Usage / Class / Dynamic / Rule

(API Version v4)

Defines a rule used with a Dynamic Usage Class.

What can you do with UsageClassDynamicRule?

GET api/v4/Usage/Class/Dynamic/Rule/
Retrieve all of the UsageClassDynamicRule objects.
GET api/v4/Usage/Class/Dynamic/Rule/Paged
Retrieve all of the UsageClassDynamicRule objects in a paged fashion.
GET api/v4/Usage/Class/Dynamic/Rule/{id}
Retrieve an instance of the UsageClassDynamicRule object by its ID.
POST api/v4/Usage/Class/Dynamic/Rule/Search
Retreive a list of UsageClassDynamicRule objects based on search criteria.

Properties

Property Details

identity READ-ONLY	"identity": 10 Type: Number This is the unique numeric identifier for the UsageClassDynamicRule
usageClassDynamicId	"usageClassDynamicId": 4 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": 13 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": 1 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": 18 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": 0 Type: Number Unused

End Points

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": 18,
            "usageClassDynamicName": "Sample Text Data",
            "extensionAttributeListItemId": 16,
            "extensionAttributeListItemName": "Sample Text Data",
            "geoTreeLocationGroupId": 15,
            "geoTreeLocationGroupName": "Sample Text Data",
            "usageClassId": 7,
            "usageClassName": "Sample Text Data",
            "sortOrder": 8
        }
    ]
}

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": 0,
                "usageClassDynamicName": "Sample Text Data",
                "extensionAttributeListItemId": 15,
                "extensionAttributeListItemName": "Sample Text Data",
                "geoTreeLocationGroupId": 18,
                "geoTreeLocationGroupName": "Sample Text Data",
                "usageClassId": 22,
                "usageClassName": "Sample Text Data",
                "sortOrder": 19
            }
        ]
    }
}

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} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "usageClassDynamicId": 4, "usageClassDynamicName": "Sample Text Data", "extensionAttributeListItemId": 20, "extensionAttributeListItemName": "Sample Text Data", "geoTreeLocationGroupId": 5, "geoTreeLocationGroupName": "Sample Text Data", "usageClassId": 0, "usageClassName": "Sample Text Data", "sortOrder": 22 } }

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": 4,
            "usageClassDynamicName": "Sample Text Data",
            "extensionAttributeListItemId": 0,
            "extensionAttributeListItemName": "Sample Text Data",
            "geoTreeLocationGroupId": 22,
            "geoTreeLocationGroupName": "Sample Text Data",
            "usageClassId": 26,
            "usageClassName": "Sample Text Data",
            "sortOrder": 2
        }
    ]
}