TAG LINE
SMALL TITLE
Version 4 APIs
APIs based on the latest platform version 10.3.X
Version 3 APIs
APIs based on platform version 10.2.1
Version 2 APIs
APIs based on platform version 10.2.0

Usage / Class / Dynamic / Rule

(API Version v4)

Defines a rule used with a Dynamic Usage Class.

What can you do with UsageClassDynamicRule?

Properties

Property Details
identity
READ-ONLY
"identity": 18
Type: Number
This is the unique numeric identifier for the UsageClassDynamicRule
usageClassDynamicId
"usageClassDynamicId": 15
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": 11
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": 13
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": 19
Type: Number
Unused

End Points

GETapi/v4/Usage/Class/Dynamic/Rule/
Retrieve all of the UsageClassDynamicRule objects.
Retrieve all of the UsageClassDynamicRule objects.
GET api/v4/Usage/Class/Dynamic/Rule/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageClassDynamicId": 11,
            "usageClassDynamicName": "Sample Text Data",
            "extensionAttributeListItemId": 3,
            "extensionAttributeListItemName": "Sample Text Data",
            "geoTreeLocationGroupId": 11,
            "geoTreeLocationGroupName": "Sample Text Data",
            "usageClassId": 7,
            "usageClassName": "Sample Text Data",
            "sortOrder": 10
        }
    ]
}
GETapi/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
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,
                "usageClassDynamicId": 23,
                "usageClassDynamicName": "Sample Text Data",
                "extensionAttributeListItemId": 21,
                "extensionAttributeListItemName": "Sample Text Data",
                "geoTreeLocationGroupId": 25,
                "geoTreeLocationGroupName": "Sample Text Data",
                "usageClassId": 6,
                "usageClassName": "Sample Text Data",
                "sortOrder": 24
            }
        ]
    }
}
GETapi/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}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageClassDynamicId": 4,
        "usageClassDynamicName": "Sample Text Data",
        "extensionAttributeListItemId": 17,
        "extensionAttributeListItemName": "Sample Text Data",
        "geoTreeLocationGroupId": 24,
        "geoTreeLocationGroupName": "Sample Text Data",
        "usageClassId": 3,
        "usageClassName": "Sample Text Data",
        "sortOrder": 8
    }
}
POSTapi/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"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "usageClassDynamicId": 19,
            "usageClassDynamicName": "Sample Text Data",
            "extensionAttributeListItemId": 15,
            "extensionAttributeListItemName": "Sample Text Data",
            "geoTreeLocationGroupId": 27,
            "geoTreeLocationGroupName": "Sample Text Data",
            "usageClassId": 3,
            "usageClassName": "Sample Text Data",
            "sortOrder": 9
        }
    ]
}