Usage Rated Exception Schedule

(API Version v9)

Details the schedules of usage rated exception reprocessing.

What can you do with UsageRatedExceptionSchedule?

POST UsageRatedExceptionSchedule/Reprocess
Create a new instance of the UsageRatedExceptionSchedule object.

Properties

Property Details

identity READ-ONLY	"identity": 4 Type: Number This is the unique numeric identifier for the UsageRatedExceptionSchedule
ownerId READ-ONLY	"ownerId": 27 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.
scheduledStart	"scheduledStart": "2021-04-26T15:25:27.587Z" Type: Date The scheduled start date and time. Date and time values are specified in the ISO 8601 format.
start	"start": "2021-04-26T15:25:27.587Z" Type: Date The actual start date and time. Date and time values are specified in the ISO 8601 format.
complete	"complete": "2021-04-26T15:25:27.587Z" Type: Date The completion date and time. Date and time values are specified in the ISO 8601 format.
created READ-ONLY	"created": "2021-04-26T15:25:27.587Z" Type: Date This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
createdByUserId	"createdByUserId": 26 Type: Number Unique identifier for the associated User object.
createdByUserName	"createdByUserName": "Sample Name" Type: String The name of the object associated with the createdByUserId property.
filterCriteria	"filterCriteria": "Hello World" Type: String The criteria used in processing.
sentCount	"sentCount": "Hello World" Type: String Number of exceptions sent.
isDelete	"isDelete": true Type: Boolean TBC

End Points

Create a new instance of the UsageRatedExceptionSchedule object.

POST UsageRatedExceptionSchedule/Reprocess

{
    "scheduledStart": "2021-04-26T15:25:27.587Z",
    "start": "2021-04-26T15:25:27.587Z",
    "complete": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 15,
    "filterCriteria": "Sample Text Data",
    "sentCount": "Sample Text Data",
    "isDelete": 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",
                "scheduledStart": "2021-04-26T15:25:27.587Z",
                "start": "2021-04-26T15:25:27.587Z",
                "complete": "2021-04-26T15:25:27.587Z",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 5,
                "createdByUserName": "Sample Text Data",
                "filterCriteria": "Sample Text Data",
                "sentCount": "Sample Text Data",
                "isDelete": true
            }
        ]
    }
}