{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Scripts API", "version": "v2" }, "items": [ { "info": { "name": "Scripts", "type": "folder" }, "items": [ { "info": { "name": "Export a script via download service.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/scripts/:scriptId/export", "params": [ { "name": "scriptId", "value": "", "type": "path", "description": "Script ID" } ] }, "docs": "Export a script via download service." }, { "info": { "name": "Get the upload status of an imported script", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/scripts/uploads/:uploadId/status", "params": [ { "name": "uploadId", "value": "", "type": "path", "description": "Upload ID" }, { "name": "longPoll", "value": "", "type": "query", "description": "Enable longPolling endpoint" } ] }, "docs": "Get the upload status of an imported script" }, { "info": { "name": "Get a page", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/scripts/:scriptId/pages/:pageId", "params": [ { "name": "scriptId", "value": "", "type": "path", "description": "Script ID" }, { "name": "pageId", "value": "", "type": "path", "description": "Page ID" }, { "name": "scriptDataVersion", "value": "", "type": "query", "description": "Advanced usage - controls the data version of the script" } ] }, "docs": "Get a page" }, { "info": { "name": "Get the list of pages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/scripts/:scriptId/pages", "params": [ { "name": "scriptId", "value": "", "type": "path", "description": "Script ID" }, { "name": "scriptDataVersion", "value": "", "type": "query", "description": "Advanced usage - controls the data version of the script" } ] }, "docs": "Get the list of pages" }, { "info": { "name": "Get the published page.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/scripts/published/:scriptId/pages/:pageId", "params": [ { "name": "scriptId", "value": "", "type": "path", "description": "Script ID" }, { "name": "pageId", "value": "", "type": "path", "description": "Page ID" }, { "name": "scriptDataVersion", "value": "", "type": "query", "description": "Advanced usage - controls the data version of the script" } ] }, "docs": "Get the published page." }, { "info": { "name": "Get the list of published pages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/scripts/published/:scriptId/pages", "params": [ { "name": "scriptId", "value": "", "type": "path", "description": "Script ID" }, { "name": "scriptDataVersion", "value": "", "type": "query", "description": "Advanced usage - controls the data version of the script" } ] }, "docs": "Get the list of published pages" }, { "info": { "name": "Get the published script.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/scripts/published/:scriptId", "params": [ { "name": "scriptId", "value": "", "type": "path", "description": "Script ID" }, { "name": "scriptDataVersion", "value": "", "type": "query", "description": "Advanced usage - controls the data version of the script" } ] }, "docs": "Get the published script." }, { "info": { "name": "Get the published scripts metadata.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/scripts/published/divisionviews", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "expand", "value": "", "type": "query", "description": "Expand" }, { "name": "name", "value": "", "type": "query", "description": "Name filter" }, { "name": "feature", "value": "", "type": "query", "description": "Feature filter" }, { "name": "flowId", "value": "", "type": "query", "description": "Secure flow id filter" }, { "name": "scriptDataVersion", "value": "", "type": "query", "description": "Advanced usage - controls the data version of the script" }, { "name": "divisionIds", "value": "", "type": "query", "description": "Filters scripts to requested divisionIds" } ] }, "docs": "Get the published scripts metadata." }, { "info": { "name": "Get the published scripts.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/scripts/published", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "expand", "value": "", "type": "query", "description": "Expand" }, { "name": "name", "value": "", "type": "query", "description": "Name filter" }, { "name": "feature", "value": "", "type": "query", "description": "Feature filter" }, { "name": "flowId", "value": "", "type": "query", "description": "Secure flow id filter" }, { "name": "scriptDataVersion", "value": "", "type": "query", "description": "Advanced usage - controls the data version of the script" }, { "name": "divisionIds", "value": "", "type": "query", "description": "Filters scripts to requested divisionIds" } ] }, "docs": "Get the published scripts." }, { "info": { "name": "Publish a script.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/scripts/published", "params": [ { "name": "scriptDataVersion", "value": "", "type": "query", "description": "Advanced usage - controls the data version of the script" } ] }, "docs": "Publish a script." }, { "info": { "name": "Get the published variables", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/scripts/published/divisionviews/:scriptId/variables", "params": [ { "name": "scriptId", "value": "", "type": "path", "description": "Script ID" }, { "name": "input", "value": "", "type": "query", "description": "input" }, { "name": "output", "value": "", "type": "query", "description": "output" }, { "name": "type", "value": "", "type": "query", "description": "type" }, { "name": "scriptDataVersion", "value": "", "type": "query", "description": "Advanced usage - controls the data version of the script" } ] }, "docs": "Get the published variables" }, { "info": { "name": "Get the published variables", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/scripts/published/:scriptId/variables", "params": [ { "name": "scriptId", "value": "", "type": "path", "description": "Script ID" }, { "name": "input", "value": "", "type": "query", "description": "input" }, { "name": "output", "value": "", "type": "query", "description": "output" }, { "name": "type", "value": "", "type": "query", "description": "type" }, { "name": "scriptDataVersion", "value": "", "type": "query", "description": "Advanced usage - controls the data version of the script" } ] }, "docs": "Get the published variables" }, { "info": { "name": "Get a script", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/scripts/:scriptId", "params": [ { "name": "scriptId", "value": "", "type": "path", "description": "Script ID" } ] }, "docs": "Get a script" }, { "info": { "name": "Get the metadata for a list of scripts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/scripts/divisionviews", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "expand", "value": "", "type": "query", "description": "Expand" }, { "name": "name", "value": "", "type": "query", "description": "Name filter" }, { "name": "feature", "value": "", "type": "query", "description": "Feature filter" }, { "name": "flowId", "value": "", "type": "query", "description": "Secure flow id filter" }, { "name": "sortBy", "value": "", "type": "query", "description": "SortBy" }, { "name": "sortOrder", "value": "", "type": "query", "description": "SortOrder" }, { "name": "scriptDataVersion", "value": "", "type": "query", "description": "Advanced usage - controls the data version of the script" }, { "name": "divisionIds", "value": "", "type": "query", "description": "Filters scripts to requested divisionIds" } ] }, "docs": "Get the metadata for a list of scripts" }, { "info": { "name": "Get the list of scripts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/scripts", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "expand", "value": "", "type": "query", "description": "Expand" }, { "name": "name", "value": "", "type": "query", "description": "Name filter" }, { "name": "feature", "value": "", "type": "query", "description": "Feature filter" }, { "name": "flowId", "value": "", "type": "query", "description": "Secure flow id filter" }, { "name": "sortBy", "value": "", "type": "query", "description": "SortBy" }, { "name": "sortOrder", "value": "", "type": "query", "description": "SortOrder" }, { "name": "scriptDataVersion", "value": "", "type": "query", "description": "Advanced usage - controls the data version of the script" }, { "name": "divisionIds", "value": "", "type": "query", "description": "Filters scripts to requested divisionIds" } ] }, "docs": "Get the list of scripts" } ] } ], "bundled": true }