Service Type

What can you do with ServiceType?


Properties

Property Details
id
"id": 793
Type: Number
This is the unique numeric identifier for the ServiceType
name
"name": "Hello World"
Type: String
ownerId
"ownerId": 143
Type: Number
Unique identifier for the associated Owner object.
serviceBaseTypeId
"serviceBaseTypeId": 193
Type: Number
Unique identifier for the associated ServiceBaseType 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
  • serviceBaseTypeId

DataFlow PATCH objects:


End Points

DELETEapi/v1/ServiceType/{id:int}
Delete an instance of the ServiceType object.
GETapi/v1/ServiceType
Retrieve all of the ServiceType objects.
GETapi/v1/ServiceType/AvailableFor/SharePlans
Retrieve all of the ServiceType objects.
GETapi/v1/ServiceType/Metadata
Retrieve all of the meta data details of the ServiceType object.
GETapi/v1/ServiceType/Metadata/{option}
Retrieve all the meta data details of the ServiceType object based on provided options.
{option}Metadata options for the ServiceType object.
GETapi/v1/ServiceType/Paged
Retreive all of the ServiceType objects in a paged fashion.
GETapi/v1/ServiceType/{id:int}
Retrieve an instance of the ServiceType object by it's ID.
{id:int}Unique identifier for the ServiceType object.
POSTapi/v1/ServiceType
Create a new instance of the ServiceType object.
PUTapi/v1/ServiceType/{id:int}
Update an existing instance of the ServiceType object.