Skip to main content
Version: 1.3.0

Context API

ContextRestfulApi class

Clear all context by ID

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 nameParameter descriptionRequiredRequest typeData typeschema
idListContext id 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:

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

Clear all context by time

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 nameParameter descriptionRequiredRequest typeData typeschema
bodyMapbodyMapbodytrueobject
accessTimeEndAccess Time EndfalseStringString
accessTimeStartAccess Time StartfalseStringString
createTimeEndCreate time endfalseStringString
createTimeStartCreate TimefalseStringString
updateTimeStartUpdate start timefalseStringString

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
}

Get context content

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 nameParameter descriptionRequiredRequest typeData typeschema

| |contextID|context id|false|String|String| |contextKey|contextKey|false|String|String|

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 all values

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 nameParameter descriptionRequiredRequest typeData typeschema

| |contextID|context id|false|String|String| |contextKey|contextKey|false|String|String|

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
}

Remove all values ​​by value prefix

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 nameParameter descriptionRequiredRequest typeData typeschema

| |contextID|contextID|false|String|String| |keyPrefix|keyPrefix|false|String|String|

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
}

Remove all values ​​by key prefix and context type

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 nameParameter descriptionRequiredRequest typeData typeschema

| |contextKeyType|contextKeyType|false|String|String| |keyPrefix|keyPrefix|false|String|String|

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 value

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 nameParameter descriptionRequiredRequest typeData typeschema

| |contextID|context id|false|String|String| |contextKey|contextKey|false|String|String|

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
}

reset value

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 nameParameter descriptionRequiredRequest typeData typeschema

| |contextID|context id|false|String|String| |contextKey|contextKey|false|String|String|

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
}

search context content

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 nameParameter descriptionRequiredRequest typeData typeschema

| |condition|condition|false|String|String| |contextID|context id|false|String|String|

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
}

set value

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 nameParameter descriptionRequiredRequest typeData typeschema

| |contextID|context id|false|String|String| |contextKeyValue|contextKeyValue|false|String|String|

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
}

set key

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 nameParameter descriptionRequiredRequest typeData typeschema

| |contextID|context id|false|String|String| |contextKey|contextKey|false|String|String|

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
}