Box Developerドキュメント
ログイン
最新バージョン

ファイルのBox Skillカードを更新

put
https://api.box.com/2.0
/files/:file_id/metadata/global/boxSkillsCards

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

ファイルの1つ以上のBox Skillsメタデータカードを更新します。

リクエスト

bearer [ACCESS_TOKEN]
application/json-patch+json

パスパラメータ

stringパス内必須
12345

ファイルを表す一意の識別子。

ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_idは123です。

リクエスト本文

object array本文内必須

メタデータテンプレートに変更を加えるためのJSON-Patchの指定。

変更は操作オブジェクトのJSON配列として表されます。

string本文内省略可能
"replace"

値は常にreplaceになります。

次の値に固定: replace

string本文内省略可能
"/cards/0"

置き換えるカードを表すJSONパス。ほとんどの場合、これは/cards/{index}形式になります (indexは、カードのリストにおいてそのカードの位置を示すゼロから始まるインデックスです)。

キーワードスキルカード / ステータススキルカード / タイムラインスキルカード / トランスクリプトスキルカード。 object本文内

カードのリスト内のpathで定義された位置に挿入されるカード。

レスポンス

application/jsonSkillsメタデータインスタンス

カスタムテンプレートデータを含め、更新されたメタデータテンプレートを返します。

application/jsonクライアントエラー

リクエストしたファイルが見つかりませんでした。

application/jsonクライアントエラー

予期しないクライアントエラー。

put
ファイルのBox Skillカードを更新
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

Box SDKのバージョン戦略の詳細については、 **こちら**を確認してください。


cURL
curl -i -X PUT "https://api.box.com/2.0/files/12345/metadata/global/boxSkillsCards" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json-patch+json" \
     -d '[
       "op": "replace",
       "path": "/cards/0",
       "value": {
         "type": "skill_card",
         "skill_card_type": "keyword",
         "skill_card_title": {
           "code": "license-plates",
           "message": "Licence Plates"
         },
         "skill": {
           "type": "service"
           "id": "license-plates-service"
         },
         "invocation": {
           "type": "skill_invocation"
           "id": "license-plates-service-123"
         },
         "entries": {
           { "text": "DD-26-YT" },
           { "text": "DN86 BOX" }
         }
       }
     ]'
Node/TypeScript v10
await client.skills.updateBoxSkillCardsOnFile(file.id, [
  {
    op: 'replace' as UpdateBoxSkillCardsOnFileRequestBodyOpField,
    path: '/cards/0',
    value: cardToUpdate,
  } satisfies UpdateBoxSkillCardsOnFileRequestBody,
]);
Python v10
client.skills.update_box_skill_cards_on_file(
    file.id,
    [
        UpdateBoxSkillCardsOnFileRequestBody(
            op=UpdateBoxSkillCardsOnFileRequestBodyOpField.REPLACE,
            path="/cards/0",
            value=card_to_update,
        )
    ],
)
Java v10
client.getSkills().updateBoxSkillCardsOnFile(file.getId(), Arrays.asList(new UpdateBoxSkillCardsOnFileRequestBody.Builder().op(UpdateBoxSkillCardsOnFileRequestBodyOpField.REPLACE).path("/cards/0").value(cardToUpdate).build()))

レスポンスの例

{
  "$canEdit": true,
  "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
  "$parent": "folder_59449484661,",
  "$scope": "enterprise_27335",
  "$template": "properties",
  "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
  "$typeVersion": 2,
  "$version": 1,
  "cards": [
    {
      "created_at": "2018-04-13T13:53:23-07:00",
      "entries": [
        {
          "text": "keyword1"
        }
      ],
      "invocation": {
        "id": "image-recognition-service-123",
        "type": "skill_invocation"
      },
      "skill": {
        "id": "image-recognition-service",
        "type": "service"
      },
      "skill_card_title": {
        "code": "labels",
        "message": "Labels"
      },
      "skill_card_type": "keyword",
      "type": "skill_card"
    }
  ]
}