人物の更新

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://mi.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	-	API処理結果コード
`message`	String	-	API処理結果メッセージ
`result`	Object	-	人物詳細情報オブジェクト
`result.id`	Integer	-	人物 ID
`result.name`	String	-	人物名
`result.description`	String	-	人物の説明
`result.tags`	Array	-	人物に設定されたタグリスト: tags
`result.thumbnails`	Array	-	人物に登録されたサムネイルリスト: thumbnails

`tags`

tagsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	Integer	-	タグ ID
`name`	String	-	タグ名

`thumbnails`

thumbnailsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	Integer	-	サムネイル ID
`url`	String	-	サムネイル画像 URL (Presigned URL)
`isPrimaryThumbnail`	Boolean	-	代表サムネイルかどうか `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
      }
    ]
  }
}