人物更新サムネイルの削除

Prev Next

最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。

VPC環境で利用できます。

人物に設定されているサムネイルのうち、指定された項目を削除します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
DELETE /api/v1/workspaces/{workspace_name}/persons/{person_id}/person-thumbnail

リクエストヘッダ

Media Intelligence API で共通して使用されるヘッダの詳細は、Media Intelligenceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
workspace_name String Required ワークスペース名
person_id Integer Required 人物 ID

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
thumbnailIds Array<Integer> Required 削除対象のサムネイル IDリスト
  • 存在しないか、既に削除された IDは無視される

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request DELETE 'https://maiu.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons/1001/person-thumbnail' \
--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' \
--data '{
  "thumbnailIds": [1234]
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code String Required API処理結果コード
message String Required API処理結果メッセージ
result Object Required 人物サムネイルリストオブジェクト

result

フィールド タイプ 必須の有無 説明
thumbnailList Array Required 人物に最終的に登録されたサムネイルリスト
  • リクエストにより削除された項目を除く全リスト
thumbnailList[].id Integer Required サムネイル ID
thumbnailList[].url String Required サムネイル画像 URL (Presigned URL)
thumbnailList[].isPrimaryThumbnail Boolean Required 代表サムネイルかどうか
  • true | false

レスポンスステータスコード

Media Intelligence APIで共通して使用されるレスポンスステータスコードの詳細は、Media Intelligenceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "code": "0",
  "message": "success",
  "result": {
    "thumbnailList": [
      {
        "id": 4321,
        "url": "https://kr.object.ncloudstorage.com/.../jiho2.jpg?...",
        "isPrimaryThumbnail": true
      }
    ]
  }
}