{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Global Variables API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Global Variables",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a new Global Variable",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/organization/:orgid/cad-variable",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Global Variable in a given organization."
        },
        {
          "info": {
            "name": "Bulk save Global Variable(s)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/organization/:orgid/cad-variable/bulk",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Export all Global Variable(s) in a given organization."
        },
        {
          "info": {
            "name": "Bulk export Global Variable(s)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size."
              }
            ]
          },
          "docs": "Export all Global Variable(s) in a given organization."
        },
        {
          "info": {
            "name": "Purge inactive Global Variable(s)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "nextStartId",
                "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0",
                "type": "query",
                "description": "This is the entity ID from which items for the next purge batch with be selected."
              }
            ]
          },
          "docs": "Purge inactive Global Variable(s) older than the configured interval for a given organization."
        },
        {
          "info": {
            "name": "Get reportable count for Global Variable(s)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              }
            ]
          },
          "docs": "Get count for all the reportable Global Variable(s) in a given organization."
        },
        {
          "info": {
            "name": "Get specific Global Variable by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/cad-variable/:id",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "id",
                "value": "2f9eecc5-0472-4549",
                "type": "path",
                "description": "ID of the Global Variable."
              }
            ]
          },
          "docs": "Retrieve an existing Global Variable by ID in a given organization."
        },
        {
          "info": {
            "name": "Update specific Global Variable by ID",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/organization/:orgid/cad-variable/:id",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "id",
                "value": "2f9eecc5-0472-4549",
                "type": "path",
                "description": "ID of the Global Variable."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing Global Variable by ID in a given organization. Required fields in payload are agentEditable, variableType, agentViewable, reportable, active, defaultValue."
        },
        {
          "info": {
            "name": "Delete specific Global Variable by ID",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/organization/:orgid/cad-variable/:id",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "id",
                "value": "2f9eecc5-0472-4549",
                "type": "path",
                "description": "ID of the Global Variable."
              }
            ]
          },
          "docs": "Delete an existing Global Variable by ID in a given organization."
        },
        {
          "info": {
            "name": "List references for a specific Global Variable",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "id",
                "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0",
                "type": "path",
                "description": "ID of this contact center resource."
              },
              {
                "name": "type",
                "value": "type_text",
                "type": "query",
                "description": "Entity type of the other entity that has a reference to this specific entity."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size."
              }
            ]
          },
          "docs": "Retrieve a list of all entities that have reference to an existing Global Variable by ID in a given organization."
        },
        {
          "info": {
            "name": "List Global Variable(s)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/v2/cad-variable",
            "params": [
              {
                "name": "orgid",
                "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
                "type": "path",
                "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization."
              },
              {
                "name": "filter",
                "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"",
                "type": "query",
                "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see  <a href=\"https://www.here.com/docs/bundle/data-client-library-developer-guide-java-scala/page/client/rsql.html\">this reference</a>. For a list of supported operators, see <a href=\"https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference\">this syntax guide</a>.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply filter.\n"
              },
              {
                "name": "attributes",
                "value": "id",
                "type": "query",
                "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported"
              },
              {
                "name": "search",
                "value": "contact center",
                "type": "query",
                "description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size."
              }
            ]
          },
          "docs": "Retrieve a list of Global Variable(s) in a given organization."
        }
      ]
    }
  ],
  "bundled": true
}