CostCodeProgress

Returns a list of quantities for a given date range, job Id and other optional parameters.

Securitybearer
Request
Request Body schema:
required
jobId
required
string <uuid>

Job Id. Required for all queries.

startDate
string or null <date-time>

Start Date

endDate
string or null <date-time>

End Date

costCodeIds
Array of strings or null <uuid>

List of cost code Ids

costCodeTagIds
Array of strings or null <uuid>

List of cost code Tag Ids

costCodeTransactionTagIds
Array of strings or null <uuid>

List of cost code Transaction Tag Ids

cursor
string or null

Optional.
When there are additional results, the metadata nextCursor field should be passed to retrieve the next page of results.

limit
integer or null <int32>

The maximum number of items to return.

Responses
post/api/v1/costCode/progress/advancedRequest
Request samples
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "costCodeIds": [
    ],
  • "costCodeTagIds": [
    ],
  • "costCodeTransactionTagIds": [
    ],
  • "cursor": "string",
  • "limit": 0
}
Response samples
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}