TAG LINE
SMALL TITLE

Usage / Class / Dynamic

(API Version v4)


Defines a container of information on how to dynamically derive the Usage Class during mediation. It will have a set of associated rules.


What can you do with UsageClassDynamic?


Properties

Property Details
identity
READ-ONLY
"identity": 20
Type: Number
This is the unique numeric identifier for the UsageClassDynamic
ownerId
READ-ONLY
"ownerId": 19
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
name
"name": "Roaming Voice"
Type: String
The user defined name for this Dynamic Usage Class.
description
"description": "Derrive if this record is in Roaming Voice."
Type: String
User defined description for the Dynamic Usage Class
isActive
"isActive": true
Type: Boolean
Whether or not this Dynamic Usage Class is actively being used.


Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the UsageClassDynamic object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v4/Usage/Class/Dynamic/{id}
Delete an instance of the UsageClassDynamic 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 UsageClassDynamic object.
Delete an instance of the UsageClassDynamic object.
DELETE api/v4/Usage/Class/Dynamic/{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": "usageClassDynamic"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Usage/Class/Dynamic/
Retrieve all of the UsageClassDynamic objects.
Retrieve all of the UsageClassDynamic objects.
GET api/v4/Usage/Class/Dynamic/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 17,
            "ownerName": "Sample Text Data",
            "name": "Roaming Voice",
            "description": "Derrive if this record is in Roaming Voice.",
            "isActive": true
        }
    ]
}
GETapi/v4/Usage/Class/Dynamic/Paged
Retrieve all of the UsageClassDynamic 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 UsageClassDynamic objects in a paged fashion.
GET api/v4/Usage/Class/Dynamic/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,
                "ownerId": 7,
                "ownerName": "Sample Text Data",
                "name": "Roaming Voice",
                "description": "Derrive if this record is in Roaming Voice.",
                "isActive": true
            }
        ]
    }
}
GETapi/v4/Usage/Class/Dynamic/Paged/Detail
Retrieve all of the UsageClassDynamic objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the UsageClassDynamic objects in a paged fashion with all object details.
GET api/v4/Usage/Class/Dynamic/Paged/Detail
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,
                "ownerId": 23,
                "ownerName": "Sample Text Data",
                "name": "Roaming Voice",
                "description": "Derrive if this record is in Roaming Voice.",
                "isActive": true,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v4/Usage/Class/Dynamic/{id}
Retrieve an instance of the UsageClassDynamic object by its ID.
{id}Unique identifier for the UsageClassDynamic object.
Retrieve an instance of the UsageClassDynamic object by its ID.
GET api/v4/Usage/Class/Dynamic/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 6,
        "ownerName": "Sample Text Data",
        "name": "Roaming Voice",
        "description": "Derrive if this record is in Roaming Voice.",
        "isActive": true
    }
}
GETapi/v4/Usage/Class/Dynamic/{id}/Detail
Retrieve deep detail of the UsageClassDynamic object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the UsageClassDynamic object.
Retrieve deep detail of the UsageClassDynamic object by its ID.
GET api/v4/Usage/Class/Dynamic/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 16,
        "ownerName": "Sample Text Data",
        "name": "Roaming Voice",
        "description": "Derrive if this record is in Roaming Voice.",
        "isActive": true,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v4/Usage/Class/Dynamic/{id}
Update or Add the UsageClassDynamic object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the UsageClassDynamic object.
Update or Add the UsageClassDynamic object and optionally make changes to any child objects.
PATCH api/v4/Usage/Class/Dynamic/{id}

{
    "details": {},
    "usageClassDynamics": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "Roaming Voice",
                "description": "Derrive if this record is in Roaming Voice.",
                "isActive": true
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "usageClassDynamic",
                "instance": {
                    "identity": 1,
                    "ownerId": 0,
                    "ownerName": "Sample Text Data",
                    "name": "Roaming Voice",
                    "description": "Derrive if this record is in Roaming Voice.",
                    "isActive": true
                }
            }
        ]
    }
}
POSTapi/v4/Usage/Class/Dynamic/
Create a new instance of the UsageClassDynamic object.
Create a new instance of the UsageClassDynamic object.
POST api/v4/Usage/Class/Dynamic/

{
    "name": "Roaming Voice",
    "description": "Derrive if this record is in Roaming Voice.",
    "isActive": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 22,
                "ownerName": "Sample Text Data",
                "name": "Roaming Voice",
                "description": "Derrive if this record is in Roaming Voice.",
                "isActive": true
            }
        ]
    }
}
POSTapi/v4/Usage/Class/Dynamic/Search
Retreive a list of UsageClassDynamic 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 UsageClassDynamic objects based on search criteria.
POST api/v4/Usage/Class/Dynamic/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,
            "ownerId": 3,
            "ownerName": "Sample Text Data",
            "name": "Roaming Voice",
            "description": "Derrive if this record is in Roaming Voice.",
            "isActive": true
        }
    ]
}
PUTapi/v4/Usage/Class/Dynamic/{id}
Update an existing instance of the UsageClassDynamic object.
Update an existing instance of the UsageClassDynamic object.
PUT api/v4/Usage/Class/Dynamic/{id}

{
    "identity": 1,
    "name": "Roaming Voice",
    "description": "Derrive if this record is in Roaming Voice.",
    "isActive": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 20,
                "ownerName": "Sample Text Data",
                "name": "Roaming Voice",
                "description": "Derrive if this record is in Roaming Voice.",
                "isActive": true
            }
        ]
    }
}