Skip to main content
Version: 1.6.0

Parameter Configuration

ConfigurationRestfulApi class

Add KeyForEngine

Interface address:/api/rest_j/v1/configuration/addKeyForEngine

Request method: GET

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

Response data type: */*

Interface description:

Add KeyForEngine

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
engineTypeengineTypequeryfalsestring
keyJsonkeyJsonqueryfalsestring
tokentokenqueryfalsestring
versionversionqueryfalsestring

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
}

Add application type

Interface address:/api/rest_j/v1/configuration/createFirstCategory

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Add application type tag

Request example:

{
"categoryName": "",
"description": ""
}

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
categoryNameReference type label namefalseStringString
descriptionDescriptionfalseStringSTRing

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/configuration/createFirstCategory",
"status": 0,
"message": "OK",
"data": {}
}

Add parameter configuration

Interface address:/api/rest_j/v1/configuration/createSecondCategory

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Add parameter configuration

Request example:

{
categoryId: ,
description: "",
engineType: "",
version: ""
}

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
categoryIdParameter ConfigurationIdtrueStringString
descriptionDescriptiontrueStringString
engineTypeEngine TypetrueStringString
versionversion numbertrueStringString

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/configuration/createSecondCategory",
"status": 0,
"message": "OK",
"data": {}
}

delete configuration

Interface address: /api/rest_j/v1/configuration/deleteCategory

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Delete parameter configuration

Request example:

{
categoryId:
}

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
categoryIdParameter ConfigurationIdStringtrueString

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/configuration/deleteCategory",
"status": 0,
"message": "OK",
"data": {}
}

Engine type list

Interface address:/api/rest_j/v1/configuration/engineType

Request method: GET

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

Response data type: */*

Interface description:

Get a list of engine types

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:

{
"method": "/api/configuration/engineType",
"status": 0,
"message": "OK",
"data": {
"engineType": []
}
}

App types

Interface address: /api/rest_j/v1/configuration/getCategory

Request method: GET

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

Response data type: */*

Interface description:

Apply type tag in parameter configuration

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:

{
"method": "/api/configuration/getCategory",
"status": 0,
"message": "OK",
"data": {
"Category": [{
"categoryId": ,
"labelId": ,
"categoryName": "",
"childCategory": [],
"description": null,
"tag": null,
"createTime": ,
"updateTime": ,
"level": ,
"fatherCategoryName": ""
}],
"description": null,
"tag": null,
"createTime": ,
"updateTime": ,
"level": ,
"fatherCategoryName":
}]
}
}

queue resources

Interface address:/api/rest_j/v1/configuration/getFullTreesByAppName

Request method: GET

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

Response data type: */*

Interface description:

The queue resource module in the parameter configuration returns the column and value of the queue resource

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
creatorlabel namequeryfalsestring
engineTypeengineTypequeryfalsestring
versionversionqueryfalsestring

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/configuration/getFullTreesByAppName",
"status": 0,
"message": "OK",
"data": {
"fullTree": [{
"name": "Queue Resource",
"description": null,
"settings": [{
"id": ,
"key": "",
"description": "",
"name": "",
"defaultValue": "",
"validateType": "",
"validateRange": "[]",
"level": 1,
"engineType": ,
"treeName": "",
"valueId": ,
"configValue": "",
"configLabelId": ,
"unit": null,
"isUserDefined": ,
"hidden": ,
"advanced":
}]
}]
}
}

Get key value

Interface address:/api/rest_j/v1/configuration/keyvalue

Request method: GET

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

Response data type: */*

Interface description:

Get key value

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
configKeyconfigKeyquerytruestring
creatorcreatorqueryfalsestring
engineTypeengineTypequeryfalsestring
versionversionqueryfalsestring

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
}

save key value

Interface address:/api/rest_j/v1/configuration/keyvalue

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Save key value

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
configKeyconfigKeytrueStringString
configValueconfigValuetrueStringString
creatorcreatortrueStringString
engineTypeengineTypetrueStringString
versionversiontrueStringString
SaveKeyValuejsonbodytrueSaveKeyValueSaveKeyValue

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
}

delete key value

Interface address:/api/rest_j/v1/configuration/keyvalue

Request method: DELETE

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

Response data type: */*

Interface description:

Delete key value

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
configKeyconfigKeytrueStringString
creatorcreatortrueStringString
engineTypeengineTypetrueStringString
versionversiontrueStringString

Response Status:

Status codeDescriptionschema
200OKMessage
204No Content
401Unauthorized
403Forbidden

Response parameters:

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

Sample Response:

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

rpc test

Interface address: /api/rest_j/v1/configuration/rpcTest

Request method: GET

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

Response data type: */*

Interface description:

rpc test

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
creatorcreatorqueryfalsestring
engineTypeengineTypequeryfalsestring
usernameusernamequeryfalsestring
versionversionqueryfalsestring

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
}

Save queue resources

Interface address:/api/rest_j/v1/configuration/saveFullTree

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Save queue resources

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
creatorApp Type NameStringtrueString
descriptionDescription, belonging to the content in fullTreeStringtrueString
engineTypeEngine TypeStringtrueString
fullTreeDetails under Application TypeListtrueList
nameQueue resource name, which belongs to the content in fullTreeStringtrueString
settingsDetailed content in the queue resource, belonging to the content in fullTreeListtrueList

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/configuration/saveFullTree",
"status": 0,
"message": "OK",
"data": {}
}

Update category information

Interface address: /api/rest_j/v1/configuration/updateCategoryInfo

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Update category information

Sample Response:

{
description: "",
categoryId:
}

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
categoryIdcategoryIdStringtrueString
descriptiondescriptionStringtrueString

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/configuration/updateCategoryInfo",
"status": 0,
"message": "OK",
"data": {}
}