{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pure activity prize API",
    "version": "5.35.3-4"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api-key",
      "value": "{{api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "prize",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all prizes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes",
            "params": [
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned prizes 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 /prizes/orderings"
              }
            ]
          },
          "docs": "Lists all prizes in the Pure instance. If you need to filter the prizes returned, see the POST version which supports additional filtering."
        },
        {
          "info": {
            "name": "Create prize",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create prize"
        },
        {
          "info": {
            "name": "A list of allowed classifications for the category property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/allowed-categories"
          },
          "docs": "Get a list of classifications that can be used when submitting a category."
        },
        {
          "info": {
            "name": "A list of allowed classified identifier types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/allowed-classified-identifier-types"
          },
          "docs": "Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of prizes"
        },
        {
          "info": {
            "name": "Get allowed classifications for the custom-defined field associated with the prize",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/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 prize."
        },
        {
          "info": {
            "name": "A list of allowed classifications for the degree of recognition",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/allowed-degree-of-recognitions"
          },
          "docs": "Get a list of classifications that can be used when submitting a degree of recognition."
        },
        {
          "info": {
            "name": "A list of allowed classifications for the descriptions property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/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://pure.kfupm.edu.sa/ws/api/prizes/allowed-document-licenses"
          },
          "docs": "Get a list of allowed license types that can be used for the 'documents.license' attribute of prizes"
        },
        {
          "info": {
            "name": "A list of allowed document types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/allowed-document-types"
          },
          "docs": "Get a list of allowed license types that can be used for the 'documents.type' attribute of prizes"
        },
        {
          "info": {
            "name": "A list of allowed image types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/allowed-image-types"
          },
          "docs": "Get a list of allowed image types that can be used for the 'images.type' attribute of the prize."
        },
        {
          "info": {
            "name": "A list of keyword group configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/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/prizes/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/prizes/allowed-link-types"
          },
          "docs": "Get a list of allowed link types that can be used for the 'links.linkType' attribute of prizes"
        },
        {
          "info": {
            "name": "A list of allowed locales in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/allowed-locales"
          },
          "docs": "Get a list of allowed locales that can be used when submitting localized string entities."
        },
        {
          "info": {
            "name": "A list of allowed receiver of prize roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/allowed-receivers-of-prize-roles"
          },
          "docs": "Get a list of allowed receiver of prize roles that can be used for the 'receiversOfPrize.role' attribute of the prize."
        },
        {
          "info": {
            "name": "A list of allowed classifications for the type property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/allowed-types"
          },
          "docs": "Get a list of classifications that can be used when submitting a type."
        },
        {
          "info": {
            "name": "A list of allowed workflow steps",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/allowed-workflow-steps"
          },
          "docs": "Get a list of allowed workflow steps that can be used for the 'workflow' attribute of prizes"
        },
        {
          "info": {
            "name": "A list of allowed discipline schemes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/disciplines/allowed-discipline-schemes"
          },
          "docs": "Get a list of allowed discipline schemes for prizes"
        },
        {
          "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/prizes/disciplines/:discipline-scheme/allowed-disciplines",
            "params": [
              {
                "name": "discipline-scheme",
                "value": "",
                "type": "path",
                "description": "Identifier for the discipline scheme for prizes"
              },
              {
                "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 prizes"
        },
        {
          "info": {
            "name": "Query operation for disciplines associated with prizes",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/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 prizes in the Pure instance that matches the provided query."
        },
        {
          "info": {
            "name": "Upload file for a specific prize",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/file-uploads",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ]
          },
          "docs": "Uploads file for the prize"
        },
        {
          "info": {
            "name": "Lists available orderings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/orderings"
          },
          "docs": "Lists all orderings available to the prizes endpoint. These values can be used by the order parameter when listing prizes."
        },
        {
          "info": {
            "name": "Query operation for prizes",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists prizes 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 prize",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired prize"
              }
            ]
          },
          "docs": "Get prize with specific UUID."
        },
        {
          "info": {
            "name": "Update prize",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the prize to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update prize with specific UUID."
        },
        {
          "info": {
            "name": "Delete prize",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the prize"
              }
            ]
          },
          "docs": "Delete prize with specific UUID."
        },
        {
          "info": {
            "name": "Lock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/: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/prizes/: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 a prize",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/:uuid/dependents",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the prize"
              },
              {
                "name": "verbose",
                "value": "",
                "type": "query",
                "description": "DEPRECATED - Parameter has no effect."
              }
            ]
          },
          "docs": "Lists all dependents to a prize 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 prize",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/:uuid/disciplines/:discipline-scheme",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired prize"
              },
              {
                "name": "discipline-scheme",
                "value": "",
                "type": "path",
                "description": "Identifier for the discipline scheme"
              }
            ]
          },
          "docs": "Get disciplines from the discipline scheme associated with the prize with specific UUID."
        },
        {
          "info": {
            "name": "Update disciplines from the discipline scheme associated with the prize",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/:uuid/disciplines/:discipline-scheme",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the prize 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 prize with specific UUID."
        },
        {
          "info": {
            "name": "Get file from the prize",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/:uuid/files/:fileId",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the prize"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path",
                "description": "File id "
              }
            ]
          },
          "docs": "Get file from the prize"
        },
        {
          "info": {
            "name": "Lists notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the prize 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 prize ordered by date (nulls last)"
        },
        {
          "info": {
            "name": "Create note",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pure.kfupm.edu.sa/ws/api/prizes/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the prize to add note to"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create note and associate it with a prize"
        }
      ]
    }
  ],
  "bundled": true
}