{
  "opencollection": "1.0.0",
  "info": {
    "name": "Box Authorize Authorization Metadata Instances (Folders) API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Metadata Instances (Folders)",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Box List metadata instances on folder",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/folders/:folder_id/metadata",
            "params": [
              {
                "name": "folder_id",
                "value": "12345",
                "type": "path",
                "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."
              }
            ]
          },
          "docs": "Retrieves all metadata for a given folder. This can not be used on the root\nfolder with ID `0`."
        },
        {
          "info": {
            "name": "Box Get metadata instance on folder",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key",
            "params": [
              {
                "name": "folder_id",
                "value": "12345",
                "type": "path",
                "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."
              },
              {
                "name": "scope",
                "value": "global",
                "type": "path",
                "description": "The scope of the metadata template"
              },
              {
                "name": "template_key",
                "value": "properties",
                "type": "path",
                "description": "The name of the metadata template"
              }
            ]
          },
          "docs": "Retrieves the instance of a metadata template that has been applied to a\nfolder. This can not be used on the root folder with ID `0`."
        },
        {
          "info": {
            "name": "Box Create metadata instance on folder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key",
            "params": [
              {
                "name": "folder_id",
                "value": "12345",
                "type": "path",
                "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."
              },
              {
                "name": "scope",
                "value": "global",
                "type": "path",
                "description": "The scope of the metadata template"
              },
              {
                "name": "template_key",
                "value": "properties",
                "type": "path",
                "description": "The name of the metadata template"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Applies an instance of a metadata template to a folder.\n\nIn most cases only values that are present in the metadata template\nwill be accepted, except for the `global.properties` template which accepts\nany key-value pair.\n\nTo display the metadata template in the Box web app the enterprise needs to be\nconfigured to enable **Cascading Folder Level Metadata** for the user in the\nadmin console."
        },
        {
          "info": {
            "name": "Box Update metadata instance on folder",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key",
            "params": [
              {
                "name": "folder_id",
                "value": "12345",
                "type": "path",
                "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."
              },
              {
                "name": "scope",
                "value": "global",
                "type": "path",
                "description": "The scope of the metadata template"
              },
              {
                "name": "template_key",
                "value": "properties",
                "type": "path",
                "description": "The name of the metadata template"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a piece of metadata on a folder.\n\nThe metadata instance can only be updated if the template has already been\napplied to the folder before. When editing metadata, only values that match\nthe metadata template schema will be accepted.\n\nThe update is applied atomically. If any errors occur during the\napplication of the operations, the metadata instance will not be changed."
        },
        {
          "info": {
            "name": "Box Remove metadata instance from folder",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key",
            "params": [
              {
                "name": "folder_id",
                "value": "12345",
                "type": "path",
                "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."
              },
              {
                "name": "scope",
                "value": "global",
                "type": "path",
                "description": "The scope of the metadata template"
              },
              {
                "name": "template_key",
                "value": "properties",
                "type": "path",
                "description": "The name of the metadata template"
              }
            ]
          },
          "docs": "Deletes a piece of folder metadata."
        }
      ]
    }
  ],
  "bundled": true
}