{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pure activity externalOrganization API",
    "version": "5.35.1-2"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api-key",
      "value": "{{api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "externalOrganization",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all external organizations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations",
            "params": [
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned external 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 /external-organizations/orderings"
              }
            ]
          },
          "docs": "Lists all external organizations in the Pure instance. If you need to filter the external organizations returned, see the POST version which supports additional filtering."
        },
        {
          "info": {
            "name": "Create external organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/external-organizations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create external organization"
        },
        {
          "info": {
            "name": "A list of allowed address countries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/allowed-address-countries"
          },
          "docs": "Get a list of allowed countries that can be used for the 'address.country' attribute of external organizations"
        },
        {
          "info": {
            "name": "A list of allowed address subdivisions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/allowed-address-subdivision"
          },
          "docs": "Get a list of allowed subdivisions that can be used for the 'address.subdivisions' attribute of external organizations"
        },
        {
          "info": {
            "name": "A list of allowed classified identifier types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/allowed-classified-file-types"
          },
          "docs": "Get a list of allowed classified image types that can be used for the 'images.type' attribute of external organizations"
        },
        {
          "info": {
            "name": "A list of allowed classified identifier types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/allowed-classified-identifier-types"
          },
          "docs": "Get a list of allowed classified identifier types that can be used for the 'identifiers.type' attribute of external organizations"
        },
        {
          "info": {
            "name": "A list of allowed document licenses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/allowed-document-licenses"
          },
          "docs": "Get a list of allowed document licenses that can be used for the 'documents.license' attribute of external organizations"
        },
        {
          "info": {
            "name": "A list of allowed document types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/allowed-document-types"
          },
          "docs": "Get a list of allowed document types that can be used for the 'documents.type' attribute of external organizations"
        },
        {
          "info": {
            "name": "A list of keyword group configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-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/external-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/external-organizations/allowed-link-types"
          },
          "docs": "Get a list of allowed link types that can be used for the 'links.linkType' attribute of external organizations"
        },
        {
          "info": {
            "name": "A list of allowed locales in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-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 nature types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/allowed-nature-types"
          },
          "docs": "Get a list of allowed nature types that can be used for the 'natureTypes' attribute of external organizations"
        },
        {
          "info": {
            "name": "A list of allowed external organization types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/allowed-types"
          },
          "docs": "Get a list of allowed types that can be used for the 'type' attribute of external organizations"
        },
        {
          "info": {
            "name": "A list of allowed workflow steps",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/allowed-workflow-steps"
          },
          "docs": "Get a list of allowed workflow steps that can be used for the 'workflow' attribute of external organizations"
        },
        {
          "info": {
            "name": "A list of allowed discipline schemes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/disciplines/allowed-discipline-schemes"
          },
          "docs": "Get a list fo a allowed discipline schemes for external organizations"
        },
        {
          "info": {
            "name": "A list of allowed disciplines for a specific discipline scheme",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/disciplines/:discipline-scheme/allowed-disciplines",
            "params": [
              {
                "name": "discipline-scheme",
                "value": "",
                "type": "path",
                "description": "Identifier for the discipline scheme for external 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 external organizations"
        },
        {
          "info": {
            "name": "Query operation for disciplines associated with external organizations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/external-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 external organizations in the Pure instance that matches the provided query."
        },
        {
          "info": {
            "name": "Upload file to a specific external organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/external-organizations/file-uploads",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ]
          },
          "docs": "Uploads file for the external organization"
        },
        {
          "info": {
            "name": "Merge external organizations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/external-organizations/merge",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Merge a list of external organizations together. Note that this operation is irreversible"
        },
        {
          "info": {
            "name": "Lists available orderings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/orderings"
          },
          "docs": "Lists all orderings available to the external organization endpoint. These values can be used by the order parameter."
        },
        {
          "info": {
            "name": "Preview deduplication of external organizations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/external-organizations/preview-deduplication",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Runs through a list external organizations and returns the deduplicated and merged organizations. The operation does not touch the Pure database"
        },
        {
          "info": {
            "name": "Query operation for external organizations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/external-organizations/search",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists external 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 external organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired external organization"
              }
            ]
          },
          "docs": "Get external organization with specific UUID."
        },
        {
          "info": {
            "name": "Update external organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/external-organizations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the external organization to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update external organization with specific UUID."
        },
        {
          "info": {
            "name": "Delete external organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/ws/api/external-organizations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the external organization"
              }
            ]
          },
          "docs": "Delete external organization with specific UUID."
        },
        {
          "info": {
            "name": "Lock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/ws/api/external-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/external-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 external organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/:uuid/dependents",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the external organization to update"
              },
              {
                "name": "verbose",
                "value": "",
                "type": "query",
                "description": "Default: false. Setting this to true will add links and names to the output but will also have an impact on performance. use with caution."
              }
            ]
          },
          "docs": "Lists all dependents to the external 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 external organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/:uuid/disciplines/:discipline-scheme",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired external organization"
              },
              {
                "name": "discipline-scheme",
                "value": "",
                "type": "path",
                "description": "Identifier for the discipline scheme"
              }
            ]
          },
          "docs": "Get disciplines from the discipline scheme associated with the external organization with specific UUID."
        },
        {
          "info": {
            "name": "Update disciplines from the discipline scheme associated with the external organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/external-organizations/:uuid/disciplines/:discipline-scheme",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the external 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 external organization with specific UUID."
        },
        {
          "info": {
            "name": "Get file from the external organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/:uuid/files/:fileId",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the external organization"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path",
                "description": "File id "
              }
            ]
          },
          "docs": "Get file from the external organization"
        },
        {
          "info": {
            "name": "Lists notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/ws/api/external-organizations/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the external 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 external organization ordered by date (nulls last)"
        },
        {
          "info": {
            "name": "Create note",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/ws/api/external-organizations/:uuid/notes",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the external organization to add note to"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create note and associate it with an external organization"
        }
      ]
    }
  ],
  "bundled": true
}