Get update list

Prev Next

Available in Classic and VPC

Get the service update information.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET /services/{serviceId}/updates

Request headers

For headers common to all AiTEMS APIs, see Common AiTEMS headers.

Request path parameters

The following describes the parameters.

Field Type Required Description
serviceId String Required Service ID

Request query parameters

The following describes the parameters.

Field Type Required Description
type String Required Training request type
  • personalRecommend | relatedItem | pop
    • personalRecommend: personalized recommendations based on customer service users' past history
    • relatedItem: personalized recommendations based on an item's association history
    • pop: top item recommendations by rank
trainVersion String Required Training version

Request example

The following is a sample request.

curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/services/49qkb******/updates
?type=personalRecommend
&trainVersion=9fn93******' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

Response

The following describes the response format.

Response body

The following describes the response body.

Field Type Required Description
updates[].updateVersion String - Update version
updates[].status String - Update status
updates[].type String - Training request type
  • personalRecommend | relatedItem | pop
    • personalRecommend: personalized recommendations based on customer service users' past history
    • relatedItem: personalized recommendations based on an item's association history
    • pop: top item recommendations by rank
updates[].createdDate String - Update request date and time
updates[].finishedDate String - Update completion date and time
updates[].updateResult Object - Update result
updates[].updateResult.inputUsersCnt Integer - Number of users requested for update
updates[].updateResult.inputItemsCnt Integer - Number of items requested for update
updates[].updateResult.inputRowsCnt Integer - Number of interactions (logs) requested for update
updates[].updateResult.updatedItemsCnt Integer - Number of items updated
updates[].updateResult.updatedUsersCnt Integer - Number of users updated

Response status codes

For response status codes common to all AiTEMS APIs, see Common AiTEMS API response status codes.

Response example

The following is a sample example.

{
  "updates": [
    {
      "updateVersion": "sl3ao******",
      "status": "completed",
      "type": "personalRecommend",
      "createdDate": "2024-08-16T15:37:34.720Z",
      "finishedDate": "2024-08-16T15:37:34.720Z",
      "updateResult": {
        "inputUsersCnt": 2,
        "inputItemsCnt": 0,
        "inputRowsCnt": 2,
        "updatedItemsCnt": 0,
        "updatedUsersCnt": 2
      }
    }
  ]
}