TAG LINE
SMALL TITLE
identity READ-ONLY | "identity": 17 Type: Number This is the unique numeric identifier for the UsageClassDynamicRule |
usageClassDynamicId | "usageClassDynamicId": 23 Type: Number Unique identifier for the associated UsageClassDynamic object. |
usageClassDynamicName | "usageClassDynamicName": "Sample Name" Type: String The name of the object associated with the usageClassDynamicId property. |
extensionAttributeListItemId | "extensionAttributeListItemId": 0 Type: Number Unique identifier for the associated ExtensionAttributeListItem object. |
extensionAttributeListItemName | "extensionAttributeListItemName": "Sample Name" Type: String The name of the object associated with the extensionAttributeListItemId property. |
geoTreeLocationGroupId | "geoTreeLocationGroupId": 22 Type: Number Unique identifier for the associated GeoTreeLocationGroup object. |
geoTreeLocationGroupName | "geoTreeLocationGroupName": "Sample Name" Type: String The name of the object associated with the geoTreeLocationGroupId property. |
usageClassId | "usageClassId": 10 Type: Number Unique identifier for the associated UsageClass object. |
usageClassName | "usageClassName": "Sample Name" Type: String The name of the object associated with the usageClassId property. |
sortOrder | "sortOrder": 10 Type: Number |
| GET | api/v4/Usage/Class/Dynamic/Rule/ |
| Retrieve all of the UsageClassDynamicRule objects. | |
Retrieve all of the UsageClassDynamicRule objects. GET api/v4/Usage/Class/Dynamic/Rule/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"usageClassDynamicId": 9,
"usageClassDynamicName": "Sample Text Data",
"extensionAttributeListItemId": 17,
"extensionAttributeListItemName": "Sample Text Data",
"geoTreeLocationGroupId": 26,
"geoTreeLocationGroupName": "Sample Text Data",
"usageClassId": 15,
"usageClassName": "Sample Text Data",
"sortOrder": 10
}
]
} | |
| GET | api/v4/Usage/Class/Dynamic/Rule/Paged |
| Retrieve all of the UsageClassDynamicRule 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 UsageClassDynamicRule objects in a paged fashion. GET api/v4/Usage/Class/Dynamic/Rule/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,
"usageClassDynamicId": 1,
"usageClassDynamicName": "Sample Text Data",
"extensionAttributeListItemId": 0,
"extensionAttributeListItemName": "Sample Text Data",
"geoTreeLocationGroupId": 25,
"geoTreeLocationGroupName": "Sample Text Data",
"usageClassId": 23,
"usageClassName": "Sample Text Data",
"sortOrder": 8
}
]
}
} | |
| GET | api/v4/Usage/Class/Dynamic/Rule/{id} |
| Retrieve an instance of the UsageClassDynamicRule object by its ID. | |
| {id} | Unique identifier for the UsageClassDynamicRule object. |
Retrieve an instance of the UsageClassDynamicRule object by its ID. GET api/v4/Usage/Class/Dynamic/Rule/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"usageClassDynamicId": 6,
"usageClassDynamicName": "Sample Text Data",
"extensionAttributeListItemId": 24,
"extensionAttributeListItemName": "Sample Text Data",
"geoTreeLocationGroupId": 16,
"geoTreeLocationGroupName": "Sample Text Data",
"usageClassId": 8,
"usageClassName": "Sample Text Data",
"sortOrder": 10
}
} | |
| POST | api/v4/Usage/Class/Dynamic/Rule/Search |
| Retreive a list of UsageClassDynamicRule 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 UsageClassDynamicRule objects based on search criteria. POST api/v4/Usage/Class/Dynamic/Rule/Search
{
"query": {
"top": 20,
"search": [
{
"name": "MyFieldName",
"operator": "startsWith",
"value": "a"
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"itemCount": 1,
"items": [
{
"identity": 1,
"usageClassDynamicId": 27,
"usageClassDynamicName": "Sample Text Data",
"extensionAttributeListItemId": 6,
"extensionAttributeListItemName": "Sample Text Data",
"geoTreeLocationGroupId": 23,
"geoTreeLocationGroupName": "Sample Text Data",
"usageClassId": 19,
"usageClassName": "Sample Text Data",
"sortOrder": 11
}
]
} | |