{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Architect API", "version": "v2" }, "items": [ { "info": { "name": "Architect", "type": "folder" }, "items": [ { "info": { "name": "Returns a specific datatable by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/datatables/divisionviews/:datatableId", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the result" } ] }, "docs": "Given a datatableId returns the datatable object and schema associated with it." }, { "info": { "name": "Returns the state information about an export job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId/export/jobs/:exportJobId", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" }, { "name": "exportJobId", "value": "", "type": "path", "description": "id of export job" } ] }, "docs": "Returns the state information about an export job." }, { "info": { "name": "Begin an export process for exporting all rows from a datatable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId/export/jobs", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" } ] }, "docs": "Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response" }, { "info": { "name": "Begin an import process for importing rows from a CSV file into a datatable. CSV file is uploaded by performing a PUT request against the URL in the returned 'uploadURI' field. Headers for the PUT request must contain all headers contained in the returned 'uploadHeaders' field.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId/import/csv/jobs", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" } ] }, "docs": "Create an import job for importing rows from a CSV file. The caller can then poll for status of the import using the token returned in the response" }, { "info": { "name": "Returns the state information about an import job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId/import/jobs/:importJobId", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" }, { "name": "importJobId", "value": "", "type": "path", "description": "id of import job" } ] }, "docs": "Returns the state information about an import job." }, { "info": { "name": "Get all recent import jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId/import/jobs", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Get all recent import jobs" }, { "info": { "name": "Begin an import process for importing rows into a datatable. Apps should migrate to use POST /api/v2/flows/datatables/{datatableId}/import/csv/jobs instead", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId/import/jobs", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" } ] }, "docs": "Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response" }, { "info": { "name": "Returns a specific datatable by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the result" } ] }, "docs": "Given a datatableId returns the datatable object and schema associated with it." }, { "info": { "name": "Updates a specific datatable by id", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the result" } ] }, "docs": "Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields." }, { "info": { "name": "deletes a specific datatable by id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" }, { "name": "force", "value": "", "type": "query", "description": "force delete, even if in use" } ] }, "docs": "Deletes an entire datatable (including the schema and data) with a given datatableId" }, { "info": { "name": "Retrieve a list of datatables for the org", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/datatables/divisionviews", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the result" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "divisionId", "value": "", "type": "query", "description": "division ID(s)" }, { "name": "name", "value": "", "type": "query", "description": "Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive." } ] }, "docs": "Returns a metadata list of the datatables associated with this org, including datatableId, name and description." }, { "info": { "name": "Retrieve a list of datatables for the org", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/datatables", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the result" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "divisionId", "value": "", "type": "query", "description": "division ID(s)" }, { "name": "name", "value": "", "type": "query", "description": "Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive." } ] }, "docs": "Returns a metadata list of the datatables associated with this org, including datatableId, name and description." }, { "info": { "name": "Create a new datatable with the specified json-schema definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/datatables" }, "docs": "This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/" }, { "info": { "name": "Returns a specific row for the datatable", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId/rows/:rowId", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" }, { "name": "rowId", "value": "", "type": "path", "description": "The key for the row" }, { "name": "showbrief", "value": "", "type": "query", "description": "if true returns just the key field for the row" } ] }, "docs": "Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId." }, { "info": { "name": "Update a row entry", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId/rows/:rowId", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" }, { "name": "rowId", "value": "", "type": "path", "description": "the key for the row" } ] }, "docs": "Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs\n{\n \"Field1\": \"XYZZY\",\n \"Field2\": false,\n \"KEY\": \"27272\"\n}" }, { "info": { "name": "Delete a row entry", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId/rows/:rowId", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" }, { "name": "rowId", "value": "", "type": "path", "description": "the key for the row" } ] }, "docs": "Deletes a row with a given rowId (the value of the key field)." }, { "info": { "name": "Returns the rows for the datatable with the given id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId/rows", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "showbrief", "value": "", "type": "query", "description": "If true returns just the key value of the row" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents." }, { "info": { "name": "Create a new row entry for the datatable.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/datatables/:datatableId/rows", "params": [ { "name": "datatableId", "value": "", "type": "path", "description": "id of datatable" } ] }, "docs": "Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs\n{ \n \"Field1\": \"XYZZY\", \n \"Field2\": false, \n \"KEY\": \"27272\" \n}" }, { "info": { "name": "Start a process (job) to prepare a download of a singular flow execution data instance by Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/instances/:instanceId", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "Instance ID" }, { "name": "expand", "value": "", "type": "query", "description": "Expand various details." } ] }, "docs": "Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete." }, { "info": { "name": "Get the status and/or results of an asynchronous flow execution data retrieval job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/instances/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The asynchronous job ID" } ] }, "docs": "Get the status and/or results of an asynchronous flow execution data retrieval job" }, { "info": { "name": "Start a process (job) that will prepare a list of execution data IDs for download.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/instances/jobs", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Expand various query types." } ] }, "docs": "Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete." }, { "info": { "name": "Retrieve a list of capabilities that the org can use to query for execution data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/instances/querycapabilities", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Expand various query types." } ] }, "docs": "Returns the queryable parameters that can be used to build a query for execution data." }, { "info": { "name": "Query the database of existing flow histories to look for particular flow criteria", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/instances/query", "params": [ { "name": "indexOnly", "value": "", "type": "query", "description": "indexes only" }, { "name": "pageSize", "value": "", "type": "query", "description": "number of results to return" } ] }, "docs": "Returns a list of matching flow histories up to 200 max." }, { "info": { "name": "Get the execution history enabled setting.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/instances/settings/executiondata" }, "docs": "Get the execution history enabled setting." }, { "info": { "name": "Edit the execution history enabled setting.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/flows/instances/settings/executiondata" }, "docs": "Edit the execution history enabled setting." }, { "info": { "name": "Returns the flow default log level.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/instances/settings/loglevels/default", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the result" } ] }, "docs": "Returns the flow default log level which will be used if no specific flow id log level is found." }, { "info": { "name": "Edit the flow default log level.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/flows/instances/settings/loglevels/default", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the result" } ] }, "docs": "Edit the flow default log level." }, { "info": { "name": "Resets the org log level to default, base", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/flows/instances/settings/loglevels/default" }, "docs": "Resets the org log level to default, base" }, { "info": { "name": "Retrieves the log level for a flow by flow id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/:flowId/instances/settings/loglevels", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "The flow id to get the loglevel for" }, { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the result" } ] }, "docs": "Retrieves the log level for a flow by flow id." }, { "info": { "name": "Set the logLevel for a particular flow id", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/:flowId/instances/settings/loglevels", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the result" }, { "name": "flowId", "value": "", "type": "path", "description": "The flow id to set the loglevel for" } ] }, "docs": "Assigns a new loglevel to a flow id" }, { "info": { "name": "Edit the logLevel for a particular flow id", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/flows/:flowId/instances/settings/loglevels", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the result" }, { "name": "flowId", "value": "", "type": "path", "description": "The flow id to edit the loglevel for" } ] }, "docs": "Updates the loglevel for a flow id" }, { "info": { "name": "Deletes a log level for a flow by flow id.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/flows/:flowId/instances/settings/loglevels", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "The flow id to delete the loglevel for" } ] }, "docs": "Deletes the associated log level for a flow by flow id" }, { "info": { "name": "Gets the available flow log level characteristics for this organization.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/instances/settings/loglevels/characteristics" }, "docs": "Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled." }, { "info": { "name": "Retrieve a list of LogLevels for the organization.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/instances/settings/loglevels", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Expand instructions for the result" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." } ] }, "docs": "Returns a paged set of LogLevels per flow id" }, { "info": { "name": "Register Architect Export Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/export/jobs" }, "docs": "Register Architect Export Job" }, { "info": { "name": "Fetch Architect Export Job Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/export/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job ID" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand." } ] }, "docs": "Fetch Architect Export Job Status" }, { "info": { "name": "Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/jobs" }, "docs": "Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job." }, { "info": { "name": "Fetch Architect Job Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job ID" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand." } ] }, "docs": "Fetch Architect Job Status" }, { "info": { "name": "Get resources that are consumed by a given Dependency Tracking object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/dependencytracking/consumedresources", "params": [ { "name": "id", "value": "", "type": "query", "description": "Consuming object ID" }, { "name": "version", "value": "", "type": "query", "description": "Consuming object version" }, { "name": "objectType", "value": "", "type": "query", "description": "Consuming object type. Only versioned types are allowed here." }, { "name": "resourceType", "value": "", "type": "query", "description": "Types of consumed resources to show." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Get resources that are consumed by a given Dependency Tracking object" }, { "info": { "name": "Get resources that consume a given Dependency Tracking object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/dependencytracking/consumingresources", "params": [ { "name": "id", "value": "", "type": "query", "description": "Consumed object ID" }, { "name": "objectType", "value": "", "type": "query", "description": "Consumed object type" }, { "name": "resourceType", "value": "", "type": "query", "description": "Types of consuming resources to show. Only versioned types are allowed here." }, { "name": "version", "value": "", "type": "query", "description": "Object version" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "flowFilter", "value": "", "type": "query", "description": "Show only checkedIn or published flows" } ] }, "docs": "Get resources that consume a given Dependency Tracking object" }, { "info": { "name": "Get Dependency Tracking objects that consume deleted resources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/dependencytracking/deletedresourceconsumers", "params": [ { "name": "name", "value": "", "type": "query", "description": "Name to search for" }, { "name": "objectType", "value": "", "type": "query", "description": "Object type(s) to search for" }, { "name": "flowFilter", "value": "", "type": "query", "description": "Show only checkedIn or published flows" }, { "name": "consumedResources", "value": "", "type": "query", "description": "Return consumed resources?" }, { "name": "consumedResourceType", "value": "", "type": "query", "description": "Resource type(s) to return" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Get Dependency Tracking objects that consume deleted resources" }, { "info": { "name": "Get Dependency Tracking build status for an organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/dependencytracking/build" }, "docs": "Get Dependency Tracking build status for an organization" }, { "info": { "name": "Rebuild Dependency Tracking data for an organization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/dependencytracking/build" }, "docs": "Asynchronous. Notification topic: v2.architect.dependencytracking.build" }, { "info": { "name": "Get a Dependency Tracking object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/dependencytracking/object", "params": [ { "name": "id", "value": "", "type": "query", "description": "Object ID" }, { "name": "version", "value": "", "type": "query", "description": "Object version" }, { "name": "objectType", "value": "", "type": "query", "description": "Object type" }, { "name": "consumedResources", "value": "", "type": "query", "description": "Include resources this item consumes" }, { "name": "consumingResources", "value": "", "type": "query", "description": "Include resources that consume this item" }, { "name": "consumedResourceType", "value": "", "type": "query", "description": "Types of consumed resources to return, if consumed resources are requested" }, { "name": "consumingResourceType", "value": "", "type": "query", "description": "Types of consuming resources to return, if consuming resources are requested" }, { "name": "consumedResourceRequest", "value": "", "type": "query", "description": "Indicate that this is going to look up a consumed resource object" } ] }, "docs": "Get a Dependency Tracking object" }, { "info": { "name": "Get Dependency Tracking objects that have a given display name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/dependencytracking", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "name", "value": "", "type": "query", "description": "Object name to search for" }, { "name": "objectType", "value": "", "type": "query", "description": "Object type(s) to search for" }, { "name": "consumedResources", "value": "", "type": "query", "description": "Include resources each result item consumes" }, { "name": "consumingResources", "value": "", "type": "query", "description": "Include resources that consume each result item" }, { "name": "consumedResourceType", "value": "", "type": "query", "description": "Types of consumed resources to return, if consumed resources are requested" }, { "name": "consumingResourceType", "value": "", "type": "query", "description": "Types of consuming resources to return, if consuming resources are requested" } ] }, "docs": "Get Dependency Tracking objects that have a given display name" }, { "info": { "name": "Get a Dependency Tracking type.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/dependencytracking/types/:typeId", "params": [ { "name": "typeId", "value": "", "type": "path", "description": "Type ID" } ] }, "docs": "Get a Dependency Tracking type." }, { "info": { "name": "Get Dependency Tracking types.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/dependencytracking/types", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Get Dependency Tracking types." }, { "info": { "name": "Gets a emergency group by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/emergencygroups/:emergencyGroupId", "params": [ { "name": "emergencyGroupId", "value": "", "type": "path", "description": "Emergency group ID" } ] }, "docs": "Gets a emergency group by ID" }, { "info": { "name": "Updates a emergency group by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/architect/emergencygroups/:emergencyGroupId", "params": [ { "name": "emergencyGroupId", "value": "", "type": "path", "description": "Emergency group ID" } ] }, "docs": "Updates a emergency group by ID" }, { "info": { "name": "Deletes a emergency group by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/architect/emergencygroups/:emergencyGroupId", "params": [ { "name": "emergencyGroupId", "value": "", "type": "path", "description": "Emergency group ID" } ] }, "docs": "Deletes a emergency group by ID" }, { "info": { "name": "Get a pageable list of basic emergency group objects filterable by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/emergencygroups/divisionviews", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "id", "value": "", "type": "query", "description": "ID of the Emergency Groups to filter by." }, { "name": "name", "value": "", "type": "query", "description": "Name of the Emergency Group to filter by." }, { "name": "divisionId", "value": "", "type": "query", "description": "List of divisionIds on which to filter." } ] }, "docs": "This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch emergency groups that match the given ID(s) and not use any additional supplied query parameters in the search." }, { "info": { "name": "Get a list of emergency groups.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/emergencygroups", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "name", "value": "", "type": "query", "description": "Name of the Emergency Group to filter by." } ] }, "docs": "Get a list of emergency groups." }, { "info": { "name": "Creates a new emergency group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/emergencygroups" }, "docs": "Creates a new emergency group" }, { "info": { "name": "Unlock flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/actions/unlock", "params": [ { "name": "flow", "value": "", "type": "query", "description": "Flow ID" } ] }, "docs": "Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action." }, { "info": { "name": "Publish flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/actions/publish", "params": [ { "name": "flow", "value": "", "type": "query", "description": "Flow ID" }, { "name": "version", "value": "", "type": "query", "description": "version" } ] }, "docs": "Asynchronous. Notification topic: v2.flows.{flowId}" }, { "info": { "name": "Revert flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/actions/revert", "params": [ { "name": "flow", "value": "", "type": "query", "description": "Flow ID" } ] }, "docs": "Revert flow" }, { "info": { "name": "Check-in flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/actions/checkin", "params": [ { "name": "flow", "value": "", "type": "query", "description": "Flow ID" } ] }, "docs": "Asynchronous. Notification topic: v2.flows.{flowId}" }, { "info": { "name": "Check-out flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/actions/checkout", "params": [ { "name": "flow", "value": "", "type": "query", "description": "Flow ID" } ] }, "docs": "Check-out flow" }, { "info": { "name": "Deactivate flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/actions/deactivate", "params": [ { "name": "flow", "value": "", "type": "query", "description": "Flow ID" } ] }, "docs": "Deactivate flow" }, { "info": { "name": "Get a flow execution's details. Flow execution details are available for several days after the flow is started.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/executions/:flowExecutionId", "params": [ { "name": "flowExecutionId", "value": "", "type": "path", "description": "flow execution ID" } ] }, "docs": "Get a flow execution's details. Flow execution details are available for several days after the flow is started." }, { "info": { "name": "Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/executions" }, "docs": "The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need." }, { "info": { "name": "Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/:flowId/versions/:versionId/intents/:intentId/health", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "Flow ID." }, { "name": "versionId", "value": "", "type": "path", "description": "Version ID." }, { "name": "intentId", "value": "", "type": "path", "description": "Intent ID." }, { "name": "language", "value": "", "type": "query", "description": "Language to filter for" } ] }, "docs": "Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent." }, { "info": { "name": "Get health metrics associated with a specific utterance of an intent.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/:flowId/versions/:versionId/intents/:intentId/utterances/:utteranceId/health", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "Flow ID." }, { "name": "versionId", "value": "", "type": "path", "description": "Version ID." }, { "name": "intentId", "value": "", "type": "path", "description": "Intent ID." }, { "name": "utteranceId", "value": "", "type": "path", "description": "Utterance ID." }, { "name": "language", "value": "", "type": "query", "description": "Language to filter for" } ] }, "docs": "Get health metrics associated with a specific utterance of an intent." }, { "info": { "name": "Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/:flowId/versions/:versionId/health", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "Flow ID." }, { "name": "versionId", "value": "", "type": "path", "description": "Version ID." }, { "name": "language", "value": "", "type": "query", "description": "Language to filter for" } ] }, "docs": "Get overall health scores for all intents present in the NLU domain version associated with the bot flow version." }, { "info": { "name": "Get a flow milestone", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/milestones/:milestoneId", "params": [ { "name": "milestoneId", "value": "", "type": "path", "description": "flow milestone ID" } ] }, "docs": "Returns a specified flow milestone" }, { "info": { "name": "Updates a flow milestone", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/flows/milestones/:milestoneId", "params": [ { "name": "milestoneId", "value": "", "type": "path", "description": "flow milestone ID" } ] }, "docs": "Updates a flow milestone" }, { "info": { "name": "Delete a flow milestone.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/flows/milestones/:milestoneId", "params": [ { "name": "milestoneId", "value": "", "type": "path", "description": "flow milestone ID" } ] }, "docs": "Delete a flow milestone." }, { "info": { "name": "Get a pageable list of basic flow milestone information objects filterable by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/milestones/divisionviews", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "id", "value": "", "type": "query", "description": "ID" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "divisionId", "value": "", "type": "query", "description": "division ID(s)" } ] }, "docs": "This returns flow milestones consisting of name and division. If one or more IDs are specified, the search will fetch flow milestones that match the given ID(s) and not use any additional supplied query parameters in the search." }, { "info": { "name": "Get a pageable list of flow milestones, filtered by query parameters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/milestones", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "id", "value": "", "type": "query", "description": "ID" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "description", "value": "", "type": "query", "description": "Description" }, { "name": "nameOrDescription", "value": "", "type": "query", "description": "Name or description" }, { "name": "divisionId", "value": "", "type": "query", "description": "division ID(s)" } ] }, "docs": "Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated." }, { "info": { "name": "Create a flow milestone", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/milestones" }, "docs": "Create a flow milestone" }, { "info": { "name": "Get a flow outcome", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/outcomes/:flowOutcomeId", "params": [ { "name": "flowOutcomeId", "value": "", "type": "path", "description": "flow outcome ID" } ] }, "docs": "Returns a specified flow outcome" }, { "info": { "name": "Updates a flow outcome", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/flows/outcomes/:flowOutcomeId", "params": [ { "name": "flowOutcomeId", "value": "", "type": "path", "description": "flow outcome ID" } ] }, "docs": "Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.{flowoutcomeId}" }, { "info": { "name": "Get a pageable list of basic flow outcome information objects filterable by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/outcomes/divisionviews", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "id", "value": "", "type": "query", "description": "ID" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "divisionId", "value": "", "type": "query", "description": "division ID(s)" } ] }, "docs": "This returns flow outcomes consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search." }, { "info": { "name": "Get a pageable list of flow outcomes, filtered by query parameters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/outcomes", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "id", "value": "", "type": "query", "description": "ID" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "description", "value": "", "type": "query", "description": "Description" }, { "name": "nameOrDescription", "value": "", "type": "query", "description": "Name or description" }, { "name": "divisionId", "value": "", "type": "query", "description": "division ID(s)" } ] }, "docs": "Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated." }, { "info": { "name": "Create a flow outcome", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/outcomes" }, "docs": "Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId}" }, { "info": { "name": "Get flow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/:flowId", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "Flow ID" }, { "name": "deleted", "value": "", "type": "query", "description": "Deleted flows" } ] }, "docs": "Get flow" }, { "info": { "name": "Update flow", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/flows/:flowId", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "Flow ID" } ] }, "docs": "Update flow" }, { "info": { "name": "Delete flow", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/flows/:flowId", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "Flow ID" } ] }, "docs": "Delete flow" }, { "info": { "name": "Get the latest configuration for flow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/:flowId/latestconfiguration", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "Flow ID" }, { "name": "deleted", "value": "", "type": "query", "description": "Deleted flows" } ] }, "docs": "Get the latest configuration for flow" }, { "info": { "name": "Generate flow history", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/:flowId/history", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "Flow ID" } ] }, "docs": "Asynchronous. Notification topic: v2.flows.{flowId}" }, { "info": { "name": "Get generated flow history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/:flowId/history/:historyId", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "Flow ID" }, { "name": "historyId", "value": "", "type": "path", "description": "History request ID" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "action", "value": "", "type": "query", "description": "Flow actions to include (omit to include all)" } ] }, "docs": "Get generated flow history" }, { "info": { "name": "Get flow version configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/:flowId/versions/:versionId/configuration", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "Flow ID" }, { "name": "versionId", "value": "", "type": "path", "description": "Version ID" }, { "name": "deleted", "value": "", "type": "query", "description": "Deleted flows" } ] }, "docs": "Get flow version configuration" }, { "info": { "name": "Get flow version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/:flowId/versions/:versionId", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "Flow ID" }, { "name": "versionId", "value": "", "type": "path", "description": "Version ID" }, { "name": "deleted", "value": "", "type": "query", "description": "Deleted flows" } ] }, "docs": "Get flow version" }, { "info": { "name": "Get flow version list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/:flowId/versions", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "Flow ID" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "deleted", "value": "", "type": "query", "description": "Include Deleted flows" } ] }, "docs": "Get flow version list" }, { "info": { "name": "Create flow version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows/:flowId/versions", "params": [ { "name": "flowId", "value": "", "type": "path", "description": "Flow ID" } ] }, "docs": "Create flow version" }, { "info": { "name": "Get a pageable list of basic flow information objects filterable by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/divisionviews", "params": [ { "name": "type", "value": "", "type": "query", "description": "Type" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "id", "value": "", "type": "query", "description": "ID" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "publishVersionId", "value": "", "type": "query", "description": "Publish version ID" }, { "name": "publishedAfter", "value": "", "type": "query", "description": "Published after" }, { "name": "publishedBefore", "value": "", "type": "query", "description": "Published before" }, { "name": "divisionId", "value": "", "type": "query", "description": "division ID(s)" }, { "name": "includeSchemas", "value": "", "type": "query", "description": "Include variable schemas" } ] }, "docs": "This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search." }, { "info": { "name": "Look up flows by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows/lookup", "params": [ { "name": "id", "value": "", "type": "query", "description": "Flow ID(s)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Returns only flows matching the specified ID(s). Returns an empty listing if no flows match the given IDs." }, { "info": { "name": "Get a pageable list of flows, filtered by query parameters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/flows", "params": [ { "name": "type", "value": "", "type": "query", "description": "Type" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "id", "value": "", "type": "query", "description": "ID" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "description", "value": "", "type": "query", "description": "Description" }, { "name": "nameOrDescription", "value": "", "type": "query", "description": "Name or description" }, { "name": "publishVersionId", "value": "", "type": "query", "description": "Publish version ID" }, { "name": "editableBy", "value": "", "type": "query", "description": "Editable by" }, { "name": "lockedBy", "value": "", "type": "query", "description": "Locked by" }, { "name": "lockedByClientId", "value": "", "type": "query", "description": "Locked by client ID" }, { "name": "secure", "value": "", "type": "query", "description": "Secure" }, { "name": "deleted", "value": "", "type": "query", "description": "Include deleted" }, { "name": "includeSchemas", "value": "", "type": "query", "description": "Include variable schemas" }, { "name": "virtualAgentEnabled", "value": "", "type": "query", "description": "Include/exclude virtual agent flows" }, { "name": "publishedAfter", "value": "", "type": "query", "description": "Published after" }, { "name": "publishedBefore", "value": "", "type": "query", "description": "Published before" }, { "name": "divisionId", "value": "", "type": "query", "description": "division ID(s)" } ] }, "docs": "If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search." }, { "info": { "name": "Create flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/flows", "params": [ { "name": "language", "value": "", "type": "query", "description": "Language" } ] }, "docs": "Create flow" }, { "info": { "name": "Batch-delete a list of flows", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/flows", "params": [ { "name": "id", "value": "", "type": "query", "description": "List of Flow IDs" } ] }, "docs": "Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}" }, { "info": { "name": "Get a grammar language.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/grammars/:grammarId/languages/:languageCode", "params": [ { "name": "grammarId", "value": "", "type": "path", "description": "Grammar ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Get a grammar language." }, { "info": { "name": "Updates a grammar language", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/architect/grammars/:grammarId/languages/:languageCode", "params": [ { "name": "grammarId", "value": "", "type": "path", "description": "Grammar ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Updates a grammar language" }, { "info": { "name": "Delete specified grammar language", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/architect/grammars/:grammarId/languages/:languageCode", "params": [ { "name": "grammarId", "value": "", "type": "path", "description": "Grammar ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Delete specified grammar language" }, { "info": { "name": "Creates a presigned URL for uploading a grammar voice mode file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/grammars/:grammarId/languages/:languageCode/files/voice", "params": [ { "name": "grammarId", "value": "", "type": "path", "description": "Grammar ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Creates a presigned URL for uploading a grammar voice mode file" }, { "info": { "name": "Clear the voice mode file for the grammar language if there is one", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/architect/grammars/:grammarId/languages/:languageCode/files/voice", "params": [ { "name": "grammarId", "value": "", "type": "path", "description": "Grammar ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Clear the voice mode file for the grammar language if there is one" }, { "info": { "name": "Creates a presigned URL for uploading a grammar DTMF mode file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/grammars/:grammarId/languages/:languageCode/files/dtmf", "params": [ { "name": "grammarId", "value": "", "type": "path", "description": "Grammar ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Creates a presigned URL for uploading a grammar DTMF mode file" }, { "info": { "name": "Clear the DTMF mode file for the grammar language if there is one", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/architect/grammars/:grammarId/languages/:languageCode/files/dtmf", "params": [ { "name": "grammarId", "value": "", "type": "path", "description": "Grammar ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Clear the DTMF mode file for the grammar language if there is one" }, { "info": { "name": "Create a new language for a given grammar", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/grammars/:grammarId/languages", "params": [ { "name": "grammarId", "value": "", "type": "path", "description": "Grammar ID" } ] }, "docs": "Create a new language for a given grammar" }, { "info": { "name": "Get a grammar", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/grammars/:grammarId", "params": [ { "name": "grammarId", "value": "", "type": "path", "description": "grammar ID" }, { "name": "includeFileUrls", "value": "", "type": "query", "description": "Include grammar language file URLs" } ] }, "docs": "Returns a specified grammar" }, { "info": { "name": "Updates a grammar", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/architect/grammars/:grammarId", "params": [ { "name": "grammarId", "value": "", "type": "path", "description": "grammar ID" } ] }, "docs": "Updates a grammar" }, { "info": { "name": "Delete a grammar.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/architect/grammars/:grammarId", "params": [ { "name": "grammarId", "value": "", "type": "path", "description": "grammar ID" } ] }, "docs": "Delete a grammar." }, { "info": { "name": "Get a pageable list of grammars, filtered by query parameters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/grammars", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "id", "value": "", "type": "query", "description": "ID" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "description", "value": "", "type": "query", "description": "Description" }, { "name": "nameOrDescription", "value": "", "type": "query", "description": "Name or description" }, { "name": "includeFileUrls", "value": "", "type": "query", "description": "Include grammar language file URLs" } ] }, "docs": "Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated." }, { "info": { "name": "Create a new grammar", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/grammars" }, "docs": "Create a new grammar" }, { "info": { "name": "Get an IVR IdentityResolutionConfig.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/ivrs/:ivrId/identityresolution", "params": [ { "name": "ivrId", "value": "", "type": "path", "description": "IVR id" } ] }, "docs": "Get an IVR IdentityResolutionConfig." }, { "info": { "name": "Update an IVR IdentityResolutionConfig.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/architect/ivrs/:ivrId/identityresolution", "params": [ { "name": "ivrId", "value": "", "type": "path", "description": "IVR id" } ] }, "docs": "Update an IVR IdentityResolutionConfig." }, { "info": { "name": "Get an IVR config.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/ivrs/:ivrId", "params": [ { "name": "ivrId", "value": "", "type": "path", "description": "IVR id" } ] }, "docs": "Get an IVR config." }, { "info": { "name": "Update an IVR Config.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/architect/ivrs/:ivrId", "params": [ { "name": "ivrId", "value": "", "type": "path", "description": "IVR id" } ] }, "docs": "Update an IVR Config." }, { "info": { "name": "Delete an IVR Config.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/architect/ivrs/:ivrId", "params": [ { "name": "ivrId", "value": "", "type": "path", "description": "IVR id" } ] }, "docs": "Delete an IVR Config." }, { "info": { "name": "Get IVR configs.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/ivrs", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "name", "value": "", "type": "query", "description": "Name of the IVR to filter by." }, { "name": "dnis", "value": "", "type": "query", "description": "The phone number of the IVR to filter by." }, { "name": "scheduleGroup", "value": "", "type": "query", "description": "The Schedule Group of the IVR to filter by." }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand" } ] }, "docs": "Get IVR configs." }, { "info": { "name": "Create IVR config.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/ivrs" }, "docs": "Create IVR config." }, { "info": { "name": "Get a pageable list of basic ivr configuration information objects filterable by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/ivrs/divisionviews", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "id", "value": "", "type": "query", "description": "ID of the IVR to filter by." }, { "name": "name", "value": "", "type": "query", "description": "Name of the IVR to filter by." }, { "name": "divisionId", "value": "", "type": "query", "description": "List of divisionIds on which to filter." } ] }, "docs": "Get a pageable list of basic ivr configuration information objects filterable by query parameters." }, { "info": { "name": "Get specified user prompt resource", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/prompts/:promptId/resources/:languageCode", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Get specified user prompt resource" }, { "info": { "name": "Update specified user prompt resource", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/architect/prompts/:promptId/resources/:languageCode", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Update specified user prompt resource" }, { "info": { "name": "Delete specified user prompt resource", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/architect/prompts/:promptId/resources/:languageCode", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Delete specified user prompt resource" }, { "info": { "name": "Delete specified user prompt resource audio", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/architect/prompts/:promptId/resources/:languageCode/audio", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Delete specified user prompt resource audio" }, { "info": { "name": "Get a pageable list of user prompt resources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/prompts/:promptId/resources", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "The returned list is pageable, and query parameters can be used for filtering." }, { "info": { "name": "Create a new user prompt resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/prompts/:promptId/resources", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" } ] }, "docs": "Create a new user prompt resource" }, { "info": { "name": "Generate prompt history", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/prompts/:promptId/history", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" } ] }, "docs": "Asynchronous. Notification topic: v2.architect.prompts.{promptId}" }, { "info": { "name": "Get specified user prompt", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/prompts/:promptId", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" }, { "name": "includeMediaUris", "value": "", "type": "query", "description": "Include the media URIs for each resource" }, { "name": "includeResources", "value": "", "type": "query", "description": "Include the resources for each system prompt" }, { "name": "language", "value": "", "type": "query", "description": "Filter the resources down to the provided languages" } ] }, "docs": "Get specified user prompt" }, { "info": { "name": "Update specified user prompt", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/architect/prompts/:promptId", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" } ] }, "docs": "Update specified user prompt" }, { "info": { "name": "Delete specified user prompt", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/architect/prompts/:promptId", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" }, { "name": "allResources", "value": "", "type": "query", "description": "Whether or not to delete all the prompt resources" } ] }, "docs": "Delete specified user prompt" }, { "info": { "name": "Get generated prompt history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/prompts/:promptId/history/:historyId", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" }, { "name": "historyId", "value": "", "type": "path", "description": "History request ID" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "action", "value": "", "type": "query", "description": "Flow actions to include (omit to include all)" } ] }, "docs": "Get generated prompt history" }, { "info": { "name": "Get a pageable list of user prompts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/prompts", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "description", "value": "", "type": "query", "description": "Description" }, { "name": "nameOrDescription", "value": "", "type": "query", "description": "Name or description" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "includeMediaUris", "value": "", "type": "query", "description": "Include the media URIs for each resource" }, { "name": "includeResources", "value": "", "type": "query", "description": "Include the resources for each system prompt" }, { "name": "language", "value": "", "type": "query", "description": "Filter the resources down to the provided languages" } ] }, "docs": "The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated." }, { "info": { "name": "Create a new user prompt", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/prompts" }, "docs": "Create a new user prompt" }, { "info": { "name": "Batch-delete a list of prompts", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/architect/prompts", "params": [ { "name": "id", "value": "", "type": "query", "description": "List of Prompt IDs" } ] }, "docs": "Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}" }, { "info": { "name": "Gets a schedule group by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/schedulegroups/:scheduleGroupId", "params": [ { "name": "scheduleGroupId", "value": "", "type": "path", "description": "Schedule group ID" } ] }, "docs": "Gets a schedule group by ID" }, { "info": { "name": "Updates a schedule group by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/architect/schedulegroups/:scheduleGroupId", "params": [ { "name": "scheduleGroupId", "value": "", "type": "path", "description": "Schedule group ID" } ] }, "docs": "Updates a schedule group by ID" }, { "info": { "name": "Deletes a schedule group by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/architect/schedulegroups/:scheduleGroupId", "params": [ { "name": "scheduleGroupId", "value": "", "type": "path", "description": "Schedule group ID" } ] }, "docs": "Deletes a schedule group by ID" }, { "info": { "name": "Get a pageable list of basic schedule group configuration information objects filterable by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/schedulegroups/divisionviews", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "id", "value": "", "type": "query", "description": "ID of the schedule group to filter by." }, { "name": "name", "value": "", "type": "query", "description": "Name of the schedule group to filter by." }, { "name": "divisionId", "value": "", "type": "query", "description": "List of divisionIds on which to filter." } ] }, "docs": "Get a pageable list of basic schedule group configuration information objects filterable by query parameters." }, { "info": { "name": "Get a list of schedule groups.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/schedulegroups", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "name", "value": "", "type": "query", "description": "Name of the Schedule Group to filter by." }, { "name": "scheduleIds", "value": "", "type": "query", "description": "A comma-delimited list of Schedule IDs to filter by." }, { "name": "divisionId", "value": "", "type": "query", "description": "List of divisionIds on which to filter." } ] }, "docs": "Get a list of schedule groups." }, { "info": { "name": "Creates a new schedule group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/schedulegroups" }, "docs": "Creates a new schedule group" }, { "info": { "name": "Get a schedule by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/schedules/:scheduleId", "params": [ { "name": "scheduleId", "value": "", "type": "path", "description": "Schedule ID" } ] }, "docs": "Get a schedule by ID" }, { "info": { "name": "Update schedule by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/architect/schedules/:scheduleId", "params": [ { "name": "scheduleId", "value": "", "type": "path", "description": "Schedule ID" } ] }, "docs": "Update schedule by ID" }, { "info": { "name": "Delete a schedule by id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/architect/schedules/:scheduleId", "params": [ { "name": "scheduleId", "value": "", "type": "path", "description": "Schedule ID" } ] }, "docs": "Delete a schedule by id" }, { "info": { "name": "Get a pageable list of basic schedule configuration information objects filterable by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/schedules/divisionviews", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "id", "value": "", "type": "query", "description": "ID of the schedule group to filter by." }, { "name": "name", "value": "", "type": "query", "description": "Name of the schedule group to filter by." }, { "name": "divisionId", "value": "", "type": "query", "description": "List of divisionIds on which to filter." } ] }, "docs": "Get a pageable list of basic schedule configuration information objects filterable by query parameters." }, { "info": { "name": "Get a list of schedules.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/schedules", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "name", "value": "", "type": "query", "description": "Name of the Schedule to filter by." }, { "name": "divisionId", "value": "", "type": "query", "description": "List of divisionIds on which to filter." } ] }, "docs": "Get a list of schedules." }, { "info": { "name": "Create a new schedule.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/schedules" }, "docs": "Create a new schedule." }, { "info": { "name": "Get a system prompt resource.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/systemprompts/:promptId/resources/:languageCode", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Get a system prompt resource." }, { "info": { "name": "Updates a system prompt resource override.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/architect/systemprompts/:promptId/resources/:languageCode", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Updates a system prompt resource override." }, { "info": { "name": "Delete a system prompt resource override.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/architect/systemprompts/:promptId/resources/:languageCode", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" }, { "name": "languageCode", "value": "", "type": "path", "description": "Language" } ] }, "docs": "Delete a system prompt resource override." }, { "info": { "name": "Get system prompt resources.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/systemprompts/:promptId/resources", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Get system prompt resources." }, { "info": { "name": "Create system prompt resource override.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/systemprompts/:promptId/resources", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "Prompt ID" } ] }, "docs": "Create system prompt resource override." }, { "info": { "name": "Generate system prompt history", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/architect/systemprompts/:promptId/history", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "promptId" } ] }, "docs": "Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId}" }, { "info": { "name": "Get generated prompt history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/systemprompts/:promptId/history/:historyId", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "promptId" }, { "name": "historyId", "value": "", "type": "path", "description": "History request ID" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "action", "value": "", "type": "query", "description": "Flow actions to include (omit to include all)" } ] }, "docs": "Get generated prompt history" }, { "info": { "name": "Get a system prompt", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/systemprompts/:promptId", "params": [ { "name": "promptId", "value": "", "type": "path", "description": "promptId" }, { "name": "includeMediaUris", "value": "", "type": "query", "description": "Include the media URIs for each resource" }, { "name": "includeResources", "value": "", "type": "query", "description": "Include the resources for each system prompt" }, { "name": "language", "value": "", "type": "query", "description": "Filter the resources down to the provided languages" } ] }, "docs": "Get a system prompt" }, { "info": { "name": "Get System Prompts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/systemprompts", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "description", "value": "", "type": "query", "description": "Description" }, { "name": "nameOrDescription", "value": "", "type": "query", "description": "Name or description" }, { "name": "includeMediaUris", "value": "", "type": "query", "description": "Include the media URIs for each resource" }, { "name": "includeResources", "value": "", "type": "query", "description": "Include the resources for each system prompt" }, { "name": "language", "value": "", "type": "query", "description": "Filter the resources down to the provided languages" } ] }, "docs": "Get System Prompts" }, { "info": { "name": "Get Dependency Tracking objects that depend on updated resources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/architect/dependencytracking/updatedresourceconsumers", "params": [ { "name": "name", "value": "", "type": "query", "description": "Name to search for" }, { "name": "objectType", "value": "", "type": "query", "description": "Object type(s) to search for" }, { "name": "consumedResources", "value": "", "type": "query", "description": "Return consumed resources?" }, { "name": "consumedResourceType", "value": "", "type": "query", "description": "Resource type(s) to return" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Get Dependency Tracking objects that depend on updated resources" } ] } ], "bundled": true }