Context API

ContextRestfulApi class

Interface address: /api/rest_j/v1/contextservice/clearAllContextByID

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Clear all context by ID

Request Parameters:

Parameter name Parameter description Required Request type Data type schema
idList Context 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:

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

Interface address:/api/rest_j/v1/contextservice/clearAllContextByTime

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Clear so context by time

Request Parameters:

Parameter name Parameter description Required Request type Data type schema
bodyMap bodyMap body true object
accessTimeEnd Access Time End false String String
accessTimeStart Access Time Start false String String
createTimeEnd Create time end false String String
createTimeStart Create Time false String String
updateTimeStart Update start time 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. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

Interface address:/api/rest_j/v1/contextservice/getContextValue

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Get context content

Request Parameters:

Parameter name Parameter description Required Request type Data type schema

| |contextID|context id|false|String|String| |contextKey|contextKey|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. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

Interface address:/api/rest_j/v1/contextservice/removeAllValue

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Delete all values

Request Parameters:

Parameter name Parameter description Required Request type Data type schema

| |contextID|context id|false|String|String| |contextKey|contextKey|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. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

Interface address:/api/rest_j/v1/contextservice/removeAllValueByKeyPrefix

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Remove all values ​​by prefix and context type

Request Parameters:

Parameter name Parameter description Required Request type Data type schema

| |contextID|contextID|false|String|String| |keyPrefix|keyPrefix|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. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

Interface address:/api/rest_j/v1/contextservice/removeAllValueByKeyPrefixAndContextType

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Remove all values ​​by prefix and context type

Request Parameters:

Parameter name Parameter description Required Request type Data type schema

| |contextKeyType|contextKeyType|false|String|String| |keyPrefix|keyPrefix|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. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

Interface address:/api/rest_j/v1/contextservice/removeValue

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Delete value

Request Parameters:

Parameter name Parameter description Required Request type Data type schema

| |contextID|context id|false|String|String| |contextKey|contextKey|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. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

Interface address:/api/rest_j/v1/contextservice/resetValue

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Reset value

Request Parameters:

Parameter name Parameter description Required Request type Data type schema

| |contextID|context id|false|String|String| |contextKey|contextKey|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. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

Interface address:/api/rest_j/v1/contextservice/searchContextValue

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Search context content

Request Parameters:

Parameter name Parameter description Required Request type Data type schema

| |condition|condition|false|String|String| |contextID|context id|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. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

Interface address:/api/rest_j/v1/contextservice/setValue

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Set value

Request Parameters:

Parameter name Parameter description Required Request type Data type schema

| |contextID|context id|false|String|String| |contextKeyValue|contextKeyValue|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. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

Interface address:/api/rest_j/v1/contextservice/setValueByKey

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Set key for value

Request Parameters:

Parameter name Parameter description Required Request type Data type schema

| |contextID|context id|false|String|String| |contextKey|contextKey|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. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }