ACacculynx
jobs

Get Job Estimates

Changed on

Use this endpoint to get a list of estimates for the specified job. This endpoint will return a paginated response starting from the given page start index. A 416 Range Not Satisfiable error is returned when pageStartIndex is greater than or equal to the number of estimates on the job.

get/jobs/{jobId}/estimates

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/jobs/{jobId}/estimates
  • Auth
    HTTP bearer

Path parameters

jobIdstring uuid required

The job's unique identifier

Query parameters

pageSizeinteger

How many items to be returned at a time.

pageStartIndexinteger

The value of pageStartIndex will specify the index of the record that the list begins with.

Response

OK

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

Example response

{
  "items": [
    {
      "id": "01a7cfc1-2231-4589-9657-7f3004c06bd3",
      "job": {
        "id": "e591bf22-9828-4144-bca8-42cbb8c6e2c0",
        "_link": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0"
      },
      "_link": "https://api.acculynx.com/api/v2/estimates/01a7cfc1-2231-4589-9657-7f3004c06bd3"
    }
  ]
}

Changes

  • 443924b00f43Revision changes
    • breaking

      for the query request parameter pageSize, default value 25 was removed

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      deleted the query request parameter recordStartIndex

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter pageStartIndex

    • info

      added the optional property to the response with the status