title: Context Logging Service sidebar_position: 17

** ContextIDRestfulApi class **

create text record

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

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:Create text record

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
jsonNodejsonNodebodytrueJsonNodeJsonNode
contextIDContextIdfalseStringString

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 text ID

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

Request method: GET

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

Response data type: */*

Interface description:Get text ID

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
contextIdContextIdqueryfalsestring

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
}

delete text ID

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

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:Delete text ID

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
jsonNodejsonNodebodytrueJsonNodeJsonNode
contextIdContextIdfalseStringString

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 text ID

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

Request method: POST

Request data type: application/json

Response data type: */*

Interface Description:Reset Text ID

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
jsonNodejsonNodebodytrueJsonNodeJsonNode
contextIdContextIdfalseStringString

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 text Id execution time

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

Request method: GET

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

Response data type: */*

Interface description:Search text ID execution time

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
accessTimeEndAccess end timequeryfalsestring
accessTimeStartAccess Start Timequeryfalsestring
createTimeEndCreate end timequeryfalsestring
createTimeStartcreate timequeryfalsestring
pageNowpage numberqueryfalsestring
pageSizepage sizequeryfalsestring
updateTimeEndUpdate end timequeryfalsestring
updateTimeStartUpdate timequeryfalsestring

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
}

Modify text ID

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

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:Modify text ID

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
jsonNodejsonNodebodytrueJsonNodeJsonNode
contextIdContextIdfalseStringString

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
}