process

Update the status of a process, marking its progress or setting status to DONE or ERROR

patch/v1/org/{orgId}/process/{processId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/process/{processId}
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

processIdstring required

process id

Request body

status'PENDING' | 'RUNNING' | 'DONE' | 'ERROR'

current status of process

filePathstring

data file path

messagestring

status or error message

progressnumber double

percent progress so far

internalErrorstring

internal-only error message

optionsobject

options passed to the process

resultsobject

results summary for the process

stateobject

process-specific state data

summarystring

human-readable, searchable summary of what this process did

appIdstring

app id of the process

Example request

{
  "logDataList": [
    {
      "at": "2017-01-24T13:57:52Z"
    }
  ],
  "appId": "588f7ee98f138b19220041a7"
}

Changes

No recorded changes to this operation across all 20 revisions of this API.