{ "swagger": "2.0", "info": { "title": "IBM Business Automation Workflow Operations REST Interface", "version": "8.6.2.21021", "description": "IBM Business Automation Workflow REST resources for operating IBM Business Automation Workflow." }, "basePath": "/ops", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "basic_auth": { "type": "basic" } }, "security": [ { "basic_auth": [ ] } ], "tags": [ { "name": "System" }, { "name": "AI Agent" }, { "name": "Application" }, { "name": "BPEL" }, { "name": "Blackout Periods" }, { "name": "Branch" }, { "name": "Cache" }, { "name": "Container" }, { "name": "Environment Variable" }, { "name": "Event Manager Tasks" }, { "name": "Exposed Process Value" }, { "name": "External Service - REST" }, { "name": "Health Management" }, { "name": "Performance Data Warehouse" }, { "name": "Process" }, { "name": "REST Server" }, { "name": "Synchronous Queues" }, { "name": "Team Binding" }, { "name": "User Management" }, { "name": "Version" }, { "name": "Workflow Server" }, { "name": "Saved Search" }, { "name": "Installed Versions" }, { "name": "Task Instances" }, { "name": "Process Instance Transfer" }, { "name": "Logging" }, { "name": "Federated Data Repository" }, { "name": "Usage" } ], "paths": { "/system/login": { "post": { "summary": "Obtain IBM Business Automation Workflow CSRF prevention token", "description": "Obtain a CSRF prevention token and optionally refresh the user's group membership information.", "operationId": "createBPMCSRFToken", "tags": [ "System" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "login_request", "in": "body", "description": "Mandatory parameter that allows you to specify whether the caller's group membership data is refreshed", "required": true, "schema": { "$ref": "#/definitions/login_request" } } ], "responses": { "201": { "description": "The request was processed successfully and returned a new CSRF token", "schema": { "$ref": "#/definitions/csrf_token" } }, "400": { "description": "Invalid input.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/system/queue/{id}": { "get": { "summary": "Obtain status of an asynchronous operation.", "description": "Obtains information about the status of an asynchronous operation, such as group memberships that are being updated. Various REST APIs that start asynchronous operations return a URL that points to this API. Use this API to determine whether the asynchronous operation is still running, it failed, or it finished successfully and to determine the result of the operation. By default, the information about the operation is available for at least 48 hours; then it is discarded. Only Business Automation Workflow administrators or users who initiated the asynchronous call are authorized to perform this call.", "operationId": "getQueuedOperationStatus", "x-display-name": "Get asynchronous operation status", "tags": [ "System" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "Identifier of the operation, obtained from the REST API that started the asynchronous operation.", "required": true, "type": "string" }, { "name": "key", "in": "query", "description": "Authorization key, obtained from the REST API that started the asynchronous operation. Administrators can query an operation status without any authorization key; in all other cases, the authorization key is mandatory to ensure that only callers who started the operation can query its status.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The status of the specified operation is returned in the response", "schema": { "$ref": "#/definitions/queued_operation_status" } }, "400": { "description": "The request contains invalid parameter", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/system/validate_database": { "get": { "summary": "Validate database.", "description": "Validates the database of the system. For more information about which roles are authorized to perform this call, see the IBM Knowledge Center documentation.", "operationId": "validateDatabase", "x-display-name": "validate database", "tags": [ "System" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Indicates the cross-site request forgery prevention token for Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The status of the specified operation is returned in the response.", "schema": { "$ref": "#/definitions/validation_result" } }, "400": { "description": "The request contains invalid parameter.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/servers/workflow/install_packages": { "delete": { "summary": "Delete all deployment packages.", "description": "Delete all deployment packages.", "operationId": "deleteDeployments", "x-display-name": "Delete all deployment packages.", "tags": [ "Deployment" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Indicates the cross-site request forgery prevention token for Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The deployment packages have been deleted.", "schema": { "type": "boolean" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/servers/workflow/{name}/install_packages": { "delete": { "summary": "Delete the deployment packages associated with a particular server.", "description": "Delete the deployment packages associated with the server.", "operationId": "deleteServerDeployments", "x-display-name": "Delete the deployment packages associated with a particular server.", "tags": [ "Deployment" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Indicates the cross-site request forgery prevention token for Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "The name of the deployed server if it is not a generic deployment.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The deployment packages have been deleted.", "schema": { "type": "boolean" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/event_manager_tasks": { "get": { "summary": "Retrieve a list of Event Manager tasks.", "description": "Lists Event Manager tasks that are currently in the IBM Business Automation Workflow system. Request parameters allow you to filter based on states or process instance. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "getEventManagerTasks", "x-display-name": "Get Event Manager tasks", "tags": [ "Event Manager Tasks", "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "states", "in": "query", "description": "A comma-separated list of states. Restricts the results to instances that are in the specified states. Valid values are: 'acquired', 'blackedout', 'executing', 'on_hold', 'scheduled'.", "x-display-name": "Select the states you want to use as filter critera.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "acquired", "blackedout", "executing", "on_hold", "scheduled" ] }, "collectionFormat": "csv" }, { "name": "process_id", "description": "Process instance ID used for filtering Event Manager tasks that are associated with the specified instance.", "required": false, "in": "query", "type": "string" }, { "name": "offset", "in": "query", "description": "In a list of entries, the offset specifies the position of the first Event Manager task to return from the query result set.", "required": false, "type": "integer" }, { "name": "size", "in": "query", "description": "Maximum number of Event Manager tasks to return.", "required": false, "type": "integer", "minimum": 1 }, { "name": "optional_parts", "in": "query", "description": "A comma-separated list of optional parts to be returned in the response object. Optional part 'message' results in the message that is associated with the Event Manager task to be returned. Valid values are: 'message'.", "x-display-name": "Optional part to be returned in the response object. If 'message' is specified, the response contains the serialized message associated with the Event Manager task.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "message" ] }, "collectionFormat": "csv" } ], "responses": { "200": { "description": "The request was processed successfully and the response contains the list of Event Manager tasks.", "schema": { "$ref": "#/definitions/event_manager_tasks" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "delete": { "summary": "Delete multiple on-hold Event Manager tasks.", "description": "Deletes multiple on-hold Event Manager tasks. List the IDs of the Event Manager tasks that are in the on-hold state and should be deleted. To delete all Event Manager tasks in the on-hold state, specify the all=true parameter. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "deleteEventManagerTasks", "x-display-name": "Delete Event Manager tasks", "tags": [ "Event Manager Tasks", "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "em_task_ids", "in": "query", "description": "A comma-separated list of Event Manager task IDs to be deleted.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "all", "in": "query", "description": "Indicator that must be set explicitly if all Event Manager tasks that are in the state 'on-hold' are to be deleted.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "The request was processed successfully. The response contains information about the Event Manager tasks that were successfully deleted and error details if some of the specified tasks could not be deleted.", "schema": { "$ref": "#/definitions/event_manager_tasks_delete_result" } }, "400": { "description": "The request could not be handled because of missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/event_manager_tasks/replay": { "post": { "summary": "Replay multiple Event Manager Tasks.", "description": "Replays multiple Event Manager tasks that are in the on-hold state. Either replay them all, specify the IDs of the Event Manager task you want to replay, or specify a process instance ID to identify which Event Manager tasks should be replayed. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "replayEventManagerTasks", "x-display-name": "Replay Event Manager tasks", "tags": [ "Event Manager Tasks", "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "em_task_ids", "in": "query", "description": "A comma-separated list of Event Manager task IDs of tasks that are to be replayed.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "process_id", "in": "query", "description": "The process instance ID for which all Event Manager tasks are to be replayed.", "required": false, "type": "string" }, { "name": "max_number", "in": "query", "description": "Maximum number of Event Manager tasks to be replayed. You can use this parameter to prevent system overload.", "required": false, "type": "integer" } ], "responses": { "200": { "description": "The request was processed successfully. The response contains information about which Event Manager tasks were successfully replayed and error details if some of the specified tasks could not be replayed.", "schema": { "$ref": "#/definitions/event_manager_tasks_replay_result" } }, "400": { "description": "The request could not be handled because of missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/event_manager_tasks/{em_task_id}": { "get": { "summary": "Retrieve details of an Event Manager task.", "description": "Retrieves the details of the specified Event Manager task. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "getEventManagerTask", "x-display-name": "Get Event Manager task details", "tags": [ "Event Manager Tasks", "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "em_task_id", "in": "path", "type": "string", "required": true, "description": "Identifier of the Event Manager task to retrieve" }, { "name": "optional_parts", "in": "query", "description": "A comma-separated list of optional parts to be returned in the response object. If 'message' is specified, the response contains the serialized message that is associated with the Event Manager task. Valid values are: 'message'.", "x-display-name": "Optional part to be returned in the response object. If 'message' is specified, the response contains the serialized message associated with the Event Manager task.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "message" ] }, "collectionFormat": "csv" } ], "responses": { "200": { "description": "Details of the specified Event Manager task are returned in the response", "schema": { "$ref": "#/definitions/event_manager_task" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested Event Manager task does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "delete": { "summary": "Delete an on-hold Event Manager task.", "description": "Deletes the specified Event Manager task that is in the on-hold state. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "deleteEventManagerTask", "x-display-name": "Delete Event Manager Task", "tags": [ "Event Manager Tasks", "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "em_task_id", "in": "path", "type": "string", "required": true, "description": "Identifier of the Event Manager task to delete." } ], "responses": { "204": { "description": "The Event Manager task was successfully deleted." }, "400": { "description": "The request could not be handled because of missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested Event Manager task does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The Event Manager task that was specified cannot be deleted because it is not in the state 'on-hold'.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/event_manager_tasks/{em_task_id}/replay": { "post": { "summary": "Replay an on-hold Event Manager task.", "description": "Replays the specified on-hold Event Manager task. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "replayEventManagerTask", "x-display-name": "Replay Event Manager Task", "tags": [ "Event Manager Tasks", "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "em_task_id", "in": "path", "type": "string", "required": true, "description": "Identifier of the Event Manager task to replay" }, { "name": "optional_parts", "in": "query", "description": "A comma-separated list of optional parts to be returned in the response object. If 'message' is specified, the response contains the serialized message associated with the Event Manager task. Valid values are: 'message'.", "x-display-name": "Optional part to be returned in the response object. If 'message' is specified, the response contains the serialized message associated with the Event Manager task.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "message" ] }, "collectionFormat": "csv" } ], "responses": { "200": { "description": "The Event Manager task was successfully scheduled again.", "schema": { "$ref": "#/definitions/event_manager_task" } }, "400": { "description": "The request could not be handled because of missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested Event Manager task does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The Event Manager task that was specified cannot be replayed because it is not in the state 'on-hold'.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/event_manager/resume": { "post": { "summary": "Resume all Event Manager Schedulers.", "description": "Resumes all Event Manager schedulers. This API is subject to authorization check based on Process Admin Console security properties setttings.", "operationId": "eventManagerResume", "x-display-name": "Resume Event Manager", "tags": [ "Event Manager Tasks" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "204": { "description": "Event Manager Schedulers were successfully resumed." }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/event_manager/pause": { "post": { "summary": "Pause all Event Manager Schedulers.", "description": "Pauses all Event Manager schedulers. This API is subject to authorization check based on Process Admin Console security properties setttings.", "operationId": "eventManagerPause", "x-display-name": "Pause Event Manager", "tags": [ "Event Manager Tasks" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "204": { "description": "Event Manager Schedulers were successfully paused." }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/event_manager/monitor": { "get": { "summary": "Retrieves the Event Manager monitor.", "description": "Retrieves the Event Manager monitor. This API is subject to authorization check based on Process Admin Console security properties setttings.", "operationId": "getEventManagerMonitor", "x-display-name": "Get Event Manager Monitor", "tags": [ "Event Manager Tasks" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Indicates the cross-site request forgery prevention token for Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/event_manager_monitor" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/processes/count": { "get": { "summary": "Retrieve a count of process instances.", "description": "Tells you how many process instances match the specified criteria. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "getProcessesCount", "x-display-name": "Count Processes", "tags": [ "Process", "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "states", "in": "query", "description": "A comma-separated list of states. Restricts the results to instances that are in the specified states. Valid values are: 'finished', 'terminated', 'running', 'suspended', 'stopped', 'did_not_start'.", "x-display-name": "Select the states of interest to restrict the instances in the result to those in the specified states.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "finished", "terminated", "running", "suspended", "stopped", "did_not_start" ] }, "collectionFormat": "csv" }, { "name": "containers", "in": "query", "description": "A comma-separated list of containers. Restricts the results to instances that belong to the specified process application acronyms.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "versions", "in": "query", "description": "A comma-separated list of snapshot acronyms. Restricts the results to instances that belong to the specified snapshots.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "model", "in": "query", "description": "The name of the process model. Restricts the results to instances of the specified process model.", "required": false, "type": "string" }, { "name": "ended_before", "in": "query", "description": "Only process instances that completed before this point in time are returned. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ssz'.", "required": false, "type": "string", "format": "date-time" }, { "name": "ended_after", "in": "query", "description": "Only process instances that completed after this point in time are returned. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ssz'.", "required": false, "type": "string", "format": "date-time" }, { "name": "search_term", "in": "query", "description": "A string that uses the given term to filters the process instances that are returned.", "required": false, "type": "string" }, { "name": "process_ids", "in": "query", "description": "A comma-separated list of process instance identifiers. Restricts the results to instances with the specified process IDs.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" } ], "responses": { "200": { "description": "The request was processed successfully and returned the number of process instances that match the specified query parameters.", "schema": { "$ref": "#/definitions/resource_count" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/uca/event_manager_tasks/": { "delete": { "summary": "Deletes event manager tasks of on event undercover agents.", "description": "Deletes event manager tasks associate with On Event type of Undercover Agents. This operation only look for the UCA in the snapshot requested. If you inadvertently deleted the scheduled UCA Event Manager tasks for some instances, you can regenerate UCA events by running the process sendMessage REST API. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "deleteUCAEventManagerTasks", "x-display-name": "Delete Event Manager Tasks Of A On Event UCA", "tags": [ "Event Manager Tasks" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "container", "in": "query", "description": "The acronym of the process application or toolkit that defines the undercover agent.", "required": true, "type": "string" }, { "name": "version", "in": "query", "description": "The acronym of the snapshot that defines the undercover agent.", "required": true, "type": "string" }, { "name": "undercoverAgentName", "in": "query", "description": "The name of the On Event Undercover Agent that is defined in the version.", "required": true, "type": "string" }, { "name": "scheduled_after", "in": "query", "description": "Only event manager task schduled after this point in time are deleted. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ssz'.", "required": true, "type": "string", "format": "date-time" }, { "name": "scheduled_before", "in": "query", "description": "Optional parameter. Only event manager task schduled before this point in time are deleted. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ssz'.", "required": false, "type": "string", "format": "date-time" }, { "name": "batchSize", "in": "query", "description": "Optional parameter. The maximum number of tasks to delete in each batch. If not specified, defaults to 5000. Must be a positive integer. Smaller values reduce transaction size and lock duration but may require more iterations.", "required": false, "type": "integer", "format": "int32", "minimum": 1, "default": 5000 } ], "responses": { "200": { "description": "The request was processed successfully. The response contains information about the Event Manager tasks that were successfully deleted and error details if some of the specified tasks could not be deleted.", "schema": { "$ref": "#/definitions/uca_event_manager_tasks_delete_result" } }, "400": { "description": "The request could not be handled because of missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/processes": { "delete": { "summary": "Delete specified process instances.", "description": "Deletes the specified process instances according to their states, completion dates, process models, or process instance identifiers. This operation is asynchronous. Messages for this operation are available only in the system log. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "deleteProcesses", "x-display-name": "Delete Processes", "tags": [ "Process", "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "states", "in": "query", "description": "A comma-separated list of states. To delete process instances that are not in an end state, set the 'force' parameter to 'true'. Valid values are: 'finished', 'terminated', 'running', 'suspended', 'stopped', 'did_not_start'.", "x-display-name": "Select the states the process instances to be deleted need to be in.", "required": true, "type": "array", "items": { "type": "string", "enum": [ "finished", "terminated", "running", "suspended", "stopped", "did_not_start" ] }, "collectionFormat": "csv" }, { "name": "force", "in": "query", "description": "Set this parameter to the value 'true' if you want to delete process instances regardless of whether they are in an end state.", "required": false, "type": "boolean", "default": false }, { "name": "container", "in": "query", "description": "The acronym of the process application for which process instances are deleted.", "required": false, "type": "string" }, { "name": "versions", "in": "query", "description": "A comma-separated list of snapshot acronyms for which process instances are deleted. This parameter is only valid if the container parameter is specified.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "ended_before", "in": "query", "description": "Only process instances that completed before this point in time are deleted. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ssz'.", "required": false, "type": "string", "format": "date-time" }, { "name": "ended_after", "in": "query", "description": "Only process instances that completed after this point in time are deleted. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ssz'.", "required": false, "type": "string", "format": "date-time" }, { "name": "process_ids", "in": "query", "description": "A comma-separated list of process instance identifiers.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "transaction_slice", "in": "query", "description": "Specifies the number of instances that are deleted per transaction. The default value is 10.", "required": false, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 10 } ], "responses": { "202": { "description": "The request to delete the specified process instances was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "204": { "description": "No instances that match the request were found to delete." }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/processes/resume": { "post": { "summary": "Resume suspended process instances.", "description": "Resume suspended process instances belonging to the specified container and snapshot. This command can not be used to resume instances that belong to a tip. This operation is asynchronous. Only Business Automation Workflow administrators and authors are authorized to perform this call.", "operationId": "resumeProcesses", "x-display-name": "Resume Processes", "tags": [ "Process", "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "A cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "container", "in": "query", "description": "The acronym of the process application process instances are to be resumed for.", "required": true, "type": "string" }, { "name": "version", "in": "query", "description": "The acronym of the snapshot process instances are to be resumed for.", "required": true, "type": "string" }, { "name": "max_instances", "in": "query", "description": "The maximum number of instances to resume (between 1 and 2147483647). If this parameter is not set, all suspended instances belonging to the specified container and version are resumed. When the 'get_instances' parameter is set, this command is mutually exclusive.", "required": false, "type": "integer" }, { "name": "get_instances", "in": "query", "description": "If set to true, this parameter return the number of suspended instances belonging to the specified container and version. When the 'max_instances' parameter is set, this command is mutually exclusive.", "required": false, "type": "boolean" } ], "responses": { "202": { "description": "The request to resume the specified on-hold process instances was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/servers/workflow": { "get": { "summary": "Lists all the Workflow Server instances that are in the Workflow Center.", "description": "Lists all the Workflow Server instances that are in the Workflow Center. Only Business Automation Workflow users are authorized to perform this call.", "operationId": "getServers", "x-display-name": "Get Servers", "tags": [ "Workflow Server" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "type", "in": "query", "description": "Valid values (mutually exclusive): 'online', 'offline'. Specify 'online' to view only online servers and 'offline' to view only offline servers. If the value is not set, both are returned.", "x-display-name": "Type of servers to be returned. If neither 'online' nor 'offline' is specified, then both online and offline servers are returned.", "required": false, "type": "string", "enum": [ "online", "offline" ] }, { "name": "offset", "in": "query", "description": "In a list of entries, the offset specifies the position of the first server to return from the query result set.", "required": false, "type": "integer" }, { "name": "size", "in": "query", "description": "The maximum number of servers to return.", "required": false, "type": "integer", "minimum": 1 } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/servers" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/servers/workflow/{server_name}": { "get": { "summary": "Lists information for a Workflow Server instance in a Workflow Center.", "description": "Retrieves detailed information about a Workflow Server instance. Only Business Automation Workflow users are authorized to perform this call.", "operationId": "getServer", "x-display-name": "Get Server", "tags": [ "Workflow Server" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "server_name", "in": "path", "description": "A required parameter that specifies the name of the server instance.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/server" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/servers/workflow/count": { "get": { "summary": "Retrieve a count of servers.", "description": "Tells you how many servers on the Workflow Center server match the specified criteria. Only Business Automation Workflow users are authorized to perform this call.", "operationId": "getServersCount", "x-display-name": "Count Servers", "tags": [ "Workflow Server" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "type", "in": "query", "description": "Valid values (mutually exclusive): 'online', 'offline'. Specify 'online' to count only online servers and 'offline' to count only offline servers. If the value is not set, both are counted.", "x-display-name": "Type of servers to be counted. If neither 'online' nor 'offline' is specified, then both online and offline servers are counted.", "required": false, "type": "string", "enum": [ "online", "offline" ] } ], "responses": { "200": { "description": "The request was successfully processed and returned the number of servers that match the specified parameters.", "schema": { "$ref": "#/definitions/resource_count" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/env_vars": { "get": { "summary": "Retrieve the values of environment variables for a specific snapshot.", "description": "Retrieves the values of environment variables for a specific snapshot. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "getEnvVars", "x-display-name": "Get Environment Variables", "tags": [ "Environment Variable" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the environment variables.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the environment variables.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/env_var_pairs_with_source" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "post": { "summary": "Sets the value of environment variables for a specific snapshot.", "description": "Sets the values of the environment variables for a specific snapshot. Don't use this API to update the environment variable of a toolkit if the environment variable name is not unique in the process app and all its dependent toolkits. Instead, use the Process Admin Console to update the runtime environment variable value of a toolkit. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "setEnvVars", "x-display-name": "Set Environment Variables", "tags": [ "Environment Variable", "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot.", "required": true, "type": "string" }, { "name": "env_vars", "in": "body", "description": "The name value pairs used to set the specified environment variables. The field envVarRef is optional.", "required": true, "schema": { "$ref": "#/definitions/env_var_pairs" } } ], "responses": { "200": { "description": "The request was processed successfully.", "schema": { "$ref": "#/definitions/env_var_pairs" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/branches/{branch}/env_vars": { "post": { "summary": "Sets the value of environment variables for the tip snapshot of a specified track.", "description": "Sets the values of the environment variables for the tip snapshot of a specified branch. Use /rest/bpm/wle/v1/system/env/variable REST API to retrieve the environment variable value of the tip snapshot. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "setTipEnvVars", "x-display-name": "Set Environment Variables for Tip Snapshot", "tags": [ "Environment Variable" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" }, { "name": "branch", "in": "path", "description": "The acronym of the track containing the tip snapshot to be modified.", "required": true, "type": "string" }, { "name": "env_vars", "in": "body", "description": "The name value pairs used to set the specified environment variables. The field envVarRef is optional.", "required": true, "schema": { "$ref": "#/definitions/env_var_pairs" } } ], "responses": { "200": { "description": "The request was processed successfully.", "schema": { "$ref": "#/definitions/env_var_pairs" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/env_vars/sync": { "post": { "summary": "Copy environment variables between two snapshots.", "description": "Copies the environment variables from a source snapshot to a target snapshot. This operation is asynchronous. The API changes the target snapshot's environment variable only if the 'last modified' timestamp of the source environment variable is more recent than the timestamp of the target snapshot's environment variable. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "syncEnvVars", "x-display-name": "Synchronize Environment Variables", "tags": [ "Environment Variable", "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that is associated with the snapshots.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the environment variables that you want to copy.", "required": true, "type": "string" }, { "name": "target_version", "in": "query", "description": "The acronym of the snapshot that you want to copy the environment variables to.", "required": true, "type": "string" } ], "responses": { "202": { "description": "The request to synchronize environment variables was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/epvs": { "get": { "summary": "Retrieve a list of exposed process values (EPVs) for a specific snapshot.", "description": "Lists EPVs for a specific snapshot. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "getEPVs", "x-display-name": "Get Exposed Process Values", "tags": [ "Exposed Process Value", "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the exposed process values.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the exposed process values.", "required": true, "type": "string" }, { "name": "optional_parts", "in": "query", "description": "A comma-separated list of optional parts to be returned in the response object. If 'previous_values' is specified, the response contains the previous values associated with the EPV variable. If 'future_values' is specified, the response contains the future values associated with the EPV variable Valid values are: 'previous_values', 'current_values', 'future_values'.", "x-display-name": "Optional part to be returned in the response object. If 'previous_values' is specified, the response contains the previous values associated with the EPV variable. If 'future_values' is specified, the response contains the future values associated with the EPV variable.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "previous_values", "current_values", "future_values" ] }, "collectionFormat": "csv" }, { "name": "useGMT", "in": "query", "description": "A boolean to indicate if the returned date and time string should use GMT timezone. The default is true.", "required": false, "default": true, "type": "boolean" }, { "name": "onlyIncludeCurrentUser", "in": "query", "description": "A boolean to indicate if the epvs to be retrieved will be limited to the epvs exposed to the current user.", "required": false, "default": false, "type": "boolean" } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/epvs_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "post": { "summary": "Create a value of an exposed process value variable for a specific snapshot.", "description": "Create a value of an EPV variable that takes effect according to the specified date and time. Only Business Automation Workflow administrators or authors are authorized to perform this call.", "operationId": "createEPVVariableValue", "x-display-name": "Create a Exposed Process Value Variable Value", "tags": [ "Exposed Process Value", "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the exposed process value.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the exposed process value.", "required": true, "type": "string" }, { "name": "epv_variable_value_details", "in": "body", "description": "The body parameters for creating a new value for an EPV variable.", "required": true, "schema": { "$ref": "#/definitions/create_epv_variable_value" } }, { "name": "useGMT", "in": "query", "description": "A boolean to indicate if the returned date and time string should use GMT timezone. The default is true.", "required": false, "default": true, "type": "boolean" } ], "responses": { "200": { "description": "The request was processed successfully.", "schema": { "$ref": "#/definitions/epvs_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/epvs/sync": { "post": { "summary": "Copy the exposed process values (EPVs) from between two snapshots.", "description": "Copies the EPVs from a source snapshot to a target snapshot. This operation is asynchronous. The API changes the target snapshot's EPV only if the 'last modified' timestamp of the source EPV is more recent than the timestamp of the target snapshot's EPV. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "syncEPVs", "x-display-name": "Synchronize Exposed Process Values", "tags": [ "Exposed Process Value" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that is associated with the snapshots.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the EPVs that you want to copy.", "required": true, "type": "string" }, { "name": "target_version", "in": "query", "description": "The acronym of the snapshot that you want to copy the EPVs to.", "required": true, "type": "string" } ], "responses": { "202": { "description": "The request to synchronize EPVs was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/epvs/history": { "delete": { "summary": "Delete exposed process values (EPVs) that are no longer required.", "description": "Deletes all previous EPVs associated with a specified snapshot (or across all snapshots if this parameter is unspecified). Does not delete the current or future EPVs. This operation is asynchronous. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "deleteEPVs", "x-display-name": "Deletes previous exposed process values", "tags": [ "Exposed Process Value" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "A cross-site request forgery prevention token for Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "query", "description": "The acronym of the process application that is associated with the snapshot's EPVs. Leave this parameter empty to delete all EPVs. If only the container is specified, all EPVs in the container are deleted. This parameter is required if the 'Version' parameter is specified.", "required": false, "type": "string" }, { "name": "version", "in": "query", "description": "The acronym of the snapshot that contains the EPVs that you want to delete. Deletes all EPVs if both the container and version parameters are empty. If only the container is specified, this parameter deletes all EPVs in the container. To only consider tip snapshots, specify 'Tip'.", "required": false, "type": "string" }, { "name": "transaction_slice", "in": "query", "description": "The number of EPVs to be deleted in each transaction. If this parameter is unspecified, the default is 1000. Specify 0 to perform the delete operation in one transaction. If the number of EPV values to be deleted is large, you might run out of transaction log space.", "required": false, "type": "integer" }, { "name": "display_status", "in": "query", "description": "When set to 'true', displays the number of EPV data items that can be deleted (organized by application and snapshot). If this parameter is unspecified, the default is false.", "required": false, "type": "boolean" } ], "responses": { "202": { "description": "The request to delete EPV histories was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/team_bindings": { "get": { "summary": "Retrieve a list of team bindings for a specific snapshot.", "description": "Lists the team bindings for a specific snapshot. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "getTeamBindings", "x-display-name": "Get Team Bindings", "tags": [ "Team Binding", "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the team bindings.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the team bindings.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/team_bindings_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/team_bindings/{team_name}": { "post": { "summary": "Add users, groups, and manager to a team for a specific snapshot.", "description": "Adds a set of users, a set of groups, or a team of managers to a team definition for a specfic snapshot. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "setTeamMembers", "x-display-name": "Set Team Members", "tags": [ "Team Binding", "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the team binding", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the team binding.", "required": true, "type": "string" }, { "name": "team_name", "in": "path", "description": "The name of the team that additions will be made to.", "required": true, "type": "string" }, { "name": "add_team_details", "in": "body", "description": "The body parameters for adding new team members.", "required": true, "schema": { "$ref": "#/definitions/add_team_details" } } ], "responses": { "201": { "description": "The request was processed successfully. The response contains the updated team bindings.", "schema": { "$ref": "#/definitions/team_bindings_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "delete": { "summary": "Delete users, groups, and manager from a team for a specific snapshot.", "description": "Removes a set of users, a set of groups, or a team of managers from a team definition for a specfic snapshot. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "removeTeamMembers", "x-display-name": "Remove Team Members", "tags": [ "Team Binding", "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the team binding", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the team binding.", "required": true, "type": "string" }, { "name": "team_name", "in": "path", "description": "The name of the team that removals will be made to.", "required": true, "type": "string" }, { "name": "remove_team_details", "in": "body", "description": "The body parameters for removing team members.", "required": true, "schema": { "$ref": "#/definitions/remove_team_details" } } ], "responses": { "200": { "description": "The request was processed successfully. The response contains the updated team bindings.", "schema": { "$ref": "#/definitions/team_bindings_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/team_bindings/sync": { "post": { "summary": "Copy the team bindings from a source snapshot to a target snapshot.", "description": "Copies the team bindings values from a source snapshot to a target snapshot. This operation is asynchronous. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "syncTeamBindings", "x-display-name": "Synchronize Team Bindings", "tags": [ "Team Binding", "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the snapshots.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the team bindings to be copied.", "required": true, "type": "string" }, { "name": "target_version", "in": "query", "description": "The acronym of the snapshot that the team bindings are to be copied to.", "required": true, "type": "string" } ], "responses": { "202": { "description": "The request to synchronize team bindings was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers": { "get": { "summary": "Retrieve a list of all process applications and toolkits.", "description": "Retrieves a list of all process applications and toolkits on the Workflow Center server or Workflow Server that the user may see. Only Business Automation Workflow users are authorized to perform this call.", "operationId": "getContainers", "x-display-name": "Get Containers", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "type", "in": "query", "description": "Valid values (mutually exclusive): 'PA', 'TK'. Specify 'PA' to view only process applications and 'TK' to view only toolkits. If the value is not set, both are returned.", "x-display-name": "Type of containers to be returned. If neither 'PA' nor 'TK' is specified, then both process applications and toolkits are returned.", "required": false, "type": "string", "enum": [ "PA", "TK" ] }, { "name": "ids", "in": "query", "description": "A comma-separated list of IDs of process applications or toolkits. This parameter restricts the results to the process applications or toolkits with the specified IDs.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "offset", "in": "query", "description": "In a list of entries, the offset specifies the position of the first process application or toolkit to return from the query result set.", "required": false, "type": "integer" }, { "name": "size", "in": "query", "description": "Maximum number of process applications or toolkits to return.", "required": false, "type": "integer", "minimum": 1 }, { "name": "optional_parts", "in": "query", "description": "Valid values: 'branches', 'versions'. Specify 'branches' to see the list of tracks in a process application or toolkit. Specify 'versions' to see, both, the list of tracks and snapshots. Valid values are: 'branches', 'versions'.", "x-display-name": "The values 'branches' and 'versions' respectively determine whether the list of tracks and snapshots is displayed in the response.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "branches", "versions" ] }, "collectionFormat": "csv" } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/containers" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "post": { "summary": "Creates a process application or toolkit", "description": "Creates a process app or toolkit. Only Business Automation Workflow authors are authorized to perform this call.", "operationId": "createContainer", "x-display-name": "Create Container", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container_details", "in": "body", "description": "The body parameters for creating a new process app or toolkit.", "schema": { "$ref": "#/definitions/new_container" } } ], "responses": { "200": { "description": "The process app or toolkit was created successfully.", "schema": { "$ref": "#/definitions/container" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/migrate": { "post": { "summary": "Migrates instances from one snapshot to another snapshot", "description": "Migrate process application instances from one snapshot to another snapshot. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "migrateBPDInstances", "x-display-name": "Migrate Container Instances", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "containerAcronym", "in": "query", "description": "A required parameter that identifies the process application that is to be migrated.", "required": true, "type": "string" }, { "name": "sourceContainerSnapshotAcronym", "in": "query", "description": "Identifies the snapshot that instances will be migrated from (the old version)", "required": true, "type": "string" }, { "name": "targetContainerSnapshotAcronym", "in": "query", "description": "Identifies the snapshot that instances will be migrated to (the new version)", "required": true, "type": "string" }, { "name": "orphanTokenPolicyFile", "in": "formData", "description": "This required parameter identifies a policy file to use during instance migration. This file is distributed to all the nodes in the same network deployment environment and then instance migration is performed on those nodes.", "required": true, "type": "file" }, { "name": "useNetworkAvailablePolicyFile", "in": "query", "description": "This optional parameter must be set to true if the policy file is larger than 100 KB. Save the file in a path accessible to all nodes.", "required": false, "type": "boolean" } ], "responses": { "202": { "description": "The request was successfully processed and the process application instances were successfully migrated.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/migrate_without_policyfile": { "post": { "summary": "Migrates instances from one snapshot to another snapshot without using a policy file", "description": "Migrate process application instances from one snapshot to another snapshot without using a policy file. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "migrateBPDInstancesWithoutPolicy", "x-display-name": "Migrate Container Instances Without Policy File", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "containerAcronym", "in": "query", "description": "A required parameter that identifies the process application that is to be migrated.", "required": true, "type": "string" }, { "name": "sourceContainerSnapshotAcronym", "in": "query", "description": "Identifies the snapshot that instances will be migrated from (the old version)", "required": true, "type": "string" }, { "name": "targetContainerSnapshotAcronym", "in": "query", "description": "Identifies the snapshot that instances will be migrated to (the new version)", "required": true, "type": "string" } ], "responses": { "202": { "description": "The request was successfully processed and the process application instances were successfully migrated.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/check_orphans": { "post": { "summary": "Detects the possibility of orphaned tokens by comparing one snapshot with another", "description": "Detects the possibility of orphaned tokens by comparing one snapshot with another. It allows the user to identify what the system should do with each orphaned token that it encounters during migration. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "checkOrphanTokens", "x-display-name": "Check Orphan Tokens", "tags": [ "Container" ], "produces": [ "application/octet-stream" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "containerAcronym", "in": "query", "description": "A required parameter that identifies the process application that is to be migrated.", "required": true, "type": "string" }, { "name": "sourceContainerSnapshotAcronym", "in": "query", "description": "This parameter identifies the snapshot from which instances will be migrated (the old version)", "required": true, "type": "string" }, { "name": "targetContainerSnapshotAcronym", "in": "query", "description": "This parameter identifies the snapshot to which instances will be migrated (the new version)", "required": true, "type": "string" }, { "name": "outputFile", "in": "query", "description": "A required parameter that provides the file path to where the orphan token policy file will be generated and a name for that file. Must be an XML file.", "required": true, "type": "string" }, { "name": "overwrite", "in": "query", "description": "An optional parameter that forces a replacement of an existing policy file with the new generated file.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "The request was successfully processed and the orphan token policy file was generated.", "schema": { "type": "file" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/count": { "get": { "summary": "Retrieve a count of process applications and toolkits.", "description": "Tells you how many process apps and toolkits match the specified criteria on the Workflow Center server or Workflow Server. Only Business Automation Workflow users are authorized to perform this call.", "operationId": "getContainersCount", "x-display-name": "Count Containers", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "type", "in": "query", "description": "Valid values (mutually exclusive): 'PA', 'TK'. Specify 'PA' to count only process applications and 'TK' to count only toolkits. If the value is not set, both are counted.", "x-display-name": "Type of containers to be counted. If neither 'PA' nor 'TK' is specified, then both process applications and toolkits are counted.", "required": false, "type": "string", "enum": [ "PA", "TK" ] } ], "responses": { "200": { "description": "The request was successfully processed and returned the number of process applications or toolkits that match the specified parameters.", "schema": { "$ref": "#/definitions/resource_count" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/migration_policy": { "post": { "summary": "Extract the information used to migrate instances from other snapshots to the newly installed snapshot.", "description": "Extracts the information used to migrate instances from other snapshots to the newly installed snapshot. Extracts the migration policy from Workflow Center Only Business Automation Workflow authors are authorized to perform this call.", "operationId": "extractMigrationPolicy", "x-display-name": "Extract Migration Policy", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "containerAcronym", "in": "query", "description": "A required parameter that identifies the process application that is to be migrated.", "required": true, "type": "string" }, { "name": "sourceContainerSnapshotAcronym", "in": "query", "description": "This parameter identifies the snapshot instances will be migrated from (the old version)", "required": true, "type": "string" }, { "name": "targetContainerSnapshotAcronym", "in": "query", "description": "This parameter identifies the snapshot instances will be migrated to (the new version)", "required": true, "type": "string" }, { "name": "outputFile", "in": "query", "description": "A required parameter that provides the file path where the orphan token policy file will be generated to and a name for that file. Must be an XML file", "required": true, "type": "string" } ], "responses": { "202": { "description": "The request was successfully processed and the migration was successful.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid parameters or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/migration_policies/{migration_policy}": { "delete": { "summary": "Delete a specified migration policy.", "description": "Deletes the specified migration policy. Only Business Automation Workflow administrators or users with project write permission are authorized to perform this call.", "operationId": "deleteMigrationPolicy", "x-display-name": "Delete Migration Policy", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "migration_policy", "in": "path", "type": "string", "required": true, "description": "The ID of the migration policy." } ], "responses": { "204": { "description": "The migration policy data was successfully deleted." }, "400": { "description": "The request contains an invalid parameter.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request. You must be a Business Automation Workflow administrators or a user with project read permission to perform this call.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested migration policy does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/install": { "post": { "summary": "Install an application on Workflow Server or Workflow Center", "description": "Installs the application from the installation package file (a .zip file for Workflow Server or a .twx file for Workflow Center). This operation is asynchronous. You can see the messages for it in the system log or by using the GET /ops/system/queue/{id} API to periodically query its status. You can find the id value in the url field of the JSON response body. Only Business Automation Workflow authors are authorized to perform this call. For a case solution, choosing the value \"true\" means the process application will be installed and set to inactive while the case solution portions of the application are deployed. Because a case solution always works with its corresponding process application's default snapshot, make sure that the latest deployed case solution works fine with existing default and active snapshot until the recently installed process application snapshot is set as the default and active snapshot. Choosing this option for a case solution that was not deployed in the environment before prevents that case solution from being usable until the corresponding process application snapshot is set as the default and active snapshot.", "operationId": "containerInstall", "x-display-name": "Install", "tags": [ "Container" ], "produces": [ "application/json" ], "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "install_file", "in": "formData", "description": "The file to be installed", "required": true, "type": "file" }, { "name": "inactive", "in": "query", "description": "Deactivates the snapshot after you install it. The default value is false and is ignored in Workflow Center. When the application is a case solution, see the implementation Notes.", "required": false, "default": false, "type": "boolean" }, { "name": "caseDosName", "in": "query", "description": "Specifies the name of the case design object store.", "required": false, "type": "string" }, { "name": "caseProjectArea", "in": "query", "description": "Target environment or project area for case artifacts. You can omit this value if the default project area is defined.", "required": false, "type": "string" }, { "name": "caseOverwrite", "in": "query", "description": "Specifies to overwrite artifacts in the case store if they already exist. The default value is false.", "required": false, "default": false, "type": "boolean" } ], "responses": { "202": { "description": "A request to install the specified file was submitted. This operation is asynchronous. You can see the messages for it in the system log or by using the GET /ops/system/queue/{id} API to periodically query its status. You can find the id value in the 'url' field of the JSON response body.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}": { "get": { "summary": "Retrieve process application or toolkit details.", "description": "Retrieves detailed information for a specified process app or toolkit, including a list of all its snapshots. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "getContainerInfo", "x-display-name": "Get Container Info", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" }, { "name": "optional_parts", "in": "query", "description": "Valid values: 'branches' and 'versions'. Specify 'branches' to see the list of tracks in a process application or toolkit. Specify 'versions' to see, both, the list of tracks and snapshots. Valid values are: 'branches', 'versions'.", "x-display-name": "The values 'branches' and 'versions' respectively determine whether the list of tracks and snapshots is displayed in the response.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "branches", "versions" ] }, "collectionFormat": "csv" } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/container" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "delete": { "summary": "Delete a process application or toolkit.", "description": "Deletes an archived process app or toolkit and all its snapshots from the Workflow Center server. None of them may include dependencies from other process apps. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "deleteContainer", "x-display-name": "Delete process application or toolkit.", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that you want to delete.", "required": true, "type": "string" }, { "name": "ignoreLocks", "in": "query", "description": "Set this parameter to true to delete projects with Case features that have locked artifacts.", "required": false, "type": "boolean", "default": false } ], "responses": { "204": { "description": "The process application or toolkit was successfully deleted." }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "405": { "description": "The requested method is not allowed on this resource.", "schema": { "$ref": "#/definitions/exception" } }, "423": { "description": "The process application or toolkit contains locked artifacts.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/archive": { "post": { "summary": "Archive a deactivated process application or toolkit", "description": "Archives a deactivated process application or toolkit on the Workflow Center server. Only Business Automation Workflow administrators or users with project administration permission are authorized to perform this call.", "operationId": "archiveContainer", "x-display-name": "Archive Container", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The specified process application or toolkit was archived successfully.", "schema": { "$ref": "#/definitions/container" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/restore": { "post": { "summary": "Restore a process application or toolkit that was previously archived.", "description": "Restores a process app or toolkit on the Workflow Center server. Only Business Automation Workflow administrators or users with project administration permission are authorized to perform this call.", "operationId": "restoreContainer", "x-display-name": "Restore Container", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The specified process application or toolkit was restored successfully.", "schema": { "$ref": "#/definitions/container" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "405": { "description": "The requested method is not allowed on this resource.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/update_file": { "post": { "summary": "Update the contents of an external file on the default track.", "description": "Updates external files such as images, stylesheets, JAR files, or other assets that are part of a Business Automation Workflow implementation but are developed outside Process Designer. This API updates the contents of an external file in your process application or toolkit on the default track. Only Business Automation Workflow administrators or users with project write permission are authorized to perform this call.", "operationId": "updateFileDefaultTrack", "x-display-name": "Update File (Default Track)", "tags": [ "Container" ], "produces": [ "application/json" ], "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the file that you want to update.", "required": true, "type": "string" }, { "name": "file_type", "in": "query", "description": "Identifies the type of file that you want to update. The possible values are Web (for example, images, .css files), Server (for example, JAR or JavaScript), or Design (for example, .xsl files).", "required": true, "type": "string", "enum": [ "Web", "Server", "Design" ] }, { "name": "file_name", "in": "query", "description": "The name of the file that you want to update.", "required": true, "type": "string" }, { "name": "update_file", "in": "formData", "description": "The file that you want to update.", "required": true, "type": "file" }, { "name": "file_description", "in": "query", "description": "The description of the file that you want to update.", "required": false, "type": "string" } ], "responses": { "202": { "description": "The request to update a file was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "405": { "description": "The requested method is not allowed on this resource.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/orphaned": { "get": { "summary": "Retrieve a list of orphaned toolkit snapshots.", "description": "Retrieves the information about all toolkit snapshots that other process apps or toolkits on the Workflow Center server or Workflow Server don't refer to. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "getOrphanedToolkits", "x-display-name": "Get Orphaned Toolkits", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "offset", "in": "query", "description": "In a list of entries, the offset specifies the position of the first orphaned toolkit to return from the query result set.", "required": false, "type": "integer" }, { "name": "size", "in": "query", "description": "The maximum number of orphaned toolkits to return.", "required": false, "type": "integer", "minimum": 1 }, { "name": "all_versions_orphaned", "in": "query", "description": "An optional parameter that shows the orphan snapshots of the toolkits. The default is false. If you specify true, only the toolkits that have all of their snapshots orphaned are returned.", "required": false, "type": "boolean" }, { "name": "optional_parts", "in": "query", "description": "Valid values: 'version_details'. Specify 'version_details' to see the branch and snapshot acronym of each orphaned snapshot returned. Valid values are: 'version_details'.", "x-display-name": "The value 'version_details' determines whether the list of orphaned toolkits displays branch and snapshot details in the response.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "version_details" ] }, "collectionFormat": "csv" } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/orphaned_toolkits" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/migration_policies": { "post": { "summary": "Creates migration policies for the selected process application snapshots.", "description": "Creates migration policies for the selected process application snapshots. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "createMigrationPolicies", "x-display-name": "Create Migration Policies", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application that is to have migration policies created.", "required": true, "type": "string" }, { "name": "sourceContainerSnapshotAcronyms", "in": "query", "description": "A comma-separated list of all the snapshots which instances will be migrated from (the old versions)", "required": true, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "targetContainerSnapshotAcronym", "in": "query", "description": "This parameter identifies the snapshot instances will be migrated to (the new version)", "required": true, "type": "string" } ], "responses": { "201": { "description": "The migration policies were successfully created.", "schema": { "$ref": "#/definitions/version_migration_policies_result" } }, "400": { "description": "The request contains invalid parameters or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/orphaned": { "get": { "summary": "Retrieve a list of orphaned toolkit snapshots.", "description": "Retrieves the information about all toolkit snapshots belonging to a specified toolkit that other process apps or toolkits on the Workflow Center server or Workflow Server don't refer to. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "getContainersOrphanedToolkits", "x-display-name": "Get Containers Orphaned Toolkits", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the toolkit.", "required": true, "type": "string" }, { "name": "offset", "in": "query", "description": "In a list of entries, the offset specifies the position of the first orphaned toolkit to return from the query result set.", "required": false, "type": "integer" }, { "name": "size", "in": "query", "description": "The maximum number of orphaned toolkits to return.", "required": false, "type": "integer", "minimum": 1 }, { "name": "all_versions_orphaned", "in": "query", "description": "An optional parameter that shows the orphan snapshots of the toolkits. The default is false. If you specify true, the toolkit will only be returned if it has all of it's snapshots orphaned.", "required": false, "type": "boolean" }, { "name": "optional_parts", "in": "query", "description": "Valid values: 'version_details'. Specify 'version_details' to see the branch and snapshot acronym of each orphaned snapshot returned. Valid values are: 'version_details'.", "x-display-name": "The value 'version_details' determines whether the list of orphaned toolkits displays branch and snapshot details in the response.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "version_details" ] }, "collectionFormat": "csv" } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/orphaned_toolkits" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/available_project_areas": { "get": { "summary": "Retrieve a list of available project areas for a specified case solution.", "description": "Retrieve a list of available project areas for a specified case solution. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "getContainersAvailableProjectAreas", "x-display-name": "Get Containers Available Project Areas", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the case solution.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request was successfully processed and returned the list of available project areas for the specified case solution.", "schema": { "$ref": "#/definitions/result_available_project_areas" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/branches": { "get": { "summary": "Retrieve a list of all tracks for a process application or toolkit.", "description": "Retrieves the information about all the tracks or a subset of the tracks of a specific process app or toolkit on the Workflow Center server or Workflow Server. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "getBranches", "x-display-name": "Get Branches", "tags": [ "Branch" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" }, { "name": "ids", "in": "query", "description": "A comma-separated list of track IDs. This parameter restricts the results to the tracks with the specified IDs.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "offset", "in": "query", "description": "In a list of entries, the offset specifies the position of the first track to return from the query result set.", "required": false, "type": "integer" }, { "name": "size", "in": "query", "description": "Maximum number of tracks to return.", "required": false, "type": "integer", "minimum": 1 }, { "name": "optional_parts", "in": "query", "description": "Valid values: 'versions'. Specify this parameter to view the snapshots in a track. Valid values are: 'versions'.", "x-display-name": "The 'versions' value determines whether a list of snapshots is returned in the response.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "versions" ] }, "collectionFormat": "csv" } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/branches" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "post": { "summary": "Create new track in process application or toolkit.", "description": "Creates a track in a process app or toolkit. Only Business Automation Workflow administrators or users with project write permission are authorized to perform this call.", "operationId": "createBranch", "x-display-name": "Create Branch", "tags": [ "Branch" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" }, { "name": "branch_details", "in": "body", "description": "The body parameters for creating a new track.", "required": true, "schema": { "$ref": "#/definitions/new_branch" } } ], "responses": { "200": { "description": "The track was created successfully.", "schema": { "$ref": "#/definitions/branch" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/branches/count": { "get": { "summary": "Retrieves the count of all the tracks of a process application or toolkit.", "description": "Tells you how many tracks of a specific process app or toolkit are on the Workflow Center server or Workflow Server. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "getBranchesCount", "x-display-name": "Count Branches", "tags": [ "Branch" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request was successfully processed and returned the number of tracks in the specified process application or toolkit.", "schema": { "$ref": "#/definitions/resource_count" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/branches/{branch}": { "get": { "summary": "Retrieve track details.", "description": "Retrieves information about a specified track in a process application or toolkit. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "getBranchInfo", "x-display-name": "Get Branch Info", "tags": [ "Branch" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the track.", "required": true, "type": "string" }, { "name": "branch", "in": "path", "description": "The acronym of the track.", "required": true, "type": "string" }, { "name": "optional_parts", "in": "query", "description": "Valid value: 'versions'. Specify this parameter to view a list of all the snapshots in the track. Valid values are: 'versions'.", "x-display-name": "The value 'versions' determines whether the list of snapshots is displayed in the response.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "versions" ] }, "collectionFormat": "csv" } ], "responses": { "200": { "description": "The track information was successfully retrieved.", "schema": { "$ref": "#/definitions/branch" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/branches/{branch}/update_target_environment": { "post": { "summary": "Update the target environment of the project.", "description": "Updates the target environment of a project branch in the Workflow Center. Only Business Automation Workflow administrators, or users with write permission to the target project are authorized to perform this call.", "operationId": "updateTargetEnvironment", "x-display-name": "Update target environment", "tags": [ "Branch" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit containing the branch.", "required": true, "type": "string" }, { "name": "branch", "in": "path", "description": "The acronym of the branch.", "required": true, "type": "string" }, { "name": "target_environment", "in": "body", "description": "The target environment to change the project to. Values can be: 'traditional', 'container', 'traditional_or_container', 'cp4a'.", "required": true, "schema": { "$ref": "#/definitions/target_environment_body" } } ], "responses": { "200": { "description": "The branch information was successfully updated.", "schema": { "$ref": "#/definitions/branch" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/branches/{branch}/update_dependency": { "post": { "summary": "Update a toolkit dependency.", "description": "Updates a process app or toolkit dependency on a toolkit that is in a Workflow Center. Only Business Automation Workflow administrators, or users with write permission to the target project and read permission to the referenced project, are authorized to perform this call.", "operationId": "updateDependency", "x-display-name": "Update Dependency", "tags": [ "Branch" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit containing the branch.", "required": true, "type": "string" }, { "name": "branch", "in": "path", "description": "The acronym of the branch.", "required": true, "type": "string" }, { "name": "dependency_details", "in": "body", "description": "Body parameters of the dependency to update.", "required": true, "schema": { "$ref": "#/definitions/version_dependency" } } ], "responses": { "200": { "description": "The request was processed successfully.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/branches/{branch}/update_file": { "post": { "summary": "Update the contents of an external file on the specified track.", "description": "Updates external files, such as images, stylesheets, JAR files, or other assets that are part of a Business Automation Workflow implementation but are developed outside Process Designer. This API updates the contents of an external file in your process app or toolkit on the specified track. Only Business Automation Workflow administrators or users with project write permission are authorized to perform this call.", "operationId": "updateFileSpecificTrack", "x-display-name": "Update File (Specific Track)", "tags": [ "Branch" ], "produces": [ "application/json" ], "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the file that you want to update.", "required": true, "type": "string" }, { "name": "branch", "in": "path", "description": "The acronym of the track that you want to update.", "required": true, "type": "string" }, { "name": "file_type", "in": "query", "description": "Identifies the type of file that you want to update. The possible values are Web (for example, images, .css files), Server (for example, JAR or JavaScript), or Design (for example, .xsl files).", "required": true, "type": "string", "enum": [ "Web", "Server", "Design" ] }, { "name": "file_name", "in": "query", "description": "The name of the file that you want to update.", "required": true, "type": "string" }, { "name": "update_file", "in": "formData", "description": "The file that you want to update.", "required": true, "type": "file" }, { "name": "file_description", "in": "query", "description": "The description of the file that you want to update.", "required": false, "type": "string" } ], "responses": { "202": { "description": "The request to update a file was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "405": { "description": "The requested method is not allowed on this resource.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions": { "post": { "summary": "Create snapshots of process applications or toolkits.", "description": "Creates snapshots of process apps or toolkits on the Workflow Center server. You might want to use this API to automate the creation of an offline backup of the current snapshots of your process apps and toolkits. You can use the API for only one process app or toolkit at a time. Only Business Automation Workflow administrators or users with project write permission are authorized to perform this call.", "operationId": "createSnapshot", "x-display-name": "Create Snapshot", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" }, { "name": "version_details", "in": "body", "description": "The body parameters for creating a new snapshot.", "required": true, "schema": { "$ref": "#/definitions/new_version" } } ], "responses": { "200": { "description": "The specified snapshot was created successfully.", "schema": { "$ref": "#/definitions/version" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "get": { "summary": "Retrieve information about all the snapshots or a subset of the snapshots.", "description": "Retrieves information about all the snapshots or a subset of the snapshots of a specific process app or toolkit on the Workflow Center server or Workflow Server. Only Business Automation Workflow administrators users with project read permission are authorized to perform this call. Note: For Workflow Center only named snapshots are returned.", "operationId": "getVersions", "x-display-name": "Get Versions", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" }, { "name": "version_ids", "in": "query", "description": "A comma-separated list of snapshot IDs. This parameter restricts the results to the snapshots with the specified IDs.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "branch", "in": "query", "description": "Specify the track acronym to view only those snapshots that belong to the track. If a track is not specified, all the snapshots of the specified process application or toolkit are returned.", "required": false, "type": "string" }, { "name": "offset", "in": "query", "description": "In a list of entries, the offset specifies the position of the first snapshot to return from the query result set.", "required": false, "type": "integer" }, { "name": "size", "in": "query", "description": "Maximum number of snapshots to return.", "required": false, "type": "integer", "minimum": 1 } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/versions" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "delete": { "summary": "Delete snapshots of process applications or toolkits.", "description": "Deletes process app or toolkit snapshots that match the specified criteria. Having too many snapshots might cause your system to slow down. If that occurs, on Workflow Server find and delete inactive snapshots that don't have running instances and are not deployed. On a Workflow Center server, archive named snapshots. Delete unnamed and archived snapshots when they are obsolete. This operation is asynchronous and returns a URL that you can use to monitor the status of the call. However, this operation doesn't support parallel execution. Because only one snapshot delete operation can occur at a time, ensure the status of the operation is 'success' before invoking the next snapshot delete operation. Messages for this operation are available only in the system log. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "deleteVersions", "x-display-name": "Delete Snapshots", "tags": [ "Version", "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" }, { "name": "branch_name", "in": "query", "description": "Workflow Center server only. The name of the track that is associated with the process application or toolkit. If this parameter is not specified, the default track is used.", "required": false, "type": "string" }, { "name": "versions", "in": "query", "description": "Required for Workflow Server. Optional for Workflow Center server. Use a comma-separated list to specify multiple snapshot acronyms. For a Workflow Center server, if this parameter is specified, you cannot specify any other filters, such as values for the kept_number, created_before, created_after, created_before_version, or delete_archived parameters.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "force", "in": "query", "description": "Workflow Server only. To delete the last and default snapshot of a process application, set this value to 'true'. The default snapshot can be deleted only if it is the last existing snapshot of the process application. When its last snapshot is deleted, the process application is removed.", "required": false, "type": "boolean" }, { "name": "kept_number", "in": "query", "description": "Workflow Center server only. This parameter specifies the number of unnamed snapshots to keep when a snapshot cleanup is run. The most recent snapshots are kept. The tip snapshot is not counted in kept_number. If kept_number is greater than or equal to the total number of unnamed snapshots, no snapshots are deleted. If kept_number equals 0, all the unnamed snapshots are deleted except the tip snapshot. The kept_number parameter cannot be specified with the created_before or created_after parameters.", "required": false, "type": "integer" }, { "name": "created_before", "in": "query", "description": "Workflow Center server only. This parameter specifies the time before which all unnamed snapshots must be deleted. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ss.sssz'.", "required": false, "type": "string", "format": "date-time" }, { "name": "created_after", "in": "query", "description": "Workflow Center server only. This parameter specifies the time after which all unnamed snapshots must be deleted. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ss.sssz'.", "required": false, "type": "string", "format": "date-time" }, { "name": "created_before_version", "in": "query", "description": "Workflow Center server only. This parameter specifies the acronym of a named snapshot. Unnamed snapshots are deleted if they were created before the specified snapshot. When created_before_version is used with the kept_number parameter, the specified number of snapshots is retained. When created_before_version is used with the created_before or created_after parameters, unnamed snapshots are deleted that were created between the time when the named snapshot was created and the time that is specified by the created_before or created_after parameter.", "required": false, "type": "string" }, { "name": "delete_archived", "in": "query", "description": "Workflow Center server only. To delete archived snapshots and unnamed snapshots that match the filter criteria, set this value to 'true'.", "required": false, "type": "boolean" }, { "name": "caseDosName", "in": "query", "description": "Workflow Server only. If you are removing the last snapshot off a server, specify the case design object store name if the content engine is not using the default name 'dos'.", "required": false, "type": "string" }, { "name": "continueOnError", "in": "query", "description": "Workflow Server only. This parameter indicates whether the operation should continue even if an error occurs while deleting one or more versions. When set to 'true', the API will attempt to process all items in the request, skipping over any errors encountered and proceeding with the next item. If set to 'false' (default behaviour), the operation will halt upon encountering the first error, and no further items will be processed. The 'versions' parameter must also be speicied. Refer to the system log to view specific results of which versions were successfully deleted and which encountered errors.", "required": false, "type": "boolean" } ], "responses": { "202": { "description": "The request to delete the specified snapshots was submitted. You can check the progress of the deletion in system log.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "405": { "description": "The requested method is not allowed on this resource.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/count": { "get": { "summary": "Retrieve the count of all the snapshots of a process application or toolkit.", "description": "Retrieves the count of all the snapshots of a specific process app or toolkit on the Workflow Center server or Workflow Server. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "getVersionsCount", "x-display-name": "Count Versions", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" }, { "name": "branch", "in": "query", "description": "Specify the track acronym to count only those snapshots that belong to the track. If a track is not specified, all the snapshots of a process appplication or toolkit are counted.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request was successfully processed and returned the number of snapshots of the specified process application or toolkit.", "schema": { "$ref": "#/definitions/resource_count" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}": { "get": { "summary": "Retrieve the information for a specified snapshot.", "description": "Retrieves detailed information about a specified process app or toolkit snapshot, including the business process management capability it uses and its development status. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "getSnapshotInfo", "x-display-name": "Get Snapshot Info", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that is associated with the snapshot.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/version" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/activate": { "post": { "summary": "Activates a specified process application snapshot or toolkit snapshot", "description": "Activates a snapshot that has been deactivated, stopped, or undeployed. Activated snapshots can receive and process requests. Only Business Automation Workflow administrators or users with project write permission are authorized to perform this call. The process is activated only when you activate a process app. If the process app uses BPEL processes and the templates stopped, follow the instructions in \"Administering BPEL process and task templates\" in the documentation to start the templates.", "operationId": "activate", "x-display-name": "Activate", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit associated with the specified snapshot.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot to be activated.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The specified snapshot was activated successfully.", "schema": { "$ref": "#/definitions/version" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/archive": { "post": { "summary": "Archives a specified process application snapshot or toolkit snapshot", "description": "Archives a specified process app snapshot or toolkit snapshot on the Workflow Center server. When you use the archive function, all active processes related to the snapshot can complete, but new processes can't be started. Only Business Automation Workflow administrators or users with project write permission are authorized to perform this call.", "operationId": "archiveVersion", "x-display-name": "Archive Version", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit associated with the specified snapshot", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot to be archived.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The specified container snapshot was archived successfully.", "schema": { "$ref": "#/definitions/version" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/restore": { "post": { "summary": "Restore a specified process application snapshot or toolkit snapshot that is archived", "description": "Restores a specified process app snapshot or toolkit snapshot on the Workflow Center server. Only Business Automation Workflow administrators or users with project write permission are authorized to perform this call.", "operationId": "restoreVersion", "x-display-name": "Restore Version", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit associated with the specified snapshot", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot to be restored.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The specified container snapshot was restored successfully.", "schema": { "$ref": "#/definitions/version" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "405": { "description": "The requested method is not allowed on this resource.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/deactivate": { "post": { "summary": "Deactivate a process application snapshot or a toolkit snapshot", "description": "Deactivates an active process app snapshot or toolkit snapshot. When you use the deactivation function, new requests are prevented but existing instances and in-flight requests complete. Using the optional parameters, you can deactivate the default snapshot and suspend in-flight instances. Also, you can deactivate the default snapshot without using the optional -force parameter. Check whether the snapshot is the default snapshot before you deactivate it because, when there is only one snapshot for a process app deactivating the default snapshot might be intended; however, when there is more than one snapshot, you must set another snapshot as the default before you deactivate the current default snapshot. Only Business Automation Workflow administrators or users with project write permission are authorized to perform this call.", "operationId": "deactivate", "x-display-name": "Deactivate", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application (Workflow Server and Workflow Center) or toolkit (Workflow Center only) associated with the specified snapshot.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the process application snapshot (Workflow Server and Workflow Center) or toolkit snapshot (Workflow Center only) to be deactivated.", "required": true, "type": "string" }, { "name": "force", "in": "query", "description": "An optional parameter that deactivates the default snapshot of the process application or toolkit", "required": false, "type": "boolean" }, { "name": "suspend_bpd_instances", "in": "query", "description": "An optional parameter that suspends all instances associated with the given context instead of letting them continue to run. The instances remain suspended until you resume them.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "The specified snapshot was successfully deactivated.", "schema": { "$ref": "#/definitions/version" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/export": { "get": { "summary": "Exports a specified process application snapshot or toolkit snapshot", "description": "Enables the exchange of a process app or toolkit between Workflow Center servers. This API exports a specified process app snapshot or toolkit snapshot as a .twx file that you can import into a Workflow Center server. The suggested file name is URL-encoded in the Content-Disposition HTTP response header. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "export", "x-display-name": "Export", "tags": [ "Version" ], "produces": [ "application/octet-stream" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit associated with the specified snapshot.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot to be exported.", "required": true, "type": "string" }, { "name": "format", "in": "query", "description": "The format of the export. If the value is not specified, system toolkits are exported. A value of twxWithoutToolkits skips exporting system toolkits that are not versioned (the latest version is already on the server).", "required": false, "type": "string" }, { "name": "use_enhanced_filenames", "in": "query", "description": "A value of true produces more meaningful file names within the exported file. If the value is false or unspecified, the default internal format is used.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "The specified snapshot was exported successfully.", "schema": { "type": "file" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "type": "file" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "type": "file" } }, "404": { "description": "The requested operation does not exist.", "schema": { "type": "file" } }, "500": { "description": "Internal server error.", "schema": { "type": "file" } } } } }, "/std/bpm/containers/{container}/versions/{version}/install": { "post": { "summary": "Install a process application on a connected workflow server.", "description": "Installs a process app snapshot from Workflow Center to an online Workflow server in a test or production environment. The operation runs asynchronously and, unless the -skipGovernance parameter is set to true, the installation might successfully complete before the governance process finishes. Also, if the process app contains advanced content, advanced deployment might complete after the command returns successfully. Check the state of the snapshot to verify whether it has been deployed, and check the server logs for errors if the state doesn't change to active. When installing to production environments, only Business Automation Workflow administrators or users with project administration permission are authorized to perform this call. When installing to staging or test environments, only Business Automation Workflow administrators or users with project write permission are authorized to perform this call. When installing to development environments, only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "install", "x-display-name": "Install", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM BPM REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application associated with the snapshot that you want to install.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that you want to install.", "required": true, "type": "string" }, { "name": "server", "in": "query", "description": "The name of the Workflow Server instance where you are installing the snapshot.", "required": true, "type": "string" }, { "name": "skip_governance", "in": "query", "description": "Set this value to true to skip human approvals in the processing of a snapshot installation. It is set to false by default.", "required": false, "default": false, "type": "boolean" }, { "name": "case_project_area", "in": "query", "description": "If the snapshot contains case artifacts, provide the name of the project area for the target environment.", "required": false, "type": "string" }, { "name": "migration_instructions", "in": "body", "description": "An array of migration instructions for other snapshots.", "default": [ ], "required": false, "schema": { "$ref": "#/definitions/migration_instructions" } } ], "responses": { "202": { "description": "A request to install the specified snapshot was submitted. You can check the progress of the installation in system log or in the workflow server by using the install_messages API.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/install_messages": { "get": { "summary": "Retrieve the installation messages for the process application snapshot", "description": "Retrieves the installation messages for the process app snapshot. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "getInstallMessages", "x-display-name": "Get Install Messages", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application that contains the installation messages", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the installation messages", "required": true, "type": "string" }, { "name": "server", "in": "query", "description": "The name of the Workflow Server where the install occurred. This parameter is required and only valid when running on a Workflow Center. An aggregation of installation messages is generated from both the Workflow Center and Workflow Server.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The installation messages were successfully retrieved.", "schema": { "$ref": "#/definitions/install_messages_result" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/install_package": { "get": { "summary": "Export the installation package for a process application snapshot.", "description": "Creates a generic installation package (.zip file) for a process app snapshot, which you use to install a process app on any Workflow Server. The suggested file name is URL-encoded in the Content-Disposition HTTP response header. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "exportInstallPackage", "x-display-name": "Export Install Package", "tags": [ "Version" ], "produces": [ "application/octet-stream" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application associated with the specified snapshot.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot to be exported.", "required": true, "type": "string" }, { "name": "server", "in": "query", "description": "The name of the Workflow Server instance from which you are extracting the offline installation package.", "required": false, "type": "string" }, { "name": "format", "in": "query", "description": "The format of the export. If the value is not specified, system toolkits are exported. A value of twxWithoutToolkits skips exporting system toolkits that are not versioned (the latest version is already on the server).", "required": false, "type": "string" }, { "name": "use_enhanced_filenames", "in": "query", "description": "A value of true produces more meaningful file names within the exported file. If the value is false or unspecified, the default internal format is used.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "The specified snapshot install package was exported successfully.", "schema": { "type": "file" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "type": "file" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "type": "file" } }, "404": { "description": "The requested operation does not exist.", "schema": { "type": "file" } }, "500": { "description": "Internal server error.", "schema": { "type": "file" } } } } }, "/std/bpm/containers/{container}/versions/{version}/migration_policies": { "get": { "summary": "Retrieve the generated migration policies for the process application snapshot.", "description": "Retrieves the migration policy information for the process app snapshot. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "getVersionMigrationPolicies", "x-display-name": "Get Version Migration Policies", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application associated with the specified snapshot.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the generated migration policies.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The migration policy data was successfully retrieved.", "schema": { "$ref": "#/definitions/version_migration_policies_result" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/migration_policies/{migration_policy}/export": { "get": { "summary": "Exports a specified migration policy.", "description": "Exports a specified migration policy as a .xml file that you can then use for process instance migration. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "migrationPolicyExport", "x-display-name": "Export Migration Policy", "tags": [ "Version" ], "produces": [ "application/octet-stream" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the container containing the migration policy to be exported.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the target version for the migration policy to be exported.", "required": true, "type": "string" }, { "name": "migration_policy", "in": "path", "type": "string", "required": true, "description": "The ID of the migration policy to be exported." }, { "name": "source_version", "in": "query", "description": "The acronym of the version that instances will be migrated from", "required": true, "type": "string" } ], "responses": { "200": { "description": "The specified migration policy was exported successfully.", "schema": { "type": "file" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request. You must be a Business Automation Workflow administrators or a user with project read permission to perform this call.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested migration policy does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/make_default": { "post": { "summary": "Designate a default snapshot on a workflow server.", "description": "Designates the first snapshot that you install as the default version that runs when an event or other trigger that applies to more than one version of a process or service is received. When you install subsequent snapshots, you can use this API to set the snapshot you want as the default. Only Business Automation Workflow administrators or users with project administration permission are authorized to perform this call.", "operationId": "defaultVersion", "x-display-name": "Make default version", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM BPM REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application associated with the snapshot that you want to set as the default.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that you want to set as the default.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The specified snapshot was set to default successfully.", "schema": { "$ref": "#/definitions/version" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "405": { "description": "The requested method is not allowed on this resource.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/stop": { "post": { "summary": "Stop the BLA associated with a deactivated snapshot on a workflow server.", "description": "Stops the business-level application (BLA) associated with a snapshot that has already been deactivated on a Workflow Server. A BLA is a WebSphere Application Server configuration artifact that is created only for a snapshot that has advanced content generated in Integration Designer. Only Business Automation Workflow administrators or users with project administration permission are authorized to perform this call.", "operationId": "stopVersion", "x-display-name": "Stop version", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM BPM REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application associated with the snapshot that you want to stop.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that you want to stop.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The specified snapshot was successfully stopped.", "schema": { "$ref": "#/definitions/version" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "405": { "description": "The requested method is not allowed on this resource.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/offline_package": { "post": { "summary": "Create an installation package for a process application snapshot.", "description": "Creates an installation package for a process app snapshot on the Workflow Center server. This operation is asynchronous and, unless the -skipGovernance parameter is set to true, creating the installation package might successfully complete before the governance process finishes. Also, if the process app contains advanced content, advanced deployment might complete after the command returns successfully. Only Business Automation Workflow administrators or users with project read permission are authorized to perform this call.", "operationId": "offlinePackage", "x-display-name": "Create Offline Package", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application associated with the snapshot that you want to install.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that you want to install.", "required": true, "type": "string" }, { "name": "server", "in": "query", "description": "The name of the offline Workflow Server instance where you want to install the snapshot.", "required": true, "type": "string" }, { "name": "skip_governance", "in": "query", "description": "Set this value to true to skip human approvals in the processing of a snapshot installation. It is set to false by default.", "required": false, "type": "boolean" }, { "name": "format", "in": "query", "description": "The format of the export. If the value is not specified, system toolkits are exported. A value of twxWithoutToolkits skips exporting system toolkits that are not versioned (the latest version is already on the server).", "required": false, "type": "string" }, { "name": "use_enhanced_filenames", "in": "query", "description": "A value of true produces more meaningful file names within the exported file. If the value is false or unspecified, the default internal format is used.", "required": false, "type": "boolean", "default": false } ], "responses": { "202": { "description": "The installation package was successfully created.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/pdw/prune": { "post": { "summary": "Invoke the PDW prune command.", "description": "Invokes the PDW prune command. Use this command to remove data that you no longer need from the Performance Data Warehouse database. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response. Only Business Automation Workflow administrators are authorized to perform this call. Not available on Containers.", "operationId": "prunePDW", "x-display-name": "Prune PDW", "tags": [ "Performance Data Warehouse", "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "age", "in": "query", "description": "The minimum age in days of the data that should be removed. The age is based on the current server time.", "required": true, "type": "integer", "format": "int32", "minimum": 1 } ], "responses": { "202": { "description": "The request to remove data from the Performance Data Warehouse database was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/historical_data_playback": { "post": { "summary": "Play back historical event data and send it to IBM Business Automation Insights.", "description": "Plays back process-related events stored in the PDW and BPM databases and sends them to Business Automation Insights. Only Business Automation Workflow administrators are authorized to perform this call. Not available on Containers.", "operationId": "historical_data_playback", "x-display-name": "Play Back Historical Data for IBM Business Automation Insights", "tags": [ "Performance Data Warehouse" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "containers", "in": "query", "description": "A comma-separated list of container acronyms. Restricts the playback of events to instances that belong to the specified process application acronyms.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "start_date", "in": "query", "description": "The date from which to start processing events. If not specified, process instance data is played back up to the end_date, if specified.", "required": false, "type": "string", "format": "date-time" }, { "name": "end_date", "in": "query", "description": "The date to stop processing events. If not specified, process instance data is played back up to the current date and time.", "required": false, "type": "string", "format": "date-time" }, { "name": "skip_duplicates_check", "in": "query", "description": "Use this parameter in conjunction with tracing to troubleshoot event playback. By default, events are generated and played back only once from Performance Data Warehouse; subsequent calls to the API will not send the same events again. However, you can replay these events without sending them to Business Automation Insights by setting this parameter to true.", "required": false, "type": "boolean" }, { "name": "event_count_only", "in": "query", "description": "If the value is set to true, return only an estimated count of the number of events that will be sent to IBM Business Automation Insights. The estimate is based on the values of the other parameters. If a value is not specified, the default is false.", "required": false, "type": "boolean" } ], "responses": { "202": { "description": "The playback request was submitted. You can check the progress of the playback in the system log.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/system/group_membership_update": { "post": { "summary": "Invoke the group membership update command.", "description": "Invokes the group membership update command. This operation is asynchronous. It updates the group membership of the users specified with this command. You can call it when the group memberships of users in the user registry (for example, LDAP) have changed to inform Business Automation Workflow about the changes. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "updateGroupMembership", "x-display-name": "Update Group Membership for Users", "tags": [ "System" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "update_dynamic_groups", "in": "query", "description": "If you omit this parameter or specify the value 'default', dynamic groups are only updated if a group membership change was detected. If you specify the value 'always', dynamic groups are always updated. If you specify the value 'never', dynamic groups are not updated.", "required": false, "type": "string", "enum": [ "default", "always", "never" ] }, { "name": "users", "in": "body", "description": "The user names to be handled. If a specified user name is known to the user registry but unknown to IBM Business Automation Workflow, this user is added to the IBM Business Automation Workflow database. To indicate that all known users should be handled, pass the single element array [ \"ALL_USERS\" ].", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "202": { "description": "The request to update group memberships was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/system/umsteam_membership_update": { "post": { "summary": "Invoke the UMS Teams membership update command.", "description": "Invokes the UMS Teams membership update command. This operation is asynchronous. It updates the membership of the users specified with this command for UMS teams. You can call it when the memberships of users in the UMS Teams service have changed to inform Business Automation Workflow about the changes. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "updateUMSTeamMembership", "x-display-name": "Update UMS Team Membership for Users", "tags": [ "System" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "users", "in": "body", "description": "The user names to be handled. If a specified user name is known to the user registry but unknown to IBM Business Automation Workflow, this user is added to the IBM Business Automation Workflow database. To indicate that all known users should be handled, pass the single element array [ \"ALL_USERS\" ].", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "202": { "description": "The request to update UMS team memberships was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/users/{user_id}/sync": { "post": { "summary": "Synchronizes the user.", "description": "Synchronizes the internal and the external user data, updating the full name of the user and, depending on the query parameters, might also activate or deactivate the user in the Business Automation Workflow database. Only Business Automation Workflow administrators and users who fulfill the ACTION_DELETE_USER_PERSONAL_DATA or ACTION_REFRESH_USER action policies are authorized to perform this call.", "operationId": "syncUser", "x-display-name": "Synchronize User", "tags": [ "User Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "user_id", "in": "path", "description": "Identifier of the user to synchronize.", "required": true, "type": "string" }, { "name": "sync_user_state", "in": "query", "description": "If you want to update the user state in the IBM Business Automation Workflow database, set the value to 'true'. If the user was deleted from the user registry, the user is made inactive in the IBM Business Automation Workflow database. If the user is reactivated in the user registry, it becomes active in the IBM Business Automation Workflow database. The default is false.", "required": false, "type": "boolean" }, { "name": "sync_attributes", "in": "query", "description": "A comma-separated list of user attributes to be transferred from the user registry to the IBM Business Automation Workflow database. This allows to transfer the email and phone numbers of the user while synchronizing the user. This works only of the user registry is configured for containing user email and phone numbers. By default, it transfers no user attributes. Valid values are: 'email', 'phone'.", "x-display-name": "Select the user attributes to be transferred from the user registry to the IBM Business Automation Workflow database.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "email", "phone" ] }, "collectionFormat": "csv" }, { "name": "enable_preferences", "in": "query", "description": "A comma-separated list of user preferences to be set to true in the IBM Business Automation Workflow database. In addition to 'notification' or 'assignandrun', other custom user attribute names might also be specified, provided that they have been defined in Process Designer and are of type boolean. This allows to enable preferences of the synchronized user.", "x-display-name": "Select the user preferences to be enabled.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "disable_preferences", "in": "query", "description": "A comma-separated list of user preferences to be set to false in the IBM Business Automation Workflow database. In addition to 'notification' or 'assignandrun', other custom user attribute names might also be specified, provided that they have been defined in Process Designer and are of type boolean. This allows to disable preferences of the synchronized user.", "x-display-name": "Select the user preferences to be disabled.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" } ], "responses": { "200": { "description": "The request was processed successfully. The response contains information about how many users were synchronized and how many users were already up-to-date.", "schema": { "$ref": "#/definitions/sync_result" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested user does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/system/users_sync": { "post": { "summary": "Invoke the user synchronize command.", "description": "Invokes the user synchronize command. This operation is asynchronous. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response. Only Business Automation Workflow administrators and users who fulfill the ACTION_DELETE_USER_PERSONAL_DATA or ACTION_REFRESH_USER action policies are authorized to perform this call.", "operationId": "syncUsers", "x-display-name": "Synchronize Users", "tags": [ "System" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "sync_user_state", "in": "query", "description": "If you want to update the user state in the IBM Business Automation Workflow database, set the value to 'true'. If the user was deleted from the user registry, the user is made inactive in the IBM Business Automation Workflow database. If the user is reactivated in the user registry, it becomes active in the IBM Business Automation Workflow database. The default is false.", "required": false, "type": "boolean" }, { "name": "add_to_db", "in": "query", "description": "If you want to add users from the user registry to the IBM Business Automation Workflow database, set the value to 'true'. If the value is 'false', only users that already exist in the IBM Business Automation Workflow data base are treated. The default is false.", "required": false, "type": "boolean" }, { "name": "sync_attributes", "in": "query", "description": "A comma-separated list of user attributes to be transferred from the user registry to the IBM Business Automation Workflow database. This allows to transfer the email and phone numbers of users while synchronizing the users. This works only of the user registry is configured for containing user email and phone numbers. By default, it transfers no user attributes. Valid values are: 'email', 'phone'.", "x-display-name": "Select the user attributes to be transferred from the user registry to the IBM Business Automation Workflow database.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "email", "phone" ] }, "collectionFormat": "csv" }, { "name": "enable_preferences", "in": "query", "description": "A comma-separated list of user preferences to be set to true in the IBM Business Automation Workflow database. In addition to 'notification' or 'assignandrun', other custom user attribute names might also be specified, provided that they have been defined in Process Designer and are of type boolean. This allows to enable preferences of all synchronized users.", "x-display-name": "Select the user preferences to be enabled.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "disable_preferences", "in": "query", "description": "A comma-separated list of user preferences to be set to false in the IBM Business Automation Workflow database. In addition to 'notification' or 'assignandrun', other custom user attribute names might also be specified, provided that they have been defined in Process Designer and are of type boolean. This allows to disable preferences of all synchronized users.", "x-display-name": "Select the user preferences to be disabled.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "users", "in": "body", "description": "The user names that should be synchronized. To indicate that all users should be synchronized, pass the single element array [ \"ALL_USERS\" ].", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "202": { "description": "The request to synchronize users was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/system/groups_sync": { "post": { "summary": "Invoke the group membership synchronize command.", "description": "Invokes the group membership synchronize command. This operation is asynchronous. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "syncGroups", "x-display-name": "Synchronize Groups", "tags": [ "System" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "add_groups_to_db", "in": "query", "description": "If you want to add groups from the user registry to the IBM Business Automation Workflow database, set the value to 'true'. If the value is 'false' only groups that already exist in the IBM Business Automation Workflow data base are synchronized. The default is false.", "required": false, "type": "boolean" }, { "name": "add_users_to_db", "in": "query", "description": "If you want to add users that are member of the treated groups from the user registry to the IBM Business Automation Workflow database, set the value to 'true'. If the value is 'false' only the group membership of users that already exist in the IBM Business Automation Workflow data base are synchronized. The default is false.", "required": false, "type": "boolean" }, { "name": "sync_group_state", "in": "query", "description": "If you want to update the group state in the IBM Business Automation Workflow database, set the value to 'true'. If the group was deleted from the user registry, the group is made inactive in the IBM Business Automation Workflow database. If the group is reactivated in the user registry, it becomes active in the IBM Business Automation Workflow database. The default is false.", "required": false, "type": "boolean" }, { "name": "migrate_group_type", "in": "query", "description": "If you want to migrate the group type from Internal group to Security Group in the IBM Business Automation Workflow database, set the value to 'true'. If a group with the same group name, like the internal group exists in the user registry, the group type becomes security group in the IBM Business Automation Workflow database. The default is false.", "required": false, "type": "boolean" }, { "name": "groups", "in": "body", "description": "The group names that should be synchronized. To indicate that all groups should be synchronized, pass the single element array [ \"ALL_GROUPS\" ].", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "202": { "description": "The request to synchronize groups was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/system/umsteams_sync": { "post": { "summary": "Invoke the UMS Teams membership synchronize command.", "description": "Invokes the UMS Teams membership synchronize command. This operation is asynchronous. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response. This operation can be used if IBM Business Automation Workflow is connected to the UMS Teams service. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "syncUMSTeams", "x-display-name": "Synchronize UMS Teams", "tags": [ "System" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "add_teams_to_db", "in": "query", "description": "If you want to add teams from the UMS Teams service to the IBM Business Automation Workflow database, set the value to 'true'. If the value is 'false' only UMS Teams that already exist in the IBM Business Automation Workflow data base are synchronized. The default is false.", "required": false, "type": "boolean" }, { "name": "add_users_to_db", "in": "query", "description": "If you want to add users that are member of the treated UMS teams to the IBM Business Automation Workflow database, set the value to 'true'. If the value is 'false' only the team membership of users that already exist in the IBM Business Automation Workflow data base are synchronized. The default is false.", "required": false, "type": "boolean" }, { "name": "sync_team_state", "in": "query", "description": "If you want to update the group state for groups corresponding to UMS teams in the IBM Business Automation Workflow database, set the value to 'true'. If the team was deleted from the UMS Teams service, its corresponding group is made inactive in the IBM Business Automation Workflow database. If the team is reactivated in the UMS Teams sercice, its corresponding group becomes active in the IBM Business Automation Workflow database. The default is false. If this parameter is set to true and team names are specified, the uuids of teams must be used as team names in order to recognize correctly which groups must be made inactive.", "required": false, "type": "boolean" }, { "name": "migrate_group_type", "in": "query", "description": "If you want to migrate the group type from Internal group type to UMS Teams group typein the IBM Business Automation Workflow database, set the value to 'true'. If a team with the same uuid or distinguished name, like the internal group exists, the group type becomes UMS team in the IBM Business Automation Workflow database. The default is false.", "required": false, "type": "boolean" }, { "name": "teams", "in": "body", "description": "The uuids or distinguished names of teams from the UMS Teams service that should be synchronized. To indicate that all teams should be synchronized, pass the single element array [ \"ALL_TEAMS\" ].", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "202": { "description": "The request to synchronize UMS teams was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/adv/bpm/processes/count": { "get": { "summary": "Retrieve a count of BPEL process instances in end states.", "description": "Tells you how many BPEL process instances are in end states that match particular criteria. For more information about which roles are authorized to perform this call, see the documentation.", "operationId": "getBPELProcessesCount", "x-display-name": "Count BPEL Processes", "tags": [ "BPEL", "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "states", "in": "query", "description": "A comma-separated list of states. The default is that all instances that are in the state 'finished', 'terminated' or 'failed' are returned. Valid values are: 'failed', 'finished', 'terminated'.", "x-display-name": "Select the states of interest to restrict the instances in the result to those in the specified states.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "failed", "finished", "terminated" ] }, "collectionFormat": "csv" }, { "name": "model", "in": "query", "description": "The process template name of the BPEL processes. Restricts the results to process instances of the specified process template.", "required": false, "type": "string" }, { "name": "valid_from", "in": "query", "description": "Only process instances of a process template that is valid from this point in time are returned. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ssz'. This parameter is only valid if the model parameter is specified.", "required": false, "type": "string", "format": "date-time" }, { "name": "ended_before", "in": "query", "description": "Only process instances that completed before this point in time are returned. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ssz'.", "required": false, "type": "string", "format": "date-time" }, { "name": "ended_after", "in": "query", "description": "Only process instances that completed after this point in time are returned. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ssz'.", "required": false, "type": "string", "format": "date-time" }, { "name": "starter", "in": "query", "description": "The user ID of the process starter. Restricts the results to process instances started by the specified user.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request was processed successfully and returned the number of BPEL process instances that match the specified query parameters.", "schema": { "$ref": "#/definitions/resource_count" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } }, "501": { "description": "Not implemented.", "schema": { "$ref": "#/definitions/exception" } }, "503": { "description": "Service unavailable.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/adv/bpm/processes": { "delete": { "summary": "Delete specified BPEL process instances.", "description": "Deletes specified BPEL process instances according to their process instance states, process models, valid-from dates, completion dates, or according to which user started the process instance. This operation is asynchronous. You can find messages for this operation only in the system log. For more information about which roles are authorized to perform this call, see the documentation.", "operationId": "deleteBPELProcesses", "x-display-name": "Delete BPEL Processes", "tags": [ "BPEL", "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "states", "in": "query", "description": "A comma-separated list of states. The default is that all instances in state finished, terminated or failed are deleted. Valid values are: 'failed', 'finished', 'terminated'.", "x-display-name": "Select the states of interest to restrict the instances in the result to those in the specified states.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "failed", "finished", "terminated" ] }, "collectionFormat": "csv" }, { "name": "model", "in": "query", "description": "The process template name of the BPEL processes to delete.", "required": false, "type": "string" }, { "name": "valid_from", "in": "query", "description": "Only process instances of a process template that is valid from this point in time are deleted. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ssz'. This parameter is only valid if the model parameter is specified.", "required": false, "type": "string", "format": "date-time" }, { "name": "ended_before", "in": "query", "description": "Only process instances that completed before this point in time are deleted. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ssz'.", "required": false, "type": "string", "format": "date-time" }, { "name": "ended_after", "in": "query", "description": "Only process instances that completed after this point in time are deleted. Specify the time in ISO 8601 format 'yyyy-MM-dd'T'HH:mm:ssz'.", "required": false, "type": "string", "format": "date-time" }, { "name": "starter", "in": "query", "description": "The user ID of the user who started the process instance.", "required": false, "type": "string" } ], "responses": { "202": { "description": "The request to delete the specified process instances was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "204": { "description": "No instances matching the request were found to delete." }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } }, "501": { "description": "Not implemented.", "schema": { "$ref": "#/definitions/exception" } }, "503": { "description": "Service unavailable.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/users/{user_id}/personal_data": { "get": { "summary": "Retrieve user's personal data.", "description": "Retrieves the personal data of the specified user. Personal data contains the user attributes, a user avatar, the group the user is a member of, the user's online status, the user's server ID, and the task measurement data. Only Business Automation Workflow administrators who want to view their own personal data and users who fulfill the ACTION_VIEW_USER_PERSONAL_DATA or ACTION_DELETE_USER_PERSONAL_DATA action policies are authorized to perform this call.", "operationId": "getPersonalData", "x-display-name": "Get user personal data", "tags": [ "User Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "user_id", "in": "path", "type": "string", "required": true, "description": "Identifier of the user to retrieve" } ], "responses": { "200": { "description": "Personal data of the specified user are returned in the response", "schema": { "$ref": "#/definitions/user_personal_data" } }, "400": { "description": "The request contains invalid parameter", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested user does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "delete": { "summary": "Delete user's personal data.", "description": "Deletes the personal data for the specified user. Only Business Automation Workflow administrators and users who fulfill the ACTION_DELETE_USER_PERSONAL_DATA action policy are authorized to perform this call.", "operationId": "deletePersonalData", "x-display-name": "Delete personal data", "tags": [ "User Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "user_id", "in": "path", "type": "string", "required": true, "description": "Identifier of the user." } ], "responses": { "204": { "description": "The personal data was successfully deleted." }, "400": { "description": "The request contains invalid parameter", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested user does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The personal data of the user that was specified cannot be deleted because the user is not deactivated'.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/users/remove_personal_data": { "post": { "summary": "Bulk delete personal data for multiple users.", "description": "Deletes the personal data for multiple deactivated users in a single operation. This API accepts a list of user IDs and processes them in bulk. Only Business Automation Workflow administrators and users who fulfill the ACTION_DELETE_USER_PERSONAL_DATA action policy are authorized to perform this call. All users must be deactivated before their personal data can be deleted.", "operationId": "bulkRemovePersonalData", "x-display-name": "Bulk delete personal data", "tags": [ "User Management" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "bulkRemovePersonalDataRequest", "in": "body", "description": "Request containing list of user IDs for bulk deletion", "required": true, "schema": { "$ref": "#/definitions/bulkRemovePersonalDataRequest" } } ], "responses": { "201": { "description": "Bulk deletion completed. Response contains summary and detailed results for each user.", "schema": { "$ref": "#/definitions/bulkRemovePersonalDataResponse" } }, "400": { "description": "The request contains invalid parameters or empty user list.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/user/{user_id}/attributes": { "delete": { "summary": "Deletes the user's attribute values that were set. These attributes have predefined values.", "description": "Deletes the user's attribute values that were set. These attributes have predefined values. This API is subject to authorization check based on Process Admin Console security properties setttings.", "operationId": "deleteAttributeValue", "x-display-name": "Delete User Attribute Value", "tags": [ "User Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "user_id", "in": "path", "description": "ID of the user.", "required": true, "type": "string" }, { "name": "attributes", "in": "query", "decription": "A list of attributes for which values will be unset", "required": true, "type": "array", "items": { "type": "string" } } ], "responses": { "204": { "description": "The attribute of specified user was successfully deleted." }, "400": { "description": "The request contains invalid parameter", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested user does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/user/currentuser/repair_token": { }, "/std/bpm/user/refresh_api_key": { }, "/std/bpm/durable_messages": { "delete": { "summary": "Delete old durable subscription messages.", "description": "Deletes durable subscriptions, which are Java Message Service (JMS) subscriptions that persist and store subscribed messages even when the client is not connected. Durable subscription messages exist and persist in the database if durable subscriptions are enabled for message events or content events of the following types: intermediate, boundary, and start events of event subprocesses. This API deletes durable subscription messages based on their age. You can use this operation to reduce storage space the database uses. This operation is asynchronous. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response. Only Business Automation Workflow administrators are authorized to perform this call.", "operationId": "deleteDurableMessages", "x-display-name": "Delete Durable Messages", "tags": [ "Health Management" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "older_than", "in": "query", "description": "Specifies an age in days and must be greater than 0. Durable subscription messages that are older than the specified age are deleted. TIP: A day is interpreted as a period of 24 hours rather than as a calendar day. For example, if you specify a value of 3 for the older_than parameter, it is interpreted as 72 hours rather than as 3 calendar days. As a result, all durable subscription messages that are older than 72 hours will be deleted. However, durable subscription messages that were created 3 calendar days ago, but less than 72 hours ago, will not be deleted.", "required": true, "type": "integer" }, { "name": "maximum_duration", "in": "query", "description": "Specifies the maximum duration of the deletion operation in minutes. The default value is 0 (which is equivalent to an unlimited number of minutes). The value must be greater than or equal to 0. When the maximum duration is exceeded, the command is aborted after the current transaction has committed.", "required": false, "type": "integer" }, { "name": "transaction_slice", "in": "query", "description": "Specifies the number of durable subscription message instances that are deleted with each transaction. The default value is 1000. The value must be greater than 0.", "required": false, "type": "integer" } ], "responses": { "202": { "description": "The request to delete durable messages was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request. The caller must have administrative privileges to delete durable messages.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/servers/rest/": { "get": { "summary": "Retrieve a list of REST Server definitions.", "description": "This API retrieves a list of REST Server definitions. Authentications can be retrieved by using the 'authentications' sub resource. You must be an IBM Business Automation Workflow administrator to retrieve REST Server definitions. -All the authentication information that is required to invoke a REST service operation is defined in an authentication.", "operationId": "getRESTServerDefinitions", "x-display-name": "Get REST Server Definitions", "tags": [ "REST Server" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "Process application acronym", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "Process application snapshot acronym", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request completed successfully and returned a list of REST Server definitions.", "schema": { "$ref": "#/definitions/rest_server_definitions" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/servers/rest/{server_name}": { "put": { "summary": "Set the definition of a REST Server.", "description": "This API sets the values of a REST Server definition. You must be an IBM Business Automation Workflow administrator to update REST Server definitions. -All the authentication information that is required to invoke a REST service operation is defined in an authentication. The server name is used as the identifier, and must match with the server_name request parameter. It cannot be changed. The properties port and ssl_configuration are optional. If the port is omitted, the server definition is updated to use the default port of the protocol. If the ssl_configuration is not specified, no SSL configuration is used. Other properties are mandatory.", "operationId": "setRESTServerDefinition", "x-display-name": "Set REST Server Definition", "tags": [ "REST Server" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "Process application acronym", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "Process application snapshot acronym", "required": true, "type": "string" }, { "name": "server_name", "in": "path", "description": "REST Server name", "required": true, "type": "string" }, { "name": "rest_server_definition", "in": "body", "description": "The values used to update the specified REST Server definition.", "required": true, "schema": { "$ref": "#/definitions/rest_server_definition" } } ], "responses": { "200": { "description": "The REST Server definition was successfully updated.", "schema": { "$ref": "#/definitions/rest_server_definition" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The REST Server does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/servers/rest/{server_name}/authentications/": { "get": { "summary": "Retrieve authentications of a REST Server.", "description": "This API retrieves authentications of a REST Server. You must be an IBM Business Automation Workflow administrator to retrieve authentications of a REST Server. All the authentication information that is required to invoke a REST service operation is defined in an authentication. Specifying an empty list of authentications means no authentication.", "operationId": "getRESTServerAuthentications", "x-display-name": "Get REST Server authentications", "tags": [ "REST Server" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "Process application acronym", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "Process application snapshot acronym", "required": true, "type": "string" }, { "name": "server_name", "in": "path", "description": "REST Server name", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request completed successfully and returned a list of authentications of a REST Server.", "schema": { "$ref": "#/definitions/rest_server_authentications" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The REST Server does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "put": { "summary": "Update authentications of a REST server.", "description": "This API updates authentications of a REST server. You must be an IBM Business Automation Workflow administrator to update authentications. All the authentication information that is required to invoke a REST service operation is defined in an authentication. Its authentication type cannot be changed. For basic authentication either username and password or invocation credentials must be specified. Specifying an empty list of authentications means no authentication.", "operationId": "updateRESTServerAuthentications", "x-display-name": "Update REST Server authentications", "tags": [ "REST Server" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "Process application acronym", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "Process application snapshot acronym", "required": true, "type": "string" }, { "name": "server_name", "in": "path", "description": "REST server name", "required": true, "type": "string" }, { "name": "rest_server_authentications", "in": "body", "description": "The values used to update the specified authentication definitions.", "required": true, "schema": { "$ref": "#/definitions/rest_server_authentications" } } ], "responses": { "200": { "description": "The authentications were successfully updated.", "schema": { "$ref": "#/definitions/rest_server_authentications" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The REST Server does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/external_services/rest/{external_service_name}/authentications/": { "get": { "summary": "Retrieve authentications for a REST External Service.", "description": "This API retrieves the authentications for a REST External Service. You must be an IBM Business Automation Workflow administrator to use this API. All the authentication information that is required to invoke a REST service operation is defined in an authentication. This REST API works only for REST External Services that are discovered with IBM Business Automation Workflow V19.0.0.2 or later.", "operationId": "getRESTExternalServiceAuthentications", "x-display-name": "Get REST External Service Authentications", "tags": [ "External Service - REST" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "Process application acronym", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "Process application snapshot acronym", "required": true, "type": "string" }, { "name": "external_service_name", "in": "path", "description": "External Service name", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request completed successfully and returned a list of authentications for a REST External Service.", "schema": { "$ref": "#/definitions/external_service_rest_authentications" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The REST External Service does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "put": { "summary": "Updates authentications for a REST External Service.", "description": "This API updates authentications for a REST External Service. You must be an IBM Business Automation Workflow administrator to update authentications. All the authentication information that is required to invoke a REST service operation is defined in an authentication. The authentication type and the description cannot be changed. For basic authentication either username and password or invocation credentials must be specified. For API key, the value of the API key must be specified. This REST API works only for REST External Services that are discovered with IBM Business Automation Workflow V19.0.0.2 or later.", "operationId": "updateRESTExternalServiceAuthentication", "x-display-name": "Update REST External Service Authentication", "tags": [ "External Service - REST" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "Process application acronym", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "Process application snapshot acronym", "required": true, "type": "string" }, { "name": "external_service_name", "in": "path", "description": "External Service name", "required": true, "type": "string" }, { "name": "external_service_rest_authentications", "in": "body", "description": "The values used to update the specified authentication definitions.", "required": true, "schema": { "$ref": "#/definitions/external_service_rest_authentications" } } ], "responses": { "200": { "description": "The authentication was successfully updated.", "schema": { "$ref": "#/definitions/external_service_rest_authentications" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The REST External Service does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/ai_agents/{ai_agent_name}/authentication/": { "put": { "summary": "Updates the authentication for an AI Agent.", "description": "This API updates the authentication for an AI Agent. You must be an IBM Business Automation Workflow administrator to update the authentication. All the authentication information that is required to invoke an AI Agent is defined in an authentication. This API is only applicable in IBM Cloud Pak for Business Automation and IBM Business Automation Workflow on containers.", "operationId": "updateAIAgentAuthentication", "x-display-name": "Update AI Agent Authentication", "tags": [ "AI Agent" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "Process application acronym", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "Process application snapshot acronym", "required": true, "type": "string" }, { "name": "ai_agent_name", "in": "path", "description": "AI Agent name", "required": true, "type": "string" }, { "name": "ai_agent_authentication", "in": "body", "description": "The value used to update the specified authentication definition.", "required": true, "schema": { "$ref": "#/definitions/ai_agent_authentication" } } ], "responses": { "200": { "description": "The authentication was successfully updated.", "schema": { "$ref": "#/definitions/ai_agent_authentication" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The AI Agent does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/applications": { "get": { "summary": "Returns the list of applications.", "description": "This API returns the list of applications such as Microsoft Exchange. You must be an IBM Business Automation Workflow administrator to use this API. This API is only applicable in IBM Cloud Pak for Business Automation and IBM Business Automation Workflow on containers.", "operationId": "getApplications", "x-display-name": "Get Applications", "produces": [ "application/json" ], "tags": [ "Application" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request completed successfully and returned a list of applications.", "examples": { "application/json": { "applications": [ { "name": "msexchange", "display_name": "MS Exchange", "description": "MyDescription", "version": "1.0.0", "application_accounts": [ { "name": "Account1" } ] } ] } }, "schema": { "$ref": "#/definitions/applications" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/applications/{application_name}": { "get": { "summary": "Returns the details of an application.", "description": "This API returns the details of an application such as Microsoft Exchange. Use this API to get the schema for this application's account specification, which you will need when you create or update an account. You must be an IBM Business Automation Workflow administrator to use this API. This API is only applicable in IBM Cloud Pak for Business Automation and IBM Business Automation Workflow on containers.", "operationId": "getApplication", "x-display-name": "Get Application", "produces": [ "application/json" ], "tags": [ "Application" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "application_name", "in": "path", "description": "The identifying name of the application such as msexchange.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request completed successfully and returned the details of an application.", "examples": { "application/json": { "name": "msexchange", "display_name": "MS Exchange", "description": "MyDescription", "version": "1.0.0", "application_accounts": [ { "name": "Account1" } ], "authentication_schemas": [ { "credentials": { "type": "object", "description": "Credentials for the basicOauth authentication type", "additionalProperties": true, "properties": { "accessToken": { "displayType": "password", "type": "string", "title": "Access token", "description": "The access token generated from the application client ID and client secret", "displayOrder": 2 }, "refreshToken": { "displayType": "password", "type": "string", "title": "Refresh token", "description": "The refresh token generated from the application client ID and client secret", "displayOrder": 3 }, "clientId": { "displayType": "password", "type": "string", "title": "Client ID", "description": "The unique identifier generated after the Microsoft Azure app registration gets mapped to the specific project requests", "displayOrder": 4 }, "clientSecret": { "displayType": "password", "type": "string", "title": "Client secret", "description": "The application client secret for a project-specific unique application client ID", "displayOrder": 5 } }, "required": [ "accessToken", "refreshToken", "clientId", "clientSecret" ] } } ] } }, "schema": { "$ref": "#/definitions/application_details" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The application does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/applications/{application_name}/accounts": { "get": { "summary": "Returns the list of application accounts.", "description": "This API returns the list of application account names of the specified application. You must be an IBM Business Automation Workflow administrator to use this API. This API is only applicable in IBM Cloud Pak for Business Automation and IBM Business Automation Workflow on containers.", "operationId": "getApplicationAccounts", "x-display-name": "Get Application Accounts", "produces": [ "application/json" ], "tags": [ "Application" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "application_name", "in": "path", "description": "The identifying name of the application such as msexchange.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request completed successfully and returned a list of applications.", "schema": { "$ref": "#/definitions/application_accounts" }, "examples": { "application/json": { "application_accounts": [ { "name": "Account1" } ] } } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The application does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "post": { "summary": "Creates an application account.", "description": "This API creates an application account. An application account contains the credentials needed to access an application. The schema for an account can be retrieved from the application details API. The accounts to be created can be obtained from the workflow developer. You must be an IBM Business Automation Workflow administrator to use this API. This API is only applicable in IBM Cloud Pak for Business Automation and IBM Business Automation Workflow on containers.", "operationId": "createApplicationAccount", "x-display-name": "Create Application Account", "produces": [ "application/json" ], "consumes": [ "application/json" ], "tags": [ "Application" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "application_name", "in": "path", "description": "The identifying name of the application such as msexchange.", "required": true, "type": "string" }, { "name": "application_account", "in": "body", "description": "The application account.", "required": true, "schema": { "$ref": "#/definitions/application_account" } } ], "responses": { "201": { "description": "The request completed successfully and returned the created application account.", "schema": { "$ref": "#/definitions/application_account" }, "examples": { "application/json": { "name": "Account1", "description": "Test Account" } } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The application does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "An account with the specified name for the specified application already exists.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/applications/{application_name}/accounts/{account_name}": { "put": { "summary": "Updates an application account.", "description": "This API updates an application account. An application account contains the credentials needed to access an application. The schema for an account can be retrieved from the application details API. You must be an IBM Business Automation Workflow administrator to use this API. This API is only applicable in IBM Cloud Pak for Business Automation and IBM Business Automation Workflow on containers.", "operationId": "updateApplicationAccount", "x-display-name": "Update Application Account", "produces": [ "application/json" ], "consumes": [ "application/json" ], "tags": [ "Application" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "application_name", "in": "path", "description": "The identifying name of the application such as msexchange.", "required": true, "type": "string" }, { "name": "account_name", "in": "path", "description": "The identifying name of the application account.", "required": true, "type": "string" }, { "name": "application_account", "in": "body", "description": "The application account. An application account contains the credentials needed to access an application. The schema for an account can be retrieved from the application details API.", "required": true, "schema": { "$ref": "#/definitions/application_account" } } ], "responses": { "200": { "description": "The request completed successfully and returned the updated application account.", "schema": { "$ref": "#/definitions/application_account" }, "examples": { "application/json": { "name": "Account1", "description": "Test Account" } } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The application or account does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "delete": { "summary": "Deletes an application account.", "description": "This API deletes an application account. An application account contains the credentials needed to access an application. You must be an IBM Business Automation Workflow administrator to use this API. This API is only applicable in IBM Cloud Pak for Business Automation and IBM Business Automation Workflow on containers.", "operationId": "deleteApplicationAccount", "x-display-name": "Delete Application Account", "produces": [ "application/json" ], "tags": [ "Application" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "application_name", "in": "path", "description": "The identifying name of the application such as msexchange.", "required": true, "type": "string" }, { "name": "account_name", "in": "path", "description": "The identifying name of the application account.", "required": true, "type": "string" } ], "responses": { "204": { "description": "The request completed successfully." }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The application or account does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/servers/webservice/": { "get": { "summary": "Retrieve a list of Web Service Server definitions.", "description": "This API retrieves a list of Web Service Server definitions. You must be an IBM Business Automation Workflow administrator to retrieve Web Service Server definitions. Only properties that are supported for both IBM Business Automation Workflow in traditional and container environments are returned.", "operationId": "getWSServerDefinitions", "x-display-name": "Get Web Service Server Definitions", "tags": [ "Web Service Server" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "Process application acronym", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "Process application snapshot acronym", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request completed successfully and returned a list of Web Service Server definitions.", "schema": { "$ref": "#/definitions/ws_server_definitions" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/servers/webservice/{server_name}": { "put": { "summary": "Set the definition of a Web Service Server.", "description": "This API sets the values of a Web Service Server definition. You must be an IBM Business Automation Workflow administrator to update Web Service Server definitions. The server name is used as the identifier, and must match [with] the server_name request parameter. Other properties are only updated if they are specified. Only properties that are supported for both IBM Business Automation Workflow in traditional and container environments are updated. Any other properties are ignored. In IBM Business Automation Workflow traditional, you must use the Process Admin Console or BPMSetWebServiceServerProperties wsadmin command to update any other properties.", "operationId": "updateWSServerDefinition", "x-display-name": "Set Web Service Server Definition", "tags": [ "Web Service Server" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "Process application acronym", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "Process application snapshot acronym", "required": true, "type": "string" }, { "name": "server_name", "in": "path", "description": "Web Service Server name", "required": true, "type": "string" }, { "name": "ws_server_definition", "in": "body", "description": "The values used to update the specified Web Service Server definition.", "required": true, "schema": { "$ref": "#/definitions/ws_server_definition" } } ], "responses": { "200": { "description": "The Web Service Server definition was successfully updated.", "schema": { "$ref": "#/definitions/ws_server_definition" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The REST Server does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/saved_search_acceleration/optimize": { "post": { "summary": "Generate pivot tables and load instance variable data for saved search acceleration tool.", "description": "Create LSW_BPD_INSTANCE_VAR_NAMES and LSW_BPD_INSTANCE_VARS_PIVOT tables and load instance variable data for the saved search acceleration. If you don't load data, the saved search may generate a failure. You must drop the pivot tables and recreate them, either after you have deployed a new process that contains any searchable business data variables or after you have updated an existing process (by deploying a new process snapshot) that contains any searchable business data variable changes. This API should be used when the system is idle to avoid variable changes during API execution. Only IBM Business Automation Workflow administrators are authorized to perform this call.", "operationId": "savedSearchAcceleration", "x-display-name": "Saved Search Acceleration", "tags": [ "Saved Search" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "generateSchema", "in": "query", "description": "Set to 'true' to create pivot tables. The default value is 'true'.", "required": true, "type": "boolean", "default": true }, { "name": "loadData", "in": "query", "description": "Set to 'true' to load instance variable value data. The default value is 'true'.", "required": true, "type": "boolean", "default": true } ], "responses": { "202": { "description": "The request was successfully processed.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "delete": { "summary": "Drop the pivot tables used by the Saved Search Acceleration.", "description": "Drop the LSW_BPD_INSTANCE_VAR_NAMES and LSW_BPD_INSTANCE_VARS_PIVOT tables used for the Saved Search Acceleration. You must run this REST API when you need to recreate the pivot tables. This API should be used when the system is idle to avoid Saved Search executions during table delete. Only IBM Business Automation Workflow administrators are authorized to perform this call.", "operationId": "dropPivotTables", "x-display-name": "Drop the pivot tables", "tags": [ "Saved Search" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request was successfully processed.", "schema": { "$ref": "#/definitions/schema_generator_result" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/regenerate_theme": { "post": { "summary": "Regenerate the runtime theme CSS for a process app, case solution, or toolkit snapshot.", "description": "Regenerates the runtime theme CSS for a process app, case solution, or toolkit snapshot on Workflow Center or Workflow Server.", "operationId": "regenerateTheme", "x-display-name": "Regenerate Theme", "tags": [ "Container" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process app, case solution, or toolkit that will have its CSS regenerated. The * wildcard is supported. The theme is regenerated for the specified snapshot in the server according to the currently applied theme.", "required": true, "type": "string" }, { "name": "regenerate_theme_details", "in": "body", "description": "The body parameters for regenerating the theme.", "schema": { "$ref": "#/definitions/regenerate_theme" } } ], "responses": { "200": { "description": "The request was processed successfully. For detailed information, check the system log.", "schema": { "$ref": "#/definitions/regenerate_theme_result" } }, "400": { "description": "The request contains invalid parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/update_theme": { "post": { "summary": "Make a project look like another project without redeploying the project.", "description": "Makes a project (process app, case solution, or toolkit) look like another project without redeploying the project. The command generates the CSS based on the theme definition of a source project snapshot. Although the generated CSS for the two projects is different, the projects can look similar because the definitions used to generate the CSS are the same. This command runs only on Workflow Server.", "operationId": "updateTheme", "x-display-name": "Update Theme", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process app, case solution, or toolkit that will have its theme updated.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that will have its theme updated.", "required": true, "type": "string" }, { "name": "update_theme_details", "in": "body", "description": "The body parameters for updating the theme.", "required": true, "schema": { "$ref": "#/definitions/update_theme" } } ], "responses": { "204": { "description": "The request was submitted successfully. For detailed information, check the system log." }, "400": { "description": "The request contains invalid parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/processes/{process}/analyze": { "post": { "summary": "(Internal API) Generates analytics information for BPC.", "description": "(Internal API) Triggers the invocation of the analytics engine to compute a performance dashboard for the given process.", "operationId": "analyzeProcess", "x-display-name": "Compute Performance and Workforce data", "tags": [ "Analytics" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "process", "in": "path", "description": "Specifies the id of the process to analyze.", "required": true, "type": "string" }, { "name": "version", "in": "query", "description": "The snapshot id that contains the process.", "required": true, "type": "string" }, { "name": "start_date", "in": "query", "description": "The date from which to start analyzing process performance. If not specified, all available process instance data is analyzed up to the end_date.", "required": false, "type": "string", "format": "date-time" }, { "name": "end_date", "in": "query", "description": "The date to stop analyzing process performance. If not specified, process instance data is analyzed to the current date and time.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "202": { "description": "The analysis request was submitted.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/processes/historical_execution": { "get": { "summary": "(Internal API) Request process historical events", "description": "(Internal API) Returns a set of process events for all completed process instances of a process in the BAW database. Paging support is at the process instance level and does not relate to the number of events returned for each instance.", "operationId": "get_historical_data", "x-display-name": "Retrieve Process Execution Data", "tags": [ "Analytics" ], "security": [ ], "produces": [ "application/json" ], "parameters": [ { "name": "session_id", "in": "query", "description": "Session ID for which to retrieve historical data from.", "required": true, "type": "string" }, { "name": "offset", "in": "query", "description": "In a list of entries, the offset specifies the position of the first process instance to return events for.", "required": false, "type": "integer" }, { "name": "size", "in": "query", "description": "Maximum number of process instances to retrieve data for.", "required": false, "type": "integer", "minimum": 1 } ], "responses": { "200": { "description": "Events for the process requested.", "schema": { "$ref": "#/definitions/process_events" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/processes/participants": { "get": { "summary": "(Internal API) Request performer information for a given process", "description": "(Internal API) Returns performer information for a given process, including what activities they worked on and what teams they belong to in the context of a given process.", "operationId": "get_participant_information", "x-display-name": "Retrieve Performer Execution Data", "tags": [ "Analytics" ], "produces": [ "application/json" ], "security": [ ], "parameters": [ { "name": "session_id", "in": "query", "description": "Session ID for which to retrieve historical data from.", "required": true, "type": "string" }, { "name": "offset", "in": "query", "description": "In a list of entries, the offset specifies the position of the first process application or toolkit to return from the query result set.", "required": false, "type": "integer" }, { "name": "size", "in": "query", "description": "Maximum number of process applications or toolkits to return.", "required": false, "type": "integer", "minimum": 1 } ], "responses": { "200": { "description": "Events for the process requested.", "schema": { "$ref": "#/definitions/process_performers" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/processes/model": { "get": { "summary": "(Internal API) Request the model a process", "description": "(Internal API) Returns the model for the process associated with the given session ID.", "operationId": "get_process_model", "x-display-name": "Retrieve Process Model", "tags": [ "Analytics" ], "produces": [ "application/json" ], "security": [ ], "parameters": [ { "name": "session_id", "in": "query", "description": "Session ID for which to retrieve the process model.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The process model.", "schema": { "$ref": "#/definitions/process_model" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/tasks": { "delete": { "summary": "Deletes completed tasks associated with a running process instance.", "description": "Deletes completed tasks associated with a running process instance. In general, start by deleting completed system and decision tasks. Consider deleting completed user tasks only if you need further performance improvements because deleting user tasks before the process instance completes could distort duration statistics for users who worked on those tasks. To access this IBM Business Automation Workflow API, the user ID used to make this request must belong to either the bpmAdminGroup or bpmAuthorGroup. The default name for the bpmAdminGroup is tw_admins and the default name for the bpmAuthorGroup is tw_authors", "operationId": "deleteCompletedTasks", "x-display-name": "Delete Completed Tasks", "tags": [ "Task Instances" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token.", "required": true, "type": "string" }, { "name": "container", "in": "query", "description": "The acronym of the process application that the command will delete completed tasks from. If you do not specify the task_IDs parameter, then this parameter must be defined.", "required": false, "type": "string" }, { "name": "version", "in": "query", "description": "The acronym of the snapshot that the command will delete completed tasks from. If you do not specify this parameter, the default action is to delete completed tasks from Tip in IBM Workflow Center environments or the default snapshot in IBM Workflow Server environments.", "required": false, "type": "string" }, { "name": "task_type", "in": "query", "description": "Identifies which types of tasks to delete. The ALL value is the only valid value to delete tasks created in the versions of Business Automation Workflow prior to 8.5.6.0 and subsequently migrated.", "required": false, "type": "string", "enum": [ "SYSTEM_TASK", "USER_TASK", "DECISION_TASK", "ALL" ], "default": "ALL" }, { "name": "task_status", "in": "query", "description": "A required parameter that identifies the status of a completed task to be deleted. Tasks with the status closed, sent, alert and actioned are considered completed tasks and can be filtered accordingly. Use the parameter value ALL_COMPLETED to delete completed tasks regardless of task status.", "required": true, "type": "string", "enum": [ "CLOSED", "SENT", "ACTIONED", "ALERT", "ALL_COMPLETED" ] }, { "name": "task_IDs", "in": "query", "description": "Comma separated list containing the IDs of one or more completed tasks to delete from the runtime database. If you have not specified the container parameter then this parameter must be defined.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "name": "process_name", "in": "query", "description": "Identifies the specific process in the container that will have its tasks cleaned up. The default action is to clean up the tasks of all processes in the specified container.", "required": false, "type": "string" }, { "name": "ended_after", "in": "query", "description": "Identifies the local time on the server. Only tasks that have a specific value on or after the specfied time period are cleaned.", "required": false, "type": "string" }, { "name": "ended_before", "in": "query", "description": "Identifies the local time on the server. Only tasks that have a specific value on or before the specfied time period are cleaned.", "required": false, "type": "string" }, { "name": "maximum_duration", "in": "query", "description": "Specifies the maximum time in minutes for the system to run the command. The default value is 0 (no limit). The value must be greater than or equal to 0. When the maximum duration is exceeded, the command is aborted after the current transaction has committed.", "default": 0, "required": false, "type": "integer" }, { "name": "transaction_slice", "in": "query", "description": "Specifies the number of completed tasks to delete per transaction. When the number of tasks being deleted reaches the parameter value, the system completes the transaction and then starts a new transaction to resume deleting tasks. The default value is 100 tasks to delete per transaction.", "default": 100, "required": false, "type": "integer" } ], "responses": { "202": { "description": "The request to delete the completed task instances was submitted. To check the progress of the operation, use the 'GET /system/queue/{id}' resource to access the URL that is included in the response.", "schema": { "$ref": "#/definitions/request_accepted_result" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } }, "501": { "description": "Not implemented.", "schema": { "$ref": "#/definitions/exception" } }, "503": { "description": "Service unavailable.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/bin_repo_sync": { "post": { "summary": "Push the installation package to the configured binary repository or artifactory", "description": "Creates a snapshot of a process app and pushes its installation package to the configured binary repository (for example jFrog artifactory). This is only applicable in Workflow Center environments. You can not use the API for a toolkit snapshot. Only Business Automation Workflow administrators or users with project write permission are authorized to perform this call.", "operationId": "pushInstallPackage", "x-display-name": "Push Install Package", "tags": [ "Version" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application associated with the specified snapshot", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot to be pushed to binary repository.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The specified container snapshot was pushed to binary repository successfully.", "schema": { "$ref": "#/definitions/version" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "405": { "description": "The requested method is not allowed on this resource.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/installedApps/teams": { "get": { "summary": "Retrieve information about teams.", "description": "Retrieve information about teams that have been defined to the IBM Business Automation Workflow installation.", "operationId": "getTeams", "x-display-name": "Get Teams", "tags": [ "Installed Versions" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "required": true, "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs." }, { "name": "filter", "in": "query", "type": "string", "required": true, "description": "Filters the global teams and includes only team names that match the specified filter condition. The filter is case insensitive. By default, the method returns all the global teams to which the user has access. Example: 'hiring*' returns all the teams whose name begins with 'hiring'." }, { "name": "snapshotId", "in": "query", "type": "string", "required": true, "description": "The snapshot id that identifies the context in which the teams will be received." } ], "responses": { "201": { "description": "The teams were succesfully retrieved.", "schema": { "$ref": "#/definitions/teams_result" } }, "400": { "description": "The request contains parameters that are not valid, or they are missing.", "schema": { "type": "array", "items": { "$ref": "#/definitions/exception" } } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/transfer/targets": { "get": { "summary": "Retrieve targets for process instance transfer", "description": "Returns all targets available for process instance transfer.", "operationId": "getTransferTargetsList", "tags": [ "Process Instance Transfer" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Request processed successfully. Returns all targets.", "schema": { "$ref": "#/definitions/transfer_targets" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The request cannot be processed because of one or more conflicts in the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "post": { "summary": "Add a new transfer target.", "description": "Creates a new transfer target.", "operationId": "createTransferTarget", "tags": [ "Process Instance Transfer" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The details of the transfer target to be created.", "required": true, "schema": { "$ref": "#/definitions/transfer_target" } } ], "responses": { "201": { "description": "Transfer target created successfully.", "schema": { "$ref": "#/definitions/transfer_target" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The request cannot be processed because of one or more conflicts in the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/transfer/targets/{name}": { "get": { "summary": "Retrieve a transfer target.", "description": "Retrieves the details of a specific transfer target used for process instance transfer.", "operationId": "getTransferTarget", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "Target name", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request was processed successfully.", "schema": { "$ref": "#/definitions/transfer_target" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "delete": { "summary": "Delete a transfer target.", "description": "Deletes the transfer target.", "operationId": "deleteTransferTarget", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "Target name", "required": true, "type": "string" } ], "responses": { "204": { "description": "transfer target deleted successfully." }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The request cannot be processed because of one or more conflicts in the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "put": { "summary": "Update a transfer target.", "description": "Updates transfer target configuration.", "operationId": "setTransferTarget", "tags": [ "Process Instance Transfer" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "The unique name of the transfer target to update.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The updated transfer target details.", "required": true, "schema": { "$ref": "#/definitions/transfer_target" } } ], "responses": { "200": { "description": "Request processed successfully. Returns updated transfer target.", "schema": { "$ref": "#/definitions/transfer_target" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "No transfer target found with the specified name.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The request cannot be processed because of a conflict (e.g., trying to change a read-only field).", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/transfer/targets/{name}/verify": { "post": { "summary": "Verify transfer target connection", "description": "Tests the connection parameters to the specified transfer target to ensure it is reachable and properly configured for process instance transfer.", "operationId": "verifyTransferTargetConnection", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "CSRF prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "The unique name of the transfer target to be verified.", "required": true, "type": "string" }, { "name": "mode", "in": "query", "description": "The verification mode.", "required": false, "type": "string", "enum": [ "test" ] } ], "responses": { "200": { "description": "Connection verified successfully.", "schema": { "$ref": "#/definitions/transfer_target" } }, "400": { "description": "Invalid request parameters or malformed syntax.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to verify transfer targets.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The specified transfer target ID was not found.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "A verification process is already in progress for this target.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error occurred while attempting to reach the target.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/transfer/targets/{name}/pair": { "post": { "summary": "Pair the target server with current system.", "description": "Pairs the target server to enable process instance transfer from the source snapshot.", "operationId": "pairTransferTarget", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "CSRF prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "The unique name of the transfer target to prepare.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Connection verified successfully.", "schema": { "$ref": "#/definitions/transfer_target" } }, "400": { "description": "Invalid request parameters or malformed syntax.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to verify transfer targets.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The specified transfer target ID was not found.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "A verification process is already in progress for this target.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error occurred while attempting to reach the target.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/transfer/targets/{name}/cancel": { "post": { "summary": "Cancel the current operation about transfer target management.", "description": "Cancels the current operation about transfer target management.", "operationId": "cancelTransferTarget", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "CSRF prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "name", "in": "path", "description": "The unique name of the transfer target to pair.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Cancel request submitted successfully.", "schema": { "$ref": "#/definitions/transfer_target" } }, "400": { "description": "Invalid request parameters or malformed syntax.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to verify transfer targets.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The specified transfer target ID was not found.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "A verification process is already in progress for this target.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error occurred while attempting to reach the target.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/instance_transfer/configuration": { "get": { "summary": "Retrieve the Process Instance Transfer configuration.", "description": "Returns the configuration or status of Process Instance Transfer for the specified snapshot.", "operationId": "getInstanceTransferControl", "tags": [ "Process Instance Transfer" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot.", "required": true, "type": "string" }, { "name": "optional_parts", "in": "query", "description": "A comma-separated list of optional parts to be returned in the response object. Valid values are: 'check_result', 'settings', 'data'.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "check_result", "settings", "data" ] } } ], "responses": { "200": { "description": "Request processed successfully. Returns instance transfer configuration.", "schema": { "$ref": "#/definitions/instance_transfer_control" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The request cannot be processed because of one or more conflicts in the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "put": { "summary": "Update the configuration to transfer process instances.", "description": "Updates configuration or status for moving process instances in the specified snapshot.", "operationId": "setInstanceTransferControl", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "The details of the configuration to be updated.", "required": true, "schema": { "$ref": "#/definitions/instance_transfer_control" } } ], "responses": { "200": { "description": "Request processed successfully. Returns updated transfer configuration.", "schema": { "$ref": "#/definitions/instance_transfer_control" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The request cannot be processed because of one or more conflicts in the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/instance_transfer/attempts": { "get": { "summary": "Retrieve a list of previous transfer attempts.", "description": "Returns a collection of all transfer attempts associated with the specific snapshot ID.", "operationId": "getAttemptsList", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the environment variables.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the environment variables.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Request processed successfully. Returns all transfer attempts.", "schema": { "$ref": "#/definitions/instance_transfer_attempts" } }, "400": { "description": "Invalid parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "Not authorized.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "Snapshot not found.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/instance_transfer/attempts/{attempt_id}": { "get": { "summary": "Retrieve a moving attempt.", "description": "Retrieves the details of a specific moving attempt by ID.", "operationId": "getAttempt", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the environment variables.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the environment variables.", "required": true, "type": "string" }, { "name": "attempt_id", "in": "path", "description": "Moving attempt ID", "required": true, "type": "string" }, { "name": "optional_parts", "in": "query", "description": "A comma-separated list of optional parts to be returned in the response object. Valid values are: 'check_result', 'settings', 'json', 'txt'.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "check_result", "settings", "json", "txt" ] } } ], "responses": { "200": { "description": "Successful retrieval of transfer attempt details.", "schema": { "$ref": "#/definitions/instance_transfer_attempt" } }, "404": { "description": "Attempt or Snapshot not found.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "delete": { "summary": "Delete a transfer attempt.", "description": "Removes the record of a specific transfer attempt.", "operationId": "deleteAttempt", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the environment variables.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the environment variables.", "required": true, "type": "string" }, { "name": "attempt_id", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "Transfer attempt deleted successfully." }, "409": { "description": "Conflict: Cannot delete an active transfer.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/instance_transfer/check": { "post": { "summary": "Check the source and target system.", "description": "Performs pre-transfer check. Identifies potential conflicts, missing dependencies, or data integrity issues between source and target systems.", "operationId": "checkSourceAndTarget", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Check triggered successfully.", "schema": { "$ref": "#/definitions/instance_transfer_control" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The specified container or version was not found.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The request cannot be processed because the transfer is in an invalid state for analysis.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/instance_transfer/post_check": { "post": { "summary": "Check the source and target system.", "description": "Performs post-transfer check. Identifies potential issues between source and target systems.", "operationId": "postCheckSourceAndTarget", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Post-check triggered successfully.", "schema": { "$ref": "#/definitions/instance_transfer_control" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The specified container or version was not found.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The request cannot be processed because the transfer is in an invalid state for analysis.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/instance_transfer/start": { "post": { "summary": "Start the transfer", "description": "Initiates process instances transfer for the specified snapshot.", "operationId": "startTransfer", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the environment variables.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the environment variables.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Request processed successfully.", "schema": { "$ref": "#/definitions/instance_transfer_control" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The request cannot be processed because of one or more conflicts in the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/instance_transfer/cancel": { "post": { "summary": "Stop the current operation", "description": "Stops current operation (pre-req check, freeze, or transfer) for the specified snapshot and triggers cleanup of transient data.", "operationId": "cancel", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the environment variables.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the environment variables.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Request processed successfully.", "schema": { "$ref": "#/definitions/instance_transfer_control" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The request cannot be processed because of one or more conflicts in the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/instance_transfer/reset_target": { "post": { "summary": "Clear up transferred data in the target.", "description": "Removes transferred data from the target system to allow for a clean retry.", "operationId": "resetTarget", "tags": [ "Process Instance Transfer" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the environment variables.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the environment variables.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Request processed successfully.", "schema": { "$ref": "#/definitions/instance_transfer_control" } }, "400": { "description": "The request contains invalid parameters, or they are missing.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "The request cannot be processed because of one or more conflicts in the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/instance_transfer/promote_target": { "post": { "summary": "Promote transferred process instances in the target system.", "description": "Resume transferred process instances in the target system.", "operationId": "goLiveInTarget", "tags": [ "Process Instance Transfer" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the environment variables.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the environment variables.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Request submitted successfully.", "schema": { "$ref": "#/definitions/instance_transfer_control" } }, "400": { "description": "Invalid snapshot ID provided or missing required headers.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to signal go-live for this snapshot.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The specified snapshot could not be found.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "Conflict: The snapshot may already be in go-live status or is in an invalid state for this transition.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error occurred while processing the go-live signal.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/instance_transfer/freeze_source": { "post": { "summary": "Suspends process instances in the source snapshot to prevent modifications during transfer.", "description": "Suspend the process instances in the source snapshot to prevent modifications during transfer.", "operationId": "freezeSource", "tags": [ "Process Instance Transfer" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the environment variables.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the environment variables.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Snapshot frozen successfully.", "schema": { "$ref": "#/definitions/instance_transfer_control" } }, "404": { "description": "Snapshot not found.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "Conflict: Snapshot is already frozen or in an invalid state for freezing.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/versions/{version}/instance_transfer/unfreeze_source": { "post": { "summary": "Resume the process instances in the source snapshot.", "description": "Resumes process instances in the source snapshot.", "operationId": "unfreezeSource", "tags": [ "Process Instance Transfer" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "container", "in": "path", "description": "The acronym of the process application or toolkit that contains the environment variables.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The acronym of the snapshot that contains the environment variables.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Snapshot unfrozen successfully.", "schema": { "$ref": "#/definitions/instance_transfer_control" } }, "404": { "description": "Snapshot not found.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "Conflict: Snapshot is not currently frozen.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/logging_overrides": { "get": { "tags": [ "Logging" ], "summary": "Retrieve all logging overrides", "description": "Retrieves all the logging configuration overrides.", "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns the logging configuration list", "schema": { "type": "object", "properties": { "overrides": { "type": "array", "items": { "type": "object", "properties": { "acronym": { "type": "string", "description": "The process application acronym." }, "isEnabled": { "type": "boolean", "description": "Indicates whether custom logging is enabled for the process application." }, "logLevel": { "type": "integer", "description": "The logging level for the process application. Possible values are 1000 (ERROR), 900 (WARNING), 800 (INFO), 500 (DEBUG).", "enum": [ 1000, 900, 800, 500 ] } } } } } } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/logging_override": { "get": { "tags": [ "Logging" ], "summary": "Retrieve logging override", "description": "Retrieves the logging configuration override for a specific process application container.", "parameters": [ { "name": "container", "in": "path", "required": true, "type": "string", "description": "The acronym of the process application." }, { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns the logging configuration override", "schema": { "type": "object", "properties": { "isEnabled": { "type": "boolean", "description": "Indicates whether custom logging is enabled for the process application." }, "logLevel": { "type": "integer", "description": "The logging level for the process application. Possible values are 1000 (ERROR), 900 (WARNING), 800 (INFO), 500 (DEBUG).", "enum": [ 1000, 900, 800, 500 ] } } } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "put": { "tags": [ "Logging" ], "summary": "Update or create logging override", "description": "Creates or updates the logging configuration for a process application container.", "parameters": [ { "name": "container", "in": "path", "required": true, "type": "string", "description": "The acronym of the process application." }, { "name": "isEnabled", "in": "query", "required": true, "type": "boolean", "description": "Indicates whether to enable or disable custom logging for the process application." }, { "name": "logLevel", "in": "query", "required": true, "type": "integer", "description": "The logging level to set for the process application. Possible values are 1000 (ERROR), 900 (WARNING), 800 (INFO), 500 (DEBUG).", "enum": [ 1000, 900, 800, 500 ] }, { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Override updated successfully", "schema": { "type": "object", "properties": { "isEnabled": { "type": "boolean", "description": "Indicates whether custom logging is enabled for the process application." }, "logLevel": { "type": "integer", "description": "The logging level for the process application. Possible values are 1000 (ERROR), 900 (WARNING), 800 (INFO), 500 (DEBUG).", "enum": [ 1000, 900, 800, 500 ] } } } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "delete": { "tags": [ "Logging" ], "summary": "Delete logging override", "description": "Deletes the logging configuration override for the specified container, reverting it to system defaults.", "parameters": [ { "name": "container", "in": "path", "required": true, "type": "string", "description": "The acronym of the process application." }, { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "204": { "description": "Override removed" }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/containers/{container}/logging_config": { "get": { "tags": [ "Logging" ], "summary": "Retrieve effective logging configuration", "description": "Retrieves the effective logging configuration for a specific process application container, following the precedence: override > project defaults > global config.", "parameters": [ { "name": "container", "in": "path", "required": true, "type": "string", "description": "The acronym of the process application." }, { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns the effective logging configuration", "schema": { "type": "object", "properties": { "fileLocation": { "type": "string", "description": "The location where log files are stored." }, "fileName": { "type": "string", "description": "The name of the log file for the process application." }, "logLevel": { "type": "integer", "description": "The effective logging level for the process application. Possible values are 1000 (ERROR), 900 (WARNING), 800 (INFO), 500 (DEBUG).", "enum": [ 1000, 900, 800, 500 ] }, "isCustomLoggingEnabled": { "type": "boolean", "description": "Indicates whether custom logging is effectively enabled." }, "isCustomLoggingEnabledGlobal": { "type": "boolean", "description": "Indicates whether global custom logging is enabled in config." }, "isCustomLoggingEnabledProjectDefaults": { "type": "boolean", "description": "Indicates whether custom logging is enabled in the project defaults table (process app settings)." }, "effectiveLoggingConfig": { "type": "string", "description": "The source of the effective logging configuration.", "enum": [ "LOGGING_OVERRIDE", "LOGGING_PROJECT_DEFAULTS", "LOGGING_GLOBAL", "LOGGING_NONE" ] } } } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/fdr/bpd/enabled": { "get": { "summary": "Check if Federated Data Repository BPD indexing is enabled", "description": "This API checks if the Federated Data Repository BPD indexing is enabled or not.", "operationId": "getFdrBpdEnablement", "x-display-name": "Check if Federated Data Repository BPD indexing is enabled", "tags": [ "Federated Data Repository" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Flag stating if Federated Data Repository BPD indexing is enabled", "schema": { "$ref": "#/definitions/fdrBpdEnablement" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/fdr/bpd/info": { "get": { "summary": "Get information about the Federated Data Repository BPD indexing", "description": "Get information about the Federated Data Repository BPD indexing configuration and current status.", "operationId": "getFdrBpdInfo", "x-display-name": "Get information about the Federated Data Repository BPD indexing", "tags": [ "Federated Data Repository" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Information about the Federated Data Repository BPD indexing", "schema": { "$ref": "#/definitions/fdrBpdInfo" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } }, "503": { "description": "Service unavailable, possibly because Federated Data Repository indexing is not enabled.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/fdr/bpd/maintenanceOperations": { "get": { "summary": "Retrieve the available history of all maintenance operations", "description": "Retrieve the available list of all maintenance operations related to Federated Data Repository BPD indexing which have been processed.", "operationId": "getFdrBpdMaintenances", "x-display-name": "Retrieve the available history of all maintenance operations", "tags": [ "Federated Data Repository" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The list of maintenance operations has been returned.", "schema": { "$ref": "#/definitions/fdrBpdMaintenanceOperationsList" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } }, "503": { "description": "Service unavailable, possibly because Federated Data Repository indexing is not enabled.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/fdr/bpd/maintenanceOperations/{type}": { "get": { "summary": "Get a Federated Data Repository maintenance operation", "description": "Retrieve the latest status of a Federated Data Repository maintenance operation related to BPD indexing.", "operationId": "getFdrBpdMaintenance", "x-display-name": "Get Federated Data Repository maintenance operation", "tags": [ "Federated Data Repository" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "type", "type": "string", "in": "path", "required": true, "description": "The type of the maintenance operation.", "enum": [ "create-index", "house-keeping", "rebuild", "retry-failures", "reconcile", "post-backup", "restore", "sync-deletions" ] } ], "responses": { "200": { "description": "The request completed successfully and returned the latest status of a Federated Data Repository maintenance operation.", "schema": { "$ref": "#/definitions/fdrBpdMaintenanceOperation" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested operation does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } }, "503": { "description": "Service unavailable, possibly because Federated Data Repository indexing is not enabled.", "schema": { "$ref": "#/definitions/exception" } } } }, "post": { "summary": "Start a Federated Data Repository maintenance operation", "description": "This API allows to start a Federated Data Repository maintenance operation of a given type, related to BPD indexing. To start a maintenance operation, there must not be an on-going maintenance operation of the requested type in submitted, running or suspended status.", "operationId": "postFdrBpdMaintenance", "x-display-name": "Start a Federated Data Repository maintenance operation", "tags": [ "Federated Data Repository" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "type", "type": "string", "in": "path", "required": true, "description": "The type of the maintenance operation.", "enum": [ "house-keeping", "rebuild", "retry-failures", "reconcile", "restore", "sync-deletions" ] } ], "responses": { "202": { "description": "The maintenance operation has been started.", "schema": { "$ref": "#/definitions/fdrBpdMaintenanceOperation" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested maintenance operation type does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "Conflict, cannot start the maintenance operation because one is already running.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } }, "503": { "description": "Service unavailable, possibly because Federated Data Repository indexing is not enabled.", "schema": { "$ref": "#/definitions/exception" } } } }, "put": { "summary": "Abort, resume or suspend a Federated Data Repository maintenance operation", "description": "This API allows to abort, resume or suspend a Federated Data Repository maintenance operation of a given type, related to BPD indexing. To abort a maintenance operation, there must be an on-going maintenance operation of the same type in submitted, running or suspended status. To suspend a maintenance operation, the operation must be in submitted or running status. To resume a maintenance operation, the operation must be in submitted status", "operationId": "putFdrBpdMaintenance", "x-display-name": "Abort, resume or suspend a Federated Data Repository maintenance operation", "tags": [ "Federated Data Repository" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "type", "type": "string", "in": "path", "required": true, "description": "The type of the maintenance operation.", "enum": [ "house-keeping", "rebuild", "retry-failures", "reconcile", "restore", "sync-deletions" ] }, { "name": "action", "in": "query", "description": "The action to perform on the maintenance operation", "required": false, "type": "string", "enum": [ "abort", "resume", "suspend" ] } ], "responses": { "202": { "description": "The maintenance operation has been successfully suspended, resumed or aborted.", "schema": { "$ref": "#/definitions/fdrBpdMaintenanceOperation" } }, "400": { "description": "Bad request, possibly because Federated Data Repository indexing is not enabled, or because, the requested action does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested maintenance operation type does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "409": { "description": "Conflict. Cannot suspend an operation which is not in submitted or running status. Cannot resume an operation which is not suspended. Cannot abort an operation whic is not running or suspended.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/fdr/bpd/backupState": { "get": { "summary": "Get the latest backup of the state of the BPD indexer", "description": "Get the latest backup of the state of the Federated Data Repository BPD indexer.", "operationId": "getFdrBpdBackupState", "x-display-name": "Get the latest backup of the state of the BPD indexer", "tags": [ "Federated Data Repository" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Provide the result of the operation.", "schema": { "$ref": "#/definitions/fdrBpdBackupState" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } }, "503": { "description": "Service unavailable, possibly because Federated Data Repository indexing is not enabled.", "schema": { "$ref": "#/definitions/exception" } } } }, "put": { "summary": "Backup the current state of the BPD indexer", "description": "Backup the current state of the Federated Data Repository BPD indexer.", "operationId": "setFdrBpdBackupState", "x-display-name": "Backup the current state of the BPD indexer", "tags": [ "Federated Data Repository" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Provide the result of the operation.", "schema": { "$ref": "#/definitions/fdrBpdBackupState" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } }, "503": { "description": "Service unavailable, possibly because Federated Data Repository indexing is not enabled.", "schema": { "$ref": "#/definitions/exception" } } } }, "delete": { "summary": "Delete the backup of the state of the BPD indexer", "description": "Delete the backup of the state of the Federated Data Repository BPD indexer.", "operationId": "deleteFdrBpdBackupState", "x-display-name": "Delete the backup of the state of the BPD indexer", "tags": [ "Federated Data Repository" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Cross-site request forgery prevention token for IBM Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Details of the deleted backup state.", "schema": { "$ref": "#/definitions/fdrBpdBackupState" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "There is no backup state to delete.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } }, "503": { "description": "Service unavailable, possibly because Federated Data Repository indexing is not enabled.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/measure/recordBillingMetric": { "get": { "summary": "Retrieves the billing metrics count", "description": "Retrieves the billing metrics count", "operationId": "getRecordBillingMetric", "x-display-name": "Get Recorded Billing Metric", "tags": [ "Usage" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Indicates the cross-site request forgery prevention token for Business Automation Workflow REST APIs.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The information was successfully retrieved.", "schema": { "$ref": "#/definitions/usageDataList" } }, "400": { "description": "The request contains invalid or missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "404": { "description": "The requested resource does not exist.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } }, "post": { "summary": "Record a billing metric for a component ID.", "description": "Record a billing metric for a component ID.", "operationId": "postRecordIncrementalUsage", "x-display-name": "Record Incremental Usage", "tags": [ "Usage" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Indicates the cross-site request forgery prevention token for Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "componentId", "in": "query", "description": "The component id to record.", "required": true, "type": "string" }, { "name": "count", "in": "query", "description": "The metric count", "required": false, "type": "integer", "default": 1 } ], "responses": { "204": { "description": "The request was processed successfully." }, "400": { "description": "The request could not be handled because of missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/measure/recordUsage/bulk": { "post": { "summary": "Record multiple usage events in a single request.", "description": "Record multiple usage events in a single request.", "operationId": "postRecordUsageBulk", "x-display-name": "Record Bulk Usage", "tags": [ "Usage" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Indicates the cross-site request forgery prevention token for Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "usageData", "in": "body", "description": "Collection of UsageData", "required": true, "schema": { "$ref": "#/definitions/usageDataList" } } ], "responses": { "204": { "description": "The request was processed successfully." }, "400": { "description": "The request could not be handled because of missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } }, "/std/bpm/measure/recordUsage": { "post": { "summary": "Record a feature has been used by its usage ID.", "description": "Record a feature has been used by its usage ID.", "operationId": "postRecordUsage", "x-display-name": "Record Usage", "tags": [ "Usage" ], "produces": [ "application/json" ], "parameters": [ { "name": "BPMCSRFToken", "in": "header", "description": "Indicates the cross-site request forgery prevention token for Business Automation Workflow REST APIs.", "required": true, "type": "string" }, { "name": "componentId", "in": "query", "description": "The usage id to record.", "required": true, "type": "string" }, { "name": "count", "in": "query", "description": "The metric count", "required": false, "type": "integer", "default": 1 } ], "responses": { "204": { "description": "The request was processed successfully." }, "400": { "description": "The request could not be handled because of missing parameters.", "schema": { "$ref": "#/definitions/exception" } }, "403": { "description": "The caller is not authorized to perform the request.", "schema": { "$ref": "#/definitions/exception" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/exception" } } } } } }, "definitions": { "login_request": { "title": "Login Request", "description": "Request object for creating a new CSRF token", "required": [ "refresh_groups" ], "properties": { "refresh_groups": { "description": "Flag that indicates whether the current user's group membership is refreshed in the IBM Business Automation Workflow database.", "type": "boolean" }, "requested_lifetime": { "description": "Requested token lifetime in seconds (positive integer). Must be smaller than the maximum lifetime 7200.", "type": "integer", "default": 7200 } } }, "csrf_token": { "title": "Cross-site Request Forgery protection token", "description": "Token required by IBM Business Automation Workflow REST APIs to prevent cross-site request forgery attacks.", "properties": { "csrf_token": { "type": "string" }, "expiration": { "type": "integer" } } }, "refresh_api_key_status": { "description": "Status of refresh api key", "type": "object", "properties": { "state": { "type": "string", "example": "success", "description": "The state of the asynchronous operation. When the state is 'success' or 'failure', the operation is finished.", "enum": [ "running", "success", "failure" ] }, "last_modified": { "type": "string", "format": "date-time", "description": "The time stamp when the status was last modified." }, "result": { "type": "object", "properties": { }, "description": "The result of the operation when the operation finished. The structure of the result depends on the kind of operation that was performed." } } }, "queued_operation_status": { "description": "Status of queued operation", "type": "object", "properties": { "state": { "type": "string", "example": "success", "description": "The state of the asynchronous operation. When the state is 'success' or 'failure', the operation is finished.", "enum": [ "pending", "running", "success", "failure" ] }, "last_modified": { "type": "string", "format": "date-time", "description": "The time stamp when the status was last modified." }, "result": { "type": "object", "properties": { }, "description": "The result of the operation when the operation finished. The structure of the result depends on the kind of operation that was performed." } } }, "validation_result": { "description": "Result of database validation", "type": "object", "properties": { "result": { "type": "string", "example": "validated", "description": "The valid state of the database", "enum": [ "validated", "invalid", "failure" ] }, "validate_time": { "type": "string", "format": "date-time", "description": "The time stamp when the status was last modified." }, "error_count": { "type": "integer", "description": "Number of validation errors in the database." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Errors detected from database validation." } } }, "repair_token_result": { "description": "Result of token repair", "type": "object", "properties": { "result": { "type": "string", "example": "repaired", "description": "status of the token", "enum": [ "repaired", "failure" ] } } }, "event_manager_tasks": { "description": "The result of a query for Event Manager tasks in the IBM Business Automation Workflow system.", "required": [ "event_manager_tasks" ], "properties": { "event_manager_tasks": { "type": "array", "items": { "$ref": "#/definitions/event_manager_task" } }, "previous": { "type": "string", "description": "A URL that returns the previous page of Event Manager tasks." }, "next": { "type": "string", "description": "A URL that returns the next page of Event Manager tasks." } } }, "event_manager_task": { "description": "One Event Manager task result object", "required": [ "id", "scheduled_time" ], "properties": { "id": { "type": "string", "description": "The instance ID of the Event Manager Task." }, "description": { "type": "string", "description": "The description that is associated with the Event Manager task." }, "job_queue": { "type": "string", "description": "The queue that the Event Manager task is in." }, "scheduled_time": { "type": "string", "format": "date-time", "description": "The date when the Event Manager task will be processed." }, "message": { "type": "string", "description": "The message that is associated with the Event Manager task." }, "state": { "type": "string", "description": "The state that is associated with the Event Manager task.", "enum": [ "acquired", "blackedout", "executing", "on_hold", "scheduled" ] } } }, "event_manager_tasks_replay_result": { "description": "The result of performing a replay action on multiple Event Manager tasks", "required": [ "replayed_event_manager_task_ids" ], "properties": { "replayed_event_manager_task_ids": { "type": "array", "items": { "type": "string" }, "description": "A list of Event Manager task IDs that were successfully rescheduled." }, "replay_failures": { "type": "array", "items": { "$ref": "#/definitions/failure" } } } }, "event_manager_tasks_delete_result": { "description": "The result of performing a delete action on multiple Event Manager tasks", "required": [ "deleted_event_manager_task_ids" ], "properties": { "deleted_event_manager_task_ids": { "type": "array", "items": { "type": "string" }, "description": "A list of Event Manager task IDs that were successfully deleted." }, "delete_failures": { "type": "array", "items": { "$ref": "#/definitions/failure" }, "description": "A list of Event Manager task IDs that could not be deleted successfully and details of the reasons." } } }, "uca_event_manager_tasks_delete_result": { "description": "The result of performing a delete action on scheduled UCA event manager task", "required": [ "deleted_event_manager_task_ids" ], "properties": { "number_of_tasks_deleted": { "type": "integer", "description": "A number of scheduled UCA event manager tasks deleted." }, "number_of_task_keywords_deleted": { "type": "integer", "description": "A number of task keyword deleted" } } }, "resource_count": { "description": "Resource count", "type": "object", "required": [ "count" ], "properties": { "count": { "type": "integer", "description": "Number of entities in the system for the given filter criteria." } } }, "result_available_project_areas": { "description": "Result with list of available project areas", "required": [ "available_project_areas" ], "properties": { "available_project_areas": { "type": "array", "description": "The list of available project areas", "items": { "type": "string" } } } }, "sync_result": { "description": "The result for a user synchronization request.", "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string", "description": "Details about the user synchronization." } } }, "user_attribute": { "description": "An attribute that may belong to a user.", "type": "object", "required": [ "id", "name", "translated_name", "type" ], "properties": { "id": { "description": "The user attribute ID.", "type": "string" }, "name": { "description": "The user attribute name.", "type": "string" }, "translated_name": { "description": "The user attribute translated name.", "type": "string" }, "type": { "description": "The type of the user attribute. Will be one of 'ANY', 'LIST', 'BOOL'.", "type": "string" }, "possible_values": { "description": "The list of possibles values for attributes with the 'LIST' type.", "type": "array", "items": { "$ref": "#/definitions/attribute_value" } } } }, "attribute_value": { "description": "Values that an attribute of 'LIST' type can have.", "type": "object", "required": [ "value_key", "translation_value" ], "properties": { "value_key": { "description": "The user attribute value key", "type": "string" }, "translation_value": { "description": "The translation of the user attribute value key", "type": "string" } } }, "user_attributes_list": { "description": "A list of all user attributes.", "required": [ "attributes" ], "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/user_attribute" } } } }, "user_personal_data": { "description": "Users personal data", "type": "object", "properties": { "user_id": { "type": "string", "description": "The user ID of the user that is described by this object." }, "user_name": { "type": "string", "description": "The user name of the user that is described by this object." }, "full_name": { "type": "string", "description": "The full name of the user that is described by this object." }, "is_deactivated": { "type": "boolean", "description": "Indicates whether this user is deactivated." }, "user_attributes": { "type": "array", "description": "List of user attributes.", "items": { "type": "object", "properties": { } } }, "group_memberships": { "description": "List of groups of which the user is a member.", "type": "array", "items": { "type": "string" } }, "user_avatar": { "type": "string", "format": "uri", "description": "A URL that returns the user's avatar." }, "online_status": { "type": "boolean", "description": "users online status." }, "online_server_id": { "type": "string", "description": "server id." }, "task_measurement_data": { "type": "array", "description": "Statistical data for a single user on a given task.", "items": { "$ref": "#/definitions/task_measurement_data" } } } }, "user_personal_data_list": { "description": "A list of user's personal data", "type": "object", "required": [ "users" ], "properties": { "users": { "type": "array", "items": { "$ref": "#/definitions/user_personal_data" } } } }, "bulkRemovePersonalDataRequest": { "title": "Bulk Remove Personal Data Request", "description": "Request object for bulk removal of personal data for multiple users", "type": "object", "required": [ "userIds" ], "properties": { "userIds": { "description": "List of user IDs whose personal data should be deleted. All users must be deactivated.", "type": "array", "items": { "type": "string" }, "minItems": 1 } } }, "bulkRemovePersonalDataResponse": { "title": "Bulk Remove Personal Data Response", "description": "Response object containing summary and detailed results of bulk personal data deletion", "type": "object", "properties": { "totalRequested": { "description": "Total number of users requested for deletion", "type": "integer" }, "successCount": { "description": "Number of successful deletions", "type": "integer" }, "failureCount": { "description": "Number of failed deletions", "type": "integer" }, "results": { "description": "Detailed results for each user", "type": "array", "items": { "$ref": "#/definitions/bulkDeleteResult" } } } }, "bulkDeleteResult": { "title": "Bulk Delete Result", "description": "Result of personal data deletion for a single user in a bulk operation", "type": "object", "properties": { "userId": { "description": "User ID", "type": "string" }, "status": { "description": "Status of the deletion operation", "type": "string", "enum": [ "SUCCESS", "FAILED" ] }, "errorCode": { "description": "Error code if the operation failed", "type": "string" }, "errorMessage": { "description": "Error message if the operation failed", "type": "string" } } }, "task_measurement_data": { "description": "Statistical data for a single user on a given task.", "type": "object", "properties": { "task_id": { "type": "string", "description": "task id." }, "completed": { "type": "integer", "description": "The number of times that this task has been completed by this user." }, "avg_completion_time": { "type": "string", "description": "The average time for this user to complete this task, in ISO-8601 duration format." }, "min_completion_time": { "type": "string", "description": "The minimum time for this user to complete a task, in ISO-8601 duration format." }, "max_completion_time": { "type": "string", "description": "The maximum time for this user to complete a task, in ISO-8601 duration format." } } }, "install_messages_result": { "description": "The result for requesting the installation messages of a process application", "properties": { "install_messages": { "type": "array", "items": { "$ref": "#/definitions/install_message" } } } }, "install_message": { "description": "A message that indicates the state of a step in an installation process", "type": "object", "properties": { "message_id": { "type": "string", "description": "The ID of the message" }, "message_name": { "type": "string", "description": "The name of the message" }, "parent_message_id": { "type": "string", "description": "The ID of the message that is the parent of this message" }, "start_time": { "type": "string", "description": "The start time associated with the message" }, "end_time": { "type": "string", "description": "The end time associated with the message" }, "type": { "type": "string", "description": "The type of the message", "enum": [ "PC_PRE_INSTALL_STEP", "PC_POST_INSTALL_STEP", "STEP", "INFORMATIONAL_MESSAGE", "WARNING_MESSAGE", "ERROR_MESSAGE", "RECOVERY_MESSAGE" ] }, "state": { "type": "string", "description": "The state of the message", "enum": [ "RUNNING", "COMPLETED_SUCCESSFULLY", "COMPLETED_IN_ERROR", "NONE" ] }, "server_name": { "type": "string", "description": "The name of the server from which this message originates" }, "thread_id": { "type": "string", "description": "The ID of the thread on which the installation ran" }, "message": { "type": "string", "description": "The content of the message" } } }, "servers": { "description": "Servers in the IBM Business Automation Workflow system that match the specified criteria.", "required": [ "servers" ], "properties": { "servers": { "type": "array", "items": { "$ref": "#/definitions/server" } }, "previous": { "type": "string", "description": "A URL that returns the previous page of results." }, "next": { "type": "string", "description": "A URL that returns the next page of results." } } }, "server": { "description": "Server Details.", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the server instance." }, "id": { "type": "string", "description": "The ID of the server instance." }, "description": { "type": "string", "description": "The description of the server instance." }, "url": { "type": "string", "description": "The provider URL of the server instance." }, "address": { "type": "string", "description": "The address of the server instance." }, "port": { "type": "string", "description": "The port of the server instance." }, "user_name": { "type": "string", "description": "The user name associated with the server instance." }, "created_by": { "type": "string", "description": "The user name of the user who created the server instance." }, "creation_date": { "type": "string", "format": "date-time", "description": "The date that the server instance was created on." }, "available": { "type": "boolean", "description": "Indicates whether the server instance is available." } } }, "versions": { "description": "Snapshots in the IBM Business Automation Workflow system that match the specified criteria.", "required": [ "versions" ], "properties": { "versions": { "type": "array", "items": { "$ref": "#/definitions/version" } }, "previous": { "type": "string", "description": "A URL that returns the previous page of results." }, "next": { "type": "string", "description": "A URL that returns the next page of results." } } }, "version": { "description": "Snapshot Details.", "type": "object", "properties": { "version_name": { "type": "string", "description": "The name of the snapshot." }, "version": { "type": "string", "description": "The acronym of the snapshot." }, "id": { "type": "string", "description": "The ID of the snapshot." }, "description": { "type": "string", "description": "The description of the snapshot." }, "active": { "type": "boolean", "description": "Indicates whether the snapshot is active." }, "creation_date": { "type": "string", "format": "date-time", "description": "The date on which the snapshot was created." }, "creator_user_id": { "type": "string", "description": "The ID of the user who created the snapshot." }, "creator_user_name": { "type": "string", "description": "The user name of the user who created the snapshot." }, "tip": { "type": "boolean", "description": "Indicates whether the snapshot is the tip." }, "branch_id": { "type": "string", "description": "The ID of the track that contains the snapshot." }, "branch_name": { "type": "string", "description": "The name of the track that contains the snapshot." }, "branch": { "type": "string", "description": "The acronym of the track that contains the snapshot." }, "container_id": { "type": "string", "description": "The ID of the process application or toolkit that is associated with the snapshot." }, "container_name": { "type": "string", "description": "The name of the process application or toolkit that is associated with the snapshot." }, "container": { "type": "string", "description": "The acronym of the process application or toolkit that is associated with the snapshot." }, "is_default": { "type": "boolean", "description": "Indicates whether the snapshot is the default snapshot." }, "status": { "type": "string", "description": "The current state of the snapshot in the development process, for example, New, Validated, or Released." }, "capability": { "type": "string", "description": "Indicates the business process management capability that the snapshot uses, for example, Standard or Advanced." }, "archived": { "type": "boolean", "description": "Indicates whether the snapshot is archived." }, "target_environment": { "description": "The target environment of the version", "$ref": "#/definitions/target_environment" }, "installable": { "description": "Indicates if the snapshot can be installed. A snapshot cannot be installed on a Workflow Server if it contains install errors.", "type": "boolean", "default": true } } }, "new_version": { "title": "Version Post Parameters", "description": "The body parameters for creating new snapshot.", "required": [ "version_name" ], "properties": { "branch_acronym": { "description": "The acronym of the track associated with the process application. If not specified, the default track is used. Projects can have a non-default track if track development is enabled in Workflow Center.", "type": "string", "default": "Some branch acronym" }, "version_name": { "description": "The name of the snapshot. You can include any of the following characters in the name: A-Z 0-9 _", "type": "string", "default": "Some snapshot name" }, "description": { "description": "The description of the new snapshot.", "type": "string", "default": "Some snapshot description" } } }, "containers": { "description": "The result of a query for process applications and toolkits in the IBM Business Automation Workflow system.", "required": [ "containers" ], "properties": { "containers": { "type": "array", "items": { "$ref": "#/definitions/container" } }, "previous": { "type": "string", "description": "A URL that returns the previous page of the results." }, "next": { "type": "string", "description": "A URL that returns the next page of the results." } } }, "container": { "description": "Process Application or Toolkit Details.", "type": "object", "properties": { "container_name": { "type": "string", "description": "The name of the process application or toolkit." }, "container": { "type": "string", "description": "The acronym of the process application or toolkit." }, "id": { "type": "string", "description": "The ID of the process application or toolkit." }, "description": { "type": "string", "description": "The description of the process application or toolkit." }, "creation_date": { "type": "string", "format": "date-time", "description": "The date on which the process application or toolkit was created." }, "creator_user_id": { "type": "string", "description": "The ID of the user who created the process application or toolkit." }, "creator_user_name": { "type": "string", "description": "The user name of the user who created the process application or toolkit." }, "toolkit": { "type": "boolean", "description": "Indicates whether the project is a toolkit." }, "archived": { "type": "boolean", "description": "Indicates whether the process application or toolkit is archived." }, "branches": { "type": "array", "description": "List of tracks in a process application or toolkit.", "items": { "$ref": "#/definitions/branch" } } } }, "new_container": { "title": "Container Post Parameters", "description": "The body parameters for creating new process app or toolkit.", "required": [ "container_acronym", "container_name" ], "properties": { "container_acronym": { "description": "The acronym of the new container.", "type": "string", "default": "Some container acronym" }, "container_name": { "description": "The name of the new container. You can include any of the following characters in the name: A-Z 0-9 _", "type": "string", "default": "Some container name" }, "description": { "description": "The description of the new container.", "type": "string", "default": "Some container description" }, "is_toolkit": { "description": "Indicates whether the container being created is a toolkit. By default, the container created is a process app.", "type": "boolean", "default": false } } }, "branches": { "description": "The result of a query for tracks in the IBM Business Automation Workflow system.", "required": [ "branches" ], "properties": { "branches": { "type": "array", "items": { "$ref": "#/definitions/branch" } }, "previous": { "type": "string", "description": "A URL that returns the previous page of results." }, "next": { "type": "string", "description": "A URL that returns the next page of results." } } }, "branch": { "description": "Information about a specific track.", "type": "object", "properties": { "branch_name": { "type": "string", "description": "The name of the track." }, "branch": { "type": "string", "description": "The acronym of the track." }, "id": { "type": "string", "description": "The ID of the track." }, "is_default": { "type": "boolean", "description": "Indicates whether the track is the default track." }, "tip": { "$ref": "#/definitions/version", "description": "Information about the tip of the specific track." }, "container_id": { "type": "string", "description": "The ID of the process application or toolkit that contains the track." }, "container_name": { "type": "string", "description": "The name of the process application or toolkit that contains the track." }, "container": { "type": "string", "description": "The acronym of the process application or toolkit that contains the track." }, "target_environment": { "$ref": "#/definitions/target_environment", "description": "The target environment" }, "installable": { "description": "Indicates if a snapshot taken of the branch can be installed. A snapshot cannot be installed on a Workflow Server if it contains install errors.", "type": "boolean", "default": true }, "versions": { "type": "array", "description": "Snapshots that belong to the specific track.", "items": { "$ref": "#/definitions/version" } } } }, "new_branch": { "title": "Branch Post Parameters", "description": "The body parameters for creating new track.", "required": [ "branch_name", "version_acronym" ], "properties": { "branch_name": { "description": "The name of the new track. You can include any of the following characters in the name: A-Z 0-9 _", "type": "string", "default": "Some track name" }, "description": { "description": "The description of the new track.", "type": "string", "default": "Some track description" }, "version_acronym": { "description": "The acronym of the snapshot.", "type": "string", "default": "Some snapshot acronym" } } }, "version_migration_policies_result": { "description": "The result of a query for a version's migration policies in the IBM Business Automation Workflow system.", "required": [ "version_migration_policies" ], "properties": { "version_migration_policies": { "type": "array", "items": { "$ref": "#/definitions/version_migration_policy" } } } }, "version_migration_policy": { "description": "The migration policy for a specific source snapshot.", "required": [ "version_migration_policies" ], "type": "object", "properties": { "migration_policy_Id": { "type": "string", "description": "The ID of the migration policy." }, "source_version_name": { "type": "string", "description": "The name of the snapshot that instances will be migrated from (the old version)." }, "source_version": { "type": "string", "description": "The acronym of the snapshot that instances will be migrated from (the old version)." }, "source_version_id": { "type": "string", "description": "The ID of the snapshot that instances will be migrated from (the old version)." }, "source_version_creation_date": { "type": "string", "format": "date-time", "description": "The date that the snapshot that instances will be migrated from (the old version) was created." }, "source_branch_name": { "type": "string", "description": "The branch name of the snapshot that instances will be migrated from (the old version)." }, "source_branch": { "type": "string", "description": "The branch acronym of the snapshot that instances will be migrated from (the old version)." }, "source_branch_id": { "type": "string", "description": "The branch ID of the snapshot that instances will be migrated from (the old version)." }, "target_version_id": { "type": "string", "description": "The ID of the snapshot that instances will be migrated to (the new version)." }, "deployment_servers": { "type": "array", "description": "List of servers that the source snapshot has been deployed to, if any.", "items": { "$ref": "#/definitions/server" } } } }, "orphaned_toolkits": { "description": "The result of a query for orphaned toolkits in the IBM Business Automation Workflow system.", "required": [ "orphaned_toolkits" ], "properties": { "orphaned_toolkits": { "type": "array", "items": { "$ref": "#/definitions/orphaned_toolkit" } }, "previous": { "type": "string", "description": "A URL that returns the previous page of results." }, "next": { "type": "string", "description": "A URL that returns the next page of results." } } }, "orphaned_toolkit": { "description": "Information about a given orphaned toolkit and its snapshots.", "type": "object", "properties": { "container_name": { "type": "string", "description": "The name of the toolkit." }, "container_acronym": { "type": "string", "description": "The acronym of the toolkit." }, "container_snapshot_acronym": { "type": "string", "description": "The acronym of the snapshot." }, "container_branch_acronym": { "type": "string", "description": "The acronym of the track." } } }, "request_accepted_result": { "description": "The result for a request that was accepted for processing, but the processing has not completed.", "type": "object", "properties": { "description": { "type": "string", "description": "Details about the accepted request." }, "url": { "type": "string", "description": "A URL to verify the progress of the action." } } }, "exception": { "description": "An exception object that describes the details of the REST API error.", "required": [ "error_number", "error_message" ], "properties": { "error_number": { "type": "string", "description": "The message ID of the exception." }, "error_message": { "type": "string", "description": "The message text of the exception." }, "error_message_parameters": { "type": "array", "items": { "type": "string", "description": "An array of parameter strings that were inserted into the error message." }, "description": "Message text parameters for the exception." }, "error_cause": { "$ref": "#/definitions/exception" } } }, "failure": { "description": "The data structure for reporting the results of bulk actions that were not successful", "type": "object", "required": [ "id", "cause" ], "properties": { "id": { "type": "string", "description": "The ID of the object for which the invoked action failed" }, "cause": { "$ref": "#/definitions/failure_reason" } } }, "failure_reason": { "description": "The reason for the REST API replay error.", "required": [ "error_reason", "error_description" ], "properties": { "error_reason": { "type": "string", "description": "The message ID of the replay error." }, "error_description": { "type": "string", "description": "The message text of the replay error." } } }, "version_dependency": { "title": "Toolkit version dependency.", "description": "Toolkit version that can be referenced by another toolkit or process application.", "type": "object", "required": [ "target_container", "target_version" ], "properties": { "target_container": { "description": "The acronym of the toolkit dependency container to update.", "type": "string", "default": "Some toolkit dependency container acronym" }, "target_version": { "description": "The acronym of the toolkit dependency version to update.", "type": "string", "default": "Some toolkit dependency version acronym" } } }, "env_var_pairs": { "title": "Environment Variable Name Value", "description": "Specifies the names and values of the environment variables in a snapshot. It can be used as a body parameter for specifying the names and the new values of the environment variables in the SetEnvironmentVariables command. The field envVarRef is optional.", "required": [ "pairs" ], "properties": { "pairs": { "type": "array", "items": { "$ref": "#/definitions/env_var" } } } }, "env_var": { "description": "Describes the value of the environment variable. The field envVarRef is optional.", "required": [ "name", "value" ], "optional": [ "envVarRef" ], "properties": { "name": { "type": "string", "description": "The name of the environment variable." }, "value": { "type": "string", "description": "The value for the environment variable." }, "envVarRef": { "type": "string", "description": "The reference of the environment variable." } } }, "env_var_pairs_with_source": { "title": "Environment Variable Name Value Pairs with the originating container.", "description": "Specifies the names and values of the environment variables in a snapshot. In a snapshot, environment variables can originate from toolkits; therefore, the container is also specified", "required": [ "pairs" ], "properties": { "pairs": { "type": "array", "items": { "$ref": "#/definitions/env_var_with_source" } } } }, "env_var_with_source": { "description": "Describes the value of the environment variable with the container acronym.", "required": [ "name", "value", "container" ], "properties": { "name": { "type": "string", "description": "The name of the environment variable." }, "value": { "type": "string", "description": "The value for the environment variable." }, "container_acronym": { "type": "string", "description": "The acronym of the process application or toolkit that contains the environment variable." }, "container_name": { "type": "string", "description": "The full name of the process application or toolkit that contains the environment variable." }, "envVarRef": { "type": "string", "description": "The reference of the environment variable." } } }, "epvs_result": { "description": "The result of the request for the exposed process values of a snapshot", "required": [ "epvs" ], "properties": { "epvs": { "type": "array", "items": { "$ref": "#/definitions/epv" } } } }, "epv": { "description": "Details of the exposed process value", "type": "object", "properties": { "container": { "type": "string", "description": "The process app or toolkit name containing the EPV" }, "container_acronym": { "type": "string", "description": "The acronym of the process app or toolkit containing the EPV" }, "version_acronym": { "type": "string", "description": "The acronym of the snapshot containing the EPV" }, "name": { "type": "string", "description": "The name of the EPV" }, "description": { "type": "string", "description": "The description of the EPV" }, "external_description": { "type": "string", "description": "The external description of the EPV" }, "feedback_email_contact": { "type": "string", "description": "The feedback email contact of the EPV" }, "id": { "type": "string", "description": "The ID of the EPV" }, "epv_variables": { "type": "array", "items": { "$ref": "#/definitions/epv_variable" } } } }, "epv_variable": { "description": "Details of the exposed process value variable", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the variable" }, "description": { "type": "string", "description": "The description of the variable" }, "id": { "type": "string", "description": "The ID of the variable" }, "current_value": { "type": "string", "description": "The current value of the variable" }, "default_value": { "type": "string", "description": "The default value of the variable" }, "previous_variable_values": { "type": "array", "items": { "$ref": "#/definitions/epv_variable_value" } }, "current_variable_values": { "type": "array", "items": { "$ref": "#/definitions/epv_variable_value" } }, "future_variable_values": { "type": "array", "items": { "$ref": "#/definitions/epv_variable_value" } }, "class_type": { "type": "string", "description": "The type class of the epv variable." }, "type_class_ref": { "type": "string", "description": "The type class ref of the epv variable." }, "type_class_snapshot_id": { "type": "string", "description": "The type class snapshot id of the epv variable." }, "type_class_branch_id": { "type": "string", "description": "The type class branch id of the epv variable." } } }, "epv_variable_value": { "description": "Details of the previous exposed process value variable", "type": "object", "properties": { "value": { "type": "string", "description": "The value of the variable" }, "effective_date": { "type": "string", "format": "date-time", "description": "The effective date of the variable value" }, "modified_by": { "type": "string", "description": "The username of who modified the variable value last" }, "modified_date": { "type": "string", "format": "date-time", "description": "The modified date of the variable value" }, "epv_var_value_id": { "type": "string", "description": "The unique id for this epv variable value" }, "reason": { "type": "string", "description": "The reason of the variable value" } } }, "create_epv_variable_value": { "description": "A list of objects used to create exposed process value variable values", "required": [ "variable_value_details" ], "properties": { "variable_value_details": { "type": "array", "items": { "$ref": "#/definitions/variable_value_detail" } } } }, "variable_value_detail": { "description": "Information required to create a new EPV variable value", "required": [ "epv_name", "epv_variable_name", "epv_variable_value" ], "properties": { "epv_container_acronym": { "type": "string", "description": "The acronym of the process app or toolkit containing the EPV. If not specified, then the process app's acronym will be used." }, "epv_name": { "type": "string", "description": "The name of the EPV that holds the variable" }, "epv_variable_name": { "type": "string", "description": "The name of the variable that the value is being changed for" }, "epv_variable_value": { "type": "string", "description": "The new value to set enclosed as a string. Make sure to use the same data type as before" }, "effective_date": { "type": "string", "format": "date-time", "description": "The effective date of the variable value. Specify the time in the ISO 8601 format: 'yyyy-MM-dd'T'HH:mm:ssZ'", "default": "2018-01-31T01:30:00-04:00" }, "reason": { "type": "string", "description": "The reason for the change in EPV variable" } } }, "new_epv_variable_value": { "description": "Details of what needs to be changed to the EPV", "type": "object", "properties": { "epv_variable_id": { "type": "string", "description": "The unique id of the EPV variable" }, "effective_date": { "type": "string", "description": "The date in which the new value should take effect" }, "value": { "type": "string", "description": "The new value of the EPV variable" }, "reason": { "type": "string", "description": "The reason for the change in EPV variable" } } }, "update_epv_variable_value": { "description": "Details of what needs to be changed to the EPV", "type": "object", "properties": { "epv_variable_id": { "type": "string", "description": "The unique id of the EPV variable" }, "epv_var_value_id": { "type": "string", "description": "The unique value id for editing variable values" }, "effective_date": { "type": "string", "description": "The date in which the new value should take effect" }, "value": { "type": "string", "description": "The new value of the EPV variable" }, "reason": { "type": "string", "description": "The reason for the change in EPV variable" } } }, "delete_epv_variable_value": { "description": "Details of which EPV Variable Value needs to be deleted.", "type": "object", "properties": { "epv_variable_id": { "type": "string", "description": "The unique id of the EPV variable" }, "epv_var_value_id": { "type": "string", "description": "The unique value id for editing variable values" } } }, "cache_results": { "description": "Array of caches", "properties": { "caches": { "type": "array", "items": { "$ref": "#/definitions/cache" } } } }, "cache": { "description": "Details of the cache", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the cache." }, "description": { "type": "string", "description": "The description of the cache." }, "access_count": { "type": "string", "description": "The number of times this cache was accessed." }, "cache_misses": { "type": "string", "description": "The number times the value is not in cache." }, "hit_rate": { "type": "string", "description": "The percentage of cache hits relative to the total access count." }, "last_accessed": { "type": "string", "description": "The last time this cache was accessed" }, "status": { "type": "string", "description": "The status of the cache" }, "info": { "type": "string", "description": "The information about the cache" } } }, "blackout_results": { "description": "An array of all the scheduled blackout periods", "properties": { "blackoutPeriods": { "type": "array", "items": { "$ref": "#/definitions/blackout" } } } }, "blackout": { "description": "An instance of a scheduled blackout period", "type": "object", "properties": { "id": { "type": "string", "description": "The id of the blackout" }, "dateType": { "type": "string", "description": "The format of the time the blackout is scheduled" }, "fromDate": { "type": "string", "description": "The date in which the blackout period starts" }, "fromDisplayDate": { "type": "string", "description": "The display date in which the blackout period starts" }, "fromTime": { "type": "string", "description": "The time in which the blackout period starts" }, "toDate": { "type": "string", "description": "The date in which the blackout period ends" }, "toDisplayDate": { "type": "string", "description": "The display date in which the blackout period ends" }, "toTime": { "type": "string", "description": "The time in which the blackout period ends" }, "fromWeekday": { "type": "string", "description": "The day in which the blackout period starts" }, "fromWeekdayTime": { "type": "string", "description": "The time in which the blackout period starts" }, "toWeekday": { "type": "string", "description": "The day in which the blackout period ends" }, "toWeekdayTime": { "type": "string", "description": "The time in which the blackout period ends" } } }, "blackout_periods_change_details": { "description": "The details of the changes to make to the blackout periods", "properties": { "blackoutId": { "type": "string", "description": "If it is an update, blackout id must be provided" }, "dateType": { "type": "string", "description": "The type of date for the blackout period" }, "fromDate": { "type": "string", "description": "The date in which the blackout period starts" }, "fromTime": { "type": "string", "description": "The time in which the blackout period starts" }, "toDate": { "type": "string", "description": "The date in which the blackout period ends" }, "toTime": { "type": "string", "description": "The time in which the blackout period ends" }, "fromWeekday": { "type": "string", "description": "The day in which the blackout period starts" }, "fromWeekdayTime": { "type": "string", "description": "The time in which the blackout period starts" }, "toWeekday": { "type": "string", "description": "The day in which the blackout period ends" }, "toWeekdayTime": { "type": "string", "description": "The time in which the blackout period ends" } } }, "sync_queue": { "description": "A synchronous queue object", "type": "object", "properties": { "id": { "description": "id of the queue", "type": "string" }, "description": { "description": "description of the queue", "type": "string" } } }, "sync_queue_results": { "description": "List of all the synchronous queues", "properties": { "syncQueues": { "type": "array", "items": { "$ref": "#/definitions/sync_queue" } } } }, "sync_queue_change_details": { "description": "Details of the changes that need to be made for this Synchronous queue", "properties": { "id": { "description": "id of the queue", "type": "string" }, "description": { "description": "description of the queue", "type": "string" } } }, "installedVersions": { "description": "The result of a query for installed snapshots.", "required": [ "installedVersions" ], "properties": { "installedVersions": { "type": "array", "items": { "$ref": "#/definitions/installedVersion" } }, "pagination": { "$ref": "#/definitions/installedVersionsPagination" } } }, "installedVersionsPagination": { "description": "installed snapshot overview.", "type": "object", "properties": { "offset": { "type": "integer", "description": "The offset." }, "size": { "type": "integer", "description": "The number of returns." }, "totalSize": { "type": "integer", "description": "The total number of installed versions." } } }, "installedVersion": { "description": "Details of installed snapshot.", "type": "object", "properties": { "project_id": { "type": "string", "description": "The project id." }, "project_name": { "type": "string", "description": "The name of the project." }, "project_short_name": { "type": "string", "description": "The short name of the project." }, "branch_name": { "type": "string", "description": "The branch name." }, "branch_id": { "type": "string", "description": "The branch id." }, "tip": { "type": "boolean", "description": "Indicate if the snapshot is the tip of the branch, only applicable in the Process Center environment." }, "snapshot_name": { "type": "string", "description": "The name of the snapshot." }, "snapshot_id": { "type": "string", "description": "The snapshot id." }, "snapshot_acronym": { "type": "string", "description": "The acronym of snapshot." }, "is_active": { "type": "boolean", "description": "Is snapshot active." }, "is_default": { "type": "boolean", "description": "Is snapshot default snapshot." }, "is_installed": { "type": "boolean", "description": "Is snapshot installed." }, "is_archived": { "type": "boolean", "description": "Is snapshot archived." }, "has_suspended_all_instances": { "type": "boolean", "description": "Has snapshot suspended all instances." }, "snapshot_deployed_on": { "type": "string", "format": "date-time", "description": "The date when the snapshot was deployed." }, "is_installed_on_process_server": { "type": "boolean", "description": "Is the snapshot installed on the process server." }, "error": { "type": "string", "description": "The error of the snapshot." }, "state": { "type": "string", "description": "The state of the snapshot." }, "possible_actions": { "type": "array", "description": "The list of possible actions of the snapshot", "items": { "type": "string" } }, "case_display_name": { "type": "string", "description": "The display name of the case project." } } }, "processInstancesCountStats": { "description": "The result for requesting the processes of a snapshot", "required": [ "instanceStats" ], "properties": { "instanceStats": { "type": "array", "items": { "$ref": "#/definitions/processInstanceCount" } } } }, "processInstanceCount": { "description": "The exposed process instance count.", "type": "object", "properties": { "processName": { "type": "string", "description": "The processs name." }, "instancesRunning": { "type": "integer", "description": "The number of running instances for this process." }, "instancesFailed": { "type": "integer", "description": "The number of failed instances for this process." } } }, "team_bindings_result": { "description": "The result for requesting the team bindings of a snapshot", "required": [ "team_bindings" ], "properties": { "team_bindings": { "type": "array", "items": { "$ref": "#/definitions/team_binding" } } } }, "team_binding": { "description": "Details of the team binding", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the team" }, "participant_id": { "type": "string", "description": "The participant ID of the team" }, "user_members": { "type": "array", "description": "A list of the user names in the team", "items": { "type": "string" } }, "group_members": { "type": "array", "description": "A list of the group names in the team", "items": { "type": "string" } }, "manager_name": { "type": "string", "description": "The name of the team manager" }, "is_auto_refresh_enabled": { "type": "boolean", "description": "Indicates only for dynamic teams whether a team definition is refreshed with the latest information" } } }, "teams_result": { "description": "Details of the team", "type": "object", "properties": { "teams": { "type": "array", "items": { "$ref": "#/definitions/team" } } } }, "team": { "description": "Details of the team", "type": "object", "properties": { "id": { "type": "string", "description": "The id of the team." }, "snapshotId": { "type": "string", "description": "The id of the snapshot this team belongs to." }, "teamManagerGroupId": { "type": "string", "description": "The id of the team manager group id." }, "name": { "type": "string", "description": "The name of the team." }, "defaultName": { "type": "string", "description": "The default English name of the team." } } }, "add_team_details": { "description": "The information required to add to a team binding", "properties": { "add_users": { "type": "array", "items": { "type": "string" }, "description": "A list of the user names to add to the team" }, "add_groups": { "type": "array", "items": { "type": "string" }, "description": "A list of the groups to add to the team" }, "add_manager": { "type": "string", "description": "Assign a team of managers to the team" }, "set_auto_refresh_enabled": { "type": "boolean", "description": "Only applicable for dynamic teams, sets whether a team definition is to be refreshed with the latest information" } } }, "remove_team_details": { "description": "The information required to remove from a team binding", "properties": { "remove_users": { "type": "array", "items": { "type": "string" }, "description": "A list of the user names to remove from the team" }, "remove_groups": { "type": "array", "items": { "type": "string" }, "description": "A list of the groups to remove from the team" }, "remove_manager": { "type": "string", "description": "Remove a team of managers from the team" }, "set_auto_refresh_enabled": { "type": "boolean", "description": "Only applicable for dynamic teams, sets whether a team definition is to be refreshed with the latest information" } } }, "rest_server_definition": { "description": "All the information that is required to connect to a particular host is defined in a server definition. This definition represents a REST Server.", "required": [ "server_name", "request_timeout", "response_timeout" ], "properties": { "server_name": { "type": "string", "example": "Example REST Server", "description": "The name of the REST Server" }, "server_url": { "type": "string", "example": "https://host:port/basePath", "description": "The endpoint of the REST services. Either the 'server_url' or the combination of 'host_name', 'port' and 'use_https' are required. If both are specified the 'server_url' is used." }, "host_name": { "type": "string", "example": "Example host", "description": "The host name of the server that hosts the REST services. It specifies either an IP address or a host name and domain. For example: myHost.labwide.ibm.com." }, "port": { "type": "integer", "example": 443, "description": "The port number where the server is listening. Port numbers between 1 and 65535 are valid." }, "use_https": { "type": "boolean", "example": true, "description": "If set to true, the https protocol is used for REST service invocations. Otherwise the http protocol is used." }, "ssl_configuration": { "type": "string", "example": "Example SSL configuration", "description": "The SSL configuration that is configured in WebSphere Application Server." }, "request_timeout": { "type": "integer", "example": 30000, "description": "The number of milliseconds that the client attempts to establish a connection before it times out. The value 0 disables the timeout, which allows the client to attempt to open a connection indefinitely." }, "response_timeout": { "type": "integer", "example": 60000, "description": "The number of milliseconds that the client waits for a response before it times out. The value 0 disables the timeout, which allows the client to wait indefinitely." } } }, "rest_server_definitions": { "description": "A list of REST Server definitions.", "required": [ "rest_server_definitions" ], "properties": { "rest_server_definitions": { "type": "array", "items": { "$ref": "#/definitions/rest_server_definition" } } } }, "rest_server_authentication": { "description": "Authentication used to invoke the REST services. BASIC_AUTH is supported in two types: (a) combination of username and password; (b) invocation credentials.", "required": [ "authentication_type" ], "properties": { "authentication_type": { "type": "string", "example": "BASIC_AUTH", "description": "The authentication type used to invoke the REST services. You can use one of the following options: BASIC_AUTH (basic authentication).", "enum": [ "BASIC_AUTH" ] }, "user_name": { "type": "string", "example": "ExampleUserName", "description": "User name used for basic authentication" }, "password": { "type": "string", "example": "ExamplePassword", "description": "Password used for basic authentication" }, "invocation_credentials": { "type": "string", "example": "ExampleInvocationCredentials", "description": "Invocation credentials used for basic authentication" } } }, "rest_server_authentications": { "description": "A list of rest rest server authentications.", "required": [ "rest_server_authentications" ], "properties": { "rest_server_authentications": { "type": "array", "items": { "$ref": "#/definitions/rest_server_authentication" } } } }, "external_service_rest_authentication": { "description": "Authentication used to invoke the REST services. BASIC_AUTH, API_KEY and OAUTH_2 are supported. BASIC_AUTH is supported in two types: (a) combination of username and password; (b) invocation credentials. OAUTH_2 only support client credential flow.", "required": [ "authentication_name", "authentication_type" ], "properties": { "authentication_name": { "type": "string", "example": "MyAuthenticationName", "description": "The name of the authentication" }, "authentication_type": { "type": "string", "example": "BASIC_AUTH", "description": "The authentication type used to invoke the REST services. You can use one of the following options: BASIC_AUTH (basic authentication) and API_KEY.", "enum": [ "BASIC_AUTH", "API_KEY", "OAUTH_2" ] }, "description": { "type": "string", "example": "MyDescription", "description": "Description of the authentication." }, "user_name": { "type": "string", "example": "ExampleUserName", "description": "User name used for basic authentication" }, "password": { "type": "string", "example": "ExamplePassword", "description": "Password used for basic authentication" }, "invocation_credentials": { "type": "string", "example": "ExampleInvocationCredentials", "description": "WebSphere authentication alias used for basic authentication" }, "client_id": { "type": "string", "example": "ExampleClientId", "description": "Client Id for OAUTH2 client credential flow" }, "client_secret": { "type": "string", "example": "ExampleClientSecret", "description": "Client Secret for OAUTH2 client credential flow" }, "token_url": { "type": "string", "example": "ExampleTokenUrl", "description": "Token url for OAUTH2 client credential flow" }, "api_key": { "type": "string", "example": "ExampleAPIKey", "description": "The API key used for authentication" } } }, "external_service_rest_authentications": { "description": "A list of authentications used to invoke the REST services.", "required": [ "external_service_rest_authentications" ], "properties": { "external_service_rest_authentications": { "type": "array", "items": { "$ref": "#/definitions/external_service_rest_authentication" } } } }, "application_account": { "description": "An application account contains the credentials needed to access an application. The schema for an account can be retrieved from the application details API.", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Account1", "description": "The identifying name of the application account." }, "description": { "type": "string", "example": "Test Account", "description": "The description of the application account." }, "credentials": { "type": "object", "example": { "clientId": "****", "clientSecret": "****", "accessToken": "****", "refreshToken": "****" }, "description": "Credentials needed to access an application. The schema for an account can be retrieved from the application details API." } } }, "application_accounts": { "description": "A list of application accounts.", "required": [ "application_accounts" ], "properties": { "application_accounts": { "type": "array", "items": { "$ref": "#/definitions/application_account" } } } }, "application": { "description": "An application such as Microsoft Exchange.", "required": [ "name", "display_name", "description", "version" ], "properties": { "name": { "type": "string", "example": "msexchange", "description": "The identifying name of the application." }, "display_name": { "type": "string", "example": "Microsoft Exchange", "description": "The display name of the application." }, "description": { "type": "string", "example": "MyDescription", "description": "The description of the application." }, "version": { "type": "string", "example": "1.0.0", "description": "The version of the application connector." }, "application_accounts": { "type": "array", "items": { "$ref": "#/definitions/application_account" } } } }, "authentication_schema": { "description": "An authentication schema for an application account.", "type": "object", "properties": { "credentials": { "type": "object", "description": "The json schema for the authentication specification." } }, "example": { "description": "Credentials schema for the msexchange application.", "type": "object", "properties": { "credentials": { "accessToken": { "displayType": "password", "type": "string", "title": "Access token", "description": "The access token generated from the application client ID and client secret", "displayOrder": 2 }, "refreshToken": { "displayType": "password", "type": "string", "title": "Refresh token", "description": "The refresh token generated from the applica t ID and client secret", "displayOrder": 3 }, "clientId": { "displayType": "password", "type": "string", "title": "Client ID", "description": "The unique identifier generated after the Microsoft Azure app registration gets mapped to the specific project requests", "displayOrder": 4 }, "clientSecret": { "displayType": "password", "type": "string", "title": "Client secret", "description": "The application client secret for a project-specific unique application client ID", "displayOrder": 5 } }, "required": [ "accessToken", "refreshToken", "clientId", "clientSecret" ] } } }, "application_details": { "description": "The details of an application such as Microsoft Exchange.", "required": [ "name", "display_name", "description", "version", "authentication_schemas" ], "properties": { "name": { "type": "string", "example": "msexchange", "description": "The identifying name of the application." }, "display_name": { "type": "string", "example": "Microsoft Exchange", "description": "The display name of the application." }, "description": { "type": "string", "example": "MyDescription", "description": "The description of the application." }, "version": { "type": "string", "example": "1.0.0", "description": "The version of the application connector." }, "application_accounts": { "type": "array", "description": "The accounts for the application.", "items": { "$ref": "#/definitions/application_account" } }, "authentication_schemas": { "type": "array", "items": { "$ref": "#/definitions/authentication_schema" } } } }, "applications": { "description": "A list of applications such as Microsoft Exchange.", "required": [ "applications" ], "properties": { "applications": { "type": "array", "items": { "$ref": "#/definitions/application" } } } }, "ai_agent_authentication": { "description": "Authentication used to invoke the AI Agent. Only API_KEY is supported.", "properties": { "api_key": { "type": "string", "example": "ExampleAPIKey", "description": "The API key used for authentication" } } }, "ws_server_definition": { "description": "All the information that is required to connect to a particular host is defined in a server definition. This definition represents a Web Service Server.", "required": [ "server_name" ], "properties": { "server_name": { "type": "string", "example": "Example Web Service Server", "description": "The name of the Web Service Server" }, "override_endpoint": { "type": "boolean", "example": "true", "description": "If set to true, the value provided for endpoint_address will be used rather than the value specified in the WSDL." }, "endpoint_address": { "type": "string", "example": "https://host/endpoint", "description": "The endpoint address where the service is hosted." }, "authentication": { "type": "string", "enum": [ "None", "HTTP Authentication", "UsernameToken (Password in plaintext)", "UsernameToken (Password in Digest)" ], "example": "HTTP Authentication", "description": "If set to None, credentials are not sent to the Web Service provider. If set to HTTP Authentication the values of user_name and password are sent to the Web Service provider in form of HTTP Basic Authentication." }, "user_name": { "type": "string", "example": "user", "description": "The name of the user to be used for authentication." }, "password": { "type": "string", "example": "password", "description": "The password of the user to be used for authentication." } } }, "ws_server_definitions": { "description": "A list of Web Service Server definitions.", "required": [ "ws_server_definitions" ], "properties": { "ws_server_definitions": { "type": "array", "items": { "$ref": "#/definitions/ws_server_definition" } } } }, "target_environment": { "description": "A target environmment", "type": "string", "enum": [ "traditional", "container", "traditional_or_container", "cp4a", "none" ] }, "target_environment_body": { "description": "A target environment definition in the body of a request", "type": "object", "properties": { "target_environment": { "description": "A target environmment", "type": "string", "enum": [ "traditional", "container", "traditional_or_container", "cp4a", "none" ] } } }, "regenerate_theme": { "title": "Theme regeneration details", "description": "These optional parameters will be used when the theme of a process app, case solution, or toolkit is regenerated.", "properties": { "version_acronym": { "type": "string", "description": "The acronym of the snapshot that will have its CSS regenerated based on the currently applied theme definition. If this acronym is not provided, the theme is regenerated for all named snapshots in the target process app, case solution, or toolkit." } } }, "regenerate_theme_result": { "title": "Theme regeneration result", "description": "The result of requesting that the theme be regenerated. For detailed information, check the system log.", "properties": { "result": { "type": "string", "example": "success", "description": "The result of the theme regeneration. For detailed information, check the system log.", "enum": [ "success", "failure" ] } } }, "update_theme": { "title": "Theme update details", "description": "These parameters will be used when the theme of a process app, case solution, or toolkit is updated.", "required": [ "source_container_acronym", "source_version_acronym" ], "properties": { "source_container_acronym": { "type": "string", "description": "The acronym of the process app, case solution, or toolkit that contains the source theme definition to be copied." }, "source_version_acronym": { "type": "string", "description": "The acronym of the snapshot that contains the source theme definition to be copied." }, "theme_name": { "type": "string", "description": "An optional parameter that identifies the specific theme definition that the command will use to generate the CSS for the target process application, case solution, or toolkit. If this parameter is not provided, the command uses the theme definition of the current source process app, case solution, or toolkit." } } }, "schema_generator_result": { "description": "The result for the saved search acceleration schema deletion.", "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string", "description": "Information about the saved search schema generator." } } }, "pagination": { "description": "Pagination details", "type": "object", "properties": { "previous": { "type": "string", "description": "A URL that returns the previous page of the results." }, "next": { "type": "string", "description": "A URL that returns the next page of the results." }, "offset": { "type": "integer", "description": "The offset into the total list of artifacts." }, "size": { "type": "integer", "description": "The number of artifacts returned." }, "total_size": { "type": "integer", "description": "The total number of artifacts in the list." } } }, "process_events": { "description": "Raw process events", "type": "object", "required": [ "events", "event_count" ], "properties": { "events": { "type": "array", "items": { "type": "object" }, "description": "JSON string representing the events." }, "event_count": { "type": "integer", "description": "Number of events returned." }, "pagination": { "$ref": "#/definitions/pagination" } } }, "process_performers": { "description": "Performer information for process", "type": "object", "required": [ "performers", "process_id", "version_id" ], "properties": { "process_id": { "type": "string", "description": "The process ID associated with the result." }, "process_version_id": { "type": "string", "description": "process version ID associated with the result" }, "performers": { "type": "array", "items": { "$ref": "#/definitions/performer" } }, "pagination": { "$ref": "#/definitions/pagination" } } }, "jms_error_queue": { "description": "Event Manager JMS Error Queue for Process Admin Console.", "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "#/definitions/jms_message" }, "description": "A string representing a JMS message." } } }, "jms_message": { "description": "JMS message for the JMS Error Queue.", "type": "object", "properties": { "messageId": { "type": "string" }, "message": { "type": "string" } } }, "performer": { "description": "Process Performer Details.", "type": "object", "properties": { "performer_id": { "type": "string", "description": "The id of the performer." }, "performer_name": { "type": "string", "description": "The name of the performer." }, "team_name": { "type": "string", "description": "The name of the team the performer belonged to when completing given activities." }, "team_display_name": { "type": "string", "description": "The display name of the team the performer belonged to when completing given activities." }, "activity_names": { "type": "array", "items": { "type": "string" }, "description": "Activity names the performer participated on." }, "process_id": { "type": "string", "description": "The is of the process." } } }, "process_model": { "description": "BPMN Process model.", "type": "object", "properties": { "model": { "type": "object", "description": "The BPMN model." } } }, "maintenance_monitors": { "description": "The system maintenance monitors.", "properties": { "maintenance_monitors": { "type": "array", "items": { "$ref": "#/definitions/maintenance_monitor" } } } }, "maintenance_monitor": { "description": "A single system maintenance monitor.", "type": "object", "properties": { "display_name": { "type": "string", "description": "The system maintenance monitor display name." }, "description": { "type": "string", "description": "The system maintenance monitor description." }, "warning_threshold": { "type": "integer", "description": "The threshold where a warning is triggered and the number of items is approaching the capacity limit." }, "critical_threshold": { "type": "integer", "description": "The threshold where a critical error is triggered and the number of items has reached the capacity limit." }, "current_count": { "type": "integer", "description": "The current number of items." }, "info_message": { "type": "string", "description": "The message shown in System Maintenance Monitor if the current count of items does not exceeds the warning threshold and critical error threshold." }, "warning_message": { "type": "string", "description": "The message shown in System Maintenance Monitor if the current count of items exceeds the warning threshold." }, "critical_error_message": { "type": "string", "description": "The message shown in System Maintenance Monitor if the current count of items exceeds the critical error threshold." } } }, "event_manager_monitor": { "description": "The event manager monitor in Process Admin Console.", "type": "object", "properties": { "schedulers": { "type": "array", "items": { "$ref": "#/definitions/scheduler" } }, "total_number_of_jobs": { "type": "integer", "description": "The number of all jobs executed by all the schedulers." }, "total_number_of_jobs_executing": { "type": "integer", "description": "The number of all jobs currently executing by all the schedulers." }, "task_list": { "type": "array", "items": { "$ref": "#/definitions/scheduler_task" } } } }, "scheduler": { "description": "A system task scheduler in Process Admin Console.", "type": "object", "properties": { "id": { "type": "integer", "description": "The Id of the job scheduler." }, "display_name": { "type": "string", "description": "The display name of the job scheduler." }, "status": { "type": "string", "description": "The scheduler's current status." }, "number_of_jobs_executing": { "type": "integer", "description": "The current number of jobs being executed by the scheduler." }, "expiration": { "type": "string", "format": "date-time", "description": "The expiration time of the scheduler." } } }, "scheduler_task": { "description": "Information about a scheduler task in Process Admin Console.", "type": "object", "required": [ "id", "scheduled_time" ], "properties": { "job_owner": { "type": "string", "description": "the name of the scheduler that owns the job." }, "project_name": { "type": "string", "description": "The project name." }, "snapshot_name": { "type": "string", "description": "The snapshot name." }, "job_name": { "type": "string", "description": "The job or task name." }, "job_queue": { "type": "string", "description": "The type of event manager queue the job belongs to." }, "scheduled_time": { "type": "string", "format": "date-time", "description": "The scheduled time for the job." }, "last_scheduled_time": { "type": "string", "format": "date-time", "description": "The last scheduled time for the job." }, "last_execution_time": { "type": "string", "format": "date-time", "description": "The last time the job was executed." }, "next_scheduled_time": { "type": "string", "format": "date-time", "description": "The next scheduled time for the job." }, "task_status": { "type": "string", "description": "The status value for the job." } } }, "task_cleanup_stats": { "description": "Results of task house cleaning process.", "type": "object", "properties": { "task_count_before": { "type": "string" }, "file_count_before": { "type": "string" }, "task_count_after": { "type": "string" }, "file_count_after": { "type": "string" } } }, "access_control": { "description": "Process Admin Console user access control.", "type": "object", "properties": { "page_groups": { "type": "array", "description": "The Process Admin Console pages the current user can access.", "items": { "$ref": "#/definitions/page_group" } }, "admin_services": { "type": "array", "description": "The exposed services available in Process Admin Console.", "items": { "$ref": "#/definitions/page_group" } } } }, "page_group": { "description": "Process Admin Console page categories.", "type": "object", "properties": { "page_group_name": { "type": "string" }, "pages": { "type": "array", "description": "The names of the Process Admin Console pages the current user can access.", "items": { "type": "object", "$ref": "#/definitions/page" } } } }, "page": { "description": "Process Admin Console page", "type": "object", "required": [ "page_name" ], "properties": { "page_name": { "type": "string" }, "page_link": { "type": "string" } } }, "process_entry": { "description": "Holds information about a single process entry.", "type": "object", "properties": { "processId": { "type": "string" }, "diagramId": { "type": "string" }, "diagramName": { "type": "string" }, "activeUnitGuid": { "type": "string" }, "active": { "type": "boolean" }, "state": { "type": "string" }, "serviceDuration": { "type": "string" }, "workflowUnits": { "type": "array", "items": { "$ref": "#/definitions/workflow_unit" } }, "workflowUnitTotalCount": { "type": "string" }, "serviceUnits": { "type": "array", "items": { "$ref": "#/definitions/service_entry" } }, "execution_unit": { "$ref": "#/definitions/execution_unit" } } }, "workflow_unit": { "description": "Holds information about a process workflow unit.", "type": "object", "properties": { "guid": { "type": "string" }, "diagramId": { "type": "string" }, "diagramName": { "type": "string" }, "parentProcessEntry": { "$ref": "#/definitions/process_entry" }, "parentServiceEntry": { "$ref": "#/definitions/service_entry" }, "type": { "type": "string" }, "count": { "type": "string" }, "execution_unit": { "$ref": "#/definitions/execution_unit" } } }, "execution_unit": { "description": "Holds information about execution of a service, process or workflow unit.", "type": "object", "properties": { "name": { "type": "string" }, "projectName": { "type": "string" }, "snapshotName": { "type": "string" }, "context": { "type": "string" }, "duration": { "type": "string" }, "lastEnterTimestamp": { "type": "string" }, "count": { "type": "string" }, "lastDuration": { "type": "string" }, "totalDuration": { "type": "string" } } }, "service_entry": { "description": "Holds information about a service entry.", "type": "object", "properties": { "contextGuid": { "type": "string" }, "diagramId": { "type": "string" }, "diagramName": { "type": "string" }, "parentProcessId": { "type": "string" }, "activeUnitGuid": { "type": "string" }, "active": { "type": "boolean" }, "state": { "type": "string" }, "workflowUnits": { "type": "array", "items": { "$ref": "#/definitions/workflow_unit" } }, "workflowUnitTotalCount": { "type": "string" }, "execution_unit": { "$ref": "#/definitions/execution_unit" } } }, "process_entries": { "description": "Result containing requested process entries.", "type": "object", "properties": { "process_entries": { "type": "array", "items": { "$ref": "#/definitions/process_entry" } }, "pagination": { "$ref": "#/definitions/pagination" } } }, "service_entries": { "description": "Result containing requested service entries.", "type": "object", "properties": { "service_entries": { "type": "array", "items": { "$ref": "#/definitions/service_entry" } }, "pagination": { "$ref": "#/definitions/pagination" } } }, "group": { "description": "Result of group addition.", "type": "object", "properties": { "group_id": { "type": "string", "description": "The id of the group." }, "group_name": { "type": "string", "description": "The name of the group." }, "group_description": { "type": "string", "description": "The description of the group." }, "parentGroupId": { "type": "string", "description": "The id of the parent group." } } }, "members": { "description": "An array of groups and user members", "type": "object", "properties": { "users": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } } } }, "member_obj": { "description": "Member object", "type": "object", "properties": { "membertype": { "type": "string" }, "name": { "type": "string" }, "displayname": { "type": "string" } } }, "members_obj": { "description": "Arrays of members of groups and users", "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/definitions/member_obj" } }, "users": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } } } }, "process_monitor_summary": { "description": "Data summary of active processes and services.", "type": "object", "properties": { "server_name": { "type": "string" }, "active_processes": { "type": "string" }, "active_services": { "type": "string" }, "most_expensive_services": { "$ref": "#/definitions/service_entries" }, "most_expensive_processes": { "$ref": "#/definitions/process_entries" }, "most_expensive_service_steps": { "type": "array", "items": { "$ref": "#/definitions/workflow_unit" } }, "most_expensive_process_steps": { "type": "array", "items": { "$ref": "#/definitions/workflow_unit" } } } }, "snapshotExposedItems": { "description": "The list of exposed items for a snapshot.", "type": "object", "properties": { "exposedItems": { "type": "array", "description": "Exposed Items for this snapshot", "items": { "$ref": "#/definitions/exposedItem" } } } }, "exposedItem": { "type": "object", "description": "Details of the exposed item", "properties": { "itemId": { "type": "string", "description": "The id of the exposed item" }, "name": { "type": "string", "description": "The name of the exposed item" }, "exposedType": { "type": "string", "description": "The type of the exposed item" }, "participantGroupName": { "type": "string", "description": "The unique name for the security group" }, "participantDisplayName": { "type": "string", "description": "The unique name for the security group that is user-friendly" }, "isExposed": { "type": "boolean", "description": "True if the item is exposed" }, "favoriteId": { "type": "string", "description": "A string representing the favorite id" }, "isUCA": { "type": "boolean", "description": "True if the item is a UCA" }, "type": { "type": "string", "description": "The type of the exposed Item", "enum": [ "BPD", "SERVICE", "REPORT", "SCOREBOARD", "EPV", "WEB_SERVICE", "TIMER", "MESSAGE", "CONTENT", "UCA", "UCA_Timer", "UCA_Message", "UCA_Content" ] }, "exposedAsName": { "type": "string", "description": "The exposed type label of the exposed item" } } }, "detailed_team_bindings_result": { "description": "The result for requesting the detailed team bindings of a snapshot", "type": "object", "required": [ "team_bindings" ], "properties": { "team_bindings": { "type": "array", "items": { "$ref": "#/definitions/detailed_team_binding" } } } }, "team_binding_details": { "description": "The details of the changes to be made to the team binding", "type": "object", "properties": { "snapshot_id": { "type": "string", "description": "the snapshot id of the app for this binding" }, "member_id": { "type": "string", "description": "the id of the member to remove" }, "members": { "type": "array", "items": { "type": "string" }, "description": "The members to add to this group" }, "group_id": { "type": "string", "description": "the id of the group to change" }, "participant_id": { "type": "string", "description": "the id of the participant group to change" }, "participant_ref": { "type": "string", "description": "the ref of the participant group to change" }, "automatic_refresh_enabled": { "type": "boolean", "description": "a boolean indicates automatic refresh should be enabled" } } }, "detailed_team_binding": { "description": "Details of a more details version of team binding.", "type": "object", "properties": { "id": { "type": "string", "description": "ID of the team binding" }, "groupName": { "type": "string", "description": "The name of the team binding" }, "groupId": { "type": "string", "description": "The id of the team binding" }, "participantId": { "type": "string", "description": "The pariticipant ID for this team binding" }, "participantRef": { "type": "string", "description": "The pariticipant reference for this team binding" }, "groupType": { "type": "string", "description": "The pariticipant ID for this team binding" }, "whereUsed": { "type": "array", "items": { "type": "string" }, "description": "The whereUsed attribute for this team binding" }, "members": { "type": "array", "items": { "$ref": "#/definitions/principal" }, "description": "The members of this team binding" }, "numberOfMembers": { "type": "integer", "description": "The number of members in this team binding" }, "numberOfTasks": { "type": "integer", "description": "The number of tasks in this team binding has" }, "managerId": { "type": "string", "description": "The id of the manager of this team binding" }, "managerName": { "type": "string", "description": "The id of the manager of this team binding" }, "autoRefresh": { "type": "boolean", "description": "The autoRefresh attribute for this team binding" }, "definitionType": { "type": "string", "description": "The autoRefresh attribute for this team binding" } } }, "principal_results": { "description": "The result for requesting the all the principal object of a snapshot", "required": [ "team_bindings" ], "properties": { "principals": { "type": "array", "items": { "$ref": "#/definitions/principal" } } } }, "principal": { "description": "An object to represent a client principal.", "properties": { "type": { "type": "string", "description": "The type of the object" }, "id": { "type": "string", "description": "The id of the object" }, "name": { "type": "string", "description": "The name of the object" }, "fullName": { "type": "string", "description": "The fullName of the object" }, "teamManagerGroupId": { "type": "string", "description": "The team manager group id for this object" }, "teamManagerGroupName": { "type": "string", "description": "The team manager group name for this object" }, "description": { "type": "string", "description": "The description for this object" }, "numberOfMembers": { "type": "string", "description": "The number of members for this principal" }, "permission": { "type": "string", "description": "The permission type for this principal" }, "readOnly": { "type": "boolean", "description": "The the read only property for this principal" }, "lastAdmin": { "type": "string", "description": "The number of members for this principal" } } }, "snapshotServerVariables": { "description": "The list of server variables for a snapshot.", "type": "object", "properties": { "serverVariables": { "type": "array", "description": "Server Variables for this snapshot", "items": { "$ref": "#/definitions/serverVariable" } } } }, "usageDataList": { "description": "A list of usageData.", "required": [ "attributes" ], "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/usageData" } } } }, "usageData": { "type": "object", "description": "Details of the usage data", "properties": { "componentId": { "type": "string", "description": "The component id for the component usage" }, "count": { "type": "integer", "description": "The the count of the component usage" } } }, "serverVariable": { "type": "object", "description": "Details of the server variable", "properties": { "serverName": { "type": "string", "description": "The name of the server for the variable" }, "description": { "type": "string", "description": "The description of the server variable" }, "serverType": { "type": "string", "description": "The type of the server.", "enum": [ "ECM", "ICM", "ILOG", "WS", "SAP", "REST", "OTHER" ] }, "projectShortName": { "type": "string", "description": "The project's acronym" }, "projectName": { "type": "string", "description": "The name of the project" }, "envVarRef": { "type": "string", "description": "A reference variable specific to this snapshot" }, "hostName": { "type": "string", "description": "The host of the server" }, "port": { "type": "string", "description": "The port for this server" }, "useHTTPS": { "type": "boolean", "description": "True if server uses HTTPS" }, "contextPath": { "type": "string", "description": "The Context Path for this server" }, "userName": { "type": "string", "description": "User name for this server" }, "password": { "type": "string", "description": "Password for this server. Do not populate this field in the REST API response." }, "hasPasswordForUpdate": { "type": "boolean", "description": "This is used for ECM, ICM, REST" }, "repository": { "type": "string", "description": "The repository of this server." }, "repositoryId": { "type": "string", "description": "The id of the repository of the server" }, "eventSourceId": { "type": "string", "description": "The event source id of the server" }, "useStaticCredentials": { "type": "boolean", "description": "True if the server uses static credentials" }, "documentAuthServiceRef": { "type": "string", "description": "Used by ECM type servers" }, "queryAuthServiceRef": { "type": "string", "description": "Used by ECM type servers" }, "participantRef": { "type": "string", "description": "Used by ECM type servers" }, "targetObjectStore": { "type": "string", "description": "Used by ICM type servers" }, "wsdlUrl": { "type": "string", "description": "Used by WS type servers" }, "wsdlProtected": { "type": "boolean", "description": "Used by WS type servers" }, "wsdlPasswordMode": { "type": "string", "description": "Used by WS type servers" }, "wsdlUserName": { "type": "string", "description": "Used by WS type servers" }, "wsdlFreeTextPassword": { "type": "string", "description": "Used by WS type servers" }, "wsdlPointyHashPassword": { "type": "string", "description": "Used by WS type servers" }, "dynamicallyLoadWSDL": { "type": "string", "description": "Used by WS type servers", "enum": [ "True", "False", "Unset" ] }, "overrideEndpoint": { "type": "boolean", "description": "Used by WS type servers" }, "endpointAddress": { "type": "string", "description": "Used by WS type servers" }, "endpointPort": { "type": "string", "description": "Used by WS type servers" }, "securityAndPolicy": { "type": "string", "description": "Used by WS type servers" }, "policySet": { "type": "string", "description": "Used by WS type servers" }, "policyBinding": { "type": "string", "description": "Used by WS type servers" }, "authentication": { "type": "string", "description": "Used by WS and REST type servers" }, "wsUserName": { "type": "string", "description": "Used by WS type servers" }, "passwordMode": { "type": "string", "description": "Used by WS type servers" }, "wsFreeTextPassword": { "type": "string", "description": "Used by WS type servers" }, "wsPointyHashPassword": { "type": "string", "description": "Used by WS type servers" }, "clientCertificateAlias": { "type": "string", "description": "Used by WS type servers" }, "clientSignRequest": { "type": "boolean", "description": "Used by WS type servers" }, "clientExpectEncryptedResponse": { "type": "boolean", "description": "Used by WS type servers" }, "serverCertificateAlias": { "type": "string", "description": "Used by WS type servers" }, "serverSignRequest": { "type": "boolean", "description": "Used by WS type servers" }, "serverExpectEncryptedResponse": { "type": "boolean", "description": "Used by WS type servers" }, "systemName": { "type": "string", "description": "Used by SAP type servers" }, "location": { "type": "string", "description": "Used by SAP type servers" }, "client": { "type": "string", "description": "Used by SAP type servers" }, "httpPort": { "type": "string", "description": "Used by SAP type servers" }, "httpsPort": { "type": "string", "description": "Used by SAP type servers" }, "connectionTimeout": { "type": "string", "description": "Used by REST type servers" }, "receiveTimeout": { "type": "string", "description": "Used by REST type servers" }, "invocationCredential": { "type": "string", "description": "Used by REST type servers" }, "sslConfiguration": { "type": "string", "description": "Used by REST type servers" } } }, "webServiceServerVariableInfo": { "type": "object", "description": "Policy set names, policy bindings, client certificate aliases, server certificate aliases informatino for a WS server variable type.", "properties": { "policySetList": { "type": "array", "description": "The list of policy sets used by WS type servers", "items": { "type": "string" } }, "policyBindingsList": { "type": "array", "description": "The list of policy bindings used by WS type servers", "items": { "type": "string" } }, "clientCertificateAliases": { "type": "array", "description": "The list of client certificate aliases used by WS type servers", "items": { "type": "string" } }, "serverCertificateAliases": { "type": "array", "description": "The list of the keys and values of the server certificate aliases used by WS type servers", "items": { "type": "string" } } } }, "repositoryInfo": { "type": "object", "description": "Repository info of the server variable after connection test.", "properties": { "repositoryID": { "type": "string", "description": "Id of the repository." }, "eventSourceID": { "type": "string", "description": "Id of the event source" } } }, "snapshotEventSubscriptionList": { "type": "object", "description": "A list of event subscription objects.", "properties": { "snapshotESList": { "type": "array", "description": "an array of the sanpshotEventSubscription object.", "items": { "$ref": "#/definitions/snapshotEventSubscription" } } } }, "snapshotEventSubscription": { "type": "object", "description": "A map of event subscription type and and array of a server list.", "properties": { "name": { "type": "string", "description": "an event subscription type." }, "serverList": { "type": "array", "description": "A map of event subscription server tuple objects.", "items": { "$ref": "#/definitions/eventSubscriptionServerNameTuple" } } } }, "eventSubscriptionServerNameTuple": { "type": "object", "description": "A tuple of event subscription objects and the server name", "properties": { "serverName": { "type": "string", "description": "The server name of an event subscription." }, "eventSubscriptions": { "type": "array", "description": "The event subscription object.", "items": { "$ref": "#/definitions/eventSubscription" } } } }, "eventSubscription": { "type": "object", "description": "Event subscription info.", "properties": { "estype": { "type": "string", "description": "the es type of the event subscription.", "enum": [ "ECM" ] }, "serviceType": { "type": "string", "description": "the service type of the event subscription.", "enum": [ "REGULAR", "RULE", "AJAX", "HUMAN", "INTEGRATION", "INSTALLATION", "BACKGROUND", "SCA", "ICM", "UCA", "OTHER" ] }, "id": { "type": "string", "description": "the id of the event subscription." }, "name": { "type": "string", "description": "the name of the event subscription." }, "serverName": { "type": "string", "description": "the server name of the event subscription." }, "response": { "type": "string", "description": "the response of the event subscription." }, "eventClass": { "type": "string", "description": "the event class of the event subscription." }, "objectType": { "type": "string", "description": "the object type name of the event subscription." }, "eventType": { "type": "string", "description": "the event type of the event subscription." }, "exposed": { "type": "boolean", "description": "indicates whether or not the event subscription is exposed." }, "favoriteId": { "type": "string", "description": "the favorite id of the event subscription." }, "serviceName": { "type": "string", "description": "the service name of the event subscription." } } }, "participant_group": { "type": "object", "description": "Client facing participant group object (replicate of com.lombardisoftware.processadmin.client.clientObjects.ClientParticipantGroup. Used for the sync settings modal.", "properties": { "groupName": { "type": "string", "description": "group name of participant group object." }, "groupId": { "type": "string", "description": "group id of participant group object." }, "numMembers": { "type": "integer", "description": "number of members within particiapnt group object." }, "numGroups": { "type": "integer", "description": "number of groups within participant group object." } } }, "admin_epv": { "type": "object", "description": "EPV values for the snapshot preview.", "properties": { "EPVName": { "type": "string", "description": "the name of the admin epv variable." }, "snapshotId": { "type": "string", "description": "snapshot id of the admin epv variable." }, "epvRef": { "type": "string", "description": "epv reference of the admin epv variable." }, "epvVarValues": { "type": "array", "description": "a list of the values within th admin epv variable.", "items": { "type": "array", "description": "", "$ref": "#/definitions/admin_epv_variable" } } } }, "admin_epv_variable": { "type": "object", "description": "EPV variable for the admin_epv definition", "properties": { "snapshotId": { "type": "string", "description": "snapshot id of the admin epv variable." }, "epvId": { "type": "string", "description": "snapshot id of the admin epv variable." }, "epvVariableId": { "type": "string", "description": "snapshot id of the admin epv variable." }, "name": { "type": "string", "description": "snapshot id of the admin epv variable." }, "description": { "type": "string", "description": "snapshot id of the admin epv variable." }, "currentValue": { "type": "string", "description": "snapshot id of the admin epv variable." }, "values": { "type": "array", "description": "", "items": { "$ref": "#/definitions/admin_epv_variable_value" } } } }, "admin_epv_variable_value": { "type": "object", "description": "Details of the exposed process value variable", "properties": { "value": { "type": "string", "description": "The value of the variable" }, "effective_date": { "type": "string", "description": "The effective date of the variable value" }, "modified_by": { "type": "string", "description": "The username of who modified the variable value last" }, "modified_date": { "type": "string", "description": "The modified date of the variable value" }, "epv_var_value_id": { "type": "string", "description": "The unique id for this epv variable value" }, "localized_date_modified_date": { "type": "string", "description": "The localized date of the modified variable value" }, "localized_time_modified_date": { "type": "string", "description": "The localized time of the modified variable value" }, "localized_date_effective_date": { "type": "string", "description": "The localized date of the effected variable value" }, "localized_time_effective_date": { "type": "string", "description": "The localized time of the effected variable value" } } }, "snapshotPreview": { "type": "object", "description": "Provides a preview of EPV values, environment variables and participant groups of the snapshot.", "properties": { "epv_vars": { "type": "array", "description": "An array of the EPV values.", "items": { "$ref": "#/definitions/admin_epv" } }, "env_vars": { "type": "array", "description": "An array of the environment variables.", "items": { "$ref": "#/definitions/env_var" } }, "participant_groups": { "type": "array", "description": "An array of the participant groups.", "items": { "$ref": "#/definitions/participant_group" } } } }, "migration_instructions": { "description": "A list of snapshot migration instructions.", "type": "object", "properties": { "migration_instructions": { "type": "array", "items": { "$ref": "#/definitions/migration_instruction" }, "description": "A list of snapshot migration instructions for other snapshots." } } }, "migration_instruction": { "description": "Details of the snapshot migration instruction", "type": "object", "required": [ "snapshot_id", "action" ], "properties": { "snapshot_id": { "description": "The snapshot id.", "type": "string" }, "action": { "description": "The type of the action can be leave, migrate, or delete.", "type": "string", "enum": [ "leave", "migrate", "delete" ], "default": "leave" } } }, "workflow_automation_version": { "description": "The response data", "type": "object", "properties": { "projectId": { "description": "The project ID", "type": "string" }, "branchId": { "description": "The branch ID", "type": "string" }, "taskDefIds": { "description": "The task definition id", "type": "array", "items": { "type": "string" } } } }, "request_task": { "description": "Request task", "type": "object", "properties": { "name": { "description": "Task Definition Name", "type": "string" }, "description": { "description": "Task Definition description", "type": "string" }, "id": { "description": "Task definition id", "type": "string" }, "version": { "description": "Task definition description", "type": "string" }, "automation_service_definitions": { "description": "Task definition description", "type": "array", "items": { "$ref": "#/definitions/automation_service_definition" } }, "user_task_definitions": { "description": "Task definition description", "type": "array", "items": { "$ref": "#/definitions/user_task_definition" } }, "external_implementation_definitions": { "description": "Task definition description", "type": "array", "items": { "$ref": "#/definitions/external_implementation_definition" } } } }, "automation_service_definition": { "description": "Request task", "type": "object", "properties": { "name": { "description": "Automation service definition", "type": "string" }, "description": { "description": "Automation service definition", "type": "string" }, "operations": { "description": "Automation service description", "type": "array", "items": { "$ref": "#/definitions/automation_service_definition_operation" } } } }, "user_task_definition": { "description": "Request task", "type": "object", "properties": { "name": { "description": "User task definition", "type": "string" }, "inputs": { "description": "User task definition", "type": "array", "items": { "$ref": "#/definitions/input" } }, "outputs": { "description": "User task description", "type": "array", "items": { "$ref": "#/definitions/output" } }, "assignments": { "description": "User task description", "type": "object", "properties": { "potential_owners": { "description": "Potential owners description", "type": "object", "properties": { "user_input_paramater": { "description": "User_input_parameter description", "type": "string" } } } } }, "due_in": { "description": "User task description", "type": "object", "properties": { "duration": { "description": "User task description", "type": "string" } } }, "implementation": { "description": "User task description", "type": "object", "properties": { "kind": { "description": "User task description", "type": "string" }, "reference": { "description": "User task description", "type": "string" } } } } }, "external_implementation_definition": { "description": "Request task", "type": "object", "properties": { "name": { "description": "External implementation definition", "type": "string" }, "inputs": { "description": "External implementation definition", "type": "array", "items": { "$ref": "#/definitions/input" } }, "outputs": { "description": "External implementation description", "type": "array", "items": { "$ref": "#/definitions/output" } } } }, "automation_service_definition_operation": { "description": "Automation service definition operation", "type": "object", "properties": { "name": { "description": "Operation name", "type": "string" }, "description": { "description": "Operation name", "type": "string" }, "inputs": { "description": "inputs", "type": "array", "items": { "$ref": "#/definitions/input" } }, "outputs": { "description": "ouputs", "type": "array", "items": { "$ref": "#/definitions/output" } }, "implementation": { "description": "ouputs", "type": "object", "properties": { "kind": { "description": "Output description", "type": "string" }, "reference": { "description": "Output description", "type": "string" } } }, "utterances": { "description": "ouputs", "type": "array", "items": { "type": "string" } } } }, "input": { "description": "Inputs", "type": "object", "properties": { "name": { "description": "Inputs", "type": "string" }, "description": { "description": "Inputs", "type": "string" }, "type": { "description": "Inputs", "type": "string" } } }, "output": { "description": "Outputs", "type": "object", "properties": { "name": { "description": "Output description", "type": "string" }, "description": { "description": "Output description", "type": "string" }, "type": { "description": "Output description", "type": "string" } } }, "userInput": { "description": "Data for creating a new user.", "type": "object", "properties": { "userName": { "description": "Username created for the user.", "type": "string" }, "fullName": { "description": "User's full name", "type": "string" }, "password": { "description": "User's password'", "type": "string" }, "confirmPassword": { "description": "User's password entered a second time.", "type": "string" }, "disabled": { "description": "Whether user is disabled or not", "type": "boolean" } } }, "userCredentials": { "description": "The user's credentials data.", "type": "object", "properties": { "userId": { "description": "Id identifying the user.", "type": "string" }, "userName": { "description": "The user's username.", "type": "string" }, "fullName": { "description": "The user's full name.", "type": "string" }, "disabled": { "description": "Whether the user is active or disabled.", "type": "boolean" } } }, "userDetails": { "description": "The user's details data.", "type": "object", "properties": { "userId": { "description": "The is identifying the user.", "type": "string" }, "userName": { "description": "The user's username.", "type": "string" }, "fullName": { "description": "The user's full name.", "type": "string" }, "password": { "description": "The user's password.", "type": "string" }, "confirmPassword": { "description": "Confirmation of the user's password.", "type": "string" }, "disabled": { "description": "Whether the user is active or disabled.", "type": "boolean" } } }, "userSearch": { "description": "The user's search results data.", "type": "object", "properties": { "userId": { "description": "The is identifying the user.", "type": "string" }, "userName": { "description": "The user's username.", "type": "string" }, "fullName": { "description": "The user's full name.", "type": "string" }, "disabled": { "description": "Whether the user is active or disabled.", "type": "boolean" }, "lastAdmin": { "description": "The user was the last admin.", "type": "boolean" } } }, "userSearchResultList": { "description": "Users matching the search.", "type": "object", "properties": { "users": { "description": "List of users matching the search.", "type": "array", "items": { "$ref": "#/definitions/userSearch" } } } }, "traceSpec": { "description": "The trace spec for the server.", "type": "object", "properties": { "value": { "description": "The trace specification", "type": "string" }, "defaultValue": { "description": "The default trace specification", "type": "string" } } }, "instance_transfer_control": { "title": "Moving Snapshot", "description": "The configuration/status of Process Instance Transfer.", "required": [ ], "properties": { "target_name": { "type": "string", "description": "Target name" }, "attempt_id": { "type": "string", "description": "attempt id" }, "start_time": { "type": "string", "description": "attempt id" }, "end_time": { "type": "string", "description": "attempt id" }, "status": { "type": "string", "description": "The public-facing life cycle status of the Process Instance Transfer." }, "internal_status": { "type": "string", "description": "The internal backend life cycle status (includes sub-steps)." }, "frozen_time": { "type": "string", "description": "attempt id" }, "data": { "type": "object", "description": "The log content for the moving operation." }, "settings": { "type": "object", "description": "The settings for the moving operation." }, "check_result": { "type": "object", "description": "The check result about source and target." } } }, "instance_transfer_controls": { "title": "A collection of Process Instance Transfer configuration/status", "description": "List of all moving snapshots.", "required": [ "instance_transfer_controls" ], "properties": { "instance_transfer_controls": { "type": "array", "items": { "$ref": "#/definitions/instance_transfer_control" } } } }, "instance_transfer_attempt": { "title": "Moving Attempt", "description": "The historic record of Process Instance Transfer attempt.", "required": [ "move_id", "state" ], "properties": { "move_id": { "type": "string", "description": "The id that is associated to the configuration that governs the moving attempt." }, "attempt_id": { "type": "string", "description": "attempt id" }, "start_time": { "type": "string", "description": "start time" }, "end_time": { "type": "string", "description": "end time" }, "status": { "type": "string", "description": "The public-facing life cycle status of the Process Instance Transfer." }, "internal_status": { "type": "string", "description": "The internal backend life cycle status (includes sub-steps)." }, "transfer_start_time": { "type": "string", "description": "attempt id" }, "transfer_end_time": { "type": "string", "description": "attempt id" }, "transformation_start_time": { "type": "string", "description": "attempt id" }, "transformation_end_time": { "type": "string", "description": "attempt id" }, "log": { "type": "object", "description": "The log content for the moving operation." }, "settings": { "type": "object", "description": "The settings for the moving operation." }, "check_result": { "type": "object", "description": "The analysis result about source and target." } } }, "instance_transfer_attempts": { "title": "A collection of Process Instance Transfer attempt records", "description": "List of all moving attempt records.", "required": [ "attempts" ], "properties": { "attempts": { "type": "array", "items": { "$ref": "#/definitions/instance_transfer_attempt" } } } }, "transfer_target": { "title": "Transfer Target", "description": "A transfer target configuration and its current status.", "required": [ "target_id", "name", "db_type", "db_host", "db_port", "db_user", "db_password", "db_ssl_enabled" ], "properties": { "target_id": { "type": "string", "description": "The unique identifier of the migration target." }, "name": { "type": "string", "description": "The name of the migration target." }, "db_type": { "type": "string", "description": "The type of the database.", "enum": [ "DB2", "Oracle", "SQLServer", "PostgreSQL" ] }, "db_host": { "type": "string", "description": "The hostname or IP address of the database server." }, "db_port": { "type": "integer", "description": "The port number for the database connection.", "format": "int32", "example": 50000 }, "db_name": { "type": "string", "description": "The name of the database." }, "db_user": { "type": "string", "description": "The username for database authentication." }, "db_password": { "type": "string", "format": "password", "description": "The password for database authentication." }, "db_ssl_enabled": { "type": "boolean", "description": "Whether SSL is enabled for the database connection.", "default": false }, "datasource_jndi_name": { "type": "string", "description": "The JNDI name of the datasource as defined in the application server." }, "baw_host": { "type": "string", "description": "The hostname of the Business Automation Workflow server." }, "baw_port": { "type": "integer", "description": "The port number of the BAW server.", "format": "int32" }, "baw_user": { "type": "string", "description": "Admin username for the BAW server." }, "baw_password": { "type": "string", "format": "password", "description": "Admin password for the BAW server." }, "more_settings": { "type": "object", "description": "More settings for the moving target." }, "status": { "type": "string", "description": "Current connection status of this target." }, "messages": { "type": "object", "description": "The message or error trace from the last connection attempt." } } }, "transfer_targets": { "title": "Transfer Targets", "description": "List of all transfer targets.", "required": [ "transfer_targets" ], "properties": { "transfer_targets": { "type": "array", "items": { "$ref": "#/definitions/transfer_target" } } } }, "fdrBpdEnablement": { "description": "Returns whether the Federated Data Repository BPD indexing is enabled or not", "type": "object", "properties": { "enabled": { "description": "Boolean stating if the Federated Data Repository BPD indexing is enabled or not", "type": "boolean" } } }, "fdrBpdInfo": { "description": "Information about the Federated Data Repository BPD indexer", "type": "object", "properties": { "date": { "type": "string", "description": "The date of the info retrieval" }, "indexedContent": { "$ref": "#/definitions/fdrBpdIndexedContent" }, "indexingQueue": { "$ref": "#/definitions/fdrBpdIndexingQueue" } } }, "fdrBpdIndexedContent": { "description": "Information about the content of the Federated Data Repository BPD index", "type": "object", "properties": { "instanceCount": { "description": "Number of indexed process instances", "type": "integer" }, "taskCount": { "description": "Number of indexed tasks", "type": "integer" }, "latestInstanceIndexedTime": { "type": "string", "description": "The date of the latest process instance document indexation time" }, "latestTaskIndexedTime": { "type": "string", "description": "The date of the latest task document indexation time" }, "deletedInstanceCount": { "description": "Number of process instances documents deleted but still tracked in FED_INDEX_INSTANCE table", "type": "integer" }, "deletedTaskCount": { "description": "Number of task documents deleted but still tracked in FED_INDEX_TASK table", "type": "integer" } } }, "fdrBpdIndexingQueue": { "description": "Information about the content of the Federated Data Repository BPD indexing queue", "type": "object", "properties": { "oldestPendingEntry": { "type": "string", "description": "The date of the oldest queue entry waiting to be processed" }, "youngestPendingEntry": { "type": "string", "description": "The date of the youngest queue entry waiting to be processed" }, "pendingUpdateCount": { "description": "Number of regular indexing queue entries waiting to be processed", "type": "integer" }, "pendingRebuildCount": { "description": "Number of rebuild queue entries waiting to be processed", "type": "integer" }, "pendingDeletionCount": { "description": "Number of deletion queue entries waiting to be processed", "type": "integer" }, "failedCount": { "description": "Number of failed queue entries which will not be re-processed until a retry-failures maintenance operation is triggered", "type": "integer" }, "oldestFailedEntry": { "type": "string", "description": "The date of the oldest failed queue entry" }, "youngestFailedEntry": { "type": "string", "description": "The date of the youngest failed queue entry" } } }, "fdrBpdMaintenanceOperationsList": { "description": "List of maintenance operations of the BPD indexer", "type": "object", "properties": { "message": { "description": "The description of the response", "type": "string" }, "maintenances": { "type": "array", "items": { "$ref": "#/definitions/fdrBpdMaintenanceOperationItem" } } } }, "fdrBpdMaintenanceOperation": { "description": "Single maintenance operation of the BPD indexer", "type": "object", "properties": { "message": { "description": "The description of the response", "type": "string" }, "maintenance": { "$ref": "#/definitions/fdrBpdMaintenanceOperationItem" } } }, "fdrBpdMaintenanceOperationItem": { "description": "Details about a maintenance operation of the BPD indexer", "type": "object", "properties": { "type": { "description": "The type of the maintenance operation", "type": "string", "enum": [ "create-index", "house-keeping", "rebuild", "retry-failures", "reconcile", "restore", "post-backup", "sync-deletions" ] }, "status": { "description": "The status of the maintenance operation", "type": "string", "enum": [ "submitted", "running", "suspended", "completed", "aborted", "failed" ] }, "startTime": { "description": "The start time of the maintenance operation", "type": "string" }, "endTime": { "description": "The start time of the maintenance operation", "type": "string" }, "details": { "description": "The details of the maintenance operation. When aborting, suspending or resuming a maintenance operation, this property contains details about the status of the maintenance operation before it got aborted, suspended ot resumed.", "type": "object" } } }, "fdrBpdBackupState": { "description": "Details about a backup state of the Federated Data Repository BPD indexer", "type": "object", "properties": { "message": { "description": "The description of the response", "type": "string" }, "createdBy": { "description": "The user who initiated the creation of this backup state", "type": "string" }, "latestInstanceDocIndexedTime": { "description": "The latest indexation time of a process instance document", "type": "string" }, "latestTaskDocIndexedTime": { "description": "The latest indexation time of a task document", "type": "string" } } } } }