점검 요청

개요

• 점검 항목의 점검을 요청합니다.
• 점검 항목마다 각각의 status(점검 요청 상태)를 가지며, status 가 NONE(점검 요청 가능 상태)인 점검 항목에 대한 점검 요청만 실제 수행됩니다.
  • status 는 점검 요청의 진행 단계, 혹은 시간이 지남에 따라 내부적으로 변화하며 아래 다섯 가지 중 하나의 값을 가집니다.
    • NONE: 점검 요청 가능.
    • ENQUEUED: 점검 대기 중.
    • PROCESSING: 점검 진행 중.
    • DONE: 점검 요청 완료. 다음 요청까지 대기 필요.
    • FAIL: 점검 실패.
• 점검 요청 기능은 연관 상품마다 각기 다른 재요청 가능 시간을 두고 있습니다.
  • 점검 항목의 status가 DONE, FAIL 그리고 ENQUEUED 인 상태에서 재요청 가능 시간이 지나면, NONE 상태로 초기화됩니다.
• 점검 항목의 status로 인해 점검 요청이 실제로 수행되지 않더라도 요청 처리 성공(200, OK)으로 응답합니다.
  • 점검 항목별로 점검 요청을 실제로 수행했는지 여부는 Response Body 의 requestSuccess 필드를 통해 알 수 있습니다.
    (true : 성공 / false : 실패)
  • requestSucess 필드가 false 로 응답되더라도, status 필드의 값이 ENQUEUED, PROCESSING 이라면 점검 요청이 기존에 이미 진행 중인 것으로 이해할 수 있습니다.

API

• POST /categories/{categoryCode}/checkitems/refresh
  • {categoryCode} 에 해당하는 모든 점검 항목에 대한 점검을 수행합니다.
• POST /categories/{categoryCode}/checkitems/{itemCode}/refresh
  • {itemCode} 에 해당하는 하나의 점검 항목에 대한 점검을 수행합니다.
  • 입력한 {categoryCode} 에 포함되지 않은 {itemCode} 를 입력하여 요청했을 때도 404 오류가 발생합니다.

요청

Headers

개요에 명시된 공통 요청 헤더가 필요합니다.

Path Variables

응답

• 점검 수행 후 점검 항목 상태 조회 기능과 같은 결과를 응답합니다.

Response Body

{
  "result": "SUCCESS",
  "contents": [
    {
      "itemCode": String,
      "timeToRefresh": Timestamp,
      "lastRequestTime": Timestamp,
      "status": String,
      "requestSuccess": Boolean
    },
    ...
  ]
}