TAG LINE
SMALL TITLE

Usage / Class / Type

(API Version v4)


Defines a way of grouping all of your Usage Classes under a certain classification.


What can you do with UsageClassType?


Properties

Property Details
identity
READ-ONLY
"identity": 15
Type: Number
This is the unique numeric identifier for the UsageClassType
name
"name": "Data Classes"
Type: String
A user defined name for this Class Type.
sortOrder
READ-ONLY
"sortOrder": 24
Type: Number
Unused


End Points

DELETEapi/v4/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/v4/Usage/ClassType/{id}
View Sample Response
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"
            }
        ]
    }
}
GETapi/v4/Usage/ClassType/
Retrieve all of the UsageClassType objects.
Retrieve all of the UsageClassType objects.
GET api/v4/Usage/ClassType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Data Classes",
            "sortOrder": 9
        }
    ]
}
GETapi/v4/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/v4/Usage/ClassType/Paged
View Sample Response
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": "Data Classes",
                "sortOrder": 25
            }
        ]
    }
}
GETapi/v4/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/v4/Usage/ClassType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Data Classes",
        "sortOrder": 0
    }
}
POSTapi/v4/Usage/ClassType/
Create a new instance of the UsageClassType object.
Create a new instance of the UsageClassType object.
POST api/v4/Usage/ClassType/

{
    "name": "Data Classes"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Data Classes",
                "sortOrder": 3
            }
        ]
    }
}
POSTapi/v4/Usage/ClassType/Search
Retreive a list of UsageClassType objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of UsageClassType objects based on search criteria.
POST api/v4/Usage/ClassType/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Data Classes",
            "sortOrder": 20
        }
    ]
}
PUTapi/v4/Usage/ClassType/{id}
Update an existing instance of the UsageClassType object.
Update an existing instance of the UsageClassType object.
PUT api/v4/Usage/ClassType/{id}

{
    "identity": 1,
    "name": "Data Classes"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Data Classes",
                "sortOrder": 10
            }
        ]
    }
}