Manage data

Get push operation

Changed on

Retrieve push operation.

get/companies/{companyId}/push/{pushOperationKey}

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/companies/{companyId}/push/{pushOperationKey}
  • Auth
    API key in header Authorization

Response

OK

changesPushOperationChange[] nullable(unresolved $ref)

Contains a single entry that communicates which record has changed and the manner in which it changed.

dataTypeDataType (unresolved $ref)
companyIdSchema required(unresolved $ref)
pushOperationKeystring uuid required

A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.

dataConnectionKeySchema required(unresolved $ref)
requestedOnUtcCreated required(unresolved $ref)
completedOnUtcCreated (unresolved $ref)
timeoutInMinutesinteger nullable

Number of minutes the push operation must complete within before it times out.

timeoutInSecondsinteger nullable

Number of seconds the push operation must complete within before it times out.

statusPushOperationStatus required(unresolved $ref)
errorMessagestring nullable

A message about the error.

validationValidation (unresolved $ref)
statusCodeinteger required

Push status code.

Changes

  • fc70787de2f3Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status