スキル呼び出しを更新

put

https://api.box.com/2.0

/skill_invocations/:skill_invocation_id

スキル呼び出しのステータス、利用状況、応答のメタデータを更新します。

リクエスト

Content-Typeapplication/json

パスパラメータ

skill_invocation_id stringパス内必須

例33243242

スキル呼び出しのID。

リクエスト本文

file object本文内

このメタデータを割り当てるファイル

file.id stringnull省略可能

例3243244

ファイルのID

file.type stringnull省略可能

例file

次の値に固定: file

file_version object本文内

このメタデータを割り当てるファイルバージョン

file_version.id stringnull省略可能

例3

ファイルバージョンのID

file_version.type stringnull省略可能

例file_version

次の値に固定: file_version

metadata object本文内

このスキルに対して設定するメタデータ

metadata.cardsobject arraynull省略可能

ファイルに設定するメタデータカード。

[cards.created_at] string / date-timenull条件付きで必須

例2012-12-12T10:53:43-08:00

カードが作成された日時

[cards.duration] integernull省略可能

例1000

期間(省略可)。

transcriptのcard_type、またはtimelineで使用します。

[cards.entries]object arraynull省略可能

エントリのリスト(省略可)。

transcriptのcard_type、keyword、またはtimelineで使用します。

[entries.text] stringnull条件付きで必須

例keyword1

エントリのテキスト

[entries.type] stringnull条件付きで必須

例text

次の値に固定: text

[cards.invocation] objectnull

現在のスキル呼び出し

invocation.id stringnull省略可能

例33243242

スキル呼び出しのID。

invocation.type stringnull省略可能

例skill_invocation

次の値に固定: skill_invocation

[cards.skill] objectnull

カードを更新しているスキル

skill.id stringnull省略可能

例43342423234

スキルのID。

skill.type stringnull省略可能

例service

次の値に固定: service

[cards.skill_card_title] objectnull

カードのタイトル

skill_card_title.code stringnull省略可能

例my_transcripts

役職の識別子

skill_card_title.message stringnull省略可能

例My Transcripts

UI上で表示する実際のタイトル

[cards.skill_card_type] stringnull省略可能

例status

作成するカードのタイプ

次の値のいずれか1つ: transcript,keyword,timeline,status,error

[cards.status] objectnull

ステータス(省略可)。statusのcard_typeで使用します。

status.code stringnull省略可能

例skills_pending_status

設定するステータスのタイプ

次の値のいずれか1つ: skills_pending_status,custom_error

status.message stringnull省略可能

例We're preparing to process your file. Please hold on!

UI上で表示するステータスについてのメッセージ。

[cards.type] stringnull条件付きで必須

例skill_card

次の値に固定: skill_card

status string本文内必須

例success

スキル呼び出しのステータスを設定します。

次の値のいずれか1つ: invoked,processing,success,transient_failure,permanent_failure

レスポンス

200none

空の応答を返します。

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

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

put

スキル呼び出しを更新

このドキュメント内で一部のAPIを試せるようになりました。

ログイン

リクエストの例

cURL

curl -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": {},
       "file": {}
     }'