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