{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pure activity event API",
    "version": "5.33.3-3"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api-key",
      "value": "{{api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "event",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events",
            "params": [
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned events 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 /events/orderings"
              }
            ]
          },
          "docs": "Lists all events in the Pure instance. If you need to filter the events returned, see the POST version which supports additional filtering."
        },
        {
          "info": {
            "name": "Create event",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/events",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create event"
        },
        {
          "info": {
            "name": "A list of allowed classified identifier types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/allowed-classified-identifier-types"
          },
          "docs": "Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of events"
        },
        {
          "info": {
            "name": "A list of allowed countries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/allowed-countries"
          },
          "docs": "Get a list of allowed countries that can be used for the 'country' attribute of events"
        },
        {
          "info": {
            "name": "A list of allowed degree of recognitions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/allowed-degree-of-recognition"
          },
          "docs": "Get a list of allowed degree of recognitions that can be used for the 'degreeOfRecognition' attribute of events"
        },
        {
          "info": {
            "name": "A list of keyword group configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/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/events/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/events/allowed-link-types"
          },
          "docs": "Get a list of allowed link types that can be used for the 'links.linkType' attribute of events"
        },
        {
          "info": {
            "name": "A list of allowed locales in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/allowed-locales"
          },
          "docs": "Get a list of allowed locales that can be used when submitting localized string entities."
        },
        {
          "info": {
            "name": "A list of allowed subdivisions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/allowed-subdivision"
          },
          "docs": "Get a list of allowed subdivisions can be used for the 'subdivision' attribute of events"
        },
        {
          "info": {
            "name": "A list of allowed event types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/allowed-types"
          },
          "docs": "Get a list of allowed types that can be used for the 'type' attribute of events"
        },
        {
          "info": {
            "name": "A list of allowed workflow steps",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/allowed-workflow-steps"
          },
          "docs": "Get a list of allowed workflow steps that can be used for the 'workflow' attribute of events"
        },
        {
          "info": {
            "name": "A list of allowed discipline schemes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/disciplines/allowed-discipline-schemes"
          },
          "docs": "Get a list fo a allowed discipline schemes for events"
        },
        {
          "info": {
            "name": "A list of allowed disciplines for a specific discipline scheme",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/disciplines/:discipline-scheme/allowed-disciplines",
            "params": [
              {
                "name": "discipline-scheme",
                "value": "",
                "type": "path",
                "description": "Identifier for the discipline scheme for events"
              },
              {
                "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 events"
        },
        {
          "info": {
            "name": "Query operation for disciplines associated with events",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/events/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 events in the Pure instance that matches the provided query."
        },
        {
          "info": {
            "name": "Lists available orderings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/orderings"
          },
          "docs": "Lists all orderings available to the event endpoint. These values can be used by the order parameter."
        },
        {
          "info": {
            "name": "Query operation for events",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/events/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists events 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 event",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired event"
              }
            ]
          },
          "docs": "Get event with specific UUID."
        },
        {
          "info": {
            "name": "Update event",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/events/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the event to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update event with specific UUID."
        },
        {
          "info": {
            "name": "Delete event",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/ws/api/events/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the event"
              }
            ]
          },
          "docs": "Delete event with specific UUID."
        },
        {
          "info": {
            "name": "Lock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/events/: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/events/: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 event",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/:uuid/disciplines/:discipline-scheme",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired event"
              },
              {
                "name": "discipline-scheme",
                "value": "",
                "type": "path",
                "description": "Identifier for the discipline scheme"
              }
            ]
          },
          "docs": "Get disciplines from the discipline scheme  associated with the event with specific UUID."
        },
        {
          "info": {
            "name": "Update disciplines from the discipline scheme associated with the event",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/events/:uuid/disciplines/:discipline-scheme",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the event 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 event with specific UUID."
        },
        {
          "info": {
            "name": "Lists notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/events/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the event 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 event ordered by date (nulls last)"
        },
        {
          "info": {
            "name": "Create note",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/events/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the event to add note to"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create note and associate it with an event"
        }
      ]
    }
  ],
  "bundled": true
}