getJobHistory

Click to copy

Get job history by jobId

Get job history by jobId. It returns the log of job actions such as running steps, managing job attachments and properties.

Query parameters

NameTypeRequired

token

string

Path parameters

NameTypeRequired

jobId

string

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
# You can also use wget
curl -X GET /{orgId}/{itemId}/jobs/{jobId}/history \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "jobHistory": [
    {
      "date": "2019-08-24T14:15:22Z",
      "jobId": "string",
      "stepId": "string",
      "username": "string",
      "action": "Activated",
      "result": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "durationSeconds": 0
    }
  ]
}
StatusMeaningDescriptionSchema

200

OK

List of job histories

Inline

400

Bad Request

error

WorkflowExceptionDTO

Response details

Status Code 200

JobHistoryRecords

NameTypeRequired

jobHistory

date

string(date-time)¦null

jobId

string

stepId

string¦null

username

string

action

string

result

string¦null

startDate

string(date-time)¦null

endDate

string(date-time)¦null

durationSeconds

integer(int64)¦null

Enumerated Values

action
Activated
Click to copy
Deactivated
Click to copy
Started
Click to copy
Paused
Click to copy
Finished
Click to copy
Completed
Click to copy
Error
Click to copy
Cancelled
Click to copy
Reassigned
Click to copy
Upgraded
Click to copy
Updated
Click to copy
Created
Click to copy
Deleted
Click to copy
Closed
Click to copy
Added
Click to copy
DependencyAdded
Click to copy
Held
Click to copy
HoldReleased
Click to copy
Reopened
Click to copy
Reactivated
Click to copy

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.