> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# ファイルのBox Skillカードを更新
> ファイルの1つ以上のBox Skillsメタデータカードを更新します。
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 [**Box APIのバージョン管理**](/ja/guides/api-calls/api-versioning-strategy/)を参照してください。
「[Box SDKのバージョニング戦略](/ja/guides/tooling/sdks/sdk-versioning/)について詳しく学ぶ。」
## OpenAPI
````yaml box-openapi-jp.json PUT /files/{file_id}/metadata/global/boxSkillsCards
openapi: 3.0.2
info:
title: Box Platform API
description: >-
[Box
Platform](https://developer.box.com)では、[Box](https://box.com)内に保存されているコンテンツへのアクセス権限を付与する機能が提供されています。また、ファイルとフォルダの基本操作、会社内のユーザーの管理、リーガルホールドやリテンションポリシーなどの複雑なトピックのためのエンドポイントも提供されています。
termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
contact:
name: Box, Inc
url: https://developer.box.com
email: devrel@box.com
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '2024.0'
x-box-commit-hash: 92c221bf9d
servers:
- url: https://api.box.com/2.0
description: Box Platform APIサーバー。
security:
- OAuth2Security: []
tags:
- name: AI
description: サポート対象のLLMの操作に使用される、一連のエンドポイント。
x-box-tag: ai
- name: AI Studio
description: AI Studioの操作に使用される、一連のエンドポイント。
x-box-tag: ai_studio
- name: アプリ項目の関連付け
x-box-tag: app_item_associations
- name: 承認
description: ユーザー承認プロセスを管理するために使用される、一連のエンドポイント。
x-box-tag: authorization
x-box-priority: true
- name: Box Signリクエスト
description: Box Signリクエストは、署名用ファイルを送信するために使用されます。
x-box-tag: sign_requests
- name: Classifications
description: 分類ラベルは、機密性の高いコンテンツやセキュリティ上の制限が適用されるコンテンツに使用されます。
x-box-tag: classifications
- name: ファイルの分類
description: 分類ラベルは、機密性の高いファイルやセキュリティ上の制限が適用されるファイルに使用されます。
x-box-tag: file_classifications
- name: フォルダの分類
description: 分類ラベルは、機密性の高いフォルダやセキュリティ上の制限が適用されるフォルダに使用されます。
x-box-tag: folder_classifications
- name: Collaborations
description: コラボレーションは、アクセス制限リストと同様に、ユーザーやグループがファイルやフォルダにアクセスする際の権限を定義します。
x-box-tag: user_collaborations
- name: コラボレーション (リスト)
description: ファイル、フォルダ、保留、グループコラボレーションを取得するために使用される、一連のエンドポイント。
x-box-tag: list_collaborations
- name: Collections
description: コレクションを利用して、ファイル、フォルダ、ウェブリンクを1つのフォルダにまとめることなくグループ化できます。
x-box-tag: collections
- name: Comments
description: >-
コメントは、ユーザーがファイルに対して生成するメッセージです。コメントを使用すると、複数のユーザーがファイル上でコラボレーションし、コンテンツに対するフィードバックについて話し合うことができます。
x-box-tag: comments
- name: Device Pinners
description: Device Pinnerを使用すると、どのデバイスでネイティブBoxアプリケーションの使用を許可するかを企業レベルで制御できます。
x-box-tag: device_pinners
- name: ドメインの制限 (ユーザーの除外)
description: 特定の企業に許可されたコラボレーションドメインのリストによって課せられた制限からユーザーを除外できる、一連のエンドポイント。
x-box-tag: collaboration_allowlist_exempt_targets
- name: コラボレーションに対するドメインを制限
description: ユーザーが企業のファイルやフォルダでコラボレーションできるドメインを管理する、一連のエンドポイント。
x-box-tag: collaboration_allowlist_entries
- name: ダウンロード
description: ダウンロードを利用して、ファイルをアプリケーションのサーバーに保存することも、エンドユーザーがブラウザで直接保存することもできます。
x-box-tag: downloads
- name: メールエイリアス
description: メールエイリアスを使用することで、ユーザーのログイン用プライマリメールアドレスに加えて複数のメールアドレスを指定できます。
x-box-tag: email_aliases
- name: Events
description: イベントを利用して、企業内の任意のユーザー (複数可) またはサービスによって実行される操作をアプリケーションが登録できます。
x-box-tag: events
- name: ファイルリクエスト
description: >-
ファイルリクエストを利用すると、任意のユーザーに対してファイルとそれに関連付けられたメタデータを迅速かつ安全にリクエストできます。ユーザーは、既存のファイルリクエストを基にして新しいファイルリクエストを作成できるほか、ファイルリクエストの設定を更新したり、プログラムによってファイルリクエストの有効化、無効化、削除を実行したりできます。
x-box-tag: file_requests
- name: ファイルバージョンリーガルホールド
description: >-
リーガルホールドとは、係争中の訴訟や当然予期される訴訟で、関連する可能性のあるさまざまな形式の情報を企業が保全するために利用できるプロセスのことです。ファイルバージョンリーガルホールドは、特定のファイルバージョンに割り当てられているすべてのポリシーを表します。
x-box-tag: file_version_legal_holds
- name: ファイルバージョンリテンション
description: >-
リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。ファイルバージョンリテンションとは、保持されているファイルバージョンのレコードです。
x-box-tag: file_version_retentions
- name: ファイルバージョン
description: ファイルの特定のバージョンを管理するために使用される、一連のエンドポイント。
x-box-tag: file_versions
- name: Files
description: >-
ファイルは、フォルダとともに、Box
APIの中核を成します。ファイルはアップロードおよびダウンロードが可能で、コンテンツに関する重要なメタデータ情報を保持できます。
x-box-tag: files
- name: フォルダロック
description: フォルダロックでは、特定のフォルダが移動または削除されないように、フォルダ所有者によって設定されるアクセス制限を定義します。
x-box-tag: folder_locks
- name: Folders
description: >-
フォルダは、ファイルとともに、Box
APIの中核を成します。フォルダはアップロードおよびダウンロードが可能で、コンテンツに関する重要なメタデータ情報を保持できます。
x-box-tag: folders
- name: 統合マッピング
description: 統合マッピングを使用すると、ユーザーはパートナーアプリからのコンテンツがBoxのどこに保存されるかを管理できます。
x-box-tag: integration_mappings
- name: グループメンバーシップ
description: グループメンバーシップは、ユーザーがグループに属していることを示します。
x-box-tag: memberships
- name: Groups
description: 企業内に作成されたグループ。
x-box-tag: groups
- name: Invites
description: 招待は、ユーザーを企業に招待するために使用されます。
x-box-tag: invites
- name: リーガルホールドポリシー
description: >-
リーガルホールドとは、係争中の訴訟や当然予期される訴訟で、関連する可能性のあるさまざまな形式の情報を企業が保全するために利用できるプロセスのことです。
x-box-tag: legal_hold_policies
- name: リーガルホールドポリシー割り当て
description: >-
リーガルホールドポリシー割り当ては、ポリシーとカストディアンの関係です。この場合、カストディアンにはユーザー、フォルダ、ファイル、またはファイルバージョンを指定できます。
x-box-tag: legal_hold_policy_assignments
- name: メタデータカスケードポリシー
description: メタデータカスケードポリシーには、フォルダに適用されているメタデータインスタンスを、そのフォルダ内の項目にどのように適用するかが記載されています。
x-box-tag: metadata_cascade_policies
- name: メタデータインスタンス (ファイル)
description: メタデータインスタンスには、テンプレートとファイル間の関係が記載されています。これには、各フィールドに割り当てられている値が含まれます。
x-box-tag: file_metadata
- name: メタデータインスタンス (フォルダ)
description: メタデータインスタンスには、テンプレートとフォルダ間の関係が記載されています。これには、各フィールドに割り当てられている値が含まれます。
x-box-tag: folder_metadata
- name: メタデータ階層
description: メタデータ階層とは、企業内のメタデータを整理して管理するために役立つ、階層型分類システムです。
x-box-tag: metadata_taxonomies
- name: メタデータテンプレート
description: メタデータテンプレートには、ファイルに割り当てることができる、一連の再利用可能なキー/値ペアが記載されています。
x-box-tag: metadata_templates
- name: 最近使用した項目
description: 最近使用した項目は、ユーザーが最近アクセスしたファイルやフォルダなどの項目を表します。
x-box-tag: recent_items
- name: リテンションポリシー
description: >-
リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。管理者はリテンションポリシーを作成して特定のフォルダや企業全体に割り当てることができます。
x-box-tag: retention_policies
- name: リテンションポリシー割り当て
description: >-
リテンションポリシー割り当ては、ポリシーとフォルダや企業の関係です。割り当てを作成すると、そのフォルダや企業に属するすべてのファイルバージョンにリテンションが適用されます。
x-box-tag: retention_policy_assignments
- name: 検索
description: Box APIを使用すると、ファイルコンテンツ検索クエリを使用してBox内のコンテンツを探すことができます。
x-box-tag: search
- name: セッション終了
description: セッション終了APIを使用すると、グループのロールと権限を検証し、グループのセッションを終了させる非同期ジョブを作成できます。
x-box-tag: session_termination
- name: 共有リンク (ファイル)
description: >-
ファイル共有リンクは、Boxに保存されているファイルを対象として生成されるURLです。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
x-box-tag: shared_links_files
- name: 共有リンク (フォルダ)
description: >-
フォルダ共有リンクは、Boxに保存されているフォルダを対象として生成されるURLです。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
x-box-tag: shared_links_folders
- name: 共有リンク (ウェブリンク)
description: >-
ファイル用ウェブリンクは、Box内のウェブリンクを対象として生成されるURLです。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
x-box-tag: shared_links_web_links
- name: 共有リンク (アプリ項目)
description: Boxに保存されているアプリ項目に対して生成されるURL。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
x-box-tag: shared_links_app_items
- name: Shield情報バリア
description: >-
BoxのShield情報バリアは、倫理的境界を定義します。倫理的境界とは、利益相反につながり、結果として倫理的または法的に問題のあるビジネス活動につながる可能性があるやり取りまたは通信を防ぐメカニズムです。
x-box-tag: shield_information_barriers
- name: Shield情報バリアのセグメント
description: >-
Shield情報バリアのセグメントは、ユーザーの定義済みグループを表します。セグメントがグループと異なる点は、ユーザーが所属できるセグメントが1つのみであることです。
x-box-tag: shield_information_barrier_segments
- name: Shield情報バリアのセグメントメンバー
description: Shield情報バリアのセグメントメンバーは、特定のセグメントに割り当てられたユーザーを表します。
x-box-tag: shield_information_barrier_segment_members
- name: Shield情報バリアレポート
description: Shield情報バリアレポートには、情報バリアが有効化されるときに完全に削除される既存のコラボレーションに関する情報が含まれます。
x-box-tag: shield_information_barrier_reports
- name: Shield情報バリアのセグメント制限
description: Shield情報バリアのセグメント制限とは、コンテンツ (ファイルまたはフォルダ) の所有者に基づいて適用されるアクセス制限です。
x-box-tag: shield_information_barrier_segment_restrictions
- name: Box Signテンプレート
description: >-
署名テンプレートを使用すると、署名リクエストの作成時に、あらかじめ定義されたBox
Signテンプレートを使用できます。このテンプレートに含まれるプレースホルダには、リクエストの作成時にデータが自動的に入力されます。
x-box-tag: sign_templates
- name: Skills
description: >-
Box
Skillsは、ファイルの基盤となるメタデータを強化することを目的として、Boxにアップロードされたファイルにカスタム処理を実行するための機能です。
x-box-tag: skills
- name: 標準およびZonesのストレージポリシー
description: ストレージポリシー割り当ては、特定の企業内の項目に対するストレージゾーンを表します。
x-box-tag: storage_policies
- name: 標準およびZonesのストレージポリシー割り当て
description: ストレージポリシー割り当ては、ストレージゾーンと割り当てられた項目 (特定のゾーンに保存されているファイルなど) の間の関係を表します。
x-box-tag: storage_policy_assignments
- name: タスク割り当て
description: タスク割り当てでは、完了するためにどのタスクをどのユーザーに割り当てるかを定義します。
x-box-tag: task_assignments
- name: Tasks
description: >-
ユーザーはタスクを使用することで、ファイルのコラボレータに対して、ファイルのレビューや作業の一部の完了をリクエストできます。タスクは、開発者がファイル中心のワークフローを作成するために使用できます。
x-box-tag: tasks
- name: サービス利用規約
description: サービス利用規約を管理するために使用される、一連のエンドポイント。
x-box-tag: terms_of_services
- name: サービス利用規約のユーザーステータス
description: 特定ユーザーのサービス利用規約のステータスを管理するために使用される、一連のエンドポイント。
x-box-tag: terms_of_service_user_statuses
- name: フォルダの移動
description: ユーザーが所有するすべての項目 (ファイル、フォルダ、およびワークフロー) を別のユーザーのアカウントに移動するためのAPI。
x-box-tag: transfer
- name: ごみ箱内のファイル
description: 削除されて現在ごみ箱にあるファイル。
x-box-tag: trashed_files
- name: ごみ箱内のフォルダ
description: 削除されて現在ごみ箱にあるフォルダ。
x-box-tag: trashed_folders
- name: ごみ箱内の項目
description: 削除されて現在ごみ箱にある項目。
x-box-tag: trashed_items
- name: ごみ箱内のウェブリンク
description: 削除されて現在ごみ箱にあるウェブリンク。
x-box-tag: trashed_web_links
- name: アップロード
description: >-
直接ファイルアップロードAPIは最大50 MBのファイルをサポートしており、1回のAPIリクエストですべてのバイナリデータをBox
APIに送信します。
x-box-tag: uploads
- name: アップロード (分割)
description: >-
分割アップロードエンドポイントは20
MB以上のファイルをサポートしており、アプリケーションでファイルを複数のパーツに分割してアップロードすることで、エラーのキャッチと個別のパーツの再送信を詳細に制御できます。
x-box-tag: chunked_uploads
- name: ユーザーのアバター
description: >-
ユーザーのアバターとは、ユーザー画像を表すためにBoxにアップロードされたJPGファイルまたはPNGファイルです。これはユーザーアカウントで表示されます。
x-box-tag: avatars
- name: Users
description: >-
Box APIは、管理対象ユーザーアカウントでログインする実際の従業員や、App
Userを使用して強力な自動化ワークフローを推進するアプリケーションなど、さまざまなユーザーをサポートしています。
x-box-tag: users
- name: 電子すかし (ファイル)
description: >-
電子すかしとは、埋め込みファイルのプレビューに適用される半透明のオーバーレイです。電子すかしには、ビューアーのメールアドレスまたはユーザーIDと、ファイルのアクセス日時が表示されます。
x-box-tag: file_watermarks
- name: 電子すかし (フォルダ)
description: >-
電子すかしとは、埋め込みフォルダのプレビューに適用される半透明のオーバーレイです。電子すかしには、ビューアーのメールアドレスまたはユーザーIDと、フォルダコンテンツのアクセス日時が表示されます。
x-box-tag: folder_watermarks
- name: ウェブリンク
description: ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。
x-box-tag: web_links
- name: Webhooks
description: >-
Webhookを使用すると、Boxコンテンツのイベントを監視し、イベントの発生時に任意のURLへの通知を受け取ることができます。たとえば、ファイルがダウンロードされるのを待ち、ダウンロード後に共有リンクを削除するワークフローを作成できます。
x-box-tag: webhooks
- name: ワークフロー (リスト)
description: Box Relayワークフローは、名前が付けられたフローのコレクションを表すオブジェクトです。
x-box-tag: workflows
- name: zipダウンロード
description: zipダウンロードは、ファイルやフォルダを含むZIPアーカイブを作成するリクエストが成功したことを表します。
x-box-tag: zip_downloads
externalDocs:
description: Box Developerドキュメント。
url: https://developer.box.com
paths:
/files/{file_id}/metadata/global/boxSkillsCards:
put:
tags:
- Skills
summary: ファイルのBox Skillカードを更新
description: ファイルの1つ以上のBox Skillsメタデータカードを更新します。
operationId: put_files_id_metadata_global_boxSkillsCards
parameters:
- name: file_id
in: path
description: >-
ファイルを表す一意の識別子。
ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。
required: true
schema:
type: string
example: '12345'
requestBody:
content:
application/json-patch+json:
schema:
description: >-
メタデータテンプレートに変更を加えるための[JSON-Patch](https://tools.ietf.org/html/rfc6902)の指定。
変更は操作オブジェクトのJSON配列として表されます。
type: array
items:
type: object
description: 既存のカードを置き換える操作。
properties:
op:
description: 値は常に`replace`になります。
type: string
example: replace
enum:
- replace
path:
description: >-
置き換えるカードを表すJSONパス。ほとんどの場合、これは`/cards/{index}`形式になります
(`index`は、カードのリストにおいてそのカードの位置を示すゼロから始まるインデックスです)。
type: string
example: /cards/0
value:
allOf:
- $ref: '#/components/schemas/SkillCard'
- description: カードのリスト内の`path`で定義された位置に挿入されるカード。
responses:
'200':
description: カスタムテンプレートデータを含め、更新されたメタデータテンプレートを返します。
content:
application/json:
schema:
$ref: '#/components/schemas/SkillCardsMetadata'
'404':
description: リクエストしたファイルが見つかりませんでした。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
default:
description: 予期しないクライアントエラー。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
x-codeSamples:
- lang: curl
label: ファイルのBox Skillカードを更新
source: >-
curl -i -X PUT
"https://api.box.com/2.0/files/12345/metadata/global/boxSkillsCards"
\
-H "authorization: Bearer " \
-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" }
]
}
}]'
- lang: java
label: ファイルのBox Skillカードを更新
source: >-
client.getSkills().updateBoxSkillCardsOnFile(file.getId(),
Arrays.asList(new
UpdateBoxSkillCardsOnFileRequestBody.Builder().op(UpdateBoxSkillCardsOnFileRequestBodyOpField.REPLACE).path("/cards/0").value(cardToUpdate).build()))
- lang: node
label: ファイルのBox Skillカードを更新
source: |-
await client.skills.updateBoxSkillCardsOnFile(file.id, [
{
op: 'replace' as UpdateBoxSkillCardsOnFileRequestBodyOpField,
path: '/cards/0',
value: cardToUpdate,
} satisfies UpdateBoxSkillCardsOnFileRequestBody,
]);
- lang: python
label: ファイルのBox Skillカードを更新
source: |-
client.skills.update_box_skill_cards_on_file(
file.id,
[
UpdateBoxSkillCardsOnFileRequestBody(
op=UpdateBoxSkillCardsOnFileRequestBodyOpField.REPLACE,
path="/cards/0",
value=card_to_update,
)
],
)
components:
schemas:
SkillCard:
description: Box Skillカード。
type: object
oneOf:
- $ref: '#/components/schemas/KeywordSkillCard'
- $ref: '#/components/schemas/TimelineSkillCard'
- $ref: '#/components/schemas/TranscriptSkillCard'
- $ref: '#/components/schemas/StatusSkillCard'
title: Box Skillカード
SkillCardsMetadata:
description: Boxスキルの使用に割り当てられたメタデータ。
type: object
properties:
$canEdit:
description: このメタデータをユーザーが編集できるかどうか。
type: boolean
example: true
$id:
description: メタデータオブジェクトを識別するためのUUID。
type: string
format: uuid
example: 01234500-12f1-1234-aa12-b1d234cb567e
maxLength: 36
$parent:
description: 親フォルダのID。
type: string
example: folder_59449484661,
$scope:
description: このテンプレートが適用されているスコープのID。
type: string
example: enterprise_27335
$template:
description: テンプレートの名前。
type: string
example: properties
$type:
description: >-
このインスタンスの「タイプ」に対応する一意の識別子。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。
type: string
example: properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0
$typeVersion:
description: >-
オブジェクトテンプレートの既知の最新バージョン。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。
type: integer
example: 2
$version:
description: メタデータオブジェクトのバージョン。0から始まり、ユーザー定義プロパティが変更されるたびに増加します。
type: integer
example: 1
cards:
description: このファイルに適用されているBox Skillカードのリスト。
type: array
items:
$ref: '#/components/schemas/SkillCard'
title: Skillsメタデータインスタンス
x-box-resource-id: skill_cards_metadata
x-box-tag: skills
ClientError:
description: 一般的なエラー。
type: object
properties:
type:
description: 値は常に`error`になります。
type: string
example: error
enum:
- error
nullable: false
status:
description: レスポンスのHTTPステータス。
type: integer
format: int32
example: 400
nullable: false
code:
description: Box固有のエラーコード。
type: string
example: item_name_invalid
enum:
- created
- accepted
- no_content
- redirect
- not_modified
- bad_request
- unauthorized
- forbidden
- not_found
- method_not_allowed
- conflict
- precondition_failed
- too_many_requests
- internal_server_error
- unavailable
- item_name_invalid
- insufficient_scope
message:
description: エラーについての短い説明メッセージ。
type: string
example: Method Not Allowed
nullable: false
context_info:
description: >-
このエラーに関する追加コンテキストを含む自由形式のオブジェクト。使用できるフィールドは、エンドポイントごとに定義されています。`message`は唯一の例です。
type: object
example:
message: Something went wrong
additionalProperties: {}
nullable: true
help_url:
description: このエラーの原因に関する詳細情報にリンクされたURL。
type: string
example: >-
https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
nullable: false
request_id:
description: Boxサポートに連絡するときに使用できる、このレスポンスの一意の識別子。
type: string
example: abcdef123456
nullable: false
title: クライアントエラー
x-box-resource-id: client_error
KeywordSkillCard:
description: 一連のキーワードを含むスキルカード。
type: object
properties:
created_at:
description: このカードの作成日時 (省略可)。
type: string
format: date-time
example: '2018-04-13T13:53:23-07:00'
type:
description: 値は常に`skill_card`になります。
type: string
example: skill_card
enum:
- skill_card
skill_card_type:
description: 値は常に`keyword`になります。
type: string
example: keyword
enum:
- keyword
skill_card_title:
description: カードのタイトル。
type: object
properties:
code:
description: タイトルの識別子 (省略可)。
type: string
example: labels
message:
description: UI上で表示する実際のタイトル。
type: string
example: Labels
required:
- message
skill:
description: このメタデータを適用したサービス。
type: object
properties:
type:
description: 値は常に`service`になります。
type: string
example: service
enum:
- service
id:
description: このメタデータを適用したサービスを表すカスタム識別子。
type: string
example: image-recognition-service
required:
- type
- id
invocation:
description: このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。
type: object
properties:
type:
description: 値は常に`skill_invocation`になります。
type: string
example: skill_invocation
enum:
- skill_invocation
id:
description: >-
このメタデータを適用したサービスのインスタンスを表すカスタム識別子。たとえば、`image-recognition-service`が複数のノードで動作する場合、このフィールドを使用すると、メタデータの適用に使用されたノードのIDを識別できます。
type: string
example: image-recognition-service-123
required:
- type
- id
entries:
description: メタデータカード内のエントリのリスト。
type: array
items:
type: object
description: メタデータカードの`entries`属性のエントリ。
properties:
text:
description: キーワードのテキスト。
type: string
example: keyword1
required:
- type
- skill_card_type
- skill
- invocation
- entries
title: キーワードスキルカード
x-box-resource-id: keyword_skill_card
x-box-tag: skills
TimelineSkillCard:
description: タイムラインに画像のリストを配置するBox Skillメタデータカード。
type: object
properties:
created_at:
description: このカードの作成日時 (省略可)。
type: string
format: date-time
example: '2018-04-13T13:53:23-07:00'
type:
description: 値は常に`skill_card`になります。
type: string
example: skill_card
enum:
- skill_card
skill_card_type:
description: 値は常に`timeline`になります。
type: string
example: timeline
enum:
- timeline
skill_card_title:
description: カードのタイトル。
type: object
properties:
code:
description: タイトルの識別子 (省略可)。
type: string
example: Faces
message:
description: UI上で表示する実際のタイトル。
type: string
example: Faces
required:
- message
skill:
description: このメタデータを適用したサービス。
type: object
properties:
type:
description: 値は常に`service`になります。
type: string
example: service
enum:
- service
id:
description: このメタデータを適用したサービスを表すカスタム識別子。
type: string
example: image-recognition-service
required:
- type
- id
invocation:
description: このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。
type: object
properties:
type:
description: 値は常に`skill_invocation`になります。
type: string
example: skill_invocation
enum:
- skill_invocation
id:
description: >-
このメタデータを適用したサービスのインスタンスを表すカスタム識別子。たとえば、`image-recognition-service`が複数のノードで動作する場合、このフィールドを使用すると、メタデータの適用に使用されたノードのIDを識別できます。
type: string
example: image-recognition-service-123
required:
- type
- id
duration:
description: タイムラインの総持続時間 (秒)。
type: integer
example: 1000
entries:
description: タイムライン上のエントリのリスト。
type: array
items:
type: object
description: タイムライン上の複数の項目に配置される1つの項目。
properties:
text:
description: エントリのテキスト。これは、たとえば、ビデオで検出された人物の名前など、タイムラインに配置される項目の表示名になります。
type: string
example: John
appears:
description: この項目がタイムラインに表示される日時を表すタイムスタンプのリストを定義します。
type: array
items:
type: object
description: エントリのタイムスタンプ。
properties:
start:
description: エントリがタイムライン上に表示され始める時間 (秒)。
type: integer
example: 1
end:
description: エントリがタイムラインに表示されなくなる時間 (秒)。
type: integer
example: 20
required:
- start
- end
image_url:
description: >-
タイムラインに表示されるエントリを示す画像。この画像のURLはすべてのエントリに必要です。
この画像は項目 (顔など)
のリストに表示されます。また、画像をクリックすると、このエントリの期間中にそのエントリが表示される位置がユーザーに示されます。
type: string
example: https://example.com/image1.jpg
required:
- type
- skill_card_type
- skill
- invocation
- entries
title: タイムラインスキルカード
x-box-resource-id: timeline_skill_card
x-box-tag: skills
TranscriptSkillCard:
description: ファイルにトランスクリプトを追加するBox Skillメタデータカード。
type: object
properties:
created_at:
description: このカードの作成日時 (省略可)。
type: string
format: date-time
example: '2018-04-13T13:53:23-07:00'
type:
description: 値は常に`skill_card`になります。
type: string
example: skill_card
enum:
- skill_card
skill_card_type:
description: 値は常に`transcript`になります。
type: string
example: transcript
enum:
- transcript
skill_card_title:
description: カードのタイトル。
type: object
properties:
code:
description: タイトルの識別子 (省略可)。
type: string
example: my_transcripts
message:
description: UI上で表示する実際のタイトル。
type: string
example: My Transcripts
required:
- message
skill:
description: このメタデータを適用したサービス。
type: object
properties:
type:
description: 値は常に`service`になります。
type: string
example: service
enum:
- service
id:
description: このメタデータを適用したサービスを表すカスタム識別子。
type: string
example: transciption-service
required:
- type
- id
invocation:
description: このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。
type: object
properties:
type:
description: 値は常に`skill_invocation`になります。
type: string
example: skill_invocation
enum:
- skill_invocation
id:
description: >-
このメタデータを適用したサービスのインスタンスを表すカスタム識別子。たとえば、`image-recognition-service`が複数のノードで動作する場合、このフィールドを使用すると、メタデータの適用に使用されたノードのIDを識別できます。
type: string
example: transciption-service-123
required:
- type
- id
duration:
description: |-
総持続時間 (秒) (省略可)。
`skill_card_type`が`transcript`または`timeline`の場合に使用されます。
type: integer
example: 1000
entries:
description: カードのエントリのリスト。これは、書き起こしの個々のエントリを表します。
type: array
items:
type: object
description: メタデータカードの`entries`属性のエントリ。
properties:
text:
description: エントリのテキスト。これは、タイムライン上のエントリに割り当てられた書き起こしテキストになります。
type: string
example: Hi, and welcome to this video...
appears:
description: 書き起こしテキストが表示される時刻を定義します。これに含まれるのは開始時刻のみで、終了時刻は含まれません。
type: array
items:
type: object
description: エントリのタイムスタンプ。
properties:
start:
description: エントリがタイムライン上に表示され始める時間 (秒)。
type: integer
example: 1
required:
- start
required:
- type
- skill_card_type
- skill
- invocation
- entries
title: トランスクリプトスキルカード
x-box-resource-id: transcript_skill_card
x-box-tag: skills
StatusSkillCard:
description: メタデータサイドバーにステータスメッセージを配置するBox Skillメタデータカード。
type: object
properties:
created_at:
description: このカードの作成日時 (省略可)。
type: string
format: date-time
example: '2018-04-13T13:53:23-07:00'
type:
description: 値は常に`skill_card`になります。
type: string
example: skill_card
enum:
- skill_card
skill_card_type:
description: 値は常に`status`になります。
type: string
example: status
enum:
- status
skill_card_title:
description: カードのタイトル。
type: object
properties:
code:
description: タイトルの識別子 (省略可)。
type: string
example: status
message:
description: UI上で表示する実際のタイトル。
type: string
example: Status
required:
- message
status:
description: >-
スキルのステータスを設定します。これは、スキルがデータを処理している間またはファイルを処理できなかった場合にユーザーにメッセージを表示するのに使用できます。
type: object
properties:
code:
description: >-
このスキル呼び出しのステータスを表すコード。デフォルトでは、各コードには独自のメッセージが伴います。これらのメッセージを調整するには、このオブジェクトの`message`値を設定します。
type: string
example: success
enum:
- invoked
- processing
- success
- transient_failure
- permanent_failure
message:
description: このステータスで提供できるカスタムメッセージ。ウェブアプリでエンドユーザーに表示されます。
type: string
example: We're preparing to process your file. Please hold on!
required:
- code
skill:
description: このメタデータを適用したサービス。
type: object
properties:
type:
description: 値は常に`service`になります。
type: string
example: service
enum:
- service
id:
description: このメタデータを適用したサービスを表すカスタム識別子。
type: string
example: image-recognition-service
required:
- type
- id
invocation:
description: このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。
type: object
properties:
type:
description: 値は常に`skill_invocation`になります。
type: string
example: skill_invocation
enum:
- skill_invocation
id:
description: >-
このメタデータを適用したサービスのインスタンスを表すカスタム識別子。たとえば、`image-recognition-service`が複数のノードで動作する場合、このフィールドを使用すると、メタデータの適用に使用されたノードのIDを識別できます。
type: string
example: image-recognition-service-123
required:
- type
- id
required:
- type
- skill_card_type
- skill
- invocation
- status
title: ステータススキルカード
x-box-resource-id: status_skill_card
x-box-tag: skills
securitySchemes:
OAuth2Security:
type: oauth2
description: >-
The access token received from the authorization server in the OAuth 2.0
flow.
flows:
authorizationCode:
authorizationUrl: https://account.box.com/api/oauth2/authorize
tokenUrl: https://api.box.com/oauth2/token
scopes:
root_readonly: Boxに格納されているすべてのファイルとフォルダの読み取り
root_readwrite: Boxに格納されているすべてのファイルとフォルダの読み取りと書き込み
manage_app_users: App Userのプロビジョニングと管理
manage_managed_users: 管理対象ユーザーのプロビジョニングと管理
manage_groups: 企業のグループの管理
manage_webhook: APIを使用したプログラムによるWebhookの作成
manage_enterprise_properties: Enterpriseのプロパティを管理
manage_data_retention: データリテンションポリシーの管理
manage_legal_hold: リーガルホールドの管理
````