REST Delete
By using the REST Delete (Record) activity, you can delete records when the records exist, and when the latest version of the records is not in any workflow. You can delete all related records along with the parent record. The records are deleted by using only
PRODUCTID
as well as both
PRODUCTID
and
PRODUCTIDEXTENSION
. Use the command qualifier
RelationshipTargets to delete a single child record added to a relationship at that level.
Limitation
You can delete only a single related record of the specified relationship for the command qualifier RelationshipTargets. Deletion of multiple-level related records is not supported.
General
The General tab contains the following fields:
Field | Module Property? | Description |
---|---|---|
Name | No | The name to be displayed as the label for the activity in the process.
The default value is RESTDelete. |
MDM Connection | Yes | The MDM connection resource establishes a connection to a TIBCO® MDM server, allowing the plug-in to communicate with TIBCO® MDM.
Click
If no matching MDM connections are found, click Create Shared Resource to create one. |
HTTP Client | Yes | Select the HTTP client which supports the HTTP and REST services, allowing the plug-in to communicate with TIBCO® MDM.
Click
If no matching HTTP client is found, click Create Shared Resource to create one. Note: An HTTP client must be created with the default values on all fields and properties. The
Default Host must be the host IP address and the
Default Port port number of the TIBCO® MDM server.
|
Execution Mode | Yes | The default execution mode is
SYNCHR .
|
Repository | Yes | The name of the repository where records are stored.
Click
Note: When the selected repository model is complex and involves many related repositories, increase the value of the
-Xms and
-Xmx parameters in the
TIBCOBusinessStudio.ini file which is located in the
TIBCO_HOME\studio\version\eclipse directory.
|
Command Qualifier | No | The default command qualifier is
Record.
|
Delete All Related Records | Select this check box to delete all related records of a specified record along with the parent record.
Note: This check box is available only if you have selected
Record from the
Command Qualifier drop-down list.
|
Description
Provide a short description for the activity.
Input
The following is the input for the activity.
Input Item | Description | |
---|---|---|
Context | For the standard context variables, which are supported for delete operations, refer to General Input for MDM Activities. | |
Record | Includes repository, its attributes, and relationship information.
|
|
Repository | ||
Request Parameters | If you have specific custom parameters, specify those in the custom request parameter fields. For more information on the request parameters by REST service, refer to TIBCO® MDM Web Services Guide and TIBCO® MDM REST Swagger Online Help. | |
Message Headers | If you have specific custom headers, specify those in the custom header fields. For information on the headers accepted by REST service, refer to TIBCO® MDM Web Services Guide and TIBCO® MDM REST Swagger Online Help. |
Output
The following is the output for the activity.
Output Item | Description |
---|---|
Result | The execution result to indicate whether the execution has succeeded or not.
This node contains the following three elements:
|
Records | The Records are displayed only in case of validation errors. Detailed information of the repository:
|
ResponseAsJSON | It is data-type is String |
Success | A Boolean for success. true or false. The result of a record to indicate if the command has succeeded or not. |
Fault
The server and client errors which result in activity exceptions are displayed in the Fault tab.