TAG LINE
TAG LINE
SMALL TITLE
identity READ-ONLY | "identity": 25 Type: Number This is the unique numeric identifier for the RerateSchedule |
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. |
start | "start": "2021-04-26T15:25:27.587Z" Type: Date Date and time values are specified in the ISO 8601 format. |
complete | "complete": "2021-04-26T15:25:27.587Z" Type: Date 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": 27 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. |
rerateScheduleStatusTypeId | "rerateScheduleStatusTypeId": 24 Type: Number Unique identifier for the associated RerateScheduleStatusType object. |
rerateScheduleStatusTypeName | "rerateScheduleStatusTypeName": "Sample Name" Type: String The name of the object associated with the rerateScheduleStatusTypeId property. |
GET | RerateSchedule/ |
Retrieve all of the RerateSchedule objects. | |
Retrieve all of the RerateSchedule objects. GET RerateSchedule/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "ownerId": 22, "ownerName": "Sample Text Data", "start": "2021-04-26T15:25:27.587Z", "complete": "2021-04-26T15:25:27.587Z", "created": "2021-04-26T15:25:27.587Z", "createdByUserId": 4, "createdByUserName": "Sample Text Data", "rerateScheduleStatusTypeId": 2, "rerateScheduleStatusTypeName": "Sample Text Data" } ] } |
GET | RerateSchedule/Paged |
Retrieve all of the RerateSchedule 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 RerateSchedule objects in a paged fashion. GET RerateSchedule/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, "ownerId": 3, "ownerName": "Sample Text Data", "start": "2021-04-26T15:25:27.587Z", "complete": "2021-04-26T15:25:27.587Z", "created": "2021-04-26T15:25:27.587Z", "createdByUserId": 16, "createdByUserName": "Sample Text Data", "rerateScheduleStatusTypeId": 23, "rerateScheduleStatusTypeName": "Sample Text Data" } ] } } |
GET | RerateSchedule/{id} |
Retrieve an instance of the RerateSchedule object by its ID. | |
{id} | Unique identifier for the RerateSchedule object. |
Retrieve an instance of the RerateSchedule object by its ID. GET RerateSchedule/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "ownerId": 25, "ownerName": "Sample Text Data", "start": "2021-04-26T15:25:27.587Z", "complete": "2021-04-26T15:25:27.587Z", "created": "2021-04-26T15:25:27.587Z", "createdByUserId": 21, "createdByUserName": "Sample Text Data", "rerateScheduleStatusTypeId": 19, "rerateScheduleStatusTypeName": "Sample Text Data" } } |