{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Desktop Layout API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Desktop Layout",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a new Desktop Layout",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/organization/:orgid/desktop-layout",
            "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 Desktop Layout in a given organization."
        },
        {
          "info": {
            "name": "Bulk save Desktop Layout(s)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/organization/:orgid/desktop-layout/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 Desktop Layout(s) in bulk in a given organization."
        },
        {
          "info": {
            "name": "Bulk export Desktop Layout(s)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/desktop-layout/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": "",
                "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 Desktop Layout(s) in a given organization."
        },
        {
          "info": {
            "name": "Purge inactive Desktop Layout(s)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/organization/:orgid/desktop-layout/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 Desktop Layout(s) older than the configured interval for a given organization."
        },
        {
          "info": {
            "name": "Get specific Desktop Layout by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/desktop-layout/: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 Desktop Layout."
              }
            ]
          },
          "docs": "Retrieve an existing Desktop Layout by ID in a given organization."
        },
        {
          "info": {
            "name": "Update specific Desktop Layout by ID",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/organization/:orgid/desktop-layout/: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 Desktop Layout."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing Desktop Layout by ID in a given organization."
        },
        {
          "info": {
            "name": "Delete specific Desktop Layout by ID",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/organization/:orgid/desktop-layout/: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 Desktop Layout."
              }
            ]
          },
          "docs": "Delete an existing Desktop Layout by ID in a given organization."
        },
        {
          "info": {
            "name": "List references for a specific Desktop Layout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/desktop-layout/: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 Desktop Layout by ID in a given organization."
        },
        {
          "info": {
            "name": "List Desktop Layout(s)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/organization/:orgid/v2/desktop-layout",
            "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, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, 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."
              },
              {
                "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."
              },
              {
                "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."
              },
              {
                "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."
              }
            ]
          },
          "docs": "Retrieve a list of Desktop Layout(s) in a given organization. Json file content field won't be avalible in get all even though it is showing in sample response structure. and it will be avialable only in get by id.\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
}