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

put
https://api.box.com/2.0
/skill_invocations/:skill_id/

ファイルのすべてのBox Skillメタデータカードを上書きおよび更新するために使用できる代替方法。

Request

Bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
33243242

このメタデータを適用するスキルのID。

Request Body

objectin body

カードを割り当てるファイル。

stringin bodyrequired
3243244

ファイルのID

stringin bodyrequired
file

Value is always file

objectin body

カードを割り当てるファイルバージョン (省略可)。

stringin bodyoptional
731381601045

ファイルバージョンのID

stringin bodyoptional
file_version

Value is always file_version

objectin body

このスキルに設定するメタデータ。Box Skillsカードのリストです。ファイルの既存のBoxスキルカードはすべてこれらのカードで上書きされます。

stringin bodyrequired
success

この呼び出しのステータスを定義します。スキルカードを設定する際は、successに設定します。

Value is one of invoked,processing,success,transient_failure,permanent_failure

objectin body

この呼び出しの影響を受ける項目を定義する記述子。

カードをsuccess状態に設定する場合はこれをデフォルト値に設定し、それ以外のほとんどの場合には省略してください。

stringin bodyoptional
file

file

numberin bodyoptional
1

1

Response

none

ファイルが正常に更新された場合は、空のレスポンスを返します。

リクエスト本文が無効な場合にエラーを返します。

  • schema_validation_failed - リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、enumまたはmultiSelectフィールドに不明なオプションが指定されている場合があります。

ファイルが見つからないか、ユーザーにアクセス権限がない場合はエラーを返します。

  • not_found - ファイルが見つからないか、ユーザーがファイルにアクセスできない場合に返されます。

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

put
ファイルのすべてのBox Skillカードを更新
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X PUT "https://api.box.com/2.0/skill_invocations/33243242" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "Content-Type: application/json" \
     -d '{
       "status": "success",
       "metadata": {
         "cards": [{
            "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" }
            }
          },{
            "type": "skill_card",
            "skill_card_type": "transcript",
            "skill_card_title": {
              "code": "video-transcription",
              "message": "Video Transcription"
            },
            "skill": {
              "type": "service"
              "id": "video-transcription-service"
            },
            "invocation": {
              "type": "skill_invocation"
              "id": "video-transcription-service-123"
            },
            "duration": 1000,
            "entries": {
              {
                "text": "Hi John, have I told you about Box recently?",
                "appears": [{ "start": 0 }]
              },
              {
                "text": "No Aaron, you have not. Tell me more!",
                "appears": [{ "start": 5 }]
              }
            }
          },{
            "type": "skill_card",
            "skill_card_type": "timeline",
            "skill_card_title": {
              "code": "face-detection",
              "message": "Faces"
            },
            "skill": {
              "type": "service"
              "id": "face-detection-service"
            },
            "invocation": {
              "type": "skill_invocation"
              "id": "face-detection-service-123"
            },
            "duration": 1000,
            "entries": {
              {
                "text": "John",
                "appears": [{ "start": 0, "end": 5 }, { "start": 10, "end": 15 }],
                "image_url": "https://example.com/john.png"
              },
              {
                "text": "Aaron",
                "appears": [{ "start": 5, "end": 10 }],
                "image_url": "https://example.com/aaron.png"
              }
            }
          },{
            "type": "skill_card",
            "skill_card_type": "status",
            "skill_card_title": {
              "code": "hold",
              "message": "Please hold..."
            },
            "skill": {
              "type": "service"
              "id": "face-detection-service"
            },
            "invocation": {
              "type": "skill_invocation"
              "id": "face-detection-service-123"
            },
            "status": {
              "code": "processing",
              "message": "We are processing this file right now."
            }
          }],
       },
       "file": {
         "id": "12345"
       },
       "usage": {
         "unit": "file",
         "value": 1
       }
     }'