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 name Parameter description Request type Required Data type schema
engineType engineType query false string
keyJson keyJson query false string
token token query false string
version version 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:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

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:

1. {
2. "categoryName": "",
3. "description": ""
4. }

Request Parameters:

Parameter name Parameter description Required Request type Data type schema
categoryName Reference type label name false String String
description Description 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:

1. {
2. "method": "/api/configuration/createFirstCategory",
3. "status": 0,
4. "message": "OK",
5. "data": {}
6. }

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:

1. {
2. categoryId: ,
3. description: "",
4. engineType: "",
5. version: ""
6. }

Request Parameters:

Parameter name Parameter description Required Request type Data type schema
categoryId Parameter ConfigurationId true String String
description Description true String String
engineType Engine Type true String String
version version number true 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:

1. {
2. "method": "/api/configuration/createSecondCategory",
3. "status": 0,
4. "message": "OK",
5. "data": {}
6. }

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:

1. {
2. categoryId:
3. }

Request Parameters:

Parameter name Parameter description Request type Required Data type schema
categoryId Parameter ConfigurationId String true 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:

1. {
2. "method": "/api/configuration/deleteCategory",
3. "status": 0,
4. "message": "OK",
5. "data": {}
6. }

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 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:

1. {
2. "method": "/api/configuration/engineType",
3. "status": 0,
4. "message": "OK",
5. "data": {
6. "engineType": []
7. }
8. }

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 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:

1. {
2. "method": "/api/configuration/getCategory",
3. "status": 0,
4. "message": "OK",
5. "data": {
6. "Category": [{
7. "categoryId": ,
8. "labelId": ,
9. "categoryName": "",
10. "childCategory": [],
11. "description": null,
12. "tag": null,
13. "createTime": ,
14. "updateTime": ,
15. "level": ,
16. "fatherCategoryName": ""
17. }],
18. "description": null,
19. "tag": null,
20. "createTime": ,
21. "updateTime": ,
22. "level": ,
23. "fatherCategoryName":
24. }]
25. }
26. }

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 name Parameter description Request type Required Data type schema
creator label name query false string
engineType engineType query false string
version version 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:

1. {
2. "method": "/api/configuration/getFullTreesByAppName",
3. "status": 0,
4. "message": "OK",
5. "data": {
6. "fullTree": [{
7. "name": "Queue Resource",
8. "description": null,
9. "settings": [{
10. "id": ,
11. "key": "",
12. "description": "",
13. "name": "",
14. "defaultValue": "",
15. "validateType": "",
16. "validateRange": "[]",
17. "level": 1,
18. "engineType": ,
19. "treeName": "",
20. "valueId": ,
21. "configValue": "",
22. "configLabelId": ,
23. "unit": null,
24. "isUserDefined": ,
25. "hidden": ,
26. "advanced":
27. }]
28. }]
29. }
30. }

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 name Parameter description Request type Required Data type schema
configKey configKey query true string
creator creator query false string
engineType engineType query false string
version version 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:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

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 name Parameter description Required Request type Data type schema
configKey configKey true String String
configValue configValue true String String
creator creator true String String
engineType engineType true String String
version version true String String
SaveKeyValue json body true SaveKeyValue SaveKeyValue

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:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

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 name Parameter description Required Request type Data type schema
configKey configKey true String String
creator creator true String String
engineType engineType true String String
version version true String String

Response Status:

Status code Description schema
200 OK Message
204 No Content
401 Unauthorized
403 Forbidden

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:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

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 name Parameter description Request type Required Data type schema
creator creator query false string
engineType engineType query false string
username username query false string
version version 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:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

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 name Parameter description Request type Required Data type schema
creator App Type Name String true String
description Description, belonging to the content in fullTree String true String
engineType Engine Type String true String
fullTree Details under Application Type List true List
name Queue resource name, which belongs to the content in fullTree String true String
settings Detailed content in the queue resource, belonging to the content in fullTree List true List

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:

1. {
2. "method": "/api/configuration/saveFullTree",
3. "status": 0,
4. "message": "OK",
5. "data": {}
6. }

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:

1. {
2. description: "",
3. categoryId:
4. }

Request Parameters:

Parameter name Parameter description Request type Required Data type schema
categoryId categoryId String true String
description description String true 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:

1. {
2. "method": "/api/configuration/updateCategoryInfo",
3. "status": 0,
4. "message": "OK",
5. "data": {}
6. }