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

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

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

リクエスト

Bearer [ACCESS_TOKEN]
application/json-patch+json

パスパラメータ

stringパス内必須
12345

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

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

リクエスト本文

object array本文内必須

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

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

string本文内省略可能
replace

次の値に固定: replace

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

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

レスポンス

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

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

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

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

リクエストの例

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" }
         }
       }
     ]'

レスポンスの例

{
  "$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",
      "type": "skill_card",
      "skill_card_type": "status",
      "skill_card_title": {
        "code": "my_transcripts",
        "message": "My Transcripts"
      },
      "status": {
        "code": "success",
        "message": "We're preparing to process your file. Please hold on!"
      },
      "skill": {
        "type": "service",
        "id": "image-recognition-service"
      },
      "invocation": {
        "type": "skill_invocation",
        "id": "image-recognition-service-123"
      },
      "duration": 1000,
      "entries": [
        {
          "text": "keyword1",
          "appears": [
            {
              "start": 1,
              "end": 20
            }
          ],
          "image_url": "https://example.com/image1.jpg"
        }
      ]
    }
  ]
}