{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pure activity organization API",
    "version": "5.35.3-4"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api-key",
      "value": "{{api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "organization",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all organizations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations",
            "params": [
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned organizations 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 /organizations/orderings"
              }
            ]
          },
          "docs": "Lists all organizations in the Pure instance. If you need to filter the organizations returned, see the POST version which supports additional filtering."
        },
        {
          "info": {
            "name": "Create organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/organizations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create organization"
        },
        {
          "info": {
            "name": "A list of allowed address countries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-address-countries"
          },
          "docs": "Get a list of allowed countries that can be used for the 'addresses.country' attribute of organizations"
        },
        {
          "info": {
            "name": "A list of allowed address subdivisions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-address-subdivision"
          },
          "docs": "Get a list of allowed subdivisions that can be used for the 'addresses.subdivisions' attribute of organizations"
        },
        {
          "info": {
            "name": "A list of allowed address types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-address-types"
          },
          "docs": "Get a list of allowed address types that can be used for the 'addresses.type' attribute of organizations"
        },
        {
          "info": {
            "name": "DEPRECATED - use 'allowed-photo-types' - A list of allowed classified identifier types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-classified-file-types"
          },
          "docs": "DEPRECATED - use 'allowed-photo-types' - Get a list of allowed classified photo types that can be used for the 'photos.type' attribute of organizations"
        },
        {
          "info": {
            "name": "A list of allowed classified identifier types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-classified-identifier-types"
          },
          "docs": "Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of organizations"
        },
        {
          "info": {
            "name": "A list of allowed cost centers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-cost-centers"
          },
          "docs": "Get a list of allowed cost centers that can be used for the 'costCenters' attribute of organizations"
        },
        {
          "info": {
            "name": "Get allowed classifications for the custom-defined field associated with the organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/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 organization."
        },
        {
          "info": {
            "name": "A list of allowed e-mail types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-email-types"
          },
          "docs": "Get a list of allowed e-mail types that can be used for the 'emails.type' attribute of organizations"
        },
        {
          "info": {
            "name": "A list of keyword group configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/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/organizations/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/organizations/allowed-link-types"
          },
          "docs": "Get a list of allowed link types on organizations"
        },
        {
          "info": {
            "name": "A list of allowed locales in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-locales"
          },
          "docs": "Get a list of allowed locales that can be used when submitting localized string entities."
        },
        {
          "info": {
            "name": "A list of allowed main research areas",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-main-research-areas"
          },
          "docs": "Get a list of allowed main research areas on organizations"
        },
        {
          "info": {
            "name": "A list of allowed name variant types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-name-variant-types"
          },
          "docs": "Get a list of allowed name variant types that can be used for the 'nameVariants.type' attribute of organizations"
        },
        {
          "info": {
            "name": "A list of allowed phone number types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-phone-number-types"
          },
          "docs": "Get a list of allowed phone number types that can be used for the 'phoneNumbers.type' attribute of organizations"
        },
        {
          "info": {
            "name": "A list of allowed photo types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-photo-types"
          },
          "docs": "Get a list of allowed photo types that can be used for the 'photos.type' attribute of organizations"
        },
        {
          "info": {
            "name": "A list of allowed profile information types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-profile-information-types"
          },
          "docs": "Get a list of allowed profile information types that can be used for the 'profileInformations.type' attribute of organizations"
        },
        {
          "info": {
            "name": "A list of allowed organization types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-types"
          },
          "docs": "Get a list of allowed types that can be used for the 'type' attribute of organizations"
        },
        {
          "info": {
            "name": "A list of allowed web address types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/allowed-web-address-types"
          },
          "docs": "Get a list of allowed web address types that can be used for the 'webAddresses.type' attribute of organizations"
        },
        {
          "info": {
            "name": "A list of allowed discipline schemes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/disciplines/allowed-discipline-schemes"
          },
          "docs": "Get a list fo a allowed discipline schemes for organizations"
        },
        {
          "info": {
            "name": "A list of allowed disciplines for a specific discipline scheme",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/disciplines/:discipline-scheme/allowed-disciplines",
            "params": [
              {
                "name": "discipline-scheme",
                "value": "",
                "type": "path",
                "description": "Identifier for the discipline scheme for organizations"
              },
              {
                "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 organizations"
        },
        {
          "info": {
            "name": "Query operation for disciplines associated with organizations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/organizations/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 organizations in the Pure instance that matches the provided query."
        },
        {
          "info": {
            "name": "Upload file to a specific organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/organizations/file-uploads",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ]
          },
          "docs": "Uploads file for the organization"
        },
        {
          "info": {
            "name": "Lists available orderings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/orderings"
          },
          "docs": "Lists all orderings available to the organization endpoint. These values can be used by the order parameter."
        },
        {
          "info": {
            "name": "Query operation for organizations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/organizations/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists organizations 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 organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired organization"
              }
            ]
          },
          "docs": "Get organization with specific UUID."
        },
        {
          "info": {
            "name": "Update organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/organizations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the organization to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update organization with specific UUID."
        },
        {
          "info": {
            "name": "Delete organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/ws/api/organizations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the organization"
              }
            ]
          },
          "docs": "Delete organization with specific UUID."
        },
        {
          "info": {
            "name": "Lock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/organizations/: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/organizations/: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 the organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/:uuid/dependents",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the organization"
              },
              {
                "name": "verbose",
                "value": "",
                "type": "query",
                "description": "DEPRECATED - Parameter has no effect."
              }
            ]
          },
          "docs": "Lists all dependents to the organization 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 organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/:uuid/disciplines/:discipline-scheme",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired organization"
              },
              {
                "name": "discipline-scheme",
                "value": "",
                "type": "path",
                "description": "Identifier for the discipline scheme"
              }
            ]
          },
          "docs": "Get disciplines from the discipline scheme associated with the organization with specific UUID."
        },
        {
          "info": {
            "name": "Update disciplines from the discipline scheme associated with the organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/organizations/:uuid/disciplines/:discipline-scheme",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the organization 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 organization with specific UUID."
        },
        {
          "info": {
            "name": "Get file from the organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/:uuid/files/:fileId",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the organization"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path",
                "description": "Id of the file"
              }
            ]
          },
          "docs": "Get file from the organization"
        },
        {
          "info": {
            "name": "Get the fingerprints for the organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/:uuid/fingerprints",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the organization"
              }
            ]
          },
          "docs": "Get the fingerprints for the organization with the specified UUID."
        },
        {
          "info": {
            "name": "Lists notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/organizations/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the organization 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 organization ordered by date (nulls last)"
        },
        {
          "info": {
            "name": "Create note",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/organizations/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the organization to add note to"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create note and associate it with an organization"
        }
      ]
    }
  ],
  "bundled": true
}