{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Dial Number API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Dial Number",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Dialed Number Mapping(s)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/dial-number",
            "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. Supported filterable fields:  id. \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 spaces. If they do, please enclose them in quotes to apply the filter.\n"
              },
              {
                "name": "attributes",
                "value": "id",
                "type": "query",
                "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)"
              },
              {
                "name": "page",
                "value": "0",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "100",
                "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 Dialed Number Mapping(s) in a given organization."
        },
        {
          "info": {
            "name": "Create a new Dialed Number Mapping",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/organization/:orgid/dial-number",
            "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 Dialed Number Mapping in a given organization."
        },
        {
          "info": {
            "name": "Delete all Dialed Number Mapping(s)",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/organization/:orgid/dial-number",
            "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": "Delete all Dialed Number Mapping(s) in a given organization."
        },
        {
          "info": {
            "name": "Bulk save Dialed Number Mapping(s)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/organization/:orgid/dial-number/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": "Create, Update or delete Dialed Number Mapping(s) in bulk in a given organization."
        },
        {
          "info": {
            "name": "Bulk export Dialed Number Mapping(s)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/dial-number/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": "0",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "100",
                "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 Dialed Number Mapping(s) in a given organization."
        },
        {
          "info": {
            "name": "List  only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only",
            "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": "Retrieve a list of  only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s) without pagination in a given organization."
        },
        {
          "info": {
            "name": "Get specific Dialed Number Mapping by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/dial-number/: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-9a83-2afdae0d4ba2",
                "type": "path",
                "description": "Resource ID of the Dialed Number Mapping."
              }
            ]
          },
          "docs": "Retrieve an existing Dialed Number Mapping by ID in a given organization."
        },
        {
          "info": {
            "name": "Update specific Dialed Number Mapping by ID",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/organization/:orgid/dial-number/: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-9a83-2afdae0d4ba2",
                "type": "path",
                "description": "Resource ID of the Dialed Number Mapping."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing Dialed Number Mapping by ID in a given organization."
        },
        {
          "info": {
            "name": "Delete specific Dialed Number Mapping by ID",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/organization/:orgid/dial-number/: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-9a83-2afdae0d4ba2",
                "type": "path",
                "description": "Resource ID of the Dialed Number Mapping."
              }
            ]
          },
          "docs": "Delete an existing Dialed Number Mapping by ID in a given organization."
        },
        {
          "info": {
            "name": "List references for a specific Dialed Number Mapping",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/dial-number/: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": "0",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "100",
                "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 Dialed Number Mapping by ID in a given organization."
        },
        {
          "info": {
            "name": "List Dialed Number Mapping(s)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/v2/dial-number",
            "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 spaces. If they do, please enclose them in quotes to apply the filter.\n"
              },
              {
                "name": "attributes",
                "value": "id",
                "type": "query",
                "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)"
              },
              {
                "name": "search",
                "value": "contact center",
                "type": "query",
                "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n"
              },
              {
                "name": "page",
                "value": "0",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "100",
                "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."
              },
              {
                "name": "includeEntryPointName",
                "value": "",
                "type": "query",
                "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled."
              }
            ]
          },
          "docs": "Retrieve a list of Dialed Number Mapping(s) in a given organization."
        },
        {
          "info": {
            "name": "List Dialed Number Mapping(s)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/v3/dial-number",
            "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 spaces. If they do, please enclose them in quotes to apply the filter.\n"
              },
              {
                "name": "attributes",
                "value": "id",
                "type": "query",
                "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)"
              },
              {
                "name": "search",
                "value": "contact center",
                "type": "query",
                "description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n"
              },
              {
                "name": "page",
                "value": "0",
                "type": "query",
                "description": "Defines the number of displayed page. The page number starts from 0."
              },
              {
                "name": "pageSize",
                "value": "100",
                "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."
              },
              {
                "name": "includeEntryPointName",
                "value": "",
                "type": "query",
                "description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled."
              }
            ]
          },
          "docs": "Retrieve a list of Dialed Number Mapping(s) in a given organization."
        }
      ]
    }
  ],
  "bundled": true
}