{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pure activity impact API",
    "version": "5.35.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api-key",
      "value": "{{api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "impact",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all impacts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts",
            "params": [
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned impact 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 /impacts/orderings"
              }
            ]
          },
          "docs": "Lists all impacts in the Pure instance. If you need to filter the impact returned, see the POST version which supports additional filtering."
        },
        {
          "info": {
            "name": "Create impact",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create impact"
        },
        {
          "info": {
            "name": "A list of allowed classified identifier types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-classified-identifier-types"
          },
          "docs": "Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of impact"
        },
        {
          "info": {
            "name": "Get allowed classifications for the custom-defined field associated with the impact",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/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 impact."
        },
        {
          "info": {
            "name": "A list of allowed classifications for the descriptions property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-description-types"
          },
          "docs": "Get a list of classifications that can be used when submitting a description."
        },
        {
          "info": {
            "name": "A list of allowed document licenses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-document-licenses"
          },
          "docs": "Get a list of allowed license types that can be used for the 'documents.license' attribute of impacts"
        },
        {
          "info": {
            "name": "A list of allowed document types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-document-types"
          },
          "docs": "Get a list of allowed license types that can be used for the 'documents.type' attribute of impacts"
        },
        {
          "info": {
            "name": "A list of allowed image types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-image-types"
          },
          "docs": "Get a list of allowed image types that can be used for the 'images.type' attribute of impact"
        },
        {
          "info": {
            "name": "A list of allowed impact categories",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-impact-categories"
          },
          "docs": "Get a list of allowed categories for impacts"
        },
        {
          "info": {
            "name": "A list of allowed impact evidence indicators",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-impact-evidence-indicators"
          },
          "docs": "Get a list of allowed indicators for impact evidence"
        },
        {
          "info": {
            "name": "A list of allowed impact levels",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-impact-levels"
          },
          "docs": "Get a list of levels for impact"
        },
        {
          "info": {
            "name": "A list of allowed impact types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-impact-status"
          },
          "docs": "Get a list of allowed types that can be used for the 'type' attribute of impact"
        },
        {
          "info": {
            "name": "A list of keyword group configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/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://scholars.hkbu.edu.hk/ws/api/impacts/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://scholars.hkbu.edu.hk/ws/api/impacts/allowed-link-types"
          },
          "docs": "Get a list of allowed link types that can be used for the 'links.linkType' attribute of impacts"
        },
        {
          "info": {
            "name": "A list of allowed locales in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-locales"
          },
          "docs": "Get a list of allowed locales that can be used when submitting localized string entities."
        },
        {
          "info": {
            "name": "A list of allowed impact persons countries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-persons-countries"
          },
          "docs": "Get a list of countries for impact persons"
        },
        {
          "info": {
            "name": "A list of allowed persons roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-persons-roles"
          },
          "docs": "Get a list of allowed persons roles"
        },
        {
          "info": {
            "name": "A list of allowed impact types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-types"
          },
          "docs": "Get a list of allowed types that can be used for the 'type' attribute of impact"
        },
        {
          "info": {
            "name": "A list of allowed workflow steps in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/allowed-workflow-steps"
          },
          "docs": "Get a list of allowed workflow steps."
        },
        {
          "info": {
            "name": "A list of allowed discipline schemes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/disciplines/allowed-discipline-schemes"
          },
          "docs": "Get a list fo a allowed discipline schemes for impacts"
        },
        {
          "info": {
            "name": "A list of allowed disciplines for a specific discipline scheme",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/disciplines/:discipline-scheme/allowed-disciplines",
            "params": [
              {
                "name": "discipline-scheme",
                "value": "",
                "type": "path",
                "description": "Identifier for the discipline scheme for impacts"
              },
              {
                "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 impacts"
        },
        {
          "info": {
            "name": "Query operation for disciplines associated with impacts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/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 impacts in the Pure instance that matches the provided query."
        },
        {
          "info": {
            "name": "Upload file to a specific impact",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/file-uploads",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ]
          },
          "docs": "Uploads file for the impact"
        },
        {
          "info": {
            "name": "Query operation for impact",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists impact 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 impact",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired impact"
              }
            ]
          },
          "docs": "Get impact with specific UUID."
        },
        {
          "info": {
            "name": "Update impact",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the impact to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update impact with specific UUID."
        },
        {
          "info": {
            "name": "Delete impact",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the impact"
              }
            ]
          },
          "docs": "Delete impact with specific UUID."
        },
        {
          "info": {
            "name": "Lock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/: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://scholars.hkbu.edu.hk/ws/api/impacts/: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": "Lists all dependents to an impact",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/:uuid/dependents",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the impact"
              },
              {
                "name": "verbose",
                "value": "",
                "type": "query",
                "description": "Default: false. Setting this to true will add links and names to the output but will also have an impact on performance. use with caution."
              }
            ]
          },
          "docs": "Lists all dependents to an impact 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 impact",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/:uuid/disciplines/:discipline-scheme",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired impact"
              },
              {
                "name": "discipline-scheme",
                "value": "",
                "type": "path",
                "description": "Identifier for the discipline scheme"
              }
            ]
          },
          "docs": "Get disciplines from the discipline scheme associated with the impact with specific UUID."
        },
        {
          "info": {
            "name": "Update disciplines from the discipline scheme associated with the impact",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/:uuid/disciplines/:discipline-scheme",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the impact 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 impact with specific UUID."
        },
        {
          "info": {
            "name": "Get file from the impact",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/:uuid/files/:fileId",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the impact"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path",
                "description": "File id "
              }
            ]
          },
          "docs": "Get file from the impact"
        },
        {
          "info": {
            "name": "Lists notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the impact 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 impact ordered by date (nulls last)"
        },
        {
          "info": {
            "name": "Create note",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://scholars.hkbu.edu.hk/ws/api/impacts/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the impact to add note to"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create note and associate it with the impact"
        }
      ]
    }
  ],
  "bundled": true
}