{
"opencollection": "1.0.0",
"info": {
"name": "Webex Admin Address Book Resource Collection API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Resource Collection",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a new Resource Collection",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organization/:orgid/resource-collection",
"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 resource collection in a given organization."
},
{
"info": {
"name": "Bulk partial update Resource Collections",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/organization/:orgid/resource-collection/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": "Update some or all properties for resource collections in bulk for a given organization."
},
{
"info": {
"name": "Update resource with default resource collection",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource",
"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": "Update resource with default resource collection. Ensure resource should not associated to any resource collection and resource should not be updated and not older than 15 min. Only single Resource Collection is allowed to update."
},
{
"info": {
"name": "Get specific Resource Collection by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/resource-collection/: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 Resource Collection."
}
]
},
"docs": "Retrieve an existing Resource Collection by ID in a given organization."
},
{
"info": {
"name": "Update specific Resource Collection by ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/organization/:orgid/resource-collection/: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 Resource Collection."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing resource collection by ID in a given organization."
},
{
"info": {
"name": "Delete specific Resource Collection by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/organization/:orgid/resource-collection/: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 Resource Collection."
}
]
},
"docs": "Delete an existing resource collection by ID in a given organization."
},
{
"info": {
"name": "List references for a specific Resource Collection",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/resource-collection/: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 resource collection by ID in a given organization."
},
{
"info": {
"name": "List Resource Collections",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organization/:orgid/v2/resource-collection",
"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 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."
},
{
"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": "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 resource collections in a given organization."
}
]
}
],
"bundled": true
}