Problem Statement
...
| approaches | pros | cons |
|---|---|---|
1.without content service | loosely coupled | |
| 2.with content service | reply on content service |
Problem Statement
What is the API for update content?
...
| 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 : {
"script" : "course_rename",
"version" : "1.2",
"content" : {
"oldName" : "AB",
"newName" : "ab"
}
}
}
Response
{
"id": "api.content.update",
"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/content/update/status/01262366359399628812
Response
{
"id": "api.content.update.status",
"result": {
"status" : "FAILURE",
"message" : "Operation to update failed"
}
}
|
Problem Statement
What is the API for get all the processes by a user
Solution approach
URL:
GET /v1/content/update/processes
Headers:
Authorization
X-authenticated-user-token
Request Params:
None
Response Params:
returns an array of processes related to user
| 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/content/update/processes
Response
{
"id": "api.content.update.processes",
"result": {
processes : [{
"processId" : "01262366359399628812",
"script" : "course_rename",
"version" : "1.2"
}]
}
}
|
...