{ "opencollection": "1.0.0", "info": { "name": "Pure activity project API", "version": "5.35.3-4" }, "request": { "auth": { "type": "apikey", "key": "api-key", "value": "{{api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "project", "type": "folder" }, "items": [ { "info": { "name": "Lists all projects", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects", "params": [ { "name": "size", "value": "", "type": "query", "description": "Number of returned projects 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 project_getOrderings" } ] }, "docs": "Lists all projects in the Pure instance. If you need to filter the projects returned, see the POST version which supports additional filtering." }, { "info": { "name": "Create project", "type": "http" }, "http": { "method": "PUT", "url": "https://yonsei.elsevierpure.com/ws/api/projects", "body": { "type": "json", "data": "{}" } }, "docs": "Create project" }, { "info": { "name": "A list of allowed classified identifier types", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-classified-identifier-types" }, "docs": "Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of projects" }, { "info": { "name": "A list of allowed collaborator types", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-collaborator-types" }, "docs": "Get a list of allowed types for collaborators on projects" }, { "info": { "name": "Get allowed classifications for the custom-defined field associated with the project", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-custom-defined-field-values/:propertyName/classifications", "params": [ { "name": "propertyName", "value": "", "type": "path", "description": "PropertyName for the desired custom-defined field" } ] }, "docs": "Get allowed classifications for the custom-defined field associated with the project." }, { "info": { "name": "A list of allowed description types", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-description-types" }, "docs": "Get a list of allowed types for descriptions on projects" }, { "info": { "name": "A list of allowed document licenses", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-document-licenses" }, "docs": "Get a list of allowed document licenses for projects" }, { "info": { "name": "A list of allowed document types", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-document-types" }, "docs": "Get a list of allowed types for documents on projects" }, { "info": { "name": "A list of allowed image types", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-image-types" }, "docs": "Get a list of allowed image types that can be used for the 'images.type' attribute of projects" }, { "info": { "name": "A list of keyword group configurations", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/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://yonsei.elsevierpure.com/ws/api/projects/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 link types", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-link-types" }, "docs": "Get a list of allowed link types that can be used for the 'links.linkType' attribute of projects" }, { "info": { "name": "A list of allowed locales in localized strings", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-locales" }, "docs": "Get a list of allowed locales that can be used when submitting localized string entities." }, { "info": { "name": "A list of allowed nature types", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-nature-types" }, "docs": "Get a list of allowed nature types for projects" }, { "info": { "name": "A list of allowed participant roles", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-participant-roles" }, "docs": "Get a list of allowed roles for participant on projects" }, { "info": { "name": "A list of allowed project relation types", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-project-relation-types" }, "docs": "Get a list of allowed project relation types on projects" }, { "info": { "name": "A list of allowed project templates", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-templates" }, "docs": "Get a list of allowed templates that can be used for projects. Some of the templates that exists in the API specification may be disabled for the Pure installation." }, { "info": { "name": "A list of allowed project types", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-types" }, "docs": "Get a list of allowed types that can be used for the 'type' attribute of projects" }, { "info": { "name": "A list of allowed workflow steps", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/allowed-workflow-steps" }, "docs": "Get a list of allowed workflow steps that can be used for the 'workflow' attribute of projects" }, { "info": { "name": "A list of allowed discipline schemes", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/disciplines/allowed-discipline-schemes" }, "docs": "Get a list fo a allowed discipline schemes for projects" }, { "info": { "name": "A list of allowed disciplines for a specific discipline scheme", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/disciplines/:discipline-scheme/allowed-disciplines", "params": [ { "name": "discipline-scheme", "value": "", "type": "path", "description": "Identifier for the discipline scheme for project" }, { "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 projects" }, { "info": { "name": "Query operation for disciplines associated with projects", "type": "http" }, "http": { "method": "POST", "url": "https://yonsei.elsevierpure.com/ws/api/projects/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 projects in the Pure instance that matches the provided query." }, { "info": { "name": "Upload file to a specific project", "type": "http" }, "http": { "method": "PUT", "url": "https://yonsei.elsevierpure.com/ws/api/projects/file-uploads", "headers": [ { "name": "Content-Type", "value": "" } ] }, "docs": "Uploads file for the project" }, { "info": { "name": "Lists available orderings", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/orderings" }, "docs": "Lists all orderings available to the project endpoint. These values can be used by the order parameter." }, { "info": { "name": "Query operation for projects", "type": "http" }, "http": { "method": "POST", "url": "https://yonsei.elsevierpure.com/ws/api/projects/search", "body": { "type": "json", "data": "{}" } }, "docs": "Lists projects 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 project", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the desired project" } ] }, "docs": "Get project with specific UUID." }, { "info": { "name": "Update project", "type": "http" }, "http": { "method": "PUT", "url": "https://yonsei.elsevierpure.com/ws/api/projects/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the project to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update project with specific UUID." }, { "info": { "name": "Delete project", "type": "http" }, "http": { "method": "DELETE", "url": "https://yonsei.elsevierpure.com/ws/api/projects/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the project" } ] }, "docs": "Delete project with specific UUID." }, { "info": { "name": "Lock the content", "type": "http" }, "http": { "method": "POST", "url": "https://yonsei.elsevierpure.com/ws/api/projects/:uuid/actions/lock", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the content 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://yonsei.elsevierpure.com/ws/api/projects/:uuid/actions/unlock", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the content 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": "Get the application clusters for the project", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/:uuid/application-clusters", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the project" } ] }, "docs": "Get the application clusters for the project with the specified UUID." }, { "info": { "name": "Get the award clusters for the project", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/:uuid/award-clusters", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the project" } ] }, "docs": "Get the award clusters for the project with the specified UUID." }, { "info": { "name": "Lists all dependents to an project", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/:uuid/dependents", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the project" }, { "name": "verbose", "value": "", "type": "query", "description": "DEPRECATED - Parameter has no effect." } ] }, "docs": "Lists all dependents to an project 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 disciplines from the discipline scheme associated with the project", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/:uuid/disciplines/:discipline-scheme", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the desired project" }, { "name": "discipline-scheme", "value": "", "type": "path", "description": "Identifier for the discipline scheme" } ] }, "docs": "Get disciplines from the discipline scheme associated with the project with specific UUID." }, { "info": { "name": "Update disciplines from the discipline scheme associated with the project", "type": "http" }, "http": { "method": "PUT", "url": "https://yonsei.elsevierpure.com/ws/api/projects/:uuid/disciplines/:discipline-scheme", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the project 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 project with specific UUID." }, { "info": { "name": "Get file from the project", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/:uuid/files/:fileId", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the project" }, { "name": "fileId", "value": "", "type": "path", "description": "File id " } ] }, "docs": "Get file from the project" }, { "info": { "name": "Lists notes", "type": "http" }, "http": { "method": "GET", "url": "https://yonsei.elsevierpure.com/ws/api/projects/:uuid/notes", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the project 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 an project ordered by date (nulls last)" }, { "info": { "name": "Create note", "type": "http" }, "http": { "method": "PUT", "url": "https://yonsei.elsevierpure.com/ws/api/projects/:uuid/notes", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the project to add note to" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create note and associate it with the project" } ] } ], "bundled": true }