Skip to content

Latest commit

 

History

History
430 lines (272 loc) · 16.6 KB

OperatorApi.md

File metadata and controls

430 lines (272 loc) · 16.6 KB

\OperatorApi

All URIs are relative to https://api.uptrends.com/v4

Method HTTP request Description
OperatorAddDutyPeriodForOperator Post /Operator/{operatorGuid}/DutySchedule Adds a duty schedule to the specified operator.
OperatorCreateOperator Post /Operator Creates a new operator.
OperatorDeleteAuthorizationForOperator Delete /Operator/{operatorGuid}/Authorization/{authorizationType} Removes the specified authorization of this operator.
OperatorDeleteDutyScheduleFromOperator Delete /Operator/{operatorGuid}/DutySchedule/{dutyScheduleId} Deletes the specified duty schedule of the specified operator.
OperatorDeleteOperator Delete /Operator/{operatorGuid} Deletes an existing operator.
OperatorGetAllOperators Get /Operator Gets a list of all operators.
OperatorGetAuthorizationsForOperator Get /Operator/{operatorGuid}/Authorization Gets all authorizations for the specified operator.
OperatorGetDutyScheduleForOperator Get /Operator/{operatorGuid}/DutySchedule Gets the duty schedules for an specified operator.
OperatorGetOperator Get /Operator/{operatorGuid} Gets the details of the operator with the provided OperatorGuid.
OperatorGetOperatorGroupsForOperator Get /Operator/{operatorGuid}/OperatorGroup Gets a list of all operator groups for the specified operator.
OperatorPostAuthorizationForOperator Post /Operator/{operatorGuid}/Authorization/{authorizationType} Assigns the specified authorization to this operator.
OperatorUpdateDutyPeriodForOperator Put /Operator/{operatorGuid}/DutySchedule/{dutyScheduleId} Updates the specified duty schedule of the specified operator.
OperatorUpdateOperator Put /Operator/{operatorGuid} Updates an existing operator.
OperatorUpdateOperatorWithPatch Patch /Operator/{operatorGuid} Updates an existing operator.

OperatorAddDutyPeriodForOperator

OperatorAddDutyPeriodForOperator(ctx, operatorGuid, optional) Adds a duty schedule to the specified operator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operatorGuid string The Guid of the operator to add the duty schedule to
optional *OperatorApiOperatorAddDutyPeriodForOperatorOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a OperatorApiOperatorAddDutyPeriodForOperatorOpts struct

Name Type Description Notes

schedule | optional.Interface of OperatorDutySchedule| The duty schedule to add |

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperatorCreateOperator

Operator OperatorCreateOperator(ctx, optional) Creates a new operator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *OperatorApiOperatorCreateOperatorOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a OperatorApiOperatorCreateOperatorOpts struct

Name Type Description Notes
uptrendsOperator optional.Interface of Operator The details of the operator to create

Return type

Operator

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperatorDeleteAuthorizationForOperator

OperatorDeleteAuthorizationForOperator(ctx, operatorGuid, authorizationType) Removes the specified authorization of this operator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operatorGuid string The Guid of the operator
authorizationType string The type of authorization

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperatorDeleteDutyScheduleFromOperator

OperatorDeleteDutyScheduleFromOperator(ctx, operatorGuid, dutyScheduleId) Deletes the specified duty schedule of the specified operator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operatorGuid string
dutyScheduleId int32

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperatorDeleteOperator

OperatorDeleteOperator(ctx, operatorGuid) Deletes an existing operator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operatorGuid string The Guid of the operator to delete

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperatorGetAllOperators

[]Operator OperatorGetAllOperators(ctx, ) Gets a list of all operators.

Required Parameters

This endpoint does not need any parameter.

Return type

[]Operator

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperatorGetAuthorizationsForOperator

[]OperatorAuthorizationType OperatorGetAuthorizationsForOperator(ctx, operatorGuid) Gets all authorizations for the specified operator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operatorGuid string The Guid of the operator

Return type

[]OperatorAuthorizationType

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperatorGetDutyScheduleForOperator

[]OperatorDutySchedule OperatorGetDutyScheduleForOperator(ctx, operatorGuid) Gets the duty schedules for an specified operator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operatorGuid string The Guid of the operator to get the duty schedule for

Return type

[]OperatorDutySchedule

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperatorGetOperator

Operator OperatorGetOperator(ctx, operatorGuid) Gets the details of the operator with the provided OperatorGuid.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operatorGuid string The Guid of the operator for which to retrieve the details

Return type

Operator

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperatorGetOperatorGroupsForOperator

[]OperatorMember OperatorGetOperatorGroupsForOperator(ctx, operatorGuid) Gets a list of all operator groups for the specified operator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operatorGuid string The Guid of the operator for which to retrieve the operator group guids

Return type

[]OperatorMember

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperatorPostAuthorizationForOperator

OperatorPostAuthorizationForOperator(ctx, operatorGuid, authorizationType) Assigns the specified authorization to this operator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operatorGuid string The Guid of the operator
authorizationType string The type of authorization

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperatorUpdateDutyPeriodForOperator

OperatorUpdateDutyPeriodForOperator(ctx, operatorGuid, dutyScheduleId, optional) Updates the specified duty schedule of the specified operator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operatorGuid string
dutyScheduleId int32
optional *OperatorApiOperatorUpdateDutyPeriodForOperatorOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a OperatorApiOperatorUpdateDutyPeriodForOperatorOpts struct

Name Type Description Notes

schedule | optional.Interface of OperatorDutySchedule| |

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperatorUpdateOperator

OperatorUpdateOperator(ctx, operatorGuid, optional) Updates an existing operator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operatorGuid string The Guid of the operator to update
optional *OperatorApiOperatorUpdateOperatorOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a OperatorApiOperatorUpdateOperatorOpts struct

Name Type Description Notes

uptrendsOperator | optional.Interface of Operator| The updated details of the operator |

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OperatorUpdateOperatorWithPatch

OperatorUpdateOperatorWithPatch(ctx, operatorGuid, optional) Updates an existing operator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
operatorGuid string The Guid of the operator to update
optional *OperatorApiOperatorUpdateOperatorWithPatchOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a OperatorApiOperatorUpdateOperatorWithPatchOpts struct

Name Type Description Notes

uptrendsOperator | optional.Interface of Operator| The updated details of the operator |

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]