{
"opencollection": "1.0.0",
"info": {
"name": "Webex Admin Address Book Site API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Site",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Site(s)",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/site",
"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": "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"
}
]
},
"docs": "Retrieve a list of Site(s) in a given organization."
},
{
"info": {
"name": "Create a new Site",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organization/:orgid/site",
"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 Site in a given organization."
},
{
"info": {
"name": "Bulk save Site(s)",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organization/:orgid/site/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 Site(s) in bulk in a given organization."
},
{
"info": {
"name": "Bulk export Site(s)",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/site/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 Site(s) in a given organization."
},
{
"info": {
"name": "Purge inactive Site(s)",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organization/:orgid/site/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 Site(s) older than the configured interval for a given organization."
},
{
"info": {
"name": "Get specific Site by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/site/: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 Site."
}
]
},
"docs": "Retrieve an existing Site by ID in a given organization."
},
{
"info": {
"name": "Update specific Site by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/organization/:orgid/site/: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 Site."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing Site by ID in a given organization."
},
{
"info": {
"name": "Delete specific Site by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/organization/:orgid/site/: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 Site."
}
]
},
"docs": "Delete an existing Site by ID in a given organization."
},
{
"info": {
"name": "List references for a specific Site",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/site/: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 Site by ID in a given organization."
},
{
"info": {
"name": "List Site(s)",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/v2/site",
"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 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"
},
{
"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 Site(s) in a given organization."
},
{
"info": {
"name": "Get Meeting Common Settings Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/admin/meeting/config/commonSettings",
"params": [
{
"name": "siteUrl",
"value": "example.webex.com",
"type": "query",
"description": "URL of the Webex site which the API queries common settings of the meeting's configuration from. If not specified, the API will query from the site administrator's preferred site. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
}
]
},
"docs": "Site administrators can use this API to get a list of functions, options, and privileges that are configured for their Webex service sites.\n\n* If `siteUrl` is specified, common settings of the meeting's configuration of the specified site will be queried; otherwise, the API will query from the site administrator's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
},
{
"info": {
"name": "Update Meeting Common Settings Configuration",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/admin/meeting/config/commonSettings",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Site administrators can use this API to update the option of features, options and privileges that are configured for their WebEx service sites."
}
]
}
],
"bundled": true
}