{ "opencollection": "1.0.0", "info": { "name": "Box Authorize Authorization Web Links API", "version": "1.0" }, "items": [ { "info": { "name": "Web Links", "type": "folder" }, "items": [ { "info": { "name": "Box Create web link", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/web_links", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a web link object within a folder." }, { "info": { "name": "Box Get web link", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/web_links/:web_link_id", "headers": [ { "name": "boxapi", "value": "shared_link=[link]&shared_link_password=[password]" } ], "params": [ { "name": "web_link_id", "value": "12345", "type": "path", "description": "The ID of the web link." } ] }, "docs": "Retrieve information about a web link." }, { "info": { "name": "Box Restore web link", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/web_links/:web_link_id", "params": [ { "name": "web_link_id", "value": "12345", "type": "path", "description": "The ID of the web link." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restores a web link that has been moved to the trash.\n\nAn optional new parent ID can be provided to restore the web link to in case\nthe original folder has been deleted." }, { "info": { "name": "Box Update web link", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/web_links/:web_link_id", "params": [ { "name": "web_link_id", "value": "12345", "type": "path", "description": "The ID of the web link." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a web link object." }, { "info": { "name": "Box Remove web link", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/web_links/:web_link_id", "params": [ { "name": "web_link_id", "value": "12345", "type": "path", "description": "The ID of the web link." } ] }, "docs": "Deletes a web link." }, { "info": { "name": "Box Get trashed web link", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/web_links/:web_link_id/trash", "params": [ { "name": "web_link_id", "value": "12345", "type": "path", "description": "The ID of the web link." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ] }, "docs": "Retrieves a web link that has been moved to the trash." }, { "info": { "name": "Box Permanently remove web link", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/web_links/:web_link_id/trash", "params": [ { "name": "web_link_id", "value": "12345", "type": "path", "description": "The ID of the web link." } ] }, "docs": "Permanently deletes a web link that is in the trash.\nThis action cannot be undone." }, { "info": { "name": "Box Get shared link for web link", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/web_links/:web_link_id#get_shared_link", "params": [ { "name": "web_link_id", "value": "12345", "type": "path", "description": "The ID of the web link." }, { "name": "fields", "value": "shared_link", "type": "query", "description": "Explicitly request the `shared_link` fields\nto be returned for this item." } ] }, "docs": "Gets the information for a shared link on a web link." }, { "info": { "name": "Box Add shared link to web link", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/web_links/:web_link_id#add_shared_link", "params": [ { "name": "web_link_id", "value": "12345", "type": "path", "description": "The ID of the web link." }, { "name": "fields", "value": "shared_link", "type": "query", "description": "Explicitly request the `shared_link` fields\nto be returned for this item." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a shared link to a web link." }, { "info": { "name": "Box Update shared link on web link", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/web_links/:web_link_id#update_shared_link", "params": [ { "name": "web_link_id", "value": "12345", "type": "path", "description": "The ID of the web link." }, { "name": "fields", "value": "shared_link", "type": "query", "description": "Explicitly request the `shared_link` fields\nto be returned for this item." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a shared link on a web link." }, { "info": { "name": "Box Remove shared link from web link", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/web_links/:web_link_id#remove_shared_link", "params": [ { "name": "web_link_id", "value": "12345", "type": "path", "description": "The ID of the web link." }, { "name": "fields", "value": "shared_link", "type": "query", "description": "Explicitly request the `shared_link` fields\nto be returned for this item." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a shared link from a web link." } ] } ], "bundled": true }