{ "opencollection": "1.0.0", "info": { "name": "Pure activity researchOutput API", "version": "5.35.3-4" }, "request": { "auth": { "type": "apikey", "key": "api-key", "value": "{{api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "researchOutput", "type": "folder" }, "items": [ { "info": { "name": "Lists all research outputs", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs", "params": [ { "name": "size", "value": "", "type": "query", "description": "Number of returned research outputs per request." }, { "name": "offset", "value": "", "type": "query", "description": "The offset for the returned list. 0 or null value is from the start" }, { "name": "order", "value": "", "type": "query", "description": "The order of the list, must be a value from /research-outputs/orderings" } ] }, "docs": "Lists all research outputs in the Pure instance. If you need to filter the research outputs returned, see the POST version which supports additional filtering." }, { "info": { "name": "Create research output", "type": "http" }, "http": { "method": "PUT", "url": "https://pure.qub.ac.uk/ws/api/research-outputs", "body": { "type": "json", "data": "{}" } }, "docs": "Create research output" }, { "info": { "name": "A list of allowed access types", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-additional-file-access-types" }, "docs": "Get a list of allowed access types for additional files on research outputs" }, { "info": { "name": "A list of allowed license types", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-additional-file-license-types" }, "docs": "Get a list of allowed license types for additional files on research outputs" }, { "info": { "name": "A list of allowed article processing charge currencies", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-article-processing-charge-currencies" }, "docs": "Get a list of allowed article processing charge currencies on research outputs" }, { "info": { "name": "A list of allowed contributor roles for the book anthology subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-book-anthology-contributor-roles" }, "docs": "Get a list of allowed roles for contributors on the book anthology subtype of research outputs" }, { "info": { "name": "A list of allowed description types for the book anthology subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-book-anthology-description-types" }, "docs": "Get a list of allowed description types on the book anthology subtype of research outputs" }, { "info": { "name": "A list of allowed case note sources", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-case-note-sources" }, "docs": "Get a list of allowed case note sources for select subtypes of research outputs" }, { "info": { "name": "A list of allowed categories", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-categories" }, "docs": "Get a list of allowed categories on research outputs" }, { "info": { "name": "A list of allowed contributor roles for the contribution to book anthology subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-contribution-to-book-anthology-contributor-roles" }, "docs": "Get a list of allowed roles for contributors on the contribution to book anthology subtype of research outputs" }, { "info": { "name": "A list of allowed description types for the contribution to book anthology subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-contribution-to-book-anthology-description-types" }, "docs": "Get a list of allowed description types on the contribution to book anthology subtype of research outputs" }, { "info": { "name": "A list of allowed contributor roles for the contribution to conference subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-contribution-to-conference-contributor-roles" }, "docs": "Get a list of allowed roles for contributors on the contribution to conference subtype of research outputs" }, { "info": { "name": "A list of allowed description types for the contribution to conference subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-contribution-to-conference-description-types" }, "docs": "Get a list of allowed description types on the contribution to conference subtype of research outputs" }, { "info": { "name": "A list of allowed contributor roles for the contribution to journal subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-contribution-to-journal-contributor-roles" }, "docs": "Get a list of allowed roles for contributors on the contribution to journal subtype of research outputs" }, { "info": { "name": "A list of allowed description types for the contribution to journal subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-contribution-to-journal-description-types" }, "docs": "Get a list of allowed description types on the contribution to journal subtype of research outputs" }, { "info": { "name": "A list of allowed contributor roles for the contribution to memorandum subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-contribution-to-memorandum-contributor-roles" }, "docs": "Get a list of allowed roles for contributors on the contribution to memorandum subtype of research outputs" }, { "info": { "name": "A list of allowed description types for the contribution to memorandum subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-contribution-to-memorandum-description-types" }, "docs": "Get a list of allowed description types on the contribution to memorandum subtype of research outputs" }, { "info": { "name": "A list of allowed contributor roles for the contribution to periodical subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-contribution-to-periodical-contributor-roles" }, "docs": "Get a list of allowed roles for contributors on the contribution to periodical subtype of research outputs" }, { "info": { "name": "A list of allowed description types for the contribution to periodical subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-contribution-to-periodical-description-types" }, "docs": "Get a list of allowed description types on the contribution to periodical subtype of research outputs" }, { "info": { "name": "A list of allowed contributor countries", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-contributor-countries" }, "docs": "Get a list of allowed countries for contributors on research outputs" }, { "info": { "name": "A list of allowed countries", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-countries" }, "docs": "Get a list of allowed countries that can be used for the 'countries' attribute of research outputs" }, { "info": { "name": "Get allowed classifications for the custom-defined field associated with the research output", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-custom-defined-field-values/:fieldIdentifer/classifications", "params": [ { "name": "fieldIdentifer", "value": "", "type": "path", "description": "FieldIdentifer for the desired custom-defined field" } ] }, "docs": "Get allowed classifications for the custom-defined field associated with the research output." }, { "info": { "name": "A list of allowed access types", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-electronic-version-access-types" }, "docs": "Get a list of allowed access types for electronic versions on research outputs" }, { "info": { "name": "A list of allowed license types", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-electronic-version-license-types" }, "docs": "Get a list of allowed license types for electronic versions on research outputs" }, { "info": { "name": "A list of allowed version types", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-electronic-version-version-types" }, "docs": "Get a list of allowed version types for electronic versions on research outputs" }, { "info": { "name": "A list of allowed image types", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-image-types" }, "docs": "Get a list of allowed image types that can be used for the 'images.type' attribute of research output" }, { "info": { "name": "A list of keyword group configurations", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-keyword-group-configurations" }, "docs": "Get a list of allowed keyword group configurations that can be used when submitting keyword groups." }, { "info": { "name": "A list of allowed classifications for the specified keyword group", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-keyword-group-configurations/:id/classifications", "params": [ { "name": "id", "value": "", "type": "path", "description": "Pure id of the keyword group configuration" } ] }, "docs": "Get a list of allowed classifications that can be used when submitting a specified keyword group." }, { "info": { "name": "A list of allowed languages", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-languages" }, "docs": "Get a list of allowed languages on research outputs" }, { "info": { "name": "A list of allowed link types", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-link-types" }, "docs": "Get a list of allowed link types on research outputs" }, { "info": { "name": "A list of allowed locales in localized strings", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-locales" }, "docs": "Get a list of allowed locales that can be used when submitting localized string entities." }, { "info": { "name": "A list of allowed main research areas", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-main-research-areas" }, "docs": "Get a list of allowed main research areas on research outputs" }, { "info": { "name": "A list of allowed contributor roles for the memorandum subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-memorandum-contributor-roles" }, "docs": "Get a list of allowed roles for contributors on the memorandum subtype of research outputs" }, { "info": { "name": "A list of allowed description types for the memorandum subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-memorandum-description-types" }, "docs": "Get a list of allowed description types on the memorandum subtype of research outputs" }, { "info": { "name": "A list of allowed metric collections", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-metric-collections" }, "docs": "Get a list of metric collections allowed on research outputs" }, { "info": { "name": "A list of allowed contributor roles for the non-textual subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-non-textual-contributor-roles" }, "docs": "Get a list of allowed roles for contributors on the non-textual subtype of research outputs" }, { "info": { "name": "A list of allowed description types for the non-textual subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-non-textual-description-types" }, "docs": "Get a list of allowed description types on the non-textual subtype of research outputs" }, { "info": { "name": "A list of allowed contributor roles for the other contribution subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-other-contribution-contributor-roles" }, "docs": "Get a list of allowed roles for contributors on the other contribution subtype of research outputs" }, { "info": { "name": "A list of allowed description types for the other contribution subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-other-contribution-description-types" }, "docs": "Get a list of allowed description types on the other contribution subtype of research outputs" }, { "info": { "name": "A list of allowed output medias", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-output-medias" }, "docs": "Get a list of allowed output medias for the non-textual subtype of research outputs" }, { "info": { "name": "A list of allowed contributor roles for the patent subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-patent-contributor-roles" }, "docs": "Get a list of allowed roles for contributors on the patent subtype of research outputs" }, { "info": { "name": "A list of allowed description types for the patent subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-patent-description-types" }, "docs": "Get a list of allowed description types on the patent subtype of research outputs" }, { "info": { "name": "A list of peer review configurations", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-peer-review-configurations" }, "docs": "Get a list of peer review configurations that describe the allowed combinations of values for the interrelated fields: type, category, peerReview, and internationalPeerReview" }, { "info": { "name": "A list of allowed publication statuses", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-publication-statuses" }, "docs": "Get a list of allowed publication statuses on research output" }, { "info": { "name": "A list of allowed qualifications", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-qualifications" }, "docs": "Get a list of allowed qualifications for the thesis subtype of research outputs" }, { "info": { "name": "A list of allowed supervisor roles", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-supervisor-roles" }, "docs": "Get a list of allowed supervisors roles for the thesis subtype of research outputs" }, { "info": { "name": "A list of allowed research output templates", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-templates" }, "docs": "Get a list of allowed templates that can be used for research outputs, such as 'ContributionToJournal' or 'BookAnthology'. Some of the templates that exists in the API specification may be disabled for the Pure installation." }, { "info": { "name": "A list of allowed contributor roles for the thesis subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-thesis-contributor-roles" }, "docs": "Get a list of allowed roles for contributors on the thesis subtype of research outputs" }, { "info": { "name": "A list of allowed description types for the thesis subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-thesis-description-types" }, "docs": "Get a list of allowed description types on the thesis subtype of research outputs" }, { "info": { "name": "A list of allowed research output types", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-types" }, "docs": "Get a list of allowed types that can be used for the 'type' attribute of research outputs" }, { "info": { "name": "A list of allowed workflow steps", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-workflow-steps" }, "docs": "Get a list of allowed workflow steps that can be used for the 'workflow' attribute of research outputs" }, { "info": { "name": "A list of allowed contributor roles for the working paper subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-working-paper-contributor-roles" }, "docs": "Get a list of allowed roles for contributors on the working paper subtype of research outputs" }, { "info": { "name": "A list of allowed description types for the working paper subtype", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/allowed-working-paper-description-types" }, "docs": "Get a list of allowed description types on the working paper subtype of research outputs" }, { "info": { "name": "A list of allowed discipline schemes", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/disciplines/allowed-discipline-schemes" }, "docs": "Get a list fo a allowed discipline schemes for research outputs" }, { "info": { "name": "A list of allowed disciplines for a specific discipline scheme", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/disciplines/:discipline-scheme/allowed-disciplines", "params": [ { "name": "discipline-scheme", "value": "", "type": "path", "description": "Identifier for the discipline scheme for research output" }, { "name": "size", "value": "", "type": "query", "description": "Number of returned disciplines per request" }, { "name": "offset", "value": "", "type": "query", "description": "The offset for the returned list. 0 or null value is from the start" } ] }, "docs": "Get a list of a allowed disciplines for specific discipline scheme for research outputs" }, { "info": { "name": "Query operation for disciplines associated with research outputs", "type": "http" }, "http": { "method": "POST", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/disciplines/:discipline-scheme/search", "params": [ { "name": "discipline-scheme", "value": "", "type": "path", "description": "Identifier for the discipline scheme" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Lists disciplines from the discipline scheme associated with research outputs in the Pure instance that matches the provided query." }, { "info": { "name": "Upload file to a specific research output", "type": "http" }, "http": { "method": "PUT", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/file-uploads", "headers": [ { "name": "Content-Type", "value": "" } ] }, "docs": "Uploads file for the research output" }, { "info": { "name": "Lists available orderings", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/orderings" }, "docs": "Lists all orderings available to the research output endpoint. These values can be used by the order parameter." }, { "info": { "name": "Query operation for research outputs", "type": "http" }, "http": { "method": "POST", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/search", "body": { "type": "json", "data": "{}" } }, "docs": "Lists research outputs in the Pure instance that matches the provided query, similar to the GET version, instead of using parameters to alter the response, an JSON document is posted with the request. The JSON document contains fields for all the parameters available for the GET version, but also additional filtering options." }, { "info": { "name": "Get research output", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the desired research output" } ] }, "docs": "Get research output with specific UUID." }, { "info": { "name": "Update research output", "type": "http" }, "http": { "method": "PUT", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the research output to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update research output with specific UUID." }, { "info": { "name": "Delete research output", "type": "http" }, "http": { "method": "DELETE", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the research output" } ] }, "docs": "Delete research output with specific UUID." }, { "info": { "name": "Lock the content", "type": "http" }, "http": { "method": "POST", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/:uuid/actions/lock", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the research output to lock" } ] }, "docs": "Mark the content as external (used when content contains synchronised data). This has no effect on interactions with the content through the API." }, { "info": { "name": "Unlock the content", "type": "http" }, "http": { "method": "POST", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/:uuid/actions/unlock", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the research output to unlock" } ] }, "docs": "Remove the external mark on the content (used when content contains synchronised data). This has no effect on interactions with the content through the API." }, { "info": { "name": "Lists all dependents to a research output", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/:uuid/dependents", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the research output" }, { "name": "verbose", "value": "", "type": "query", "description": "DEPRECATED - Parameter has no effect." } ] }, "docs": "Lists all dependents to a research output with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. " }, { "info": { "name": "Get disciplinesfrom the discipline scheme associated with the research output", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/:uuid/disciplines/:discipline-scheme", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the desired research output" }, { "name": "discipline-scheme", "value": "", "type": "path", "description": "Identifier for the discipline scheme" } ] }, "docs": "Get disciplines from the discipline scheme associated with the research output with specific UUID." }, { "info": { "name": "Update disciplines from the discipline scheme associated with the research output", "type": "http" }, "http": { "method": "PUT", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/:uuid/disciplines/:discipline-scheme", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the research output to update" }, { "name": "discipline-scheme", "value": "", "type": "path", "description": "Identifier for the discipline scheme" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update disciplines from the discipline scheme associated with the research output with specific UUID." }, { "info": { "name": "Get file from the research output", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/:uuid/files/:fileId", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the research output" }, { "name": "fileId", "value": "", "type": "path", "description": "File id " } ] }, "docs": "Get file from the research output" }, { "info": { "name": "Get the fingerprints for the research output", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/:uuid/fingerprints", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the research output" } ] }, "docs": "Get the fingerprints for the research output with the specified UUID." }, { "info": { "name": "Lists metrics with collection id", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/:uuid/metrics/:collection-id", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the research output to get metrics for" }, { "name": "collection-id", "value": "", "type": "path", "description": "ID of the metrics collection to get metrics for" } ] }, "docs": "Lists metrics from a specific metrics collection that associated with a research output." }, { "info": { "name": "Lists notes", "type": "http" }, "http": { "method": "GET", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/:uuid/notes", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the research output to get notes for" }, { "name": "size", "value": "", "type": "query", "description": "Number of returned notes per request" }, { "name": "offset", "value": "", "type": "query", "description": "The offset for the returned list. 0 or null value is from the start" } ] }, "docs": "Lists notes associated with a research output ordered by date (nulls last)" }, { "info": { "name": "Create note", "type": "http" }, "http": { "method": "PUT", "url": "https://pure.qub.ac.uk/ws/api/research-outputs/:uuid/notes", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the research output to add note to" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create note and associate it with a research output" } ] } ], "bundled": true }