Skip to main content
Version: 1.3.2

Admin Console Home Page Interface

QueryRestfulApi class

admin authentication

Interface address:/api/rest_j/v1/jobhistory/governanceStationAdmin

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Used to verify whether it is an administrator, if it is, it will return true if it is not false

Request Parameters:

No

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: {
solution: null,
admin: true
}
message: "OK"
method: "/api/jobhistory/governanceStationAdmin"
status: 0
}

global history

Interface address:/api/rest_j/v1/jobhistory/list

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Acquire global historical data list according to conditions and get all by default

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
creatorCreatorqueryfalsestring
endDateEnd timequeryfalseinteger(int64)
executeApplicationNameoperatorqueryfalsestring
isAdminViewWhether it is in administrator mode or normal modequeryfalseboolean
pageSizeNumber of pagesqueryfalseref
proxyUserProxy Userqueryfalsestring
startDateStart timequeryfalseinteger(int64)
statusend timequeryfalsestring
taskIDIDqueryfalseinteger(int64)
tpageNowpage numberqueryfalseref
pageNowpageNowqueryfalseinteger(int32)

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

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

Sample Response:

{
{
"method": "/api/jobhistory/list",
"status": 0,
"message": "OK",
"data": {
"solution": null,
"totalPage": 90,
"tasks": [{
"taskID": ,
"instance": ",
"execId": "",
"umUser": "",
"engineInstance": null,
"executionCode": "",
"progress": "",
"logPath": "",
"resultLocation": "",
"status": "",
"createdTime": ,
"updatedTime": ,
"engineType": "",
"errCode": 0,
"errDesc": "",
"executeApplicationName": "",
"requestApplicationName": "",
"runType": "datachecker",
"paramsJson": "",
"costTime": 1000,
"strongerExecId": "",
"sourceJson": "",
"sourceTailor": "",
"engineStartTime": null,
"labels": [],
"canRetry": ,
"subJobs":
}]
}
}
}

list undo

Interface address:/api/rest_j/v1/jobhistory/listundone

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Undo list

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
creatorcreatorqueryfalsestring
endDateEnd timequeryfalseinteger(int64)
engineTypeengineTypequeryfalsestring
pageNowpageNowqueryfalseref
pageSizepageSizequeryfalseref
startDateStart timequeryfalseref
startTaskIDstartTaskIDqueryfalseinteger(int64)
statusstatusqueryfalsestring

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
}

History details

Interface address:/api/rest_j/v1/jobhistory/{id}/get

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Get the detailed information of a history through the history ID

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
idHistoryIdqueryfalseinteger(int64)

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

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

Sample Response:

{
"method": "/api/jobhistory/1928730/get",
"status": 0,
"message": "OK",
"data": {
"task": {
"taskID": ,
"instance": "",
"execId": "",
"umUser": "",
"engineInstance": "",
"executionCode": "",
"progress": "",
"logPath": "",
"resultLocation": "",
"status": "",
"createdTime":,
"updatedTime": ,
"engineType": "",
"errCode": ,
"errDesc": "",
"executeApplicationName": "",
"requestApplicationName": "",
"runType": "hql",
"paramsJson": "",
"costTime": ,
"strongerExecId": "",
"sourceJson": "",
"sourceTailor": "",
"engineStartTime": null,
"labels": [""],
"canRetry": false,
"subJobs": null
}
}
}