Skip to main content
Version: 1.3.0

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 nameParameter descriptionRequest typeRequiredData typeschema
jsonjsonbodytrueobject

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(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 nameParameter descriptionRequest typeRequiredData typeschema
SubmitjsonbodytrueSubmitSubmit

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(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 nameParameter descriptionRequest typeRequiredData typeschema
idIDpathfalsestring
taskIDtaskIDqueryfalsestring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(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 nameParameter descriptionRequiredRequest typeData typeschema
idid request path generationtruestringstring
taskIDListcollection of task IDsfalseStringString
idListID collectionfalseStringString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(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 nameParameter descriptionRequest typeRequiredData typeschema
idTask IDpathfalsestring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(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 nameParameter descriptionRequest typeRequiredData typeschema
idTask IDpathfalsestring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(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 nameParameter descriptionRequest typeRequiredData typeschema
idTask IDpathfalsestring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(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 nameParameter descriptionRequest typeRequiredData typeschema
idIDpathfalsestring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(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 nameParameter descriptionRequest typeRequiredData typeschema
idIDpathfalsestring
taskIDtaskIDqueryfalsestring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

{
"data": {},
"message": "",
"method": "",
"status": 0
}