Task Action
EntranceRestfulApi class
process task request#
Interface address:/api/rest_j/v1/entrance/execute
Request method: POST
Request data type: application/json
Response data type: */*
Interface description:
The execute function handles the request submitted by the user to execute the task
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| json | json | body | true | object |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response parameters:
| parameter name | parameter description | type | schema |
|---|---|---|---|
| data | Dataset | object | |
| message | Description | string | |
| method | request url | string | |
| status | Status | integer(int32) | integer(int32) |
Sample Response:
{ "data": {}, "message": "", "method": "", "status": 0}Submit the execute function#
Interface address:/api/rest_j/v1/entrance/submit
Request method: POST
Request data type: application/json
Response data type: */*
Interface description:
Submit execute function
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| Submit | json | body | true | Submit | Submit |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response parameters:
| parameter name | parameter description | type | schema |
|---|---|---|---|
| data | Dataset | object | |
| message | Description | string | |
| method | request url | string | |
| status | Status | integer(int32) | integer(int32) |
Sample Response:
{ "data": {}, "message": "", "method": "", "status": 0}end task#
Interface address: /api/rest_j/v1/entrance/{id}/kill
Request method: GET
Request data type: application/x-www-form-urlencoded
Response data type: */*
Interface description:
kill task
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| id | ID | path | false | string | |
| taskID | taskID | query | false | string |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response parameters:
| parameter name | parameter description | type | schema |
|---|---|---|---|
| data | Dataset | object | |
| message | Description | string | |
| method | request url | string | |
| status | Status | integer(int32) | integer(int32) |
Sample Response:
{ "data": {}, "message": "", "method": "", "status": 0}End Jobs#
Interface address: /api/rest_j/v1/entrance/{id}/killJobs
Request method: POST
Request data type: application/json
Response data type: */*
Interface description:
End Jobs
Request example:
{ "taskIDList": [], "idList": []}Request Parameters:
| Parameter name | Parameter description | Required | Request type | Data type | schema |
|---|---|---|---|---|---|
| id | id request path generation | true | string | string | |
| taskIDList | collection of task IDs | false | String | String | |
| idList | ID collection | false | String | String |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response parameters:
| parameter name | parameter description | type | schema |
|---|---|---|---|
| data | Dataset | object | |
| message | Description | string | |
| method | request url | string | |
| status | Status | integer(int32) | integer(int32) |
Sample Response:
{ "method": "/api/entrance/#id/killJobs", "status": 0, "message": "success", "data": { "messages": [{ "method": "", "status": 0, "message": "", "data": { "execID": "" } }] }}task log#
Interface address: /api/rest_j/v1/entrance/{id}/log
Request method: GET
Request data type: application/x-www-form-urlencoded
Response data type: */*
Interface description:
Get task log
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| id | Task ID | path | false | string |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response parameters:
| parameter name | parameter description | type | schema |
|---|---|---|---|
| data | Dataset | object | |
| message | Description | string | |
| method | request url | string | |
| status | Status | integer(int32) | integer(int32) |
Sample Response:
{ "data": {}, "message": "", "method": "", "status": 0}Pause task#
Interface address:/api/rest_j/v1/entrance/{id}/pause
Request method: GET
Request data type: application/x-www-form-urlencoded
Response data type: */*
Interface description:
Pause task
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| id | Task ID | path | false | string |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response parameters:
| parameter name | parameter description | type | schema |
|---|---|---|---|
| data | Dataset | object | |
| message | Description | string | |
| method | request url | string | |
| status | Status | integer(int32) | integer(int32) |
Sample Response:
{ "data": {}, "message": "", "method": "", "status": 0}Mission progress#
Interface address:/api/rest_j/v1/entrance/{id}/progress
Request method: GET
Request data type: application/x-www-form-urlencoded
Response data type: */*
Interface description:
Task progress
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| id | Task ID | path | false | string |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response parameters:
| parameter name | parameter description | type | schema |
|---|---|---|---|
| data | Dataset | object | |
| message | Description | string | |
| method | request url | string | |
| status | Status | integer(int32) | integer(int32) |
Sample Response:
{ "data": {}, "message": "", "method": "", "status": 0}Resource progress#
Interface address:/api/rest_j/v1/entrance/{id}/progressWithResource
Request method: GET
Request data type: application/x-www-form-urlencoded
Response data type: */*
Interface description:
Resource progress
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| id | ID | path | false | string |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response parameters:
| parameter name | parameter description | type | schema |
|---|---|---|---|
| data | Dataset | object | |
| message | Description | string | |
| method | request url | string | |
| status | Status | integer(int32) | integer(int32) |
Sample Response:
{ "data": {}, "message": "", "method": "", "status": 0}task status#
Interface address:/api/rest_j/v1/entrance/{id}/status
Request method: GET
Request data type: application/x-www-form-urlencoded
Response data type: */*
Interface description:
Task status
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| id | ID | path | false | string | |
| taskID | taskID | query | false | string |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Response parameters:
| parameter name | parameter description | type | schema |
|---|---|---|---|
| data | Dataset | object | |
| message | Description | string | |
| method | request url | string | |
| status | Status | integer(int32) | integer(int32) |
Sample Response:
{ "data": {}, "message": "", "method": "", "status": 0}