最新バージョン
ファイルのすべてのBox Skillカードを更新
ファイルのすべてのBox Skillメタデータカードを上書きおよび更新するために使用できる代替方法。
リクエスト
bearer [ACCESS_TOKEN]
application/json
パスパラメータ
stringパス内必須
33243242このメタデータを適用するスキルのID。
リクエスト本文
object本文内
カードを割り当てるファイル。
string本文内必須
"3243244"ファイルのID
string本文内必須
"file"file
次の値に固定: file
object本文内
カードを割り当てるファイルバージョン (省略可)。
string本文内省略可能
"731381601045"ファイルバージョンのID
string本文内省略可能
"file_version"file_version
次の値に固定: file_version
object本文内
このスキルに設定するメタデータ。Box Skillsカードのリストです。ファイルの既存のBox Skillsカードはすべてこれらのカードで上書きされます。
このファイルに適用するBox Skillカードのリスト。
string本文内必須
"success"この呼び出しのステータスを定義します。スキルカードを設定する際は、successに設定します。
次の値のいずれか1つ: invoked,processing,success,transient_failure,permanent_failure
object本文内
この呼び出しの影響を受ける項目を定義する記述子。
カードをsuccess状態に設定する場合はこれをデフォルト値に設定し、それ以外のほとんどの場合には省略してください。
string本文内省略可能
"file"file
number本文内省略可能
11
レスポンス
none
ファイルが正常に更新された場合は、空のレスポンスを返します。
application/jsonクライアントエラー
リクエスト本文が無効な場合にエラーを返します。
schema_validation_failed- リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、enumまたはmultiSelectフィールドに不明なオプションが指定されている場合があります。
application/jsonクライアントエラー
ファイルが見つからないか、ユーザーにアクセス権限がない場合はエラーを返します。
not_found- ファイルが見つからないか、ユーザーがファイルにアクセスできない場合に返されます。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
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
}
}'