{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Web Deployments API", "version": "v2" }, "items": [ { "info": { "name": "Web Deployments", "type": "folder" }, "items": [ { "info": { "name": "Retrieves a cobrowse session", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/webdeployments/deployments/:deploymentId/cobrowse/:sessionId", "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "WebMessaging deployment ID" }, { "name": "sessionId", "value": "", "type": "path", "description": "Cobrowse session id or join code" } ] }, "docs": "Retrieves a cobrowse session" }, { "info": { "name": "Deletes a cobrowse session", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/webdeployments/deployments/:deploymentId/cobrowse/:sessionId", "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "WebMessaging deployment ID" }, { "name": "sessionId", "value": "", "type": "path", "description": "Cobrowse session id or join code" } ] }, "docs": "Deletes a cobrowse session" }, { "info": { "name": "Refresh a JWT.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/webdeployments/token/refresh" }, "docs": "Refresh a JWT." }, { "info": { "name": "Exchange an oAuth code (obtained using the Authorization Code Flow or Implicit flow) for a JWT that can be used by webdeployments.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/webdeployments/token/oauthcodegrantjwtexchange" }, "docs": "Exchange an oAuth code (obtained using the Authorization Code Flow or Implicit flow) for a JWT that can be used by webdeployments." }, { "info": { "name": "Delete all versions of a configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/webdeployments/configurations/:configurationId", "params": [ { "name": "configurationId", "value": "", "type": "path", "description": "The configuration version ID" } ] }, "docs": "Delete all versions of a configuration" }, { "info": { "name": "View configuration drafts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/webdeployments/configurations", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Defaults to 300." }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "showOnlyPublished", "value": "", "type": "query", "description": "Filter by published status." } ] }, "docs": "View configuration drafts" }, { "info": { "name": "Create a configuration draft", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/webdeployments/configurations" }, "docs": "Create a configuration draft" }, { "info": { "name": "Get the versions of a configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/webdeployments/configurations/:configurationId/versions", "params": [ { "name": "configurationId", "value": "", "type": "path", "description": "The configuration version ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Defaults to 300." }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." } ] }, "docs": "Get the versions of a configuration" }, { "info": { "name": "Get a configuration version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/webdeployments/configurations/:configurationId/versions/:versionId", "params": [ { "name": "configurationId", "value": "", "type": "path", "description": "The configuration version ID" }, { "name": "versionId", "value": "", "type": "path", "description": "The version of the configuration to get" } ] }, "docs": "Get a configuration version" }, { "info": { "name": "Get the configuration draft", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/webdeployments/configurations/:configurationId/versions/draft", "params": [ { "name": "configurationId", "value": "", "type": "path", "description": "The configuration version ID" } ] }, "docs": "Get the configuration draft" }, { "info": { "name": "Update the configuration draft", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/webdeployments/configurations/:configurationId/versions/draft", "params": [ { "name": "configurationId", "value": "", "type": "path", "description": "The configuration version ID" } ] }, "docs": "Update the configuration draft" }, { "info": { "name": "Publish the configuration draft and create a new version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/webdeployments/configurations/:configurationId/versions/draft/publish", "params": [ { "name": "configurationId", "value": "", "type": "path", "description": "The configuration version ID" } ] }, "docs": "Publish the configuration draft and create a new version" }, { "info": { "name": "Get a deployment identity resolution setting.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/webdeployments/deployments/:deploymentId/identityresolution", "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment ID" } ] }, "docs": "Get a deployment identity resolution setting." }, { "info": { "name": "Update identity resolution settings for a deployment.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/webdeployments/deployments/:deploymentId/identityresolution", "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment ID" } ] }, "docs": "Update identity resolution settings for a deployment." }, { "info": { "name": "Get a deployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/webdeployments/deployments/:deploymentId", "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment ID" }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attributes will be filled. Comma separated values expected. " } ] }, "docs": "Get a deployment" }, { "info": { "name": "Update a deployment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/webdeployments/deployments/:deploymentId", "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment ID" } ] }, "docs": "Update a deployment" }, { "info": { "name": "Delete a deployment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/webdeployments/deployments/:deploymentId", "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment ID" } ] }, "docs": "Delete a deployment" }, { "info": { "name": "Get active configuration for a given deployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/webdeployments/deployments/:deploymentId/configurations", "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "The deployment ID" }, { "name": "type", "value": "", "type": "query", "description": "Get active configuration on a deployment" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the return value" } ] }, "docs": "Get active configuration for a given deployment" }, { "info": { "name": "Invalidate JWT", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/webdeployments/token/revoke", "headers": [ { "name": "X-Journey-Session-Id", "value": "" }, { "name": "X-Journey-Session-Type", "value": "" } ] }, "docs": "Invalidate JWT" }, { "info": { "name": "Get deployments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/webdeployments/deployments", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Defaults to 300." }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attributes will be filled. Comma separated values expected. " } ] }, "docs": "Get deployments" }, { "info": { "name": "Create a deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/webdeployments/deployments" }, "docs": "Create a deployment" } ] } ], "bundled": true }