All URIs are relative to https://api.uptrends.com/v4
Method | HTTP request | Description |
---|---|---|
OperatorGroupAddDutyScheduleToAllMembers | Post /OperatorGroup/{operatorGroupGuid}/DutySchedule/AddDutyScheduleForAllMembers | Adds the provided duty schedule to all operators in the group specified |
OperatorGroupAddOperatorToOperatorGroup | Post /OperatorGroup/{operatorGroupGuid}/Member/{operatorGuid} | Adds the specified operator to the operator group |
OperatorGroupAllOperatorsInGroupOffDuty | Post /OperatorGroup/{operatorGroupGuid}/AllOperatorsOffDuty | Set the OnDuty flag to off for all operators that are a member of the operator group specified by the operator group GUID |
OperatorGroupAllOperatorsInGroupOnDuty | Post /OperatorGroup/{operatorGroupGuid}/AllOperatorsOnDuty | Set the OnDuty flag to on for all operators that are a member of the operator group specified by the operator group GUID |
OperatorGroupCreateOperatorGroup | Post /OperatorGroup | Creates a new operator group |
OperatorGroupDeleteAuthorizationForOperatorGroup | Delete /OperatorGroup/{operatorGroupGuid}/Authorization/{authorizationType} | Removes the specified authorization of the operator group. |
OperatorGroupDeleteOperatorGroup | Delete /OperatorGroup/{operatorGroupGuid} | Deletes the specified operator group |
OperatorGroupGetAllOperatorGroups | Get /OperatorGroup | Gets all operator groups |
OperatorGroupGetAuthorizationsForOperatorGroup | Get /OperatorGroup/{operatorGroupGuid}/Authorization | Gets all authorizations for the specified operator group. |
OperatorGroupGetOperatorGroup | Get /OperatorGroup/{operatorGroupGuid} | Gets the details of a operator group |
OperatorGroupGetOperatorGroupMembers | Get /OperatorGroup/{operatorGroupGuid}/Member | Gets a list of all members of an operator group |
OperatorGroupPostAuthorizationForOperatorGroup | Post /OperatorGroup/{operatorGroupGuid}/Authorization/{authorizationType} | Assigns the specified authorization to the operator group. |
OperatorGroupRemoveOperatorFromOperatorGroup | Delete /OperatorGroup/{operatorGroupGuid}/Member/{operatorGuid} | Removes the specified operator from the operator group |
OperatorGroupUpdateOperatorGroup | Put /OperatorGroup/{operatorGroupGuid} | Updates the operator group with the Guid specified |
OperatorGroupAddDutyScheduleToAllMembers(ctx, operatorGroupGuid).DutySchedule(dutySchedule).Execute()
Adds the provided duty schedule to all operators in the group specified
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
operatorGroupGuid := "operatorGroupGuid_example" // string |
dutySchedule := *openapiclient.NewOperatorDutySchedule(int32(123), map[string][]openapiclient.OperatorScheduleMode{ ... }) // OperatorDutySchedule | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupAddDutyScheduleToAllMembers(context.Background(), operatorGroupGuid).DutySchedule(dutySchedule).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupAddDutyScheduleToAllMembers``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGroupGuid | string |
Other parameters are passed through a pointer to a apiOperatorGroupAddDutyScheduleToAllMembersRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
dutySchedule | 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]
OperatorGroupAddOperatorToOperatorGroup(ctx, operatorGroupGuid, operatorGuid).Execute()
Adds the specified operator to the operator group
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
operatorGroupGuid := "operatorGroupGuid_example" // string | The Guid of the operator group to add the operator to
operatorGuid := "operatorGuid_example" // string | The operator Guid
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupAddOperatorToOperatorGroup(context.Background(), operatorGroupGuid, operatorGuid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupAddOperatorToOperatorGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGroupGuid | string | The Guid of the operator group to add the operator to | |
operatorGuid | string | The operator Guid |
Other parameters are passed through a pointer to a apiOperatorGroupAddOperatorToOperatorGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OperatorGroupAllOperatorsInGroupOffDuty(ctx, operatorGroupGuid).Execute()
Set the OnDuty flag to off for all operators that are a member of the operator group specified by the operator group GUID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
operatorGroupGuid := "operatorGroupGuid_example" // string | The operator group GUID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupAllOperatorsInGroupOffDuty(context.Background(), operatorGroupGuid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupAllOperatorsInGroupOffDuty``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGroupGuid | string | The operator group GUID |
Other parameters are passed through a pointer to a apiOperatorGroupAllOperatorsInGroupOffDutyRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OperatorGroupAllOperatorsInGroupOnDuty(ctx, operatorGroupGuid).Execute()
Set the OnDuty flag to on for all operators that are a member of the operator group specified by the operator group GUID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
operatorGroupGuid := "operatorGroupGuid_example" // string | The operator group GUID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupAllOperatorsInGroupOnDuty(context.Background(), operatorGroupGuid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupAllOperatorsInGroupOnDuty``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGroupGuid | string | The operator group GUID |
Other parameters are passed through a pointer to a apiOperatorGroupAllOperatorsInGroupOnDutyRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OperatorGroup OperatorGroupCreateOperatorGroup(ctx).OperatorGroup(operatorGroup).Execute()
Creates a new operator group
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
operatorGroup := *openapiclient.NewOperatorGroup() // OperatorGroup | The operatorGroup object to be created (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupCreateOperatorGroup(context.Background()).OperatorGroup(operatorGroup).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupCreateOperatorGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `OperatorGroupCreateOperatorGroup`: OperatorGroup
fmt.Fprintf(os.Stdout, "Response from `OperatorGroupApi.OperatorGroupCreateOperatorGroup`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiOperatorGroupCreateOperatorGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
operatorGroup | OperatorGroup | The operatorGroup object to be created |
- 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]
OperatorGroupDeleteAuthorizationForOperatorGroup(ctx, operatorGroupGuid, authorizationType).Execute()
Removes the specified authorization of the operator group.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
operatorGroupGuid := "operatorGroupGuid_example" // string | The Guid of the operator group
authorizationType := "authorizationType_example" // string | The type of authorization
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupDeleteAuthorizationForOperatorGroup(context.Background(), operatorGroupGuid, authorizationType).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupDeleteAuthorizationForOperatorGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGroupGuid | string | The Guid of the operator group | |
authorizationType | string | The type of authorization |
Other parameters are passed through a pointer to a apiOperatorGroupDeleteAuthorizationForOperatorGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OperatorGroupDeleteOperatorGroup(ctx, operatorGroupGuid).Execute()
Deletes the specified operator group
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
operatorGroupGuid := "operatorGroupGuid_example" // string | The Guid of the operator group to be deleted
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupDeleteOperatorGroup(context.Background(), operatorGroupGuid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupDeleteOperatorGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGroupGuid | string | The Guid of the operator group to be deleted |
Other parameters are passed through a pointer to a apiOperatorGroupDeleteOperatorGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]OperatorGroup OperatorGroupGetAllOperatorGroups(ctx).Execute()
Gets all operator groups
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupGetAllOperatorGroups(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupGetAllOperatorGroups``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `OperatorGroupGetAllOperatorGroups`: []OperatorGroup
fmt.Fprintf(os.Stdout, "Response from `OperatorGroupApi.OperatorGroupGetAllOperatorGroups`: %v\n", resp)
}
This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiOperatorGroupGetAllOperatorGroupsRequest struct via the builder pattern
- Content-Type: Not defined
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]OperatorGroupAuthorizationType OperatorGroupGetAuthorizationsForOperatorGroup(ctx, operatorGroupGuid).Execute()
Gets all authorizations for the specified operator group.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
operatorGroupGuid := "operatorGroupGuid_example" // string | The Guid of the operator group
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupGetAuthorizationsForOperatorGroup(context.Background(), operatorGroupGuid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupGetAuthorizationsForOperatorGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `OperatorGroupGetAuthorizationsForOperatorGroup`: []OperatorGroupAuthorizationType
fmt.Fprintf(os.Stdout, "Response from `OperatorGroupApi.OperatorGroupGetAuthorizationsForOperatorGroup`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGroupGuid | string | The Guid of the operator group |
Other parameters are passed through a pointer to a apiOperatorGroupGetAuthorizationsForOperatorGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
[]OperatorGroupAuthorizationType
- Content-Type: Not defined
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OperatorGroup OperatorGroupGetOperatorGroup(ctx, operatorGroupGuid).Execute()
Gets the details of a operator group
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
operatorGroupGuid := "operatorGroupGuid_example" // string | The Guid of the operator group to be retrieved
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupGetOperatorGroup(context.Background(), operatorGroupGuid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupGetOperatorGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `OperatorGroupGetOperatorGroup`: OperatorGroup
fmt.Fprintf(os.Stdout, "Response from `OperatorGroupApi.OperatorGroupGetOperatorGroup`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGroupGuid | string | The Guid of the operator group to be retrieved |
Other parameters are passed through a pointer to a apiOperatorGroupGetOperatorGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OperatorGroupMember OperatorGroupGetOperatorGroupMembers(ctx, operatorGroupGuid).Execute()
Gets a list of all members of an operator group
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
operatorGroupGuid := "operatorGroupGuid_example" // string | The Guid of the operator group to retrieve the members for
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupGetOperatorGroupMembers(context.Background(), operatorGroupGuid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupGetOperatorGroupMembers``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `OperatorGroupGetOperatorGroupMembers`: OperatorGroupMember
fmt.Fprintf(os.Stdout, "Response from `OperatorGroupApi.OperatorGroupGetOperatorGroupMembers`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGroupGuid | string | The Guid of the operator group to retrieve the members for |
Other parameters are passed through a pointer to a apiOperatorGroupGetOperatorGroupMembersRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
- Content-Type: Not defined
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OperatorGroupPostAuthorizationForOperatorGroup(ctx, operatorGroupGuid, authorizationType).Execute()
Assigns the specified authorization to the operator group.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
operatorGroupGuid := "operatorGroupGuid_example" // string | The Guid of the operator group
authorizationType := "authorizationType_example" // string | The type of authorization
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupPostAuthorizationForOperatorGroup(context.Background(), operatorGroupGuid, authorizationType).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupPostAuthorizationForOperatorGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGroupGuid | string | The Guid of the operator group | |
authorizationType | string | The type of authorization |
Other parameters are passed through a pointer to a apiOperatorGroupPostAuthorizationForOperatorGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OperatorGroupRemoveOperatorFromOperatorGroup(ctx, operatorGroupGuid, operatorGuid).Execute()
Removes the specified operator from the operator group
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
operatorGroupGuid := "operatorGroupGuid_example" // string | The Guid of the operator group to remove the operator from
operatorGuid := "operatorGuid_example" // string | The operator Guid to be removed
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupRemoveOperatorFromOperatorGroup(context.Background(), operatorGroupGuid, operatorGuid).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupRemoveOperatorFromOperatorGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGroupGuid | string | The Guid of the operator group to remove the operator from | |
operatorGuid | string | The operator Guid to be removed |
Other parameters are passed through a pointer to a apiOperatorGroupRemoveOperatorFromOperatorGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OperatorGroupUpdateOperatorGroup(ctx, operatorGroupGuid).OperatorGroup(operatorGroup).Execute()
Updates the operator group with the Guid specified
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
operatorGroupGuid := "operatorGroupGuid_example" // string | The Guid of the operator group to be updated
operatorGroup := *openapiclient.NewOperatorGroup() // OperatorGroup | The operator group to be updated (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.OperatorGroupApi.OperatorGroupUpdateOperatorGroup(context.Background(), operatorGroupGuid).OperatorGroup(operatorGroup).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OperatorGroupApi.OperatorGroupUpdateOperatorGroup``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
operatorGroupGuid | string | The Guid of the operator group to be updated |
Other parameters are passed through a pointer to a apiOperatorGroupUpdateOperatorGroupRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
operatorGroup | OperatorGroup | The operator group to be updated |
(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]