人物の更新

Prev Next

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

VPC環境で利用できます。

人物情報を更新します。

リクエスト

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

メソッド URI
PATCH /api/v1/workspaces/{workspace_name}/persons/{person_id}

リクエストヘッダ

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

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

パラメータの説明は次の通りです。

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
name String Optional 人物名
  • 1~50文字
  • ワークスペース内で重複不可
  • 空白文字列または空白のみ含む場合、登録不可
description String Optional 人物の説明
  • 1~700文字
primaryThumbnailId Integer Optional 代表サムネイル ID

リクエスト例

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

curl --location --request PATCH 'https://maiu.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons/1001' \
--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 '{
  "name": "ユ・ジェソク",
  "description": "韓国の代表的な MCです。",
  "primaryThumbnailId": 3002
}'

レスポンス

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

レスポンスボディ

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

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

result

フィールド タイプ 必須の有無 説明
id Integer Required 人物 ID
name String Required 人物名
description String Optional 人物の説明
tags Array Required 人物に設定されたタグリスト
  • 0~
tags[].id Integer Required タグ ID
tags[].name String Required タグ名
thumbnails Array Required 人物に登録されたサムネイルリスト
  • 0~
thumbnails[].id Integer Required サムネイル ID
thumbnails[].url String Required サムネイル画像 URL (Presigned URL)
thumbnails[].isPrimaryThumbnail Boolean Required 代表サムネイルかどうか
  • true | false

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

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

レスポンス例

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

{
  "code": "0",
  "message": "success",
  "result": {
    "id": 1001,
    "name": "ユ・ジェソク",
    "description": "韓国の代表的な MCです。",
    "tags": [
      {
        "id": 202,
        "name": "テレビ俳優"
      }
    ],
    "thumbnails": [
      {
        "id": 3002,
        "url": "https://kr.object.ncloudstorage.com/.../9870829644790204567.jpg?...",
        "isPrimaryThumbnail": true
      }
    ]
  }
}