ACacculynx
jobs

Get Job Change History

Changed on

Use this endpoint to get a history of actions performed for a job. Supported includes: createdBy. When startDate and endDate are specified, actions returned will be filtered to those created between those dates (inclusive). 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 total number of history records. If the job has no history records, a 200 OK is returned with an empty items array, echoing back the requested pageSize and pageStartIndex.

get/jobs/{jobId}/history

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/jobs/{jobId}/history
  • 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.

includesstring

A comma-separated list of related resources to expand inline in the response. Valid values vary by endpoint and are documented in each operation description.

startDatestring date

The start of the date range to filter by, in YYYY-MM-DD format (inclusive). When provided with endDate, must be earlier than endDate.

endDatestring date

The end of the date range to filter by, in YYYY-MM-DD format (inclusive). When provided, must be greater than startDate.

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": [
    {
      "action": "Company Representative changed from Jimmy to Julie",
      "type": "Job",
      "date": "2020-06-22T05:00:00Z",
      "createdBy": {
        "id": "228db892-3b49-4455-b839-ffd8576d8731",
        "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
      }
    }
  ]
}

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