{ "uuid": "e2f71408-beec-4563-96d9-415209093fea", "lastMigration": 29, "name": "Box Platform API", "endpointPrefix": "2.0", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "8292e7d3-3298-4106-8268-732b07a12cfe", "documentation": "Authorize user", "method": "get", "endpoint": "authorize", "responses": [ { "uuid": "fc7fe49d-d17b-4ad7-922d-5346b69e4cec", "body": "", "latency": 0, "statusCode": 200, "label": "Does not return any data, but rather should be used in the browser.", "headers": [{ "key": "Content-Type", "value": "text/html" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "206e8410-6925-4ec0-91e1-eb22b5185b97", "body": "", "latency": 0, "statusCode": 200, "label": "Does not return any data, but rather should be used in the browser.", "headers": [{ "key": "Content-Type", "value": "text/html" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9d6590fc-9f4d-4f49-aa32-36a0038e47f7", "documentation": "List allowed collaboration domains", "method": "get", "endpoint": "collaboration_whitelist_entries", "responses": [ { "uuid": "9a5e7386-7d20-4dbb-b1fc-956fe2f128af", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of domains that are allowed for collaboration.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "feb86a4e-5b4f-4aef-bf0c-52c943a75b57", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "553e10a9-6af0-4fbb-a5f5-cfa1f85f3d6f", "documentation": "Add domain to list of allowed collaboration domains", "method": "post", "endpoint": "collaboration_whitelist_entries", "responses": [ { "uuid": "49c0b910-b789-48c3-a723-5b95c0a48b39", "body": "{\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"direction\": \"{{oneOf (array 'inbound' 'outbound' 'both')}}\",\n \"domain\": \"example.com\",\n \"enterprise\": {\n \"id\": \"11446498\",\n \"name\": \"Acme Inc.\",\n \"type\": \"{{oneOf (array 'enterprise')}}\"\n },\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'collaboration_whitelist_entry')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a new entry on the list of allowed domains.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c15b8c06-e1c3-40f0-a042-ff4f7a6676f0", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d9b516c3-651a-4d1e-9de0-eb2866079204", "documentation": "Remove domain from list of allowed collaboration domains", "method": "delete", "endpoint": "collaboration_whitelist_entries/:collaboration_whitelist_entry_id", "responses": [ { "uuid": "c70f502f-815d-4800-b8b7-5c5020f0576d", "body": "", "latency": 0, "statusCode": 204, "label": "A blank response is returned if the entry was\nsuccessfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "49f2303e-fbdf-4abc-a8ce-aa7e4ec4fb6e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ee222940-c762-44ee-81f2-6e043333063d", "documentation": "Get allowed collaboration domain", "method": "get", "endpoint": "collaboration_whitelist_entries/:collaboration_whitelist_entry_id", "responses": [ { "uuid": "311233a4-0741-4fcc-b92c-2f597855c58f", "body": "{\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"direction\": \"{{oneOf (array 'inbound' 'outbound' 'both')}}\",\n \"domain\": \"example.com\",\n \"enterprise\": {\n \"id\": \"11446498\",\n \"name\": \"Acme Inc.\",\n \"type\": \"{{oneOf (array 'enterprise')}}\"\n },\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'collaboration_whitelist_entry')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns an entry on the list of allowed domains.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "723b72dc-b600-4171-adda-a734d0a0ed82", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "74ad4be5-3c0a-4142-8229-43e48441487c", "documentation": "List users exempt from collaboration domain restrictions", "method": "get", "endpoint": "collaboration_whitelist_exempt_targets", "responses": [ { "uuid": "e085cf9f-0f6f-4d9b-ac5a-7eb2dff4337d", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of user exemptions.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ee326bc9-5fb2-45d4-9fce-147ef740fa2e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "82d7f33c-3adf-46e8-985f-4abdd460f2b7", "documentation": "Create user exemption from collaboration domain restrictions", "method": "post", "endpoint": "collaboration_whitelist_exempt_targets", "responses": [ { "uuid": "3ddfd9c9-ef4d-41e5-bd6e-e531b5213d5a", "body": "{\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"enterprise\": {\n \"id\": \"11446498\",\n \"name\": \"Acme Inc.\",\n \"type\": \"{{oneOf (array 'enterprise')}}\"\n },\n \"id\": \"11446498\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"type\": \"{{oneOf (array 'collaboration_whitelist')}}\",\n \"user\": {\n \"id\": \"11446498\",\n \"name\": \"Acme Inc.\",\n \"type\": \"{{oneOf (array 'enterprise')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns a new exemption entry.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c4249d73-4e5d-427b-b13f-92120a4b1f02", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6126bd03-1f67-4177-a8e0-9f1d861f67fd", "documentation": "Remove user from list of users exempt from domain restrictions", "method": "delete", "endpoint": "collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id", "responses": [ { "uuid": "05f4d2e4-d0de-4c11-8cca-f13b301b1309", "body": "", "latency": 0, "statusCode": 204, "label": "A blank response is returned if the exemption was\nsuccessfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "005d7457-d298-4f10-87a5-e45a0eb1c3ce", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "02fcc573-ef4a-49f5-bcfe-ccc6209558db", "documentation": "Get user exempt from collaboration domain restrictions", "method": "get", "endpoint": "collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_id", "responses": [ { "uuid": "dab9f7cb-cd7f-4eaf-8f63-1a29177c38d9", "body": "{\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"enterprise\": {\n \"id\": \"11446498\",\n \"name\": \"Acme Inc.\",\n \"type\": \"{{oneOf (array 'enterprise')}}\"\n },\n \"id\": \"11446498\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"type\": \"{{oneOf (array 'collaboration_whitelist')}}\",\n \"user\": {\n \"id\": \"11446498\",\n \"name\": \"Acme Inc.\",\n \"type\": \"{{oneOf (array 'enterprise')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns the user's exempted from the list of collaboration domains.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "47c23d15-2c17-46b7-bff2-19ac8dd91211", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "985f7e91-f863-489a-9654-db7cf34398a2", "documentation": "List pending collaborations", "method": "get", "endpoint": "collaborations", "responses": [ { "uuid": "aca7866a-7d73-4d30-b990-c0daac1138b8", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of pending collaboration objects.\n\nIf the user has no pending collaborations, the collection\nwill be empty.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "81dc2a66-f7ca-4d3c-aaca-a447bbe897c5", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "aabdba92-7a06-4be6-ac3b-6b70b3441858", "documentation": "Create collaboration", "method": "post", "endpoint": "collaborations", "responses": [ { "uuid": "84412f38-49c6-46c8-bf7f-73187604c740", "body": "{\n \"acceptance_requirements_status\": {\n \"strong_password_requirement\": {\n \"enterprise_has_strong_password_required_for_external_users\": true,\n \"user_has_strong_password\": true\n },\n \"terms_of_service_requirement\": {\n \"is_accepted\": true,\n \"terms_of_service\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'terms_of_service')}}\"\n }\n },\n \"two_factor_authentication_requirement\": {\n \"enterprise_has_two_factor_auth_enabled\": true,\n \"user_has_two_factor_authentication_enabled\": true\n }\n },\n \"accessible_by\": {},\n \"acknowledged_at\": \"2012-12-12T10:55:20-08:00\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {},\n \"expires_at\": \"2012-12-26T10:53:43-08:00\",\n \"id\": \"12345678\",\n \"invite_email\": \"john@example.com\",\n \"item\": \"\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"role\": \"{{oneOf (array 'editor' 'viewer' 'previewer' 'uploader' 'previewer uploader' 'viewer uploader' 'co-owner' 'owner')}}\",\n \"status\": \"{{oneOf (array 'accepted' 'pending' 'rejected')}}\",\n \"type\": \"{{oneOf (array 'collaboration')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Returns a new collaboration object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9f9e8860-26d3-459d-9c9b-e52735151679", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "762638dd-e65e-47e0-bac4-ca71d100c958", "documentation": "Remove collaboration", "method": "delete", "endpoint": "collaborations/:collaboration_id", "responses": [ { "uuid": "a6fe90f3-3f97-4a14-9699-79d0d8bdc44e", "body": "", "latency": 0, "statusCode": 204, "label": "A blank response is returned if the collaboration was\nsuccessfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "69b416e9-f802-4a92-a5fc-743d3c17fd32", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "79805bcc-09c6-4cae-b82c-eb5aa6655bef", "documentation": "Get collaboration", "method": "get", "endpoint": "collaborations/:collaboration_id", "responses": [ { "uuid": "d4c5ce3d-2fbc-47d6-8eaf-fac36a0c8116", "body": "{\n \"acceptance_requirements_status\": {\n \"strong_password_requirement\": {\n \"enterprise_has_strong_password_required_for_external_users\": true,\n \"user_has_strong_password\": true\n },\n \"terms_of_service_requirement\": {\n \"is_accepted\": true,\n \"terms_of_service\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'terms_of_service')}}\"\n }\n },\n \"two_factor_authentication_requirement\": {\n \"enterprise_has_two_factor_auth_enabled\": true,\n \"user_has_two_factor_authentication_enabled\": true\n }\n },\n \"accessible_by\": {},\n \"acknowledged_at\": \"2012-12-12T10:55:20-08:00\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {},\n \"expires_at\": \"2012-12-26T10:53:43-08:00\",\n \"id\": \"12345678\",\n \"invite_email\": \"john@example.com\",\n \"item\": \"\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"role\": \"{{oneOf (array 'editor' 'viewer' 'previewer' 'uploader' 'previewer uploader' 'viewer uploader' 'co-owner' 'owner')}}\",\n \"status\": \"{{oneOf (array 'accepted' 'pending' 'rejected')}}\",\n \"type\": \"{{oneOf (array 'collaboration')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a collaboration object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bf63aa68-bbbe-4560-b0ad-066c4e81dc5e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d9f498f2-a388-497b-8e7c-97c969a3ed28", "documentation": "Update collaboration", "method": "put", "endpoint": "collaborations/:collaboration_id", "responses": [ { "uuid": "6202f2fb-e253-4185-ad21-8de83b7d3eef", "body": "{\n \"acceptance_requirements_status\": {\n \"strong_password_requirement\": {\n \"enterprise_has_strong_password_required_for_external_users\": true,\n \"user_has_strong_password\": true\n },\n \"terms_of_service_requirement\": {\n \"is_accepted\": true,\n \"terms_of_service\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'terms_of_service')}}\"\n }\n },\n \"two_factor_authentication_requirement\": {\n \"enterprise_has_two_factor_auth_enabled\": true,\n \"user_has_two_factor_authentication_enabled\": true\n }\n },\n \"accessible_by\": {},\n \"acknowledged_at\": \"2012-12-12T10:55:20-08:00\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {},\n \"expires_at\": \"2012-12-26T10:53:43-08:00\",\n \"id\": \"12345678\",\n \"invite_email\": \"john@example.com\",\n \"item\": \"\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"role\": \"{{oneOf (array 'editor' 'viewer' 'previewer' 'uploader' 'previewer uploader' 'viewer uploader' 'co-owner' 'owner')}}\",\n \"status\": \"{{oneOf (array 'accepted' 'pending' 'rejected')}}\",\n \"type\": \"{{oneOf (array 'collaboration')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns an updated collaboration object unless the owner has changed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6a4fd2bc-db38-43a0-ac7a-a50b29812d93", "body": "{\n \"acceptance_requirements_status\": {\n \"strong_password_requirement\": {\n \"enterprise_has_strong_password_required_for_external_users\": true,\n \"user_has_strong_password\": true\n },\n \"terms_of_service_requirement\": {\n \"is_accepted\": true,\n \"terms_of_service\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'terms_of_service')}}\"\n }\n },\n \"two_factor_authentication_requirement\": {\n \"enterprise_has_two_factor_auth_enabled\": true,\n \"user_has_two_factor_authentication_enabled\": true\n }\n },\n \"accessible_by\": {},\n \"acknowledged_at\": \"2012-12-12T10:55:20-08:00\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {},\n \"expires_at\": \"2012-12-26T10:53:43-08:00\",\n \"id\": \"12345678\",\n \"invite_email\": \"john@example.com\",\n \"item\": \"\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"role\": \"{{oneOf (array 'editor' 'viewer' 'previewer' 'uploader' 'previewer uploader' 'viewer uploader' 'co-owner' 'owner')}}\",\n \"status\": \"{{oneOf (array 'accepted' 'pending' 'rejected')}}\",\n \"type\": \"{{oneOf (array 'collaboration')}}\"\n}", "latency": 0, "statusCode": 204, "label": "If the role is changed to `owner`, the collaboration is deleted\nand a new collaboration is created. The previous `owner` of\nthe old collaboration will be a `co-owner` on the new collaboration.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "155c77b8-4cc1-4d05-971a-af6ab17b351e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the authenticated user does not have the right\npermissions to update the collaboration.\n\nAdditionally, this error may occur when attempting to update the\n`expires_at` field for the collaboration without the **Automatically\nremove invited collaborators: Allow folder owners to extend the expiry\ndate** setting enabled in the admin dashboard of the enterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c1392062-ee58-43a8-a8c9-ddf57638be74", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b556eda9-7e76-49a4-abf9-cf7470d00b2f", "documentation": "List all collections", "method": "get", "endpoint": "collections", "responses": [ { "uuid": "2c8a61be-ac76-4bbe-b62e-0de49f01efe5", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns all collections for the given user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a1f7bd84-761e-4372-8c3c-8646b89e3b26", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "519723bf-b80c-4944-92a2-03625f1de7d1", "documentation": "List collection items", "method": "get", "endpoint": "collections/:collection_id/items", "responses": [ { "uuid": "73116d77-370e-4b0a-96bd-df69f1686e12", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns an array of items in the collection.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "82d9031b-98e2-4e19-b706-580dfb7b3ba4", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4fd2fe91-5137-4bed-8a86-6891ad1821c3", "documentation": "Create comment", "method": "post", "endpoint": "comments", "responses": [ { "uuid": "0e83a33b-2219-4a98-a6ba-5a180d6d99d2", "body": "{\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'comment')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Returns the newly created comment object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2828128e-d693-4383-b8e1-d9939fb0305a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5dfbb9d8-859b-416c-98f4-a2609267ca43", "documentation": "Remove comment", "method": "delete", "endpoint": "comments/:comment_id", "responses": [ { "uuid": "95888ee3-d853-4ed1-8851-8dbc0bda14c9", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the comment has been deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6b80605a-f565-4533-b8bb-7335e920e658", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7f89a8aa-6467-4cfd-978f-9797968da414", "documentation": "Get comment", "method": "get", "endpoint": "comments/:comment_id", "responses": [ { "uuid": "6234b0b3-812b-471d-bdd1-8a295f08422e", "body": "{\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'comment')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a full comment object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4f5dac15-c04e-404b-86ae-41770dab8acf", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7e2ad9f8-8ef4-4a64-8e34-11e262159f9a", "documentation": "Update comment", "method": "put", "endpoint": "comments/:comment_id", "responses": [ { "uuid": "b7720733-6d14-48f3-9fe1-0d306c5f5e6a", "body": "{\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'comment')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated comment object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d9721cca-49a1-4732-a04c-0bd3d7fec524", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "aa78fca9-0076-4f47-b972-9afdc50262cb", "documentation": "Remove device pin", "method": "delete", "endpoint": "device_pinners/:device_pinner_id", "responses": [ { "uuid": "b5ae9a58-6ae1-4a2a-8003-722d756bbb03", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the pin has been deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "dcf0a255-ff47-4903-9dae-ed509751631c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bf702c1c-e7a8-41ee-b885-f1a5c47e8e95", "documentation": "Get device pin", "method": "get", "endpoint": "device_pinners/:device_pinner_id", "responses": [ { "uuid": "8e216e6f-e570-4976-8e86-8e1d5e5728ed", "body": "{\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"owned_by\": {},\n \"product_name\": \"iPad\",\n \"type\": \"{{oneOf (array 'device_pinner')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns information about a single device pin.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a01a0934-40f9-4016-9abb-27bcd2dcc194", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3c4ff192-14eb-4520-beba-7f1d6a136476", "documentation": "List enterprise device pins", "method": "get", "endpoint": "enterprises/:enterprise_id/device_pinners", "responses": [ { "uuid": "a9c5e670-8214-4bab-8560-745f95e989ef", "body": "{\n \"entries\": [\n {\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"owned_by\": {},\n \"product_name\": \"iPad\",\n \"type\": \"{{oneOf (array 'device_pinner')}}\"\n }\n ],\n \"limit\": 200,\n \"next_marker\": 3000,\n \"order\": [\n {\n \"by\": \"{{oneOf (array 'id')}}\",\n \"direction\": \"{{oneOf (array 'asc' 'desc')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of device pins for a given enterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "aaf970a2-ceac-4e2c-96d3-86ec8f69737f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6a6635ff-a33b-46fd-b9c0-2a98945a4827", "documentation": "List user and enterprise events", "method": "get", "endpoint": "events", "responses": [ { "uuid": "2358e134-8811-4cf3-8598-c6437fd63681", "body": "{\n \"chunk_size\": 2,\n \"entries\": [\n {\n \"additional_details\": {\n \"key\": \"value\"\n },\n \"created_by\": {},\n \"event_id\": \"f82c3ba03e41f7e8a7608363cc6c0390183c3f83\",\n \"event_type\": \"\",\n \"session_id\": \"70090280850c8d2a1933c1\",\n \"source\": \"\",\n \"type\": \"event\"\n }\n ],\n \"next_stream_position\": \"1152922976252290886\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of event objects.\n\nEvents objects are returned in pages, with each page (chunk)\nincluding a list of event objects. The response includes a\n`chunk_size` parameter indicating how many events were returned in this\nchunk, as well as the next `stream_position` that can be\nqueried.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "aa0fb4c2-c71e-4790-a45d-67632670346d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f342a493-8246-49df-b059-667237b02f02", "documentation": "Get events long poll endpoint", "method": "options", "endpoint": "events", "responses": [ { "uuid": "48ba7881-92d3-4de0-9129-70b749a9c0ed", "body": "{\n \"chunk_size\": 1,\n \"entries\": [\n {\n \"max_retries\": 10,\n \"retry_timeout\": 610,\n \"ttl\": 10,\n \"type\": \"realtime_server\",\n \"url\": \"http://2.realtime.services.box.net/subscribe?channel=cc807c9c4869ffb1c81a&stream_type=all\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Returns a paginated array of servers that can be used\ninstead of the regular endpoints for long-polling events.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "473f6421-abee-471e-bd2b-e7073a528461", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2034aa31-23a9-414e-b01d-43f6b0b621fc", "documentation": "Delete file request", "method": "delete", "endpoint": "file_requests/:file_request_id", "responses": [ { "uuid": "5a44e521-ee04-4d0e-8d34-a5260fac9979", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the file request has been successfully\ndeleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8cbe621c-2043-4a96-bf76-f09c81614ab4", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "61afd7a9-4e11-468d-ace4-2cb17dc9743c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the file request is not found or has already been deleted,\nor the user does not have access to the associated folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3e6e56fc-b029-4f54-98a9-0cbc5fa091f5", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `file_request_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ce32341f-a392-4017-a69a-a00d3a73d8d8", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "03ff2205-9c27-44ea-8042-9d031334b29c", "documentation": "Get file request", "method": "get", "endpoint": "file_requests/:file_request_id", "responses": [ { "uuid": "c4ddae81-5378-4c08-a1c8-b28a2b3bca51", "body": "{\n \"created_at\": \"2020-09-28T10:53:43-08:00\",\n \"created_by\": {},\n \"description\": \"Following documents are requested for your process\",\n \"etag\": \"1\",\n \"expires_at\": \"2020-09-28T10:53:43-08:00\",\n \"folder\": {},\n \"id\": \"42037322\",\n \"is_description_required\": true,\n \"is_email_required\": true,\n \"status\": \"{{oneOf (array 'active' 'inactive')}}\",\n \"title\": \"Please upload documents\",\n \"type\": \"{{oneOf (array 'file-request')}}\",\n \"updated_at\": \"2020-09-28T10:53:43-08:00\",\n \"updated_by\": {},\n \"url\": \"/f/19e57f40ace247278a8e3d336678c64a\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a file request object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "676cfe24-8e4f-4ccb-867f-73e2b634a646", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5658ebce-6c64-468b-ac40-b44f9938c444", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the file request is not found, or the user does not\nhave access to the associated folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f6453a0d-63c4-45cc-a3ae-c1ac7283645e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `file_request_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8e21df28-5395-4ed7-9e0d-627c3be6a31d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b4d76627-6f98-4401-84ea-7c965f81218a", "documentation": "Update file request", "method": "put", "endpoint": "file_requests/:file_request_id", "responses": [ { "uuid": "13c7006c-15c3-4c90-8ca5-60b8ee150c44", "body": "{\n \"created_at\": \"2020-09-28T10:53:43-08:00\",\n \"created_by\": {},\n \"description\": \"Following documents are requested for your process\",\n \"etag\": \"1\",\n \"expires_at\": \"2020-09-28T10:53:43-08:00\",\n \"folder\": {},\n \"id\": \"42037322\",\n \"is_description_required\": true,\n \"is_email_required\": true,\n \"status\": \"{{oneOf (array 'active' 'inactive')}}\",\n \"title\": \"Please upload documents\",\n \"type\": \"{{oneOf (array 'file-request')}}\",\n \"updated_at\": \"2020-09-28T10:53:43-08:00\",\n \"updated_by\": {},\n \"url\": \"/f/19e57f40ace247278a8e3d336678c64a\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated file request object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7ea8e1bd-29e9-40b7-98f7-b61c36d7d4f8", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "88feeb63-31c8-42d3-8e17-40493bba4120", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned if the user does not have all the permissions to complete the\nupdate.\n\n* `access_denied_insufficient_permissions` when the authenticated user\ndoes not have access to update the file request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0d54d88f-f5a4-41aa-ab32-df96fe0d026c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the file request is not found, or the user does not\nhave access to the associated folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "af70a1ae-6433-4777-bfa8-53383bcb7c91", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `file_request_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d53dcd61-c2c7-4c06-ba74-4e4e6a0c3cdc", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the file request. This indicates that the\nfile request has changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a054e3e0-7acc-4767-9adb-3aa9495d541b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6a0aa962-01f4-49c3-b10c-d51a52544384", "documentation": "Copy file request", "method": "post", "endpoint": "file_requests/:file_request_id/copy", "responses": [ { "uuid": "9c9756cd-1fc5-4efb-aff4-754d229010a9", "body": "{\n \"created_at\": \"2020-09-28T10:53:43-08:00\",\n \"created_by\": {},\n \"description\": \"Following documents are requested for your process\",\n \"etag\": \"1\",\n \"expires_at\": \"2020-09-28T10:53:43-08:00\",\n \"folder\": {},\n \"id\": \"42037322\",\n \"is_description_required\": true,\n \"is_email_required\": true,\n \"status\": \"{{oneOf (array 'active' 'inactive')}}\",\n \"title\": \"Please upload documents\",\n \"type\": \"{{oneOf (array 'file-request')}}\",\n \"updated_at\": \"2020-09-28T10:53:43-08:00\",\n \"updated_by\": {},\n \"url\": \"/f/19e57f40ace247278a8e3d336678c64a\"\n}", "latency": 0, "statusCode": 200, "label": "Returns updated file request object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e00adcae-9b94-45e9-ac38-a7dfcf1a9d60", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1dcba2bb-e425-46c5-9985-5e37e5c81262", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned if the user does not have all the permissions to complete the\nupdate.\n\n* `access_denied_insufficient_permissions` when the authenticated user\ndoes not have access to update the file request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b736b5a8-5c18-44d5-9126-d29956f65d04", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the file request is not found, or the user does not\nhave access to the associated folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e28c1dea-697e-4343-81ae-5ccc7399ea9c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `file_request_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "07b608a9-9e98-432e-9726-827c55639a62", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "61425222-9413-4991-b2e5-48e2ab6b4aba", "documentation": "List file version legal holds", "method": "get", "endpoint": "file_version_legal_holds", "responses": [ { "uuid": "7332da01-df6e-42d8-a21a-cfcf7108fbc2", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns the list of file version legal holds for a specific legal\nhold policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f10ae2a8-1e50-4576-9e5f-e3fee79bdd52", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "32d85d3a-9ed0-4aec-968d-208006b54ab9", "documentation": "Get file version legal hold", "method": "get", "endpoint": "file_version_legal_holds/:file_version_legal_hold_id", "responses": [ { "uuid": "dc7c55e8-d443-43ad-8aa4-ea79cfca1cc0", "body": "{\n \"deleted_at\": \"2012-12-12T10:53:43-08:00\",\n \"file\": {},\n \"file_version\": {},\n \"id\": \"11446498\",\n \"legal_hold_policy_assignments\": [\n {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'legal_hold_policy_assignment')}}\"\n }\n ],\n \"type\": \"{{oneOf (array 'file_version_legal_hold')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the legal hold policy assignments for the file version.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e59795e8-c670-467a-9ca7-dd46c9434f85", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "db8e2f09-54c5-47a7-a769-fdf278916082", "documentation": "Get retention on file", "method": "get", "endpoint": "file_version_retentions/:file_version_retention_id", "responses": [ { "uuid": "73cc7f65-fd5e-4c45-8f3c-53b1cfdfd729", "body": "{\n \"applied_at\": \"2012-12-12T10:53:43-08:00\",\n \"disposition_at\": \"2012-12-12T10:53:43-08:00\",\n \"file\": {},\n \"file_version\": {},\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'file_version_retention')}}\",\n \"winning_retention_policy\": {}\n}", "latency": 0, "statusCode": 200, "label": "Returns a file version retention object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "79ddbfd7-f195-436f-9f29-3281145fedcf", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2aa83d70-69a1-40ae-86cd-61bde6843a70", "documentation": "Preflight check before upload", "method": "options", "endpoint": "files/content", "responses": [ { "uuid": "a0adabba-6a18-48bb-ae90-02ffaf784cbb", "body": "{\n \"upload_token\": \"Pc3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQP\",\n \"upload_url\": \"https://upload-las.app.box.com/api/2.0/files/content?upload_session_id=1234\"\n}", "latency": 0, "statusCode": 200, "label": "If the check passed, the response will include a session URL that\ncan be used to upload the file to.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7bd1ac49-efd7-4813-8ddc-56326343eb6c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "If the check did not pass, the response will include some details on\nwhy it did not pass.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f52ea5ef-6344-471b-8555-8aef7a4f7179", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bfadd46b-c52b-42ec-a9c0-209105ecea65", "documentation": "Upload file", "method": "post", "endpoint": "files/content", "responses": [ { "uuid": "961c4f9f-bd90-430b-ac46-d945f534bbc3", "body": "{\n \"entries\": [\n {}\n ],\n \"total_count\": 1\n}", "latency": 0, "statusCode": 201, "label": "Returns the new file object in a list.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9b290ba3-f868-409b-8641-6a17843b17ba", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if the file already exists,\nor the account has run out of disk space.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "064c5401-560e-4516-a9f8-06a0ae529870", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "821ac293-1ed0-49b1-b08a-af483926830f", "documentation": "Create upload session", "method": "post", "endpoint": "files/upload_sessions", "responses": [ { "uuid": "f798d0f1-a31f-44c4-9cbc-09ba60650832", "body": "{\n \"id\": \"F971964745A5CD0C001BBE4E58196BFD\",\n \"num_parts_processed\": 455,\n \"part_size\": 1024,\n \"session_endpoints\": {\n \"abort\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD\",\n \"commit\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit\",\n \"list_parts\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts\",\n \"log_event\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/log\",\n \"status\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD\",\n \"upload_part\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD\"\n },\n \"session_expires_at\": \"2012-12-12T10:53:43-08:00\",\n \"total_parts\": 1000,\n \"type\": \"{{oneOf (array 'upload_session')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Returns a new upload session.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4a94cf94-25ae-4fd4-8d43-005f7216cdc9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `missing_destination`: No `folder_id` was provided\n* `invalid_folder_id`: `folder_id` is not valid\n* `item_name_invalid`: `file_name` is not valid\n* `missing_file_size`: `file_size` was not provided\n* `invalid_file_size`: `file_size` was not a valid number\n* `file_size_too_small`: `file_size` is below minimum file size for\n uploads via this API\n* `missing_file_name`: `file_name` was not provided", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9064237c-a25a-43e8-bc2c-b0cf74bfabc2", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the operation is not allowed for some reason.\n\n* `storage_limit_exceeded`: Account storage limit reached", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d4a51cba-3a01-4af6-9f73-aee084c65eac", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the parent folder could not be found, or\nthe authenticated user does not have access to it.\n\n* `invalid_parameter`: The `folder_id` value represents a\n folder that the user does not have access to, or does not\n exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5834ab61-f78a-4c7c-9830-5eda5bfbcc78", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if the file already exists,\nor the account has run out of disk space.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "625321dc-cbc5-4bf2-b49c-cf83973413fe", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5f1cb5ec-d155-4769-841e-ac12c0fb20f7", "documentation": "Remove upload session", "method": "delete", "endpoint": "files/upload_sessions/:upload_session_id", "responses": [ { "uuid": "dcc9604b-20ad-427b-9156-df67866e367b", "body": "", "latency": 0, "statusCode": 204, "label": "A blank response is returned if the session was\nsuccessfully aborted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f3468273-92a6-4d41-9db1-b7ed9eb15217", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "707f5032-7690-4966-89d6-0f2543abb573", "documentation": "Get upload session", "method": "get", "endpoint": "files/upload_sessions/:upload_session_id", "responses": [ { "uuid": "449a1f51-15f2-4179-a11d-9c845bda021f", "body": "{\n \"id\": \"F971964745A5CD0C001BBE4E58196BFD\",\n \"num_parts_processed\": 455,\n \"part_size\": 1024,\n \"session_endpoints\": {\n \"abort\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD\",\n \"commit\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit\",\n \"list_parts\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts\",\n \"log_event\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/log\",\n \"status\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD\",\n \"upload_part\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD\"\n },\n \"session_expires_at\": \"2012-12-12T10:53:43-08:00\",\n \"total_parts\": 1000,\n \"type\": \"{{oneOf (array 'upload_session')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns an upload session object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ecc60bed-8ac1-4e38-8a73-7fd6e45a1c51", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6d8cf4e9-73e7-4ee6-bb99-13e328de1818", "documentation": "Upload part of file", "method": "put", "endpoint": "files/upload_sessions/:upload_session_id", "responses": [ { "uuid": "0aadaae0-7578-4ae0-b485-b62334e95bce", "body": "{\n \"part\": {\n \"offset\": 16777216,\n \"part_id\": \"6F2D3486\",\n \"size\": 3222784\n }\n}", "latency": 0, "statusCode": 200, "label": "Chunk has been uploaded successfully.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "76eb55c9-a6b6-4f51-af49-d758273401e9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if the chunk conflicts with another\nchunk previously uploaded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "44364d0f-e3e6-464d-aed9-f88881f60090", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error if a precondition was not met.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "72b593b5-2366-4586-938e-54e7ec4a09e9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 416, "label": "Returns an error if the content range does not match a specified range\nfor the session.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4e9ec190-0d95-43d4-b660-95e9c7e00980", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1adc158e-8416-473d-9bf0-be9c4ac9846a", "documentation": "Commit upload session", "method": "post", "endpoint": "files/upload_sessions/:upload_session_id/commit", "responses": [ { "uuid": "f8b18643-6e57-49c3-b2f7-e79eca7e4b5e", "body": "{\n \"entries\": [\n {}\n ],\n \"total_count\": 1\n}", "latency": 0, "statusCode": 201, "label": "Returns the file object in a list.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bfb256fb-0678-4860-ad7d-e07d5c8ecadf", "body": "", "latency": 0, "statusCode": 202, "label": "Returns when all chunks have been uploaded but not yet processed.\n\nInspect the upload session to get more information about the\nprogress of processing the chunks, then retry committing the file\nwhen all chunks have processed.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Retry-After", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c34b198b-0fe5-49a0-8997-171841de29d6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if there is already a file with the same name\nin the target folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6a2d1060-7feb-420a-9c38-d55723d67416", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error if the `If-Match` or `If-None-Match` conditions fail.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a02b99ce-229e-4e08-bb2f-a47f81c5d50b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2aa30612-8e02-4c9c-9ed8-8e8624f31249", "documentation": "List parts", "method": "get", "endpoint": "files/upload_sessions/:upload_session_id/parts", "responses": [ { "uuid": "6120e57b-5152-4c9f-b680-1760744eb9f8", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of parts that have been uploaded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fce22f03-e11d-4e14-b39d-8d223a6733a7", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ec6c7e3a-bd71-4fbe-8293-f6f696d2825e", "documentation": "Delete file", "method": "delete", "endpoint": "files/:file_id", "responses": [ { "uuid": "ace8f32d-9cf8-4521-a267-973bfe32611d", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the file has been successfully\ndeleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "dea14376-7575-4ac8-b151-7ad1a9b6df3e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "73bab2c3-b634-4f6d-893a-64353e70b1df", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the file is not found or has already been deleted, or the user\ndoes not have access to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e959f30e-69da-46ca-bd85-a8407221285a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `file_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5af7def3-1cd6-4925-97db-69b40b4e5859", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the file. This indicates that the file\nhas changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8cf4996f-aba1-42cc-a6a1-a9c0b1c40666", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "55d7408c-5a19-47ee-9302-5c6ab87214f8", "documentation": "Get file information", "method": "get", "endpoint": "files/:file_id", "responses": [ { "uuid": "7aa82afb-565e-41f3-96fd-c2d77f15068c", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a file object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "382097bf-f4f0-4cad-acee-5f2dbd32e366", "body": "", "latency": 0, "statusCode": 304, "label": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the folder. This indicates that the folder\nhas not changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "eb2bcf9a-7995-4c77-b8b1-8b2113e08326", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cec3159c-ba1f-46fb-81d3-1e3071f19d56", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the file is not found, or the user does not\nhave access to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7d970730-e3c1-488e-9dc6-b1d7e3df5952", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `file_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7a507508-9c83-4823-8377-5c0f674ac5d9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 415, "label": "Returns an error if an action is performed on a file with an\nincorrect media type.\n\n* `unsupported_media_type` when requesting an `expiring_embed_link`\n for a file that is not supported by Box Embed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "05cccb0c-d244-466d-be48-21e39aa9bcac", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "255a3917-e6fe-4a5a-8077-0506c698355d", "documentation": "Restore file", "method": "post", "endpoint": "files/:file_id", "responses": [ { "uuid": "398c24ce-fb55-4ab4-810d-90f0856fe2bf", "body": "{}", "latency": 0, "statusCode": 201, "label": "Returns a file object when the file has been restored.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ba9656e8-3724-4b19-9598-061f7128bde8", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the user does not have access to the folder\nthe file is being restored to, or the user does not have permission\nto restore files from the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b5a5e184-6d2b-442a-b000-d072747db740", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the file is not in the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f13140e0-f79d-4a23-845a-4940e5c37c95", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if there is an file with the same name\nin the folder the file is being restored to.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6d03ff4d-76eb-426f-88ad-d5ef6d7b8e54", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "13c19d48-c048-4984-bdd1-32801127cd33", "documentation": "Update file", "method": "put", "endpoint": "files/:file_id", "responses": [ { "uuid": "b93a8aed-99fc-4fa3-b43c-eda3e3289ebf", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a file object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bad0d3cd-0e05-44d1-a837-1893964624d0", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0dfc8df0-0a9c-4f4c-aa53-49dd03dfe6d7", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned if the user does not have all the permissions to complete the\nupdate.\n\n* `access_denied_insufficient_permissions` when the authenticated user\ndoes not have access the destination folder to move the file to.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "905239a1-a0a2-4e6a-97bd-c399ad865029", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the file is not found, or the user does not\nhave access to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "aa222031-1062-48c6-b2ce-2c18421a6c9b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `file_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6abda077-518d-4b04-9209-0525027bf2d4", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the file. This indicates that the file\nhas changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e56f1a32-94ac-42b7-ac2f-9315ae47043d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ad42f0c2-4610-49a9-833f-c44b217899ad", "documentation": "Add shared link to file", "method": "put", "endpoint": "files/:file_id#add_shared_link", "responses": [ { "uuid": "8f19d9fb-fd4a-4c25-bbde-e84bb99f4cd0", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the base representation of a file with a new shared\nlink attached.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "68900015-1808-49a7-8514-90299f6ac5d7", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "67afba25-4fe7-4f7b-a4ef-9677cfcf7fb3", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned if the user does not have all the permissions to complete the\nupdate.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "974b98f9-d854-4d25-88b9-d0b2b7a9982f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the file is not found, or the user does not\nhave access to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2e3cdeab-6bad-47f8-a81f-755c1ef29ee0", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `file_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "903e8e25-e14f-4cbf-87fc-fa9310775d10", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the file. This indicates that the file\nhas changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8317e3a9-78a2-4c11-b68c-20a8423d5ce0", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ac4943f1-cf5f-4b28-9cd2-5340bba8891f", "documentation": "Get shared link for file", "method": "get", "endpoint": "files/:file_id#get_shared_link", "responses": [ { "uuid": "9166c7e6-a788-4cc9-96aa-1e91f1fb30df", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the base representation of a file with the\nadditional shared link information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2e55ae67-b5ba-4299-abb9-bad522ccfbc2", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d454de49-5c1c-4a94-a91d-dc8ba44d278b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the file is not found, or the user does not\nhave access to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "932fea04-752a-46ae-8a29-2c18b4e4b5a6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `file_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8776ed73-bfaf-4bf5-ab7b-825a64d34758", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "84d82934-b680-48af-8fb0-e3ac7cde1408", "documentation": "Remove shared link from file", "method": "put", "endpoint": "files/:file_id#remove_shared_link", "responses": [ { "uuid": "6ca77446-7e73-4228-b459-ca78da989fd7", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a basic representation of a file, with the shared link removed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "88395043-501a-4d89-8a20-1d7873c5726d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ead9bc67-dbd4-4273-8853-b29ead1dfdf3", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned if the user does not have all the permissions to complete the\nupdate.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7954faba-fe32-4bd7-a0cc-9f46170756f0", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the file is not found, or the user does not\nhave access to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b6bd1f77-b44c-485d-af9f-2d4508db138f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `file_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b045a6b6-8c5b-4345-925a-2738f7cacebd", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the file. This indicates that the file\nhas changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1c787d88-8dd8-499f-9aba-e3322a97e986", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "12134aec-9bac-482a-8472-e28bd6d934a7", "documentation": "Update shared link on file", "method": "put", "endpoint": "files/:file_id#update_shared_link", "responses": [ { "uuid": "f65463dc-da66-448e-b4f1-164eee0335f6", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a basic representation of the file, with the updated shared\nlink attached.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "07329562-a8a8-4eee-927c-1648bc7fa85e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1c5154a9-a5c3-467c-9925-8ecbe418f0e9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned if the user does not have all the permissions to complete the\nupdate.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "16ea0ed3-4161-47a8-b9c7-195276a2ac24", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the file is not found, or the user does not\nhave access to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "13887583-1113-4dc9-9745-4d259fb993f1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `file_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "25a41982-c4c6-4c1f-a2c3-6e250bedcf92", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the file. This indicates that the file\nhas changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9b254278-99bf-4675-b539-f49db2a603de", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5997b0a1-fc87-4367-ba2d-74a264134b7e", "documentation": "List file collaborations", "method": "get", "endpoint": "files/:file_id/collaborations", "responses": [ { "uuid": "079bdf41-6e2a-4bd9-9b38-e1b4fdc874b8", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of collaboration objects. If there are no\ncollaborations on this file an empty collection will be returned.\n\nThis list includes pending collaborations, for which the `status`\nis set to `pending`, indicating invitations that have been sent but not\nyet accepted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "90e7b77c-b4d2-4e18-8b6c-cf63ba762c10", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d3ea8d55-bf90-4198-b847-a1cd7924887f", "documentation": "List file comments", "method": "get", "endpoint": "files/:file_id/comments", "responses": [ { "uuid": "993531ec-057f-41ad-9608-58c3ee8827e5", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of comment objects. If there are no\ncomments on this file an empty collection will be returned.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e3f01cc2-31bc-4404-8e91-acb73a4f6a32", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "73c35c90-928d-4b74-9c95-04aae55f737a", "documentation": "Download file", "method": "get", "endpoint": "files/:file_id/content", "responses": [ { "uuid": "bd4fefa6-a4a0-4ca8-a506-690db74d84f6", "body": "", "latency": 0, "statusCode": 202, "label": "If the file is not ready to be downloaded yet `Retry-After` header will\nbe returned indicating the time in seconds after which the file will\nbe available for the client to download.\n\nThis response can occur when the file was uploaded immediately before the\ndownload request.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Retry-After", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "24c6e818-e1bb-4a97-966c-562cd6c3c2c4", "body": "", "latency": 0, "statusCode": 302, "label": "If the file is available to be downloaded the response will include a\n`Location` header for the file on `dl.boxcloud.com`.\n\nThe `dl.boxcloud.com` URL is not persistent and clients will need\nto follow the redirect in order to actually download the file.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "554e1492-f243-4c84-9a08-eee6509f91e7", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cafa0060-e86e-4f43-90d7-13c191b2bb4d", "documentation": "Upload file version", "method": "post", "endpoint": "files/:file_id/content", "responses": [ { "uuid": "2a84d3d9-9c07-4875-8279-e12963b7891c", "body": "{\n \"entries\": [\n {}\n ],\n \"total_count\": 1\n}", "latency": 0, "statusCode": 200, "label": "Returns the new file object in a list.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0d679d86-6d75-4e69-899e-73bbcf5a869a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the file. This indicates that the file\nhas changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4499409c-fe10-4bae-ba95-84b2cfb32a2b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e1c6217d-f7dc-41da-981c-5a3191148d25", "documentation": "Copy file", "method": "post", "endpoint": "files/:file_id/copy", "responses": [ { "uuid": "881960d6-7d9d-49cf-8cf9-0669109b3874", "body": "{}", "latency": 0, "statusCode": 201, "label": "Returns a new file object representing the copied file.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b782dabc-6cc9-41df-ace4-740ea5d8af04", "body": "", "latency": 0, "statusCode": 304, "label": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the file. This indicates that the file\nhas not changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ccccc972-dbc9-49f6-a266-328494dd764e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `bad_request` when a parameter is missing.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ba0331ed-10b0-410e-a2c9-8c60ffccb6e7", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if either the source file or the destination\nfolder could not be found, or the authenticated user does not\nhave access to either.\n\n* `not_found` when the authenticated user does not have access\n to the source file or the destination folder", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "094bffc5-cfcd-4531-97a0-19f0714a722c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in process.\n\n The operation can be retried at a later point.\n\n* `item_name_in_use` when a folder with the same name already\n exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "aedf33d1-fdd4-4cf7-a1de-4a734d05b134", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c943d3c6-fccb-437d-8bfc-33ea778c532f", "documentation": "List metadata instances on file", "method": "get", "endpoint": "files/:file_id/metadata", "responses": [ { "uuid": "aadd5fa7-ca14-44c0-806b-28b921814420", "body": "{\n \"entries\": [\n {\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"marketingCollateral\",\n \"$version\": 1\n }\n ],\n \"limit\": 100\n}", "latency": 0, "statusCode": 200, "label": "Returns all the metadata associated with a file.\n\nThis API does not support pagination and will therefore always return\nall of the metadata associated to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d426f400-c3fa-445a-9696-715e0561e9ab", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned when the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ecbda6a9-ef2a-4f0d-92ba-64bd9c0ee4c6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned when the user does not have access to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "06590ff7-9856-4ae1-acb8-377a5a68ea2f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2baa0868-3ba6-473c-8f81-a952a9de6a42", "documentation": "Remove classification from file", "method": "delete", "endpoint": "files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "responses": [ { "uuid": "e1996678-e55e-4762-b01c-bddbe9a3189e", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the classification is\nsuccessfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "91bdb65c-0ec8-4632-bfa5-3901f6081d91", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned when the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b73c76ab-6b7f-4fd1-a6b5-cdc2f5a02b58", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the file does not have any classification applied\nto it, or when the user does not have access to the\nfile.\n\n* `instance_not_found` - An instance of the classification metadata\ntemplate with the was not found on this file.\n* `not_found` - The file was not found, or the user does not have access\nto the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "33acc61a-d70a-4ec7-854b-1a98304fdf87", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned when the method was not allowed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6ca1046f-20d3-40a9-b5b4-f0adfaa39460", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4c74f171-f089-49f2-ac13-88c423b766b9", "documentation": "Get classification on file", "method": "get", "endpoint": "files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "responses": [ { "uuid": "c690d126-a4ce-4bb5-8a35-8ae4e15568cd", "body": "{\n \"$canEdit\": true,\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"{{oneOf (array 'securityClassification-6VMVochwUWo')}}\",\n \"$type\": \"securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8\",\n \"$typeVersion\": 5,\n \"$version\": 1,\n \"Box__Security__Classification__Key\": \"Sensitive\"\n}", "latency": 0, "statusCode": 201, "label": "Returns an instance of the `securityClassification` metadata\ntemplate, which contains a `Box__Security__Classification__Key`\nfield that lists all the classifications available to this\nenterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "96f8d972-374f-4c3c-b9e2-8ba0417efa7f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned when the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dcd0a034-8aa3-4172-aaa2-c7945c26755e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the metadata template specified\nwas not applied to this file or the user does not have access to the\nfile.\n\n* `instance_not_found` - The metadata template was not applied to the\nfile.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c2ba72ab-eefa-45e7-8fbf-5b898aab1d0f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned when the method was not allowed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "aa9ecef7-5a19-4494-a2e0-d40f779f6e6e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "48d8c130-9813-47d2-80e7-06d137bb49fa", "documentation": "Add classification to file", "method": "post", "endpoint": "files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "responses": [ { "uuid": "904f4fb7-61f0-4aec-9af5-ac14673c4d3e", "body": "{\n \"$canEdit\": true,\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"{{oneOf (array 'securityClassification-6VMVochwUWo')}}\",\n \"$type\": \"securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8\",\n \"$typeVersion\": 5,\n \"$version\": 1,\n \"Box__Security__Classification__Key\": \"Sensitive\"\n}", "latency": 0, "statusCode": 201, "label": "Returns the classification template instance\nthat was applied to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "49da271f-7733-4c98-823e-0fd0e762e17d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when the request body is not valid.\n\n* `schema_validation_failed` - The request body contains a value for a for\na field that either does not exist, or for which the value or type does\nnot match the expected field type. An example might be an unknown option\nfor an `enum` or `multiSelect` field.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cb84273e-2f0d-4e83-91e4-32e6e9c8f5ca", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the file or metadata template could not be found.\n\n* `not_found` - The file could not be found, or the user does not have\naccess to the file.\n* `instance_tuple_not_found` - The metadata template could not be found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0894d9df-647d-4e60-bfa2-836c2c08c9ef", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error when an instance of this metadata template is already\npresent on the file.\n\n* `tuple_already_exists` - An instance of them metadata template already\nexists on the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "aa64965e-1162-4acd-86d1-1b038f4cb138", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "14e5aebc-7b10-4539-a4bc-0461536ff25c", "documentation": "Update classification on file", "method": "put", "endpoint": "files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "responses": [ { "uuid": "36c47446-707a-4046-a8a9-1d4d9f5701da", "body": "{\n \"$canEdit\": true,\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"{{oneOf (array 'securityClassification-6VMVochwUWo')}}\",\n \"$type\": \"securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8\",\n \"$typeVersion\": 5,\n \"$version\": 1,\n \"Box__Security__Classification__Key\": \"Sensitive\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated classification metadata template instance.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "60b501cf-15d8-455f-b5c2-b7b3d6746ebb", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when the request body is not valid.\n\n* `bad_request` - The request body format is not an array of valid JSON\nPatch operations.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c2a15f61-f0a1-4e04-ac12-fdae3995faa7", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 500, "label": "Returns an error in some edge cases when the request body is not a valid\narray of JSON Patch items.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "25b5022a-3e38-4421-bffb-8c6257325007", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "44de3a0b-33c7-4b65-accf-82e21e7bcb42", "documentation": "Remove Box Skill cards from file", "method": "delete", "endpoint": "files/:file_id/metadata/global/boxSkillsCards", "responses": [ { "uuid": "11c074e6-125f-415e-9f80-2254d5612dea", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the cards are\nsuccessfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6d522b12-086d-47b5-bd3d-b12c71d1c649", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the file does not have an instance of the Box Skill\ncards applied to it, or when the user does not have access to the file.\n\n* `instance_not_found` - An instance of the metadata template for Box\nSkill cards was not found on this file.\n* `not_found` - The file was not found, or the user does not have access\nto the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6083ee1a-21c2-4c20-a663-3f279bd493d5", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned when the method was not allowed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7b9efc34-7f33-41d5-912b-456274974abf", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e1a8d317-0772-4cad-8351-2ab7a8c3fcaf", "documentation": "List Box Skill cards on file", "method": "get", "endpoint": "files/:file_id/metadata/global/boxSkillsCards", "responses": [ { "uuid": "3d1acfc1-7e96-4a06-b905-07c06f0d367b", "body": "{\n \"$canEdit\": true,\n \"$id\": \"01234500-12f1-1234-aa12-b1d234cb567e\",\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"properties\",\n \"$type\": \"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0\",\n \"$typeVersion\": 2,\n \"$version\": 1,\n \"cards\": [\n {\n \"created_at\": \"2018-04-13T13:53:23-07:00\",\n \"duration\": 1000,\n \"entries\": [\n {\n \"appears\": [\n {\n \"end\": 20,\n \"start\": 1\n }\n ],\n \"image_url\": \"https://example.com/image1.jpg\",\n \"text\": \"keyword1\"\n }\n ],\n \"invocation\": {\n \"id\": \"image-recognition-service-123\",\n \"type\": \"{{oneOf (array 'skill_invocation')}}\"\n },\n \"skill\": {\n \"id\": \"image-recognition-service\",\n \"type\": \"{{oneOf (array 'service')}}\"\n },\n \"skill_card_title\": {\n \"code\": \"my_transcripts\",\n \"message\": \"My Transcripts\"\n },\n \"skill_card_type\": \"{{oneOf (array 'transcript' 'keyword' 'timeline' 'status')}}\",\n \"status\": {\n \"code\": \"{{oneOf (array 'invoked' 'processing' 'success' 'transient_failure' 'permanent_failure')}}\",\n \"message\": \"We're preparing to process your file. Please hold on!\"\n },\n \"type\": \"{{oneOf (array 'skill_card')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Returns all the metadata associated with a file.\n\nThis API does not support pagination and will therefore always return\nall of the metadata associated to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "50d8be71-a0b5-4f14-8ea0-6574f49261d3", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8a114235-7383-4cbb-85df-9a6ef0e927f0", "documentation": "Create Box Skill cards on file", "method": "post", "endpoint": "files/:file_id/metadata/global/boxSkillsCards", "responses": [ { "uuid": "89ae2ac1-5f3e-4d7d-95ec-fde9376adb1c", "body": "{\n \"$canEdit\": true,\n \"$id\": \"01234500-12f1-1234-aa12-b1d234cb567e\",\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"properties\",\n \"$type\": \"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0\",\n \"$typeVersion\": 2,\n \"$version\": 1,\n \"cards\": [\n {\n \"created_at\": \"2018-04-13T13:53:23-07:00\",\n \"duration\": 1000,\n \"entries\": [\n {\n \"appears\": [\n {\n \"end\": 20,\n \"start\": 1\n }\n ],\n \"image_url\": \"https://example.com/image1.jpg\",\n \"text\": \"keyword1\"\n }\n ],\n \"invocation\": {\n \"id\": \"image-recognition-service-123\",\n \"type\": \"{{oneOf (array 'skill_invocation')}}\"\n },\n \"skill\": {\n \"id\": \"image-recognition-service\",\n \"type\": \"{{oneOf (array 'service')}}\"\n },\n \"skill_card_title\": {\n \"code\": \"my_transcripts\",\n \"message\": \"My Transcripts\"\n },\n \"skill_card_type\": \"{{oneOf (array 'transcript' 'keyword' 'timeline' 'status')}}\",\n \"status\": {\n \"code\": \"{{oneOf (array 'invoked' 'processing' 'success' 'transient_failure' 'permanent_failure')}}\",\n \"message\": \"We're preparing to process your file. Please hold on!\"\n },\n \"type\": \"{{oneOf (array 'skill_card')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 201, "label": "Returns the instance of the template that was applied to the file,\nincluding the data that was applied to the template.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fede8577-545a-48f2-8873-34deca5dd996", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when the request body is not valid.\n\n* `schema_validation_failed` - The request body contains a value for a for\na field that either does not exist, or for which the value or type does\nnot match the expected field type. An example might be an unknown option\nfor an `enum` or `multiSelect` field.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "29bf7f59-057f-4769-8383-81916124c3f0", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the file or metadata template could not be found.\n\n* `not_found` - The file could not be found, or the user does not have\naccess to the file.\n* `instance_tuple_not_found` - The metadata template could not be found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "aeda55c9-c336-40e6-8eed-3b3a38a5ecbf", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error when an instance of this metadata template is already\npresent on the file.\n\n* `tuple_already_exists` - An instance of them metadata template already\nexists on the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f917fe03-e7c4-4fa8-88bf-4e37bb921e54", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4a15b295-6d29-4bd1-8766-2d7f7ce9ca31", "documentation": "Update Box Skill cards on file", "method": "put", "endpoint": "files/:file_id/metadata/global/boxSkillsCards", "responses": [ { "uuid": "baaf815f-b415-41da-8f96-6de909f7b086", "body": "{\n \"$canEdit\": true,\n \"$id\": \"01234500-12f1-1234-aa12-b1d234cb567e\",\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"properties\",\n \"$type\": \"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0\",\n \"$typeVersion\": 2,\n \"$version\": 1,\n \"cards\": [\n {\n \"created_at\": \"2018-04-13T13:53:23-07:00\",\n \"duration\": 1000,\n \"entries\": [\n {\n \"appears\": [\n {\n \"end\": 20,\n \"start\": 1\n }\n ],\n \"image_url\": \"https://example.com/image1.jpg\",\n \"text\": \"keyword1\"\n }\n ],\n \"invocation\": {\n \"id\": \"image-recognition-service-123\",\n \"type\": \"{{oneOf (array 'skill_invocation')}}\"\n },\n \"skill\": {\n \"id\": \"image-recognition-service\",\n \"type\": \"{{oneOf (array 'service')}}\"\n },\n \"skill_card_title\": {\n \"code\": \"my_transcripts\",\n \"message\": \"My Transcripts\"\n },\n \"skill_card_type\": \"{{oneOf (array 'transcript' 'keyword' 'timeline' 'status')}}\",\n \"status\": {\n \"code\": \"{{oneOf (array 'invoked' 'processing' 'success' 'transient_failure' 'permanent_failure')}}\",\n \"message\": \"We're preparing to process your file. Please hold on!\"\n },\n \"type\": \"{{oneOf (array 'skill_card')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated metadata template, with the\ncustom template data included.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cb9a056d-9183-45ee-8175-5de3f7a32c77", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "The requested file could not be found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "61b0efbe-8684-4c46-a40b-5169f17acecd", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8e454ccf-4797-4e21-9401-4414a83903aa", "documentation": "Remove metadata instance from file", "method": "delete", "endpoint": "files/:file_id/metadata/:scope/:template_key", "responses": [ { "uuid": "ec206b60-8ac0-4d04-8019-c65deb363fb5", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the metadata is\nsuccessfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c865feac-92d1-429c-8564-d1728b4d1766", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned when the request parameters are not valid. This may happen of the\n`scope` is not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "05931656-88cb-4fd9-8a9c-454bf5ce17a6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the file does not have an instance of the metadata\ntemplate applied to it, or when the user does not have access to the\nfile.\n\n* `instance_not_found` - An instance of the metadata template with the\ngiven `scope` and `templateKey` was not found on this file.\n* `not_found` - The file was not found, or the user does not have access\nto the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fa4219ca-ceb4-4a92-81e7-bcb72e09d718", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned when the method was not allowed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c359ff01-2f94-4515-9829-c424082087ff", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "023920b8-8b2e-40f3-963c-e46ed33c490d", "documentation": "Get metadata instance on file", "method": "get", "endpoint": "files/:file_id/metadata/:scope/:template_key", "responses": [ { "uuid": "f047a184-0ddd-47fb-90b6-9ba3826a42a0", "body": "{\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"marketingCollateral\",\n \"$version\": 1\n}", "latency": 0, "statusCode": 201, "label": "An instance of the metadata template that includes\nadditional \"key:value\" pairs defined by the user or\nan application.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "34f9b50a-6a70-4df1-865c-6848568c765f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned when the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "48e201dc-4c58-4c0f-a32f-d59c1c0d1ed3", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the metadata template specified\nwas not applied to this file or the user does not have access to the\nfile.\n\n* `instance_not_found` - The metadata template was not applied to the\nfile.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0a2240f7-7a15-45eb-889b-2b0320cc6e66", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned when the method was not allowed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4581b397-341f-4c06-9384-9957a11df039", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "48b8ab75-bff0-438e-89f5-7093911d5fb2", "documentation": "Create metadata instance on file", "method": "post", "endpoint": "files/:file_id/metadata/:scope/:template_key", "responses": [ { "uuid": "36220b71-c79a-4860-bd2c-fb5cd66e1cd5", "body": "{\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"marketingCollateral\",\n \"$version\": 1\n}", "latency": 0, "statusCode": 201, "label": "Returns the instance of the template that was applied to the file,\nincluding the data that was applied to the template.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8fa81c7c-c954-4a7f-9d80-a1f5e9bb7da9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when the request body is not valid.\n\n* `schema_validation_failed` - The request body contains a value for a for\na field that either does not exist, or for which the value or type does\nnot match the expected field type. An example might be an unknown option\nfor an `enum` or `multiSelect` field.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9c3cbc0a-f2a9-4860-b8df-43dab586464b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the file or metadata template could not be found.\n\n* `not_found` - The file could not be found, or the user does not have\naccess to the file.\n* `instance_tuple_not_found` - The metadata template could not be found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c813268e-bf3b-407d-b1d7-2bb55512507b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error when an instance of this metadata template is already\npresent on the file.\n\n* `tuple_already_exists` - An instance of them metadata template already\nexists on the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a571b3c3-dc13-4bfd-9a6b-440251a1fbbc", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4949479a-b844-477b-9696-40eb4681dfc4", "documentation": "Update metadata instance on file", "method": "put", "endpoint": "files/:file_id/metadata/:scope/:template_key", "responses": [ { "uuid": "282e1dcd-69d2-4fa7-9a71-ea41478ce184", "body": "{\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"marketingCollateral\",\n \"$version\": 1\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated metadata template instance, with the\ncustom template data included.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fdefacec-c61e-42af-bdd4-edc060232209", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when the request body is not valid.\n\n* `bad_request` - The request body format is not an array of valid JSON\nPatch objects.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5ca653dc-4186-4e20-b828-e90adcf19542", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 500, "label": "Returns an error in some edge cases when the request body is not a valid\narray of JSON Patch items.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9bcbeb0d-93cb-4d13-b971-b6942e860f86", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a1319b9e-2f7e-48ab-aac3-3de408665a91", "documentation": "List tasks on file", "method": "get", "endpoint": "files/:file_id/tasks", "responses": [ { "uuid": "9804da2d-c36e-45cd-b83b-ae102fe43d01", "body": "{\n \"entries\": [\n {\n \"action\": \"{{oneOf (array 'review' 'complete')}}\",\n \"completion_rule\": \"{{oneOf (array 'all_assignees' 'any_assignee')}}\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {},\n \"due_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"is_completed\": true,\n \"item\": {},\n \"message\": \"Legal review\",\n \"task_assignment_collection\": {\n \"entries\": [\n {\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"assigned_by\": {},\n \"assigned_to\": {},\n \"completed_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"item\": {},\n \"message\": \"Please review\",\n \"reminded_at\": \"2012-12-12T10:53:43-08:00\",\n \"resolution_state\": \"{{oneOf (array 'completed' 'incomplete' 'approved' 'rejected')}}\",\n \"type\": \"{{oneOf (array 'task_assignment')}}\"\n }\n ],\n \"total_count\": 100\n },\n \"type\": \"{{oneOf (array 'task')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of tasks on a file.\n\nIf there are no tasks on this file an empty collection is returned\ninstead.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "713f3850-b532-4202-a004-1459eb4250e8", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the file could not be found or the user does not\nhave access to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e9702253-28ec-4d16-a7ea-8b0a515ed715", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returns an error when the `file_id` was not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "de10d83e-8a41-46b7-8ce2-a1e1fe64fdee", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 500, "label": "Returns an error when an attempt was made to retrieve tasks for the file\nwith ID `0`.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1d15823a-b7e7-40d6-8364-c823a780dd5e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1a64ff85-91d4-45c5-8e11-2fd2604ea718", "documentation": "Get file thumbnail", "method": "get", "endpoint": "files/:file_id/thumbnail.:extension", "responses": [ { "uuid": "bcbaf0ff-476d-44d4-bbff-868c88000c25", "body": "", "latency": 0, "statusCode": 200, "label": "When a thumbnail can be created the thumbnail data will be\nreturned in the body of the response.", "headers": [{ "key": "Content-Type", "value": "image/jpg" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8452e098-9586-4608-be3b-683189ff0eff", "body": "", "latency": 0, "statusCode": 202, "label": "Sometimes generating a thumbnail can take a few seconds. In these\nsituations the API returns a `Location`-header pointing to a\nplaceholder graphic for this file type.\n\nThe placeholder graphic can be used in a user interface until the\nthumbnail generation has completed. The `Retry-After`-header indicates\nwhen to the thumbnail will be ready. At that time, retry this endpoint\nto retrieve the thumbnail.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" }, { "key": "Retry-After", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a732c1f2-32c8-4c2a-8f51-45aac54a9994", "body": "", "latency": 0, "statusCode": 302, "label": "Returns an error when Box is not able to create a thumbnail for this\nfile type.\n\nInstead, a `Location`-header pointing to a placeholder graphic for\nthis file type will be returned.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "188676a5-bf58-460f-8504-b01f9abe088a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `requested_preview_unavailable` - an incorrect dimension was\n requested. This will happen if the dimension requested is\n larger or smaller than the available file sizes for the thumbnail\n format, or when when any of the size constraints contradict\n each other.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1dcf4066-df2f-4ac3-994b-4c5373537821", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "85982a46-4b29-41a8-85fc-1ed8fc1f9ba8", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the file is not found, or the user does not\nhave access to the file, or for additional reasons.\n\n* `preview_cannot_be_generated` - Box does not support thumbnails\n for this type of file", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4266beee-deca-47d0-a249-860f910648fd", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3c0429dd-89f6-4fd6-8973-7446e96acc07", "documentation": "Permanently remove file", "method": "delete", "endpoint": "files/:file_id/trash", "responses": [ { "uuid": "7fccfeba-d697-4061-a189-9bda1c6bc001", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the file was\npermanently deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "af00e056-4f95-46f8-94f0-4c075fef4c8f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the file is not in the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f576aef2-cde8-44c4-bb55-ed9353362459", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fd1aeb40-c803-4563-bcfc-2367c85b28b1", "documentation": "Get trashed file", "method": "get", "endpoint": "files/:file_id/trash", "responses": [ { "uuid": "374574ee-8424-4590-be25-3f22a6ea5330", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the file that was trashed,\nincluding information about when the it\nwas moved to the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c5c7d05e-f232-4b5f-a4c5-1034fbee81cc", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the file can not be found directly\nin the trash.\n\nPlease note that a `HTTP 404` is also returned if any of\nthe file's parent folders have been moved to the trash.\n\nIn that case, only that parent folder can be inspected using\nthe [`GET /folders/:id/trash`](e://get_folders_id_trash) API.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7db96c60-f5cb-441d-a15a-6bfa6cdc2d88", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1cfc1925-a081-4070-8844-084abe7a7f07", "documentation": "Create upload session for existing file", "method": "post", "endpoint": "files/:file_id/upload_sessions", "responses": [ { "uuid": "b994331a-f176-411c-8702-56d5505b2a5c", "body": "{\n \"id\": \"F971964745A5CD0C001BBE4E58196BFD\",\n \"num_parts_processed\": 455,\n \"part_size\": 1024,\n \"session_endpoints\": {\n \"abort\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD\",\n \"commit\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit\",\n \"list_parts\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts\",\n \"log_event\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/log\",\n \"status\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD\",\n \"upload_part\": \"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD\"\n },\n \"session_expires_at\": \"2012-12-12T10:53:43-08:00\",\n \"total_parts\": 1000,\n \"type\": \"{{oneOf (array 'upload_session')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Returns a new upload session.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0f799f4b-531b-45fd-811b-73fff7260379", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if the file already exists,\nor if the account has run out of disk space.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1f27cc25-22b6-4afd-9285-21a9251a2d54", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "13ea230b-2509-4073-988c-abe009382b43", "documentation": "List all file versions", "method": "get", "endpoint": "files/:file_id/versions", "responses": [ { "uuid": "27d944bf-8416-42b2-94c4-6e7dbc50fa2f", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns an array of past versions for this file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "37e2dfb1-0839-43cc-a177-5769f17a7ede", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fc414afc-1f1f-4ff3-8d64-a3a99fbe3a9c", "documentation": "Revert file version", "method": "post", "endpoint": "files/:file_id/versions/current", "responses": [ { "uuid": "8f53ccf9-dd04-4c38-9ab5-c099c29ad447", "body": "{}", "latency": 0, "statusCode": 201, "label": "Returns a newly created file version object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8084f6c3-c1a6-465f-9738-0cd527ff5425", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bedf14d5-f14e-4a1b-9af7-1e3caea3412a", "documentation": "Remove file version", "method": "delete", "endpoint": "files/:file_id/versions/:file_version_id", "responses": [ { "uuid": "41549c2f-f162-4bf5-acea-983829eb9c23", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the file has been successfully\ndeleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "43f2b9a4-6b2c-4895-866f-2a3d3ce38e44", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8ba84f55-d5f1-4842-bb48-2d630ec3bb4c", "documentation": "Get file version", "method": "get", "endpoint": "files/:file_id/versions/:file_version_id", "responses": [ { "uuid": "6939b957-f3d5-401b-9d8f-42d5a45b5012", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a specific version of a file.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0d9ea6d8-4d2b-458c-a12e-07f00e88b943", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b2fa4f3f-1223-4480-9228-85d40ccccf31", "documentation": "Remove watermark from file", "method": "delete", "endpoint": "files/:file_id/watermark", "responses": [ { "uuid": "86a79236-5d02-455a-ab58-14a80f51896c", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response will be returned when the watermark\nwas successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c6e141f2-c99e-4a81-b5d4-cae5c3650cad", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the file did not have\na watermark applied to it", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "47ab529c-ab2c-46a7-8b1b-030e50f20718", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d376727d-bf5d-49f9-b7d1-4080906a0e1b", "documentation": "Get watermark on file", "method": "get", "endpoint": "files/:file_id/watermark", "responses": [ { "uuid": "52a735c6-88a7-4401-a386-8a5cd1654f87", "body": "{\n \"watermark\": {\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns an object containing information about the\nwatermark associated for to this file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a6ba8993-d2a2-4298-9ca4-8cb082257cd8", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the file does not have a watermark applied.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "db070d00-97bf-474e-aa8f-06e04db060f9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3732cbaa-899f-4838-88f0-57d0083800bc", "documentation": "Apply watermark to file", "method": "put", "endpoint": "files/:file_id/watermark", "responses": [ { "uuid": "4d5b9099-0975-4103-8a61-37f59ac36247", "body": "{\n \"watermark\": {\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns an updated watermark if a watermark already\nexisted on this file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cab6d8b5-0b6c-44dc-bf17-cc8c8e10ae9d", "body": "{\n \"watermark\": {\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n }\n}", "latency": 0, "statusCode": 201, "label": "Returns a new watermark if no watermark existed on\nthis file yet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cf9ba5a4-af4d-44f7-8f05-81a4682e5e18", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5e8fdc56-cef6-48da-8556-c414c970e66e", "documentation": "List folder locks", "method": "get", "endpoint": "folder_locks", "responses": [ { "uuid": "d257e116-0016-4f55-84a7-c2a8719821ac", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns details for all folder locks applied to the folder, including the\nlock type and user that applied the lock.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4b7c9303-036a-41de-8da0-6d55f62a7de0", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "20fbeb41-6deb-4ae9-b67e-6475643a7d8f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b35b4f5e-e94a-4e50-903a-f141aab273d7", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `folder_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6ee5164d-667f-41fa-96cb-81d11b92569b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1042efb8-7b3b-4b12-a843-7b0e605faaa3", "documentation": "Create folder lock", "method": "post", "endpoint": "folder_locks", "responses": [ { "uuid": "65905ef3-8801-4948-8893-0dc9600acb6e", "body": "{\n \"created_at\": \"2020-09-14T23:12:53Z\",\n \"created_by\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'user')}}\"\n },\n \"folder\": {},\n \"id\": \"12345678\",\n \"lock_type\": \"freeze\",\n \"locked_operations\": {\n \"delete\": true,\n \"move\": true\n },\n \"type\": \"folder_lock\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the instance of the folder lock that was applied to the folder,\nincluding the user that applied the lock and the operations set.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "df330300-5834-4304-bb61-c13775762204", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when the request body is not valid.\n\n* `schema_validation_failed` - The request body contains a value for\na field that either does not exist, or for which the value or type does\nnot match the expected field type. An example might be an unknown option\nfor an `enum` or `multiSelect` field.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cb56ea8f-3427-4b0f-aa41-a13d763cb807", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the folder could not be found.\n\n* `not_found` - The folder could not be found, the user does not have\naccess to the folder, or the user making call is not an owner or co-owner\nof folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "334c4e38-e747-489b-9dd7-1b82da074e56", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b3758c64-bb2d-4f60-ae8c-5f2f023c018b", "documentation": "Delete folder lock", "method": "delete", "endpoint": "folder_locks/:folder_lock_id", "responses": [ { "uuid": "1c905da9-c895-4c47-9fc5-a1b67a8007c0", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the folder lock is successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a6920566-8674-40e9-ae31-912b442aab69", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the user does not have the required\naccess to perform the action.\n\n* `access_denied_insufficient_permissions`: Returned when the\n user does not have access to the folder.\n\n* `insufficient_scope`: Returned an error if the application\n does not have the right scope to delete folders. Make sure\n your application has been configured to read and write all files\n and folders stored in Box.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7965ea7a-aa29-44ce-96e6-8e9eefcc5493", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the folder could not be found,\nor the authenticated user does not have access to the folder.\n\n* `not_found` when the authenticated user does not have access\n to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "36332405-36a9-4cfd-b42e-f6feb9e61cb4", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "153fffb1-c1a1-4c07-843f-ef66a49f439e", "documentation": "Create folder", "method": "post", "endpoint": "folders", "responses": [ { "uuid": "c75a82f2-19cd-4ca4-bccb-b2d1df4f48cc", "body": "{}", "latency": 0, "statusCode": 201, "label": "Returns a folder object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5a86ad8b-52cb-47a0-af0b-b00077f7cce2", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `bad_request` when a parameter is missing or incorrect.\n* `item_name_too_long` when the folder name is too long.\n* `item_name_invalid` when the folder name contains\n non-valid characters.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d9c45867-7f61-4ca4-89ce-f5b2baada38e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the user does not have the required\naccess to perform the action. This might be because they\ndon't have access to the folder or parent folder, or because\nthe application does not have permission to write files and\nfolders.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e21bf5bd-a882-4ac1-af79-59c9f868a9ff", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the parent folder could not be found,\nor the authenticated user does not have access to the parent\nfolder.\n\n* `not_found` when the authenticated user does not have access\n to the parent folder", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8503faf3-c069-430e-8fde-81abdc6469db", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in process.\n\n The operation can be retried at a later point.\n\n* `item_name_in_use`: Returned if a folder with the name\n already exists in the parent folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f42bc130-cc41-447a-8a03-fd1fb03432ee", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "34934169-0104-4499-832b-28a1cda603a6", "documentation": "List trashed items", "method": "get", "endpoint": "folders/trash/items", "responses": [ { "uuid": "cb8d028b-01c2-4ad1-8fb3-7d58049ba813", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of items that have been deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e5d65edf-bd2c-4ce9-97c5-4d44e9225550", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `invalid_parameter` can appear when the `sort`, `direction` or `offset`\nparameter is provided when using marker based pagination, or when the\n`marker` parameter is provided but `usemarker` is set to `false` or\n`null`.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "be18b062-5f84-4b0f-8e1a-788d1e2b7fe4", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f7752010-c68e-4a51-970f-e77186f819bc", "documentation": "Delete folder", "method": "delete", "endpoint": "folders/:folder_id", "responses": [ { "uuid": "54ee0d9a-3902-4129-a33f-7f91e1112501", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the folder is successfully deleted\nor moved to the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "00a5bf11-9075-45f6-b7f8-4dcf522fadd2", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the user does not have the required\naccess to perform the action.\n\n* `access_denied_insufficient_permissions`: Returned when the\n user does not have access to the folder, or when a folder lock has been\n applied to the folder to prevent deletion.\n\n* `insufficient_scope`: Returned an error if the application\n does not have the right scope to delete folders. Make sure\n your application has been configured to read and write all files\n and folders stored in Box.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2388f602-91c3-4bf7-97a3-29b7125408ad", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the folder could not be found,\nor the authenticated user does not have access to the folder.\n\n* `not_found` when the authenticated user does not have access\n to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9d0307db-cfee-4219-87e1-2a42fa978c49", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "* `folder_not_empty`: Returned if the folder is not empty. Use the\n `recursive` query parameter to recursively delete the folder and\n its contents.\n* `operation_blocked_temporary`: Returned if the folder\n is locked due to another move, copy, delete or restore\n operation in progress.\n\n The operation can be retried at a later point.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c65bb437-e3bb-4596-bce5-c4a5f0494952", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the folder. This indicates that the\nfolder has changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b16f818e-11b9-4ba0-84b8-ecee7e7f04d1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 503, "label": "Returns an error when the operation takes longer\nthan 60 seconds. The operation will continue after\nthis response has been returned.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "aa958887-61c9-4e79-bb08-b1a10e6b16bf", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b3d28130-46c4-4f12-8995-a88db6cd820c", "documentation": "Get folder information", "method": "get", "endpoint": "folders/:folder_id", "responses": [ { "uuid": "19ebbd35-608f-4b9f-95e1-95a1671f4b9c", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a folder, including the first 100 entries in the folder.\n\nTo fetch more items within the folder, please use the\n[Get items in a folder](#get-folders-id-items) endpoint.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cda012a6-6567-4ea3-bd56-e93dd83e06a6", "body": "", "latency": 0, "statusCode": 304, "label": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the folder. This indicates that the folder\nhas not changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "173682b0-6393-4fd5-bffb-1cc06c714789", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "00ae8d6a-3a24-4bd3-9c32-62102b9c8ed1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d0afc1fd-1222-4fec-a21b-7e31ebb6241a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `folder_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "85a7e202-e1cd-4a26-98c8-45db0f55d0db", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "be620589-1f81-47ac-aff7-671ff861e2c0", "documentation": "Restore folder", "method": "post", "endpoint": "folders/:folder_id", "responses": [ { "uuid": "0c6e8d39-a337-43db-b40a-4ea3f7e30690", "body": "{}", "latency": 0, "statusCode": 201, "label": "Returns a folder object when the folder has been restored.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d2e96f45-cc45-4a45-8cc1-ef59b933b5c5", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the user does not have access to the folder\nthe folder is being restored to, or the user does not have permission\nto restore folders from the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "71c965e8-613a-4b39-8100-d62ddbadc28e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the folder is not in the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6089ad7b-38fb-4201-9422-8186f2e51a10", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "* Returned an error if there is a folder with the same name\n in the destination folder.\n\n* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in process.\n\n The operation can be retried at a later point.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d3af1b09-49e1-4148-b01f-f5b1b69ab0e5", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "76b300a6-c0cf-471d-b09d-40e203307941", "documentation": "Update folder", "method": "put", "endpoint": "folders/:folder_id", "responses": [ { "uuid": "aae37541-8133-4cd8-a6a9-4e4e88457903", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a folder object for the updated folder\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.\n\nThis call will return synchronously. This holds true even when\nmoving folders with a large a large number of items in all of its\ndescendants. For very large folders, this means the call could\ntake minutes or hours to return.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "35b581ab-1fac-41a0-a1a4-241af2fb51c6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if some of the parameters are missing or\nnot valid, or if a folder lock is preventing a move operation.\n\n* `bad_request` when a parameter is missing or incorrect. This error also\n happens when a password is set for a shared link with an access type\n of `open`.\n* `item_name_too_long` when the folder name is too long.\n* `item_name_invalid` when the folder name contains\n non-valid characters.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d55a31a4-de4b-46ad-8c5a-8a8a81440c1b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the user does not have the required\naccess to perform the action.\n\n* `access_denied_insufficient_permissions`: Returned when the\n user does not have access to the folder or parent folder, or if the\n folder is being moved and a folder lock has been applied to prevent\n such operations.\n\n* `insufficient_scope`: Returned an error if the application\n does not have the right scope to update folders. Make sure\n your application has been configured to read and write all files\n and folders stored in Box.\n\n* `forbidden`: Returned when the user is not allowed to perform this\n action for other users. This can include trying to create a\n Shared Link with a `company` access level on a free account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0a00d6d5-8e83-4b1d-ac17-f833093a122a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the folder or parent folder could not be found,\nor the authenticated user does not have access to either folder.\n\n* `not_found` when the authenticated user does not have access\n to the folder or parent folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fe0c989e-9372-4916-b512-51dd9f821ed8", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in progress.\n\n The operation can be retried at a later point.\n\n* `item_name_in_use`: Returned if a folder with the name\n already exists in the parent folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0525b70e-04a6-4f2f-983b-b231615ec232", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the folder. This indicates that the\nfolder has changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "07be31d2-c73a-45a1-a6f7-568860c2887d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 503, "label": "Returns an error when the operation takes longer\nthan 60 seconds. The operation will continue after\nthis response has been returned.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "46799a77-9e29-4318-9542-18359dcce541", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "606aa19f-f0e5-4576-9b46-5cd6616cc66d", "documentation": "Add shared link to folder", "method": "put", "endpoint": "folders/:folder_id#add_shared_link", "responses": [ { "uuid": "28d62668-14d9-4ccc-ab1d-670b9859dffc", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the base representation of a folder with a new shared\nlink attached.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5750b001-b5bf-440c-a10f-ae3ca0170c3d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4b156164-b9c6-403b-bb1e-62c8a4536624", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned if the user does not have all the permissions to complete the\nupdate.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "be9933c4-1fd3-4914-a9e1-55921fab7f89", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "198c5d45-e1d4-4ea6-bbf4-dcac3ecbc537", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `folder_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a98422bd-bca9-4c0d-b8af-1d3777b7f5be", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the folder. This indicates that the folder\nhas changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dba49036-92df-4a8b-b264-573b19db4928", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9196d6e5-74df-488a-8fe7-83f9b759e3d9", "documentation": "Get shared link for folder", "method": "get", "endpoint": "folders/:folder_id#get_shared_link", "responses": [ { "uuid": "5fb98bae-6542-4e61-a12a-9dc74ef30a4d", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the base representation of a folder with the\nadditional shared link information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "00a0a288-8c19-4f44-a7cf-b28568921b07", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "01e1c508-7afc-4b92-8de8-753d8753dafc", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5abee1e7-8906-461b-9124-755c94e688f6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `folder_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4c51e5e4-a95d-4303-8dc4-3c7ec76dfd15", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "18c12249-91a7-41ed-a4dc-870894b98433", "documentation": "Remove shared link from folder", "method": "put", "endpoint": "folders/:folder_id#remove_shared_link", "responses": [ { "uuid": "736be382-4ff4-4421-9655-f770293dbd05", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a basic representation of a folder, with the shared link removed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d8301ccb-2249-4a4d-9ea7-03b01d92501d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c4f033ae-465a-4360-92c5-1659974ced67", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned if the user does not have all the permissions to complete the\nupdate.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "05a513b4-fd56-4732-8efc-3accf8268605", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0eebe04e-c29b-40bb-b492-8661fd85c40a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `folder_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8ca748e6-aa4c-4e52-8f1a-f2be86e270b6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the folder. This indicates that the folder\nhas changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0a43ad43-7308-4a22-8a89-94fb029b47c6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6ceb2818-ecc1-4d0e-b222-0db8a57d11e5", "documentation": "Update shared link on folder", "method": "put", "endpoint": "folders/:folder_id#update_shared_link", "responses": [ { "uuid": "565662a3-0519-41cf-b339-4ce3008b48c4", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a basic representation of the folder, with the updated shared\nlink attached.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "566066a6-efde-4f6d-985a-c5266d8223f5", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0224b330-d274-4a88-9e92-484c5560a633", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned if the user does not have all the permissions to complete the\nupdate.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ab18a54d-ef81-4d1a-a261-504425ee900b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "413e498a-ac85-48e7-ba88-0238a786ffbf", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `folder_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c1551d04-56a6-443a-b388-9b3a6a8e9201", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 412, "label": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the folder. This indicates that the folder\nhas changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "13495bb3-3af5-4009-951e-b47967feca1b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d515bb3b-80a3-434e-b204-b340633c7934", "documentation": "List folder collaborations", "method": "get", "endpoint": "folders/:folder_id/collaborations", "responses": [ { "uuid": "b1731c6d-5f59-4a26-b62e-6bd1ae488167", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of collaboration objects. If there are no\ncollaborations on this folder an empty collection will be returned.\n\nThis list includes pending collaborations, for which the `status`\nis set to `pending`, indicating invitations that have been sent but not\nyet accepted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "419ccaf7-c5dd-41fb-85ef-436e6158a803", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d3fda18f-a78c-4c53-ae45-188eb93a852c", "documentation": "Copy folder", "method": "post", "endpoint": "folders/:folder_id/copy", "responses": [ { "uuid": "330aff9d-d255-42a9-9151-f7c5b403678d", "body": "{}", "latency": 0, "statusCode": 201, "label": "Returns a new folder object representing the copied folder.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bcda6ece-b117-46c5-aff2-4ddce9185fe7", "body": "", "latency": 0, "statusCode": 304, "label": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the folder. This indicates that the folder\nhas not changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b4595d40-20ca-4493-8769-5a9844b1b3ea", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `bad_request` when a parameter is missing.\n* `item_name_too_long` when the new folder name is too long.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3de1fa5f-e352-4817-9be1-9ae233bf15a1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if either the source or destination folder\ncould not be found, or the authenticated user does not\nhave access to either folders.\n\n* `not_found` when the authenticated user does not have access\n to the parent folder", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "caddad0f-053b-49aa-ab49-8d178d2209f9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if a folder by this name already exists\nin the destination folder, or if the destination folder\nis locked.\n\n* `item_name_in_use` when a folder with the same name already\n exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a9ec9259-323b-4746-a11a-148ede6409d9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 500, "label": "Returns an error when trying to copy the root folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "87262c5b-f456-47c7-8006-1841bbabeab2", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "42147a95-a4e1-4ad9-b3a6-bcc4e32fdfa8", "documentation": "List items in folder", "method": "get", "endpoint": "folders/:folder_id/items", "responses": [ { "uuid": "29d0497f-4e94-4c4c-b2ff-88842e3aa123", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of files, folders, and web links contained in a folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f9e36f10-b57d-47b8-9c52-beccea17d481", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c7ff34e8-2434-4db7-8369-77191c43aabc", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "55ea9ace-9c19-46a4-a929-840abe5676fe", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned if the `folder_id` is not in a recognized format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1cd5e6eb-a67d-418e-8080-9d2050fb9811", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "77425774-2af7-41dd-8c8e-75ddd50d721e", "documentation": "List metadata instances on folder", "method": "get", "endpoint": "folders/:folder_id/metadata", "responses": [ { "uuid": "029326d2-ca9d-4e89-87fe-52f38721d1a3", "body": "{\n \"entries\": [\n {\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"marketingCollateral\",\n \"$version\": 1\n }\n ],\n \"limit\": 100\n}", "latency": 0, "statusCode": 200, "label": "Returns all the metadata associated with a folder.\n\nThis API does not support pagination and will therefore always return\nall of the metadata associated to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fafe1a73-4899-4dad-93c0-cb2d7d36f320", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned when the request parameters are not valid.\n\n* `forbidden` - this operation is not allowed on the Root folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8351c34a-bb64-4092-9c9a-54bf3e309464", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned when the user does not have access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9dce3804-0240-47fd-9201-1ff3e5d7b881", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f002bf52-f9a8-486b-9f07-a928aaf28322", "documentation": "Remove classification from folder", "method": "delete", "endpoint": "folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "responses": [ { "uuid": "6ac5c0cb-90d2-433b-abb7-dd0521ec01cf", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the classification is\nsuccessfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "11fd01a7-f441-48f4-95a0-b4b6d80419a3", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned when the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3b7d4b5d-f25c-4f9c-b9fd-87ef2878d0b6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the folder does not have any classification applied\nto it, or when the user does not have access to the\nfolder.\n\n* `instance_not_found` - An instance of the classification metadata\ntemplate with the was not found on this folder.\n* `not_found` - The folder was not found, or the user does not have access\nto the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f7ba3987-fd86-4d66-8320-391f0cb412d1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned when the method was not allowed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d18ce43d-3fb8-4a7a-bd15-da67f961b8fc", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2b8dfc4a-b88f-4e7b-a165-dbafe3c5cead", "documentation": "Get classification on folder", "method": "get", "endpoint": "folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "responses": [ { "uuid": "899cfe5c-a9cf-4815-a916-14fb1fe7a755", "body": "{\n \"$canEdit\": true,\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"{{oneOf (array 'securityClassification-6VMVochwUWo')}}\",\n \"$type\": \"securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8\",\n \"$typeVersion\": 5,\n \"$version\": 1,\n \"Box__Security__Classification__Key\": \"Sensitive\"\n}", "latency": 0, "statusCode": 201, "label": "Returns an instance of the `securityClassification` metadata\ntemplate, which contains a `Box__Security__Classification__Key`\nfield that lists all the classifications available to this\nenterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "af3d391e-d9b9-4b72-b356-a25dc595d97b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned when the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b3504810-34c8-475e-860d-f36132241b0c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the metadata template specified\nwas not applied to this folder or the user does not have access to the\nfolder.\n\n* `instance_not_found` - The metadata template was not applied to the\nfolder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c24ec362-81f9-4fd9-8bf8-8685d5e110f1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned when the method was not allowed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8cbca7db-fdd1-486a-82c1-8edb6336abfb", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1909bedc-b3a7-4c6a-ae1c-36e5f765278f", "documentation": "Add classification to folder", "method": "post", "endpoint": "folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "responses": [ { "uuid": "b57e578c-76b0-489e-9b61-1c7ea5d445f6", "body": "{\n \"$canEdit\": true,\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"{{oneOf (array 'securityClassification-6VMVochwUWo')}}\",\n \"$type\": \"securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8\",\n \"$typeVersion\": 5,\n \"$version\": 1,\n \"Box__Security__Classification__Key\": \"Sensitive\"\n}", "latency": 0, "statusCode": 201, "label": "Returns the classification template instance\nthat was applied to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7cc1b3cd-0950-453a-b2c4-a9928ce7f6bf", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when the request body is not valid.\n\n* `schema_validation_failed` - The request body contains a value for a for\na field that either does not exist, or for which the value or type does\nnot match the expected field type. An example might be an unknown option\nfor an `enum` or `multiSelect` field.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b5c0465c-4051-446e-a08e-4c21d4a5264e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the folder or metadata template could not be found.\n\n* `not_found` - The folder could not be found, or the user does not have\naccess to the folder.\n* `instance_tuple_not_found` - The metadata template could not be found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2efac92c-6fe9-4f9d-836b-cec8f9e53b18", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error when an instance of this metadata template is already\npresent on the folder.\n\n* `tuple_already_exists` - An instance of them metadata template already\nexists on the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "162f755d-5e44-48aa-b960-7e01bb0f6802", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f14f378f-96af-4c5f-89b4-392b8dce326d", "documentation": "Update classification on folder", "method": "put", "endpoint": "folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "responses": [ { "uuid": "265a19e6-a043-4d6e-94dd-bf1fecf08766", "body": "{\n \"$canEdit\": true,\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"{{oneOf (array 'securityClassification-6VMVochwUWo')}}\",\n \"$type\": \"securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8\",\n \"$typeVersion\": 5,\n \"$version\": 1,\n \"Box__Security__Classification__Key\": \"Sensitive\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated classification metadata template instance.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "beb958c9-34b8-4702-964c-d200d2607893", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when the request body is not valid.\n\n* `bad_request` - The request body format is not an array of valid JSON\nPatch operations.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "56857861-7373-42d3-b991-53592096a9ec", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 500, "label": "Returns an error in some edge cases when the request body is not a valid\narray of JSON Patch items.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "19c97466-7fac-4ac5-893a-5899aad4589b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6c7f8925-e333-4e7f-b398-f1b7ffc83451", "documentation": "Remove metadata instance from folder", "method": "delete", "endpoint": "folders/:folder_id/metadata/:scope/:template_key", "responses": [ { "uuid": "de06d2be-e69d-4e90-a7f1-c28fc7bc3695", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the metadata is\nsuccessfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7539aa4b-e1b4-4c7b-8585-a24cacc788a4", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned when the request parameters are not valid. This may happen of the\n`scope` is not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "22f7f71c-cefe-4f07-950a-fb760f1d058f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the folder does not have an instance of the metadata\ntemplate applied to it, or when the user does not have access to the\nfolder.\n\n* `instance_not_found` - An instance of the metadata template with the\ngiven `scope` and `templateKey` was not found on this folder.\n* `not_found` - The folder was not found, or the user does not have access\nto the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "189065d7-927e-47dd-a114-f626982954ba", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned when the method was not allowed. This often happens when the\nfolder ID is not valid or the root folder with ID `0`.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d8313135-5fa8-412b-9334-7652973a731b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c3037448-8808-4149-a6b0-3f4183fc2bc3", "documentation": "Get metadata instance on folder", "method": "get", "endpoint": "folders/:folder_id/metadata/:scope/:template_key", "responses": [ { "uuid": "5e7cee5f-f998-4615-ae1b-68693b31d500", "body": "{\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"marketingCollateral\",\n \"$version\": 1\n}", "latency": 0, "statusCode": 201, "label": "An instance of the metadata template that includes\nadditional \"key:value\" pairs defined by the user or\nan application.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b6159d1e-a992-49fb-94bf-9865b34a5160", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned when the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dd47e0b0-4be7-45e6-9474-780108373520", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the metadata template specified\nwas not applied to this folder or the user does not have access to the\nfolder.\n\n* `instance_not_found` - The metadata template was not applied to the\nfolder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "635b94c8-874e-444e-9899-f143adbe81fe", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 405, "label": "Returned when the method was not allowed. This often happens when the\nfolder ID is not valid or the root folder with ID `0`.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "793e7696-99ca-43db-8ceb-7bb1fecec5cb", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "81f6cbd7-96d3-4893-8df4-34543b807345", "documentation": "Create metadata instance on folder", "method": "post", "endpoint": "folders/:folder_id/metadata/:scope/:template_key", "responses": [ { "uuid": "198d2fc7-4532-4b44-bbca-489b6fdc54f7", "body": "{\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"marketingCollateral\",\n \"$version\": 1\n}", "latency": 0, "statusCode": 201, "label": "Returns the instance of the template that was applied to the folder,\nincluding the data that was applied to the template.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "408aad01-4f87-4472-8354-4e295b699bbf", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when the request body is not valid.\n\n* `schema_validation_failed` - The request body contains a value for a for\na field that either does not exist, or for which the value or type does\nnot match the expected field type. An example might be an unknown option\nfor an `enum` or `multiSelect` field.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d0c45b83-56ce-4e9b-9bf7-6f1760ec55eb", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the folder or metadata template could not be found.\n\n* `not_found` - The folder could not be found, or the user does not have\naccess to the folder.\n* `instance_tuple_not_found` - The metadata template could not be found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7e1304c4-1aa9-44ad-bd27-d3f14664e7f8", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error when an instance of this metadata template is already\npresent on the folder.\n\n* `tuple_already_exists` - An instance of them metadata template already\nexists on the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "977a4833-e7df-41e6-bc7c-ca8f537b5633", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4e62079a-9b3c-4aca-85b5-0638898061a7", "documentation": "Update metadata instance on folder", "method": "put", "endpoint": "folders/:folder_id/metadata/:scope/:template_key", "responses": [ { "uuid": "904460e4-a605-4471-bdc2-3067a53fe9c3", "body": "{\n \"$parent\": \"folder_59449484661,\",\n \"$scope\": \"enterprise_27335\",\n \"$template\": \"marketingCollateral\",\n \"$version\": 1\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated metadata template instance, with the\ncustom template data included.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3f3ee4e6-6305-4d45-8da7-91cf77dd9eea", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when the request body is not valid.\n\n* `bad_request` - The request body format is not an array of valid JSON\nPatch objects.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e1ca0fcb-edb4-4016-92de-7044f50b36f1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 500, "label": "Returns an error in some edge cases when the request body is not a valid\narray of JSON Patch items.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "39bb6a18-cf2a-4813-bd64-9341a2405771", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "de1db3c8-8c73-4729-9bdd-4df2d02f7c45", "documentation": "Permanently remove folder", "method": "delete", "endpoint": "folders/:folder_id/trash", "responses": [ { "uuid": "b8b252ad-7ddf-4ce3-af65-0bf2e0abad4e", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the folder was\npermanently deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0cb5661b-21b4-4d79-a692-e80905b769e1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the folder is not in the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "46ffccba-72a3-470c-9fc4-8a3cf1ada466", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9692dc22-4feb-473c-b365-25bf252ce21c", "documentation": "Get trashed folder", "method": "get", "endpoint": "folders/:folder_id/trash", "responses": [ { "uuid": "fcc6976b-cfa6-473f-a766-45833408c153", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the folder that was trashed,\nincluding information about when the it\nwas moved to the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5ee688ec-b682-4b88-95ed-96819be2cfe5", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the folder can not be found directly\nin the trash.\n\nPlease note that a `HTTP 404` is also returned if any of\nthe folder's parent folders have been moved to the trash.\n\nIn that case, only that parent folder can be inspected using\nthe [`GET /folders/:id/trash`](e://get_folders_id_trash) API.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3beabe47-f9e9-4c17-b443-fbcdf667fd62", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8aad19c4-292d-4a3c-aba0-cd3e6f07074c", "documentation": "Remove watermark from folder", "method": "delete", "endpoint": "folders/:folder_id/watermark", "responses": [ { "uuid": "ecf2da58-2708-427b-83dd-ad7c3a01ad27", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response will be returned when the watermark\nwas successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4b295213-9a22-4310-a435-3eddfeee86c3", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the folder did not have\na watermark applied to it", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cc546e02-5012-4259-ad00-f46e5d423836", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f31e4bf3-a72e-4d05-9b9a-f18de701fa1d", "documentation": "Get watermark for folder", "method": "get", "endpoint": "folders/:folder_id/watermark", "responses": [ { "uuid": "6e34c203-5c99-4175-918e-dd62a5cd119a", "body": "{\n \"watermark\": {\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns an object containing information about the\nwatermark associated for to this folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "21015fec-c5f6-4009-8152-8e9fe926a82c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the folder does not have a watermark applied.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a1dc8f07-3679-46d6-b7d1-2ae43a7985c0", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "618dd3d6-337f-4085-913c-0e3b30164f6c", "documentation": "Apply watermark to folder", "method": "put", "endpoint": "folders/:folder_id/watermark", "responses": [ { "uuid": "8abe8209-5ee9-43b5-9571-7f9c14bbe7dc", "body": "{\n \"watermark\": {\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns an updated watermark if a watermark already\nexisted on this folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "350c7d77-eae1-4317-b9d4-b010c261c0f4", "body": "{\n \"watermark\": {\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\"\n }\n}", "latency": 0, "statusCode": 201, "label": "Returns a new watermark if no watermark existed on\nthis folder yet.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "af06cecc-da9c-4e25-af5c-bbf48b1b77ac", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "85423d93-29c9-4646-845f-64ccc086b207", "documentation": "Add user to group", "method": "post", "endpoint": "group_memberships", "responses": [ { "uuid": "587697e6-d83b-4e34-b4c0-7b95f6106bab", "body": "{\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"group\": {},\n \"id\": \"11446498\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"role\": \"{{oneOf (array 'member' 'admin')}}\",\n \"type\": \"{{oneOf (array 'group_membership')}}\",\n \"user\": {}\n}", "latency": 0, "statusCode": 201, "label": "Returns a new group membership object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "140033ac-7837-4d78-be69-f567650a90a2", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2288755e-e1d1-41d4-b9c4-0517e05596d8", "documentation": "Remove user from group", "method": "delete", "endpoint": "group_memberships/:group_membership_id", "responses": [ { "uuid": "a821328a-3745-4906-b2f0-c91221bbc281", "body": "", "latency": 0, "statusCode": 204, "label": "A blank response is returned if the membership was\nsuccessfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4d77920a-7214-43d6-921b-734dfc5b7bb6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "13c46004-b6ad-4c28-a8b3-1e45b7cc5f45", "documentation": "Get group membership", "method": "get", "endpoint": "group_memberships/:group_membership_id", "responses": [ { "uuid": "27af8a89-de8d-4e84-a362-01ce28ee48ea", "body": "{\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"group\": {},\n \"id\": \"11446498\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"role\": \"{{oneOf (array 'member' 'admin')}}\",\n \"type\": \"{{oneOf (array 'group_membership')}}\",\n \"user\": {}\n}", "latency": 0, "statusCode": 200, "label": "Returns the group membership object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c76841d1-4064-49d3-8af3-4c9f0b3bbae1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b29e32b0-eda2-4eb3-8a6c-e47aa1c81ed3", "documentation": "Update group membership", "method": "put", "endpoint": "group_memberships/:group_membership_id", "responses": [ { "uuid": "1fb58021-143d-49dd-a16a-c908b6cbeed3", "body": "{\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"group\": {},\n \"id\": \"11446498\",\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"role\": \"{{oneOf (array 'member' 'admin')}}\",\n \"type\": \"{{oneOf (array 'group_membership')}}\",\n \"user\": {}\n}", "latency": 0, "statusCode": 200, "label": "Returns a new group membership object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6348806c-34bd-4dfb-9d05-8a91a2f925f3", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3a2452d5-7fa9-4061-9d5e-9f1d6add426b", "documentation": "List groups for enterprise", "method": "get", "endpoint": "groups", "responses": [ { "uuid": "dd4f077b-0224-4f85-9d36-1f338924db97", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of group objects. If there are no groups, an\nempty collection will be returned.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3f98190b-ea98-4aa4-bd6a-275efebc0ce3", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b7d27dfc-8b38-4f16-a8d2-7aea2df4519f", "documentation": "Create group", "method": "post", "endpoint": "groups", "responses": [ { "uuid": "74534000-a8e3-4e9a-9294-96c4ec0e4dd1", "body": "{}", "latency": 0, "statusCode": 201, "label": "Returns the new group object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a3e5e06b-74c6-4f7e-bd75-cfa7032252b4", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error a conflict is stopping the group from being created.\n\n* `invalid_parameter`: Often returned if the group name is not unique in\nthe enterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5b1b718f-ce92-4c4e-a271-a1c8642f0126", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6244326c-c492-4c80-8c3b-2b1f322b8ed8", "documentation": "Remove group", "method": "delete", "endpoint": "groups/:group_id", "responses": [ { "uuid": "08a0f0cf-4894-402f-ab59-fdc564b9a465", "body": "", "latency": 0, "statusCode": 204, "label": "A blank response is returned if the group was\nsuccessfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "270f2347-0221-48ef-9621-e01275474417", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "342019a4-eb3a-4cad-972a-d086e1a55ee7", "documentation": "Get group", "method": "get", "endpoint": "groups/:group_id", "responses": [ { "uuid": "2b923bed-cfb4-48a3-9cef-1e84d3087e30", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the group object", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a9f3d33b-26c9-428b-b386-33b24b26f9b2", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5e05a382-8ec0-403d-a57c-a7b68d60206b", "documentation": "Update group", "method": "put", "endpoint": "groups/:group_id", "responses": [ { "uuid": "0a0e0186-54c6-49eb-b871-02fbe801a9c9", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the updated group object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cc5dbb5c-8921-4230-adb6-4ca5d54c60d3", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error a conflict is stopping the group from being created.\n\n* `invalid_parameter`: Often returned if the group name is not unique in\nthe enterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6401ed0e-78b5-44c4-93d2-ca4ef3ea6f29", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "efb8aa7f-223c-4448-85a6-396772a1e9c7", "documentation": "List group collaborations", "method": "get", "endpoint": "groups/:group_id/collaborations", "responses": [ { "uuid": "3e8188c2-e603-4084-89ed-aa4aacfb1482", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of collaboration objects. If there are no\ncollaborations, an empty collection will be returned.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "dbc6b47c-3101-4dfb-a738-40efbc4827ad", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "921bb861-de65-4405-bbb2-d6362feb888d", "documentation": "List members of group", "method": "get", "endpoint": "groups/:group_id/memberships", "responses": [ { "uuid": "f1dda09b-48d3-4714-a956-645321c71e8c", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of membership objects. If there are no\nmemberships, an empty collection will be returned.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "982165b5-992a-4369-a8f4-01c63d02440a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "57fdff08-5b9e-45ba-93b1-bf63ec97c352", "documentation": "Create user invite", "method": "post", "endpoint": "invites", "responses": [ { "uuid": "777c4870-8c55-4783-84f5-f981e2ab4a10", "body": "{\n \"actionable_by\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'user')}}\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"invited_by\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'user')}}\"\n },\n \"invited_to\": {\n \"id\": \"11446498\",\n \"name\": \"Acme Inc.\",\n \"type\": \"{{oneOf (array 'enterprise')}}\"\n },\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"status\": \"pending\",\n \"type\": \"{{oneOf (array 'invite')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a new invite object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ec34a51f-62d7-4d43-81b7-96b484816ace", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c5b3bb29-cdae-4592-a460-0288f47340b7", "documentation": "Get user invite status", "method": "get", "endpoint": "invites/:invite_id", "responses": [ { "uuid": "c24afe6d-563b-4825-bce1-12a063a519b1", "body": "{\n \"actionable_by\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'user')}}\"\n },\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"invited_by\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'user')}}\"\n },\n \"invited_to\": {\n \"id\": \"11446498\",\n \"name\": \"Acme Inc.\",\n \"type\": \"{{oneOf (array 'enterprise')}}\"\n },\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"status\": \"pending\",\n \"type\": \"{{oneOf (array 'invite')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns an invite object", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d89242ec-e829-4611-ad29-d529ce0019af", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b5660e98-be01-4ab2-80ed-40dc0c582f39", "documentation": "List all legal hold policies", "method": "get", "endpoint": "legal_hold_policies", "responses": [ { "uuid": "107ff3e1-b952-418b-9d68-12714521d69a", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of legal hold policies.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "71738ac6-2233-434e-98a8-2b00b965247b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3c33f7af-876a-44e0-9ce8-ebd464aa538a", "documentation": "Create legal hold policy", "method": "post", "endpoint": "legal_hold_policies", "responses": [ { "uuid": "869f7e65-abe4-400d-b9cd-93f666e71824", "body": "{\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'legal_hold_policy')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Returns a new legal hold policy object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "25ce36d8-7d6b-48dd-a279-8e2a6a843f34", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if required parameters are missing,\nor neither `is_ongoing` or filter dates are specified.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "666d7e1e-76d9-4042-8d16-a4fa3124665b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if a policy with this name already exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "709095d4-296b-4958-8f95-f689de8abb62", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "24d41d45-55cb-402d-b899-f549aa17196c", "documentation": "Remove legal hold policy", "method": "delete", "endpoint": "legal_hold_policies/:legal_hold_policy_id", "responses": [ { "uuid": "4db41af3-47ee-449c-aedb-2ed9628b912e", "body": "", "latency": 0, "statusCode": 202, "label": "A blank response is returned if the policy was\nsuccessfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "798de46c-9d67-442a-afb3-e71da4901ff0", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dd734ec1-9d50-40be-a303-1511b21aedf8", "documentation": "Get legal hold policy", "method": "get", "endpoint": "legal_hold_policies/:legal_hold_policy_id", "responses": [ { "uuid": "7b45ea92-8c89-4442-ac85-7c5087b743eb", "body": "{\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'legal_hold_policy')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a legal hold policy object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5ed56959-c758-48bd-ad72-4b4e5f7351bb", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3123919b-3b75-40e9-9219-21f511e5259f", "documentation": "Update legal hold policy", "method": "put", "endpoint": "legal_hold_policies/:legal_hold_policy_id", "responses": [ { "uuid": "972acae5-369b-4fd3-9bcf-a062f3e20c88", "body": "{\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'legal_hold_policy')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a new legal hold policy object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "28081d10-0e79-41d4-8aad-31ab3192b57d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if a policy with this name already exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8370de18-d799-490c-8c2a-2be2c4d62f48", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "82f99f6b-cf48-4daa-9324-f4d10c11c8d9", "documentation": "List legal hold policy assignments", "method": "get", "endpoint": "legal_hold_policy_assignments", "responses": [ { "uuid": "b5008290-eddb-4e16-b121-cb34ce352061", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of legal hold policy assignments.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b8cada18-a8b9-4da0-9158-f358f39cde87", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9475184c-52b0-43d1-b7cc-91a5edffa3a9", "documentation": "Assign legal hold policy", "method": "post", "endpoint": "legal_hold_policy_assignments", "responses": [ { "uuid": "c9641ee8-e04a-4b52-8213-0d5ec0da3a4d", "body": "{\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'legal_hold_policy_assignment')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Returns a new legal hold policy assignment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fda6e600-773b-4198-8884-caaffbc86edb", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "982ea627-ad2e-4b47-838b-07b2d303bb9c", "documentation": "Unassign legal hold policy", "method": "delete", "endpoint": "legal_hold_policy_assignments/:legal_hold_policy_assignment_id", "responses": [ { "uuid": "5163685e-2b22-4ef6-835d-576a83cb81da", "body": "", "latency": 0, "statusCode": 202, "label": "A blank response is returned if the assignment was\nsuccessfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "767ec612-b0d4-4923-90c5-b42a301014b4", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6c427457-543f-499b-8aca-18bd47fe78ee", "documentation": "Get legal hold policy assignment", "method": "get", "endpoint": "legal_hold_policy_assignments/:legal_hold_policy_assignment_id", "responses": [ { "uuid": "fa79aec7-3aca-4dc1-b8a0-6b8a6b68ced2", "body": "{\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'legal_hold_policy_assignment')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a legal hold policy object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a7460531-583a-4c12-8e60-31484891859d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6a31c5e2-280f-4f65-be05-71f270759667", "documentation": "List previous file versions for legal hold policy assignment", "method": "get", "endpoint": "legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold", "responses": [ { "uuid": "d8629eda-fae8-476c-acba-c17ccd27fae6", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns the list of previous file versions held under legal hold for a\nspecific legal hold policy assignment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e7b986a1-6405-404a-aaf6-a4e44a55167f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9edd9976-677a-4a46-a666-1d36e146c51c", "documentation": "List current file versions for legal hold policy assignment", "method": "get", "endpoint": "legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold", "responses": [ { "uuid": "46901889-a23f-4e08-b4ab-255e73c56ad1", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns the list of current file versions held under legal hold for a\nspecific legal hold policy assignment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "85ee8e98-b463-4d14-b612-2203b13398af", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6604db7d-86a7-4ca7-b5b3-5159a761015e", "documentation": "List metadata cascade policies", "method": "get", "endpoint": "metadata_cascade_policies", "responses": [ { "uuid": "167999d2-13d0-4552-87a0-b09c07ee7e39", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of metadata cascade policies", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cadb5669-564c-43dd-9dd9-159c2829c900", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when any of the parameters are not in a valid format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0f66f54f-0ea4-420e-bd85-b5cb6435ecee", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error when the folder can not be accessed. This error often\nhappens when accessing the root folder with ID `0`.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c8f681b2-d99a-4297-a9f1-8a754aa36097", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the folder can not be found or the user does not\nhave access to the folder.\n\n* `not_found` - The folder could not be found or the user does not have\n access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "72686ee0-1bb6-4b92-9f9a-0ac13987610a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d1612214-ee54-42f0-aa70-d95d662b2773", "documentation": "Create metadata cascade policy", "method": "post", "endpoint": "metadata_cascade_policies", "responses": [ { "uuid": "e95b3067-130c-450c-ba1d-fb8e6511ec99", "body": "{\n \"id\": \"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7\",\n \"owner_enterprise\": {\n \"id\": \"690678\",\n \"type\": \"{{oneOf (array 'enterprise')}}\"\n },\n \"parent\": {\n \"id\": \"1234567\",\n \"type\": \"{{oneOf (array 'folder')}}\"\n },\n \"scope\": \"{{oneOf (array 'global' 'enterprise_*')}}\",\n \"templateKey\": \"productInfo\",\n \"type\": \"{{oneOf (array 'metadata_cascade_policy')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Returns a new of metadata cascade policy", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d9977b4d-9e01-480f-80cd-e64972726317", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when any of the parameters are not in a valid format.\n\n* `bad_request` - Either the `scope`, `templateKey`, or `folder_id` are\nnot in a valid format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f5cd199d-4a74-4632-8c8b-f604c714ed69", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error when trying to apply a policy to a restricted folder, for\nexample the root folder with ID `0`.\n\n* `forbidden` - Although the folder ID was valid and the user has access\nto the folder, the policy could not be applied to this folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6ad07cb7-6da9-4d24-9f7a-2191f575247c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the template or folder can not be found, or when the\nuser does not have access to the folder or template.\n\n* `instance_tuple_not_found` - The template could not be found or the user\ndoes not have access to the template.\n* `not_found` - The folder could not be found or the user\ndoes not have access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "aaf5309c-162d-49a1-8422-78e088d0b268", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error when a policy for this folder and template is already in\nplace.\n\n* `tuple_already_exists` - A cascade policy for this combination of\n`folder_id`, `scope` and `templateKey` already exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ceeea9a9-66cf-452d-a3db-63547e98c3ab", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a43bda6a-c881-4595-be8e-bb3e6fa26cbe", "documentation": "Remove metadata cascade policy", "method": "delete", "endpoint": "metadata_cascade_policies/:metadata_cascade_policy_id", "responses": [ { "uuid": "64d102a2-3b2d-402f-8cbf-7c0ef011310f", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the policy\nis successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "18e625f6-b9e6-44c7-8bf1-f52188ac9501", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the policy can not be found or the user does not\nhave access to the folder.\n\n* `instance_not_found` - The policy could not be found\n* `not_found` - The folder could not be found or the user does not have\n access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fb1e943a-20d9-475d-a47d-0ad55a31ccab", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8955d059-2315-43f3-880a-8eb2c1fb4332", "documentation": "Get metadata cascade policy", "method": "get", "endpoint": "metadata_cascade_policies/:metadata_cascade_policy_id", "responses": [ { "uuid": "5670ef05-391b-4d44-a03d-8a7dd2fcb5ba", "body": "{\n \"id\": \"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7\",\n \"owner_enterprise\": {\n \"id\": \"690678\",\n \"type\": \"{{oneOf (array 'enterprise')}}\"\n },\n \"parent\": {\n \"id\": \"1234567\",\n \"type\": \"{{oneOf (array 'folder')}}\"\n },\n \"scope\": \"{{oneOf (array 'global' 'enterprise_*')}}\",\n \"templateKey\": \"productInfo\",\n \"type\": \"{{oneOf (array 'metadata_cascade_policy')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a metadata cascade policy", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c9332a73-f820-46d1-8a5a-37265a1d25df", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the policy can not be found or the user does not\nhave access to the folder.\n\n* `instance_not_found` - The policy could not be found\n* `not_found` - The folder could not be found or the user does not have\n access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7ff45002-34c9-495a-b6f6-afbb273c257b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c4e512a2-997d-48ce-87c6-7bd70d3754ce", "documentation": "Force-apply metadata cascade policy to folder", "method": "post", "endpoint": "metadata_cascade_policies/:metadata_cascade_policy_id/apply", "responses": [ { "uuid": "f1bc4a30-eaf8-4bb8-a8af-e173659aa251", "body": "", "latency": 0, "statusCode": 202, "label": "Returns an empty response when the API call was successful. The metadata\ncascade operation will be performed asynchronously.\n\nThe API call will return directly, before the cascade operation\nis complete. There is currently no API to check for the status of this\noperation.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5911dbd0-e2f1-4a06-a804-a9bc33d0d225", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the policy can not be found or the user does not\nhave access to the folder.\n\n* `instance_not_found` - The policy could not be found\n* `not_found` - The folder could not be found or the user does not have\n access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "493960d7-d38e-40a7-b016-7a7e09ad2d19", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cb2dca20-cbc2-4492-b9cd-880458e736ae", "documentation": "Query files/folders by metadata", "method": "post", "endpoint": "metadata_queries/execute_read", "responses": [ { "uuid": "329c8c27-7086-4ad2-ba98-c3ef328a59f3", "body": "{\n \"entries\": [\n {}\n ],\n \"limit\": 100,\n \"next_marker\": \"0!-M7487OpVfBTNBV-XsQjU50gQFlbFFu5nArMWD7Ck61GH_Qo40M1S2xN5zWZPBzEjaQS1SOjJiQoo5BsXEl1bCVLRZ2pTqo4SKp9tyqzWQK2L51KR_nC1EgF5I_TJSFw7uO2Bx4HweGETOjh5_2oPSWw5iMkM-OvGApeR0lGFO48FDKoyzJyLgz5aogxoKd8VE09CesOOnTnmZvrW0puylDc-hFjY5YLmWFBKox3SOWiSDwKFkmZGNHyjEzza1nSwbZg6CYsAdGsDwGJhuCeTNsFzP5Mo5qx9wMloS0lSPuf2CcBInbIJzl2CKlXF3FvqhANttpm2nzdBTQRSoJyJnjVBpf4Q_HjV2eb4KIZBBlLy067UCVdv2AAWQFd5E2i6s1YiGRTtgMEZntOSUYD4IYLMWWm5Ra7ke_SP32SL3GSjbBQYIyCVQ..\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of files and folders that match this metadata query.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "68dacd8b-4e4d-4c37-8ae6-14eb4ff93f94", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when the request body is not valid.\n\n* `invalid_query` - Any of the provided body parameters might be\nincorrect. This can mean the `query` is incorrect, as well as some cases\nwhere the `from` value does not represent a valid template.\n* `unexpected_json_type` - An argument from the `query` string is not\npresent in `query_param`. For example, `query` of `name = :name` requires\nthe `query_param` to include a value for the `name` argument, for example\n`{ \"name\": \"Box, Inc\" }`.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4bdf0e29-1cd8-43fb-be67-be96e7471d35", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when a metadata template with the given `scope` and\n`templateKey` can not be found. The error response will include extra\ndetails.\n\n* `instance_not_found` - The template could not be found. Please make sure\nto use the full template scope including the enterprise ID, like\n`enterprise_12345`.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "38c2cfca-4352-4c9e-aedb-397b75deed78", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fc6b828c-c644-403b-ad01-2fe7ac859b7a", "documentation": "List metadata query indices", "method": "get", "endpoint": "metadata_query_indices", "responses": [ { "uuid": "33a9e7eb-a418-4a99-946d-fb7cef27c50b", "body": "{\n \"entries\": [\n {\n \"fields\": [\n {\n \"key\": \"vendor name\",\n \"sort_direction\": \"{{oneOf (array 'asc' 'desc')}}\"\n }\n ],\n \"id\": \"-9876\",\n \"status\": \"{{oneOf (array 'building' 'active' 'disabled')}}\",\n \"type\": \"metadata_query_index\"\n }\n ],\n \"limit\": 100,\n \"next_marker\": \"0!-M7487OpVfBTNBV-XsQjU50gQFlbFFu5nArMWD7Ck61GH_Qo40M1S2xN5zWZPBzEjaQS1SOjJiQoo5BsXEl1bCVLRZ2pTqo4SKp9tyqzWQK2L51KR_nC1EgF5I_TJSFw7uO2Bx4HweGETOjh5_2oPSWw5iMkM-OvGApeR0lGFO48FDKoyzJyLgz5aogxoKd8VE09CesOOnTnmZvrW0puylDc-hFjY5YLmWFBKox3SOWiSDwKFkmZGNHyjEzza1nSwbZg6CYsAdGsDwGJhuCeTNsFzP5Mo5qx9wMloS0lSPuf2CcBInbIJzl2CKlXF3FvqhANttpm2nzdBTQRSoJyJnjVBpf4Q_HjV2eb4KIZBBlLy067UCVdv2AAWQFd5E2i6s1YiGRTtgMEZntOSUYD4IYLMWWm5Ra7ke_SP32SL3GSjbBQYIyCVQ..\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of metadata query indices for scope and template key.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "402c162c-41d6-4b0f-b787-776d92c41ac7", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when any of the parameters are not in a valid format.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "10ca1a6b-7360-4912-aed6-df6fb470cce7", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the scope and template combination cannot be found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "71bbb504-6bbf-4013-b2ca-2ac032de892c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0a6c45bf-ad82-43f8-8f2d-55066dd4d9ec", "documentation": "Find metadata template by instance ID", "method": "get", "endpoint": "metadata_templates", "responses": [ { "uuid": "24faa08d-722e-49c0-a2c4-fb1ea4f042ac", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a list containing the 1 metadata template that matches the\ninstance ID.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "160180c2-7455-4942-a2bc-b8d68b7dfcba", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned when the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "86f58138-3387-46d9-8de5-6af48fd3e700", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e3f439cf-1885-45f1-84db-190f0ac6df73", "documentation": "List all metadata templates for enterprise", "method": "get", "endpoint": "metadata_templates/enterprise", "responses": [ { "uuid": "5546989a-76da-46b2-944c-010e1cf0350b", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns all of the metadata templates within an enterprise\nand their corresponding schema.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b6d91955-c113-4b5f-b331-d426256e362e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned when the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "62802146-8e41-40cf-b18a-96cfaa674a03", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9927982e-7950-4993-8bf0-cab49de1a4b6", "documentation": "Delete all classifications", "method": "delete", "endpoint": "metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema", "responses": [ { "uuid": "8e3871a5-a3c9-4a87-acd3-58e0b900a5d4", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the metadata\ntemplate for classifications is successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "95bda74b-7dbe-414e-9fc2-216dd786f279", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "82798aea-2f2a-41ab-a710-2a16fa13b0db", "documentation": "List all classifications", "method": "get", "endpoint": "metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema", "responses": [ { "uuid": "e0ae4e75-5d10-409e-8ed5-f8e4de037b7f", "body": "{\n \"copyInstanceOnItemCopy\": true,\n \"displayName\": \"{{oneOf (array 'Classification')}}\",\n \"fields\": [\n {\n \"displayName\": \"{{oneOf (array 'Classification')}}\",\n \"hidden\": {{faker 'datatype.boolean'}},\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\",\n \"key\": \"{{oneOf (array 'Box__Security__Classification__Key')}}\",\n \"options\": [\n {\n \"id\": \"46aea176-3483-4431-856c-6b5b13d1cc50\",\n \"key\": \"Sensitive\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"Sensitive information\",\n \"colorID\": 4\n }\n }\n }\n ],\n \"type\": \"{{oneOf (array 'enum')}}\"\n }\n ],\n \"hidden\": {{faker 'datatype.boolean'}},\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"{{oneOf (array 'securityClassification-6VMVochwUWo')}}\",\n \"type\": \"{{oneOf (array 'metadata_template')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the `securityClassification` metadata template, which contains\na `Box__Security__Classification__Key` field that lists all the\nclassifications available to this enterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3b567b38-2522-4f0d-ba3a-e4f728dcf1e1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned if any of the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cd442e88-cef4-4e6c-a7fb-5de4c223068b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned when a template name is not correct. Please make sure\nthe URL for the request is correct.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "08acf168-ecaf-470f-8694-898e3bb829e7", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2a904f1b-de46-4bf7-8150-d82bae7ef036", "documentation": "Add classification", "method": "put", "endpoint": "metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add", "responses": [ { "uuid": "7ed1ba14-1112-4b00-a5a9-420f1f7d2680", "body": "{\n \"copyInstanceOnItemCopy\": true,\n \"displayName\": \"{{oneOf (array 'Classification')}}\",\n \"fields\": [\n {\n \"displayName\": \"{{oneOf (array 'Classification')}}\",\n \"hidden\": {{faker 'datatype.boolean'}},\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\",\n \"key\": \"{{oneOf (array 'Box__Security__Classification__Key')}}\",\n \"options\": [\n {\n \"id\": \"46aea176-3483-4431-856c-6b5b13d1cc50\",\n \"key\": \"Sensitive\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"Sensitive information\",\n \"colorID\": 4\n }\n }\n }\n ],\n \"type\": \"{{oneOf (array 'enum')}}\"\n }\n ],\n \"hidden\": {{faker 'datatype.boolean'}},\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"{{oneOf (array 'securityClassification-6VMVochwUWo')}}\",\n \"type\": \"{{oneOf (array 'metadata_template')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated `securityClassification` metadata template, which\ncontains a `Box__Security__Classification__Key` field that lists all\nthe classifications available to this enterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ed54d70b-a2ad-4fb8-951f-2468635c61d4", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned if any of the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "31350a32-2d60-4f6e-84cb-d92c0544aaef", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned when a template name is not correct. Please make sure\nthe URL for the request is correct.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "061c1384-8bab-4fdb-9cad-33b2fe0293a4", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0acb9110-e851-481c-8170-c493a04550fb", "documentation": "Delete classification", "method": "put", "endpoint": "metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete", "responses": [ { "uuid": "3ffc65b1-96ab-42fa-b6b0-c67fba391315", "body": "{\n \"copyInstanceOnItemCopy\": true,\n \"displayName\": \"{{oneOf (array 'Classification')}}\",\n \"fields\": [\n {\n \"displayName\": \"{{oneOf (array 'Classification')}}\",\n \"hidden\": {{faker 'datatype.boolean'}},\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\",\n \"key\": \"{{oneOf (array 'Box__Security__Classification__Key')}}\",\n \"options\": [\n {\n \"id\": \"46aea176-3483-4431-856c-6b5b13d1cc50\",\n \"key\": \"Sensitive\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"Sensitive information\",\n \"colorID\": 4\n }\n }\n }\n ],\n \"type\": \"{{oneOf (array 'enum')}}\"\n }\n ],\n \"hidden\": {{faker 'datatype.boolean'}},\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"{{oneOf (array 'securityClassification-6VMVochwUWo')}}\",\n \"type\": \"{{oneOf (array 'metadata_template')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated `securityClassification` metadata template, which\ncontains a `Box__Security__Classification__Key` field that lists all\nthe classifications available to this enterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c3ffe587-08ff-49cf-8dfb-7b1c5b6d818e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned if any of the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "59da0928-5b7c-4af2-a892-89b75232cd3c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned when a template name is not correct. Please make sure\nthe URL for the request is correct.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "60a8dea4-2f7d-48db-bca8-5b5716dea544", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2401fb90-84d9-4914-a2f6-07660d696d96", "documentation": "Update classification", "method": "put", "endpoint": "metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update", "responses": [ { "uuid": "a01711d4-321d-4a13-8495-6ab7be5c7ad7", "body": "{\n \"copyInstanceOnItemCopy\": true,\n \"displayName\": \"{{oneOf (array 'Classification')}}\",\n \"fields\": [\n {\n \"displayName\": \"{{oneOf (array 'Classification')}}\",\n \"hidden\": {{faker 'datatype.boolean'}},\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\",\n \"key\": \"{{oneOf (array 'Box__Security__Classification__Key')}}\",\n \"options\": [\n {\n \"id\": \"46aea176-3483-4431-856c-6b5b13d1cc50\",\n \"key\": \"Sensitive\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"Sensitive information\",\n \"colorID\": 4\n }\n }\n }\n ],\n \"type\": \"{{oneOf (array 'enum')}}\"\n }\n ],\n \"hidden\": {{faker 'datatype.boolean'}},\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"{{oneOf (array 'securityClassification-6VMVochwUWo')}}\",\n \"type\": \"{{oneOf (array 'metadata_template')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated `securityClassification` metadata template, which\ncontains a `Box__Security__Classification__Key` field that lists all\nthe classifications available to this enterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1e7ffca6-1ada-4893-b643-e8f90a5737f8", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned if any of the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4eee83c9-6c1b-4b20-95f0-36b7ddf25567", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned when a template name is not correct. Please make sure\nthe URL for the request is correct.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e9726996-0c69-40f4-ae63-3824b7bb3bce", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3d99cf92-30bf-4459-b1f6-fcf3befceb0e", "documentation": "List all global metadata templates", "method": "get", "endpoint": "metadata_templates/global", "responses": [ { "uuid": "34b8d016-a4c6-4e0a-8968-77383bff84c8", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns all of the metadata templates available to all enterprises\nand their corresponding schema.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4791b29b-305d-4905-94da-c90cdb2ce124", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned when the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "abbc0ab6-4a9d-4160-8df5-7421917781cf", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ef99830f-f52f-48c0-89c0-7751e27fe838", "documentation": "Create metadata template", "method": "post", "endpoint": "metadata_templates/schema", "responses": [ { "uuid": "1dd1a8c7-2aa3-4e35-affb-9a61147a61bb", "body": "{\n \"copyInstanceOnItemCopy\": true,\n \"displayName\": \"Product Info\",\n \"fields\": [\n {\n \"description\": \"The category\",\n \"displayName\": \"Category\",\n \"hidden\": true,\n \"key\": \"category\",\n \"options\": [\n {\n \"key\": \"Category 1\"\n }\n ],\n \"type\": \"{{oneOf (array 'string' 'float' 'date' 'enum' 'multiSelect')}}\"\n }\n ],\n \"hidden\": true,\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\",\n \"type\": \"{{oneOf (array 'metadata_template')}}\"\n}", "latency": 0, "statusCode": 201, "label": "The schema representing the metadata template created.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cfa8f57a-2a23-486f-b541-785cc4a4b82b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned if the request parameters or body is not valid.\n\n* `bad_request` when the body does not contain a valid request. In many\ncases this response will include extra details on what fields are missing.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2a26705e-c0ae-4a04-8861-7b5eb7167427", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned when the user does not have the permission to create the metadata\ntemplate. This can happen for a few reasons, most commonly when the user\ndoes not have (co-)admin permissions, or the application tries to create a\ntemplate with the `global` scope.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "de651945-8fec-496c-a62d-623ef5ba7504", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "32d802ce-a165-4bb5-8c98-a45c03aa5708", "documentation": "Add initial classifications", "method": "post", "endpoint": "metadata_templates/schema#classifications", "responses": [ { "uuid": "635847e8-0c7d-44d1-a200-f080b15c9318", "body": "{\n \"copyInstanceOnItemCopy\": true,\n \"displayName\": \"{{oneOf (array 'Classification')}}\",\n \"fields\": [\n {\n \"displayName\": \"{{oneOf (array 'Classification')}}\",\n \"hidden\": {{faker 'datatype.boolean'}},\n \"id\": \"822227e0-47a5-921b-88a8-494760b2e6d2\",\n \"key\": \"{{oneOf (array 'Box__Security__Classification__Key')}}\",\n \"options\": [\n {\n \"id\": \"46aea176-3483-4431-856c-6b5b13d1cc50\",\n \"key\": \"Sensitive\",\n \"staticConfig\": {\n \"classification\": {\n \"classificationDefinition\": \"Sensitive information\",\n \"colorID\": 4\n }\n }\n }\n ],\n \"type\": \"{{oneOf (array 'enum')}}\"\n }\n ],\n \"hidden\": {{faker 'datatype.boolean'}},\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"{{oneOf (array 'securityClassification-6VMVochwUWo')}}\",\n \"type\": \"{{oneOf (array 'metadata_template')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a new `securityClassification` metadata template, which\ncontains a `Box__Security__Classification__Key` field that lists all\nthe classifications available to this enterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4fd8763a-c2a0-464e-930d-6dc60da5338d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned if any of the request parameters are not valid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5e8daf17-6be8-4b92-b78b-47d1d7eebdfd", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned when a template name is not correct. Please make sure\nthe URL for the request is correct.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "12f747e7-fb57-4e04-9fa6-3b94a8c1bb49", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9cfd147b-1183-457d-8419-78f8022177b8", "documentation": "Remove metadata template", "method": "delete", "endpoint": "metadata_templates/:scope/:template_key/schema", "responses": [ { "uuid": "06c0800d-5014-47ad-bbbf-9696a7b6bc4e", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the metadata\ntemplate is successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2c3cdfa4-7cb9-44c1-b11d-cd31c68a66d9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Request body does not contain a valid metadata schema.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4f9f7ccf-0d60-441e-8935-760573c1831a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Request body contains a scope that the user is not allowed to\ncreate a template for.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "050f0b32-8e0f-4bce-8a57-6e81aae98f84", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "63b5d265-a873-4287-bed1-d88c413e51ed", "documentation": "Get metadata template by name", "method": "get", "endpoint": "metadata_templates/:scope/:template_key/schema", "responses": [ { "uuid": "c0a1f84c-0354-4ff2-b08e-8e534df99e3b", "body": "{\n \"copyInstanceOnItemCopy\": true,\n \"displayName\": \"Product Info\",\n \"fields\": [\n {\n \"description\": \"The category\",\n \"displayName\": \"Category\",\n \"hidden\": true,\n \"key\": \"category\",\n \"options\": [\n {\n \"key\": \"Category 1\"\n }\n ],\n \"type\": \"{{oneOf (array 'string' 'float' 'date' 'enum' 'multiSelect')}}\"\n }\n ],\n \"hidden\": true,\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\",\n \"type\": \"{{oneOf (array 'metadata_template')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the metadata template matching the `scope`\nand `template` name.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f5b23d1c-6a8d-421f-8625-a0ca33d1506f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned if any of the request parameters are not valid.\n\n* `bad_request`: Often returned when the scope of the template is not\n recognised. Please make sure to use either `enterprise` or `global` as\n the `scope` value.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "821a08e1-d8c5-474e-b0b9-5914365fedee", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned when a template with the given `scope` and `template_key` can not\nbe found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c83f2d34-fd59-4e98-abd2-b1de50dc8e76", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b1545e31-3239-4ad6-aef5-61c207a5a7c0", "documentation": "Update metadata template", "method": "put", "endpoint": "metadata_templates/:scope/:template_key/schema", "responses": [ { "uuid": "d099f36a-2b31-46d5-b172-85bbbc89ff91", "body": "{\n \"copyInstanceOnItemCopy\": true,\n \"displayName\": \"Product Info\",\n \"fields\": [\n {\n \"description\": \"The category\",\n \"displayName\": \"Category\",\n \"hidden\": true,\n \"key\": \"category\",\n \"options\": [\n {\n \"key\": \"Category 1\"\n }\n ],\n \"type\": \"{{oneOf (array 'string' 'float' 'date' 'enum' 'multiSelect')}}\"\n }\n ],\n \"hidden\": true,\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\",\n \"type\": \"{{oneOf (array 'metadata_template')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated metadata template, with the\ncustom template data included.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8f294a67-f09a-4dba-a6eb-9bf52375aed2", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "The request body does not contain a valid metadata schema.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "374d34dc-eb31-455b-8e52-d22f51300dd4", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "The request body contains a scope that the user is not\nallowed to create templates for.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2f67a2c7-8320-4b00-bf28-10518063d9d0", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "The requested template could not be found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "662128ab-c599-48f9-af6a-ccadcf412bc8", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cb6427b0-4fa2-4599-88cc-233c157d3db6", "documentation": "Get metadata template by ID", "method": "get", "endpoint": "metadata_templates/:template_id", "responses": [ { "uuid": "5b8a253a-d76f-4152-acbf-b4f56579763e", "body": "{\n \"copyInstanceOnItemCopy\": true,\n \"displayName\": \"Product Info\",\n \"fields\": [\n {\n \"description\": \"The category\",\n \"displayName\": \"Category\",\n \"hidden\": true,\n \"key\": \"category\",\n \"options\": [\n {\n \"key\": \"Category 1\"\n }\n ],\n \"type\": \"{{oneOf (array 'string' 'float' 'date' 'enum' 'multiSelect')}}\"\n }\n ],\n \"hidden\": true,\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\",\n \"type\": \"{{oneOf (array 'metadata_template')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the metadata template that matches the ID.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8bd222af-c136-4fb3-b0ca-5a8afc085229", "body": "{\n \"copyInstanceOnItemCopy\": true,\n \"displayName\": \"Product Info\",\n \"fields\": [\n {\n \"description\": \"The category\",\n \"displayName\": \"Category\",\n \"hidden\": true,\n \"key\": \"category\",\n \"options\": [\n {\n \"key\": \"Category 1\"\n }\n ],\n \"type\": \"{{oneOf (array 'string' 'float' 'date' 'enum' 'multiSelect')}}\"\n }\n ],\n \"hidden\": true,\n \"id\": \"58063d82-4128-7b43-bba9-92f706befcdf\",\n \"scope\": \"enterprise_123456\",\n \"templateKey\": \"productInfo\",\n \"type\": \"{{oneOf (array 'metadata_template')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned if any of the request parameters are not valid.\n\n* `bad_request`: Often returned with a message when the ID of the template\n is not recognised.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "af6194b8-0c05-403e-bf58-d3b0ce68e1a9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5a838b14-6010-485e-a127-5ebc4447cd69", "documentation": "Revoke access token", "method": "post", "endpoint": "oauth2/revoke", "responses": [ { "uuid": "0bfb221c-950c-4375-b863-7f9ce1a6471d", "body": "", "latency": 0, "statusCode": 200, "label": "Returns an empty response when the token was successfully revoked.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8ec70cba-b348-41ff-961d-8559a5629d6e", "body": "{\n \"error\": \"invalid_client\",\n \"error_description\": \"The client credentials are not valid\"\n}", "latency": 0, "statusCode": 400, "label": "An authentication error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "19d94225-360b-40b5-9902-31a2ef8c4440", "body": "{\n \"error\": \"invalid_client\",\n \"error_description\": \"The client credentials are not valid\"\n}", "latency": 0, "statusCode": 200, "label": "An authentication error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6bfda2b5-4f45-4a18-9eb1-ce2782c126b7", "documentation": "Request access token", "method": "post", "endpoint": "oauth2/token", "responses": [ { "uuid": "aebdef17-e3df-4af5-8d61-353ef7187638", "body": "{\n \"access_token\": \"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ\",\n \"expires_in\": 3600,\n \"issued_token_type\": \"{{oneOf (array 'urn:ietf:params:oauth:token-type:access_token')}}\",\n \"refresh_token\": \"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ\",\n \"restricted_to\": [\n {\n \"object\": {},\n \"scope\": \"{{oneOf (array 'annotation_edit' 'annotation_view_all' 'annotation_view_self' 'base_explorer' 'base_picker' 'base_preview' 'base_upload' 'item_delete' 'item_download' 'item_preview' 'item_rename' 'item_share')}}\"\n }\n ],\n \"token_type\": \"{{oneOf (array 'bearer')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a new Access Token that can be used to make authenticated\nAPI calls by passing along the token in a authorization header as\nfollows `Authorization: Bearer `.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cb8673ad-1afd-44ca-bfa4-c6071ffd1c37", "body": "{\n \"error\": \"invalid_client\",\n \"error_description\": \"The client credentials are not valid\"\n}", "latency": 0, "statusCode": 400, "label": "An authentication error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b623ba73-f1a7-4d39-96d2-972b188dff83", "body": "{\n \"error\": \"invalid_client\",\n \"error_description\": \"The client credentials are not valid\"\n}", "latency": 0, "statusCode": 200, "label": "An authentication error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "62b26b0c-364f-424f-a418-93a02fb80136", "documentation": "Refresh access token", "method": "post", "endpoint": "oauth2/token#refresh", "responses": [ { "uuid": "5d5f8a81-81a1-4df2-9193-8f4e733c1a79", "body": "{\n \"access_token\": \"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ\",\n \"expires_in\": 3600,\n \"issued_token_type\": \"{{oneOf (array 'urn:ietf:params:oauth:token-type:access_token')}}\",\n \"refresh_token\": \"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ\",\n \"restricted_to\": [\n {\n \"object\": {},\n \"scope\": \"{{oneOf (array 'annotation_edit' 'annotation_view_all' 'annotation_view_self' 'base_explorer' 'base_picker' 'base_preview' 'base_upload' 'item_delete' 'item_download' 'item_preview' 'item_rename' 'item_share')}}\"\n }\n ],\n \"token_type\": \"{{oneOf (array 'bearer')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a new Access Token that can be used to make authenticated\nAPI calls by passing along the token in a authorization header as\nfollows `Authorization: Bearer `.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bdcc577d-0253-41a0-a118-cb2a657ef32a", "body": "{\n \"error\": \"invalid_client\",\n \"error_description\": \"The client credentials are not valid\"\n}", "latency": 0, "statusCode": 400, "label": "An authentication error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "daf3aa9c-ed0c-48b9-a9f2-70360f330624", "body": "{\n \"error\": \"invalid_client\",\n \"error_description\": \"The client credentials are not valid\"\n}", "latency": 0, "statusCode": 200, "label": "An authentication error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5e334238-f1b1-468c-a9e8-5cf819fec931", "documentation": "List recently accessed items", "method": "get", "endpoint": "recent_items", "responses": [ { "uuid": "33468161-ffcc-4fb1-915a-8f688a61f995", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a list recent items access by a user.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f9396a7d-ed73-4828-8739-7a529b1ed52f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a3ef50a1-9057-4907-a672-85bf66d1848c", "documentation": "List retention policies", "method": "get", "endpoint": "retention_policies", "responses": [ { "uuid": "ec96772b-f4c9-4318-8196-cfaefe07a44c", "body": "{\n \"entries\": [\n {}\n ],\n \"total_count\": 156\n}", "latency": 0, "statusCode": 200, "label": "Returns a list retention policies in the enterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d7ab500e-150f-429b-8bd8-e54cf3355140", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns a `bad_request` if a non existent `policy_type` was specified.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "01ec248f-b0d6-4996-81f1-1e1122c43b4e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns a `not_found` error if the user specified in `created_by_user_id`\ndoes not exist.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e42f182c-07e3-4e61-8878-8144572f7ff2", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c962b643-f4b3-4206-9009-636b0bcb19a6", "documentation": "Create retention policy", "method": "post", "endpoint": "retention_policies", "responses": [ { "uuid": "1df0fe3d-24cf-47da-a6a2-b56e2b576035", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a new retention policy object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a9bcad38-17c2-43fd-9df4-884471adee2e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns a `bad_request` error with the `retention_length` was\nspecified for a `infinite` retention policy, or an incorrect\n`disposition_action` was set.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fab0dd6f-d54a-4333-9028-e31515a811f2", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if a retention policy with the given name already exists", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e970cd43-b854-42f8-afa2-361a8910c762", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ab997488-91b1-45db-8b40-92b5b60974d2", "documentation": "Get retention policy", "method": "get", "endpoint": "retention_policies/:retention_policy_id", "responses": [ { "uuid": "7b64edb9-5876-423b-8dc7-9d1d9d6f7730", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the retention policy object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "22266b74-6baf-4c25-abe3-f816290edc21", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b04cd47c-f6d2-4f3c-8b0a-ced90974ff24", "documentation": "Update retention policy", "method": "put", "endpoint": "retention_policies/:retention_policy_id", "responses": [ { "uuid": "76f8cced-c249-469b-9575-28039728cd44", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the updated retention policy object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e2e1e78c-4021-49d1-9aeb-5ac145c53393", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns a `bad_request` if an incorrect\n`disposition_action` was set.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "10ad705a-b0ca-438e-b058-f17303646471", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if a retention policy with the given name already exists", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "534ef155-9f1e-4343-ab82-41ac60422fd5", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8552fcd5-40cd-4b9f-b9e4-d200b6e48512", "documentation": "List retention policy assignments", "method": "get", "endpoint": "retention_policies/:retention_policy_id/assignments", "responses": [ { "uuid": "5d54031e-fc75-4abc-87f1-d43f13206c15", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of the retention policy assignments associated with the\nspecified retention policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a4b1a7f9-9338-4af9-aeab-b7cc6331a07d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if an unknown `type` is specified.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "86425da8-910e-4de6-99be-ce0312140de9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d1b1babe-5fae-426e-a0cf-4c1665b26cd4", "documentation": "Assign retention policy", "method": "post", "endpoint": "retention_policy_assignments", "responses": [ { "uuid": "ff94dc00-791d-4494-925b-8f4c12284d7f", "body": "{\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"assigned_by\": {},\n \"assigned_to\": {\n \"id\": \"11446498\",\n \"type\": \"file\"\n },\n \"id\": \"11446498\",\n \"retention_policy\": {},\n \"type\": \"{{oneOf (array 'retention_policy_assignment')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Returns a new retention policy assignment object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9921df12-53e8-4de1-b0c3-1392bd0ecc5d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if an `id` is specified while assigning a the\nretention policy to an enterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bba0f09f-dceb-47ab-8a6b-2cdedd46c33c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if no retention policy with the given `policy_id` exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "08bfa322-a615-43d6-97d2-60ac9ab2071c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if a retention policy of equal or greater length has\nalready been assigned to this item.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bf5772e0-e6b7-4b3a-9231-63cb523a1fd2", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "44476395-405d-4afd-aec7-3bd167ff1d43", "documentation": "Get retention policy assignment", "method": "get", "endpoint": "retention_policy_assignments/:retention_policy_assignment_id", "responses": [ { "uuid": "c56a0991-50f8-45e9-abe0-2e5db198bc71", "body": "{\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"assigned_by\": {},\n \"assigned_to\": {\n \"id\": \"11446498\",\n \"type\": \"file\"\n },\n \"id\": \"11446498\",\n \"retention_policy\": {},\n \"type\": \"{{oneOf (array 'retention_policy_assignment')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the retention policy assignment object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "368f7f8f-8385-41df-8041-0842e950cad6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fe2b95a5-3905-480e-94ed-3bacf3d35079", "documentation": "Get file versions under retention", "method": "get", "endpoint": "retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention", "responses": [ { "uuid": "43d2f905-959c-4a71-9f0d-e122f48fe5d8", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of file versions under retention that are associated with\nthe specified retention policy assignment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9ad3f727-2786-4d7f-bc0f-6c5d16046227", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if `retention_policy_assignment_id` is not specified.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "79ac5242-46dc-4328-86cd-b34c1648ab65", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8d575bb9-8a14-4a64-bf3e-eb4fa8c04bf4", "documentation": "Get files under retention", "method": "get", "endpoint": "retention_policy_assignments/:retention_policy_assignment_id/files_under_retention", "responses": [ { "uuid": "87f7186e-6bb6-40dd-a290-cb35f0362139", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of files under retention that are associated with the\nspecified retention policy assignment.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "317995b8-34ae-4558-9d75-8f184534b370", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if `retention_policy_assignment_id` is not specified.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "53267d0b-88c2-4275-9b92-98ccdffbc41c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9836aa10-57ee-476a-950d-bbfecbc085ec", "documentation": "Search for content", "method": "get", "endpoint": "search", "responses": [ { "uuid": "e5e5505d-0625-434e-8104-66f437026789", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a collection of search results. If there are no matching\nsearch results, the `entries` array will be empty.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b3cce2f7-ed1c-4fff-abe9-def8c1428340", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when the request was not valid. This can have multiple\nreasons and the `context_info` object will provide you with more details.\n\n* `missing_parameter` - Please provide at least the `query` or `mdfilters`\n query parameter in a search.\n* `invalid_parameter` - Any of the fields might not be in the right\n format. This could for example mean that one of the RFC3339 dates is\n incorrect, or a string is provided where an integer is expected.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1373db8e-4b02-4782-b506-ccbee7ea741d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error when the user does not have the permission to make\nthis API call.\n\n* The developer provided a `scope` of `enterprise_content` but did\n not request this scope to be enabled for the user through our\n support channels.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0ce74800-2b44-4ec0-aaba-be263e6277ed", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the user does not have access to an item\nmentioned in the request.\n\n* The developer provided a folder ID in `ancestor_folder_ids`\n that either does not exist or the user does not have access to.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b879324a-09fb-4f5e-aba5-89178bff1726", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5af5c713-0a03-4993-9be4-7ea1ba1ee8d3", "documentation": "Find file for shared link", "method": "get", "endpoint": "shared_items", "responses": [ { "uuid": "166f4d5b-709c-4ec2-8787-63f0dec66057", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a full file resource if the shared link is valid and\nthe user has access to it.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "85bc1e1f-e7e0-4170-a444-4f6be94c02cb", "body": "", "latency": 0, "statusCode": 304, "label": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the folder. This indicates that the folder\nhas not changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5f8a249b-afc9-40a3-bf6a-cd0e4a87f706", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "81157e3e-a1d0-4641-95e4-30b0b01327fd", "documentation": "Find folder for shared link", "method": "get", "endpoint": "shared_items#folders", "responses": [ { "uuid": "6d85e653-1c9f-4d92-abdf-9004cdc345ba", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a full folder resource if the shared link is valid and\nthe user has access to it.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a212682d-74b8-4d68-82bc-b00c8139bf38", "body": "", "latency": 0, "statusCode": 304, "label": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the folder. This indicates that the folder\nhas not changed since it was last requested.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "710605c3-bc6d-4657-bf51-3337792b16c0", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fec8a656-fedc-4ae3-9bda-5a415fc2d9e0", "documentation": "List sign requests", "method": "get", "endpoint": "sign_requests", "responses": [ { "uuid": "5f7ff892-c6bf-4093-854a-ddae9de5dc25", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of sign requests", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "725d626a-8d1b-4cce-82b0-6bf6003043a0", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7a8fd5e5-4006-4459-b2fb-61354338345d", "documentation": "Create sign request", "method": "post", "endpoint": "sign_requests", "responses": [ { "uuid": "d52a134e-7f94-4511-930b-86869442b379", "body": "{\n \"are_reminders_enabled\": true,\n \"are_text_signatures_enabled\": true,\n \"days_valid\": 2,\n \"email_message\": \"Hello! Please sign the document below\",\n \"email_subject\": \"Sign Request from Acme\",\n \"external_id\": \"123\",\n \"is_document_preparation_needed\": true,\n \"parent_folder\": {},\n \"prefill_tags\": [\n {\n \"checkbox_value\": true,\n \"date_value\": \"2021-04-26T08:12:13.982Z\",\n \"document_tag_id\": \"1234\",\n \"text_value\": \"text\"\n }\n ],\n \"signers\": [\n {\n \"email\": \"example@gmail.com\",\n \"embed_url_external_user_id\": \"1234\",\n \"is_in_person\": true,\n \"order\": 2,\n \"role\": \"{{oneOf (array 'signer' 'approver' 'final_copy_reader')}}\"\n }\n ],\n \"source_files\": [\n {\n \"etag\": \"1\",\n \"id\": \"12345\",\n \"type\": \"{{oneOf (array 'file')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 201, "label": "Returns a Sign Request object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fbfed762-b066-4aa5-802e-7c098481ed2c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c22930cd-2d15-4a86-881d-c377ab0f5b18", "documentation": "Get sign request by ID", "method": "get", "endpoint": "sign_requests/:sign_request_id", "responses": [ { "uuid": "4155879e-0a60-42cc-97b7-04a18cac2ba1", "body": "{\n \"are_reminders_enabled\": true,\n \"are_text_signatures_enabled\": true,\n \"days_valid\": 2,\n \"email_message\": \"Hello! Please sign the document below\",\n \"email_subject\": \"Sign Request from Acme\",\n \"external_id\": \"123\",\n \"is_document_preparation_needed\": true,\n \"parent_folder\": {},\n \"prefill_tags\": [\n {\n \"checkbox_value\": true,\n \"date_value\": \"2021-04-26T08:12:13.982Z\",\n \"document_tag_id\": \"1234\",\n \"text_value\": \"text\"\n }\n ],\n \"signers\": [\n {\n \"email\": \"example@gmail.com\",\n \"embed_url_external_user_id\": \"1234\",\n \"is_in_person\": true,\n \"order\": 2,\n \"role\": \"{{oneOf (array 'signer' 'approver' 'final_copy_reader')}}\"\n }\n ],\n \"source_files\": [\n {\n \"etag\": \"1\",\n \"id\": \"12345\",\n \"type\": \"{{oneOf (array 'file')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Returns a sign request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a89db718-97e8-421e-afc2-18c50ed7f45c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the sign request cannot be found or the user does\nnot have access to the sign request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "879c53a9-2ad2-46ad-b046-4bb3288b410f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f20ce8d9-5d14-4969-8d8b-914e59448765", "documentation": "Cancel sign request", "method": "post", "endpoint": "sign_requests/:sign_request_id/cancel", "responses": [ { "uuid": "2a36dc75-398c-40a7-9b46-163ced995f7c", "body": "{\n \"are_reminders_enabled\": true,\n \"are_text_signatures_enabled\": true,\n \"days_valid\": 2,\n \"email_message\": \"Hello! Please sign the document below\",\n \"email_subject\": \"Sign Request from Acme\",\n \"external_id\": \"123\",\n \"is_document_preparation_needed\": true,\n \"parent_folder\": {},\n \"prefill_tags\": [\n {\n \"checkbox_value\": true,\n \"date_value\": \"2021-04-26T08:12:13.982Z\",\n \"document_tag_id\": \"1234\",\n \"text_value\": \"text\"\n }\n ],\n \"signers\": [\n {\n \"email\": \"example@gmail.com\",\n \"embed_url_external_user_id\": \"1234\",\n \"is_in_person\": true,\n \"order\": 2,\n \"role\": \"{{oneOf (array 'signer' 'approver' 'final_copy_reader')}}\"\n }\n ],\n \"source_files\": [\n {\n \"etag\": \"1\",\n \"id\": \"12345\",\n \"type\": \"{{oneOf (array 'file')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Returns a Sign Request object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e0f71685-b527-4aa0-b486-6d7a3edcdcfe", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the sign request cannot be found or the user does\nnot have access to the sign request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "466ab8e2-3d6c-433f-b66b-89e35f0174d4", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "530e7263-8a39-4f4f-955b-9f8146dfb09e", "documentation": "Resend sign request", "method": "post", "endpoint": "sign_requests/:sign_request_id/resend", "responses": [ { "uuid": "511b9da0-3acc-488f-95ad-790d1cf586ca", "body": "", "latency": 0, "statusCode": 202, "label": "Returns an empty response when the API call was successful.\nThe email notifications will be sent asynchronously.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1e825065-2f98-4090-80b8-961c54965215", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the sign request cannot be found or the user does\nnot have access to the sign request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4f216c18-44e3-4985-ba39-76c395cf3471", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "023a953a-aee7-449b-a67c-f5bf5305736c", "documentation": "Update all Box Skill cards on file", "method": "put", "endpoint": "skill_invocations/:skill_id", "responses": [ { "uuid": "b60fcfe4-9016-436d-a4c6-38877a4b1bac", "body": "", "latency": 0, "statusCode": 200, "label": "Returns an empty response when the card has been successfully updated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ddf51e61-0a60-4b27-9b4c-a985d776d244", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error when the request body is not valid.\n\n* `schema_validation_failed` - The request body contains a value for a for\na field that either does not exist, or for which the value or type does\nnot match the expected field type. An example might be an unknown option\nfor an `enum` or `multiSelect` field.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "14697b44-40cd-4782-a302-ebe257ff625b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the file could not be found or the user does not\nhave access.\n\n* `not_found` - The file could not be found, or the user does not have\naccess to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e874bf5c-e939-4715-907f-98414781bef4", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6328a046-58da-4a1c-95aa-2d8876949565", "documentation": "List storage policies", "method": "get", "endpoint": "storage_policies", "responses": [ { "uuid": "a1c9980f-6ed4-4dee-a23d-7f2548c61fa4", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of storage policies.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d7984137-51da-4cb2-ae73-6dcf8c58bb38", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f27acaab-66da-4a22-9776-919e0ecde3dc", "documentation": "Get storage policy", "method": "get", "endpoint": "storage_policies/:storage_policy_id", "responses": [ { "uuid": "27198cc0-febc-425e-983d-63783b7816d8", "body": "{\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'storage_policy')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a storage policy object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "52072d31-0ec6-43bd-861b-f973d7dd967b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "19b469ed-bc33-4e0b-9f50-30ab57217e71", "documentation": "List storage policy assignments", "method": "get", "endpoint": "storage_policy_assignments", "responses": [ { "uuid": "4fb05ec9-2b3b-4104-a8b9-40c51b514197", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of storage policies for\nthe enterprise or user.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "65a32cb1-fddc-4d79-8c0d-7ac233d257a5", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "aad65fa8-9f3d-49c0-81aa-291a23a02087", "documentation": "Assign storage policy", "method": "post", "endpoint": "storage_policy_assignments", "responses": [ { "uuid": "784b89a3-96cc-4612-91c4-7fa700560301", "body": "{\n \"assigned_to\": {\n \"id\": \"11446498\",\n \"type\": \"file\"\n },\n \"storage_policy\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'storage_policy')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns the new storage policy assignment created.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0bc78a34-c88e-483b-85dd-2a9564b089fc", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a721b607-12b0-4fe8-b79b-b8721d0facb4", "documentation": "Unassign storage policy", "method": "delete", "endpoint": "storage_policy_assignments/:storage_policy_assignment_id", "responses": [ { "uuid": "3458bf39-4133-4d0c-9b49-775c7e6c0320", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the storage policy\nassignment is successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "62a94eae-0ac6-4372-a34d-544a3c854d45", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b455d755-97a2-4132-90f3-d23026acc092", "documentation": "Get storage policy assignment", "method": "get", "endpoint": "storage_policy_assignments/:storage_policy_assignment_id", "responses": [ { "uuid": "99a944d5-4229-4a07-af8f-df778273eb59", "body": "{\n \"assigned_to\": {\n \"id\": \"11446498\",\n \"type\": \"file\"\n },\n \"storage_policy\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'storage_policy')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns a storage policy assignment object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b9823bef-6bad-474e-a90c-0152f660070b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "87b9675b-65d7-4f11-9376-06436812ce3b", "documentation": "Update storage policy assignment", "method": "put", "endpoint": "storage_policy_assignments/:storage_policy_assignment_id", "responses": [ { "uuid": "27e0cfe6-2e7c-41c4-930e-d0ac105b9796", "body": "{\n \"assigned_to\": {\n \"id\": \"11446498\",\n \"type\": \"file\"\n },\n \"storage_policy\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'storage_policy')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Returns an updated storage policy assignment object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3ed29737-7fcf-4b9a-88da-0e0063d23892", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e74dd0cc-edab-480b-9917-f522e336dea0", "documentation": "Assign task", "method": "post", "endpoint": "task_assignments", "responses": [ { "uuid": "aa585d5c-7152-48b1-961e-b8fd67af9b56", "body": "{\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"assigned_by\": {},\n \"assigned_to\": {},\n \"completed_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"item\": {},\n \"message\": \"Please review\",\n \"reminded_at\": \"2012-12-12T10:53:43-08:00\",\n \"resolution_state\": \"{{oneOf (array 'completed' 'incomplete' 'approved' 'rejected')}}\",\n \"type\": \"{{oneOf (array 'task_assignment')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Returns a new task assignment object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a4f98d64-ff9a-47e3-9d4f-94527f20915a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if a change to a completed task is attempted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a88e69f5-5f4b-46d6-82a7-ea2731c270bd", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the task could not be found or the user does not\nhave access to the file the task is assigned to.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "65006761-807d-4aa0-bad8-a2365ed84907", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 500, "label": "Returns an error if any of the IDs for this request were not valid, or if\nthe targeted user does not have access to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5e701e9c-2ac3-495d-9502-93928f6ed27f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3fbcb518-d73f-45e3-a6b5-c3775eda2fa5", "documentation": "Unassign task", "method": "delete", "endpoint": "task_assignments/:task_assignment_id", "responses": [ { "uuid": "f284a7a9-7142-446c-aa2d-2e04576316af", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the task\nassignment was successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "73de6093-6162-4abc-8efa-cbedaa04cbaa", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the task assignment for the given ID does not exist\nor is inaccessible to your account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b7d68f9e-5a50-404b-82be-c450776b5e31", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c1cf99f3-409e-4999-b1a6-81691fab2a3d", "documentation": "Get task assignment", "method": "get", "endpoint": "task_assignments/:task_assignment_id", "responses": [ { "uuid": "d729272d-67be-489d-9339-09d89ca4b775", "body": "{\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"assigned_by\": {},\n \"assigned_to\": {},\n \"completed_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"item\": {},\n \"message\": \"Please review\",\n \"reminded_at\": \"2012-12-12T10:53:43-08:00\",\n \"resolution_state\": \"{{oneOf (array 'completed' 'incomplete' 'approved' 'rejected')}}\",\n \"type\": \"{{oneOf (array 'task_assignment')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a task assignment, specifying who the task has been assigned to\nand by whom.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5af4e2be-1a1e-44fc-ae4a-6eabc2124a53", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the task assignment could not be found or the user\ndoes not have access to the file the task is assigned to.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "151d9659-f290-4c44-a1ca-f7d8a33053eb", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "923d329f-516b-4c4c-8517-65a81dca9774", "documentation": "Update task assignment", "method": "put", "endpoint": "task_assignments/:task_assignment_id", "responses": [ { "uuid": "735e92c9-f874-450e-a6c6-b6de8461de3a", "body": "{\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"assigned_by\": {},\n \"assigned_to\": {},\n \"completed_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"item\": {},\n \"message\": \"Please review\",\n \"reminded_at\": \"2012-12-12T10:53:43-08:00\",\n \"resolution_state\": \"{{oneOf (array 'completed' 'incomplete' 'approved' 'rejected')}}\",\n \"type\": \"{{oneOf (array 'task_assignment')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated task assignment object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "385e3c46-c097-4433-98f3-6b2ea7d4010b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if a resolution state is incompatible with the action\ntype of the task.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ead4f84a-c16e-4e92-bd80-fd9c14879b54", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the task assignment could not be found or the user\ndoes not have access to the file the task is assigned to.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "89580943-4315-4f80-9582-4fa8f0abe7a1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b4861d0a-7073-48c4-9a45-ec6ca49e70b2", "documentation": "Create task", "method": "post", "endpoint": "tasks", "responses": [ { "uuid": "d8c5e151-8bf5-475d-b7b2-5b0ac909ad86", "body": "{\n \"action\": \"{{oneOf (array 'review' 'complete')}}\",\n \"completion_rule\": \"{{oneOf (array 'all_assignees' 'any_assignee')}}\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {},\n \"due_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"is_completed\": true,\n \"item\": {},\n \"message\": \"Legal review\",\n \"task_assignment_collection\": {\n \"entries\": [\n {\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"assigned_by\": {},\n \"assigned_to\": {},\n \"completed_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"item\": {},\n \"message\": \"Please review\",\n \"reminded_at\": \"2012-12-12T10:53:43-08:00\",\n \"resolution_state\": \"{{oneOf (array 'completed' 'incomplete' 'approved' 'rejected')}}\",\n \"type\": \"{{oneOf (array 'task_assignment')}}\"\n }\n ],\n \"total_count\": 100\n },\n \"type\": \"{{oneOf (array 'task')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Returns the newly created task.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9d6b3770-fbbd-4a54-93d6-a34f2f3a6192", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned if the request parameters or body is not valid.\n\n* `bad_request` when the body does not contain a valid request. This may\nbe because the `action` or `completion_rule` are not one of the allowed\nvalues.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "417b9d37-5a83-4b48-8c1c-598790655c53", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error when the user does not have the permission to create a\ntask on the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7de67239-bde3-42bb-bf81-eca9a1584ee1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the file could not be found or the user does not\nhave access to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "14b010ff-9209-40b8-bcca-e844b032cc57", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3f1309b0-ee8c-4dfa-b6dd-4e2b7497c15b", "documentation": "Remove task", "method": "delete", "endpoint": "tasks/:task_id", "responses": [ { "uuid": "5521b43a-c391-4588-9dd4-d9321e4c714f", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the task was successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3afdbd32-c615-4b9c-8f52-cfd1f3bcbc2c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the task could not be found or the user does not\nhave access to the file the task is assigned to.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "edf0575f-55cb-4575-9cdf-6ee12d033987", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "91af7f62-1d2d-4a73-b43a-254d3bedd4a0", "documentation": "Get task", "method": "get", "endpoint": "tasks/:task_id", "responses": [ { "uuid": "d22cc5e9-7d8e-4fed-9abd-561e2bb341c7", "body": "{\n \"action\": \"{{oneOf (array 'review' 'complete')}}\",\n \"completion_rule\": \"{{oneOf (array 'all_assignees' 'any_assignee')}}\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {},\n \"due_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"is_completed\": true,\n \"item\": {},\n \"message\": \"Legal review\",\n \"task_assignment_collection\": {\n \"entries\": [\n {\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"assigned_by\": {},\n \"assigned_to\": {},\n \"completed_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"item\": {},\n \"message\": \"Please review\",\n \"reminded_at\": \"2012-12-12T10:53:43-08:00\",\n \"resolution_state\": \"{{oneOf (array 'completed' 'incomplete' 'approved' 'rejected')}}\",\n \"type\": \"{{oneOf (array 'task_assignment')}}\"\n }\n ],\n \"total_count\": 100\n },\n \"type\": \"{{oneOf (array 'task')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a task object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4dea0c56-07ad-4fd3-9767-5ea6429de23d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the task could not be found or the user does not\nhave access to the file the task is assigned to.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8f3351ec-807c-4b11-8ae9-9b6d04df057a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ac799040-9e24-44f3-ae31-3ac2e2a70b0f", "documentation": "Update task", "method": "put", "endpoint": "tasks/:task_id", "responses": [ { "uuid": "66394081-8c9e-4e67-bc73-fecb01e5b97a", "body": "{\n \"action\": \"{{oneOf (array 'review' 'complete')}}\",\n \"completion_rule\": \"{{oneOf (array 'all_assignees' 'any_assignee')}}\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {},\n \"due_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"is_completed\": true,\n \"item\": {},\n \"message\": \"Legal review\",\n \"task_assignment_collection\": {\n \"entries\": [\n {\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"assigned_by\": {},\n \"assigned_to\": {},\n \"completed_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"item\": {},\n \"message\": \"Please review\",\n \"reminded_at\": \"2012-12-12T10:53:43-08:00\",\n \"resolution_state\": \"{{oneOf (array 'completed' 'incomplete' 'approved' 'rejected')}}\",\n \"type\": \"{{oneOf (array 'task_assignment')}}\"\n }\n ],\n \"total_count\": 100\n },\n \"type\": \"{{oneOf (array 'task')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated task object", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ba4ff34d-7ba7-4ca2-8a37-590e76014469", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned if the request parameters or body is not valid.\n\n* `bad_request` when the body does not contain a valid request. This may\nbe because the `action` or `completion_rule` are not one of the allowed\nvalues.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7da75ca7-c2cd-4915-9b4b-a4ca0e419ee5", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error when the user does not have the permission to update a\ntask on the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f0f24c2c-f8af-4c79-8551-aeadddae9ccd", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the file could not be found or the user does not\nhave access to the file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ef64e5cc-aa2f-46c7-ac1e-566456cb3c40", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f72755ab-1c5d-4137-bf09-df1d4402493e", "documentation": "List task assignments", "method": "get", "endpoint": "tasks/:task_id/assignments", "responses": [ { "uuid": "eaec9c3a-a762-4464-8b20-4a36c9378bb2", "body": "{\n \"entries\": [\n {\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"assigned_by\": {},\n \"assigned_to\": {},\n \"completed_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"item\": {},\n \"message\": \"Please review\",\n \"reminded_at\": \"2012-12-12T10:53:43-08:00\",\n \"resolution_state\": \"{{oneOf (array 'completed' 'incomplete' 'approved' 'rejected')}}\",\n \"type\": \"{{oneOf (array 'task_assignment')}}\"\n }\n ],\n \"total_count\": 100\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of task assignment defining what task on\na file has been assigned to which users and by who.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8988385d-87c6-44e3-a5f1-da1874736fe6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error when the task could not be found or the user does not\nhave access to the file the task is assigned to.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bb14f46c-8216-487a-8dfd-2cb9e173b76e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 500, "label": "Returns an error if the task assignment ID was omitted in\nthe request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0562ac47-cd2e-489a-8a94-77135f470979", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fa697d40-ad8f-4fe3-812e-5c9ffc6aa527", "documentation": "List terms of service user statuses", "method": "get", "endpoint": "terms_of_service_user_statuses", "responses": [ { "uuid": "a246e455-60ce-4cf4-98a9-b7a35a466844", "body": "{\n \"entries\": [\n {\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"is_accepted\": true,\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"tos\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'terms_of_service')}}\"\n },\n \"type\": \"{{oneOf (array 'terms_of_service_user_status')}}\",\n \"user\": {}\n }\n ],\n \"total_count\": 2\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of terms of service statuses.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d90324ae-9044-428b-b435-6c0e9a4f2451", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3610640b-46bd-42f8-ad42-5ce0a2e6d8b0", "documentation": "Create terms of service status for new user", "method": "post", "endpoint": "terms_of_service_user_statuses", "responses": [ { "uuid": "9f2a3c1d-211f-440e-a2af-893918734429", "body": "{\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"is_accepted\": true,\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"tos\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'terms_of_service')}}\"\n },\n \"type\": \"{{oneOf (array 'terms_of_service_user_status')}}\",\n \"user\": {}\n}", "latency": 0, "statusCode": 200, "label": "Returns a terms of service status object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "082617c7-bd5f-48a1-9598-4ec2c84f33cf", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c8af1b94-84a5-456b-aa54-a82de6e377c1", "documentation": "Update terms of service status for existing user", "method": "put", "endpoint": "terms_of_service_user_statuses/:terms_of_service_user_status_id", "responses": [ { "uuid": "9c5cb8dd-8770-45b9-abd0-831f756eaab5", "body": "{\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"is_accepted\": true,\n \"modified_at\": \"2012-12-12T10:53:43-08:00\",\n \"tos\": {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'terms_of_service')}}\"\n },\n \"type\": \"{{oneOf (array 'terms_of_service_user_status')}}\",\n \"user\": {}\n}", "latency": 0, "statusCode": 200, "label": "Returns the updated terms of service status object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e44c85a2-afd1-4f80-83ed-f272fb544c76", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7535af9a-b77f-4a59-879c-062c3ac1eb8b", "documentation": "List terms of services", "method": "get", "endpoint": "terms_of_services", "responses": [ { "uuid": "e674e4bb-a0ed-4dcb-a583-cdaeb1d9c763", "body": "{\n \"entries\": [\n {\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'terms_of_service')}}\"\n }\n ],\n \"total_count\": 2\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of terms of service text and settings for the\nenterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6d80689e-f92c-41ef-906f-df685ac783a9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fa5e254a-3cd8-482c-9b6b-7d32c5c5f8c0", "documentation": "Create terms of service", "method": "post", "endpoint": "terms_of_services", "responses": [ { "uuid": "a14067b8-695b-4b8a-bde8-65e0745bfaf0", "body": "{\n \"action\": \"{{oneOf (array 'review' 'complete')}}\",\n \"completion_rule\": \"{{oneOf (array 'all_assignees' 'any_assignee')}}\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {},\n \"due_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"is_completed\": true,\n \"item\": {},\n \"message\": \"Legal review\",\n \"task_assignment_collection\": {\n \"entries\": [\n {\n \"assigned_at\": \"2012-12-12T10:53:43-08:00\",\n \"assigned_by\": {},\n \"assigned_to\": {},\n \"completed_at\": \"2012-12-12T10:53:43-08:00\",\n \"id\": \"11446498\",\n \"item\": {},\n \"message\": \"Please review\",\n \"reminded_at\": \"2012-12-12T10:53:43-08:00\",\n \"resolution_state\": \"{{oneOf (array 'completed' 'incomplete' 'approved' 'rejected')}}\",\n \"type\": \"{{oneOf (array 'task_assignment')}}\"\n }\n ],\n \"total_count\": 100\n },\n \"type\": \"{{oneOf (array 'task')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a new task object", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b1c6b393-a331-4b7b-8bed-39247b45158f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "63f6172c-611c-4fb9-b705-2dc5dad64a54", "documentation": "Get terms of service", "method": "get", "endpoint": "terms_of_services/:terms_of_service_id", "responses": [ { "uuid": "a57a58ff-09f6-41be-b6b2-2db3088e0e3f", "body": "{\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'terms_of_service')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a terms of service object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "79690fbd-4c88-4223-b1ab-1a8372dc7c5e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a2262d37-89c3-4ebd-b42d-ab762a28d67f", "documentation": "Update terms of service", "method": "put", "endpoint": "terms_of_services/:terms_of_service_id", "responses": [ { "uuid": "85c3a98d-1daa-4dc3-aaf9-6baf9854186f", "body": "{\n \"id\": \"11446498\",\n \"type\": \"{{oneOf (array 'terms_of_service')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns an updated terms of service object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0dd9e8af-f1a7-47b5-b28c-9349cb90707a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a1a8b2e7-5cd5-422b-b54e-ee8e384a8786", "documentation": "List enterprise users", "method": "get", "endpoint": "users", "responses": [ { "uuid": "6fc35daf-d04e-4bc8-b2e6-4aefa2bb7b9c", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns all of the users in the enterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "505d2e1c-a486-46af-8f51-6d85dd12daeb", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0334f035-6889-43da-900d-60e7335dbcd6", "documentation": "Create user", "method": "post", "endpoint": "users", "responses": [ { "uuid": "987834f0-15f4-4e0d-99c1-bbe44b9a48b6", "body": "{}", "latency": 0, "statusCode": 201, "label": "Returns a user object for the newly created user.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7bfaed24-d436-46df-a174-ad11f65ddd5c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "68281063-b524-4b4a-b4f0-7e07852a8abc", "documentation": "Get current user", "method": "get", "endpoint": "users/me", "responses": [ { "uuid": "20c7b721-a581-453a-aa3d-aa11e2e84760", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a single user object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ae9ef225-1b8b-431c-a174-09dbe1d7eda3", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "45f91b4b-6ec8-4ed6-8ed6-b8a4acb821ee", "documentation": "Delete user", "method": "delete", "endpoint": "users/:user_id", "responses": [ { "uuid": "3ddb8097-b4e6-421a-bd8b-9767e278fc00", "body": "", "latency": 0, "statusCode": 204, "label": "Removes the user and returns an empty response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5c67e9dd-d361-4292-b05a-c8999193962c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "22b0553c-e9a1-4847-a644-8b9ae7c0a27c", "documentation": "Get user", "method": "get", "endpoint": "users/:user_id", "responses": [ { "uuid": "fba1e019-3a71-437c-8c47-1ec49749022f", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns a single user object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields using the [fields](#get-users-id--request--fields)\nparameter.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "900acfb7-f7de-4893-abf2-69a2bab13bdf", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b1405243-36da-432d-ae7f-9f3dbcd9b942", "documentation": "Update user", "method": "put", "endpoint": "users/:user_id", "responses": [ { "uuid": "d2017420-cea8-4442-9050-ac0ab0a5e61c", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the updated user object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b6c742c9-e874-45d7-85b5-69ff0887b420", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `invalid_parameter` when a parameter is formatted incorrectly,\n for example when the `notification_email` has an incorrectly formatted\n email address.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8fb367c3-581f-4828-b492-3504388eb128", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the user is not allowed to make the changes.\n\n* `access_denied_insufficient_permissions` when the user does not have\n the right permissions, for example when updating the notification email\n is turned off for the enterprise.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f6b3c403-eefd-47e8-b5f5-1456eec63479", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6446d42a-a092-47ea-95a1-ab11a9ffcadd", "documentation": "Get user avatar", "method": "get", "endpoint": "users/:user_id/avatar", "responses": [ { "uuid": "4a0eade3-26cd-453c-a393-c2b6d8dfc5e2", "body": "", "latency": 0, "statusCode": 200, "label": "When an avatar can be found for the user the\nimage data will be returned in the body of the\nresponse.", "headers": [{ "key": "Content-Type", "value": "image/jpg" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3ee65279-741c-433a-b14b-3d97b29ce376", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e3c156e8-810f-4c0c-8a9f-c15fa9613db6", "documentation": "List user's email aliases", "method": "get", "endpoint": "users/:user_id/email_aliases", "responses": [ { "uuid": "3c5a7f69-a869-4e58-ad10-20979be94501", "body": "{\n \"entries\": [\n {\n \"email\": \"alias@example.com\",\n \"id\": \"11446498\",\n \"is_confirmed\": true,\n \"type\": \"{{oneOf (array 'email_alias')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of email aliases.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cdbbea18-03f1-460e-b389-6f806ce4826d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "842c513c-f564-4316-b6c5-e95c41353efa", "documentation": "Create email alias", "method": "post", "endpoint": "users/:user_id/email_aliases", "responses": [ { "uuid": "7f40dbc4-1d95-4272-aa0c-9ae8a37886b0", "body": "{\n \"email\": \"alias@example.com\",\n \"id\": \"11446498\",\n \"is_confirmed\": true,\n \"type\": \"{{oneOf (array 'email_alias')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Returns the newly created email alias object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "30b0e3b1-49f7-4780-8e89-60a78a937f61", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d0eb3db1-1a60-4f3b-9695-210a2cec318e", "documentation": "Remove email alias", "method": "delete", "endpoint": "users/:user_id/email_aliases/:email_alias_id", "responses": [ { "uuid": "0f2291f4-e677-4ee1-84ff-55b4cbd65b70", "body": "", "latency": 0, "statusCode": 204, "label": "Removes the alias and returns an empty response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c2089f39-f520-49e0-8994-3e957e482be7", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "282da8b8-d081-434d-ad90-2d4fe70711be", "documentation": "Transfer owned folders", "method": "put", "endpoint": "users/:user_id/folders/0", "responses": [ { "uuid": "2e06a220-7620-426c-908a-12beca7284ca", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the information for the newly created\ndestination folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "25c520c8-e9ad-427c-936a-8c6b322ce728", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f2fbeb78-e99b-4358-aeae-2e045814ff96", "documentation": "List user's groups", "method": "get", "endpoint": "users/:user_id/memberships", "responses": [ { "uuid": "50418f21-85ad-4ae0-8ec8-05221485e03b", "body": "{\n \"limit\": 1000,\n \"offset\": 2000,\n \"order\": [\n {\n \"by\": \"type\",\n \"direction\": \"{{oneOf (array 'ASC' 'DESC')}}\"\n }\n ],\n \"total_count\": 5000\n}", "latency": 0, "statusCode": 200, "label": "Returns a collection of membership objects. If there are no\nmemberships, an empty collection will be returned.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8768c795-4a3f-4449-8e92-ee7ac4163053", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f226a805-8fa0-4925-9eb9-90558e96ef44", "documentation": "Create web link", "method": "post", "endpoint": "web_links", "responses": [ { "uuid": "5ce9e231-8dc3-4d98-ae9d-91b52c8378fd", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the newly created web link object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "619f429b-a02c-46a9-983c-876c532a1f88", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b3cc284f-a12d-4e9b-87c6-8cbc91330d90", "documentation": "Remove web link", "method": "delete", "endpoint": "web_links/:web_link_id", "responses": [ { "uuid": "0c9bd269-f9c3-4005-8aa1-80a8082bd90b", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response will be returned when the web link\nwas successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b827a31d-4a63-44df-bdbc-162eac3d47ee", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a9d6b5d2-9ff3-4f35-a7a6-fa80dd3d83eb", "documentation": "Get web link", "method": "get", "endpoint": "web_links/:web_link_id", "responses": [ { "uuid": "c1e9731f-5e0c-43c2-bdb7-6e8fd0d70686", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the web link object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "df4ccaa1-8ac9-4609-8cd8-31af55cde6e1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7a6e5119-da88-4b9a-8667-4f0325bbcde8", "documentation": "Restore web link", "method": "post", "endpoint": "web_links/:web_link_id", "responses": [ { "uuid": "a4608dd1-0457-4f1a-aa54-1685a1b49aad", "body": "{}", "latency": 0, "statusCode": 201, "label": "Returns a web link object when it has been restored.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bd8c0884-6059-49c9-b58e-a91437421671", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the user does not have access to the folder\nthe web link is being restored to, or the user does not have permission\nto restore web link from the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "59f5eb31-93ef-46cf-92ba-6c9e8f769eb1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the web link is not in the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c69fca3a-5ac6-4997-810b-1bc7caaaebd5", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if there is an web link with the same name\nin the folder the web link is being restored to.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "20ab233e-e7eb-4d3f-a1a0-cf266dcc6d08", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a7bcb4b1-8613-4a5e-835b-b35a314b6b95", "documentation": "Update web link", "method": "put", "endpoint": "web_links/:web_link_id", "responses": [ { "uuid": "dc82c7fa-62c9-4f19-9cf9-6374ff2bfb02", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the updated web link object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9ee591c7-09d6-44bc-b5f0-ac623075b65d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7ce4ea48-d81e-454c-9697-5fd3c9686af7", "documentation": "Permanently remove web link", "method": "delete", "endpoint": "web_links/:web_link_id/trash", "responses": [ { "uuid": "05dee914-0b97-4c1c-bedd-4dc598f3c1ed", "body": "", "latency": 0, "statusCode": 204, "label": "Returns an empty response when the web link was\npermanently deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0146636d-f314-40f6-b7f0-77a9dabba0a9", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the web link is not in the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "aa32c278-f9be-430f-82f1-a6bed2a3a886", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f36e0a84-1dd4-4adb-ba37-d2541aff105f", "documentation": "Get trashed web link", "method": "get", "endpoint": "web_links/:web_link_id/trash", "responses": [ { "uuid": "4a1404f1-6dd9-4bc4-bee8-dbe8de170522", "body": "{}", "latency": 0, "statusCode": 200, "label": "Returns the web link that was trashed,\nincluding information about when the it\nwas moved to the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1bf9d2e6-b073-42b5-9fd5-1d20935f894d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the web link is not in the trash.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ebfcabfc-e79e-4098-bc9e-c47f18fce991", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e9db5410-97a5-4172-9d79-11e0b99bd401", "documentation": "List all webhooks", "method": "get", "endpoint": "webhooks", "responses": [ { "uuid": "1908c8fb-6d15-4e08-8ac4-86cdd34e64ae", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns a list of webhooks.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c75e4b29-68d4-4e46-ab5c-909db907e9e3", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the application does not\nhave the permission to manage webhooks.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5006c7d2-a56e-46e4-9ba8-178fb525db2b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "68f24243-6596-4d02-bad9-0c21820f90ab", "documentation": "Create webhook", "method": "post", "endpoint": "webhooks", "responses": [ { "uuid": "7a63f823-8760-4e6c-8202-62fdb9e453e6", "body": "{\n \"address\": \"https://example.com/webhooks\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {},\n \"id\": \"11446498\",\n \"target\": {\n \"id\": \"1231232\",\n \"type\": \"{{oneOf (array 'file' 'folder')}}\"\n },\n \"triggers\": [\n \"FILE.UPLOADED\"\n ],\n \"type\": \"{{oneOf (array 'webhook')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Returns the new webhook object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "853a86bc-85a7-4383-ba6a-43f25768908c", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if the parameters were\nincorrect.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "26c592c3-9f8d-47c0-ad46-8dce0b3d36ba", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the application does not\nhave the permission to manage webhooks.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "86c9ba86-fe55-43f1-9ab4-4d933861ae2e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the target item could\nnot be found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6b18156d-50a1-40f6-aa1a-ad662d2c3b54", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if the a webhook for this\ncombination of target, application, and user\nalready exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "80155a77-5c40-46ba-afed-a3d501034ee3", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5d6ea567-3a23-43aa-b98b-0d46b38bd1b8", "documentation": "Remove webhook", "method": "delete", "endpoint": "webhooks/:webhook_id", "responses": [ { "uuid": "4b00d050-398a-45f1-8c31-d9ed9f77828d", "body": "", "latency": 0, "statusCode": 204, "label": "An empty response will be returned when the webhook\nwas successfully deleted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5cdac39b-f766-4b90-9434-7f4ae0f66a1f", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the application does not\nhave the permission to manage webhooks.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "48408a8f-525e-4579-a05b-701815ad9ba7", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the webhook could not be found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b3c9ab92-e556-46d4-9167-97af35f3f261", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4c6c1cd8-ec89-4d40-8842-5d33bba69de9", "documentation": "Get webhook", "method": "get", "endpoint": "webhooks/:webhook_id", "responses": [ { "uuid": "9fff5932-158c-4519-88ab-3936193b7375", "body": "{\n \"address\": \"https://example.com/webhooks\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {},\n \"id\": \"11446498\",\n \"target\": {\n \"id\": \"1231232\",\n \"type\": \"{{oneOf (array 'file' 'folder')}}\"\n },\n \"triggers\": [\n \"FILE.UPLOADED\"\n ],\n \"type\": \"{{oneOf (array 'webhook')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns a webhook object", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5a6bf884-9035-4fec-a8c2-9abd65c0cd68", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the application does not\nhave the permission to manage webhooks.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bc133678-8c5c-4ab6-980f-6d94ff69f446", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the webhook could not be found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a5f9a241-431c-49c9-8cfb-97795592909d", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1f3bb38e-c475-4767-91f2-7d5a27f2f10f", "documentation": "Update webhook", "method": "put", "endpoint": "webhooks/:webhook_id", "responses": [ { "uuid": "71c4fc5e-c54e-4372-9dc0-cec2d4ce2792", "body": "{\n \"address\": \"https://example.com/webhooks\",\n \"created_at\": \"2012-12-12T10:53:43-08:00\",\n \"created_by\": {},\n \"id\": \"11446498\",\n \"target\": {\n \"id\": \"1231232\",\n \"type\": \"{{oneOf (array 'file' 'folder')}}\"\n },\n \"triggers\": [\n \"FILE.UPLOADED\"\n ],\n \"type\": \"{{oneOf (array 'webhook')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the new webhook object.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2d0175ee-6136-414a-9883-ddac22a6543e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if the parameters were\nincorrect.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "643a615c-aeeb-4238-8919-8a170a40eff3", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if the application does not\nhave the permission to manage webhooks.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "12f14b2c-d866-48d1-ba3f-192158ef5012", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the target item or webhook\ncould not be found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "293d1096-d0f0-4cd6-bfcd-92d14e74e8cd", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 409, "label": "Returns an error if the a webhook for this\ncombination of target, application, and user\nalready exists.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b152056d-8952-4f3d-b6e6-ba1768973d34", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c7100a2f-803c-4d27-8c8f-9be69031cb14", "documentation": "List workflows", "method": "get", "endpoint": "workflows", "responses": [ { "uuid": "668bb6f3-0cfe-4f30-b300-0cd8993574ac", "body": "{\n \"limit\": 1000,\n \"next_marker\": 3000,\n \"prev_marker\": 1000\n}", "latency": 0, "statusCode": 200, "label": "Returns the workflow.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "94232384-3576-4b03-8ed1-6a80dfe7c284", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returned if the trigger type is not `WORKFLOW_MANUAL_START`.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d9d31992-0b1c-48da-a1fa-8c2febe4211e", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3902736f-e5cc-4878-9592-4bfbfcfe8aa2", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ff415e68-450a-4ba4-915a-79d56e06985b", "documentation": "Starts workflow based on request body", "method": "post", "endpoint": "workflows/:workflow_id/start", "responses": [ { "uuid": "92013feb-ddf8-404c-8998-0470e31b437e", "body": "", "latency": 0, "statusCode": 204, "label": "Starts the workflow.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1c4d7ebf-2d09-4bd1-ae05-925eb1ae3eb7", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `workflow_is_not_enabled` when the workflow is not enabled\n* `workflow_not_active_on_provided_folder` when the workflow is not\n enabled for the specified folder id\n* `parameters_provided_do_not_match_target_outcome` when the provided\n parameters do not match the expected parameters", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b7d02c30-5a36-4bf2-a593-c0c4b7a2a391", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returns an error if there are insufficient permissions.\n\n* `insufficient_access` when the user does not have access rights to file\n or folder\n* `missing_relay_full_access` when the user does not have access to Relay\n Full", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "55c5e649-5476-4d3c-83c0-1f8e30fa84ad", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the workflow could not be found,\nor the authenticated user does not have access to the workflow.\n\n* `workflow_not_found` when the workflow is not found\n* `flow_missing_or_inaccessible` when the flow is not a manual start flow", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3464a0cd-3352-4a92-a1c8-656b89c0dccb", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "65c3680a-bb25-426e-b78c-a3fdd0184e16", "documentation": "Create zip download", "method": "post", "endpoint": "zip_downloads", "responses": [ { "uuid": "60c072e8-9469-43d9-a813-a744b6a93d33", "body": "{\n \"download_url\": \"https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content\",\n \"expires_at\": \"2020-07-22T11:26:08Z\",\n \"name_conflicts\": [\n [\n {\n \"download_name\": \"3aa6a7.pdf\",\n \"id\": \"12345\",\n \"original_name\": \"Report.pdf\",\n \"type\": \"file\"\n },\n {\n \"download_name\": \"5d53f2.pdf\",\n \"id\": \"34325\",\n \"original_name\": \"Report.pdf\",\n \"type\": \"file\"\n }\n ]\n ],\n \"status_url\": \"https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status\"\n}", "latency": 0, "statusCode": 202, "label": "If the `zip` archive is ready to be downloaded, the API will return a\nresponse that will include a `download_url`, a `status_url`, as well as\nany conflicts that might have occurred when creating the request.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "de02295c-93eb-457e-bd9e-5c510fd0e91b", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "Returns an error if some of the parameters are missing or\nnot valid.\n\nIn most cases, this error might happen because the JSON request body is\nnot valid JSON, any of the items has an incorrect or missing ID, any of\nthe items is not a file or folder, or the root folder with ID `0` has been\nadded to the list of folders to add to the archive.\n\nThe following is a list of common error codes for this response.\n\n* `bad_request` - the request body is missing, invalid, or both the list\nof files and folders are empty. Additionally, it this error might be\nreturned when attempting to add the root folder with ID `0` to an archive.\n* `zip_download_file_count_exceeded_limit` - the requested files and\nfolders would result in an archive with more than 10,000 files. The\nrequest will have to be split into multiple requests to reduce the number\nof files per archive.\n* `zip_download_pre_compressed_bytes_exceeded_limit` - the requested files\nand folders would result in an archive with more than the allowed download\nlimit. The request will have to be split into multiple requests to reduce\nthe size of the archive.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "95c4d7c2-7acc-4a71-ba5c-85c6515ee662", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "07f222d3-3675-49a2-bf9e-9dc97f12bbd1", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned when an authorization header is provided but the user does not\nhave access to the items.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "74fcb89b-9a95-4d96-8254-b86b56667204", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a3005fc4-d6f4-4b46-8872-759e14e89a4d", "documentation": "Download zip archive", "method": "get", "endpoint": "zip_downloads/:zip_download_id/content", "responses": [ { "uuid": "43341ab2-164f-486d-bc54-5205a0274f29", "body": "", "latency": 0, "statusCode": 200, "label": "Returns the content of the items requested for this download, formatted as\na stream of files and folders in a `zip` archive.", "headers": [ { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Content-Disposition", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1e121ab4-ccb5-44a2-862d-29f0595767f6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the ID of this download request is not valid. This\nerror can also be returned if this URL has been called before. To\nre-download this archive, please create a new request for a zip download.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4c7d5813-bc87-4e73-ba20-c25147a93a28", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 429, "label": "Returns an error if the number of concurrent zip downloads has been\nreached for either the user or the enterprise.\n\n* `user_too_many_concurrent_downloads` - the maximum of 5 parallel\ndownloads of zip archives per user has been met.\n* `enterprise_too_many_concurrent_downloads` - the maximum of 10 parallel\ndownloads of zip archives per enterprise has been met.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bbae1381-d441-4fbd-8f07-549e52cb77ca", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7f020dbe-2a23-4185-8737-529db2e2ec3f", "documentation": "Get zip download status", "method": "get", "endpoint": "zip_downloads/:zip_download_id/status", "responses": [ { "uuid": "88431e29-d881-4911-b59f-7ed13a35a3e8", "body": "{\n \"downloaded_file_count\": 10,\n \"skipped_file_count\": 5,\n \"skipped_folder_count\": 5,\n \"state\": \"{{oneOf (array 'in_progress' 'failed' 'success')}}\",\n \"total_file_count\": 20\n}", "latency": 0, "statusCode": 200, "label": "Returns the status of the `zip` archive that is being downloaded.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "40bd3775-be05-4552-8dcc-b4901502072a", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "88e91d89-bc29-41bc-a240-de1878270818", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "Returned when an authorization header is provided but the user does not\nhave access to the items.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "93066c0e-6a8f-4be1-9ed8-4ebf0776dcf6", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "Returns an error if the ID of this download request is not valid, or if\nthe status of a download is requested before the download has been\nstarted.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "690b2e87-e7b1-466a-b750-1de997fd8c13", "body": "{\n \"code\": \"{{oneOf (array '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')}}\",\n \"context_info\": {},\n \"help_url\": \"http://developers.box.com/docs/#errors\",\n \"message\": \"Method Not Allowed\",\n \"request_id\": \"abcdef123456\",\n \"status\": 400,\n \"type\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "An unexpected client error.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "8292e7d3-3298-4106-8268-732b07a12cfe" }, { "type": "route", "uuid": "9d6590fc-9f4d-4f49-aa32-36a0038e47f7" }, { "type": "route", "uuid": "553e10a9-6af0-4fbb-a5f5-cfa1f85f3d6f" }, { "type": "route", "uuid": "d9b516c3-651a-4d1e-9de0-eb2866079204" }, { "type": "route", "uuid": "ee222940-c762-44ee-81f2-6e043333063d" }, { "type": "route", "uuid": "74ad4be5-3c0a-4142-8229-43e48441487c" }, { "type": "route", "uuid": "82d7f33c-3adf-46e8-985f-4abdd460f2b7" }, { "type": "route", "uuid": "6126bd03-1f67-4177-a8e0-9f1d861f67fd" }, { "type": "route", "uuid": "02fcc573-ef4a-49f5-bcfe-ccc6209558db" }, { "type": "route", "uuid": "985f7e91-f863-489a-9654-db7cf34398a2" }, { "type": "route", "uuid": "aabdba92-7a06-4be6-ac3b-6b70b3441858" }, { "type": "route", "uuid": "762638dd-e65e-47e0-bac4-ca71d100c958" }, { "type": "route", "uuid": "79805bcc-09c6-4cae-b82c-eb5aa6655bef" }, { "type": "route", "uuid": "d9f498f2-a388-497b-8e7c-97c969a3ed28" }, { "type": "route", "uuid": "b556eda9-7e76-49a4-abf9-cf7470d00b2f" }, { "type": "route", "uuid": "519723bf-b80c-4944-92a2-03625f1de7d1" }, { "type": "route", "uuid": "4fd2fe91-5137-4bed-8a86-6891ad1821c3" }, { "type": "route", "uuid": "5dfbb9d8-859b-416c-98f4-a2609267ca43" }, { "type": "route", "uuid": "7f89a8aa-6467-4cfd-978f-9797968da414" }, { "type": "route", "uuid": "7e2ad9f8-8ef4-4a64-8e34-11e262159f9a" }, { "type": "route", "uuid": "aa78fca9-0076-4f47-b972-9afdc50262cb" }, { "type": "route", "uuid": "bf702c1c-e7a8-41ee-b885-f1a5c47e8e95" }, { "type": "route", "uuid": "3c4ff192-14eb-4520-beba-7f1d6a136476" }, { "type": "route", "uuid": "6a6635ff-a33b-46fd-b9c0-2a98945a4827" }, { "type": "route", "uuid": "f342a493-8246-49df-b059-667237b02f02" }, { "type": "route", "uuid": "2034aa31-23a9-414e-b01d-43f6b0b621fc" }, { "type": "route", "uuid": "03ff2205-9c27-44ea-8042-9d031334b29c" }, { "type": "route", "uuid": "b4d76627-6f98-4401-84ea-7c965f81218a" }, { "type": "route", "uuid": "6a0aa962-01f4-49c3-b10c-d51a52544384" }, { "type": "route", "uuid": "61425222-9413-4991-b2e5-48e2ab6b4aba" }, { "type": "route", "uuid": "32d85d3a-9ed0-4aec-968d-208006b54ab9" }, { "type": "route", "uuid": "db8e2f09-54c5-47a7-a769-fdf278916082" }, { "type": "route", "uuid": "2aa83d70-69a1-40ae-86cd-61bde6843a70" }, { "type": "route", "uuid": "bfadd46b-c52b-42ec-a9c0-209105ecea65" }, { "type": "route", "uuid": "821ac293-1ed0-49b1-b08a-af483926830f" }, { "type": "route", "uuid": "5f1cb5ec-d155-4769-841e-ac12c0fb20f7" }, { "type": "route", "uuid": "707f5032-7690-4966-89d6-0f2543abb573" }, { "type": "route", "uuid": "6d8cf4e9-73e7-4ee6-bb99-13e328de1818" }, { "type": "route", "uuid": "1adc158e-8416-473d-9bf0-be9c4ac9846a" }, { "type": "route", "uuid": "2aa30612-8e02-4c9c-9ed8-8e8624f31249" }, { "type": "route", "uuid": "ec6c7e3a-bd71-4fbe-8293-f6f696d2825e" }, { "type": "route", "uuid": "55d7408c-5a19-47ee-9302-5c6ab87214f8" }, { "type": "route", "uuid": "255a3917-e6fe-4a5a-8077-0506c698355d" }, { "type": "route", "uuid": "13c19d48-c048-4984-bdd1-32801127cd33" }, { "type": "route", "uuid": "ad42f0c2-4610-49a9-833f-c44b217899ad" }, { "type": "route", "uuid": "ac4943f1-cf5f-4b28-9cd2-5340bba8891f" }, { "type": "route", "uuid": "84d82934-b680-48af-8fb0-e3ac7cde1408" }, { "type": "route", "uuid": "12134aec-9bac-482a-8472-e28bd6d934a7" }, { "type": "route", "uuid": "5997b0a1-fc87-4367-ba2d-74a264134b7e" }, { "type": "route", "uuid": "d3ea8d55-bf90-4198-b847-a1cd7924887f" }, { "type": "route", "uuid": "73c35c90-928d-4b74-9c95-04aae55f737a" }, { "type": "route", "uuid": "cafa0060-e86e-4f43-90d7-13c191b2bb4d" }, { "type": "route", "uuid": "e1c6217d-f7dc-41da-981c-5a3191148d25" }, { "type": "route", "uuid": "c943d3c6-fccb-437d-8bfc-33ea778c532f" }, { "type": "route", "uuid": "2baa0868-3ba6-473c-8f81-a952a9de6a42" }, { "type": "route", "uuid": "4c74f171-f089-49f2-ac13-88c423b766b9" }, { "type": "route", "uuid": "48d8c130-9813-47d2-80e7-06d137bb49fa" }, { "type": "route", "uuid": "14e5aebc-7b10-4539-a4bc-0461536ff25c" }, { "type": "route", "uuid": "44de3a0b-33c7-4b65-accf-82e21e7bcb42" }, { "type": "route", "uuid": "e1a8d317-0772-4cad-8351-2ab7a8c3fcaf" }, { "type": "route", "uuid": "8a114235-7383-4cbb-85df-9a6ef0e927f0" }, { "type": "route", "uuid": "4a15b295-6d29-4bd1-8766-2d7f7ce9ca31" }, { "type": "route", "uuid": "8e454ccf-4797-4e21-9401-4414a83903aa" }, { "type": "route", "uuid": "023920b8-8b2e-40f3-963c-e46ed33c490d" }, { "type": "route", "uuid": "48b8ab75-bff0-438e-89f5-7093911d5fb2" }, { "type": "route", "uuid": "4949479a-b844-477b-9696-40eb4681dfc4" }, { "type": "route", "uuid": "a1319b9e-2f7e-48ab-aac3-3de408665a91" }, { "type": "route", "uuid": "1a64ff85-91d4-45c5-8e11-2fd2604ea718" }, { "type": "route", "uuid": "3c0429dd-89f6-4fd6-8973-7446e96acc07" }, { "type": "route", "uuid": "fd1aeb40-c803-4563-bcfc-2367c85b28b1" }, { "type": "route", "uuid": "1cfc1925-a081-4070-8844-084abe7a7f07" }, { "type": "route", "uuid": "13ea230b-2509-4073-988c-abe009382b43" }, { "type": "route", "uuid": "fc414afc-1f1f-4ff3-8d64-a3a99fbe3a9c" }, { "type": "route", "uuid": "bedf14d5-f14e-4a1b-9af7-1e3caea3412a" }, { "type": "route", "uuid": "8ba84f55-d5f1-4842-bb48-2d630ec3bb4c" }, { "type": "route", "uuid": "b2fa4f3f-1223-4480-9228-85d40ccccf31" }, { "type": "route", "uuid": "d376727d-bf5d-49f9-b7d1-4080906a0e1b" }, { "type": "route", "uuid": "3732cbaa-899f-4838-88f0-57d0083800bc" }, { "type": "route", "uuid": "5e8fdc56-cef6-48da-8556-c414c970e66e" }, { "type": "route", "uuid": "1042efb8-7b3b-4b12-a843-7b0e605faaa3" }, { "type": "route", "uuid": "b3758c64-bb2d-4f60-ae8c-5f2f023c018b" }, { "type": "route", "uuid": "153fffb1-c1a1-4c07-843f-ef66a49f439e" }, { "type": "route", "uuid": "34934169-0104-4499-832b-28a1cda603a6" }, { "type": "route", "uuid": "f7752010-c68e-4a51-970f-e77186f819bc" }, { "type": "route", "uuid": "b3d28130-46c4-4f12-8995-a88db6cd820c" }, { "type": "route", "uuid": "be620589-1f81-47ac-aff7-671ff861e2c0" }, { "type": "route", "uuid": "76b300a6-c0cf-471d-b09d-40e203307941" }, { "type": "route", "uuid": "606aa19f-f0e5-4576-9b46-5cd6616cc66d" }, { "type": "route", "uuid": "9196d6e5-74df-488a-8fe7-83f9b759e3d9" }, { "type": "route", "uuid": "18c12249-91a7-41ed-a4dc-870894b98433" }, { "type": "route", "uuid": "6ceb2818-ecc1-4d0e-b222-0db8a57d11e5" }, { "type": "route", "uuid": "d515bb3b-80a3-434e-b204-b340633c7934" }, { "type": "route", "uuid": "d3fda18f-a78c-4c53-ae45-188eb93a852c" }, { "type": "route", "uuid": "42147a95-a4e1-4ad9-b3a6-bcc4e32fdfa8" }, { "type": "route", "uuid": "77425774-2af7-41dd-8c8e-75ddd50d721e" }, { "type": "route", "uuid": "f002bf52-f9a8-486b-9f07-a928aaf28322" }, { "type": "route", "uuid": "2b8dfc4a-b88f-4e7b-a165-dbafe3c5cead" }, { "type": "route", "uuid": "1909bedc-b3a7-4c6a-ae1c-36e5f765278f" }, { "type": "route", "uuid": "f14f378f-96af-4c5f-89b4-392b8dce326d" }, { "type": "route", "uuid": "6c7f8925-e333-4e7f-b398-f1b7ffc83451" }, { "type": "route", "uuid": "c3037448-8808-4149-a6b0-3f4183fc2bc3" }, { "type": "route", "uuid": "81f6cbd7-96d3-4893-8df4-34543b807345" }, { "type": "route", "uuid": "4e62079a-9b3c-4aca-85b5-0638898061a7" }, { "type": "route", "uuid": "de1db3c8-8c73-4729-9bdd-4df2d02f7c45" }, { "type": "route", "uuid": "9692dc22-4feb-473c-b365-25bf252ce21c" }, { "type": "route", "uuid": "8aad19c4-292d-4a3c-aba0-cd3e6f07074c" }, { "type": "route", "uuid": "f31e4bf3-a72e-4d05-9b9a-f18de701fa1d" }, { "type": "route", "uuid": "618dd3d6-337f-4085-913c-0e3b30164f6c" }, { "type": "route", "uuid": "85423d93-29c9-4646-845f-64ccc086b207" }, { "type": "route", "uuid": "2288755e-e1d1-41d4-b9c4-0517e05596d8" }, { "type": "route", "uuid": "13c46004-b6ad-4c28-a8b3-1e45b7cc5f45" }, { "type": "route", "uuid": "b29e32b0-eda2-4eb3-8a6c-e47aa1c81ed3" }, { "type": "route", "uuid": "3a2452d5-7fa9-4061-9d5e-9f1d6add426b" }, { "type": "route", "uuid": "b7d27dfc-8b38-4f16-a8d2-7aea2df4519f" }, { "type": "route", "uuid": "6244326c-c492-4c80-8c3b-2b1f322b8ed8" }, { "type": "route", "uuid": "342019a4-eb3a-4cad-972a-d086e1a55ee7" }, { "type": "route", "uuid": "5e05a382-8ec0-403d-a57c-a7b68d60206b" }, { "type": "route", "uuid": "efb8aa7f-223c-4448-85a6-396772a1e9c7" }, { "type": "route", "uuid": "921bb861-de65-4405-bbb2-d6362feb888d" }, { "type": "route", "uuid": "57fdff08-5b9e-45ba-93b1-bf63ec97c352" }, { "type": "route", "uuid": "c5b3bb29-cdae-4592-a460-0288f47340b7" }, { "type": "route", "uuid": "b5660e98-be01-4ab2-80ed-40dc0c582f39" }, { "type": "route", "uuid": "3c33f7af-876a-44e0-9ce8-ebd464aa538a" }, { "type": "route", "uuid": "24d41d45-55cb-402d-b899-f549aa17196c" }, { "type": "route", "uuid": "dd734ec1-9d50-40be-a303-1511b21aedf8" }, { "type": "route", "uuid": "3123919b-3b75-40e9-9219-21f511e5259f" }, { "type": "route", "uuid": "82f99f6b-cf48-4daa-9324-f4d10c11c8d9" }, { "type": "route", "uuid": "9475184c-52b0-43d1-b7cc-91a5edffa3a9" }, { "type": "route", "uuid": "982ea627-ad2e-4b47-838b-07b2d303bb9c" }, { "type": "route", "uuid": "6c427457-543f-499b-8aca-18bd47fe78ee" }, { "type": "route", "uuid": "6a31c5e2-280f-4f65-be05-71f270759667" }, { "type": "route", "uuid": "9edd9976-677a-4a46-a666-1d36e146c51c" }, { "type": "route", "uuid": "6604db7d-86a7-4ca7-b5b3-5159a761015e" }, { "type": "route", "uuid": "d1612214-ee54-42f0-aa70-d95d662b2773" }, { "type": "route", "uuid": "a43bda6a-c881-4595-be8e-bb3e6fa26cbe" }, { "type": "route", "uuid": "8955d059-2315-43f3-880a-8eb2c1fb4332" }, { "type": "route", "uuid": "c4e512a2-997d-48ce-87c6-7bd70d3754ce" }, { "type": "route", "uuid": "cb2dca20-cbc2-4492-b9cd-880458e736ae" }, { "type": "route", "uuid": "fc6b828c-c644-403b-ad01-2fe7ac859b7a" }, { "type": "route", "uuid": "0a6c45bf-ad82-43f8-8f2d-55066dd4d9ec" }, { "type": "route", "uuid": "e3f439cf-1885-45f1-84db-190f0ac6df73" }, { "type": "route", "uuid": "9927982e-7950-4993-8bf0-cab49de1a4b6" }, { "type": "route", "uuid": "82798aea-2f2a-41ab-a710-2a16fa13b0db" }, { "type": "route", "uuid": "2a904f1b-de46-4bf7-8150-d82bae7ef036" }, { "type": "route", "uuid": "0acb9110-e851-481c-8170-c493a04550fb" }, { "type": "route", "uuid": "2401fb90-84d9-4914-a2f6-07660d696d96" }, { "type": "route", "uuid": "3d99cf92-30bf-4459-b1f6-fcf3befceb0e" }, { "type": "route", "uuid": "ef99830f-f52f-48c0-89c0-7751e27fe838" }, { "type": "route", "uuid": "32d802ce-a165-4bb5-8c98-a45c03aa5708" }, { "type": "route", "uuid": "9cfd147b-1183-457d-8419-78f8022177b8" }, { "type": "route", "uuid": "63b5d265-a873-4287-bed1-d88c413e51ed" }, { "type": "route", "uuid": "b1545e31-3239-4ad6-aef5-61c207a5a7c0" }, { "type": "route", "uuid": "cb6427b0-4fa2-4599-88cc-233c157d3db6" }, { "type": "route", "uuid": "5a838b14-6010-485e-a127-5ebc4447cd69" }, { "type": "route", "uuid": "6bfda2b5-4f45-4a18-9eb1-ce2782c126b7" }, { "type": "route", "uuid": "62b26b0c-364f-424f-a418-93a02fb80136" }, { "type": "route", "uuid": "5e334238-f1b1-468c-a9e8-5cf819fec931" }, { "type": "route", "uuid": "a3ef50a1-9057-4907-a672-85bf66d1848c" }, { "type": "route", "uuid": "c962b643-f4b3-4206-9009-636b0bcb19a6" }, { "type": "route", "uuid": "ab997488-91b1-45db-8b40-92b5b60974d2" }, { "type": "route", "uuid": "b04cd47c-f6d2-4f3c-8b0a-ced90974ff24" }, { "type": "route", "uuid": "8552fcd5-40cd-4b9f-b9e4-d200b6e48512" }, { "type": "route", "uuid": "d1b1babe-5fae-426e-a0cf-4c1665b26cd4" }, { "type": "route", "uuid": "44476395-405d-4afd-aec7-3bd167ff1d43" }, { "type": "route", "uuid": "fe2b95a5-3905-480e-94ed-3bacf3d35079" }, { "type": "route", "uuid": "8d575bb9-8a14-4a64-bf3e-eb4fa8c04bf4" }, { "type": "route", "uuid": "9836aa10-57ee-476a-950d-bbfecbc085ec" }, { "type": "route", "uuid": "5af5c713-0a03-4993-9be4-7ea1ba1ee8d3" }, { "type": "route", "uuid": "81157e3e-a1d0-4641-95e4-30b0b01327fd" }, { "type": "route", "uuid": "fec8a656-fedc-4ae3-9bda-5a415fc2d9e0" }, { "type": "route", "uuid": "7a8fd5e5-4006-4459-b2fb-61354338345d" }, { "type": "route", "uuid": "c22930cd-2d15-4a86-881d-c377ab0f5b18" }, { "type": "route", "uuid": "f20ce8d9-5d14-4969-8d8b-914e59448765" }, { "type": "route", "uuid": "530e7263-8a39-4f4f-955b-9f8146dfb09e" }, { "type": "route", "uuid": "023a953a-aee7-449b-a67c-f5bf5305736c" }, { "type": "route", "uuid": "6328a046-58da-4a1c-95aa-2d8876949565" }, { "type": "route", "uuid": "f27acaab-66da-4a22-9776-919e0ecde3dc" }, { "type": "route", "uuid": "19b469ed-bc33-4e0b-9f50-30ab57217e71" }, { "type": "route", "uuid": "aad65fa8-9f3d-49c0-81aa-291a23a02087" }, { "type": "route", "uuid": "a721b607-12b0-4fe8-b79b-b8721d0facb4" }, { "type": "route", "uuid": "b455d755-97a2-4132-90f3-d23026acc092" }, { "type": "route", "uuid": "87b9675b-65d7-4f11-9376-06436812ce3b" }, { "type": "route", "uuid": "e74dd0cc-edab-480b-9917-f522e336dea0" }, { "type": "route", "uuid": "3fbcb518-d73f-45e3-a6b5-c3775eda2fa5" }, { "type": "route", "uuid": "c1cf99f3-409e-4999-b1a6-81691fab2a3d" }, { "type": "route", "uuid": "923d329f-516b-4c4c-8517-65a81dca9774" }, { "type": "route", "uuid": "b4861d0a-7073-48c4-9a45-ec6ca49e70b2" }, { "type": "route", "uuid": "3f1309b0-ee8c-4dfa-b6dd-4e2b7497c15b" }, { "type": "route", "uuid": "91af7f62-1d2d-4a73-b43a-254d3bedd4a0" }, { "type": "route", "uuid": "ac799040-9e24-44f3-ae31-3ac2e2a70b0f" }, { "type": "route", "uuid": "f72755ab-1c5d-4137-bf09-df1d4402493e" }, { "type": "route", "uuid": "fa697d40-ad8f-4fe3-812e-5c9ffc6aa527" }, { "type": "route", "uuid": "3610640b-46bd-42f8-ad42-5ce0a2e6d8b0" }, { "type": "route", "uuid": "c8af1b94-84a5-456b-aa54-a82de6e377c1" }, { "type": "route", "uuid": "7535af9a-b77f-4a59-879c-062c3ac1eb8b" }, { "type": "route", "uuid": "fa5e254a-3cd8-482c-9b6b-7d32c5c5f8c0" }, { "type": "route", "uuid": "63f6172c-611c-4fb9-b705-2dc5dad64a54" }, { "type": "route", "uuid": "a2262d37-89c3-4ebd-b42d-ab762a28d67f" }, { "type": "route", "uuid": "a1a8b2e7-5cd5-422b-b54e-ee8e384a8786" }, { "type": "route", "uuid": "0334f035-6889-43da-900d-60e7335dbcd6" }, { "type": "route", "uuid": "68281063-b524-4b4a-b4f0-7e07852a8abc" }, { "type": "route", "uuid": "45f91b4b-6ec8-4ed6-8ed6-b8a4acb821ee" }, { "type": "route", "uuid": "22b0553c-e9a1-4847-a644-8b9ae7c0a27c" }, { "type": "route", "uuid": "b1405243-36da-432d-ae7f-9f3dbcd9b942" }, { "type": "route", "uuid": "6446d42a-a092-47ea-95a1-ab11a9ffcadd" }, { "type": "route", "uuid": "e3c156e8-810f-4c0c-8a9f-c15fa9613db6" }, { "type": "route", "uuid": "842c513c-f564-4316-b6c5-e95c41353efa" }, { "type": "route", "uuid": "d0eb3db1-1a60-4f3b-9695-210a2cec318e" }, { "type": "route", "uuid": "282da8b8-d081-434d-ad90-2d4fe70711be" }, { "type": "route", "uuid": "f2fbeb78-e99b-4358-aeae-2e045814ff96" }, { "type": "route", "uuid": "f226a805-8fa0-4925-9eb9-90558e96ef44" }, { "type": "route", "uuid": "b3cc284f-a12d-4e9b-87c6-8cbc91330d90" }, { "type": "route", "uuid": "a9d6b5d2-9ff3-4f35-a7a6-fa80dd3d83eb" }, { "type": "route", "uuid": "7a6e5119-da88-4b9a-8667-4f0325bbcde8" }, { "type": "route", "uuid": "a7bcb4b1-8613-4a5e-835b-b35a314b6b95" }, { "type": "route", "uuid": "7ce4ea48-d81e-454c-9697-5fd3c9686af7" }, { "type": "route", "uuid": "f36e0a84-1dd4-4adb-ba37-d2541aff105f" }, { "type": "route", "uuid": "e9db5410-97a5-4172-9d79-11e0b99bd401" }, { "type": "route", "uuid": "68f24243-6596-4d02-bad9-0c21820f90ab" }, { "type": "route", "uuid": "5d6ea567-3a23-43aa-b98b-0d46b38bd1b8" }, { "type": "route", "uuid": "4c6c1cd8-ec89-4d40-8842-5d33bba69de9" }, { "type": "route", "uuid": "1f3bb38e-c475-4767-91f2-7d5a27f2f10f" }, { "type": "route", "uuid": "c7100a2f-803c-4d27-8c8f-9be69031cb14" }, { "type": "route", "uuid": "ff415e68-450a-4ba4-915a-79d56e06985b" }, { "type": "route", "uuid": "65c3680a-bb25-426e-b78c-a3fdd0184e16" }, { "type": "route", "uuid": "a3005fc4-d6f4-4b46-8872-759e14e89a4d" }, { "type": "route", "uuid": "7f020dbe-2a23-4185-8737-529db2e2ec3f" } ] }