REST AddModify
By using the REST AddModify (Record) activity, you can add, modify, or lookup a record. If the record does not exist, a new record is created. If the record exists, the existing record is updated.
Field | Module Property? | Description |
---|---|---|
Name | No | The name to be displayed as the label for the activity in the process.
The default value is RESTAddModify. |
MDM Connection | Yes | The MDM connection resource establishes a connection to an 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: 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 at
TIBCO_HOME\studio\version\eclipse.
|
Record State | Yes | The state in which you want to save the record. The default record state is
Unconfirmed. See also,
Record Lookup.
|
Command Qualifier | Yes | The default command qualifier is
Validate/Process.
Note: When
Record State is set to
Draft, only
Validate/Process and
NoValidate/Process are available.
|
File Type Attributes | Yes | Specify how to upload a file with file type attributes. This field is available when any attribute defined in the selected repository model is a file type attribute. By default, the attribute is
ATTACHMENT.
Note: Currently, only the ATTACHMENT attribute is supported.
|
Add/Modify Mode | Yes | Select the mode. The default option is
Add Modify.
|
Description
Provide a short description for the activity.
Input
The following is the input for the activity. The input parameter varies based on the selected Search Type.
Input Item | Description |
---|---|
Context | The standard context variables which are supported for add and modify operations. Refer to General Input for MDM Activities. To modify records in a work item context, provide a context variable WORKITEMREFERENCE and the associated work item ID. You should have the permission Edit when a record is in workflow. |
Record |
The RecordLookup section is for collecting the information needed for looking up a record in TIBCO® MDM. You can look up a record by the internal MDM key or an external lookup identifier.
|
Request Parameters | If you have specific custom parameters, specify the custom request parameters. For information on the request parameters, 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. The response displays the record bundle hierarchy as well as the JSON payload.
Output Item | Description |
---|---|
Result | The execution result to indicate whether the execution has succeeded or not.
This node contains the following three elements:
|
Records | |
Repository Name | Name of the repository. |
ProductID | An ID of the record. |
ProductIDExt | Record ID extension. Optionally, used to identify a record. |
ResponseAttributes | Contains the repository attribute names and their values. Also, contains errors, warnings, or informational messages. This element has one or more entries. |
Relationships | Contains the following relationship information:
|
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.