Get Activity Types
Returns a list of available activity types in the target instance, along with associated metadata of each type.
Responses
200 OK ResponseOfActivityType
errors array of Error required
Array of errors that occurred if the request was unsuccessful
Model Error
code string required Error code of the error. See full list of error codes here
message string required Message describing the cause of the error
moreResult boolean Boolean indicating if there are more results in subsequent pages
nextPageToken string Paging token given if the result set exceeded the allowed batch size
requestId string required Id of the request made
result array of ActivityType required
Array of results for individual records in the operation, may be empty
Model ActivityType
apiName string attributes array of ActivityTypeAttribute required
List of secondary attributes of the type
Model ActivityTypeAttribute
apiName string dataType string required Datatype of the Attribute
name string required Name of the attribute
description string Description of the activity type
id integer (int32) required Id of the activity type
name string required Name of the activity type
primaryAttribute ActivityTypeAttribute required
Primary attribute of the type
Model ActivityTypeAttribute
apiName string dataType string required Datatype of the Attribute
name string required Name of the attribute
success boolean required Whether the request succeeded
warnings array of Warning required
Array of warnings given for the operation
Model Warning
code integer (int32) required Integer code of the warning
message string required Message describing the warning
Generated example
{
"errors": [
{
"code": "string",
"message": "string"
}
],
"moreResult": false,
"nextPageToken": "example-token",
"requestId": "123",
"result": [
{
"apiName": "Example name",
"attributes": [
{
"apiName": "Example name",
"dataType": "string",
"name": "Example name"
}
],
"description": "string",
"id": 123,
"name": "Example name",
"primaryAttribute": {
"apiName": "Example name",
"dataType": "string",
"name": "Example name"
}
}
],
"success": false,
"warnings": [
{
"code": 123,
"message": "string"
}
]
}Referenced models
Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.