tags.
Example:
\t
","operationId":"setUsersRolesRegistry","parameters":[{"name":"eraseAllUsersAndGroups","in":"query","description":"Erase all existing users and groups, default is false","required":false,"schema":{"type":"boolean"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"xml file that contains users, groups and roles registry mappings"}},"required":["file"]}}}},"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/repository/ldap/sync":{"post":{"tags":["Admin"],"summary":"Synchronize the repository with any associated LDAP server","description":"You must have the 'rtsAdministrator' role to perform this action.","operationId":"ldapSync","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/releases/{releaseId}":{"get":{"tags":["Explore"],"summary":"Details of the release","operationId":"release","parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Release"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]},"post":{"tags":["Govern"],"summary":"Update an open release of a decision service","description":"This operation can be done by the release owner or an administrator.
Only the provided fields in the JSON payload are used for updating.
An empty field in the JSON payload deletes its corresponding data during an update.
Required fields:
- Name of the release
- Owner of the release
- Target date of the release
Notes: Approvers who are either in ApprovedChanges or RejectedChanges state might not be removed.
The target date of the release cannot be set to a date earlier than today.
The owner of the release must be a registered user.
The name of the release cannot contain any of the following characters: \":*/\\<>?
","operationId":"updateRelease","parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"description":"The JSON payload describing the release to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReleaseInput"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Release"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]},"delete":{"tags":["Govern"],"summary":"Delete an open release in a decision service","description":"This operation can be done by the release owner or an administrator.","operationId":"deleteRelease","parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/releases/{releaseId}/reopen":{"post":{"tags":["Govern"],"summary":"Reopen a release that is canceled or rejected in a decision service","description":"This operation can be done by the release owner or an administrator.","operationId":"reopenRelease","parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/releases/{releaseId}/removeapprover":{"post":{"tags":["Govern"],"summary":"Remove an approver from an open release of a decision service","description":"This operation can be done by the release owner or an administrator.","operationId":"removeReleaseApprover","parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"approverName","in":"query","description":"the name of the approver to remove.","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/releases/{releaseId}/reject":{"post":{"tags":["Govern"],"summary":"Reject the open release of a decision service","description":"An authenticated approver can reject a release and include an optional comment to explain the rejection.
Note: The authenticated activity owner or administrator can reject the release on behalf of an approver. In this case, the approver's name must be provided as a parameter.","operationId":"rejectRelease","parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userName","in":"query","description":"the name of the user on behalf of whom rejecting the release.","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string","description":"the rejection comment."}}}},"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/releases/{releaseId}/changeowner":{"post":{"tags":["Govern"],"summary":"Change the owner of an open release of a decision service","description":"When this operation is done, only the new owner or an administrator can do owner's tasks in this release.
This operation can be done by the release owner or an administrator.","operationId":"changeReleaseOwner","parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ownerName","in":"query","description":"the name of the owner.","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/releases/{releaseId}/cancel":{"post":{"tags":["Govern"],"summary":"Cancel an open release in a decision service","description":"This operation can be done by the release owner or an administrator.
","operationId":"cancelRelease","parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/releases/{releaseId}/approve":{"post":{"tags":["Govern"],"summary":"Approve an open release of a decision service","description":"An authenticated approver can approve a release and include an optional comment to explain the approval.
Note: The authenticated activity owner or administrator can approve this release on behalf of an approver.In this case, the approver's name must be provided as a parameter.","operationId":"approveRelease","parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userName","in":"query","description":"the name of the user on behalf of whom approving the release.","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string","description":"the approval comment."}}}},"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/releases/{releaseId}/allowapproval":{"post":{"tags":["Govern"],"summary":"Allow the approval of an open release of a decision service","description":"The owner of a release allows the approval of the release when all the release activities are completed.
This operation can be done by the release owner or an administrator.","operationId":"allowReleaseApproval","parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/releases/{releaseId}/addapprover":{"post":{"tags":["Govern"],"summary":"Add an approver to an open release of a decision service","description":"This operation can be done by the release owner or an administrator.
","operationId":"addReleaseApprover","parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"approverName","in":"query","description":"the name of the approver to add.","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/permissions/tab/import":{"post":{"tags":["Admin"],"summary":"Import tab permissions","description":"The existing permissions for the tabs are overwritten.
Here is a JSON sample that can be imported:
[
{
"tab" : "Model",
"disabledForGroups" : ["group1", "group2"]
},
{
"tab" : "Reports",
"disabledForGroups" : ["group1"]
}
]
Only DecisionArtifacts, Queries, Tests, Simulation, Deployments, Snapshots, Model and Reports tabs are supported for now.","operationId":"importTabPermissions","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"JSON file that contains the permissions to import"}},"required":["file"]}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/permissions/import":{"post":{"tags":["Admin"],"summary":"Import permissions","description":"The existing permissions for the group are overwritten.
Here is a JSON sample that can be imported:
{
"group": "Eligibility",
"permissions": [
{
"permission": "CREATE",
"value": "YES",
"type": "brm.ActionRule"
},
{
"permission": "VIEW",
"value": "YES",
"type": "*"
},
{
"permission": "UPDATE",
"value": "NO",
"type": "*",
"feature": "*"
},
{
"permission": "UPDATE",
"value": "YES",
"type": "brm.DecisionTable",
"feature": "name"
}
]
}
The endpoint of effective permissions can be used to find the internal name of a type or feature.","operationId":"importPermissions","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"JSON file that contains the permissions to import"}},"required":["file"]}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/permissions/command/import":{"post":{"tags":["Admin"],"summary":"Import command permissions","description":"The existing permissions for the commands are overwritten.
Here is a JSON sample that can be imported:
[
{
"command" : "ExportBranch",
"disabledForGroups" : ["group1", "group2"]
},
{
"command" : "GenerateReportElement",
"disabledForGroups" : ["group1"]
}
]
Only ExportBranch and GenerateReportElement commands are supported for now.","operationId":"importCommandPermissions","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"JSON file that contains the permissions to import"}},"required":["file"]}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/group":{"post":{"tags":["Admin"],"summary":"Add or update a group.","description":"Possible values for securityProfile field are: \"FULLACCESS\", \"NOACCESS\", \"READONLY\" and \"CUSTOM\".","operationId":"addGroup","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/dynamicdomains/{decisionServiceId}/update":{"post":{"tags":["Admin"],"summary":"Update dynamic domains","operationId":"updateDynamicDomains","parameters":[{"name":"decisionServiceId","in":"path","description":"ID of the decision service","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the branch. Defaults to the main branch.","required":false,"schema":{"type":"string"}},{"name":"bomClassesFQN","in":"query","description":"Comma-separated list of fully qualified names of BOM classes for which you want to update the domain. By default all domains are updated","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/deployments/{deploymentId}/deploy":{"post":{"tags":["Build"],"summary":"Deploy a RuleApp to an execution server (Rule Execution Server)","description":"If no deployment snapshot name is given, a deployment snapshot is created if the deployment configurationhas the 'snapshotMode' attribute set to 'Always'.
If a deployment snapshot name is provided, a deployment snapshot is created with that name if it does not already exist.
This deployment snapshot is then used as the basis for building the RuleApp archive.
The response body contains the deployment snapshot that is created or used and the list of checking messages, if any.","operationId":"deploy","parameters":[{"name":"deploymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the release, branch, or snapshot to work with. Defaults to the main branch.","required":false,"schema":{"type":"string"}},{"name":"deploymentSnapshotName","in":"query","description":"Name of the deployment snapshot to create or use","required":false,"schema":{"type":"string"}},{"name":"serverId","in":"query","required":false,"schema":{"type":"string"}},{"name":"rulesetsNewVersions","in":"query","description":"Comma-separated list of ruleset versions, the format is rulesetName:version (for instance ruleset1:3.0,ruleset2:4.0). If not set, the default version policy is used.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number in the list of errors, if any","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the error page. If empty, all errors are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentResult"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/deployments/{deploymentId}/build":{"post":{"tags":["Build"],"summary":"Build a RuleApp for the deployment configuration","description":"If no deployment snapshot name is given, a deployment snapshot is created if deployment configuration has the 'snapshotMode' attribute set to 'Always'.
If a deployment snapshot name is provided, a deployment snapshot is created with that name if it does not already exist.
This deployment snapshot is then used as the basis for building the RuleApp archive.
The response body contains the deployment snapshot that is created or used, the list of checking messages, if any, and a byte array of the archive if the includeArchive flag is set to true.","operationId":"build","parameters":[{"name":"deploymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the release, branch, or snapshot to work with. Defaults to the main branch.","required":false,"schema":{"type":"string"}},{"name":"deploymentSnapshotName","in":"query","description":"Name of the deployment snapshot to create or use","required":false,"schema":{"type":"string"}},{"name":"includeArchive","in":"query","description":"Include the archive byte array in the response. False by default. Don't set this flag for very large files.","required":false,"schema":{"type":"boolean"}},{"name":"page","in":"query","description":"Page number in the list of errors, if any","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the error page. If empty, all the errors are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentResult"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices/{decisionServiceId}/snapshot":{"post":{"tags":["Build"],"summary":"Create a snapshot of a branch in the decision service","description":"To create a snapshot, the status of the branch, if any, cannot be 'complete' or 'canceled'.","operationId":"snapshot_1","parameters":[{"name":"decisionServiceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the target branch, activity, or release. If none is specified, it defaults to the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"The name of the snapshot to create.","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardSnapshot"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices/{decisionServiceId}/import":{"post":{"tags":["Admin"],"summary":"Import a decision service on top of an existing branch","description":"The authenticated user must have the 'rtsAdministrator' role to call this endpoint","operationId":"branchImport","parameters":[{"name":"decisionServiceId","in":"path","description":"ID of the target decision service","required":true,"schema":{"type":"string"}},{"name":"override","in":"query","description":"Override all the artifacts that have the same ID in the database","required":false,"schema":{"type":"boolean"}},{"name":"overrideAll","in":"query","description":"Override all the artifacts of the branch with the ones from the zip file. When this parameter is used, after import, the content of the branch will match exactly with the content of the zip file","required":false,"schema":{"type":"boolean"}},{"name":"baselineId","in":"query","description":"ID of the target branch, activity, or release. If none is specified, it defaults to the 'main' branch.","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Compressed file that contains the decision service to import"}},"required":["file"]}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices/{decisionServiceId}/decisiontables/{decisionTableId}/import":{"post":{"tags":["Manage"],"summary":"Import an Excel file into an existing decision table","operationId":"importDT","parameters":[{"name":"decisionServiceId","in":"path","description":"ID of the decision service","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the branch of the decision table. Defaults to the main branch.","required":false,"schema":{"type":"string"}},{"name":"decisionTableId","in":"path","description":"Decision table ID for which you want to import the Excel file in.","required":true,"schema":{"type":"string"}},{"name":"dtSheetName","in":"query","description":"Name of the Excel sheet you want to read the DT from. Defaults to the first sheet.","required":false,"schema":{"type":"string"}},{"name":"stopOnWrongNumberOfColumns","in":"query","description":"Prevent the import if the number of columns doesn't match. True by default.","required":false,"schema":{"type":"boolean"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Excel file that contains the decision table to import"}},"required":["file"]}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices/import":{"post":{"tags":["Admin"],"summary":"Import a decision service into the repository","description":"- The authenticated user must have the 'rtsAdministrator' role to call this endpoint.
- If a decision service that has the same UUID already exists in the repository, the project elements that do not exist yet in the 'main' branch are imported on top of it. Other elements are simply ignored. If you want to override existing elements or target another branch, use /decisionservices/{id}/import instead
","operationId":"decisionServicesImport","parameters":[{"name":"enableDGF","in":"query","description":"Enable the decision governance framework by creating an 'Initial Release'. This does not apply if the decision service already exists in the database.","required":false,"schema":{"type":"boolean"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Compressed file that contains the decision service to import"}},"required":["file"]}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/branches/{branchId}/security":{"get":{"tags":["Admin"],"summary":"Security configuration of a branch","description":"\"true\" if security is enforced on the branch, \"false\" otherwise.
If security configuration is inherited from parent branch \"(Inherited)\" is added to the response.","operationId":"branchSecurity","parameters":[{"name":"branchId","in":"path","description":"ID of the branch","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]},"post":{"tags":["Admin"],"summary":"Enforce the security on a branch","operationId":"branchSecurity_1","parameters":[{"name":"branchId","in":"path","description":"ID of the branch","required":true,"schema":{"type":"string"}},{"name":"securityEnforced","in":"query","description":"\"true\" to enforce security on the branch, \"false\" to disable security on the branch and \"Inherited\" to inherit security configuration from parent branch","required":true,"schema":{"type":"string"}},{"name":"groups","in":"query","description":"Comma-separated list of groups. This parameter is ignored if securityEnforced is set to \"Inherited\"","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/activities/{activityId}":{"get":{"tags":["Explore"],"summary":"Details of the activity","operationId":"activity","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Activity"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]},"post":{"tags":["Govern"],"summary":"Update an activity in an open release","description":"Only the provided fields in the JSON payload are used in updating.
An empty field in the JSON payload deletes the corresponding data during the update.
Required fields:
- Name of the activity
- Owner of the activity
- Target date of the activity
Notes:
- Approvers who are either in ApprovedChanges or RejectedChanges state cannot be removed.
- Any authors who contributed to this activity with modifications cannot be removed.
- The target date of the activity cannot be set to a date earlier than today, and no later than the release target date.
- The name of the activity cannot contain any of the following characters: \":*/\\<>?
","operationId":"updateActivity","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"description":"The JSON payload describing the Activity to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityInput"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Activity"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]},"delete":{"tags":["Govern"],"summary":"Delete an activity in an open release","description":"This operation can be done by the release owner or an administrator.","operationId":"deleteActivity","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/activities/{activityId}/resumework":{"post":{"tags":["Govern"],"summary":"Resume work in an activity in an open release","description":"An author can resume work in an activity after previously finishing it.
Note: The authenticated activity owner or administrator can resume work on behalf of an author. In this case, the authors's name must be provided as a parameter.","operationId":"resumeWorkInActivity","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userName","in":"query","description":"the name of the person on behalf of whom resuming work","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/activities/{activityId}/reopen":{"post":{"tags":["Govern"],"summary":"Reopen an activity in an open release","description":"This operation can be done by the activity owner or an administrator.","operationId":"reopenActivity","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/activities/{activityId}/removeauthor":{"post":{"tags":["Govern"],"summary":"Remove an author from an activity in an open release","description":"The author matching the provided name is removed from the activity's list of authors.
This operation can be done by the activity owner or an administrator.","operationId":"removeActivityAuthor","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorName","in":"query","description":"the name of the author to remove","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/activities/{activityId}/removeapprover":{"post":{"tags":["Govern"],"summary":"Remove an approver from an activity in an open release","description":"The approver matching the provided name is removed from the list of approvers.
This operation can be done by the activity owner or an administrator.","operationId":"removeActivityApprover","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"approverName","in":"query","description":"the name of the approver to remove","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/activities/{activityId}/reject":{"post":{"tags":["Govern"],"summary":"Reject changes of an activity in an open release","description":"An authenticated approver can reject an activity and include an optional comment to explain the rejection.
Note: The authenticated activity owner or administrator can reject the activity on behalf of an approver. In this case, the approver's name must be provided as a parameter.","operationId":"rejectChangesInActivity","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userName","in":"query","description":"the name of the user for whom the activity is rejected","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string","description":"the rejection comment."}}}},"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/activities/{activityId}/finishwork":{"post":{"tags":["Govern"],"summary":"Finish work on an activity in an open release","description":"When done, the author indicates that the work is finished.
Note: The authenticated activity owner or administrator can finish work on behalf of an author. In this case, the authors's name must be provided as a parameter.","operationId":"finishWorkInActivity","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userName","in":"query","description":"the name of the person on behalf of whom finishing work","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/activities/{activityId}/changeowner":{"post":{"tags":["Govern"],"summary":"Change the owner of an activity in an open release","description":"The owner of the activity is changed by the user matching the provided name.
This operation can be done by the activity owner or an administrator.","operationId":"changeActivityOwner","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ownerName","in":"query","description":"the name of the owner to change","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/activities/{activityId}/cancel":{"post":{"tags":["Govern"],"summary":"Cancel an activity in an open release","description":"This operation can be done by the activity owner or an administrator.
","operationId":"cancelActivity","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/activities/{activityId}/approve":{"post":{"tags":["Govern"],"summary":"Approve changes of an activity in an open release","description":"An authenticated approver can approve an activity and includ an optional comment to explain the approval.
Note: The authenticated activity owner or administrator can approve this activity on behalf of an approver. In this case, the approver's name must be provided as a parameter.","operationId":"approveChangesInActivity","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userName","in":"query","description":"the name of the user on behalf of whom approving this activity","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string","description":"the approval comment."}}}},"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/activities/{activityId}/allowapproval":{"post":{"tags":["Govern"],"summary":"Allow approval for an activity in an open release","description":"The authenticated activity owner or administrator can allow the activity approval after all the authors of activity finish their work.","operationId":"allowActivityApproval","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/activities/{activityId}/addauthor":{"post":{"tags":["Govern"],"summary":"Add an author to an activity in an open release","description":"The user matching the provided name is added to the list of authors.
This operation can be done by the activity owner or an administrator.","operationId":"addActivityAuthor","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"authorName","in":"query","description":"the name of the author to add","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/activities/{activityId}/addapprover":{"post":{"tags":["Govern"],"summary":"Add an approver to an activity in an open release","description":"The user matching the provided name is added to the list of approvers.
This operation can be done by the activity owner or an administrator","operationId":"addActivityApprover","parameters":[{"name":"activityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"approverName","in":"query","description":"the name of the approver to add","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/{id}/wipe":{"post":{"tags":["DBAdmin"],"summary":"Wipe element version content","description":"Wipe information from element versions to remove Personally Identifiable Information from history records. This operation cannot be rolled-back, use with care.","operationId":"wipe","parameters":[{"name":"id","in":"path","description":"The uuid of the element to process","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","description":"The version of the element to process. Should match format \\.\\. Cannot be used if minVersion or maxVersion is used. If version, minVersion and maxVersion are not specified, all versions are processed.","required":false,"schema":{"type":"string"}},{"name":"minVersion","in":"query","description":"The first version of the element to process. Should match format \\.\\. Cannot be used if version is used. If minVersion is not specified while maxVersion is specified, then minVersion defaults to first version of the element.","required":false,"schema":{"type":"string"}},{"name":"maxVersion","in":"query","description":"The last version of the element to process. Should match format \\.\\. Cannot be used if version is used. If maxVersion is not specified while minVersion is specified, then maxVersion defaults to last version of the element.","required":false,"schema":{"type":"string"}},{"name":"attribute","in":"query","description":"Name of attributes to wipe. Multiple values are supported. If this value is not specified, all supported attributes will be processed.","required":false,"schema":{"type":"array","enum":["brm.Definition.body","brm.ProjectElement.documentation","versionComment"],"items":{"type":"string","enum":["brm.Definition.body","brm.ProjectElement.documentation","versionComment"]}}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"Operation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WipeStatus"}}}},"500":{"description":"Could not execute operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/uploadmessagesfile":{"post":{"tags":["DBAdmin"],"summary":"Persist localized messages file","description":"Persist a localized message file along with its locale after model extension files are persisted.
Enables the correct display of labels from model extension files.","operationId":"uploadMessagesFile","parameters":[{"name":"locale","in":"query","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"messagesFile":{"type":"string","format":"binary"}},"required":["messagesFile"]}}}},"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/uploadextensionmodel":{"post":{"tags":["DBAdmin"],"summary":"Persist model extension files .brmx and .brdx","description":"It is mandatory to persist model extension files to the database,
after the model extension script is run.","operationId":"uploadExtensionModelFiles","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"extensionModelFile":{"type":"string","format":"binary"},"extensionDataFile":{"type":"string","format":"binary"}},"required":["extensionDataFile","extensionModelFile"]}}}},"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/execute":{"post":{"tags":["DBAdmin"],"summary":"Run SQL script","description":"The authenticated user must have the 'rtsInstaller' role to call this endpoint.
This method launches the specified SQL script file by using a data source.","operationId":"executeSQLScript","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"sqlScriptFile":{"type":"string","format":"binary","description":"SQL script file to run"}},"required":["sqlScriptFile"]}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/diagnostics/generate":{"post":{"tags":["DBAdmin"],"summary":"Launch DC database diagnostics generation","description":"Triggers diagnostics generation","operationId":"generate","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"Operation successful","content":{"*/*":{"schema":{"type":"object"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/createschema":{"post":{"tags":["DBAdmin"],"summary":"Generate an SQL script for model extensions","description":"Generate an SQL script from model extension files .brmx and .brdx to alter the schema.
Unless specified,the generated script keeps database data by default.","operationId":"generateExtensionModelScript","parameters":[{"name":"keepData","in":"query","description":"Boolean value (true or false) to indicate to keep existing data in schema.
Defaults to true with an empty value.","required":false,"allowEmptyValue":true,"schema":{"type":"boolean","default":true}},{"in":"query","$ref":"#/components/parameters/datasource"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"extensionModelFile":{"type":"string","format":"binary"},"extensionDataFile":{"type":"string","format":"binary"}},"required":["extensionDataFile","extensionModelFile"]}}}},"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/cleanup/stop":{"post":{"tags":["DBAdmin"],"summary":"Stop cleanup operation","description":"The operation is stopped without waiting for its completion ==> only part of the elements deletion have been executed.","operationId":"stopCleanup","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/cleanup/launch":{"post":{"tags":["DBAdmin"],"summary":"Launch cleanup of the repository","description":"Launch cleanup tool execution to remove old elements from the repository. Since old records will not be available any more after execution, it is recommended to make sure a backup policy is in place prior to using the tool. You must have the 'rtsAdministrator' role to perform this action.","operationId":"launchCleanup","parameters":[{"name":"cleanupDate","in":"query","description":"Date for which data should get deleted (format = yyyy-MMM-dd, with MMM = Jan/Feb/Mar/Apr/May/Jun/Jul/Aug/Sep/Oct/Nov/Dec). All versions older than this date are deleted if they are not the last version for this element.","required":true,"schema":{"type":"string"}},{"name":"dryRun","in":"query","description":"Set dryRun to true in order to generate cleanup report without deleting any record","required":false,"schema":{"type":"boolean","default":false}},{"name":"handleReports","in":"query","description":"Set handleReports to true in order to cleanup reports (deployment / Simulation / Test)","required":false,"schema":{"type":"boolean","default":false}},{"name":"recyclebinMode","in":"query","description":"Set recyclebinMode to true in order to drop only old records from recyclebin, by default all versions older than specified date are selected, including deletion versions referenced in the recyclebin","required":false,"schema":{"type":"boolean","default":false}},{"name":"eclassFQN","in":"query","description":"EClass FQN of specific type to handle, should be one of brm.RuleArtifact, brm.Ruleflow, brm.VariableSet, brm.RulePackage, brm.AbstractQuery, brm.Baseline, brm.BOM, brm.BOM2XOMMapping, brm.DecisionModel, brm.Vocabulary, brm.Template, brm.ScenarioSuite, brm.Resource, brm.EventElement, dsm.Deployment, dsm.Operation, dsm.DSDeploymentReport, validation.Metric, validation.KPI, validation.SimulationModel, validation.SimulationConfiguration, validation.SimulationReport, validation.InputData, validation.TestSuite, validation.TestReport, validation.TestCase","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"Operation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportBasicDescription"}}}},"500":{"description":"Could not launch operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/webhooks/notify":{"get":{"tags":["Manage"],"summary":"Get a list of the webhooks that are bound to this instance of Decision Center","description":"Returns a list of the webhooks bound to this instance of Decision Center.","operationId":"webhooks","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageWebhook"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/users":{"get":{"tags":["Admin"],"summary":"List of the users that are defined in Decision Center","operationId":"users","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageUser"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]},"delete":{"tags":["Admin"],"summary":"Remove all users","operationId":"eraseAllUsers","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/users/{userName}":{"get":{"tags":["Admin"],"summary":"Details of the user","operationId":"user","parameters":[{"name":"userName","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/User"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]},"delete":{"tags":["Admin"],"summary":"Remove a user","operationId":"deleteUser","parameters":[{"name":"userName","in":"path","description":"The name of the user","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/testsuites/{testSuiteId}":{"get":{"tags":["Explore"],"summary":"Details of the test suite","operationId":"testSuite","parameters":[{"name":"testSuiteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the target branch, activity, release, or createSnapshot. If none is specified, it defaults to the 'main' branch.","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TestSuite"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/testreports/{testReportId}":{"get":{"tags":["Explore"],"summary":"Details of the test report","operationId":"testReport","parameters":[{"name":"testReportId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TestReport"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]},"delete":{"tags":["Build"],"summary":"Delete a test report","operationId":"deleteTestReport","parameters":[{"name":"testReportId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/snapshots/{snapshotId}":{"get":{"tags":["Explore"],"summary":"Details of the snapshot","operationId":"snapshot_2","parameters":[{"name":"snapshotId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Snapshot"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]},"delete":{"tags":["Manage"],"summary":"Delete a snapshot from a decision service","operationId":"deleteSnapshot","parameters":[{"name":"snapshotId","in":"path","description":"ID of the snapshot to delete.","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/servers":{"get":{"tags":["Explore"],"summary":"List of the servers that are defined in Decision Center","operationId":"servers","parameters":[{"name":"q","in":"query","description":"A query to filter objects by their properties. Basic (boolean, number and strings) types only. For example: q=name:MyServer","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageServer"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/repository/metrics":{"get":{"tags":["Admin"],"summary":"Get repository metrics","operationId":"metrics","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Metrics"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/projects/{projectId}":{"get":{"tags":["Explore"],"summary":"Get the project with the ID","operationId":"project","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Project"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/projects/{projectId}/variablesets":{"get":{"tags":["Explore"],"summary":"List of variableSet in a project","operationId":"variablesets","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"branchId","in":"query","description":"The branch or release ID. If empty, take the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"useDependencies","in":"query","description":"Include project dependencies. If empty, include no dependencies.","required":false,"schema":{"type":"boolean","default":false}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageVariableSet"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/projects/{projectId}/technicalrules":{"get":{"tags":["Explore"],"summary":"List of technical rules in a project","operationId":"technicalrules","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"branchId","in":"query","description":"The branch or release ID. If empty, take the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"useDependencies","in":"query","description":"Include project dependencies. If empty, include no dependencies.","required":false,"schema":{"type":"boolean","default":false}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageTechnicalRule"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/projects/{projectId}/rules":{"get":{"tags":["Explore"],"summary":"List of rules in a project","operationId":"rules","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"branchId","in":"query","description":"The branch or release ID . If empty, take the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"folderId","in":"query","description":"The folder ID. If empty, take all the branch folders.","required":false,"schema":{"type":"string"}},{"name":"withContent","in":"query","description":"Provide the content of the rule. If empty, provide no details.","required":false,"schema":{"type":"boolean","default":false}},{"name":"useDependencies","in":"query","description":"Include project dependencies. If empty, include no dependencies.","required":false,"schema":{"type":"boolean","default":false}},{"name":"q","in":"query","description":"A query to filter objects by their properties. Basic (boolean, number and strings) types only. For example: q=name:MyProject","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageNamedObject"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/projects/{projectId}/ruleflows":{"get":{"tags":["Explore"],"summary":"List of ruleflows in a project","operationId":"ruleflows","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"branchId","in":"query","description":"The branch or release ID. If empty, take the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"withImage","in":"query","description":"Provide the image of the ruleflow. If empty, provide no image","required":false,"schema":{"type":"boolean","default":false}},{"name":"useDependencies","in":"query","description":"Include project dependencies. If empty, include no dependencies","required":false,"schema":{"type":"boolean","default":false}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageBaseRuleflow"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/projects/{projectId}/report":{"get":{"tags":["Explore"],"summary":"Generate a report for the project","operationId":"generateReport","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the target branch, activity, or release. If none is specified, it defaults to the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"includeDependencies","in":"query","description":"Include project dependencies. By default include dependencies.","required":false,"schema":{"type":"boolean","default":true}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/projects/{projectId}/queries":{"get":{"tags":["Explore"],"summary":"List of queries in a project","operationId":"queries","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"branchId","in":"query","description":"The branch or release ID. If empty, take the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"useDependencies","in":"query","description":"Include project dependencies. If empty, include no dependencies.","required":false,"schema":{"type":"boolean","default":false}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageQuery"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/projects/{projectId}/queries/{queryId}/run":{"get":{"tags":["Explore"],"summary":"List of elements returned by a query","operationId":"queryRun","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"queryId","in":"path","required":true,"schema":{"type":"string"}},{"name":"branchId","in":"query","description":"The branch or release ID. If empty, take the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageNamedObject"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/projects/{projectId}/queries/{queryId}/report":{"get":{"tags":["Explore"],"summary":"Generate a report with the elements returned by a query","operationId":"queryReport","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"queryId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"The branch or release ID. If empty, take the 'main' branch.","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/projects/{projectId}/operations":{"get":{"tags":["Explore"],"summary":"List of operations in a project","operationId":"operations","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"branchId","in":"query","description":"The branch or release ID . If empty, take the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"useDependencies","in":"query","description":"Include project dependencies. If empty, include no dependencies","required":false,"schema":{"type":"boolean","default":false}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageOperation"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/projects/{projectId}/functions":{"get":{"tags":["Explore"],"summary":"List of functions in a project","operationId":"functions","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"branchId","in":"query","description":"The branch or release ID . If empty, take the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"useDependencies","in":"query","description":"Include project dependencies. If empty, include no dependencies.","required":false,"schema":{"type":"boolean","default":false}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageFunction"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/projects/{projectId}/folders":{"get":{"tags":["Explore"],"summary":"List of folders of a project","operationId":"folders","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"branchId","in":"query","description":"The branch or release ID. If empty, take the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"useDependencies","in":"query","description":"Include project dependencies. If empty, include no dependencies.","required":false,"schema":{"type":"boolean","default":false}},{"name":"pae","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageRulePackage"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/permissions/tab/export":{"get":{"tags":["Admin"],"summary":"Export the tab permissions to JSON","operationId":"exportTabPermissions","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/permissions/export":{"get":{"tags":["Admin"],"summary":"Export the permissions that are defined for a group to JSON","operationId":"exportPermissions","parameters":[{"name":"group","in":"query","description":"Group for which you want the permissions.","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/permissions/effective":{"get":{"tags":["Admin"],"summary":"Retrieve the effective permissions for one or more groups to JSON","description":"The effective permissions are computed assuming the security is enforced.
The returned JSON contains the effective permissions for every available type and feature.
This endpoint can be used to find the internal name of a type or feature to write custom JSON-based permissions.","operationId":"effectivePermissions","parameters":[{"name":"groups","in":"query","description":"Comma-separated list of groups for which you want the effective permissions.","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/permissions/command/export":{"get":{"tags":["Admin"],"summary":"Export the command permissions to JSON","operationId":"exportCommandPermissions","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/groups":{"get":{"tags":["Admin"],"summary":"List of the groups that are defined in Decision Center","operationId":"groups","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageGroup"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]},"delete":{"tags":["Admin"],"summary":"Remove all groups","operationId":"eraseAllGroups","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/groups/{groupName}":{"get":{"tags":["Admin"],"summary":"Details of the group","operationId":"group","parameters":[{"name":"groupName","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Group"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]},"delete":{"tags":["Admin"],"summary":"Remove a group","operationId":"deleteGroup","parameters":[{"name":"groupName","in":"path","description":"The name of the group","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/dynamicdomains/{decisionServiceId}/list":{"get":{"tags":["Admin"],"summary":"Get the list of dynamic domains","operationId":"listDynamicDomains","parameters":[{"name":"decisionServiceId","in":"path","description":"ID of the decision service","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the branch. Defaults to the main branch.","required":false,"schema":{"type":"string"}},{"name":"listAll","in":"query","description":"True to return all dynamic domains, False to return only the ones that are not up to date","required":false,"schema":{"type":"boolean"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageDynamicDomain"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/deployments/{deploymentId}":{"get":{"tags":["Explore"],"summary":"Details of the deployment configuration","operationId":"deploymentConfiguration","parameters":[{"name":"deploymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the target branch, activity, release, or createSnapshot. If none is specified, it defaults to the 'main' branch.","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeploymentConfiguration"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/deployments/{deploymentId}/download":{"get":{"tags":["Build"],"summary":"Download the RuleApp archive for the deployment configuration","description":"If no deployment snapshot name is given, a deployment snapshot is created if the deployment configurationhas the 'snapshotMode' attribute set to 'Always'.
If a deployment snapshot name is provided, a deployment snapshot is created with that name if it does not already exist.
This deployment snapshot is then used as the basis for building the RuleApp archive.","operationId":"download","parameters":[{"name":"deploymentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the release, branch, or snapshot to work with. Defaults to the main branch.","required":false,"schema":{"type":"string"}},{"name":"deploymentSnapshotName","in":"query","description":"Name of the deployment snapshot to create or use","required":false,"schema":{"type":"string"}},{"name":"includeXOMInArchive","in":"query","description":"Includes the XOM in the archive when set to true.","required":false,"schema":{"type":"boolean"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/deploymentreports/{deploymentReportId}":{"get":{"tags":["Explore"],"summary":"Details of the deployment report","operationId":"DeploymentReport","parameters":[{"name":"deploymentReportId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeploymentResult"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices":{"get":{"tags":["Explore"],"summary":"Get the list of decision services","operationId":"decisionServices","parameters":[{"name":"q","in":"query","description":"A query to filter objects by their properties. Basic (boolean, number and strings) types only. For example: q=name:MyProject","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageDecisionService"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices/{decisionServiceId}":{"get":{"tags":["Explore"],"summary":"Get a decision service by its ID","operationId":"decisionService","parameters":[{"name":"decisionServiceId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DecisionService"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]},"delete":{"tags":["Admin"],"summary":"Delete a decision service","operationId":"deleteDecisionService","parameters":[{"name":"decisionServiceId","in":"path","description":"ID of the decision service to delete.","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices/{decisionServiceId}/testsuites":{"get":{"tags":["Explore"],"summary":"List of the test suites for the decision service","operationId":"testSuites","parameters":[{"name":"decisionServiceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the target branch, activity, or release. If none is specified, it defaults to the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","description":"A query to filter objects by their properties. Basic (boolean, number and strings) types only. For example: q=name:MyProject","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageTestSuite"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices/{decisionServiceId}/testreports":{"get":{"tags":["Explore"],"summary":"List of the test reports for the decision service","operationId":"testReports","parameters":[{"name":"decisionServiceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the target branch, activity, or release. If none is specified, it defaults to the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","description":"A query to filter objects by their properties. Basic (boolean, number and strings) types only. For example: q=status:COMPLETED","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageTestReport"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices/{decisionServiceId}/projects":{"get":{"tags":["Explore"],"summary":"List of the projects that form the decision service, and the decision service itself","operationId":"projects","parameters":[{"name":"decisionServiceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"q","in":"query","description":"A query to filter objects by their properties. Basic (boolean, number and strings) types only. For example: q=name:MyProject","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageProject"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices/{decisionServiceId}/export":{"get":{"tags":["Admin"],"summary":"Export a decision service to a compressed file","operationId":"decisionServiceExport","parameters":[{"name":"decisionServiceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the baseline (regular branch, release or snapshot) to export. Defaults to the main branch.","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices/{decisionServiceId}/deployments":{"get":{"tags":["Explore"],"summary":"List of the deployment configurations for the decision service","operationId":"deploymentConfigurations","parameters":[{"name":"decisionServiceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the target branch, activity, or release. If none is specified, it defaults to the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","description":"A query to filter objects by their properties. Basic (boolean, number and strings) types only. For example: q=name:MyProject","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageDeploymentConfiguration"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices/{decisionServiceId}/deploymentreports":{"get":{"tags":["Explore"],"summary":"List of the deployment reports for the decision service","operationId":"DeploymentReports","parameters":[{"name":"decisionServiceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the target branch, activity, or release. If none is specified, it defaults to the 'main' branch.","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","description":"A query to filter objects by their properties. Basic (boolean, number and strings) types only. For example: q=status:COMPLETED","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageDeploymentResult"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices/{decisionServiceId}/decisiontables/{decisionTableIds}/export":{"get":{"tags":["Manage"],"summary":"Export an Excel file from an existing decision table","operationId":"exportDT","parameters":[{"name":"decisionServiceId","in":"path","description":"ID of the decision service","required":true,"schema":{"type":"string"}},{"name":"baselineId","in":"query","description":"ID of the branch of the decision table. Defaults to the main branch.","required":false,"schema":{"type":"string"}},{"name":"decisionTableIds","in":"path","description":"Comma-separated list of decision tables IDs you want to export.","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/decisionservices/{decisionServiceId}/activities":{"get":{"tags":["Explore"],"summary":"List of the activities in the decision service","operationId":"activities","parameters":[{"name":"decisionServiceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"q","in":"query","description":"A query to filter objects by their properties. Basic (boolean, number and strings) types only. For example: q=name:MyProject","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Size of the page. If empty, all the elements are returned.","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageActivity"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/branches/{branchId}":{"get":{"tags":["Explore"],"summary":"Details of the branch","operationId":"branch","parameters":[{"name":"branchId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Branch"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]},"delete":{"tags":["Manage"],"summary":"Delete a branch from a decision service","operationId":"deleteBranch","parameters":[{"name":"branchId","in":"path","description":"ID of the branch to delete.","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/branches/{branchId}/securityInheritedFrom":{"get":{"tags":["Admin"],"summary":"Details of the branch from which the security configuration is inherited from","operationId":"branch_1","parameters":[{"name":"branchId","in":"path","description":"ID of the branch","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Branch"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/branches/{branchId}/groups":{"get":{"tags":["Admin"],"summary":"Comma-separated list of the groups that are set on a branch","operationId":"branchGroups","parameters":[{"name":"branchId","in":"path","description":"ID of the branch","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/about":{"get":{"tags":["About"],"summary":"Get system, product, and database information","operationId":"about","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/About"}}}}}}},"/v1/DBAdmin/status":{"get":{"tags":["DBAdmin"],"summary":"Get the run status of the SQL script","description":"Returns the status of the SQL script run for this data source.
The status might be SUCCESS or RUNNING, in which case the statement contains the running statement, or FAILURE, in which case the statement contains the failed statement and errorMsg the error message.
No authentication is needed to use this method because it does not have to connect to Decision Center.","operationId":"getExecutionStatus","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SQLScriptStatus"}}}}}}},"/v1/DBAdmin/modelextensionfiles":{"get":{"tags":["DBAdmin"],"summary":"Retrieve model extension files as file archive","description":"Get all current model extension related files in an archive: model extension, data extension and localized messages files
If no schema exists, all default files will be provided in the archive.","operationId":"getModelExtensionFiles","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/migrationrole":{"get":{"tags":["DBAdmin"],"summary":"Generate a migration role","description":"The authenticated user must have the 'rtsInstaller' role to call this endpoint.
This method generates an SQL script to set up database privileges to migrate 8.6 or later to the current release.","operationId":"generateMigrationRole","parameters":[{"name":"oldSchemaName","in":"query","description":"Name of database schema in which the Decision Center repository to migrate is available","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/migration":{"get":{"tags":["DBAdmin"],"summary":"Generate migration script","description":"The authenticated user must have the 'rtsInstaller' role to call this endpoint.
This method generates a migration script to migrate 8.6 or later to current release.","operationId":"generateMigrationScript","parameters":[{"name":"oldSchemaName","in":"query","description":"Name of the database schema in which the Decision Center repository to migrate is available","required":true,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/diagnostics/results":{"get":{"tags":["DBAdmin"],"summary":"Get DC database diagnostics results","description":"Retrieve the diagnostics results if available. Running diagnostics are returned with a dedicated status","operationId":"results","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"Operation successful","content":{"application/octet-stream":{}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/cleanup/status":{"get":{"tags":["DBAdmin"],"summary":"Check cleanup execution","description":"Returns status information with isRunning flag set to true if a cleanup operation is launched for this datasource.","operationId":"isCleanupRunning","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"Operation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CleanupStatus"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/cleanup/report":{"get":{"tags":["DBAdmin"],"summary":"Export report for last cleanup operation to JSON","description":"Get report on cleanup operation launched for this url and datasource. Partial report is returned if operation is not completed yet.","operationId":"cleanupReport","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"Operation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CleanupReport"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/DBAdmin/cleanup/oldreports":{"get":{"tags":["DBAdmin"],"summary":"Export old cleanup reports to JSON","description":"Get reports on cleanup operations launched for this url and datasource. Information about currently running operation or last run is available using /v1/DBAdmin/cleanup/report, whereas this endpoint will return a list of previous executions reports.","operationId":"cleanupOldReports","parameters":[{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"Operation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CleanupReports"}}}}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}},"/v1/build/discard.cache":{"delete":{"tags":["Manage"],"summary":"Discard all the built states of branches, releases, activities, and snapshots","description":"Discard all the built states for branches, releases, activities, and snapshots, namely in baselines. All baselines are rebuilt from scratch. If you provide a baselineId, only built states for this baseline are discarded.","operationId":"discardBuildState","parameters":[{"name":"baselineId","in":"query","description":"The ID of the branch, release, activity or snapshot to clean","required":false,"schema":{"type":"string"}},{"in":"query","$ref":"#/components/parameters/datasource"}],"responses":{"200":{"description":"OK"}},"security":[{"Authorization":["global"]},{"basic":["global"]}]}}},"components":{"schemas":{"About":{"type":"object","properties":{"datasourceName":{"type":"string"},"schemaVersion":{"type":"string"},"version":{"type":"string"},"patchLevel":{"type":"string"}}},"Activity":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"parentId":{"type":"string"},"documentation":{"type":"string"},"buildMode":{"type":"string","description":"Represents the type of a rule engine: classic rule engine or decision engine","enum":["DecisionEngine","ClassicEngine"]},"status":{"type":"string","enum":["InProgress","ReadyForApproval","Complete","Canceled","Rejected","Working","Finished","NotReviewed","ApprovedChanges","RejectedChanges"]},"owner":{"type":"string"},"targetDate":{"type":"string","format":"date-time"},"approvers":{"type":"array","items":{"$ref":"#/components/schemas/Contributor"}},"authors":{"type":"array","items":{"$ref":"#/components/schemas/Contributor"}},"kind":{"type":"string","enum":["Branch","Release","ChangeActivity","ValidationActivity","StandardSnapshot","DeploymentSnapshot"]}},"required":["name"]},"ActivityInput":{"type":"object","properties":{"name":{"type":"string"},"owner":{"type":"string"},"targetDate":{"type":"string","format":"date-time"},"documentation":{"type":"string"},"approversNames":{"type":"array","items":{"type":"string"}},"authorsNames":{"type":"array","items":{"type":"string"}}},"required":["name","owner","targetDate"]},"ApiError":{"description":"Error object returned by endpoints in the body of the response","properties":{"error":{"type":"string","description":"Summary or human readable code of the error"},"reason":{"type":"string","description":"Detailed description of the error"},"status":{"type":"string","description":"Http Status string. Eg: NOT_FOUND"},"ref":{"type":"string","description":"Internal reference of the error"},"errorCode":{"type":"string","description":"IBM error code (optional)"},"details":{"type":"array","description":"Technical details about the error.","items":{"type":"string","description":"Technical details about the error."}}}},"Artifacts":{"type":"object","properties":{"packages":{"type":"array","items":{"type":"string"}},"ruleArtifacts":{"type":"array","items":{"type":"string"}},"actionRules":{"type":"array","items":{"type":"string"}},"decisionTables":{"type":"array","items":{"type":"string"}},"ruleflows":{"type":"array","items":{"type":"string"}},"decisionTrees":{"type":"array","items":{"type":"string"}},"functions":{"type":"array","items":{"type":"string"}},"variableSets":{"type":"array","items":{"type":"string"}},"decisionModels":{"type":"array","items":{"type":"string"}},"templates":{"type":"array","items":{"type":"string"}},"resources":{"type":"array","items":{"type":"string"}},"vocabularies":{"type":"array","items":{"type":"string"}},"boms":{"type":"array","items":{"type":"string"}},"scenarioSuites":{"type":"array","items":{"type":"string"}},"queries":{"type":"array","items":{"type":"string"}},"operations":{"type":"array","items":{"type":"string"}},"deployments":{"type":"array","items":{"type":"string"}},"otherTypes":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"BaseRuleflow":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"project":{"type":"string"},"rulePackage":{"type":"string"},"documentation":{"type":"string"},"permaLink":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Property"}},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/RuleTask"}}},"required":["name"]},"BaselineInfo":{"type":"object","properties":{"name":{"type":"string"},"uuid":{"type":"string"},"id":{"type":"integer","format":"int32"},"typeFQN":{"type":"string"},"parentId":{"type":"integer","format":"int32"},"kind":{"type":"string"},"createdon":{"type":"string","format":"date-time"},"prjName":{"type":"string"}}},"Branch":{"type":"object","description":"A branch, also known as 'unmanaged' branch, as opposed to release or activities","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"parentId":{"type":"string"},"documentation":{"type":"string"},"buildMode":{"type":"string","description":"Represents the type of a rule engine: classic rule engine or decision engine","enum":["DecisionEngine","ClassicEngine"]},"main":{"type":"boolean","description":"Is this the 'main' branch of the Decision Service?"},"kind":{"type":"string","enum":["Branch","Release","ChangeActivity","ValidationActivity","StandardSnapshot","DeploymentSnapshot"]}},"required":["name"]},"BranchDetails":{"type":"object","properties":{"branchName":{"type":"string"},"artifacts":{"$ref":"#/components/schemas/Artifacts"}}},"BranchSummary":{"type":"object","properties":{"branchName":{"type":"string"},"lockCount":{"type":"integer","format":"int32"}}},"ChangeActivity":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"parentId":{"type":"string"},"documentation":{"type":"string"},"buildMode":{"type":"string","description":"Represents the type of a rule engine: classic rule engine or decision engine","enum":["DecisionEngine","ClassicEngine"]},"status":{"type":"string","enum":["InProgress","ReadyForApproval","Complete","Canceled","Rejected","Working","Finished","NotReviewed","ApprovedChanges","RejectedChanges"]},"owner":{"type":"string"},"targetDate":{"type":"string","format":"date-time"},"approvers":{"type":"array","items":{"$ref":"#/components/schemas/Contributor"}},"authors":{"type":"array","items":{"$ref":"#/components/schemas/Contributor"}},"kind":{"type":"string","enum":["Branch","Release","ChangeActivity","ValidationActivity","StandardSnapshot","DeploymentSnapshot"]}},"required":["name"]},"CleanupReport":{"type":"object","properties":{"datasourceName":{"type":"string"},"launchTimestamp":{"type":"string","format":"date-time"},"cleanupDate":{"type":"string","format":"date","example":"2020-Sep-01"},"completed":{"type":"boolean","default":"false"},"stopped":{"type":"boolean","default":"false"},"dryRun":{"type":"boolean","default":"false"},"handleReports":{"type":"boolean","default":"false"},"recyclebinMode":{"type":"boolean","default":"false"},"eclassFQN":{"type":"string"},"exceptions":{"type":"array","items":{"type":"string"}},"messages":{"type":"array","items":{"type":"string"}},"deletedBaselines":{"type":"array","items":{"$ref":"#/components/schemas/BaselineInfo"}},"deletedElt":{"type":"array","items":{"$ref":"#/components/schemas/OldEltInfo"}},"deletedVEltInfo":{"type":"array","items":{"$ref":"#/components/schemas/VEltInfo"}}}},"CleanupReports":{},"CleanupStatus":{"type":"object","properties":{"isRunning":{"type":"boolean"},"cleanupDate":{"type":"string","example":"2020-Sep-01"},"eclassFQN":{"type":"string"}}},"Contributor":{"type":"object","properties":{"name":{"type":"string"},"status":{"type":"string"},"fullname":{"type":"string"}}},"DecisionService":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"buildMode":{"type":"string","description":"Represents the type of a rule engine: classic rule engine or decision engine","enum":["DecisionEngine","ClassicEngine"]},"advancedProperties":{"type":"string"}},"required":["name"]},"DeploymentConfiguration":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"production":{"type":"boolean"},"description":{"type":"string"},"ruleAppName":{"type":"string"},"ruleAppVersion":{"type":"string"},"snapshotMode":{"type":"string","enum":["Always","Never","UserDefined"]}},"required":["name"]},"DeploymentMessage":{"type":"object","properties":{"message":{"type":"string"},"ruleArtifact":{"$ref":"#/components/schemas/RuleArtifact"},"severity":{"type":"string","enum":["DEBUG","INFO","WARNING","ERROR","SEMANTIC"]}}},"DeploymentResult":{"type":"object","description":"Result returned by a build or deploy operation","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"status":{"type":"string","enum":["STARTING","STARTED","STOPPING","STOPPED","FAILED","COMPLETED","ABORTED"]},"ruleAppName":{"type":"string","description":"The name of the ruleapp created by this deployment"},"messages":{"$ref":"#/components/schemas/PageDeploymentMessage"},"snapshot":{"$ref":"#/components/schemas/DeploymentSnapshot","description":"The deployment snapshot created or used for this build or deployment"},"servers":{"type":"array","description":"The list of servers this Decision Service was deployed to","items":{"type":"string"}},"archive":{"type":"string","description":"The base64 content of the RuleApp archive, if requested by the build or deploy command"}},"required":["name"]},"DeploymentSnapshot":{"type":"object","description":"A deployment snapshot is a set of project artifacts filtered by a deployment configuration","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"parentId":{"type":"string"},"documentation":{"type":"string"},"buildMode":{"type":"string","description":"Represents the type of a rule engine: classic rule engine or decision engine","enum":["DecisionEngine","ClassicEngine"]},"kind":{"type":"string","enum":["Branch","Release","ChangeActivity","ValidationActivity","StandardSnapshot","DeploymentSnapshot"]}},"required":["name"]},"Details":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/ProjectDetails"}}}},"DynamicDomain":{"type":"object","properties":{"domainValueProviderName":{"type":"string"},"bomClassFQN":{"type":"string"},"providerClassName":{"type":"string"},"providerResourceName":{"type":"string"},"projectName":{"type":"string"}}},"Function":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"definition":{"type":"string"},"project":{"type":"string"},"rulePackage":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Property"}},"documentation":{"type":"string"},"html":{"type":"string"}},"required":["name"]},"Group":{"type":"object","description":"The JSON representation of a group.","properties":{"name":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"securityProfile":{"type":"string"},"users":{"type":"array","items":{"type":"string"}}}},"Metrics":{"type":"object"},"NamedObject":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"}},"required":["name"]},"OldEltInfo":{"type":"object","properties":{"eltName":{"type":"string"},"eltId":{"type":"integer","format":"int32"},"typeFQN":{"type":"string"},"createdon":{"type":"string","format":"date-time"},"prjName":{"type":"string"}}},"Operation":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"documentation":{"type":"string"},"extractor":{"type":"string"},"extractorQuery":{"type":"string"},"extractorValidator":{"type":"string"},"rulesetName":{"type":"string"},"project":{"type":"string"},"permaLink":{"type":"string"},"ruleflow":{"$ref":"#/components/schemas/BaseRuleflow"},"referencedVariables":{"type":"array","items":{"$ref":"#/components/schemas/OperationVariable"}}},"required":["name"]},"OperationVariable":{"type":"object","properties":{"internalId":{"type":"string"},"name":{"type":"string"},"bomType":{"type":"string"},"type":{"type":"string"},"verbalization":{"type":"string"},"initialValue":{"type":"string"},"direction":{"type":"string"}},"required":["bomType","name"]},"PageActivity":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/Activity"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageBaseRuleflow":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/BaseRuleflow"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageBranch":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/Branch"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageDecisionService":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/DecisionService"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageDeploymentConfiguration":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/DeploymentConfiguration"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageDeploymentMessage":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/DeploymentMessage"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageDeploymentResult":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/DeploymentResult"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageDynamicDomain":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/DynamicDomain"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageFunction":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/Function"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageGroup":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/Group"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageNamedObject":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/NamedObject"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageOperation":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/Operation"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageProject":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/Project"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageQuery":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/Query"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageRelease":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/Release"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageRulePackage":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/RulePackage"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageServer":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/Server"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageServerExt":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/ServerExt"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageSnapshot":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/Snapshot"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageTechnicalRule":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/TechnicalRule"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageTestReport":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/TestReport"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageTestSuite":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/TestSuite"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageUser":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/User"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageVariableSet":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/VariableSet"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"PageWebhook":{"type":"object","properties":{"elements":{"type":"array","description":"The elements contained in the page","items":{"$ref":"#/components/schemas/Webhook"}},"totalCount":{"type":"integer","format":"int32","description":"Total elements count"},"number":{"type":"integer","format":"int32","description":"Current page number. Starts at 0."},"size":{"type":"integer","format":"int32","description":"Number of elements of the current page"}}},"Project":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"}},"required":["name"]},"ProjectDetails":{"type":"object","properties":{"projectName":{"type":"string"},"branches":{"type":"array","items":{"$ref":"#/components/schemas/BranchDetails"}}}},"ProjectSummary":{"type":"object","properties":{"projectName":{"type":"string"},"totalLocks":{"type":"integer","format":"int32"},"branches":{"type":"array","items":{"$ref":"#/components/schemas/BranchSummary"}}}},"Property":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"label":{"type":"string"}}},"Query":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"definition":{"type":"string"},"lastChangedBy":{"type":"string"},"html":{"type":"string"},"includeDependencies":{"type":"boolean"},"project":{"type":"string"}},"required":["name"]},"Release":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"parentId":{"type":"string"},"documentation":{"type":"string"},"buildMode":{"type":"string","description":"Represents the type of a rule engine: classic rule engine or decision engine","enum":["DecisionEngine","ClassicEngine"]},"status":{"type":"string","enum":["InProgress","ReadyForApproval","Complete","Canceled","Rejected","Working","Finished","NotReviewed","ApprovedChanges","RejectedChanges"]},"owner":{"type":"string"},"targetDate":{"type":"string","format":"date-time"},"approvers":{"type":"array","items":{"$ref":"#/components/schemas/Contributor"}},"initial":{"type":"boolean","description":"Is this release the initial one, corresponding to the creation of the Decision Service"},"kind":{"type":"string","enum":["Branch","Release","ChangeActivity","ValidationActivity","StandardSnapshot","DeploymentSnapshot"]}},"required":["name"]},"ReleaseInput":{"type":"object","properties":{"name":{"type":"string"},"owner":{"type":"string"},"targetDate":{"type":"string","format":"date-time"},"documentation":{"type":"string"},"approversNames":{"type":"array","items":{"type":"string"}},"parentId":{"type":"string"}},"required":["name","owner","targetDate"]},"ReportBasicDescription":{"type":"object","properties":{"datasourceName":{"type":"string","default":"jdbc/ilogDataSource"},"cleanupDate":{"type":"string","example":"2020-Sep-01"},"completed":{"type":"boolean","default":"false"},"stopped":{"type":"boolean","default":"false"},"dryRun":{"type":"boolean","default":"false"},"handleReports":{"type":"boolean","default":"false"},"recyclebinMode":{"type":"boolean","default":"false"}}},"RuleArtifact":{"type":"object","properties":{"path":{"type":"string"},"uuid":{"type":"string"}}},"RulePackage":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"parentId":{"type":"string"},"projectName":{"type":"string"},"path":{"type":"string"}},"required":["name"]},"RuleTask":{"type":"object","properties":{"name":{"type":"string"},"documentation":{"type":"string"},"finalActions":{"type":"string"},"initialActions":{"type":"string"},"exitCriteria":{"type":"string"},"body":{"type":"string"},"executionMode":{"type":"string"},"ordering":{"type":"string"}}},"SQLScriptStatus":{"type":"object","description":"Information on SQL script execution","properties":{"status":{"type":"string","description":"Execution status, one of RUNNING, SUCCESS, FAILURE","enum":["RUNNING","SUCCESS","FAILURE"]},"runningStatement":{"type":"string","description":"Running statment if any"},"errorMessage":{"type":"string","description":"Error message if any"},"runningStmt":{"type":"string","writeOnly":true},"errorMsg":{"type":"string","writeOnly":true}}},"Server":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string","description":"The name of the server"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"url":{"type":"string","description":"The URL of the server"},"description":{"type":"string","description":"The description of the server"},"loginServer":{"type":"string","description":"The name of the user allowed to access the server"},"loginPassword":{"type":"string","description":"The password of the user allowed to access the server"},"kind":{"type":"string","description":"The type of the server","enum":["RES, DECISION_RUNNER"]},"authenticationKind":{"type":"string","description":"The type of authentication used by the server","enum":["BASIC_AUTH, OAUTH"]},"authenticationProvider":{"type":"string","description":"The name of the authentication provider to use (for OAUTH authentication kind)"},"groups":{"type":"array","description":"A list of groups allowed to use this server. A list with the single element * means all groups are allowed to use this server","items":{"type":"string"}}},"required":["kind","name","url"]},"ServerExt":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string","description":"The name of the server"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"url":{"type":"string","description":"The URL of the server"},"description":{"type":"string","description":"The description of the server"},"loginServer":{"type":"string","description":"The name of the user allowed to access the server"},"loginPassword":{"type":"string","description":"The password of the user allowed to access the server"},"kind":{"type":"string","description":"The type of the server","enum":["RES, DECISION_RUNNER"]},"authenticationKind":{"type":"string","description":"The type of authentication used by the server","enum":["BASIC_AUTH, OAUTH"]},"authenticationProvider":{"type":"string","description":"The name of the authentication provider to use (for OAUTH authentication kind)"},"groups":{"type":"array","description":"A list of groups allowed to use this server. A list with the single element * means all groups are allowed to use this server","items":{"type":"string"}},"alternateURL":{"type":"string","description":"The URL of the server to present to users instead of the value of the property url.
If no URL is provided, the value of the property url is set."},"production":{"type":"boolean","description":"If true, the server is tagged for production.
The property is only consumed by Rule Designer where the production tag is set on servers.On Decision Center, the production tag is set on deployment configurations."},"builtIn":{"type":"boolean","description":"If true, the server was created based on a configuration file during the setup of Decision Center.
For servers created in Business console or with the dedicated REST API, the property is set to false"}},"required":["kind","name","url"]},"ServerPostInput":{"type":"object","description":"The JSON representation of a server with values to update","properties":{"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"url":{"type":"string","description":"The URL of the server"},"description":{"type":"string","description":"The description of the server"},"loginServer":{"type":"string","description":"The name of the user allowed to access the server"},"loginPassword":{"type":"string","description":"The password of the user allowed to access the server"},"authenticationKind":{"type":"string","description":"The type of authentication used by the server","enum":["BASIC_AUTH, OAUTH"]},"authenticationProvider":{"type":"string","description":"The name of the authentication provider to use (for OAUTH authentication kind)"},"groups":{"type":"array","description":"A list of groups allowed to use this server. A list with the single element * means all groups are allowed to use this server","items":{"type":"string"}}}},"ServerPutInput":{"type":"object","description":"The JSON representation of a server","properties":{"name":{"type":"string","description":"The name of the server"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"url":{"type":"string","description":"The URL of the server"},"description":{"type":"string","description":"The description of the server"},"loginServer":{"type":"string","description":"The name of the user allowed to access the server"},"loginPassword":{"type":"string","description":"The password of the user allowed to access the server"},"kind":{"type":"string","description":"The type of the server","enum":["RES, DECISION_RUNNER"]},"authenticationKind":{"type":"string","description":"The type of authentication used by the server","enum":["BASIC_AUTH, OAUTH"]},"authenticationProvider":{"type":"string","description":"The name of the authentication provider to use (for OAUTH authentication kind)"},"groups":{"type":"array","description":"A list of groups allowed to use this server. A list with the single element * means all groups are allowed to use this server","items":{"type":"string"}}},"required":["kind","name","url"]},"Snapshot":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"parentId":{"type":"string"},"documentation":{"type":"string"},"buildMode":{"type":"string","description":"Represents the type of a rule engine: classic rule engine or decision engine","enum":["DecisionEngine","ClassicEngine"]},"kind":{"type":"string","enum":["Branch","Release","ChangeActivity","ValidationActivity","StandardSnapshot","DeploymentSnapshot"]}},"required":["name"]},"StandardSnapshot":{"type":"object","description":"A 'standard' snapshot reflects the state of a Decision Service at a given point in time","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"parentId":{"type":"string"},"documentation":{"type":"string"},"buildMode":{"type":"string","description":"Represents the type of a rule engine: classic rule engine or decision engine","enum":["DecisionEngine","ClassicEngine"]},"initial":{"type":"boolean"},"kind":{"type":"string","enum":["Branch","Release","ChangeActivity","ValidationActivity","StandardSnapshot","DeploymentSnapshot"]}},"required":["name"]},"Summary":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/ProjectSummary"}}}},"TechnicalRule":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"definition":{"type":"string"},"project":{"type":"string"},"rulePackage":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Property"}},"documentation":{"type":"string"},"html":{"type":"string"}},"required":["name"]},"TestReport":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"scenarios":{"type":"integer","format":"int32","description":"The number of scenarios in the test report"},"executed":{"type":"integer","format":"int32","description":"The number of executed test in the test report, -1 means no test was executed"},"failures":{"type":"integer","format":"int32","description":"The number of failures in the test report"},"errors":{"type":"integer","format":"int32","description":"The number of errors in the test report"},"status":{"type":"string","description":"The status of the test report","enum":["STARTING","STARTED","STOPPING","STOPPED","FAILED","COMPLETED","ABORTED"]},"errorMessage":{"type":"string","description":"The error reason of the test report"}},"required":["errorMessage","errors","executed","failures","name","scenarios","status"]},"TestSuite":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"}},"required":["name"]},"UnlockArtifactsResponse":{"type":"object","properties":{"lockOwner":{"type":"string"},"totalLockedArtifacts":{"type":"integer","format":"int32"},"dryRun":{"type":"boolean"},"durationMs":{"type":"integer","format":"int64"},"summary":{"$ref":"#/components/schemas/Summary"},"details":{"$ref":"#/components/schemas/Details"}}},"UpdateReleaseInput":{"type":"object","properties":{"name":{"type":"string"},"owner":{"type":"string"},"targetDate":{"type":"string","format":"date-time"},"documentation":{"type":"string"},"approversNames":{"type":"array","items":{"type":"string"}}},"required":["name","owner","targetDate"]},"User":{"type":"object","description":"The JSON representation of a user","properties":{"name":{"type":"string"},"displayName":{"type":"string"},"email":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}}}},"VEltInfo":{"type":"object","properties":{"versionId":{"type":"integer","format":"int32"},"versDate":{"type":"string","format":"date-time"},"major":{"type":"integer","format":"int32"},"minor":{"type":"integer","format":"int32"},"isDeletionVers":{"type":"boolean","default":"false"},"uuid":{"type":"string"},"eltOId":{"type":"integer","format":"int32"},"eltId":{"type":"integer","format":"int32"},"typeFQN":{"type":"string"},"eltName":{"type":"string"},"prjId":{"type":"integer","format":"int32"},"projectName":{"type":"string"},"branchId":{"type":"integer","format":"int32"},"branchName":{"type":"string"}}},"ValidationActivity":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"parentId":{"type":"string"},"documentation":{"type":"string"},"buildMode":{"type":"string","description":"Represents the type of a rule engine: classic rule engine or decision engine","enum":["DecisionEngine","ClassicEngine"]},"status":{"type":"string","enum":["InProgress","ReadyForApproval","Complete","Canceled","Rejected","Working","Finished","NotReviewed","ApprovedChanges","RejectedChanges"]},"owner":{"type":"string"},"targetDate":{"type":"string","format":"date-time"},"approvers":{"type":"array","items":{"$ref":"#/components/schemas/Contributor"}},"authors":{"type":"array","items":{"$ref":"#/components/schemas/Contributor"}},"kind":{"type":"string","enum":["Branch","Release","ChangeActivity","ValidationActivity","StandardSnapshot","DeploymentSnapshot"]}},"required":["name"]},"Variable":{"type":"object","properties":{"internalId":{"type":"string"},"name":{"type":"string"},"bomType":{"type":"string"},"type":{"type":"string"},"verbalization":{"type":"string"},"initialValue":{"type":"string"}},"required":["bomType","name"]},"VariableSet":{"type":"object","properties":{"id":{"type":"string"},"internalId":{"type":"string"},"name":{"type":"string"},"createdBy":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"lastchangedBy":{"type":"string"},"lastChangedOn":{"type":"string","format":"date-time"},"lastVersionComment":{"type":"string"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/Variable"}},"rulePackage":{"type":"string"},"project":{"type":"string"}},"required":["name"]},"Webhook":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"authToken":{"type":"string"}}},"WipeStatus":{"type":"object","properties":{"status":{"type":"string"}}}},"parameters":{"datasource":{"name":"datasource","in":"query","description":"The JNDI name of the Decision Center data source. If not specified, it defaults to jdbc/ilogDataSource","required":false,"allowEmptyValue":false,"schema":{}}},"securitySchemes":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header"},"basic":{"type":"http","scheme":"basic"}}}}