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(ctx, operatorGuid, optional) Adds a duty schedule to the specified operator.
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 are passed through a pointer to a OperatorApiOperatorAddDutyPeriodForOperatorOpts struct
Name | Type | Description | Notes |
---|
schedule | optional.Interface of OperatorDutySchedule| The duty schedule to add |
(empty response body)
- 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]
Operator OperatorCreateOperator(ctx, optional) Creates a new operator.
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 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 |
- 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(ctx, operatorGuid, authorizationType) Removes the specified authorization of this operator.
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 |
(empty response body)
- 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(ctx, operatorGuid, dutyScheduleId) Deletes the specified duty schedule of the specified operator.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGuid | string | ||
dutyScheduleId | int32 |
(empty response body)
- 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(ctx, operatorGuid) Deletes an existing operator.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGuid | string | The Guid of the operator to delete |
(empty response body)
- 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]
[]Operator OperatorGetAllOperators(ctx, ) Gets a list of all operators.
This endpoint does not need any parameter.
- 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]
[]OperatorAuthorizationType OperatorGetAuthorizationsForOperator(ctx, operatorGuid) Gets all authorizations for the specified operator.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGuid | string | The Guid of the operator |
- 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]
[]OperatorDutySchedule OperatorGetDutyScheduleForOperator(ctx, operatorGuid) Gets the duty schedules for an specified operator.
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 |
- 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]
Operator OperatorGetOperator(ctx, operatorGuid) Gets the details of the operator with the provided OperatorGuid.
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 |
- 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]
[]OperatorMember OperatorGetOperatorGroupsForOperator(ctx, operatorGuid) Gets a list of all operator groups for the specified operator.
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 |
- 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(ctx, operatorGuid, authorizationType) Assigns the specified authorization to this operator.
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 |
(empty response body)
- 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(ctx, operatorGuid, dutyScheduleId, optional) Updates the specified duty schedule of the specified operator.
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 are passed through a pointer to a OperatorApiOperatorUpdateDutyPeriodForOperatorOpts struct
Name | Type | Description | Notes |
---|
schedule | optional.Interface of OperatorDutySchedule| |
(empty response body)
- 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(ctx, operatorGuid, optional) Updates an existing operator.
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 are passed through a pointer to a OperatorApiOperatorUpdateOperatorOpts struct
Name | Type | Description | Notes |
---|
uptrendsOperator | optional.Interface of Operator| The updated details of the operator |
(empty response body)
- 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(ctx, operatorGuid, optional) Updates an existing operator.
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 are passed through a pointer to a OperatorApiOperatorUpdateOperatorWithPatchOpts struct
Name | Type | Description | Notes |
---|
uptrendsOperator | optional.Interface of Operator| The updated details of the operator |
(empty response body)
- 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]