Box Developerドキュメント
 

    カスタムメタデータテンプレートの作成

    ガイド メタデータ メタデータの操作 カスタムメタデータテンプレートの作成

    カスタムメタデータテンプレートの作成

    会社用のカスタムメタデータテンプレートを作成するには、直接BoxのAPIを使用するかBox SDKのいずれかを使用して新しいテンプレートを作成します。

    このcustomerInfoテンプレートでは、3つのフィールドを持つテンプレートを作成します。1つ目のフィールドは顧客のnameを保持するテキストフィールド、2つ目のフィールドは顧客の業種industryに使用できる値のドロップダウンリスト、3つ目のフィールドは年間契約額の合計 (tav) を表します。

    各種フィールドタイプについて確認する

    このテンプレートを作成するには、フィールドの構成と各フィールドの表示名を渡す必要があります。

    cURL
    curl -X POST https://api.box.com/2.0/metadata_templates/schema \
        -H "authorization: Bearer <ACCESS_TOKEN>" \
        -H "content-type: application/json" \
        -d '{
          "scope": "enterprise",
          "displayName": "Customer Info",
          "fields": [
            {
              "type": "string",
              "displayName": "Name"
            },
            {
              "type": "enum",
              "displayName": "Industry",
              "options": [
                {"key": "Technology"},
                {"key": "Healthcare"},
                {"key": "Legal"}
              ]
            },
            {
              "type": "float",
              "displayName": "Total account value",
              "key": "tav"
            }
          ]
        }'
    
    

    管理者権限が必須

    メタデータテンプレートの作成は、管理者権限を持つユーザーに制限されています。つまり、管理者、または管理者から会社のメタデータテンプレートを作成、編集する権限が付与されている共同管理者だけがウェブアプリまたはAPIを使用してテンプレートを管理できます。

    このAPIにより、新しく作成されたメタデータテンプレートが返されます。

    {
      "id": "100ac693-a468-4b37-9535-05984b804dc2",
      "type": "metadata_template",
      "templateKey": "customerInfo",
      "scope": "enterprise_34567",
      "displayName": "Customer Info",
      "hidden": false,
      "copyInstanceOnItemCopy": false,
      "fields": [
        {
          "id": "5c6a5906-003b-4654-9deb-472583fc2930",
          "type": "string",
          "key": "name",
          "displayName": "Name",
          "hidden": false
        },
        {
          "id": "cf3eb5b8-52ef-456c-b175-44354a27e289",
          "type": "enum",
          "key": "industry",
          "displayName": "Industry",
          "options": [
            {"key": "Technology"},
            {"key": "Healthcare"},
            {"key": "Legal"}
          ],
          "hidden": false
        },
        {
          "id": "5c6a5906-4654-9deb-003b-472583fc2930",
          "type": "float",
          "key": "tav",
          "displayName": "Total account value",
          "hidden": false
        }
      ]
    }
    
    

    テンプレートキー

    テンプレートキーは、明示的に設定しませんでしたが、displayName値から自動的に派生します。この場合、templateKeycustomerInfoになります。