TAG LINE
TAG LINE
SMALL TITLE
Defines a rule used with a Dynamic Usage Class.
identity READ-ONLY | "identity": 12 Type: Number This is the unique numeric identifier for the UsageClassDynamicRule |
usageClassDynamicId | "usageClassDynamicId": 6 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": 8 Type: Number A specified user defined Mediation field in the usage feed to be used as part of this rule. 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": 21 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": 23 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 READ-ONLY | "sortOrder": 7 Type: Number Unused |
| GET | Usage/Class/Dynamic/Rule/ |
| Retrieve all of the UsageClassDynamicRule objects. | |
Retrieve all of the UsageClassDynamicRule objects. GET Usage/Class/Dynamic/Rule/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"usageClassDynamicId": 18,
"usageClassDynamicName": "Sample Text Data",
"extensionAttributeListItemId": 8,
"extensionAttributeListItemName": "Sample Text Data",
"geoTreeLocationGroupId": 20,
"geoTreeLocationGroupName": "Sample Text Data",
"usageClassId": 6,
"usageClassName": "Sample Text Data",
"sortOrder": 19
}
]
} | |
| GET | 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 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": 10,
"usageClassDynamicName": "Sample Text Data",
"extensionAttributeListItemId": 5,
"extensionAttributeListItemName": "Sample Text Data",
"geoTreeLocationGroupId": 26,
"geoTreeLocationGroupName": "Sample Text Data",
"usageClassId": 16,
"usageClassName": "Sample Text Data",
"sortOrder": 16
}
]
}
} | |
| GET | 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 Usage/Class/Dynamic/Rule/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"usageClassDynamicId": 23,
"usageClassDynamicName": "Sample Text Data",
"extensionAttributeListItemId": 27,
"extensionAttributeListItemName": "Sample Text Data",
"geoTreeLocationGroupId": 21,
"geoTreeLocationGroupName": "Sample Text Data",
"usageClassId": 5,
"usageClassName": "Sample Text Data",
"sortOrder": 14
}
} | |