{ "opencollection": "1.0.0", "info": { "name": "YOOBIC Public Answers Files API", "version": "1.0" }, "items": [ { "info": { "name": "Files", "type": "folder" }, "items": [ { "info": { "name": "Get", "type": "http" }, "http": { "method": "GET", "url": "https:///public/api/files/:id", "headers": [ { "name": "Accept", "value": "application/json" } ], "params": [ { "name": "id", "value": "54ab03c6546847ee0d30087d", "type": "path", "description": "The id of the file" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/", "accessTokenUrl": "/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a file for the given id." }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https:///public/api/files", "headers": [ { "name": "Accept", "value": "application/json" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/", "accessTokenUrl": "/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Upload a file in YOOBIC Documents.\n\nTo upload a photo, you should make a post request of type multipart/form-data. The request body should contain two fields:\n\n- `file`: the binary file you want to upload.\n\n- `group_ids`: select the groups that will have visibility of the file.\n\n- Optionally, `folder_id`: select the parent folder to upload the file.\n\n" }, { "info": { "name": "Get All", "type": "http" }, "http": { "method": "GET", "url": "https:///public/api/files?filter=:filter", "headers": [ { "name": "Accept", "value": "application/json" } ], "params": [ { "name": "filter", "value": "{}", "type": "query", "description": "A valid JSON filter object" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get all the files." }, { "info": { "name": "Count", "type": "http" }, "http": { "method": "GET", "url": "https:///public/api/files/count?where=:where", "headers": [ { "name": "Accept", "value": "application/json" } ], "params": [ { "name": "where", "value": "{ \"property\": \"value\" }", "type": "query", "description": "A valid JSON [Where filter](#section-api-requests-filter-where)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Count all the existing entities based on the where filter" }, { "info": { "name": "Export", "type": "http" }, "http": { "method": "GET", "url": "https:///public/api/files/export?type=:type&filter=:filter", "headers": [ { "name": "Accept", "value": "application/json" } ], "params": [ { "name": "type", "value": "csv", "type": "path", "description": "The type of file, either `csv` (default value) or `excel`" }, { "name": "filter", "value": "{}", "type": "query", "description": "A valid JSON filter object (does not accept a `fields` filter)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Export all results as a file. \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource." } ] } ], "bundled": true }