TIBCO® MDM Rest Services Guide

TIBCO® MDMRest Services GuideSoftware Release 9.1August 2017

Two-Second Advantage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (ORPROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

This document contains confidential information that is subject to U.S. and international copyright lawsand treaties. No part of this document may be reproduced in any form without the writtenauthorization of TIBCO Software Inc.

TIBCO and Two-Second Advantage are either registered trademarks or trademarks of TIBCO SoftwareInc. in the United States and/or other countries.

Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform EnterpriseEdition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks ofOracle Corporation in the U.S. and other countries.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOTALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASEDAT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWAREVERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

Copyright © 2010-2017 TIBCO Software Inc. All rights reserved.

TIBCO Software Inc. Confidential Information

2

TIBCO® MDM Rest Services Guide

Contents

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Endpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Request Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Password Encryption and Decryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Encrypting the Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Decrypting the Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

REST Services Available in TIBCO MDM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

Login Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Logout Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Session Refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Get User Profile Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Add a New Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Add Record with Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Add a Related Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Modify a Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

Modify Record with Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Modify a Related Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Compare a Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Delete a Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Delete a Related Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Search a Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Supported Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57

Text Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Retrieve Records from a Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Retrieve Records by ID and IDEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Retrieve Related Records by Parent Record ID and ID Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115

Golden Record Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Search Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .121

Create Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

3


Drop Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Add External Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Update Value of Custom Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133

Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

4


TIBCO Documentation and Support Services

Documentation for this and other TIBCO products is available on the TIBCO Documentation site. Thissite is updated more frequently than any documentation that might be included with the product. Toensure that you are accessing the latest available help topics, visit:

https://docs.tibco.com

Product-Specific Documentation

Documentation for TIBCO products is not bundled with the software. Instead, it is available on theTIBCO Documentation site. To directly access the documentation for this product, double-click thefollowing file: TIBCO_HOME/release_notes/TIB_mdm_version_docinfo.html

where TIBCO_HOME is the top-level directory in which TIBCO products are installed. On Windows,the default TIBCO_HOME is C:\tibco. On UNIX systems, the default TIBCO_HOME is /opt/tibco.

The following documents for this product can be found on the TIBCO Documentation site:

● TIBCO MDM Release Notes

● TIBCO MDM Installation and Configuration Guide

● TIBCO MDM User’s Guide

● TIBCO MDM System Administration

● TIBCO MDM Customization Guide

● TIBCO MDM Workflow Reference

● TIBCO MDM Web Services Guide

● TIBCO MDM API Reference

● TIBCO MDM Best Practices Guide

● TIBCO MDM Performance Tuning Guide

● TIBCO MDM Rest Services Guide

● TIBCO MDM REST Swagger Reference

How to Contact TIBCO Support

For comments or problems with this manual or the software it addresses, contact TIBCO Support:

● For an overview of TIBCO Support, and information about getting started with TIBCO Support,visit this site:

http://www.tibco.com/services/support

● If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a user name and password. If you do not have a user name, you canrequest one.

How to Join TIBCO Community

TIBCO Community is an online destination for TIBCO customers, partners, and resident experts. It is aplace to share and access the collective experience of the TIBCO community. TIBCO Community offersforums, blogs, and access to a variety of resources. To register, go to the following web address:

https://community.tibco.com

5


https://docs.tibco.com

http://www.tibco.com/services/support

https://support.tibco.com

https://community.tibco.com

Overview

REST stands for Representational State Transfer. REST relies on a stateless, client-server, cache-ablecommunications protocol and in virtually all cases, the HTTP protocol is used.

REST is an architecture style for designing network applications. Rather than using complexmechanisms, such as SOAP to connect between machines, simple HTTP is used to make calls betweenmachines.

RESTful applications use the HTTP requests to post data (create and/or update), read data (for example,make queries), and delete data. Thus, REST uses HTTP for all four CRUD (Create/Read/Update/Delete)operations. REST is a lightweight alternative to mechanisms, such as RPC (Remote Procedure Calls)and web services (SOAP, WSDL, and so on). Despite being simple, REST is fully-featured; there isnothing you can do in web services that cannot be done with a RESTful architecture.

MethodsThe various methods of REST services are as follows:

● : provides a read only access to a resource.

● : creates a new resource.

EndpointThis default URL format for the endpoint is:

MachineName:port/eml/rest/

For example, localhost:8080/eml/rest/

ResourceIn any RESTful service, structure your resources by their hierarchy. These resources are specified in thehierarchical part of the URL. All hierarchical parts are required and unique. None of them can beomitted, and all of them can appear only once. Certain parts of the URL are fixed (such as, the servername, port, and endpoint), and certain parts are parametrized. The parametrized parts are oftendenoted in code and documentation by curly braces.

Consider, a web service for a record. The data might be organized into a repository, which containrecords, attributes, and relationships. The resource URL for the web service is as follows: http://localhost:9393/eml/rest/records/{repositoryName}/{id}

Sending a POST request to this URL might add a new record in a repository, while sending a GETrequest to this URL might retrieve the details of a particular record ID.

HeaderREST call headers are the HTTP headers, a required component of the message. The headers define theoperating parameters of the transaction.

6


Header FieldName Description Example

Authorization Authentication credentials forHTTP authentication.

Basic username:password:EnterpriseName

userName:Password:EnterpriseName shouldbe encoded in the Base64 format in theAuthorization parameter . Forexample,john:john:Company is encoded in theBase64 format as am9objpqb2huOkNvbXBhbnk=You can encrypt the password string for securitypurpose. For details refer Password Encryptionand Decryption

For WebLogic application server, the headerrequest must be sent without the Basic in theAuthorization field. For example,username:password:EnterpriseName

Content-Type The content type shouldcontain a JSON formattedtext.

application/json

apiVersion Specifies the API version to beused.

2.0

ParametersREST parameters specify the variable parts of your resources: the data that you are working with. In aREST request, the resource that you are working with is specified in the URL - Uniform ResourceLocator.

Request BodyIn the request, send the data as a JSON object.

7


Password Encryption and Decryption

The Password input is required in all REST services. You can encrypt any text password using thepasswordEncryptDecryptTool.sh or passwordEncryptDecryptTool.bat tool located in $MQ_HOME/bin.

Prerequisite

Ensure that all environment variables used in TIBCO MDM are set properly before executing the script,such as MQ_HOME, MQ_COMMON_DIR, MQ_CONFIG_FILE, NODE_ID, WAS_HOME, JBOSS_HOME, and so on.

The scripts accept a text string and return an encrypted string value or accept an already encryptedstring value and return a text value. You can generate an encrypted string using the tool and then use itin the REST service request.

Encryption and decryption tool is also supported through a Java API so that it can be embedded.

Usage is as follows:

● For encryption:import com.tibco.mdm.infrastructure.encryption.EncrypterDecryptorUtil;......EncrypterDecryptorUtil cipher = EncrypterDecryptorUtil.getCipher();cipher.encrypt(<pwdStringInPlainText>);

● For decryption:import com.tibco.mdm.infrastructure.encryption.EncrypterDecryptorUtil;......EncrypterDecryptorUtil cipher = EncrypterDecryptorUtil.getCipher();cipger.decrypt(<EncryptedPwdValue>);

Encrypting the Password

Procedure

1. Go to the command prompt; go to the $MQ_HOME/bin folder.

2. Type passwordEncryptDecryptTool.bat "password" and press ENTER. For example, D:\work\venus_dest\bin>passwordEncryptDecryptTool.bat "tibco123"

8


The utility provides information about the accessed property file and loaded properties, and thendisplays the encrypted password. For example, the encrypted password for tibco123 iscfMrxokzKTm3zJJLpDW7Jg==.

Decrypting the PasswordUse the similar encryption procedure to decrypt the password.

Procedure

● Place the encrypted string in the command prompt instead of the text password. For example,$MQ_HOME/bin>passwordEncryptDecryptTool.bat "cfMrxokzKTm3zJJLpDW7Jg==".After entering the encrypted string as an input, the utility returns the original decrypted password.In this case, tibco123.

You must specify the double quotation marks ('') for the text password or an encryptedpassword, else the utility does not perform encryption or decryption.

9


REST Services Available in TIBCO MDM

In TIBCO MDM, REST services are available for the activities listed in the table.

The REST services sample project is available in $MQ_HOME\schema\RestService and the RESTSwagger docs on https://docs.tibco.com/products/tibco-mdm.

REST Services Available in TIBCO MDM

REST ServiceType Service Description

DetailsAvailable

Login Login Use to get the login user information. LoginServices

Logout Use to get the logout information. LogoutServices

Session Refresh Use to refresh the session. SessionRefresh

User Info forEnterprise

Use to get the details whether the useris currently logged in or not to theenterprise.

Get UserProfile

Records Add a record Use to add a record. Add aRecord

Add Record withUpload

Use to add a record with file upload. Add Recordwith Upload

Modify a record Use to modify a record. Modify aRecord

Modify Recordwith Upload

Use to modify a record with file upload. ModifyRecord withUpload

Records Delete a record Use to delete a record. Delete aRecord

Search a record Use to search a record. Search aRecord

Add a relatedrecord

Use to add a related record. Add aRelatedRecord

Modify a relatedrecord

Use to modify a related record. Modify aRelatedRecord

Compare a Record Use to compare a record with itsconfirmed version.

Compare aRecord

10


https://docs.tibco.com/products/tibco-mdm

REST ServiceType Service Description

DetailsAvailable

Delete a relatedrecord

Use to delete a related record. Delete aRelatedRecord

Text Search Use to search for human recognizableterms similar to web search engines.

Text Search

Retrieve records ofa repository

Use to retrieve records from arepository.

Retrieve aRecord froma Repository

Retrieve record byID and IDEXT

Use to retrieve a record by theirproduct ID and ID extension.

Retrieve aRecord byRecord IDand IDExtension

Retrieve relatedrecords by parentrecord Id and IdExtension

Use to retrieve related records by theirproduct ID and ID extension.

Retrieve aRelatedRecord byRecord IDand IDExtension

Golden RecordCache

Search Records Search records in fast cache. SearchRecords

Create Index Create cache index at run time whenfast cache has been defined and started.

Create Index

Drop Index Delete a cache index at run time whenfast cache is defined and started.

Drop Index

Add ExternalAttribute

Create user-defined external attributesat run time when fast cache is definedand running.

Add ExternalAttribute

Update Value ofCustom Attribute

Update the value of user-definedattributes at run time when fast cache isdefined and running.

UpdateValue ofCustomAttribute

11


Login

The Login REST service contains the information on how to implement the login related functionality.

The various login related services are as follows:

● Login

● Logout

● Session Refresh

● Get User Profile Service

Login ServiceThe various details of the Login REST services are explained in this section. You must specify theusername, password, and enterprise name as a request JSON body. You can send the parameters eitherin the request body or as a query parameter. If both the parameters are specified, the body parametersare used to login.

HTTPMethod

EndpointURL

See Endpoint

Resource /login/userinfo

RequestParameters

Specify the following parameters:

Name Description Type Data Type

Required

username Name of the user query string

password password query string

enterprise Name of theenterprise

query string

Either request body or query parameters are required. If both arespecified, the body parameters are used.

Media Type application/json

RequestModel

{ "username": "string", "password": "string", "enterprise": "string"}

12


ResponseModel

{ "sessionId": "string", "errorCode": "string", "errorMessage": "string", "result": { "severity": "string", "code": "string", "description": { "lang": "string", "message": "string" } }}

RequestExample

A username is 14305_1 and password is xyr62dwUuk4= is the enterprise named"Company":{ "username":"14305_1", "password":"xyr62dwUuk4=", "enterprise":"Company"}

ResponseExample

The response returns the message that the login was successfully.{"sessionId": "gHVYMHNScidvq2SPevK8+GRp.undefined","errorCode": "","errorMessage": "","result": {"severity": "Info","code": "SVC-11219","description": {"lang": "English","message": "Login successful." } }}

SuccessResponse

Example:

Code: 200 successful operation

ErrorResponse

If the response is unsuccessful, either of the following error code is displayed:

Example:

Code: 400 Parameters required are missing

OR

Code: 404 User not found

OR

Code: 500 Internal error occurred

For error code response, see Error Handling .

Logout ServiceThe various details of the logout REST services are explained in this section. You must set the cookie inheader to logout.

HTTPMethod

13


EndpointURL

See Endpoint

Resource /login/userinfo/logout


RequestModel

Cookie: JSESSIONID=MfDshWaTXBoHtCcsoyaRQYOz;

ResponseModel

{ "errorCode": "string", "errorMessage": "string", "result": { "severity": "string", "code": "string", "description": { "lang": "string", "message": "string" } }}

RequestExample

Consider the following example for logout having cookieJSESSIONID=MfDshWaTXBoHtCcsoyaRQYOz.Cookie: JSESSIONID=MfDshWaTXBoHtCcsoyaRQYOz;

ResponseExample

The response returns the message that the user logged out successfully.{ "errorCode": "", "errorMessage": "", "result": { "severity": "Info", "code": "SVC-11222", "description": { "lang": "English", "message": "User logged out successfully" } }}

SuccessResponse

Example:


ErrorResponse


Example:


OR


OR



14


Session RefreshThe various details of the session refresh REST services are explained in this section. You must set thecookie in header to refresh session.

HTTPMethod

EndpointURL

See Endpoint

Resource /login/userinfo/sessionrefresh


RequestModel

Cookie: JSESSIONID=No3sfvH6doYk-4VLWBcbyI95;

ResponseModel


RequestExample

Consider the following example where the session having cookieJSESSIONID=MfDshWaTXBoHtCcsoyaRQYOz is refreshed or not in the repositorynamed "Company". .Cookie: JSESSIONID=MfDshWaTXBoHtCcsoyaRQYOz;

ResponseExample

The response returns the message that the session was refreshed successfully.{ "sessionId": "C8pYEK6AjOwptp0pftaEoXUo", "errorCode": "", "errorMessage": "", "result": { "severity": "Info", "code": "SVC-11341", "description": { "lang": "English", "message": "Your session refreshed successfully." } }}

SuccessResponse

Example:


15


ErrorResponse


Example:


OR


OR



Get User Profile ServiceThe various details whether the user is currently logged in or not to the enterprise is explained in thissection. You must set the cookie in header to get session details.

HTTPMethod

EndpointURL

See Endpoint

Resource /login/userinfo/{enterprise}

RequestParameters



Required

enterprise Name of theenterprise

path string


RequestModel

Cookie: JSESSIONID=MfDshWaTXBoHtCcsoyaRQYOz;

ResponseModel


16


RequestExample

Consider the following example where user with cookieJSESSIONID=MfDshWaTXBoHtCcsoyaRQYOz is currently logged in or not to therepository named "Company".Cookie: JSESSIONID=MfDshWaTXBoHtCcsoyaRQYOz;

ResponseExample

The response returns the message that the user is a invalid user.{ "sessionId": "7tJ0RRsdFO3sXGRrQCsHW-rY.undefined", "errorCode": "", "errorMessage": "", "result": { "severity": "Info", "code": "SVC-11344", "description": { "lang": "English", "message": "Valid User" } }}

SuccessResponse

Example:


ErrorResponse


Example:


OR


OR



17


Records

This REST services contain all the information regarding the Record operations in TIBCO MDM.

The Record operations are as follows:

● Add a New Record

● Add Record with Upload

● Modify a Record

● Modify Record with Upload

● Delete a Record

● Search a Record

● Add a Related Record

● Modify a Related Record

● Compare a Record

● Delete a Related Record

● Text Search

● Retrieve Records from a Repository

● Retrieve Records by ID and EXT

● Retrieve Related Records by Parent Record ID and ID Extension

Set the entity command qualifier to any of the following command type:

● Validate/Process: causes the records to be validated before saving. This also initiates New RecordIntroduction Edit (NRIE) workflows. This is the default.

● Validate/NoProcess: validates records and saves them without starting the NRIE workflows.

● NoValidate/Process: does not validate records, but saves them, and also starts NRIE workflows.

● NoValidate/NoProcess: does not validate records or start the workflow, but saves them.

Example on how to use the Validate and Process Record Add request in JSON.{ "process" : true, "validate": true, "record": { "repositoryName": "ALLRULEA", "productIdExt": "15853", "productId": "15853", "attributes": [ { "name": "ATA_STRING1", "value": "demo" }, { "name": "ATA_INTEGER1", "value": "1" } ] }}

18


Add a New RecordThe various details of how to add a new record is explained in this section.

HTTPMethod

EndpointURL

See Endpoint

Resource /records/{repositoryName}/addRecord

RequestParameters



Required

repository

Name

Name of therepository.

path string

Optional

perspectiv

eName

Name of theperspective.

query string


19


RequestModel

{ "process": false, "validate": false, "perspectiveName": "string", "record": { "productId": "string", "productIdExt": "string", "productKeyId": "string", "attributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "repositoryName": "string", "relationships": { "relationshipAttributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "targetRecord": {} }, "deleted": false }}

20


ResponseModel

{ "responseMessages": [ { "code": "string", "message": "string", "type": "string" } ], "records": [ { "repositoryName": "string", "productId": "string", "productIdExt": "string", "productKeyId": "string", "responseAttributes": [ { "attributeName": "string", "attributeDisplayName": "string", "values": [ "string" ], "errorCode": "string", "errorMessage": "string", "errorType": "string" } ], "responseRelationships": [ { "relationshipName": "string", "sourceRepositoryName": "string", "targetRepositoryName": "string", "recordId": "string", "recordIdExt": "string", "productKeyId": "string", "responseAttributes": [ { "attributeName": "string", "attributeDisplayName": "string", "values": [ "string" ], "errorCode": "string", "errorMessage": "string", "errorType": "string" } ] } ] } ], "success": false}

21


RequestExample

A record with product ID record1 and address IL USA is added in the repositorynamed "Company":{ "record": { "repositoryName": "Company", "productIdExt": "record1", "productId": "record1", "attributes": [ { "name": "Name", "value": "TIBCO" }, { "name": "Address", "value": "IL USA" }, { "name": "Street", "multivalues": [ "11th St", "Rockford" ], "multivalue": true }, { "name": "Website", "value": "https://www.google.co.in/" }, { "name": "Rating", "value": "10.10" }, { "name": "CompanySource", "value": "IT SOURCE" }, { "name": "CompanyRating", "value": "9" } ] }}

ResponseExample

The response returns the message that the records are added successfully. { "responseMessages": [ { "code": "SVC-11025", "message": "Service 'VALIDATE_PROCESS' executed successfully.", "type": "Info" }], "records": [], "success": true}

SuccessResponse

Example:


22


ErrorResponse

The response is displayed for validation error.


Example:

Code: 400 Bad request

OR

Code: 500 Invalid Request


Add Record with UploadThe various details of how to add a record with file upload is explained in this section. The files shouldbe uploaded as attachments to the request.

HTTPMethod

EndpointURL

See Endpoint

Resource /records/addRecordWithUpload/{repositoryName}

RequestParameters



Required

repository

Name


path string

newRecord

(body)JSON payload forthe record.

query string

Optional

perspectiv

eName


query string

Media Type multipart/form-data

RequestModel

The request model is similar to the Add Record rest service.

ResponseModel

The request model is similar to the Add Record rest service.

23


RequestExample

For Attributes{"record":{"repositoryName":"ALLTypeA","productIdExt":"filetest1","productId":"filetest1","attributes":[{"name":"ATA_STRING1","value":"demo"},{"name":"ATA_FILE1","value":"A.txt"}]}}

For Multivalue Attributes{"record":{"repositoryName":"ALLTypeA","productIdExt":"multi","productId":"multi","attributes":[{"name":"ATA_STRING1","value":"demo"},{"name":"ATA_MV_FILE1","multivalues":["B.txt","C.txt"],"multivalue":true}]}}

Attach all required files with cached.

ResponseExample

The response returns the message that the records are added successfully. { "responseMessages": [ { "code": "SVC-11025", "message": "Service 'VALIDATE_PROCESS' executed successfully.", "type": "Info" }], "records": [], "success": true}

SuccessResponse

Example:


ErrorResponse



Example:


OR



Add a Related RecordThe various details of how to add a related record is explained in this section. You cannot add a reverserelationship. Also, perspective for child record attribute is not supported.

HTTPMethod

EndpointURL

See Endpoint

Resource /records/{repositoryName}/addRelatedRecord

RequestParameters


24



Required

repository

Name


path string

Optional

workItemId Unique ID of thework item.

query string


RequestModel

{ "process": false, "validate": false, "workItemId": "string", "record": { "productId": "string", "productIdExt": "string", "productKeyId": "string", "attributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "repositoryName": "string", "relationships": { "relationshipAttributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "targetRecord": {} }, "deleted": false }}

25


ResponseModel


26


RequestExample

Adding a related record where street name is Rockford, customer type is IT,company type is IT PVT, and the date of birth is 03/10/1986 in the "Company" and"Customer" repositories.{ "record": { "repositoryName": "Company", "productId": "REC1", "productIdExt": "REC1", "attributes": [ { "name": "Name", "value": "TIBCO" }, { "name": "Address", "value": "IL USA" }, { "name": "Street", "multivalues": [ "11th St", "Rockford" ], "multivalue": true }, { "name": "Website", "value": "https://www.google.co.in/" }, { "name": "Rating", "value": "10.10" }, { "name": "CompanySource", "value": "IT SOURCE" }, { "name": "CompanyRating", "value": "9" } ], "relationships": { "companycustomer": [ { "relationshipAttributes": [ { "name": "RCustomerType", "value": "IT" }, { "name": "RCompanyType", "value": "IT PVT" } ], "targetRecord": { "repositoryName": "Customer", "productId": "REC2", "productIdExt": "REC2", "attributes": [ { "name": "CustName", "value": "daniel reichard" }, { "name": "CustAddress", "value": "UK" }, {

27


"name": "DOB", "value": "03/10/1986" }, { "name": "Salary", "value": "45000" }, { "name": "Gender", "value": "M" }, { "name": "CustRating", "value": "7" } ], "relationships": { }, "deleted": false } } ] }, "deleted": false }}

ResponseExample

The response returns the message that the records are added successfully.{ "responseMessages": [ { "code": "SVC-11025", "message": "Service 'VALIDATE_PROCESS' executed successfully.", "type": "Info" }], "records": [], "success": true}

SuccessResponse

Example:


ErrorResponse


Example:


OR



Modify a RecordThe various details of how to modify a record is explained in this section.

HTTPMethod

EndpointURL

See Endpoint

28


Resource /records/{repositoryName}/modifyRecord

RequestParameters



Required

repository

Name


path string

Optional

perspectiv

eName


query string


query string


29


RequestModel

Record to be modified record.productId and record.productIdExt are used toidentify the original record. The attributes PRODUCTID and PRODUCTIDEXTvalues are used to update the records.{ "process": false, "validate": false, "workItemId": "string", "perspectiveName": "string", "record": { "productId": "string", "productIdExt": "string", "productKeyId": "string", "state": "string", "attributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "repositoryName": "string", "relationships": { "relationshipAttributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "targetRecord": {} }, "deleted": false }}

30


ResponseModel


31


RequestExample

A record with product ID record1 and ID Extension record1 is added in therepository named "Company":{ "record": { "repositoryName": "Company", "productIdExt": "record1", "productId": "record1", "attributes": [ { "name": "Name", "value": "TIBCO" }, { "name": "Address", "value": "UK" }, { "name": "Street", "multivalues": [ "11th St", "Rockford" ], "multivalue": true }, { "name": "Website", "value": "https://in.yahoo.com/" }, { "name": "Rating", "value": "10.10" }, { "name": "CompanySource", "value": "IT SOURCE" }, { "name": "CompanyRating", "value": "9" } ] }}

ResponseExample

The response returns the message that the record was successfully modified. { "responseMessages": [ { "code": "SVC-11025", "message": "Service 'VALIDATE_PROCESS' executed successfully.", "type": "Info" }], "records": [], "success": true}

SuccessResponse

Example:


32


ErrorResponse



Example:


OR



Modify Record with UploadThe various details of how to modify a record with file upload explained in this section. The filesshould be uploaded as attachments to the request.

HTTPMethod

EndpointURL

See Endpoint

Resource /records/updateRecordWithUpload/{repositoryName}

RequestParameters



Required

repository

Name


path string

newRecord

(body)JSON payload forthe record.

query string

Optional

perspectiv

eName


query string


query string

Media Type multipart/form-data

RequestModel

The request model is similar to the Modify Record rest service.

ResponseModel

The request model is similar to the Modify Record rest service.

33


RequestExample

A record with product ID record4 and ID Extension record4 is modified in therepository named "REPO1":{"record":{"repositoryName":"REPO1","productId":"record4","productIdExt":"record4","attributes":[{"name":"PFile","value":"pfile.txt"},{"name":"PMultiFile","multivalues":["pfile1.txt","pfile2.txt"],"multivalue":true},{"name":"attribute1","value":"A1.txt"}],"relationships":{"r1tor2":[{"relationshipAttributes":[{"name":"RFile","value":"R.txt"}],"targetRecord":{"repositoryName":"REPO2","productId":"record4","productIdExt":"record4","attributes":[{"name":"CFlietype","value":"Cfile.txt"},{"name":"attribute1","value":"MOD.txt"},{"name":"CMultivalueFile","multivalues":["cfile1.txt","cfile2.txt"],"multivalue":true}],"relationships":{},"deleted":false}}]},"deleted":false}}

Attach all required files with cached.

ResponseExample

The response returns the message that the record was successfully modified. { "responseMessages": [ { "code": "SVC-11025", "message": "Service 'VALIDATE_PROCESS' executed successfully.", "type": "Info" }], "records": [], "success": true}

SuccessResponse

Example:


ErrorResponse



Example:


OR



Modify a Related RecordThe various details of how to modify a related record is explained in this section.

You cannot modify a reverse relationship. Also, perspective for a child record attribute is notsupported.

HTTPMethod

EndpointURL

See Endpoint

34


Resource /records/{repositoryName}/modifyRelatedRecord

RequestParameters



Required

repository

Name


path string

Optional


query string


RequestModel

{ "process": false, "validate": false, "workItemId": "string", "record": { "productId": "string", "productIdExt": "string", "productKeyId": "string", "attributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "repositoryName": "string", "relationships": { "relationshipAttributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "targetRecord": {} }, "deleted": false }}

35


ResponseModel


36


RequestExample

Modifying a record with relationship to customer type Non IT in the repositorynamed "Company".{ "record": { "repositoryName": "Company", "productId": "REC1", "productIdExt": "REC1", "attributes": [ { "name": "Name", "value": "TIBCO" }, { "name": "Address", "value": "NL" }, { "name": "Street", "multivalues": [ "11th St", "Rockford" ], "multivalue": true }, { "name": "Website", "value": "https://www.google.co.in/" }, { "name": "Rating", "value": "10.10" }, { "name": "CompanySource", "value": "IT SOURCE" }, { "name": "CompanyRating", "value": "9" } ], "relationships": { "companycustomer": [ { "relationshipAttributes": [ { "name": "RCustomerType", "value": "NONIT" }, { "name": "RCompanyType", "value": "IT PVT" } ], "targetRecord": { "repositoryName": "Customer", "productId": "REC2", "productIdExt": "REC2", "attributes": [ { "name": "CustName", "value": "John reichard" }, { "name": "CustAddress", "value": "UK" }, { "name": "DOB",

37


"value": "03/10/1986" }, { "name": "Salary", "value": "45000" }, { "name": "Gender", "value": "M" }, { "name": "CustRating", "value": "7" } ], "relationships": { }, "deleted": false } } ] }, "deleted": false }}

ResponseExample

The response returns all the records matching the search criteria.{ "responseMessages": [ { "code": "SVC-11025", "message": "Service 'VALIDATE_PROCESS' executed successfully.", "type": "Info" }], "records": [], "success": true}

SuccessResponse

Example:


ErrorResponse


Example:


OR



Compare a RecordYou can compare a record with its confirmed version.

HTTPMethod

EndpointURL

See Endpoint

38


Resource /records/{repositoryName}/compareRecord/{id}

RequestParameters



Required

repository

Name


path string

id Unique ID of therecord.

path string

idExt Unique ID andextension of therecord.

query string

Optional

compareVer

sionMode

Compares with thefollowing recordversion modes:PREVIOUS_CONFIRME

D_VERSION (Default)andPREVIOUS_VERSION

query string

modVersion Base record version query string

compareVer

sion

Compares with theversion of a record.

Either specifycompareVersion orcompareVersionMode..If both are specifiedcompareVersion isconsidered.

query string

bulkCompar

eMode

Includesrelationships.

query boolean

fullCompar

e

Set to true if youwant to return allrepository attributes.

query boolean


39


ResponseModel

{ "productId": "string", "productIdExt": "string", "productKeyId": "string", "version": "string", "state": "string", "similarityScore":"string", "attributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "repositoryName": "string", "relationships": { "relationshipAttributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "targetRecord": {} }, "deleted": false}

RequestExample

Endpoint:http://localhost:8080Resource:/eml/rest/records/Address/compareRecord/record1

Bulk Mode RequestrepositoryName: Parent1 {style : TEMPLATE}id: Record_106idExt: Record_106 {style: QUERY}fullCompare: true {style: QUERY}bulkComapreMode: true {style: QUERY}

40


ResponseExample

The response returns the message that all the records matching the criteria arecompared successfully.{...{ "name": "Address", "value": "Australia", "displayName": "Address", "multivalues": null, "groupName": "Unassigned", "type": 0, "id": 0, "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "multivalue": false, "dataChanged": true, "oldValue": "IL USA", "oldMultiValues": null },...}

41


Bulk Mode Response{ "productId": "Record_110", "productIdExt": "Record_110", "productKeyId": "14509", "version": "2", "state": "UNCONFIRMED", "key": 0, "effectiveDate": null, "similarityScore":null, "attributes": [ { "name": "PRODUCTID", "value": "Record_110", "displayName": "Record ID", "multivalues": null, "type": 0, "id": 0, "groupName": "Unassigned", "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "dataChanged": false, "oldValue": null, "oldMultiValues": null, "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "Record_110", "displayName": "Record ID Extension", "multivalues": null, "type": 0, "id": 0, "groupName": "Unassigned", "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "dataChanged": false, "oldValue": null, "oldMultiValues": null, "multivalue": false }, { "name": "FIRSTNAME", "value": "Ashok", "displayName": "FirstName", "multivalues": null, "type": 0, "id": 0, "groupName": "Unassigned", "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "dataChanged": false, "oldValue": null, "oldMultiValues": null, "multivalue": false }, { "name": "LASTNAME", "value": "Kumar", "displayName": "LastName", "multivalues": null, "type": 0, "id": 0, "groupName": "Unassigned", "associationName": null, "auxiliaryContent": null,

42


"matchingAttribute": false, "dataChanged": false, "oldValue": null, "oldMultiValues": null, "multivalue": false }, { "name": "ATTR1", "value": "Record_1101", "displayName": "Attr1", "multivalues": null, "type": 0, "id": 0, "groupName": "Unassigned", "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "dataChanged": true, "oldValue": "Record_110", "oldMultiValues": null, "multivalue": false }, { "name": "ATTR2", "value": "Record_110", "displayName": "Attr2", "multivalues": null, "type": 0, "id": 0, "groupName": "Unassigned", "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "dataChanged": false, "oldValue": null, "oldMultiValues": null, "multivalue": false } ], "repositoryName": "PARENT1", "classificationSchemeDetails": null, "relationships": {"P2C": [ { "relationshipAttributes": null, "targetRecord": { "productId": "Record_110", "productIdExt": "Record_110", "productKeyId": "14510", "version": null, "state": null, "key": 0, "effectiveDate": null, "attributes": null, "repositoryName": "CHILD11", "classificationSchemeDetails": null, "relationships": null, "deleted": false } }]}, "deleted": false}

SuccessResponse

Example:


43


ErrorResponse


Example:


OR

Code: 404 Record not found

OR



Delete a RecordThe various details of how to delete a record is explained in this section.

You cannot delete a record with the EffectiveDate attribute and when the record state is UNCONFIRMED.

HTTPMethod

EndpointURL

See Endpoint

Resource /records/{repositoryName}/deleteRecord

RequestParameters



Required

repository

Name


path string


query string


query string

Optional

deleteRelR

ecords

Set to true if youwant to delete allrelated records.

query boolean


query string

44




RequestModel

{ "repositoryName": "string", "id": "string", "idExt": "string", "workItemId": "string", "deleteRelRecords": false}

ResponseModel

{ "responseMessages": [ { "code": "string", "message": "string", "type": "string" } ], "success": true}

RequestExample

Deleting a record having product ID record1 and ID extension record1 in therepository named "Company".Endpoint:http://localhost:8080Resource:/eml/rest/records/Company/deleteRecord

ResponseExample

The response returns the message that all the records matching the criteria aredeleted successfully.{ "responseMessages": [ { "code": "SVC-11032", "message": Record(s) deleted successfully.", "type": "Info" }], "records": [], "success": true}

SuccessResponse

Example:


ErrorResponse



Example:


OR


OR



45


Delete a Related RecordThe various details of how to delete a related record is explained in this section.

HTTPMethod

EndpointURL

See Endpoint

Resource /records/{repositoryName}/deleteRelatedRecord

RequestParameters



Required

repository

Name


path string


query string

relationsh

ipName

Name of therelationship. Therelationship name iscase sensitive.

query string

targetRepo

sitoryName

Name of the targetrepository.

query string

childId Unique ID of thechild record.

query string


query string

childIdExt Unique ID andextension of thechild record.

query string



46


RequestModel

{ "repositoryName": "string", "relationshipName": "string", "targetRepositoryName": "string", "childId": "string", "childIdExt": "string", "deleteRelRecords": false, "id": "string", "idExt": "string"}

ResponseModel

{ "responseMessages": [ { "code": "string", "message": "string", "type": "string" } ], "success": true}

RequestExample

Deleting a record where the product ID is 31 from repository name "Customer"having relationship with product ID 32 from repository named "address".{ "repositoryName": "customer", "id": "31", "idExt": "31", "relationshipName": "officeaddress", "targetRepositoryName": "address", "childId": "32", "childIdExt": "32"}

ResponseExample

The response returns the message that the record is successfully deleted.{ "responseMessages": [ { "code": "SVC-11032", "message": "Record(s) deleted successfully.", "type": "Info" } ], "records": [], "success": true}

SuccessResponse

Example:


47


ErrorResponse



Example:


OR


OR



Search a RecordThe various details of how to search a record is explained in this section.

HTTPMethod

EndpointURL

See Endpoint

Resource /records/{repositoryName}/search

RequestParameters



Required

repository

Name


path string

Optional

includeSys

temAttribu

tes

Specify whether youwant to includesystem attributes.The default value isfalse.

query boolean

findRootRe

cord

Specify whether youwant to find rootrecord only. Thedefault value isfalse.

query boolean


48


RequestModel

{ "name": "string", "productKey": 0, "attributes": [ { "name": "string", "value": [ {} ], "operator": "string", "caseSensitive": true } ], "multivalueAttributes": { "additionalProp1": [ {} ], "additionalProp2": [ {} ], "additionalProp3": [ {} ] }, "relationships": [ { "name": "string", "count": 0, "checkExistence": true, "relationshipAttributes": [ { "name": "string", "value": [ {} ], "operator": "string", "caseSensitive": true } ], "repository": { "name": "string", "productKey": 0, "attributes": [ { "name": "string", "value": [ {} ], "operator": "string", "caseSensitive": true } ] } } ], "startIndex": 0, "recordCount": 0}

49


ResponseModel

{ "records": [ { "productId": "string", "productIdExt": "string", "productKeyId": "string", "version": "string", "state": "string", "effectiveDate": "string", "attributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "repositoryName": "string", "relationships": { "relationshipAttributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "targetRecord": {} }, "deleted": false } ], "totalCount": 0}

RequestExample:Basic Search

Searching for a record where address is "IL USA" in the repository named"Company".{ "name": "Company", "productKey": -1, "attributes": [ { "name": "Address", "value": [ "IL USA" ], "operator": "eq", "caseSensitive": false } ]}

50


ResponseExample:Basic Search

The response returns all the records matching the search criteria. In followingresponse example, city is equal to "IL USA":{ "records": [ { "productId": "record1-1", "productIdExt": "record1-1", "productKeyId": "12798", "version": "1", "state": "CONFIRMED", "isDeleted": false, "attributes": [ { "name": "PRODUCTID", "value": "record1-1", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "record1-1", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Name", "value": "TIBCO", "displayName": "Name", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Address", "value": "IL USA", "displayName": "Address", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Street", "value": null, "displayName": "Street", "multivalues": [ "11th St", "Rockford" ], "groupName": "Unassigned", "multivalue": true }, { "name": "Website", "value": "https://www.google.co.in/", "displayName": "Website", "multivalues": null, "groupName": "Unassigned", "multivalue": false

51


}, { "name": "Rating", "value": "10.10", "displayName": "Rating", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CompanySource", "value": "IT SOURCE", "displayName": "CompanySource", "multivalues": null, "groupName": "CompanyType", "multivalue": false }, { "name": "CompanyRating", "value": "9", "displayName": "CompanyRating", "multivalues": null, "groupName": "CompanyType", "multivalue": false } ], "repositoryName": "COMPANY", "relationships": {}, "deleted": false }], "totalCount": 1}

52


RequestExample:RelatedRecordSearch

Searching for a related record where street name is "Rockford", customer type is notequal to "NonIT", and customer's date of birth is greater than "03/10/1985" in the"Company" and "Customer" repositories.{ "name": "Company", "productKey": -1, "attributes": [ { "name": "Street", "value": [ "Rockford" ], "operator": "eq", "caseSensitive": false } ], "relationships": [ { "name": "companycustomer", "count": 1, "checkExistence": true, "relationshipAttributes": [ { "name": "RCustomerType", "value": [ "NONIT" ], "operator": "ne", "caseSensitive": false } ], "repository": { "name": "Customer", "attributes": [ { "name": "DOB", "value": [ "03/10/1985" ], "operator": "gt", "caseSensitive": false } ] } } ]}

53


ResponseExample:RelatedRecordSearch

The response returns all the records matching the search criteria. In the followingresponse example, street name is "Rockford", customer type is "IT", and customer'sdate of birth is greater than "03/10/1985".{ "records": [ { "productId": "REC1", "productIdExt": "REC1", "productKeyId": "12799", "version": "1", "state": "CONFIRMED", "isDeleted": false, "attributes": [ { "name": "PRODUCTID", "value": "REC1", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "REC1", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Name", "value": "TIBCO", "displayName": "Name", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Address", "value": "IL USA", "displayName": "Address", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Street", "value": null, "displayName": "Street", "multivalues": [ "11th St", "Rockford" ], "groupName": "Unassigned", "multivalue": true }, { "name": "Website", "value": "https://www.google.co.in/", "displayName": "Website", "multivalues": null, "groupName": "Unassigned",

54


"multivalue": false }, { "name": "Rating", "value": "10.10", "displayName": "Rating", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CompanySource", "value": "IT SOURCE", "displayName": "CompanySource", "multivalues": null, "groupName": "CompanyType", "multivalue": false }, { "name": "CompanyRating", "value": "9", "displayName": "CompanyRating", "multivalues": null, "groupName": "CompanyType", "multivalue": false } ], "repositoryName": "COMPANY", "relationships": {"companycustomer": [ { "relationshipAttributes": [ { "name": "RCustomerType", "value": "IT", "displayName": null, "multivalues": null, "groupName": null, "multivalue": false }, { "name": "RCompanyType", "value": "IT PVT", "displayName": null, "multivalues": null, "groupName": null, "multivalue": false } ], "targetRecord": { "productId": "REC2", "productIdExt": "REC2", "productKeyId": "12800", "version": "1", "state": "CONFIRMED", "isDeleted": false, "attributes": [ { "name": "PRODUCTID", "value": "REC2", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "REC2", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "multivalue": false

55


}, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CustName", "value": "daniel reichard", "displayName": "CustName", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CustAddress", "value": "UK", "displayName": "CustAddress", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "DOB", "value": "03/10/1986", "displayName": "DOB", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Salary", "value": "45000", "displayName": "Salary", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Gender", "value": "M", "displayName": "Gender", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CustRating", "value": "7", "displayName": "CustRating", "multivalues": null, "groupName": "Unassigned", "multivalue": false } ], "repositoryName": "CUSTOMER", "relationships": {}, "deleted": false } }]}, "deleted": false }], "totalCount": 1}

56


SuccessResponse

Example:


ErrorResponse


Example:


OR


OR



Supported OperatorsThe following is a list of supported operators:

Search a Record - Supported Operators

Operator Description Data Types

eq Equals ALL

ne Not equals ALL

in In

Note: Use comma as valueseparator and doublequotes as text qualifier incase the value itselfcontains comma.

ALL except Boolean

ni Not In

Use in record query webservices to excludemultiple values in yoursearch filter. For example,if you want to retrieve allthe records withPRODUCTIDEXT not in 2 and3.

String, Number, and Date

lk Like String, File

nl Not Like String, File

sw Starts With String, File

ew Ends With String, File

57


Operator Description Data Types

sl Sounds like String, File

gt Greater than Number, Date, and Timestamp

ge Greater than equals Number, Date, and Timestamp

lt Less than Number, Date, and Timestamp

le Less than equals Number, Date, and Timestamp

bw Between Number, Date, and Timestamp

For the string type attributes, additionally, you can check for case sensitivity using caseSensitive. Itspecifies whether a case sensitive query is to be done. The default is false.

Text SearchBy using text search, you can search for human recognizable terms similar to web search engines. Textin a record is indexed and stored as key terms in a high performance and quick retrieval data structurecalled the Index.

Text search requires parameters and finds matches that do not match exactly. However, they can havesmall variations in the data. Matching is an additional functionality built on the fuzzy search capabilitythat provides the best matching repository record with the specified input record. Specify weight of anattribute to provide more weightage for matching records in the request example. Enter a decimalnumber between 0.00 to 1. To know more about the matching process and for the text indexconfiguration, refer to the chapter, "Search and Matching" in TIBCO MDM System Administration.

HTTP Method

Endpoint URL See Endpoint

Resource /records/textSearch

RequestParameters



Required

entityName Name of the index entity body string

similarityScore The value for the similaritysearch for the text

body number(float)

SearchString Name of text that you wantto search

body string

58


startIndex Represents the startingsequential number ofmatching record that youwant to display in theresponse. For example, if arepository contains twentymatching records and youwant to view the matchingrecord from fifth to twenty.You can specify"startIndex":"5". Thedefault value is 0.

body integer(int32)

endIndex Represents the endsequential number ofmatching record that youwant to display in theresponse. For example, if arepository contains twentymatching records and youwant to view the matchingrecord from fifth to twenty.You can specify"endIndex":"20". Thedefault value is 20

body integer(int32)

repositoryName Name of the repository body string

repository Attributes specified in therepository

body string


59


Request Model { "entityName": "string", "similarityScore": 0, "searchString": "string", "startIndex": 0, "endIndex": 0, "repositoryName": "string", "repository": { "name": "string", "productKey": 0, "attributes": [ { "name": "string", "value": [ {} ], "weight": "string" } ], "multivalueAttributes": { "additionalProp1": [ {} ], "additionalProp2": [ {} ], "additionalProp3": [ {} ] }, "relationships": [ { "name": "string", "count": 0, "checkExistence": true, "repository": { "name": "string", "productKey": 0, "attributes": [ { "name": "string", "value": [ {} ], "weight": "string" } ] } } ] }}

60


ResponseModel


RequestExample

See Request Examples on page 62

ResponseExample

See Response Examples on page 64

SuccessResponse

Example:


61


Error Response If the response is unsuccessful, either of the following error code is displayed:

Example:


OR


OR



Request Examples

Example Name Examples

Attribute Based Search { "entityName": "rest1", "similarityScore": "0.8", "repository": { "name": "ALLTypeA", "attributes": [ { "name": "ATA_STRING1", "value": [ "deshoom" ], "weight": "0.9" }, { "name": "ATA_INTEGER1", "value": [ "789" ], "weight": "1.0" } ], "relationships": [ { "name": "AAToAB", "repository": { "name": "ALLTypeB", "attributes": [ { "name": "ATA_STRING1", "value": [ "Abhi" ], "weight": "1.0" }, { "name": "ATA_AMOUNT1", "value": [ "982.233" ] } ] } } ] }}

62



Free Form Search With Pagination { "entityName":"rest1", "similarityScore":"0.8", "searchString":"demo1", "startIndex":"0", "endIndex":"25"}

Free Form Search With Repository Name { "repositoryName":"ALLTypeA", "similarityScore":"0.8", "searchString":"demo", "startIndex":"0", "endIndex":"25" }

63


Response Examples


Attribute Based Search { "records": [ { "productId": "test1", "productIdExt": "test1", "productKeyId": "14002", "version": "1", "state": "CONFIRMED", "isDeleted": false, "similarityScore": "0.98", "attributes": [ { "name": "PRODUCTID", "value": "test1", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "test1", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_LONG1", "value": "", "displayName": "ATA_LONG1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_URL1", "value": "", "displayName": "ATA_URL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_STRING1", "value": "deshoom", "displayName": "ATA_STRING1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false },

64



{ "name": "ATA_INTEGER1", "value": "789", "displayName": "ATA_INTEGER1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_AMOUNT1", "value": "", "displayName": "ATA_AMOUNT1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_FILE1", "value": "", "displayName": "ATA_FILE1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_BOOLEAN1", "value": "", "displayName": "ATA_BOOLEAN1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_DATE1", "value": "", "displayName": "ATA_DATE1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_TIMESTAMP1", "value": "", "displayName": "ATA_TIMESTAMP1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_DECIMAL1", "value": "", "displayName": "ATA_DECIMAL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_CUSDECIMAL1", "value": "", "displayName": "ATA_CUSDECIMAL1", "multivalues": null,

65



"groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_MV_LONG1", "value": null, "displayName": "ATA_MV_LONG1", "multivalues": [], "groupName": "MultiValue", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_URL1", "value": null, "displayName": "ATA_MV_URL1", "multivalues": [], "groupName": "MultiValue", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_STRING1", "value": null, "displayName": "ATA_MV_STRING1", "multivalues": [], "groupName": "MultiValue", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_FILE1", "value": null, "displayName": "ATA_MV_FILE1", "multivalues": [], "groupName": "MultiValue", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_AMOUNT1", "value": null, "displayName": "ATA_MV_AMOUNT1", "multivalues": [], "groupName": "MultiValue", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_BOOLEAN1", "value": "", "displayName": "ATA_MV_BOOLEAN1", "multivalues": null, "groupName": "MultiValue", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_MV_INTEGER1", "value": null, "displayName": "ATA_MV_INTEGER1", "multivalues": [], "groupName": "MultiValue", "matchingAttribute": false, "multivalue": true }, {

66



"name": "ATA_MV_DECIMAL1", "value": null, "displayName": "ATA_MV_DECIMAL1", "multivalues": [], "groupName": "MultiValue", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_DATE1", "value": null, "displayName": "ATA_MV_DATE1", "multivalues": [], "groupName": "MultiValue", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_CUSDECIMAL1", "value": null, "displayName": "ATA_MV_CUSDECIMAL1", "multivalues": [], "groupName": "MultiValue", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_TIMESTAMP1", "value": null, "displayName": "ATA_MV_TIMESTAMP1", "multivalues": [], "groupName": "MultiValue", "matchingAttribute": false, "multivalue": true }, { "name": "GRP_LONG1", "value": "", "displayName": "GRP_LONG1", "multivalues": null, "groupName": "Group1", "matchingAttribute": false, "multivalue": false }, { "name": "GRP_URL1", "value": "", "displayName": "GRP_URL1", "multivalues": null, "groupName": "Group1", "matchingAttribute": false, "multivalue": false } ], "repositoryName": "ALLTYPEA", "relationships": {"AAToAB": [ { "relationshipAttributes": [ { "name": "REL_Long1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false },

67



{ "name": "REL_URL1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_STRING1", "value": "rrtest", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_INTEGER1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_BOOLEAN1", "value": "true", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_FILE1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_AMOUNT1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_DATE1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_DECIMAL1", "value": "", "displayName": null, "multivalues": null,

68



"groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_CUSDECIMAL1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_TIMESTAMP1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false } ], "targetRecord": { "productId": "test2", "productIdExt": "test2", "productKeyId": "14003", "version": "2", "state": "CONFIRMED", "isDeleted": false, "similarityScore": "", "attributes": [ { "name": "PRODUCTID", "value": "test2", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "test2", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_LONG1", "value": "", "displayName": "ATA_LONG1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false,

69



"multivalue": false }, { "name": "ATA_URL1", "value": "", "displayName": "ATA_URL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_STRING1", "value": "Abhishek", "displayName": "ATA_STRING1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_INTEGER1", "value": "", "displayName": "ATA_INTEGER1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_AMOUNT1", "value": "982.233", "displayName": "ATA_AMOUNT1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_FILE1", "value": "", "displayName": "ATA_FILE1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_CUSDECIMAL1", "value": "", "displayName": "ATA_CUSDECIMAL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_DECIMAL1", "value": "", "displayName": "ATA_DECIMAL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false,

70



"multivalue": false }, { "name": "ATA_TIMESTAMP1", "value": "", "displayName": "ATA_TIMESTAMP1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_DATE1", "value": "", "displayName": "ATA_DATE1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_BOOLEAN1", "value": "", "displayName": "ATA_BOOLEAN1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_MV_LONG1", "value": null, "displayName": "ATA_MV_LONG1", "multivalues": [], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_URL1", "value": null, "displayName": "ATA_MV_URL1", "multivalues": [], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_STRING1", "value": null, "displayName": "ATA_MV_STRING1", "multivalues": [], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_FILE1", "value": null, "displayName": "ATA_MV_FILE1", "multivalues": [], "groupName": "MultiValueB",

71



"matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_AMOUNT1", "value": null, "displayName": "ATA_MV_AMOUNT1", "multivalues": [], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_BOOLEAN1", "value": "", "displayName": "ATA_MV_BOOLEAN1", "multivalues": null, "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_MV_INTEGER1", "value": null, "displayName": "ATA_MV_INTEGER1", "multivalues": [], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_DECIMAL1", "value": null, "displayName": "ATA_MV_DECIMAL1", "multivalues": [], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_DATE1", "value": null, "displayName": "ATA_MV_DATE1", "multivalues": [], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_CUSDECIMAL1", "value": null, "displayName": "ATA_MV_CUSDECIMAL1", "multivalues": [], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_TIMESTAMP1", "value": null, "displayName":

72



"ATA_MV_TIMESTAMP1", "multivalues": [], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true } ], "repositoryName": "ALLTYPEB", "relationships": {}, "deleted": false } }]}, "deleted": false }], "totalCount": 1}

73



Free Form Search With Pagination { "records": [ { "productId": "r1", "productIdExt": "r1", "productKeyId": "10002", "version": "2", "state": "CONFIRMED", "isDeleted": false, "similarityScore": "1.0", "attributes": [ { "name": "PRODUCTID", "value": "r1", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "r1", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_LONG1", "value": "12345", "displayName": "ATA_LONG1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_URL1", "value": "http://www.linkedin.com", "displayName": "ATA_URL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_STRING1", "value": "demo", "displayName": "ATA_STRING1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, {

74



"name": "ATA_INTEGER1", "value": "123", "displayName": "ATA_INTEGER1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_AMOUNT1", "value": "11.22", "displayName": "ATA_AMOUNT1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_FILE1", "value": "Download?downloaddoc=master/34306/10002/32009/ATTACHMENTS/file1_1.txt", "displayName": "ATA_FILE1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_BOOLEAN1", "value": "true", "displayName": "ATA_BOOLEAN1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_DATE1", "value": "07/21/2017", "displayName": "ATA_DATE1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_TIMESTAMP1", "value": "2017-07-26 12:12:11.977", "displayName": "ATA_TIMESTAMP1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_DECIMAL1", "value": "23.11", "displayName": "ATA_DECIMAL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_CUSDECIMAL1", "value": "27651.2344",

75



"displayName": "ATA_CUSDECIMAL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_MV_LONG1", "value": null, "displayName": "ATA_MV_LONG1", "multivalues": [ "1872", "223" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_URL1", "value": null, "displayName": "ATA_MV_URL1", "multivalues": [ "http://www.internet.com", "http://www.fild.com" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_STRING1", "value": null, "displayName": "ATA_MV_STRING1", "multivalues": [ "demo1", "demo2" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_FILE1", "value": null, "displayName": "ATA_MV_FILE1", "multivalues": [ "file2.txt", "file3.txt" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_AMOUNT1", "value": null, "displayName": "ATA_MV_AMOUNT1", "multivalues": [ "11.22", "12.333" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_BOOLEAN1",

76



"value": "false", "displayName": "ATA_MV_BOOLEAN1", "multivalues": null, "groupName": "MultiValue", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_MV_INTEGER1", "value": null, "displayName": "ATA_MV_INTEGER1", "multivalues": [ "1", "2" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_DECIMAL1", "value": null, "displayName": "ATA_MV_DECIMAL1", "multivalues": [ "1.10", "0.20" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_DATE1", "value": null, "displayName": "ATA_MV_DATE1", "multivalues": [ "07/28/2017", "07/14/2017" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_CUSDECIMAL1", "value": null, "displayName": "ATA_MV_CUSDECIMAL1", "multivalues": [ "9182.23", "1625.32" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_TIMESTAMP1", "value": null, "displayName": "ATA_MV_TIMESTAMP1", "multivalues": [ "2017-07-26 12:13:55.145", "2017-07-26 12:14:00.380" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true

77



}, { "name": "GRP_LONG1", "value": "", "displayName": "GRP_LONG1", "multivalues": null, "groupName": "Group1", "matchingAttribute": false, "multivalue": false }, { "name": "GRP_URL1", "value": "", "displayName": "GRP_URL1", "multivalues": null, "groupName": "Group1", "matchingAttribute": false, "multivalue": false } ], "repositoryName": "ALLTYPEA", "relationships": {"AAToAB": [ { "relationshipAttributes": [ { "name": "REL_Long1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_URL1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_STRING1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_INTEGER1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_BOOLEAN1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false },

78



{ "name": "REL_FILE1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_AMOUNT1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_DATE1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_DECIMAL1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_CUSDECIMAL1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_TIMESTAMP1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false } ], "targetRecord": { "productId": "r2", "productIdExt": "r2", "productKeyId": "10003", "version": "2", "state": "CONFIRMED", "isDeleted": false, "similarityScore": "", "attributes": [ { "name": "PRODUCTID", "value": "r2", "displayName": "Record ID",

79



"multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "r2", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_LONG1", "value": "182632", "displayName": "ATA_LONG1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_URL1", "value": "http://www.hfc.com", "displayName": "ATA_URL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_STRING1", "value": "r2demo", "displayName": "ATA_STRING1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_INTEGER1", "value": "8172", "displayName": "ATA_INTEGER1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_AMOUNT1", "value": "7172.22", "displayName":

80



"ATA_AMOUNT1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_FILE1", "value": "Download?downloaddoc=master/34319/10003/32037/ATTACHMENTS/file4_1.txt", "displayName": "ATA_FILE1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_CUSDECIMAL1", "value": "8172.22", "displayName": "ATA_CUSDECIMAL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_DECIMAL1", "value": "", "displayName": "ATA_DECIMAL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_TIMESTAMP1", "value": "2017-07-26 12:16:15.877", "displayName": "ATA_TIMESTAMP1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_DATE1", "value": "07/12/2017", "displayName": "ATA_DATE1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_BOOLEAN1", "value": "true", "displayName": "ATA_BOOLEAN1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, {

81



"name": "ATA_MV_LONG1", "value": null, "displayName": "ATA_MV_LONG1", "multivalues": [ "8172", "2763" ], "groupName": "MultiValueB", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_URL1", "value": null, "displayName": "ATA_MV_URL1", "multivalues": [ "http://www.ind.com", "http://www.cms.com" ], "groupName": "MultiValueB", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_STRING1", "value": null, "displayName": "ATA_MV_STRING1", "multivalues": [ "de1", "de2" ], "groupName": "MultiValueB", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_FILE1", "value": null, "displayName": "ATA_MV_FILE1", "multivalues": ["file5.txt"], "groupName": "MultiValueB", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_AMOUNT1", "value": null, "displayName": "ATA_MV_AMOUNT1", "multivalues": [ "1982.22", "82763.22" ], "groupName": "MultiValueB", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_BOOLEAN1",

82



"value": "false", "displayName": "ATA_MV_BOOLEAN1", "multivalues": null, "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_MV_INTEGER1", "value": null, "displayName": "ATA_MV_INTEGER1", "multivalues": [ "12", "13" ], "groupName": "MultiValueB", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_DECIMAL1", "value": null, "displayName": "ATA_MV_DECIMAL1", "multivalues": [ "4.40", "5.50" ], "groupName": "MultiValueB", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_DATE1", "value": null, "displayName": "ATA_MV_DATE1", "multivalues": [ "07/30/2017", "07/31/2017" ], "groupName": "MultiValueB", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_CUSDECIMAL1", "value": null, "displayName": "ATA_MV_CUSDECIMAL1", "multivalues": [ "9182.22", "263.22" ], "groupName": "MultiValueB", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_TIMESTAMP1", "value": null,

83



"displayName": "ATA_MV_TIMESTAMP1", "multivalues": [ "2017-07-26 12:17:32.455", "2017-07-26 12:17:37.260" ], "groupName": "MultiValueB", "matchingAttribute": true, "multivalue": true } ], "repositoryName": "ALLTYPEB", "relationships": {"BC": [ { "relationshipAttributes": [], "targetRecord": { "productId": "r3", "productIdExt": "r3", "productKeyId": "10015", "version": "1", "state": "CONFIRMED", "isDeleted": false, "similarityScore": "", "attributes": [ { "name": "PRODUCTID", "value": "r3", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "r3", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_LONGC1", "value": "1728",

84



"displayName": "AT_LONGC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_URLC1", "value": "http://www.google.com", "displayName": "AT_URLC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_STRINGC1", "value": "demo", "displayName": "AT_STRINGC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_INTEGERC1", "value": "", "displayName": "AT_INTEGERC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_AMOUNTC1", "value": "", "displayName": "AT_AMOUNTC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_BOOLEANC1", "value": "", "displayName": "AT_BOOLEANC1", "multivalues": null, "groupName": "Unassigned",

85



"matchingAttribute": false, "multivalue": false }, { "name": "AT_FILEC1", "value": "", "displayName": "AT_FILEC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_DECIMALC1", "value": "", "displayName": "AT_DECIMALC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_CUSDECIMALC1", "value": "", "displayName": "AT_CUSDECIMALC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_DATEC1", "value": "", "displayName": "AT_DATEC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_TIMESTAMPC1", "value": "", "displayName": "AT_TIMESTAMPC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false } ],

86



"repositoryName": "ALLTYPEC", "relationships": {}, "deleted": false } }]}, "deleted": false } }]}, "deleted": false }], "totalCount": 1}

87



Free Form Search With Repository Name { "records": [ { "productId": "r1", "productIdExt": "r1", "productKeyId": "10002", "version": "2", "state": "CONFIRMED", "isDeleted": false, "similarityScore": "1.0", "attributes": [ { "name": "PRODUCTID", "value": "r1", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "r1", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_LONG1", "value": "12345", "displayName": "ATA_LONG1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_URL1", "value": "http://www.linkedin.com", "displayName": "ATA_URL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_STRING1", "value": "demo", "displayName": "ATA_STRING1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, {

88



"name": "ATA_INTEGER1", "value": "123", "displayName": "ATA_INTEGER1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_AMOUNT1", "value": "11.22", "displayName": "ATA_AMOUNT1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_FILE1", "value": "Download?downloaddoc=master/34306/10002/32009/ATTACHMENTS/file1_1.txt", "displayName": "ATA_FILE1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_BOOLEAN1", "value": "true", "displayName": "ATA_BOOLEAN1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_DATE1", "value": "07/21/2017", "displayName": "ATA_DATE1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_TIMESTAMP1", "value": "2017-07-26 12:12:11.977", "displayName": "ATA_TIMESTAMP1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_DECIMAL1", "value": "23.11", "displayName": "ATA_DECIMAL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_CUSDECIMAL1", "value": "27651.2344",

89



"displayName": "ATA_CUSDECIMAL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": true, "multivalue": false }, { "name": "ATA_MV_LONG1", "value": null, "displayName": "ATA_MV_LONG1", "multivalues": [ "1872", "223" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_URL1", "value": null, "displayName": "ATA_MV_URL1", "multivalues": [ "http://www.internet.com", "http://www.fild.com" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_STRING1", "value": null, "displayName": "ATA_MV_STRING1", "multivalues": [ "demo1", "demo2" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_FILE1", "value": null, "displayName": "ATA_MV_FILE1", "multivalues": [ "file2.txt", "file3.txt" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_AMOUNT1", "value": null, "displayName": "ATA_MV_AMOUNT1", "multivalues": [ "11.22", "12.333" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_BOOLEAN1",

90



"value": "false", "displayName": "ATA_MV_BOOLEAN1", "multivalues": null, "groupName": "MultiValue", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_MV_INTEGER1", "value": null, "displayName": "ATA_MV_INTEGER1", "multivalues": [ "1", "2" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_DECIMAL1", "value": null, "displayName": "ATA_MV_DECIMAL1", "multivalues": [ "1.10", "0.20" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_DATE1", "value": null, "displayName": "ATA_MV_DATE1", "multivalues": [ "07/28/2017", "07/14/2017" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_CUSDECIMAL1", "value": null, "displayName": "ATA_MV_CUSDECIMAL1", "multivalues": [ "9182.23", "1625.32" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true }, { "name": "ATA_MV_TIMESTAMP1", "value": null, "displayName": "ATA_MV_TIMESTAMP1", "multivalues": [ "2017-07-26 12:13:55.145", "2017-07-26 12:14:00.380" ], "groupName": "MultiValue", "matchingAttribute": true, "multivalue": true

91



}, { "name": "GRP_LONG1", "value": "", "displayName": "GRP_LONG1", "multivalues": null, "groupName": "Group1", "matchingAttribute": false, "multivalue": false }, { "name": "GRP_URL1", "value": "", "displayName": "GRP_URL1", "multivalues": null, "groupName": "Group1", "matchingAttribute": false, "multivalue": false } ], "repositoryName": "ALLTYPEA", "relationships": {"AAToAB": [ { "relationshipAttributes": [ { "name": "REL_Long1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_URL1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_STRING1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_INTEGER1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_BOOLEAN1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false },

92



{ "name": "REL_FILE1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_AMOUNT1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_DATE1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_DECIMAL1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_CUSDECIMAL1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false }, { "name": "REL_TIMESTAMP1", "value": "", "displayName": null, "multivalues": null, "groupName": null, "matchingAttribute": false, "multivalue": false } ], "targetRecord": { "productId": "r2", "productIdExt": "r2", "productKeyId": "10003", "version": "2", "state": "CONFIRMED", "isDeleted": false, "similarityScore": "", "attributes": [ { "name": "PRODUCTID", "value": "r2", "displayName": "Record ID",

93



"multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "r2", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_LONG1", "value": "182632", "displayName": "ATA_LONG1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_URL1", "value": "http://www.hfc.com", "displayName": "ATA_URL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_STRING1", "value": "r2demo", "displayName": "ATA_STRING1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_INTEGER1", "value": "8172", "displayName": "ATA_INTEGER1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_AMOUNT1", "value": "7172.22", "displayName":

94



"ATA_AMOUNT1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_FILE1", "value": "Download?downloaddoc=master/34319/10003/32037/ATTACHMENTS/file4_1.txt", "displayName": "ATA_FILE1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_CUSDECIMAL1", "value": "8172.22", "displayName": "ATA_CUSDECIMAL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_DECIMAL1", "value": "", "displayName": "ATA_DECIMAL1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_TIMESTAMP1", "value": "2017-07-26 12:16:15.877", "displayName": "ATA_TIMESTAMP1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_DATE1", "value": "07/12/2017", "displayName": "ATA_DATE1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_BOOLEAN1", "value": "true", "displayName": "ATA_BOOLEAN1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, {

95



"name": "ATA_MV_LONG1", "value": null, "displayName": "ATA_MV_LONG1", "multivalues": [ "8172", "2763" ], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_URL1", "value": null, "displayName": "ATA_MV_URL1", "multivalues": [ "http://www.ind.com", "http://www.cms.com" ], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_STRING1", "value": null, "displayName": "ATA_MV_STRING1", "multivalues": [ "de1", "de2" ], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_FILE1", "value": null, "displayName": "ATA_MV_FILE1", "multivalues": ["file5.txt"], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_AMOUNT1", "value": null, "displayName": "ATA_MV_AMOUNT1", "multivalues": [ "1982.22", "82763.22" ], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_BOOLEAN1",

96



"value": "false", "displayName": "ATA_MV_BOOLEAN1", "multivalues": null, "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": false }, { "name": "ATA_MV_INTEGER1", "value": null, "displayName": "ATA_MV_INTEGER1", "multivalues": [ "12", "13" ], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_DECIMAL1", "value": null, "displayName": "ATA_MV_DECIMAL1", "multivalues": [ "4.40", "5.50" ], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_DATE1", "value": null, "displayName": "ATA_MV_DATE1", "multivalues": [ "07/30/2017", "07/31/2017" ], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_CUSDECIMAL1", "value": null, "displayName": "ATA_MV_CUSDECIMAL1", "multivalues": [ "9182.22", "263.22" ], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true }, { "name": "ATA_MV_TIMESTAMP1", "value": null,

97



"displayName": "ATA_MV_TIMESTAMP1", "multivalues": [ "2017-07-26 12:17:32.455", "2017-07-26 12:17:37.260" ], "groupName": "MultiValueB", "matchingAttribute": false, "multivalue": true } ], "repositoryName": "ALLTYPEB", "relationships": {"BC": [ { "relationshipAttributes": [], "targetRecord": { "productId": "r3", "productIdExt": "r3", "productKeyId": "10015", "version": "1", "state": "CONFIRMED", "isDeleted": false, "similarityScore": "", "attributes": [ { "name": "PRODUCTID", "value": "r3", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "r3", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_LONGC1", "value": "1728",

98



"displayName": "AT_LONGC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_URLC1", "value": "http://www.google.com", "displayName": "AT_URLC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_STRINGC1", "value": "demo", "displayName": "AT_STRINGC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_INTEGERC1", "value": "", "displayName": "AT_INTEGERC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_AMOUNTC1", "value": "", "displayName": "AT_AMOUNTC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_BOOLEANC1", "value": "", "displayName": "AT_BOOLEANC1", "multivalues": null, "groupName": "Unassigned",

99



"matchingAttribute": false, "multivalue": false }, { "name": "AT_FILEC1", "value": "", "displayName": "AT_FILEC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_DECIMALC1", "value": "", "displayName": "AT_DECIMALC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_CUSDECIMALC1", "value": "", "displayName": "AT_CUSDECIMALC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_DATEC1", "value": "", "displayName": "AT_DATEC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false }, { "name": "AT_TIMESTAMPC1", "value": "", "displayName": "AT_TIMESTAMPC1", "multivalues": null, "groupName": "Unassigned", "matchingAttribute": false, "multivalue": false } ],

100



"repositoryName": "ALLTYPEC", "relationships": {}, "deleted": false } }]}, "deleted": false } }]}, "deleted": false }], "totalCount": 1}

Retrieve Records from a RepositoryThe various details of how to retrieve records from a repository are explained in this section. Only theroot level records are retrieved. Classification, GroupName, and EffectiveDate are not supported.

HTTPMethod

EndpointURL

See Endpoint

Resource /records/{repositoryName}

RequestParameters



Required

repository

Name


path string

Optional

startIndex Starting index of thestart record. This isused for pagination.The default value is1.

query integer (int32)

recordCoun

t

Number of recordsto be retrieved. Thisis used forpagination.


includeSys

temAttribu

tes

Set to true if youwant to includesystem attributes.The default value isfalse.

query boolean

101


sortBy Column name onwhich you want tosort the data. ThesortBy works withthe ascending field.

query string

ascending Set to true if youwant to sort by theascending order. Theascending fieldworks with thesortBy field.

query boolean

recordStat

e

The state of a recordthat is beingsearched. You canspecify the followingvalues:

● CONFIRMED:includes theconfirmedrecords. This isthe default value.

● UNCONFIRMED:includes theunconfirmedrecords.

● LATEST: includesthe confirmed orunconfirmedrecords.

● DELETED:includes thedeleted records.

● ALL: includes allrecords with anystate.

query string


102


Active Specifies whether ornot the deletedrecords areretrieved. UseActive withrecordState = ALL.The valid values areY, N, and ANY. Thedefault value is Y.

● Active=Y: thedeleted recordsare not retrieved

● Active=N:deleted recordsare retrieved

● Active=ANY:either deleted ornon deletedrecords areretrieved

query string


To retrieverecordswhich are intheworkflow,you must usetheworkItemId

parameterwith therecordState

parameter.

query string

103


ResponseModel


RequestExample

Endpoint:http://localhost:8080Resource:/eml/rest/records/Company

104


ResponseExample

{ "records": [ { "productId": "REC1", "productIdExt": "REC1", "productKeyId": "12799", "version": "1", "state": "CONFIRMED", "isDeleted": false, "attributes": [ { "name": "PRODUCTID", "value": "REC1", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "REC1", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Name", "value": "TIBCO", "displayName": "Name", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Address", "value": "IL USA", "displayName": "Address", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Street", "value": null, "displayName": "Street", "multivalues": [ "11th St", "Rockford" ], "groupName": "Unassigned", "multivalue": true }, { "name": "Website", "value": "https://www.google.co.in/", "displayName": "Website", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, {

105


"name": "Rating", "value": "10.10", "displayName": "Rating", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CompanySource", "value": "IT SOURCE", "displayName": "CompanySource", "multivalues": null, "groupName": "CompanyType", "multivalue": false }, { "name": "CompanyRating", "value": "9", "displayName": "CompanyRating", "multivalues": null, "groupName": "CompanyType", "multivalue": false } ], "repositoryName": "COMPANY", "relationships": {}, "deleted": false }, { "productId": "record1-1", "productIdExt": "record1-1", "productKeyId": "12798", "version": "1", "state": "CONFIRMED", "isDeleted": false, "attributes": [ { "name": "PRODUCTID", "value": "record1-1", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "record1-1", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Name", "value": "TIBCO", "displayName": "Name", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Address",

106


"value": "IL USA", "displayName": "Address", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Street", "value": null, "displayName": "Street", "multivalues": [ "11th St", "Rockford" ], "groupName": "Unassigned", "multivalue": true }, { "name": "Website", "value": "https://www.google.co.in/", "displayName": "Website", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Rating", "value": "10.10", "displayName": "Rating", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CompanySource", "value": "IT SOURCE", "displayName": "CompanySource", "multivalues": null, "groupName": "CompanyType", "multivalue": false }, { "name": "CompanyRating", "value": "9", "displayName": "CompanyRating", "multivalues": null, "groupName": "CompanyType", "multivalue": false } ], "repositoryName": "COMPANY", "relationships": {}, "deleted": false } ], "totalCount": 2}

SuccessResponse

Example:


107


ErrorResponse


Example:


OR

Code: 404 Repository not found

OR



Retrieve Records by ID and IDEXTThe various details of how to retrieve root records by Record ID and ID extension. Classification is notsupported.

HTTPMethod

EndpointURL

See Endpoint

Resource /records/{repositoryName}/{id}

RequestParameters



Required

repository

Name

Name of therepository. Therepository name isnot case sensitive.

path string


path string

Optional


query string

108



To retrieverecordswhich are intheworkflow,you must usetheworkItemId

parameterwith therecordState

parameter.

query string

includeSys

temAttribu

tes


query boolean

findRootRe

cord

Set to true if youwant to find only theroot records. Thedefault value isfalse.

query boolean

recordStat

e





● DELETED:includes thedeleted records.

● ALL: includes allrecords with anystate.

query string

109


relationsh

ipDepth

Relationship depth.The defaultrelationship depthlevel is 2.


Active Specifies whether ornot the deletedrecords areretrieved. UseActive withrecordState = ALL.The valid values areY, N, and ANY. Thedefault value is Y.

● Active=Y: thedeleted recordsare not retrieved

● Active=N:deleted recordsare retrieved

● Active=ANY:either deleted ornon deletedrecords areretrieved

query string

relationsh

ipType

Type of relationship.

● FORWARD: This isthe default value.

● REVERSE

● ALL

For information onrelationships, referto the section,"Relationships" inTIBCO MDM User'sGuide.

query string

perspectiv

eName


query string


110


ResponseModel

{ "records": [ { "productId": "string", "productIdExt": "string", "productKeyId": "string", "version": "string", "state": "string", "attributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "repositoryName": "string", "relationships": { "relationshipAttributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "targetRecord": {} }, "deleted": false } ], "totalCount": 1}

RequestExample

Retrieving records by record ID and extensions where record ID is REC1 andextension is REC1in the repository named "Company".Endpoint:http://localhost:8080Resource:/eml/rest/records/Company/REC1

111


ResponseExample

The response returns all the records matching the criteria.{ "records": [ { "productId": "REC1", "productIdExt": "REC1", "productKeyId": "14004", "version": "1", "state": "CONFIRMED", "isDeleted": false, "attributes": [ { "name": "PRODUCTID", "value": "REC1", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "REC1", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Name", "value": "TIBCO", "displayName": "Name", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Address", "value": "IL USA", "displayName": "Address", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Street", "value": null, "displayName": "Street", "multivalues": [ "11th St", "Rockford" ], "groupName": "Unassigned", "multivalue": true }, { "name": "Website", "value": "https://www.google.co.in/", "displayName": "Website", "multivalues": null, "groupName": "Unassigned", "multivalue": false },

112


{ "name": "Rating", "value": "10.10", "displayName": "Rating", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CompanySource", "value": "IT SOURCE", "displayName": "CompanySource", "multivalues": null, "groupName": "CompanyType", "multivalue": false }, { "name": "CompanyRating", "value": "9", "displayName": "CompanyRating", "multivalues": null, "groupName": "CompanyType", "multivalue": false } ], "repositoryName": "COMPANY", "relationships": {"companycustomer": [ { "relationshipAttributes": [ { "name": "RCustomerType", "value": "IT", "displayName": null, "multivalues": null, "groupName": null, "multivalue": false }, { "name": "RCompanyType", "value": "IT PVT", "displayName": null, "multivalues": null, "groupName": null, "multivalue": false } ], "targetRecord": { "productId": "REC2", "productIdExt": "REC2", "productKeyId": "14005", "version": "1", "state": "CONFIRMED", "isDeleted": false, "attributes": [ { "name": "PRODUCTID", "value": "REC2", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "REC2", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, {

113


"name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CustName", "value": "daniel reichard", "displayName": "CustName", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CustAddress", "value": "UK", "displayName": "CustAddress", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "DOB", "value": "03/10/1986", "displayName": "DOB", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Salary", "value": "45000", "displayName": "Salary", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "Gender", "value": "M", "displayName": "Gender", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CustRating", "value": "7", "displayName": "CustRating", "multivalues": null, "groupName": "Unassigned", "multivalue": false } ], "repositoryName": "CUSTOMER", "relationships": {}, "deleted": false } }]}, "deleted": false }], "totalCount": 1}

SuccessResponse

Example:


114


ErrorResponse


Example:


OR


OR



Retrieve Related Records by Parent Record ID and ID ExtensionThe various details of how to retrieve related records by parent record ID and ID extension areexplained in this section.

HTTPMethod

EndpointURL

See Endpoint

Resource GET/records/{repositoryName}/{id}/relatedrecords/{relationshipName}

RequestParameters



Required

repository

Name

Name of therepository. Therepository name isnot case sensitive.

path string

relationsh

ipName

Name of therelationship. Therelationship name iscase sensitive.

path string


path string

Optional


query string

115


sortBy Column name onwhich you want tosort the data. ThesortBy works withthe ascending field.

query string

ascending Set to true if youwant to sort by theascending order. Theascending fieldworks with thesortBy field.

query boolean

perspectiv

eName


query string

recordStat

e





query string

includeSys

temAttribu

tes


query boolean


116


ResponseModel

{ "relationshipRecords": [ { "relationshipAttributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "targetRecord": { "productId": "string", "productIdExt": "string", "productKeyId": "string", "version": "string", "state": "string", "effectiveDate": "string", "attributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "repositoryName": "string", "relationships": {}, "deleted": false } } ], "totalCount": 0}

RequestExample

Retrieving records with relationship by record ID and extensions where record ID isREC1 and extension is REC1 in the repository named "Company".Endpoint:http://localhost:8080Resource:/eml/rest/records/Company/REC1/relatedrecords/companycustomer

117


ResponseExample

The response returns all the records matching the criteria.{ "relationshipRecords": [ { "relationshipAttributes": [ { "name": "RCustomerType", "value": "IT", "displayName": null, "multivalues": null, "groupName": null, "type": 4, "id": 0, "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "multivalue": false }, { "name": "RCompanyType", "value": "IT PVT", "displayName": null, "multivalues": null, "groupName": null, "type": 4, "id": 0, "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "multivalue": false } ], "targetRecord": { "productId": "REC2", "productIdExt": "REC2", "productKeyId": "12800", "version": "1", "state": "CONFIRMED", "isDeleted": false, "key": 12800, "effectiveDate": null, "attributes": [ { "name": "PRODUCTID", "value": "REC2", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "type": 4, "id": 0, "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "REC2", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "type": 4, "id": 0, "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "multivalue": false }, { "name": "CONTAINS",

118


"value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "type": 4, "id": 0, "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "multivalue": false }, { "name": "CustName", "value": "daniel reichard", "displayName": "CustName", "multivalues": null, "groupName": "Unassigned", "type": 4, "id": 0, "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "multivalue": false }, { "name": "CustAddress", "value": "UK", "displayName": "CustAddress", "multivalues": null, "groupName": "Unassigned", "type": 4, "id": 0, "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "multivalue": false }, { "name": "DOB", "value": "03/10/1986", "displayName": "DOB", "multivalues": null, "groupName": "Unassigned", "type": 1, "id": 0, "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "multivalue": false }, { "name": "Salary", "value": "45000", "displayName": "Salary", "multivalues": null, "groupName": "Unassigned", "type": 2, "id": 0, "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "multivalue": false }, { "name": "Gender", "value": "M", "displayName": "Gender", "multivalues": null, "groupName": "Unassigned", "type": 4,

119


"id": 0, "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "multivalue": false }, { "name": "CustRating", "value": "7", "displayName": "CustRating", "multivalues": null, "groupName": "Unassigned", "type": 10, "id": 0, "associationName": null, "auxiliaryContent": null, "matchingAttribute": false, "multivalue": false } ], "externalAttributes": [], "repositoryName": "CUSTOMER", "classificationSchemeDetails": null, "relationships": {}, "deleted": false } }], "totalCount": 1}

SuccessResponse

Example:


ErrorResponse


Example:


OR


OR



120


Golden Record Cache

By using the golden record cache REST service, you can search golden copy of records.

The golden record cache REST service supports the following operations:

● Search Records

● Create index

● Drop index

● Add external attributes

● Update value of external attributes

Search RecordsBy using this operation, you can search records in golden record cache.

If a repository already exists before the server startup and the preload is configured for the repository,you can query the records in the repository only when the preload is completed. If you run the searchquery midway, the following message is displayed in the response:

FC-00011=you can't search the records as preload record data for this repository is

not yet done. The current preload status is - ${current preload status}

To search or view the golden record cache record, you must have the following permissions:

● Browse Records

● View Records

For information on granting permission refer to the "Resource Security" section of the TIBCO MDMUser’s Guide.

HTTPMethod

EndpointURL

See Endpoint

Resource /fastcache/records/search

BodyParameters



Required

name Repository name onwhich the operationis to be performed

body string

productKey Value of the productkey

body long

121


attributes Name of theattributes on whichyou want to search

body string

multivalue

Attributes

Name of themultivalue attributeson which you wantto search

body string


RequestModel

{ "name": "string", "productKey": 0, "attributes": [ { "name": "string", "value": [ {} ], "operator": "string", "caseSensitive": true } ], "multivalueAttributes": { "additionalProp1": [ {} ], "additionalProp2": [ {} ], "additionalProp3": [ {} ] }, "relationships": [ { "name": "string", "count": 0, "checkExistence": true, "relationshipAttributes": [ { "name": "string", "value": [ {} ], "operator": "string", "caseSensitive": true } ] } ], "startIndex": 0, "recordCount": 0, "eventId": 0, "workitemId": 0}

122


ResponseModel

{ "records": [ { "productId": "string", "productIdExt": "string", "productKeyId": "string", "version": "string", "state": "string", "key": 0, "effectiveDate": "string", "attributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "repositoryName": "string", "classificationSchemeDetails": [ { "csName": "string", "classCode": "string", "schemeAction": "string", "classificationCodes": [ "string" ] } ], "relationships": { "relationshipAttributes": [ { "name": "string", "value": "string", "displayName": "string", "multivalues": [ {} ], "multivalue": false, "id": 0, "groupName": "string" } ], "targetRecord": {} }, "deleted": false } ], "totalCount": 0}

123


RequestExample

{ "name": "Customer", "productKey": -1, "attributes": [ { "name": "Name", "value": ["Richardson"], "operator": "lk" }, { "name": "City", "value": ["Hecoda"], "operator": "eq" } ]}

124


ResponseExample

This is the same output response of existing REST search service. The"externalAttributes" displays the list of external attributes that you havespecified.{ "records": [ { "productId": "100000100033", "productIdExt": "100000100033", "productKeyId": "10372", "version": "1", "state": "CONFIRMED", "isDeleted": false, "attributes": [ { "name": "PRODUCTID", "value": "100000100033", "displayName": "Record ID", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "PRODUCTIDEXT", "value": "100000100033", "displayName": "Record ID Extension", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CONTAINS", "value": "", "displayName": "Related Records", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "NAME", "value": "Don Richardson", "displayName": "NAME", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "CITY", "value": "Hecoda", "displayName": "CITY", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "EMAIL", "value": "[email protected]", "displayName": "EMAIL", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "STATENAME", "value": "MA", "displayName": "STATENAME", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, {

125


"name": "GENDER", "value": "Male", "displayName": "GENDER", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "PHONENUMBER", "value": "(710) 316-2846", "displayName": "PHONENUMBER", "multivalues": null, "groupName": "Unassigned", "multivalue": false }, { "name": "ZIPCODE", "value": "45044", "displayName": "ZIPCODE", "multivalues": null, "groupName": "Unassigned", "multivalue": false } ], "externalAttributes": [], "repositoryName": "CUSTOMER", "relationships": {}, "deleted": false }], "totalCount": 1}

SuccessResponse

Example:


ErrorResponse


Example:


OR

Code: 404 - Record not found

OR



Create IndexBy using this operation, you can create cache index at run time when golden record cache has beendefined and started.

HTTPMethod

EndpointURL

See Endpoint

Resource /fastcache/metadata/createIndex

126


BodyParameters


Name Description Data Type

Required

repository

Name

Repository name onwhich the operationis to be performed

string

cacheIndex

List

List of indexeswhich you want tocreate on therepository space.

List of string

indexName Name of the index string

indexType Type of index. Validvalues are HASH orTREE. To know thedifference betweenthese two types, seethe TIBCOActiveSpacesDeveloper's Guide

string

indexColum

nNames

Name of thecolumns on whichyou want to createthe index.

ActiveSpacesapplies somerestrictionswhilecreatingindex onrepositoryspace. Toknow thedetails, seethe TIBCOActiveSpacesDeveloper'sGuide

List of string


127


RequestModel

{ "repositoryName": "string", "cacheIndexList": [ { "indexName": "string", "indexType": "string", "indexColumnNames": [ "string" ] } ], "fieldsToBeAdded": [ { "name": "string", "dataType": "string" } ]}

ResponseModel

{responseMessages: [ {"code": "string","message": "string","type": "string",]"success": "boolean" } ]}]

RequestExample

{ "repositoryName": "PERSON", "cacheIndexList": [ { "indexName": "INDEX__PRODUCTID", "indexType": "HASH", "indexColumnNames": [ "PRODUCTID" ] } ], "fieldsToBeAdded": null}

ResponseExample

[ { "code": "FC-00008", "message": "Index created - INDEX__PRODUCTID", "type": "Info" }]

SuccessResponse

Example:


128


ErrorResponse


Example:


OR



Drop IndexBy using this operation, you can delete a cache index at run time when golden record cache is definedand started.

HTTPMethod

EndpointURL

See Endpoint

Resource /fastcache/metadata/dropIndex

BodyParameters



Required

repository

Name


string

cacheIndex

List

List of indexeswhich you want tocreate on therepository space.

List of string

indexName Name of the indexthat you want todelete

string


129


RequestModel

{ "repositoryName": "string", "cacheIndexList": [ { "indexName": "string", "indexType": "string", "indexColumnNames": [ "string" ] } ], "fieldsToBeAdded": [ { "name": "string", "displayName": "string", "dataType": "string" } ]}

ResponseModel


RequestExample

{ "repositoryName": "PERSON", "cacheIndexList": [ { "indexName": "INDEX__PRODUCTID" } ]}

ResponseExample

[ { "code": "FC-00008", "message": "Index dropped - INDEX__PRODUCTID", "type": "Info" }]

SuccessResponse

Example:


ErrorResponse


Example:


OR



130


Add External AttributeBy using this operation, you can create user-defined external attributes at run time when golden recordcache is defined and running.

You must specify the attribute name according to ActiveSpaces recommendation and it must not existin the repository space definition.

HTTPMethod

EndpointURL

See Endpoint

Resource /fastcache/metadata/addFields

BodyParameters



string

reposito

ryName

Repository name on which theoperation is to be performed.

string

FieldsTo

BeAdded

A map which contains the key orkey-value as an external attributename and value as its data type

Map of string

name Attribute Name string

dataType Data type of an attribute

MediaType

body

RequestModel

{ "repositoryName": "string", "cacheIndexList": [ { "indexName": "string", "indexType": "string", "indexColumnNames": [ "string" ] } ], "fieldsToBeAdded": [ { "name": "string", "displayName": "string", "dataType": "string" } ]}

131


ResponseModel


RequestExample

{ "repositoryName": ”CUSTOMER”, "fieldsToBeAdded": [ { "name": "LOYALITYPOINTS", "dataType": "LONG" }, { "name": "BONUS", "dataType": "INTEGER" } ]

ResponseExample

{ "code": "FC-00008", "message": "Field/s added successfully", "type": "Info"}

SuccessResponse

Example:


ErrorResponse


Example:


OR



The following data types are supported while adding external attributes in the golden record cacherepository. The API accepts only the MDM supported data types.

Generic Data Type Name TIBCO MDM DataTypeCorrespondingActiveSpaces Field Type

Boolean BOOLEAN BOOLEAN

DECIMAL NUMBER AMOUNT DOUBLE

The double range is2.2250738585072014E-30

8 to 1.7976931348623157e+308 so in case data is

DECIMAL

132


Generic Data Type Name TIBCO MDM DataTypeCorrespondingActiveSpaces Field Type

CUSTOM DECIMAL outside of the range, thendata may lost.

Integer INTEGER INTEGER

Long LONG LONG

Date DATE DATETIME

TIMESTAMP TIMESTAMP DATETIME

String STRING STRING

Url URL STRING

Update Value of Custom AttributeBy using this operation, you can update the value of user-defined attributes at run time when goldenrecord cache is defined and running.

You can update only the value of external attributes.

HTTPMethod

EndpointURL

See Endpoint

Resource /fastcache/record/update

RequestParameters



Required

repository

Name


body string

cacheDataL

ist

Key as an externalattribute name andvalueList is thevalue of the attribute

Map of String

productId PRODUCTID of therecord for whichexternal attributesvalues are updated

String

133


productIdE

xt

PRODUCTIDEXT of therecord for whichexternal attributesvalues are updated

String

name External attributename.

String

valueList Value of an externalattribute.

List


RequestModel

{ "productId": "string", "productIdExt": "string", "repositoryName": "string", "cacheDataList": [ { "name": "string", "valueList": [ {} ] } ]}

ResponseModel


RequestExample

{ "repositoryName": "PERSON", "productId": "1099", "productIdExt": "1099", "cacheDataList": [ { "name": "PAYBACKNUMBER", "valueList": [ 349898767 ] }, { "name": "LOYALITYPOINT", "valueList": [ 23 ] } ]}

134


ResponseExample

{ "code": "FC-00008", "message": "Fields value/s updated successfully.", "type": "Info"}

SuccessResponse

Example:


ErrorResponse


Example:


OR



135


Error Handling

The errors are returned using standard HTTP error code syntax.

HTTP Error Code Description Error Response

400 Bad Request Invalid Request { "errorCode": "string", "errorType": "string", "errorMessage": "string", "errorDetails": "string"}

400 Parameters required

are missing

The required parametersare not specified

{ "errorCode": "string", "errorType": "string", "errorMessage": "string", "errorDetails": "string"}

404 User not found User not found { "errorCode": "string", "errorType": "string", "errorMessage": "string", "errorDetails": "string"}

404 Record Not Found Record Not Found { "errorCode": "string", "errorType": "string", "errorMessage": "string", "errorDetails": "string"}

500 Internal Server Error Internal Server Erroroccurred

{ "errorCode": "string", "errorType": "string", "errorMessage": "string", "errorDetails": "string"}

500 Invalid Request Invalid request { "errorCode": "string", "errorType": "string", "errorMessage": "string", "errorDetails": "string"}

GEN-7001 Request not

readable

Request not readable { "errorCode": "GEN-7001", "errorType": "Error", "errorMessage": "Request Not Readable", "errorDetails": ""}

136


Documents

TIBCO® MDM Rest Services Guide