{ "opencollection": "1.0.0", "info": { "name": "Box Authorize Authorization Comments API", "version": "1.0" }, "items": [ { "info": { "name": "Comments", "type": "folder" }, "items": [ { "info": { "name": "Box List file comments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/files/:file_id/comments", "params": [ { "name": "file_id", "value": "12345", "type": "path", "description": "The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." }, { "name": "limit", "value": "1000", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "offset", "value": "1000", "type": "query", "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response." } ] }, "docs": "Retrieves a list of comments for a file." }, { "info": { "name": "Box Get comment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/comments/:comment_id", "params": [ { "name": "comment_id", "value": "12345", "type": "path", "description": "The ID of the comment." }, { "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 the message and metadata for a specific comment, as well\nas information on the user who created the comment." }, { "info": { "name": "Box Update comment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/comments/:comment_id", "params": [ { "name": "comment_id", "value": "12345", "type": "path", "description": "The ID of the comment." }, { "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": "Update the message of a comment." }, { "info": { "name": "Box Remove comment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/comments/:comment_id", "params": [ { "name": "comment_id", "value": "12345", "type": "path", "description": "The ID of the comment." } ] }, "docs": "Permanently deletes a comment." }, { "info": { "name": "Box Create comment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/comments", "params": [ { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a comment by the user to a specific file, or\nas a reply to an other comment." } ] } ], "bundled": true }