{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pure activity contract API",
    "version": "5.35.3-4"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api-key",
      "value": "{{api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "contract",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all contracts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts",
            "params": [
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned contracts 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 /contracts/orderings"
              }
            ]
          },
          "docs": "Lists all contracts in the Pure instance. If you need to filter the contracts returned, see the POST version which supports additional filtering."
        },
        {
          "info": {
            "name": "Create contract",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/contracts",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create contract"
        },
        {
          "info": {
            "name": "A list of allowed classified identifier types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/allowed-classified-identifier-types"
          },
          "docs": "Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of contracts"
        },
        {
          "info": {
            "name": "A list of allowed contract collaborator types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/allowed-collaborator-types"
          },
          "docs": "Get a list of allowed collaborator types that can be used for the 'type' attribute of contracts.collaborators"
        },
        {
          "info": {
            "name": "A list of allowed description types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/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": "/ws/api/contracts/allowed-document-licenses"
          },
          "docs": "Get a list of allowed license types for documents on activities"
        },
        {
          "info": {
            "name": "A list of allowed document types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/allowed-document-types"
          },
          "docs": "Get a list of allowed license types that can be used for the 'documents.type' attribute of contracts"
        },
        {
          "info": {
            "name": "A list of allowed document version types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/allowed-document-version-types"
          },
          "docs": "Get a list of allowed version types for documents on contract"
        },
        {
          "info": {
            "name": "A list of keyword group configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/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": "/ws/api/contracts/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": "/ws/api/contracts/allowed-link-types"
          },
          "docs": "Get a list of allowed link types that can be used for the 'links.linkType' attribute of contracts"
        },
        {
          "info": {
            "name": "A list of allowed locales in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/allowed-locales"
          },
          "docs": "Get a list of allowed locales that can be used when submitting localized string entities."
        },
        {
          "info": {
            "name": "A list of allowed person roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/allowed-persons-roles"
          },
          "docs": "Get a list of allowed person roles that can be used for the 'persons.role' attribute of the contract."
        },
        {
          "info": {
            "name": "A list of allowed reply values",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/allowed-replies"
          },
          "docs": "Get a list of allowed replies that can be used for the 'reply' attribute of contracts"
        },
        {
          "info": {
            "name": "A list of allowed requirement values",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/allowed-requirements"
          },
          "docs": "Get a list of allowed requirements that can be used for the 'requirement' attribute of contracts"
        },
        {
          "info": {
            "name": "A list of allowed contract types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/allowed-types"
          },
          "docs": "Get a list of allowed types that can be used for the 'type' attribute of contracts"
        },
        {
          "info": {
            "name": "A list of allowed workflow steps",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/allowed-workflow-steps"
          },
          "docs": "Get a list of allowed workflow steps that can be used for the 'workflow' attribute of contracts"
        },
        {
          "info": {
            "name": "Upload file for a specific contract",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/contracts/file-uploads",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ]
          },
          "docs": "Uploads file for the contract"
        },
        {
          "info": {
            "name": "Lists available orderings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/orderings"
          },
          "docs": "Lists all orderings available to the contracts endpoint. These values can be used by the order parameter when listing contracts."
        },
        {
          "info": {
            "name": "Query operation for contracts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/contracts/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists contracts 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 contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired contract"
              }
            ]
          },
          "docs": "Get contract with specific UUID."
        },
        {
          "info": {
            "name": "Update contract",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/contracts/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the contract to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update contract with specific UUID."
        },
        {
          "info": {
            "name": "Delete contract",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/ws/api/contracts/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the contract"
              }
            ]
          },
          "docs": "Delete contract with specific UUID."
        },
        {
          "info": {
            "name": "Lock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/contracts/: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": "/ws/api/contracts/: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 contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/:uuid/dependents",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the contract"
              },
              {
                "name": "verbose",
                "value": "",
                "type": "query",
                "description": "Default: false. Setting this to true will add links and names to the output but will also have a contract on performance. use with caution."
              }
            ]
          },
          "docs": "Lists all dependents to a contract 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 file from the contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/:uuid/files/:fileId",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the contract"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path",
                "description": "File id "
              }
            ]
          },
          "docs": "Get file from the contract"
        },
        {
          "info": {
            "name": "List contract milestones on an contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/:uuid/milestones",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the contract"
              }
            ]
          },
          "docs": "List contract milestones on an contract."
        },
        {
          "info": {
            "name": "Lists notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/contracts/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the student thesis 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 student thesis ordered by date (nulls last)"
        },
        {
          "info": {
            "name": "Create note",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/contracts/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the student thesis to add note to"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create note and associate it with a student thesis"
        }
      ]
    }
  ],
  "bundled": true
}