{ "item": [ { "id": "6a2b57c5-adf7-4301-9b30-79c76a01b00c", "name": "collections", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5f99db49-e84f-4524-9907-ae00c5147dab", "name": "Public Collections", "request": { "name": "Public Collections", "description": { "content": "Returns a list of public collections", "type": "text/plain" }, "url": { "path": [ "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number. Used for pagination with page_size" }, { "disabled": false, "key": "page_size", "value": "10", "description": "The number of results included on a page. Used for pagination with page" }, { "disabled": false, "key": "limit", "value": "", "description": "Number of results included on a page. Used for pagination with query" }, { "disabled": false, "key": "offset", "value": "", "description": "Where to start the listing (the offset of the first result). Used for pagination with limit" }, { "disabled": false, "key": "order", "value": "published_date", "description": "The field by which to order. Default varies by endpoint/resource." }, { "disabled": false, "key": "order_direction", "value": "desc" }, { "disabled": false, "key": "institution", "value": "", "description": "only return collections from this institution" }, { "disabled": false, "key": "published_since", "value": "", "description": "Filter by collection publishing date. Will only return collections published after the date. date(ISO 8601) YYYY-MM-DD" }, { "disabled": false, "key": "modified_since", "value": "", "description": "Filter by collection modified date. Will only return collections modified after the date. date(ISO 8601) YYYY-MM-DD" }, { "disabled": false, "key": "group", "value": "", "description": "only return collections from this group" }, { "disabled": false, "key": "resource_doi", "value": "", "description": "only return collections with this resource_doi" }, { "disabled": false, "key": "doi", "value": "", "description": "only return collections with this doi" }, { "disabled": false, "key": "handle", "value": "", "description": "only return collections with this handle" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.", "key": "X-Cursor", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6668e92b-7ca9-43a5-93a3-ef15b0b415c8", "name": "OK. An array of collections", "originalRequest": { "url": { "path": [ "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "order", "value": "published_date" }, { "key": "order_direction", "value": "desc" }, { "key": "institution", "value": "" }, { "key": "published_since", "value": "" }, { "key": "modified_since", "value": "" }, { "key": "group", "value": "" }, { "key": "resource_doi", "value": "" }, { "key": "doi", "value": "" }, { "key": "handle", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.", "key": "X-Cursor", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities.", "key": "X-Cursor", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"doi\": \"10.6084/m9.figshare.123\",\n \"handle\": \"111184/figshare.1234\",\n \"id\": 123,\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Sample collection\",\n \"url\": \"https://api.figshare.com/v2/collections/123\"\n },\n {\n \"doi\": \"10.6084/m9.figshare.123\",\n \"handle\": \"111184/figshare.1234\",\n \"id\": 123,\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Sample collection\",\n \"url\": \"https://api.figshare.com/v2/collections/123\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "331415fe-77c8-4b1c-9c06-5f8353e9022f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "order", "value": "published_date" }, { "key": "order_direction", "value": "desc" }, { "key": "institution", "value": "" }, { "key": "published_since", "value": "" }, { "key": "modified_since", "value": "" }, { "key": "group", "value": "" }, { "key": "resource_doi", "value": "" }, { "key": "doi", "value": "" }, { "key": "handle", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.", "key": "X-Cursor", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9b786f7a-10b3-47f1-9373-7c32232e262e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "order", "value": "published_date" }, { "key": "order_direction", "value": "desc" }, { "key": "institution", "value": "" }, { "key": "published_since", "value": "" }, { "key": "modified_since", "value": "" }, { "key": "group", "value": "" }, { "key": "resource_doi", "value": "" }, { "key": "doi", "value": "" }, { "key": "handle", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.", "key": "X-Cursor", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29cde9dc-e2b7-4e95-b1a6-62e614f99a28", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "order", "value": "published_date" }, { "key": "order_direction", "value": "desc" }, { "key": "institution", "value": "" }, { "key": "published_since", "value": "" }, { "key": "modified_since", "value": "" }, { "key": "group", "value": "" }, { "key": "resource_doi", "value": "" }, { "key": "doi", "value": "" }, { "key": "handle", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.", "key": "X-Cursor", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c908f166-ff14-4a4e-be95-edce0943d330", "name": "Public Collections Search", "request": { "name": "Public Collections Search", "description": { "content": "Returns a list of public collections", "type": "text/plain" }, "url": { "path": [ "collections", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.", "key": "X-Cursor", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"resource_doi\": \"\",\n \"doi\": \"\",\n \"handle\": \"\",\n \"order\": \"created_date\",\n \"search_for\": \"\",\n \"page\": \"\",\n \"page_size\": 10,\n \"limit\": \"\",\n \"offset\": \"\",\n \"order_direction\": \"desc\",\n \"institution\": \"\",\n \"published_since\": \"\",\n \"modified_since\": \"\",\n \"group\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1609eac8-03f6-4d04-a65e-7267cbf62805", "name": "OK. An array of collections", "originalRequest": { "url": { "path": [ "collections", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.", "key": "X-Cursor", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource_doi\": \"10.6084/m9.figshare.1407024\",\n \"doi\": \"10.6084/m9.figshare.1407024\",\n \"handle\": \"10084/figshare.1407024\",\n \"order\": \"published_date\",\n \"search_for\": \"figshare\",\n \"page\": 1,\n \"page_size\": 10,\n \"limit\": 10,\n \"offset\": 0,\n \"order_direction\": \"desc\",\n \"institution\": 2000013,\n \"published_since\": \"2017-12-22\",\n \"modified_since\": \"2017-12-22\",\n \"group\": 2000013\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities.", "key": "X-Cursor", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"doi\": \"10.6084/m9.figshare.123\",\n \"handle\": \"111184/figshare.1234\",\n \"id\": 123,\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Sample collection\",\n \"url\": \"https://api.figshare.com/v2/collections/123\"\n },\n {\n \"doi\": \"10.6084/m9.figshare.123\",\n \"handle\": \"111184/figshare.1234\",\n \"id\": 123,\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Sample collection\",\n \"url\": \"https://api.figshare.com/v2/collections/123\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e0d5fee-818d-4367-9b38-6f8a452a359b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "collections", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.", "key": "X-Cursor", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource_doi\": \"10.6084/m9.figshare.1407024\",\n \"doi\": \"10.6084/m9.figshare.1407024\",\n \"handle\": \"10084/figshare.1407024\",\n \"order\": \"published_date\",\n \"search_for\": \"figshare\",\n \"page\": 1,\n \"page_size\": 10,\n \"limit\": 10,\n \"offset\": 0,\n \"order_direction\": \"desc\",\n \"institution\": 2000013,\n \"published_since\": \"2017-12-22\",\n \"modified_since\": \"2017-12-22\",\n \"group\": 2000013\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e3bc666b-b01b-4974-808c-8cf461397a6e", "name": "Bad Request", "originalRequest": { "url": { "path": [ "collections", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.", "key": "X-Cursor", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource_doi\": \"10.6084/m9.figshare.1407024\",\n \"doi\": \"10.6084/m9.figshare.1407024\",\n \"handle\": \"10084/figshare.1407024\",\n \"order\": \"published_date\",\n \"search_for\": \"figshare\",\n \"page\": 1,\n \"page_size\": 10,\n \"limit\": 10,\n \"offset\": 0,\n \"order_direction\": \"desc\",\n \"institution\": 2000013,\n \"published_since\": \"2017-12-22\",\n \"modified_since\": \"2017-12-22\",\n \"group\": 2000013\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b4450e2e-6a9d-40b1-9c0c-a7c892bfad3d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "collections", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Unique hash used for bypassing the item retrieval limit of 9,000 entities. When using this parameter, please note that the offset parameter will not be available, but the limit parameter will still work as expected.", "key": "X-Cursor", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource_doi\": \"10.6084/m9.figshare.1407024\",\n \"doi\": \"10.6084/m9.figshare.1407024\",\n \"handle\": \"10084/figshare.1407024\",\n \"order\": \"published_date\",\n \"search_for\": \"figshare\",\n \"page\": 1,\n \"page_size\": 10,\n \"limit\": 10,\n \"offset\": 0,\n \"order_direction\": \"desc\",\n \"institution\": 2000013,\n \"published_since\": \"2017-12-22\",\n \"modified_since\": \"2017-12-22\",\n \"group\": 2000013\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14ecb784-fda8-4ecb-92fd-68b6c0b97c90", "name": "Collection details", "request": { "name": "Collection details", "description": { "content": "View a collection", "type": "text/plain" }, "url": { "path": [ "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "492badd1-c8e0-4804-9224-8d8368fccfde", "name": "OK. Collection representation", "originalRequest": { "url": { "path": [ "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"articles_count\": 1,\n \"authors\": [\n {\n \"first_name\": \"John\",\n \"full_name\": \"John Doe\",\n \"id\": 97657,\n \"is_active\": false,\n \"last_name\": \"Doe\",\n \"orcid_id\": \"1234-5678-9123-1234\",\n \"url_name\": \"John_Doe\"\n },\n {\n \"first_name\": \"John\",\n \"full_name\": \"John Doe\",\n \"id\": 97657,\n \"is_active\": false,\n \"last_name\": \"Doe\",\n \"orcid_id\": \"1234-5678-9123-1234\",\n \"url_name\": \"John_Doe\"\n }\n ],\n \"categories\": [\n {\n \"id\": 11,\n \"parent_id\": 1,\n \"path\": \"/450/1024/6532\",\n \"source_id\": \"300204\",\n \"taxonomy_id\": 4,\n \"title\": \"Anatomy\"\n },\n {\n \"id\": 11,\n \"parent_id\": 1,\n \"path\": \"/450/1024/6532\",\n \"source_id\": \"300204\",\n \"taxonomy_id\": 4,\n \"title\": \"Anatomy\"\n }\n ],\n \"citation\": \"citation\",\n \"created_date\": \"2017-05-15T15:12:26Z\",\n \"custom_fields\": [\n {\n \"field_type\": \"textarea\",\n \"is_mandatory\": false,\n \"name\": \"key\",\n \"order\": 1,\n \"settings\": {\n \"validations\": {\n \"min_length\": 1,\n \"max_length\": 1000\n },\n \"placeholder\": \"Enter your custom field here\"\n },\n \"value\": {}\n },\n {\n \"field_type\": \"textarea\",\n \"is_mandatory\": false,\n \"name\": \"key\",\n \"order\": 1,\n \"settings\": {\n \"validations\": {\n \"min_length\": 1,\n \"max_length\": 1000\n },\n \"placeholder\": \"Enter your custom field here\"\n },\n \"value\": {}\n }\n ],\n \"description\": \"description\",\n \"doi\": \"10.6084/m9.figshare.123\",\n \"funding\": [\n {\n \"funder_name\": \"string\",\n \"grant_code\": \"string\",\n \"id\": 1,\n \"is_user_defined\": 8504,\n \"title\": \"Scholarly funding\",\n \"url\": \"https://app.dimensions.ai/details/grant/1\"\n },\n {\n \"funder_name\": \"string\",\n \"grant_code\": \"string\",\n \"id\": 1,\n \"is_user_defined\": 1735,\n \"title\": \"Scholarly funding\",\n \"url\": \"https://app.dimensions.ai/details/grant/1\"\n }\n ],\n \"group_id\": 1,\n \"handle\": \"111184/figshare.1234\",\n \"id\": 123,\n \"institution_id\": 1,\n \"keywords\": [\n \"t1\",\n \"t2\"\n ],\n \"modified_date\": \"2017-05-15T15:12:26Z\",\n \"public\": true,\n \"references\": [\n \"string\",\n \"string\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"resource_doi\": \"10.6084/m9.figshare.123\",\n \"resource_id\": \"\",\n \"resource_link\": \"http://figshare.com\",\n \"resource_title\": \"test\",\n \"resource_version\": 0,\n \"tags\": [\n \"t1\",\n \"t2\"\n ],\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Sample collection\",\n \"url\": \"https://api.figshare.com/v2/collections/123\",\n \"version\": 1\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef4c129b-302c-4bea-929b-47f83d2c2888", "name": "Bad Request", "originalRequest": { "url": { "path": [ "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dd6a1e2b-4a94-46b4-b6ec-f38dfe58349e", "name": "Not Found", "originalRequest": { "url": { "path": [ "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac93a626-12b3-49ec-8dc3-f9b3386d31f9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e5c4f40-9d2c-478d-a99a-f56ae35fbda6", "name": "Collection Versions list", "request": { "name": "Collection Versions list", "description": { "content": "Returns a list of public collection Versions", "type": "text/plain" }, "url": { "path": [ "collections", ":collection_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2bb8d23f-2d19-4966-88d9-37535fd5096b", "name": "OK. An array of versions", "originalRequest": { "url": { "path": [ "collections", ":collection_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"funding\": [\n {\n \"funder_name\": \"string\",\n \"grant_code\": \"string\",\n \"id\": 1,\n \"is_user_defined\": 9198,\n \"title\": \"Scholarly funding\",\n \"url\": \"https://app.dimensions.ai/details/grant/1\"\n },\n {\n \"funder_name\": \"string\",\n \"grant_code\": \"string\",\n \"id\": 1,\n \"is_user_defined\": 537,\n \"title\": \"Scholarly funding\",\n \"url\": \"https://app.dimensions.ai/details/grant/1\"\n }\n ],\n \"url\": \"https://api.figshare.com/v2/collections/2000005/versions/1\",\n \"version\": 1\n },\n {\n \"funding\": [\n {\n \"funder_name\": \"string\",\n \"grant_code\": \"string\",\n \"id\": 1,\n \"is_user_defined\": 6168,\n \"title\": \"Scholarly funding\",\n \"url\": \"https://app.dimensions.ai/details/grant/1\"\n },\n {\n \"funder_name\": \"string\",\n \"grant_code\": \"string\",\n \"id\": 1,\n \"is_user_defined\": 7478,\n \"title\": \"Scholarly funding\",\n \"url\": \"https://app.dimensions.ai/details/grant/1\"\n }\n ],\n \"url\": \"https://api.figshare.com/v2/collections/2000005/versions/1\",\n \"version\": 1\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee6963dc-687b-4e9a-b8f9-c26545d21e5a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "collections", ":collection_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4e90c22-bdfe-485c-ab20-7f2419767c5c", "name": "Not Found", "originalRequest": { "url": { "path": [ "collections", ":collection_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c38d0813-f0fa-46c3-860e-6b1fa71bf16b", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "collections", ":collection_id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d48b71d-0d8b-4998-8261-95ae24619a13", "name": "Collection Version details", "request": { "name": "Collection Version details", "description": { "content": "View details for a certain version of a collection", "type": "text/plain" }, "url": { "path": [ "collections", ":collection_id", "versions", ":version_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "version_id", "description": "(Required) Version Number" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "fc56fc87-cd5f-4fcf-bf4d-abc7de718b3f", "name": "OK. Collection for that version", "originalRequest": { "url": { "path": [ "collections", ":collection_id", "versions", ":version_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "version_id", "description": "(Required) Version Number" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"articles_count\": 1,\n \"authors\": [\n {\n \"first_name\": \"John\",\n \"full_name\": \"John Doe\",\n \"id\": 97657,\n \"is_active\": false,\n \"last_name\": \"Doe\",\n \"orcid_id\": \"1234-5678-9123-1234\",\n \"url_name\": \"John_Doe\"\n },\n {\n \"first_name\": \"John\",\n \"full_name\": \"John Doe\",\n \"id\": 97657,\n \"is_active\": false,\n \"last_name\": \"Doe\",\n \"orcid_id\": \"1234-5678-9123-1234\",\n \"url_name\": \"John_Doe\"\n }\n ],\n \"categories\": [\n {\n \"id\": 11,\n \"parent_id\": 1,\n \"path\": \"/450/1024/6532\",\n \"source_id\": \"300204\",\n \"taxonomy_id\": 4,\n \"title\": \"Anatomy\"\n },\n {\n \"id\": 11,\n \"parent_id\": 1,\n \"path\": \"/450/1024/6532\",\n \"source_id\": \"300204\",\n \"taxonomy_id\": 4,\n \"title\": \"Anatomy\"\n }\n ],\n \"citation\": \"citation\",\n \"created_date\": \"2017-05-15T15:12:26Z\",\n \"custom_fields\": [\n {\n \"field_type\": \"textarea\",\n \"is_mandatory\": false,\n \"name\": \"key\",\n \"order\": 1,\n \"settings\": {\n \"validations\": {\n \"min_length\": 1,\n \"max_length\": 1000\n },\n \"placeholder\": \"Enter your custom field here\"\n },\n \"value\": {}\n },\n {\n \"field_type\": \"textarea\",\n \"is_mandatory\": false,\n \"name\": \"key\",\n \"order\": 1,\n \"settings\": {\n \"validations\": {\n \"min_length\": 1,\n \"max_length\": 1000\n },\n \"placeholder\": \"Enter your custom field here\"\n },\n \"value\": {}\n }\n ],\n \"description\": \"description\",\n \"doi\": \"10.6084/m9.figshare.123\",\n \"funding\": [\n {\n \"funder_name\": \"string\",\n \"grant_code\": \"string\",\n \"id\": 1,\n \"is_user_defined\": 6568,\n \"title\": \"Scholarly funding\",\n \"url\": \"https://app.dimensions.ai/details/grant/1\"\n },\n {\n \"funder_name\": \"string\",\n \"grant_code\": \"string\",\n \"id\": 1,\n \"is_user_defined\": 8367,\n \"title\": \"Scholarly funding\",\n \"url\": \"https://app.dimensions.ai/details/grant/1\"\n }\n ],\n \"group_id\": 1,\n \"handle\": \"111184/figshare.1234\",\n \"id\": 123,\n \"institution_id\": 1,\n \"keywords\": [\n \"t1\",\n \"t2\"\n ],\n \"modified_date\": \"2017-05-15T15:12:26Z\",\n \"public\": true,\n \"references\": [\n \"string\",\n \"string\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"resource_doi\": \"10.6084/m9.figshare.123\",\n \"resource_id\": \"\",\n \"resource_link\": \"http://figshare.com\",\n \"resource_title\": \"test\",\n \"resource_version\": 0,\n \"tags\": [\n \"t1\",\n \"t2\"\n ],\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Sample collection\",\n \"url\": \"https://api.figshare.com/v2/collections/123\",\n \"version\": 1\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e6d52c0-7834-4a91-a916-9a920ea0bacd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "collections", ":collection_id", "versions", ":version_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "version_id", "description": "(Required) Version Number" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac3eed4a-3d2c-4fc3-90ed-31f52cb00576", "name": "Not Found", "originalRequest": { "url": { "path": [ "collections", ":collection_id", "versions", ":version_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "version_id", "description": "(Required) Version Number" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "caebf948-f6d9-486d-a923-20ea76595455", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "collections", ":collection_id", "versions", ":version_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "version_id", "description": "(Required) Version Number" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33892fb7-e08a-4fce-93d7-fd24f1f935f2", "name": "Public Collection Articles", "request": { "name": "Public Collection Articles", "description": { "content": "Returns a list of public collection articles", "type": "text/plain" }, "url": { "path": [ "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number. Used for pagination with page_size" }, { "disabled": false, "key": "page_size", "value": "10", "description": "The number of results included on a page. Used for pagination with page" }, { "disabled": false, "key": "limit", "value": "", "description": "Number of results included on a page. Used for pagination with query" }, { "disabled": false, "key": "offset", "value": "", "description": "Where to start the listing (the offset of the first result). Used for pagination with limit" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "667f1897-fb5b-4e5e-a76a-271154f3e53e", "name": "OK. An array of articles belonging to the collection", "originalRequest": { "url": { "path": [ "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"created_date\": \"2017-05-18T11:49:03Z\",\n \"defined_type\": 3,\n \"defined_type_name\": \"media\",\n \"doi\": \"10.6084/m9.figshare.1434614\",\n \"handle\": \"111184/figshare.1234\",\n \"id\": 1434614,\n \"resource_doi\": \"\",\n \"resource_title\": \"\",\n \"thumb\": \"https://ndownloader.figshare.com/files/123456789/preview/12345678/thumb.png\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Test article title\",\n \"url\": \"http://api.figshare.com/articles/1434614\",\n \"url_private_api\": \"https://api.figshare.com/account/articles/1434614\",\n \"url_private_html\": \"https://figshare.com/account/articles/1434614\",\n \"url_public_api\": \"https://api.figshare.com/articles/1434614\",\n \"url_public_html\": \"https://figshare.com/articles/media/Test_article_title/1434614\"\n },\n {\n \"created_date\": \"2017-05-18T11:49:03Z\",\n \"defined_type\": 3,\n \"defined_type_name\": \"media\",\n \"doi\": \"10.6084/m9.figshare.1434614\",\n \"handle\": \"111184/figshare.1234\",\n \"id\": 1434614,\n \"resource_doi\": \"\",\n \"resource_title\": \"\",\n \"thumb\": \"https://ndownloader.figshare.com/files/123456789/preview/12345678/thumb.png\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Test article title\",\n \"url\": \"http://api.figshare.com/articles/1434614\",\n \"url_private_api\": \"https://api.figshare.com/account/articles/1434614\",\n \"url_private_html\": \"https://figshare.com/account/articles/1434614\",\n \"url_public_api\": \"https://api.figshare.com/articles/1434614\",\n \"url_public_html\": \"https://figshare.com/articles/media/Test_article_title/1434614\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1126038-6fed-4a14-80a9-5ec796c64e58", "name": "Bad Request", "originalRequest": { "url": { "path": [ "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "62f8d92b-0a5e-4a44-83ab-a10dba71e091", "name": "Not Found", "originalRequest": { "url": { "path": [ "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "979c3ec8-55ea-4fe7-834e-9d78ad4c3259", "name": "Bad Request", "originalRequest": { "url": { "path": [ "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "16bb7e99-3c2a-4a33-a082-e10d2f3d1669", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4fc26cda-08bf-4cc5-9e71-f4cc7dc3761d", "name": "Private Collections List", "request": { "name": "Private Collections List", "description": { "content": "List private collections", "type": "text/plain" }, "url": { "path": [ "account", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number. Used for pagination with page_size" }, { "disabled": false, "key": "page_size", "value": "10", "description": "The number of results included on a page. Used for pagination with page" }, { "disabled": false, "key": "limit", "value": "", "description": "Number of results included on a page. Used for pagination with query" }, { "disabled": false, "key": "offset", "value": "", "description": "Where to start the listing (the offset of the first result). Used for pagination with limit" }, { "disabled": false, "key": "order", "value": "published_date", "description": "The field by which to order. Default varies by endpoint/resource." }, { "disabled": false, "key": "order_direction", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "5a9fb21f-893e-4c76-8330-5df603740a8e", "name": "OK. An array of collections", "originalRequest": { "url": { "path": [ "account", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "order", "value": "published_date" }, { "key": "order_direction", "value": "desc" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"doi\": \"10.6084/m9.figshare.123\",\n \"handle\": \"111184/figshare.1234\",\n \"id\": 123,\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Sample collection\",\n \"url\": \"https://api.figshare.com/v2/collections/123\"\n },\n {\n \"doi\": \"10.6084/m9.figshare.123\",\n \"handle\": \"111184/figshare.1234\",\n \"id\": 123,\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Sample collection\",\n \"url\": \"https://api.figshare.com/v2/collections/123\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11f04ba9-7ab8-4b07-8a98-2c2916ede376", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "order", "value": "published_date" }, { "key": "order_direction", "value": "desc" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c2651572-35d6-4ff5-b104-be1d1a8bc675", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "order", "value": "published_date" }, { "key": "order_direction", "value": "desc" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd05925b-7fd2-4a36-9fd7-d3ba181f94b0", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "order", "value": "published_date" }, { "key": "order_direction", "value": "desc" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a5e4ba05-219b-4e4b-ae3c-c6717f7f97b0", "name": "Create collection", "request": { "name": "Create collection", "description": { "content": "Create a new Collection by sending collection information", "type": "text/plain" }, "url": { "path": [ "account", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"description\": \"\",\n \"articles\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"\",\n \"\"\n ],\n \"categories_by_source_id\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"references\": [\n \"\",\n \"\"\n ],\n \"related_materials\": [\n {\n \"id\": \"\",\n \"identifier\": \"\",\n \"title\": \"\",\n \"relation\": \"References\",\n \"identifier_type\": \"URL\",\n \"is_linkout\": \"\"\n },\n {\n \"id\": \"\",\n \"identifier\": \"\",\n \"title\": \"\",\n \"relation\": \"References\",\n \"identifier_type\": \"URL\",\n \"is_linkout\": \"\"\n }\n ],\n \"custom_fields\": {},\n \"custom_fields_list\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"\",\n \"publisherPublication\": \"\",\n \"publisherAcceptance\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b63da6ec-d2af-4cf9-ac02-24cced5e0dde", "name": "Created", "originalRequest": { "url": { "path": [ "account", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Test collection title\",\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"description\": \"Test description of article\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"entity_id\": 33334444,\n \"location\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "690d4bca-e92e-4f1d-9062-aa59ab36b86a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Test collection title\",\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"description\": \"Test description of article\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82b0ca91-5d02-42bb-8ca4-07d2ef3ef7ca", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Test collection title\",\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"description\": \"Test description of article\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34ff3bac-355a-4dba-9652-dfe7b90aed37", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Test collection title\",\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"description\": \"Test description of article\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e984f6a2-ec64-4704-be14-799d63e9831e", "name": "Collection details", "request": { "name": "Collection details", "description": { "content": "View a collection", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "e7922e00-4927-47cb-a880-f62ded815718", "name": "OK. Collection representation", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account_id\": 1000001,\n \"articles_count\": 1,\n \"authors\": [\n {\n \"first_name\": \"John\",\n \"full_name\": \"John Doe\",\n \"id\": 97657,\n \"is_active\": false,\n \"last_name\": \"Doe\",\n \"orcid_id\": \"1234-5678-9123-1234\",\n \"url_name\": \"John_Doe\"\n },\n {\n \"first_name\": \"John\",\n \"full_name\": \"John Doe\",\n \"id\": 97657,\n \"is_active\": false,\n \"last_name\": \"Doe\",\n \"orcid_id\": \"1234-5678-9123-1234\",\n \"url_name\": \"John_Doe\"\n }\n ],\n \"categories\": [\n {\n \"id\": 11,\n \"parent_id\": 1,\n \"path\": \"/450/1024/6532\",\n \"source_id\": \"300204\",\n \"taxonomy_id\": 4,\n \"title\": \"Anatomy\"\n },\n {\n \"id\": 11,\n \"parent_id\": 1,\n \"path\": \"/450/1024/6532\",\n \"source_id\": \"300204\",\n \"taxonomy_id\": 4,\n \"title\": \"Anatomy\"\n }\n ],\n \"citation\": \"citation\",\n \"created_date\": \"2017-05-15T15:12:26Z\",\n \"custom_fields\": [\n {\n \"field_type\": \"textarea\",\n \"is_mandatory\": false,\n \"name\": \"key\",\n \"order\": 1,\n \"settings\": {\n \"validations\": {\n \"min_length\": 1,\n \"max_length\": 1000\n },\n \"placeholder\": \"Enter your custom field here\"\n },\n \"value\": {}\n },\n {\n \"field_type\": \"textarea\",\n \"is_mandatory\": false,\n \"name\": \"key\",\n \"order\": 1,\n \"settings\": {\n \"validations\": {\n \"min_length\": 1,\n \"max_length\": 1000\n },\n \"placeholder\": \"Enter your custom field here\"\n },\n \"value\": {}\n }\n ],\n \"description\": \"description\",\n \"doi\": \"10.6084/m9.figshare.123\",\n \"funding\": [\n {\n \"funder_name\": \"string\",\n \"grant_code\": \"string\",\n \"id\": 1,\n \"is_user_defined\": 5837,\n \"title\": \"Scholarly funding\",\n \"url\": \"https://app.dimensions.ai/details/grant/1\"\n },\n {\n \"funder_name\": \"string\",\n \"grant_code\": \"string\",\n \"id\": 1,\n \"is_user_defined\": 4381,\n \"title\": \"Scholarly funding\",\n \"url\": \"https://app.dimensions.ai/details/grant/1\"\n }\n ],\n \"group_id\": 1,\n \"handle\": \"111184/figshare.1234\",\n \"id\": 123,\n \"institution_id\": 1,\n \"keywords\": [\n \"t1\",\n \"t2\"\n ],\n \"modified_date\": \"2017-05-15T15:12:26Z\",\n \"public\": true,\n \"references\": [\n \"string\",\n \"string\"\n ],\n \"resource_doi\": \"10.6084/m9.figshare.123\",\n \"resource_id\": \"\",\n \"resource_link\": \"http://figshare.com\",\n \"resource_title\": \"test\",\n \"resource_version\": 0,\n \"tags\": [\n \"t1\",\n \"t2\"\n ],\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Sample collection\",\n \"url\": \"https://api.figshare.com/v2/collections/123\",\n \"version\": 1,\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eb8f9eb-888d-40ae-b0b9-360b4fab7fd2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1be2dc1a-3491-4bf4-ad0d-c74cf6f694d5", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cb8b8f86-dff0-4c35-8db8-d7f2b4e5d279", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b435df4c-bbd2-4b90-8860-f5736790e221", "name": "Update collection", "request": { "name": "Update collection", "description": { "content": "Update a collection by passing full body parameters.", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"\",\n \"description\": \"\",\n \"articles\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"\",\n \"\"\n ],\n \"categories_by_source_id\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"references\": [\n \"\",\n \"\"\n ],\n \"related_materials\": [\n {\n \"id\": \"\",\n \"identifier\": \"\",\n \"title\": \"\",\n \"relation\": \"References\",\n \"identifier_type\": \"URL\",\n \"is_linkout\": \"\"\n },\n {\n \"id\": \"\",\n \"identifier\": \"\",\n \"title\": \"\",\n \"relation\": \"References\",\n \"identifier_type\": \"URL\",\n \"is_linkout\": \"\"\n }\n ],\n \"custom_fields\": {},\n \"custom_fields_list\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"\",\n \"publisherPublication\": \"\",\n \"publisherAcceptance\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ea7a8227-6cf9-4d82-9e8c-55f0cd5b80c7", "name": "Reset Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"Test collection title\",\n \"description\": \"Test description of collection\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Reset Content", "code": 205, "header": [ { "disabled": false, "description": "Location of collection", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd95890d-c2ae-41c5-b476-bdf3dbc25f5d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"Test collection title\",\n \"description\": \"Test description of collection\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "907ba03c-391b-4ad3-93b2-f79c66444ab0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"Test collection title\",\n \"description\": \"Test description of collection\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "032e01a6-c617-4e54-a19c-6128d3ca355d", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"Test collection title\",\n \"description\": \"Test description of collection\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a29820d6-5309-4a36-bef9-2917db3a2183", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"Test collection title\",\n \"description\": \"Test description of collection\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c10d9493-df00-492d-82cd-12fe063fa3d9", "name": "Delete collection", "request": { "name": "Delete collection", "description": { "content": "Delete n collection", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "9e396fa0-c7bc-4d51-8ff4-6307898fb299", "name": "No Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "219f9081-773a-4f69-9c1d-c1bb4e0edc87", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59ec334e-1b59-4396-a24d-953f1f1ea6d3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5cc6137-f6a5-4ffc-91d9-34033aab9be3", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ca9f8609-1f61-4903-b553-26087e0fc76f", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e048c0f4-c1f4-4428-a190-f49026a85e25", "name": "Partially update collection", "request": { "name": "Partially update collection", "description": { "content": "Partially update a collection by sending only the fields to change.", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"\",\n \"description\": \"\",\n \"articles\": [\n \"\",\n \"\"\n ],\n \"categories\": [\n \"\",\n \"\"\n ],\n \"categories_by_source_id\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"references\": [\n \"\",\n \"\"\n ],\n \"related_materials\": [\n {\n \"id\": \"\",\n \"identifier\": \"\",\n \"title\": \"\",\n \"relation\": \"References\",\n \"identifier_type\": \"URL\",\n \"is_linkout\": \"\"\n },\n {\n \"id\": \"\",\n \"identifier\": \"\",\n \"title\": \"\",\n \"relation\": \"References\",\n \"identifier_type\": \"URL\",\n \"is_linkout\": \"\"\n }\n ],\n \"custom_fields\": {},\n \"custom_fields_list\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"\",\n \"publisherPublication\": \"\",\n \"publisherAcceptance\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0d627ada-c0bb-46cf-b59b-084b3611fa73", "name": "Reset Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"Test collection title\",\n \"description\": \"Test description of collection\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Reset Content", "code": 205, "header": [ { "disabled": false, "description": "Location of collection", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location\": \"string\",\n \"warnings\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db37ca11-583e-461b-b0f1-2a0f6b11e260", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"Test collection title\",\n \"description\": \"Test description of collection\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f7a3d76-42d6-44ef-9628-e57b068cde39", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"Test collection title\",\n \"description\": \"Test description of collection\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f7c50c8-a4ba-4627-aaa2-78d5c0f8d4ac", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"Test collection title\",\n \"description\": \"Test description of collection\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "386c0daa-a3d1-4ea3-99bc-1eb2e0f71787", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"funding\": \"\",\n \"funding_list\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"Test collection title\",\n \"description\": \"Test description of collection\",\n \"articles\": [\n 2000001,\n 2000005\n ],\n \"authors\": [\n {\n \"name\": \"John Doe\"\n },\n {\n \"id\": 20005\n }\n ],\n \"categories\": [\n 1,\n 10,\n 11\n ],\n \"categories_by_source_id\": [\n \"300204\",\n \"400207\"\n ],\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"keywords\": [\n \"tag1\",\n \"tag2\"\n ],\n \"references\": [\n \"http://figshare.com\",\n \"http://api.figshare.com\"\n ],\n \"related_materials\": [\n {\n \"id\": 10432,\n \"identifier\": \"10.6084/m9.figshare.1407024\",\n \"identifier_type\": \"DOI\",\n \"relation\": \"IsSupplementTo\",\n \"title\": \"Figshare for institutions brochure\",\n \"is_linkout\": false\n }\n ],\n \"custom_fields\": {\n \"defined_key\": \"value for it\"\n },\n \"custom_fields_list\": [\n {\n \"name\": \"key\",\n \"value\": \"\"\n },\n {\n \"name\": \"key\",\n \"value\": \"\"\n }\n ],\n \"doi\": \"\",\n \"handle\": \"\",\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"resource_link\": \"\",\n \"resource_title\": \"\",\n \"resource_version\": \"\",\n \"group_id\": \"\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4554831-86a2-47d9-a908-04083298c1d0", "name": "Private Collections Search", "request": { "name": "Private Collections Search", "description": { "content": "Returns a list of private Collections", "type": "text/plain" }, "url": { "path": [ "account", "collections", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"resource_id\": \"\",\n \"resource_doi\": \"\",\n \"doi\": \"\",\n \"handle\": \"\",\n \"order\": \"created_date\",\n \"search_for\": \"\",\n \"page\": \"\",\n \"page_size\": 10,\n \"limit\": \"\",\n \"offset\": \"\",\n \"order_direction\": \"desc\",\n \"institution\": \"\",\n \"published_since\": \"\",\n \"modified_since\": \"\",\n \"group\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "66f6d89b-d6c6-4849-979a-1c1de51ccb91", "name": "OK. An array of collections", "originalRequest": { "url": { "path": [ "account", "collections", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource_id\": \"1407024\",\n \"resource_doi\": \"10.6084/m9.figshare.1407024\",\n \"doi\": \"10.6084/m9.figshare.1407024\",\n \"handle\": \"10084/figshare.1407024\",\n \"order\": \"published_date\",\n \"search_for\": \"figshare\",\n \"page\": 1,\n \"page_size\": 10,\n \"limit\": 10,\n \"offset\": 0,\n \"order_direction\": \"desc\",\n \"institution\": 2000013,\n \"published_since\": \"2017-12-22\",\n \"modified_since\": \"2017-12-22\",\n \"group\": 2000013\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"doi\": \"10.6084/m9.figshare.123\",\n \"handle\": \"111184/figshare.1234\",\n \"id\": 123,\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Sample collection\",\n \"url\": \"https://api.figshare.com/v2/collections/123\"\n },\n {\n \"doi\": \"10.6084/m9.figshare.123\",\n \"handle\": \"111184/figshare.1234\",\n \"id\": 123,\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Sample collection\",\n \"url\": \"https://api.figshare.com/v2/collections/123\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "389dbbda-cfbf-4e7c-9c66-9e09e383ce77", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource_id\": \"1407024\",\n \"resource_doi\": \"10.6084/m9.figshare.1407024\",\n \"doi\": \"10.6084/m9.figshare.1407024\",\n \"handle\": \"10084/figshare.1407024\",\n \"order\": \"published_date\",\n \"search_for\": \"figshare\",\n \"page\": 1,\n \"page_size\": 10,\n \"limit\": 10,\n \"offset\": 0,\n \"order_direction\": \"desc\",\n \"institution\": 2000013,\n \"published_since\": \"2017-12-22\",\n \"modified_since\": \"2017-12-22\",\n \"group\": 2000013\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5d3a72c8-75c5-4f60-a0df-3af16d080ba3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource_id\": \"1407024\",\n \"resource_doi\": \"10.6084/m9.figshare.1407024\",\n \"doi\": \"10.6084/m9.figshare.1407024\",\n \"handle\": \"10084/figshare.1407024\",\n \"order\": \"published_date\",\n \"search_for\": \"figshare\",\n \"page\": 1,\n \"page_size\": 10,\n \"limit\": 10,\n \"offset\": 0,\n \"order_direction\": \"desc\",\n \"institution\": 2000013,\n \"published_since\": \"2017-12-22\",\n \"modified_since\": \"2017-12-22\",\n \"group\": 2000013\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dba93a7f-f988-4602-9435-065e3c4dd551", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource_id\": \"1407024\",\n \"resource_doi\": \"10.6084/m9.figshare.1407024\",\n \"doi\": \"10.6084/m9.figshare.1407024\",\n \"handle\": \"10084/figshare.1407024\",\n \"order\": \"published_date\",\n \"search_for\": \"figshare\",\n \"page\": 1,\n \"page_size\": 10,\n \"limit\": 10,\n \"offset\": 0,\n \"order_direction\": \"desc\",\n \"institution\": 2000013,\n \"published_since\": \"2017-12-22\",\n \"modified_since\": \"2017-12-22\",\n \"group\": 2000013\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7476b74f-110f-44b6-8b91-68f725b0be4d", "name": "Private Collection Reserve DOI", "request": { "name": "Private Collection Reserve DOI", "description": { "content": "Reserve DOI for collection", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "reserve_doi" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "e9e0735b-abfb-4970-958c-676ca7d5afba", "name": "OK", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "reserve_doi" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"doi\": \"10.5072/FK2.FIGSHARE.20345\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75971f2d-5d50-4126-baba-61c314a2f74a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "reserve_doi" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "05515909-8cb0-4cf8-bfe5-ee27848ff9f8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "reserve_doi" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6513f9a-3ac7-4d45-a821-3eff405d9fe5", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "reserve_doi" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fcf58a7-f605-4ff7-812b-cc389d073697", "name": "Private Collection Reserve Handle", "request": { "name": "Private Collection Reserve Handle", "description": { "content": "Reserve Handle for collection", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "reserve_handle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "76d9a7de-a69c-47e9-801e-7a5a6d1d73e5", "name": "OK", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "reserve_handle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"handle\": \"11172/FK2.FIGSHARE.20345\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57e7e0d5-739a-495d-b1d6-014441ee58d4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "reserve_handle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4886d0f0-025c-4c4a-aedf-d5642c456670", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "reserve_handle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6570aa0-f79b-4d33-ab83-43e9d58ef837", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "reserve_handle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b4988bb-5224-4857-b852-63877944cd0b", "name": "Private Collection Resource", "request": { "name": "Private Collection Resource", "description": { "content": "Edit collection resource data.", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "resource" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"title\": \"\",\n \"doi\": \"\",\n \"link\": \"\",\n \"status\": \"\",\n \"version\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bb9070b5-551a-4aa2-b789-cf2661ebba2c", "name": "Reset Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "resource" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"aaaa23512\",\n \"title\": \"Test title\",\n \"doi\": \"\",\n \"link\": \"https://docs.figshare.com\",\n \"status\": \"frozen\",\n \"version\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Reset Content", "code": 205, "header": [ { "disabled": false, "description": "Location for account collection details", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b0c8641-2583-4b08-a346-8c8cca1293f0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "resource" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"aaaa23512\",\n \"title\": \"Test title\",\n \"doi\": \"\",\n \"link\": \"https://docs.figshare.com\",\n \"status\": \"frozen\",\n \"version\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcbaac79-0b1a-4567-95ee-06e80c5ced25", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "resource" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"aaaa23512\",\n \"title\": \"Test title\",\n \"doi\": \"\",\n \"link\": \"https://docs.figshare.com\",\n \"status\": \"frozen\",\n \"version\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0ee06d82-e836-44d8-b814-5ea59a27467b", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "resource" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"aaaa23512\",\n \"title\": \"Test title\",\n \"doi\": \"\",\n \"link\": \"https://docs.figshare.com\",\n \"status\": \"frozen\",\n \"version\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b941cf7-fba5-4fe6-bed6-864e7d0e3067", "name": "Private Collection Publish", "request": { "name": "Private Collection Publish", "description": { "content": "When a collection is published, a new public version will be generated. Any further updates to the collection will affect the private collection data. In order to make these changes publicly visible, an explicit publish operation is needed.", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "28496814-0ef2-4120-ba63-d5fa3a66d2bf", "name": "Created", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "Location of collection", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e134d1ce-1d27-41c1-a491-6be8b6769a03", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bfd51a65-2b49-422d-8865-e7186a89aa67", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d568055-f530-4297-b38f-1fba7e883c45", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection Unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "558b9f59-e4c2-43d6-9cfd-0b5f79dbdb67", "name": "List collection authors", "request": { "name": "List collection authors", "description": { "content": "List collection authors", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "de4b900e-8ee8-429f-86f8-b454e5870b3d", "name": "OK. Embargo for article", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"first_name\": \"John\",\n \"full_name\": \"John Doe\",\n \"id\": 97657,\n \"is_active\": false,\n \"last_name\": \"Doe\",\n \"orcid_id\": \"1234-5678-9123-1234\",\n \"url_name\": \"John_Doe\"\n },\n {\n \"first_name\": \"John\",\n \"full_name\": \"John Doe\",\n \"id\": 97657,\n \"is_active\": false,\n \"last_name\": \"Doe\",\n \"orcid_id\": \"1234-5678-9123-1234\",\n \"url_name\": \"John_Doe\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a05377aa-76a4-42cd-a659-da43643842e2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1f01238f-bdd3-481c-ba5c-5a81021305d1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a49b6c8a-a477-4b5d-b014-b4d4487b6516", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55196d67-03ae-4603-a50c-ed0b78791e0d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "632dc341-d3a7-4b15-824e-77be2f8530fe", "name": "Replace collection authors", "request": { "name": "Replace collection authors", "description": { "content": "Associate new authors with the collection. This will remove all already associated authors and add these new ones", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"authors\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c9dbb803-62ca-4833-bd7f-0b5b940b88ce", "name": "Reset Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"authors\": [\n {\n \"id\": 12121\n },\n {\n \"id\": 34345\n },\n {\n \"name\": \"John Doe\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Reset Content", "code": 205, "header": [ { "disabled": false, "description": "Location of list of authors", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2bccb99a-daed-4d39-bd1f-2a1a3b333b42", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"authors\": [\n {\n \"id\": 12121\n },\n {\n \"id\": 34345\n },\n {\n \"name\": \"John Doe\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "12103aa5-71ee-4c7a-a755-1d9801c3e878", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"authors\": [\n {\n \"id\": 12121\n },\n {\n \"id\": 34345\n },\n {\n \"name\": \"John Doe\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c43206e-a7b5-404c-932e-fde86fd8bd6c", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"authors\": [\n {\n \"id\": 12121\n },\n {\n \"id\": 34345\n },\n {\n \"name\": \"John Doe\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70ffde34-50de-4bed-9830-eb02c6fb93a8", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"authors\": [\n {\n \"id\": 12121\n },\n {\n \"id\": 34345\n },\n {\n \"name\": \"John Doe\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79859dea-cfdf-4738-b464-310f4b6128bb", "name": "Add collection authors", "request": { "name": "Add collection authors", "description": { "content": "Associate new authors with the collection. This will add new authors to the list of already associated authors", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"authors\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6b030f3d-5ba0-40fb-b8a2-8885a18f44d0", "name": "Reset Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"authors\": [\n {\n \"id\": 12121\n },\n {\n \"id\": 34345\n },\n {\n \"name\": \"John Doe\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "Location of list of authors", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "149436de-2da8-41b6-b705-d4b1ad3875ae", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"authors\": [\n {\n \"id\": 12121\n },\n {\n \"id\": 34345\n },\n {\n \"name\": \"John Doe\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0a4766e-c4d8-4979-bb5f-25261245b17e", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"authors\": [\n {\n \"id\": 12121\n },\n {\n \"id\": 34345\n },\n {\n \"name\": \"John Doe\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb4b0e83-cb3b-4fb6-b133-76bf0078f72c", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"authors\": [\n {\n \"id\": 12121\n },\n {\n \"id\": 34345\n },\n {\n \"name\": \"John Doe\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a9c0b62e-6164-4fcc-96d5-9359d2b4a482", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"authors\": [\n {\n \"id\": 12121\n },\n {\n \"id\": 34345\n },\n {\n \"name\": \"John Doe\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c1dc243d-2a6a-4e14-9117-70dcec7cea76", "name": "Delete collection author", "request": { "name": "Delete collection author", "description": { "content": "Delete collection author", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "authors", ":author_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "author_id", "description": "(Required) Collection Author unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "d18b98fe-1b17-4fbe-a003-e910e46826e7", "name": "No Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors", ":author_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "author_id", "description": "(Required) Collection Author unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8515be0-b8f8-4720-a8cd-0b0efa419635", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors", ":author_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "author_id", "description": "(Required) Collection Author unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c5555ea-4a72-4fac-ae01-5e0e7259ae41", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors", ":author_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "author_id", "description": "(Required) Collection Author unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "35125375-c5ce-45c1-bade-63a4016d7f7a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "authors", ":author_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "author_id", "description": "(Required) Collection Author unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2216fe18-e820-4139-ada0-092d0ab90773", "name": "List collection categories", "request": { "name": "List collection categories", "description": { "content": "List collection categories", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "e687a51c-d17b-444c-917b-774da1e9ef76", "name": "OK. Categories list", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 11,\n \"parent_id\": 1,\n \"path\": \"/450/1024/6532\",\n \"source_id\": \"300204\",\n \"taxonomy_id\": 4,\n \"title\": \"Anatomy\"\n },\n {\n \"id\": 11,\n \"parent_id\": 1,\n \"path\": \"/450/1024/6532\",\n \"source_id\": \"300204\",\n \"taxonomy_id\": 4,\n \"title\": \"Anatomy\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "366791f0-51ef-4ec1-b343-6fe8cbbfeea8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b01bce34-5cd3-401c-b700-4c9e9b5825a8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11378b86-08f8-4662-9e2a-7e0102497c3f", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e06f62f3-bcbf-4e4a-99d6-076ce1f1f68d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11c9c9f6-6ab8-4f94-adb6-f5e95b7ba14c", "name": "Replace collection categories", "request": { "name": "Replace collection categories", "description": { "content": "Associate new categories with the collection. This will remove all already associated categories and add these new ones", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"categories\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ca3cbe80-4c30-4e8d-af96-311355ad0808", "name": "Reset Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"categories\": [\n 1,\n 10,\n 11\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Reset Content", "code": 205, "header": [ { "disabled": false, "description": "Location of list of categories", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "19c3b80a-48aa-4bdb-9b3e-75d94564c6c0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"categories\": [\n 1,\n 10,\n 11\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "26e509ea-7fa7-4781-89c8-c7187e5525da", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"categories\": [\n 1,\n 10,\n 11\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c766026-1b33-4500-a988-1ce4287c1f0c", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"categories\": [\n 1,\n 10,\n 11\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5bb7299-f587-4982-b48c-cd5098d4a813", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"categories\": [\n 1,\n 10,\n 11\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "090f9586-726e-4c14-9a17-8f1675f97d03", "name": "Add collection categories", "request": { "name": "Add collection categories", "description": { "content": "Associate new categories with the collection. This will add new categories to the list of already associated categories", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"categories\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "265e20ed-51a2-453e-9408-d74ce733630f", "name": "Reset Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"categories\": [\n 1,\n 10,\n 11\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "Location of list of categories", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2b4ca55-80d8-40a0-be4b-24592ad77ffb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"categories\": [\n 1,\n 10,\n 11\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "934cc765-2896-4b43-8195-cc44c6fedc13", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"categories\": [\n 1,\n 10,\n 11\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dba0b731-81f1-4439-a1b1-8437d4d95051", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"categories\": [\n 1,\n 10,\n 11\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c217b482-ffe2-48be-87b5-78bf86dd7e3a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"categories\": [\n 1,\n 10,\n 11\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5999c664-95d6-4817-9dec-b6edfd2fedce", "name": "Delete collection category", "request": { "name": "Delete collection category", "description": { "content": "De-associate category from collection", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "categories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "category_id", "description": "(Required) Collection category unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "abda05e7-a1fb-4c4b-9ef5-df405750d147", "name": "No Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "category_id", "description": "(Required) Collection category unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7062b72f-88b5-407f-8e60-7df1bf681006", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "category_id", "description": "(Required) Collection category unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50bdd008-1a0e-4b1f-8245-fa52bc6712ec", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "category_id", "description": "(Required) Collection category unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39bcc76a-c488-439d-a6bb-103e13638e0d", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "categories", ":category_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "category_id", "description": "(Required) Collection category unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57dea935-fd88-4ca4-aa86-4ddb16a1758e", "name": "List collection articles", "request": { "name": "List collection articles", "description": { "content": "List collection articles", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number. Used for pagination with page_size" }, { "disabled": false, "key": "page_size", "value": "10", "description": "The number of results included on a page. Used for pagination with page" }, { "disabled": false, "key": "limit", "value": "", "description": "Number of results included on a page. Used for pagination with query" }, { "disabled": false, "key": "offset", "value": "", "description": "Where to start the listing (the offset of the first result). Used for pagination with limit" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "755c2a38-fa73-4e16-b863-9b52b714bfb2", "name": "OK. Articles List", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"created_date\": \"2017-05-18T11:49:03Z\",\n \"defined_type\": 3,\n \"defined_type_name\": \"media\",\n \"doi\": \"10.6084/m9.figshare.1434614\",\n \"handle\": \"111184/figshare.1234\",\n \"id\": 1434614,\n \"resource_doi\": \"\",\n \"resource_title\": \"\",\n \"thumb\": \"https://ndownloader.figshare.com/files/123456789/preview/12345678/thumb.png\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Test article title\",\n \"url\": \"http://api.figshare.com/articles/1434614\",\n \"url_private_api\": \"https://api.figshare.com/account/articles/1434614\",\n \"url_private_html\": \"https://figshare.com/account/articles/1434614\",\n \"url_public_api\": \"https://api.figshare.com/articles/1434614\",\n \"url_public_html\": \"https://figshare.com/articles/media/Test_article_title/1434614\"\n },\n {\n \"created_date\": \"2017-05-18T11:49:03Z\",\n \"defined_type\": 3,\n \"defined_type_name\": \"media\",\n \"doi\": \"10.6084/m9.figshare.1434614\",\n \"handle\": \"111184/figshare.1234\",\n \"id\": 1434614,\n \"resource_doi\": \"\",\n \"resource_title\": \"\",\n \"thumb\": \"https://ndownloader.figshare.com/files/123456789/preview/12345678/thumb.png\",\n \"timeline\": {\n \"firstOnline\": \"2015-12-31\",\n \"publisherPublication\": \"2015-12-31\",\n \"publisherAcceptance\": \"2015-12-31\"\n },\n \"title\": \"Test article title\",\n \"url\": \"http://api.figshare.com/articles/1434614\",\n \"url_private_api\": \"https://api.figshare.com/account/articles/1434614\",\n \"url_private_html\": \"https://figshare.com/account/articles/1434614\",\n \"url_public_api\": \"https://api.figshare.com/articles/1434614\",\n \"url_public_html\": \"https://figshare.com/articles/media/Test_article_title/1434614\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07db2d9d-b54b-4a2e-a93d-6b446c04ed86", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "448580a0-05ad-49d1-936e-b5d112d7be87", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c034539-eda4-404f-939d-92c237cc2f32", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "46098e5d-b71f-42e4-912b-f22ec3e16050", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "" }, { "key": "page_size", "value": "10" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca1707be-9eeb-49d9-ac70-d4f4c2a8e773", "name": "Replace collection articles", "request": { "name": "Replace collection articles", "description": { "content": "Associate new articles with the collection. This will remove all already associated articles and add these new ones", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"articles\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0e1ffaa6-1b94-4dba-b595-2d3ee3563c9a", "name": "Reset Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"articles\": [\n 2000003,\n 2000004\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Reset Content", "code": 205, "header": [ { "disabled": false, "description": "Location of list of articles", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b0bfb38e-04d4-48d9-b5cf-5f3d142eab71", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"articles\": [\n 2000003,\n 2000004\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5c272316-5222-40a6-8492-b99781145ba9", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"articles\": [\n 2000003,\n 2000004\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "705087e7-bf98-4172-9864-9d05dfbd04da", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"articles\": [\n 2000003,\n 2000004\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f30be0e2-d080-4d06-b783-4db5ad1658d9", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"articles\": [\n 2000003,\n 2000004\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7343273-c48d-40a0-9f6a-c9f1409705db", "name": "Add collection articles", "request": { "name": "Add collection articles", "description": { "content": "Associate new articles with the collection. This will add new articles to the list of already associated articles", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"articles\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "954f4246-e7a1-4b5c-9d03-bd68ac3aaac7", "name": "Reset Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"articles\": [\n 2000003,\n 2000004\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "Location of new articles", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"location\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbccf4aa-955c-4d85-b734-442f249a70d2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"articles\": [\n 2000003,\n 2000004\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51dc783d-09b2-42bb-ac6e-6feb671eae8b", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"articles\": [\n 2000003,\n 2000004\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93602b8b-e73c-4993-8e86-0f06303735c3", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"articles\": [\n 2000003,\n 2000004\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2cb2be23-6515-45e0-9b56-2c8017d1654e", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"articles\": [\n 2000003,\n 2000004\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fbad5c42-bbc5-482d-a322-6b7dda961f0e", "name": "Delete collection article", "request": { "name": "Delete collection article", "description": { "content": "De-associate article from collection", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "articles", ":article_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "article_id", "description": "(Required) Collection article unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "3e71a23e-45f0-41fd-bf3d-dab16be3a152", "name": "No Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles", ":article_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "article_id", "description": "(Required) Collection article unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47ba8c9f-01c7-48bb-8bc5-c9794ce117f8", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles", ":article_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "article_id", "description": "(Required) Collection article unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6649534f-35b4-4774-ab89-b8fcdf086660", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles", ":article_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "article_id", "description": "(Required) Collection article unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "78920e9e-8e7e-4253-811c-d8f3882bea09", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "articles", ":article_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "article_id", "description": "(Required) Collection article unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf6c1310-3e2e-4022-a7c0-b5f4a63431af", "name": "List collection private links", "request": { "name": "List collection private links", "description": { "content": "List article private links", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "private_links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "3fd13623-8c57-4d23-89df-2c01f9c28a58", "name": "OK. Collection private links", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"expires_date\": \"2015-07-03T00:00:00\",\n \"html_location\": \"https://figshare.com/s/d5ec7a85bcd6dbe9d9b2\",\n \"id\": \"0cfb0dbeac92df445df4aba45f63fdc85fa0b9a888b64e157ce3c93b576aa300fb3621ef3a219515dd482\",\n \"is_active\": true\n },\n {\n \"expires_date\": \"2015-07-03T00:00:00\",\n \"html_location\": \"https://figshare.com/s/d5ec7a85bcd6dbe9d9b2\",\n \"id\": \"0cfb0dbeac92df445df4aba45f63fdc85fa0b9a888b64e157ce3c93b576aa300fb3621ef3a219515dd482\",\n \"is_active\": true\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3e9fdb9-0e1c-40fc-b52f-272881a6b353", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10c591ae-1832-4bcb-a343-6668e95c6a8c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c1867fd-714b-4c9d-8b4f-14fa55e28b45", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "790369d2-d3a6-40a7-a553-32b5fcfe0e56", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "103f0a89-2ce0-4916-9eff-740a954827f3", "name": "Create collection private link", "request": { "name": "Create collection private link", "description": { "content": "Create new private link", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "private_links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"expires_date\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2c6b6720-de3f-4899-8116-cbba5031c145", "name": "Created", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expires_date\": \"2018-02-22 22:22:22\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "Location of private link", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"html_location\": \"https://figshare.com/s/d5ec7a85bcd6dbe9d9b2\",\n \"location\": \"string\",\n \"token\": \"d5ec7a85bcd6dbe9d9b2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b12bf047-4798-410c-82a0-d22022895563", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expires_date\": \"2018-02-22 22:22:22\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb7ccaed-08b7-404b-91f7-98121d3807f3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expires_date\": \"2018-02-22 22:22:22\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ab6ec7e-b685-43e4-ac3b-a55c758b3a74", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expires_date\": \"2018-02-22 22:22:22\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fc301509-412e-4830-99f3-4603f42df829", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expires_date\": \"2018-02-22 22:22:22\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "263e20fa-e592-42dc-9c98-8168fdc49bcd", "name": "View collection private link", "request": { "name": "View collection private link", "description": { "content": "View existing private link for this collection", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "a384b632-815b-4b7a-a41a-7a1560a11427", "name": "OK. Collection private link", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"expires_date\": \"2015-07-03T00:00:00\",\n \"html_location\": \"https://figshare.com/s/d5ec7a85bcd6dbe9d9b2\",\n \"id\": \"0cfb0dbeac92df445df4aba45f63fdc85fa0b9a888b64e157ce3c93b576aa300fb3621ef3a219515dd482\",\n \"is_active\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b29b70f-277a-4a80-a1de-e60199148522", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d9a6e3a2-ef46-40db-b25a-416b9d5c2dfb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abaf9867-98c6-40c3-85ad-8976811e5218", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "65d4c5ff-86be-42fa-a1f8-c6382c82b45a", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "326dd040-2ca9-43cc-9ab0-e0fb8080a41b", "name": "Update collection private link", "request": { "name": "Update collection private link", "description": { "content": "Update existing private link for this collection", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] }, "body": { "mode": "raw", "raw": "{\n \"expires_date\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f5a821b9-6554-4c2f-8727-7b2f23b5a76f", "name": "Reset Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"expires_date\": \"2018-02-22 22:22:22\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Reset Content", "code": 205, "header": [ { "disabled": false, "description": "Location of new private link", "key": "Location", "value": "string" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5d9a33d9-a843-423a-a2e3-432fb316ac7b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"expires_date\": \"2018-02-22 22:22:22\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc087cff-cbc1-4583-bcc1-7be377c1ec07", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"expires_date\": \"2018-02-22 22:22:22\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2893412-0069-47a2-85ad-20b3d7ebfc1c", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"expires_date\": \"2018-02-22 22:22:22\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59042979-1bc2-4179-b132-3e3d456ad967", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"expires_date\": \"2018-02-22 22:22:22\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "15549204-edff-4403-912f-c33cea768be2", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"expires_date\": \"2018-02-22 22:22:22\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e52a1dba-9326-4123-877d-d344152341ba", "name": "Disable private link", "request": { "name": "Disable private link", "description": { "content": "Disable/delete private link for this collection", "type": "text/plain" }, "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "all" }, { "key": "accessTokenUrl", "value": "https://api.figshare.com/v2/token" }, { "key": "authUrl", "value": "https://figshare.com/account/applications/authorize" }, { "key": "grant_type", "value": "authorization_code" } ] } }, "response": [ { "id": "e730c947-e15a-4343-9500-25a488e190ec", "name": "No Content", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8e6304cc-74c8-4844-8a0f-dbed3b4897a0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f6f583f0-2775-4c5b-a875-b3c021684098", "name": "Forbidden", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 712,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d8ad3b3-788f-4c07-94e2-07220765d201", "name": "Not Found", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "78e5c894-601d-44c8-b0c8-e8e4fe69ec43", "name": "Internal Server Error", "originalRequest": { "url": { "path": [ "account", "collections", ":collection_id", "private_links", ":link_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "collection_id", "description": "(Required) Collection unique identifier" }, { "disabled": false, "type": "any", "value": "", "key": "link_id", "description": "(Required) Private link token" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "319763aa-fb3b-482e-a775-c73760648797", "name": "List collections", "request": { "name": "List collections", "description": {}, "url": { "path": [ "core", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "Zero-based page index" }, { "disabled": false, "key": "size", "value": "20", "description": "Page size" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/hal+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d4482771-9eaf-4bc4-a290-a8d0431ad2de", "name": "Paginated list of collections", "originalRequest": { "url": { "path": [ "core", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/hal+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "body": "{\n \"_embedded\": {},\n \"_links\": {\n \"key_0\": {\n \"href\": \"http://iFtfNCvBupViKfmXeigEsa.pgz+ghHiPqoH.GHZlJyK2pdsj\"\n },\n \"key_1\": {\n \"href\": \"http://fOplybKwyK.ohVwjXbdUT\"\n }\n },\n \"page\": {\n \"size\": 7196,\n \"totalElements\": 9624,\n \"totalPages\": 2123,\n \"number\": 2294\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3bdc782-693b-48f1-aae1-b6a6e509677e", "name": "Get a collection by UUID", "request": { "name": "Get a collection by UUID", "description": {}, "url": { "path": [ "core", "collections", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the DSpace object" } ] }, "header": [ { "key": "Accept", "value": "application/hal+json" } ], "method": "GET", "auth": null }, "response": [ { "id": "82fa7bc3-65bb-4fe2-81e1-a75dfe387c96", "name": "A single collection", "originalRequest": { "url": { "path": [ "core", "collections", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the DSpace object" } ] }, "header": [ { "key": "Accept", "value": "application/hal+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "body": "{\n \"id\": \"ef63857e-ea94-a316-af0b-5dc5f9ccd84b\",\n \"uuid\": \"75e846f6-d97f-adf1-74f4-6f80dd5e885c\",\n \"name\": \"string\",\n \"handle\": \"string\",\n \"metadata\": {\n \"key_0\": [\n {\n \"value\": \"string\",\n \"language\": \"string\",\n \"authority\": \"string\",\n \"confidence\": 9710,\n \"place\": 829\n },\n {\n \"value\": \"string\",\n \"language\": \"string\",\n \"authority\": \"string\",\n \"confidence\": 7544,\n \"place\": 7436\n }\n ]\n },\n \"type\": \"string\",\n \"_links\": {\n \"key_0\": {\n \"href\": \"https://LpCR.idmwm7tuvU-4YAvd+NK.9oE-yFdVRci3CAOhPCUzvYCalDfp\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2eb3d110-abcc-4179-838b-52ec09a9aeb0", "name": "Collection not found", "originalRequest": { "url": { "path": [ "core", "collections", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the DSpace object" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.figshare.com/v2", "key": "baseUrl" } ], "info": { "_postman_id": "b008192d-5192-4717-9629-02042974a58d", "name": "Figshare altmetric collections API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Figshare API v2 - Full REST API documentation for managing articles, collections, projects and more. Saved for the University of the Witwatersrand Open Data Vault, which is hosted on the Figshare platform; datasets are accessible programmatically via this public API.\n\nContact Support:\n Name: Figshare Support", "type": "text/plain" } } }