{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pure activity keywordGroupConfiguration API",
    "version": "5.35.3-4"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "api-key",
      "value": "{{api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "keywordGroupConfiguration",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all keyword group configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/keyword-group-configurations",
            "params": [
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of returned keyword group configurations 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 keywordGroupConfigurations_getOrderings"
              }
            ]
          },
          "docs": "Lists all keyword group configurations in the Pure instance."
        },
        {
          "info": {
            "name": "Create keyword group configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pure.qub.ac.uk/ws/api/keyword-group-configurations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create keyword group configuration"
        },
        {
          "info": {
            "name": "A list of allowed locales in localized strings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/keyword-group-configurations/allowed-locales"
          },
          "docs": "Get a list of allowed locales that can be used when submitting localized string entities."
        },
        {
          "info": {
            "name": "A map of allowed relation types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/keyword-group-configurations/allowed-relation-types"
          },
          "docs": "The map key is the target system name and the value is the list of possible values to assign to relation type. Apart from the allowed values here, relation type can also be set to null (see description of relationType on KeywordGroupConfiguration)."
        },
        {
          "info": {
            "name": "A list of allowed target system names",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/keyword-group-configurations/allowed-target-system-names"
          },
          "docs": "Get a list of allowed target system names this keyword group configuration is associated with."
        },
        {
          "info": {
            "name": "Get keyword group configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pure.qub.ac.uk/ws/api/keyword-group-configurations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the desired keyword group configuration"
              }
            ]
          },
          "docs": "Get keyword group configuration with specific UUID."
        },
        {
          "info": {
            "name": "Update keyword group configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pure.qub.ac.uk/ws/api/keyword-group-configurations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the keyword group configuration to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update keyword group configuration with specific UUID."
        },
        {
          "info": {
            "name": "Delete keyword group configuration",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://pure.qub.ac.uk/ws/api/keyword-group-configurations/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "UUID of the keyword group configuration"
              }
            ]
          },
          "docs": "Delete keyword group configuration with specific UUID."
        },
        {
          "info": {
            "name": "Lock the content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pure.qub.ac.uk/ws/api/keyword-group-configurations/: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": "https://pure.qub.ac.uk/ws/api/keyword-group-configurations/: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."
        }
      ]
    }
  ],
  "bundled": true
}