{ "opencollection": "1.0.0", "info": { "name": "Box Authorize Authorization Files API", "version": "1.0" }, "items": [ { "info": { "name": "Files", "type": "folder" }, "items": [ { "info": { "name": "Box Get file information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id", "headers": [ { "name": "if-none-match", "value": "1" }, { "name": "boxapi", "value": "shared_link=[link]&shared_link_password=[password]" }, { "name": "x-rep-hints", "value": "[pdf]" } ], "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`." } ] }, "docs": "Retrieves the details about a file." }, { "info": { "name": "Box Restore file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/files/:file_id", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restores a file that has been moved to the trash.\n\nAn optional new parent ID can be provided to restore the file to in case the\noriginal folder has been deleted." }, { "info": { "name": "Box Update file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/files/:file_id", "headers": [ { "name": "if-match", "value": "1" } ], "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a file. This can be used to rename or move a file,\ncreate a shared link, or lock a file." }, { "info": { "name": "Box Delete file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/files/:file_id", "headers": [ { "name": "if-match", "value": "1" } ], "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "docs": "Deletes a file, either permanently or by moving it to\nthe trash.\n\nThe the enterprise settings determine whether the item will\nbe permanently deleted from Box or moved to the trash." }, { "info": { "name": "Box Upload file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/files/content", "headers": [ { "name": "content-md5", "value": "134b65991ed521fcfe4724b7d814ab8ded5185dc" } ], "params": [ { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ], "body": { "type": "multipart-form", "data": [ { "name": "attributes", "type": "text", "value": "" }, { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Uploads a small file to Box. For file sizes over 50MB we recommend\nusing the Chunk Upload APIs.\n\n# Request body order\n\nThe `attributes` part of the body must come **before** the\n`file` part. Requests that do not follow this format when\nuploading the file will receive a HTTP `400` error with a\n`metadata_after_file_contents` error code." }, { "info": { "name": "Box Preflight check before upload", "type": "http" }, "http": { "method": "OPTIONS", "url": "{{baseUrl}}/files/content", "body": { "type": "json", "data": "{}" } }, "docs": "Performs a check to verify that a file will be accepted by Box\nbefore you upload the entire file." }, { "info": { "name": "Box Copy file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/files/:file_id/copy", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a copy of a file." }, { "info": { "name": "Box Get file thumbnail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/thumbnail.:extension", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "extension", "value": "png", "type": "path", "description": "The file format for the thumbnail" }, { "name": "min_height", "value": "32", "type": "query", "description": "The minimum height of the thumbnail" }, { "name": "min_width", "value": "32", "type": "query", "description": "The minimum width of the thumbnail" }, { "name": "max_height", "value": "320", "type": "query", "description": "The maximum height of the thumbnail" }, { "name": "max_width", "value": "320", "type": "query", "description": "The maximum width of the thumbnail" } ] }, "docs": "Retrieves a thumbnail, or smaller image representation, of a file.\n\nSizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in\nthe `.png` format and sizes of `32x32`, `160x160`, and `320x320`\ncan be returned in the `.jpg` format.\n\nThumbnails can be generated for the image and video file formats listed\n[found on our community site][1].\n\n[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327" }, { "info": { "name": "Box List file collaborations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/collaborations", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." }, { "name": "limit", "value": "1000", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "marker", "value": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "type": "query", "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`." } ] }, "docs": "Retrieves a list of pending and active collaborations for a\nfile. This returns all the users that have access to the file\nor have been invited to the file." }, { "info": { "name": "Box List file comments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/comments", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." }, { "name": "limit", "value": "1000", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "offset", "value": "1000", "type": "query", "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response." } ] }, "docs": "Retrieves a list of comments for a file." }, { "info": { "name": "Box Download file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/content", "headers": [ { "name": "range", "value": "bytes=0-1024" }, { "name": "boxapi", "value": "shared_link=[link]&shared_link_password=[password]" } ], "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "version", "value": "4", "type": "query", "description": "The file version to download" }, { "name": "access_token", "value": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ", "type": "query", "description": "An optional access token that can be used to pre-authenticate this request, which means that a download link can be shared with a browser or a third party service without them needing to know how to handle the authentication.\nWhen using this parameter, please make sure that the access token is sufficiently scoped down to only allow read access to that file and no other files or folders." } ] }, "docs": "Returns the contents of a file in binary format." }, { "info": { "name": "Box Upload file version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/files/:file_id/content", "headers": [ { "name": "if-match", "value": "1" }, { "name": "content-md5", "value": "134b65991ed521fcfe4724b7d814ab8ded5185dc" } ], "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ], "body": { "type": "multipart-form", "data": [ { "name": "attributes", "type": "text", "value": "" }, { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Update a file's content. For file sizes over 50MB we recommend\nusing the Chunk Upload APIs.\n\n# Request body order\n\nThe `attributes` part of the body must come **before** the\n`file` part. Requests that do not follow this format when\nuploading the file will receive a HTTP `400` error with a\n`metadata_after_file_contents` error code." }, { "info": { "name": "Box Create upload session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/files/upload_sessions", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an upload session for a new file." }, { "info": { "name": "Box Create upload session for existing file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/files/:file_id/upload_sessions", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an upload session for an existing file." }, { "info": { "name": "Box Get upload session", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/upload_sessions/:upload_session_id", "params": [ { "name": "upload_session_id", "value": "D5E3F7A", "type": "path", "description": "The ID of the upload session." } ] }, "docs": "Return information about an upload session." }, { "info": { "name": "Box Upload part of file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/files/upload_sessions/:upload_session_id", "headers": [ { "name": "digest", "value": "sha=fpRyg5eVQletdZqEKaFlqwBXJzM=" }, { "name": "content-range", "value": "bytes 8388608-16777215/445856194" } ], "params": [ { "name": "upload_session_id", "value": "D5E3F7A", "type": "path", "description": "The ID of the upload session." } ] }, "docs": "Updates a chunk of an upload session for a file." }, { "info": { "name": "Box Remove upload session", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/files/upload_sessions/:upload_session_id", "params": [ { "name": "upload_session_id", "value": "D5E3F7A", "type": "path", "description": "The ID of the upload session." } ] }, "docs": "Abort an upload session and discard all data uploaded.\n\nThis cannot be reversed." }, { "info": { "name": "Box List parts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/upload_sessions/:upload_session_id/parts", "params": [ { "name": "upload_session_id", "value": "D5E3F7A", "type": "path", "description": "The ID of the upload session." }, { "name": "offset", "value": "1000", "type": "query", "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response." }, { "name": "limit", "value": "1000", "type": "query", "description": "The maximum number of items to return per page." } ] }, "docs": "Return a list of the chunks uploaded to the upload\nsession so far." }, { "info": { "name": "Box Commit upload session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/files/upload_sessions/:upload_session_id/commit", "headers": [ { "name": "digest", "value": "sha=fpRyg5eVQletdZqEKaFlqwBXJzM=" }, { "name": "if-match", "value": "1" }, { "name": "if-none-match", "value": "1" } ], "params": [ { "name": "upload_session_id", "value": "D5E3F7A", "type": "path", "description": "The ID of the upload session." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Close an upload session and create a file from the\nuploaded chunks." }, { "info": { "name": "Box List tasks on file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/tasks", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "docs": "Retrieves a list of all the tasks for a file. This\nendpoint does not support pagination." }, { "info": { "name": "Box Get trashed file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/trash", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ] }, "docs": "Retrieves a file that has been moved to the trash.\n\nPlease note that only if the file itself has been moved to the\ntrash can it be retrieved with this API call. If instead one of\nits parent folders was moved to the trash, only that folder\ncan be inspected using the\n[`GET /folders/:id/trash`](e://get_folders_id_trash) API.\n\nTo list all items that have been moved to the trash, please\nuse the [`GET /folders/trash/items`](e://get-folders-trash-items/)\nAPI." }, { "info": { "name": "Box Permanently remove file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/files/:file_id/trash", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "docs": "Permanently deletes a file that is in the trash.\nThis action cannot be undone." }, { "info": { "name": "Box List all file versions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/versions", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." }, { "name": "limit", "value": "1000", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "offset", "value": "1000", "type": "query", "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response." } ] }, "docs": "Retrieve a list of the past versions for a file.\n\nVersions are only tracked by Box users with premium accounts. To fetch the ID\nof the current version of a file, use the `GET /file/:id` API." }, { "info": { "name": "Box Get file version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/versions/:file_version_id", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." }, { "name": "file_version_id", "value": "1234", "type": "path", "description": "The ID of the file version" } ] }, "docs": "Retrieve a specific version of a file.\n\nVersions are only tracked for Box users with premium accounts." }, { "info": { "name": "Box Restore file version", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/files/:file_id/versions/:file_version_id", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "file_version_id", "value": "1234", "type": "path", "description": "The ID of the file version" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restores a specific version of a file after it was deleted.\nDon't use this endpoint to restore Box Notes,\nas it works with file formats such as PDF, DOC,\nPPTX or similar." }, { "info": { "name": "Box Remove file version", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/files/:file_id/versions/:file_version_id", "headers": [ { "name": "if-match", "value": "1" } ], "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "file_version_id", "value": "1234", "type": "path", "description": "The ID of the file version" } ] }, "docs": "Move a file version to the trash.\n\nVersions are only tracked for Box users with premium accounts." }, { "info": { "name": "Box Promote file version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/files/:file_id/versions/current", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Promote a specific version of a file.\n\nIf previous versions exist, this method can be used to\npromote one of the older versions to the top of the version history.\n\nThis creates a new copy of the old version and puts it at the\ntop of the versions history. The file will have the exact same contents\nas the older version, with the the same hash digest, `etag`, and\nname as the original.\n\nOther properties such as comments do not get updated to their\nformer values.\n\nDon't use this endpoint to restore B" }, { "info": { "name": "Box List metadata instances on file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/metadata", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "docs": "Retrieves all metadata for a given file." }, { "info": { "name": "Box Get classification on file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "docs": "Retrieves the classification metadata instance that\nhas been applied to a file.\n\nThis API can also be called by including the enterprise ID in the\nURL explicitly, for example\n`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`." }, { "info": { "name": "Box Add classification to file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a classification to a file by specifying the label of the\nclassification to add.\n\nThis API can also be called by including the enterprise ID in the\nURL explicitly, for example\n`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`." }, { "info": { "name": "Box Update classification on file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a classification on a file.\n\nThe classification can only be updated if a classification has already been\napplied to the file before. When editing classifications, only values are\ndefined for the enterprise will be accepted." }, { "info": { "name": "Box Remove classification from file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "docs": "Removes any classifications from a file.\n\nThis API can also be called by including the enterprise ID in the\nURL explicitly, for example\n`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`." }, { "info": { "name": "Box Get metadata instance on file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "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\nfile." }, { "info": { "name": "Box Create metadata instance on file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "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 file.\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." }, { "info": { "name": "Box Update metadata instance on file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "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 file.\n\nThe metadata instance can only be updated if the template has already been\napplied to the file 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 file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "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 file metadata." }, { "info": { "name": "List Box Skill cards on file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "docs": "List the Box Skills metadata cards that are attached to a file." }, { "info": { "name": "Create Box Skill cards on file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Applies one or more Box Skills metadata cards to a file." }, { "info": { "name": "Update Box Skill cards on file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more Box Skills metadata cards to a file." }, { "info": { "name": "Remove Box Skill cards from file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "docs": "Removes any Box Skills cards metadata from a file." }, { "info": { "name": "Box Get watermark on file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/watermark", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "docs": "Retrieve the watermark for a file." }, { "info": { "name": "Box Apply watermark to file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/files/:file_id/watermark", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Applies or update a watermark on a file." }, { "info": { "name": "Box Remove watermark from file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/files/:file_id/watermark", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "docs": "Removes the watermark from a file." }, { "info": { "name": "Box Get shared link for file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id#get_shared_link", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "shared_link", "type": "query", "description": "Explicitly request the `shared_link` fields\nto be returned for this item." } ] }, "docs": "Gets the information for a shared link on a file." }, { "info": { "name": "Box Add shared link to file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/files/:file_id#add_shared_link", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "shared_link", "type": "query", "description": "Explicitly request the `shared_link` fields\nto be returned for this item." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a shared link to a file." }, { "info": { "name": "Box Update shared link on file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/files/:file_id#update_shared_link", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "shared_link", "type": "query", "description": "Explicitly request the `shared_link` fields\nto be returned for this item." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a shared link on a file." }, { "info": { "name": "Box Remove shared link from file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/files/:file_id#remove_shared_link", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "shared_link", "type": "query", "description": "Explicitly request the `shared_link` fields\nto be returned for this item." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a shared link from a file." } ] } ], "bundled": true }