{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Business Rules API", "version": "v2" }, "items": [ { "info": { "name": "Business Rules", "type": "folder" }, "items": [ { "info": { "name": "Get a decision table", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" } ] }, "docs": "Get a decision table" }, { "info": { "name": "Update a decision table", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" } ] }, "docs": "Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them." }, { "info": { "name": "Delete a decision table", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId", "params": [ { "name": "forceDelete", "value": "", "type": "query", "description": "Force delete decision table (under certain conditions)" }, { "name": "tableId", "value": "", "type": "path", "description": "Table ID" } ] }, "docs": "Delete a decision table" }, { "info": { "name": "Execute a published decision table", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/execute", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" } ] }, "docs": "Execute a published decision table" }, { "info": { "name": "Get a decision table version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" } ] }, "docs": "Get a decision table version" }, { "info": { "name": "Update a decision table version", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" } ] }, "docs": "Update a decision table version" }, { "info": { "name": "Delete a decision table version", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" } ] }, "docs": "Delete a decision table version" }, { "info": { "name": "Copy a decision table version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion/copy", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" } ] }, "docs": "Copy a decision table version" }, { "info": { "name": "Execute a decision table version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion/execute", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" } ] }, "docs": "Execute a decision table version" }, { "info": { "name": "Publish a decision table version", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion/publish", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" } ] }, "docs": "Publish a decision table version" }, { "info": { "name": "Update the Business Rules Schema to the latest version for a given decision table version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion/sync", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" } ] }, "docs": "Update the Business Rules Schema to the latest version for a given decision table version" }, { "info": { "name": "Get a list of decision table versions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 100." } ] }, "docs": "Get a list of decision table versions" }, { "info": { "name": "Create a new decision table version. When sourceVersion is not provided, the draft is created from the published version.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" } ] }, "docs": "Create a new decision table version. When sourceVersion is not provided, the draft is created from the published version." }, { "info": { "name": "Get a list of decision tables.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables", "params": [ { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 100." }, { "name": "divisionIds", "value": "", "type": "query", "description": "One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned." }, { "name": "name", "value": "", "type": "query", "description": "Search for decision tables with a name that contains the given search string. Search is case insensitive and will match any table that contains this string in any part of the name." } ] }, "docs": "Get a list of decision tables." }, { "info": { "name": "Create a decision table", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables" }, "docs": "Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them." }, { "info": { "name": "Search for decision tables.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/search", "params": [ { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 100." }, { "name": "schemaId", "value": "", "type": "query", "description": "Search for decision tables that use the schema with this ID. Cannot be combined with name search. Search results will not be paginated if used." }, { "name": "name", "value": "", "type": "query", "description": "Search for decision tables with a name that contains the given search string. Search is case insensitive and will match any table that contains this string in any part of the name. Cannot be combined with schema search. Search results will not be paginated if used." }, { "name": "withPublishedVersion", "value": "", "type": "query", "description": "Filters results to only decision tables that have at least one version in Published status" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand in response" }, { "name": "ids", "value": "", "type": "query", "description": "Decision table IDs to search for" } ] }, "docs": "Search for decision tables." }, { "info": { "name": "Get an export job for a decision table", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/exports/:exportJobId", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "exportJobId", "value": "", "type": "path", "description": "Export Job ID" } ] }, "docs": "Get an export job for a decision table" }, { "info": { "name": "Delete an export job for a decision table", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/exports/:exportJobId", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "exportJobId", "value": "", "type": "path", "description": "Export Job ID" } ] }, "docs": "Delete an export job for a decision table" }, { "info": { "name": "List export jobs for a decision table", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/exports", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 100." } ] }, "docs": "List export jobs for a decision table" }, { "info": { "name": "Create an export job for a decision table version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/exports", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" } ] }, "docs": "Create an export job for a decision table version" }, { "info": { "name": "Get decision table row import job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/imports/:importJobId", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "importJobId", "value": "", "type": "path", "description": "Import job ID" } ] }, "docs": "Get decision table row import job" }, { "info": { "name": "Update decision table row import job", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/imports/:importJobId", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "importJobId", "value": "", "type": "path", "description": "Import job ID" } ] }, "docs": "Update decision table row import job" }, { "info": { "name": "Delete decision table row import job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/imports/:importJobId", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "importJobId", "value": "", "type": "path", "description": "Import job ID" } ] }, "docs": "Delete decision table row import job" }, { "info": { "name": "List decision table row import jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/imports", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 100." } ] }, "docs": "List decision table row import jobs" }, { "info": { "name": "Create a decision table row import job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/imports", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" } ] }, "docs": "Create a decision table row import job" }, { "info": { "name": "Get a decision table row", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion/rows/:rowId", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" }, { "name": "rowId", "value": "", "type": "path", "description": "Row ID" } ] }, "docs": "Get a decision table row" }, { "info": { "name": "Full update a decision table row", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion/rows/:rowId", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" }, { "name": "rowId", "value": "", "type": "path", "description": "Row ID" } ] }, "docs": "Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them." }, { "info": { "name": "Delete a decision table row", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion/rows/:rowId", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" }, { "name": "rowId", "value": "", "type": "path", "description": "Row ID" } ] }, "docs": "Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them." }, { "info": { "name": "Bulk add decision table rows", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion/rows/bulk/add", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" } ] }, "docs": "Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them." }, { "info": { "name": "Bulk update decision table rows", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion/rows/bulk/update", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" } ] }, "docs": "Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them." }, { "info": { "name": "Bulk delete decision table rows", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion/rows/bulk/remove", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" } ] }, "docs": "Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them." }, { "info": { "name": "Get a list of decision table rows.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion/rows", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number of the entities to return. Defaults to 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 100. Defaults to 25." } ] }, "docs": "Get a list of decision table rows." }, { "info": { "name": "Create a decision table row", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion/rows", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" } ] }, "docs": "Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them." }, { "info": { "name": "Search for decision table rows", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/decisiontables/:tableId/versions/:tableVersion/rows/search", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Table ID" }, { "name": "tableVersion", "value": "", "type": "path", "description": "Table Version" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number of the entities to return. Defaults to 1." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 100. Defaults to 25." } ] }, "docs": "Search for decision table rows" }, { "info": { "name": "Get a specific named core type.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/schemas/coretypes/:coreTypeName", "params": [ { "name": "coreTypeName", "value": "", "type": "path", "description": "The core type's name" } ] }, "docs": "Get a specific named core type." }, { "info": { "name": "Get the core types from which all schemas are built.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/schemas/coretypes" }, "docs": "Get the core types from which all schemas are built." }, { "info": { "name": "Get a schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Get a schema" }, { "info": { "name": "Update a schema", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/businessrules/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Update a schema" }, { "info": { "name": "Delete a schema", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/businessrules/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Delete a schema" }, { "info": { "name": "Get a list of schemas.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/businessrules/schemas" }, "docs": "Get a list of schemas." }, { "info": { "name": "Create a schema", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/businessrules/schemas" }, "docs": "Create a schema" } ] } ], "bundled": true }