Operator / Type

What can you do with OperatorType?


Properties

Property Details
id
"id": 830
Type: Number
This is the unique numeric identifier for the OperatorType
name
"name": "Hello World"
Type: String
sortOrder
"sortOrder": 233
Type: Number
operatorBaseTypeId
"operatorBaseTypeId": 222
Type: Number
Unique identifier for the associated OperatorBaseType object.


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • sortOrder
  • operatorBaseTypeId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the OperatorType object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/OperatorType/{id:int}
Delete an instance of the OperatorType object.
GETapi/v1/OperatorType
Retrieve all of the OperatorType objects.
GETapi/v1/OperatorType/Detail
Retrieve all of the OperatorType objects.
GETapi/v1/OperatorType/Metadata
Retrieve all of the meta data details of the OperatorType object.
GETapi/v1/OperatorType/Metadata/{option}
Retrieve all the meta data details of the OperatorType object based on provided options.
{option}Metadata options for the OperatorType object.
GETapi/v1/OperatorType/Paged
Retreive all of the OperatorType objects in a paged fashion.
GETapi/v1/OperatorType/Paged/Detail
Retreive all of the OperatorType objects in a paged fashion with all object details.
GETapi/v1/OperatorType/{id:int}
Retrieve an instance of the OperatorType object by it's ID.
{id:int}Unique identifier for the OperatorType object.
GETapi/v1/OperatorType/{id:int}/Detail
Retreive all of the Detail objects for the specified OperatorType.
{id:int}Unique identifier for the OperatorType object.
PATCHapi/v1/OperatorType/{id:int}
Update the OperatorType object and optionally make changes to any child objects.
POSTapi/v1/OperatorType
Create a new instance of the OperatorType object.
PUTapi/v1/OperatorType/{id:int}
Update an existing instance of the OperatorType object.