Problem Statement
...
Solution approach
URL:
POST /v1/job/start
Headers:
Authorization
X-authenticated-user-token
...
| status code | error code | error message |
|---|---|---|
| 400 | MANDATORY_PARAMETER_MISSING | Mandatory parameter {script,version} is missing. |
| 400 | UPDATE_FAILED | Data updation failed due to invalid Request |
Sample Request and Response:
| No Format | ||
|---|---|---|
| ||
Request
{
request : {
"scriptName" : "course_rename",
"version" : "1.2",
"attributes" : [{
"field" : "name"
"oldValue" : "AB",
"newValue" : "ab"
},{
"field" : "orgDetails"
"oldValue" : {
"courseName" : "AB"
},
"newValue" : {
"courseName" : "ab"
}
}]
}
}
Response
{
"id": "api.job",
"result": {
"processId" : "01262366359399628812"
}
}
|
...
| status code | error code | error message |
|---|---|---|
| 400 | INVALID_PROCESS_ID | Invalid Process Id |
Sample Request and Response:
| No Format | ||
|---|---|---|
| ||
Request
GET /v1/job/status/01262366359399628812
Response
{
"id": "api.job.status",
"result": {
"status" : "FAILURE",
"message" : "Operation to update failed"
}
}
|
...
Solution approach
URL:
GET /v1/job/processeslist
Headers:
Authorization
X-authenticated-user-token
...
| name | type | description |
|---|---|---|
| processId | text | the process id |
| script | text | the script for which process exists |
| version | text | version of the script |
Errors:
None
Sample Request and Response:
| No Format | ||
|---|---|---|
| ||
Request
GET /v1/job/processes
Response
{
"id": "api.job.processes",
"result": {
processes : [{
"processId" : "01262366359399628812",
"script" : "course_rename",
"version" : "1.2"
}]
}
}
|
...