{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pure activity API",
    "version": "5.33.3-3"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api-key",
      "value": "{{api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "activity",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all activities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities",
            "params": [
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned activities 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 /activities/orderings"
              }
            ]
          },
          "docs": "Lists all activities in the Pure instance. If you need to filter the activities returned, see the POST version which supports additional filtering."
        },
        {
          "info": {
            "name": "Create activity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/activities",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create activity"
        },
        {
          "info": {
            "name": "A list of allowed attendance activity person roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-attendance-person-roles"
          },
          "docs": "Get a list of allowed roles for persons on attendance activities"
        },
        {
          "info": {
            "name": "A list of allowed categories",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-categories"
          },
          "docs": "Get a list of allowed categories for activities"
        },
        {
          "info": {
            "name": "A list of allowed classified identifier types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-classified-identifier-types"
          },
          "docs": "Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of activities"
        },
        {
          "info": {
            "name": "A list of allowed  consultancy activity person roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-consultancy-person-roles"
          },
          "docs": "Get a list of allowed roles for persons on consultancy activities"
        },
        {
          "info": {
            "name": "Get allowed classifications for the custom-defined field associated with the activity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/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 activity."
        },
        {
          "info": {
            "name": "A list of allowed degree of recognitions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-degree-of-recognitions"
          },
          "docs": "Get a list of allowed degree of recognitions on activities"
        },
        {
          "info": {
            "name": "A list of allowed description types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-description-types"
          },
          "docs": "Get a list of allowed types for descriptions on activities"
        },
        {
          "info": {
            "name": "A list of allowed document licenses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/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/activities/allowed-document-types"
          },
          "docs": "Get a list of allowed types for documents on activities"
        },
        {
          "info": {
            "name": "A list of allowed editorial-work activity person roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-editorial-work-person-roles"
          },
          "docs": "Get a list of allowed roles for persons on editorial-work activities"
        },
        {
          "info": {
            "name": "A list of allowed examination activity person roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-examination-person-roles"
          },
          "docs": "Get a list of allowed roles for persons on examination activities"
        },
        {
          "info": {
            "name": "A list of allowed host visitor countries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-host-visitor-countries"
          },
          "docs": "Get a list of allowed countries host visitor activities"
        },
        {
          "info": {
            "name": "A list of allowed host-visitor activity person roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-host-visitor-person-roles"
          },
          "docs": "Get a list of allowed roles for persons on host visitor activities"
        },
        {
          "info": {
            "name": "A list of allowed image types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-image-types"
          },
          "docs": "Get a list of allowed image types that can be used for the 'images.type' attribute of activities"
        },
        {
          "info": {
            "name": "A list of allowed activity indicators",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-indicators"
          },
          "docs": "Get a list of allowed indicators on activities"
        },
        {
          "info": {
            "name": "A list of keyword group configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/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/activities/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/activities/allowed-link-types"
          },
          "docs": "Get a list of allowed link types on activities"
        },
        {
          "info": {
            "name": "A list of allowed locales in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-locales"
          },
          "docs": "Get a list of allowed locales that can be used when submitting localized string entities."
        },
        {
          "info": {
            "name": "A list of allowed membership activity person roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-membership-person-roles"
          },
          "docs": "Get a list of allowed roles for persons on membership activities"
        },
        {
          "info": {
            "name": "A list of allowed other activity person roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-other-activity-person-roles"
          },
          "docs": "Get a list of allowed roles for persons on other activities"
        },
        {
          "info": {
            "name": "A list of allowed talk activity person roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-talk-person-roles"
          },
          "docs": "Get a list of allowed roles for persons on talk activities"
        },
        {
          "info": {
            "name": "A list of allowed activity types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-types"
          },
          "docs": "Get a list of allowed types that can be used for the 'type' attribute of activities"
        },
        {
          "info": {
            "name": "A list of allowed visit-other activity person roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/allowed-visit-other-person-roles"
          },
          "docs": "Get a list of allowed roles for persons on visit-other activities"
        },
        {
          "info": {
            "name": "A list of allowed workflow steps in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/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": "/ws/api/activities/disciplines/allowed-discipline-schemes"
          },
          "docs": "Get a list fo a allowed discipline schemes for activities"
        },
        {
          "info": {
            "name": "A list of allowed disciplines for a specific discipline scheme",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/disciplines/:discipline-scheme/allowed-disciplines",
            "params": [
              {
                "name": "discipline-scheme",
                "value": "",
                "type": "path",
                "description": "Identifier for the discipline scheme for activities"
              },
              {
                "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 activities"
        },
        {
          "info": {
            "name": "Query operation for disciplines associated with activities",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/activities/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 activities in the Pure instance that matches the provided query."
        },
        {
          "info": {
            "name": "Upload file to a specific activity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/activities/file-uploads",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ]
          },
          "docs": "Uploads file for the activity"
        },
        {
          "info": {
            "name": "Lists available orderings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/orderings"
          },
          "docs": "Lists all orderings available to the activities endpoint. These values can be used by the order parameter when listing activities."
        },
        {
          "info": {
            "name": "Query operation for activities",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/activities/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists activities 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 activity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired activity"
              }
            ]
          },
          "docs": "Get activity with specific UUID."
        },
        {
          "info": {
            "name": "Update an activity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/activities/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the activity to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an activity with specific UUID."
        },
        {
          "info": {
            "name": "Delete activity",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/ws/api/activities/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the activity"
              }
            ]
          },
          "docs": "Delete activity with specific UUID."
        },
        {
          "info": {
            "name": "Lock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/activities/: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/activities/: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 disciplines from the discipline scheme associated with the activity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/:uuid/disciplines/:discipline-scheme",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired activity"
              },
              {
                "name": "discipline-scheme",
                "value": "",
                "type": "path",
                "description": "Identifier for the discipline scheme"
              }
            ]
          },
          "docs": "Get disciplines from the discipline scheme associated with the activity with specific UUID."
        },
        {
          "info": {
            "name": "Update disciplines from the discipline scheme associated with the activity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/activities/:uuid/disciplines/:discipline-scheme",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the activity 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 activity with specific UUID."
        },
        {
          "info": {
            "name": "Get file from the activity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/:uuid/files/:fileId",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the activity"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path",
                "description": "File id "
              }
            ]
          },
          "docs": "Get file from the activity"
        },
        {
          "info": {
            "name": "Lists notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/activities/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the activity 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 activity ordered by date (nulls last)"
        },
        {
          "info": {
            "name": "Create note",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/activities/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the activity to add note to"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create note and associate it with an activity"
        }
      ]
    }
  ],
  "bundled": true
}