{
"opencollection": "1.0.0",
"info": {
"name": "Webex Admin Address Book Entry Point API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Entry Point",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Entry Point(s)",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/entry-point",
"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 this reference. For a list of supported operators, see this syntax guide.\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": "channelTypes",
"value": "TELEPHONY,CHAT",
"type": "query",
"description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering."
},
{
"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 except (ccOneQueue, userIds, queueRankings, links) "
},
{
"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."
},
{
"name": "singleObjectResponse",
"value": "",
"type": "query",
"description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception."
}
]
},
"docs": "Retrieve a list of Entry Point(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API."
},
{
"info": {
"name": "Create a new Entry Point",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organization/:orgid/entry-point",
"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 Entry Point in a given organization."
},
{
"info": {
"name": "Bulk save Entry Point(s)",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organization/:orgid/entry-point/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 Entry Point(s) in bulk in a given organization."
},
{
"info": {
"name": "Bulk export Entry Point(s)",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/entry-point/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": "type",
"value": "INBOUND",
"type": "query",
"description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND."
},
{
"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 Entry Point(s) in a given organization."
},
{
"info": {
"name": "Purge inactive Entry Point(s)",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organization/:orgid/entry-point/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 Entry Point(s) older than the configured interval for a given organization."
},
{
"info": {
"name": "Get specific Entry Point by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/entry-point/: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": "Resource ID of the Entry Point."
},
{
"name": "includeNames",
"value": "",
"type": "query",
"description": "Specifiy whether to include flow override settings reference variable names."
}
]
},
"docs": "Retrieve an existing Entry Point by ID in a given organization."
},
{
"info": {
"name": "Update specific Entry Point by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/organization/:orgid/entry-point/: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": "Resource ID of the Entry Point."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing Entry Point by ID in a given organization."
},
{
"info": {
"name": "Delete specific Entry Point by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/organization/:orgid/entry-point/: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": "Resource ID of the Entry Point."
}
]
},
"docs": "Delete an existing Entry Point by ID in a given organization."
},
{
"info": {
"name": "List references for a specific Entry Point",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/entry-point/: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 Entry Point by ID in a given organization."
},
{
"info": {
"name": "List Entry Point(s)",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/v2/entry-point",
"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, xspVersion, 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 this reference. For a list of supported operators, see this syntax guide.\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 except (ccOneQueue, userIds, queueRankings, links) "
},
{
"name": "search",
"value": "contact center",
"type": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");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."
},
{
"name": "desktopProfileFilter",
"value": "",
"type": "query",
"description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access."
},
{
"name": "provisioningView",
"value": "",
"type": "query",
"description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. "
},
{
"name": "includeCount",
"value": "",
"type": "query",
"description": "Enable the flag to get the count of DN-EP Mapping"
},
{
"name": "singleObjectResponse",
"value": "",
"type": "query",
"description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception."
}
]
},
"docs": "Retrieve a list of Entry Point(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API."
}
]
}
],
"bundled": true
}