TAG LINE
SMALL TITLE
identity READ-ONLY | "identity": 24 Type: Number This is the unique numeric identifier for the UsageClassType |
name | "name": "Hello World" Type: String |
sortOrder | "sortOrder": 24 Type: Number |
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:
| DELETE | api/v2/Usage/ClassType/{id} |
| Delete an instance of the UsageClassType object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the UsageClassType object. |
Delete an instance of the UsageClassType object. DELETE api/v2/Usage/ClassType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "usageClassType"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v2/Usage/ClassType/ |
| Retrieve all of the UsageClassType objects. | |
Retrieve all of the UsageClassType objects. GET api/v2/Usage/ClassType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"sortOrder": 24
}
]
} | |
| GET | api/v2/Usage/ClassType/Paged |
| Retrieve all of the UsageClassType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the UsageClassType objects in a paged fashion. GET api/v2/Usage/ClassType/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"sortOrder": 11
}
]
}
} | |
| GET | api/v2/Usage/ClassType/{id} |
| Retrieve an instance of the UsageClassType object by its ID. | |
| {id} | Unique identifier for the UsageClassType object. |
Retrieve an instance of the UsageClassType object by its ID. GET api/v2/Usage/ClassType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Sample Text Data",
"sortOrder": 24
}
} | |
| POST | api/v2/Usage/ClassType/ |
| Create a new instance of the UsageClassType object. | |
Create a new instance of the UsageClassType object. POST api/v2/Usage/ClassType/
{
"name": "Sample Text Data",
"sortOrder": 11
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"sortOrder": 20
}
]
}
} | |
| PUT | api/v2/Usage/ClassType/{id} |
| Update an existing instance of the UsageClassType object. | |
Update an existing instance of the UsageClassType object. PUT api/v2/Usage/ClassType/{id}
{
"identity": 1,
"name": "Sample Text Data",
"sortOrder": 2
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data",
"sortOrder": 6
}
]
}
} | |