Informatica® Cloud Business 360 Console

July 2023

Business 360 REST API

Reference
Informatica Cloud Business 360 Console Business 360 REST API Reference
July 2023
August 2021
© Copyright Informatica LLC 2023

This software and documentation are provided only under a separate license agreement containing restrictions on use and disclosure. No part of this document may be
reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica LLC.

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial
computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such,
the use, duplication, disclosure, modification, and adaptation is subject to the restrictions and license terms set forth in the applicable Government contract, and, to the
extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License.

Informatica, Informatica Cloud, Informatica Intelligent Cloud Services, PowerCenter, PowerExchange, and the Informatica logo are trademarks or registered trademarks
of Informatica LLC in the United States and many jurisdictions throughout the world. A current list of Informatica trademarks is available on the web at https://
www.informatica.com/trademarks.html. Other company and product names may be trade names or trademarks of their respective owners.

Portions of this software and/or documentation are subject to copyright held by third parties. Required third party notices are included with the product.

The information in this documentation is subject to change without notice. If you find any problems in this documentation, report them to us at
infa_documentation@informatica.com.

Informatica products are warranted according to the terms and conditions of the agreements under which they are provided. INFORMATICA PROVIDES THE
INFORMATION IN THIS DOCUMENT "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OR CONDITION OF NON-INFRINGEMENT.

Publication Date: 2023-07-20

Table of Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Informatica Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Informatica Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Informatica Intelligent Cloud Services web site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Informatica Intelligent Cloud Services Communities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Informatica Intelligent Cloud Services Marketplace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Informatica Knowledge Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Informatica Intelligent Cloud Services Trust Center. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Informatica Global Customer Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 1: Business 360 REST API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

REST API guidelines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
REST API collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
REST API versions of the login resource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Authentication method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Session IDs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Request header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Response header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
REST API requests and responses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Read content meta . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Search API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Request body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Request response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Sample Requests. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Sample Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Filtering and sorting search results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Business entity record APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Create Master Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Read Master Record by Business ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Read Master Record by SourcePKey. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Update Master Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Update Master Record Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Read Source Records by Master Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Delete Master Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Source record API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Read Source Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Update Source Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Update Source Record Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Relationship API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Table of Contents 3
 Metadata API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Filter Relationship. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Create Relationship. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Read Relationship by Business ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Update Relationship. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Delete Relationship. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Merge API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Request body. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Request response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Sample Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Sample Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Unmerge API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Request body. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Request response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Sample Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Sample Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Search Match API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Request body. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Finding details for the request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Request response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Sample Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Sample Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Job instance API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Create Ingress Job Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Create Egress Job Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Create Match and Merge Job Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Search Job Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Read Job Instance Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Read Job Instance Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Export and import API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

4 Table of Contents
Preface
Use the Business 360 REST APIs to interact with your Informatica Intelligent Cloud Services organization
through API calls. You can use the REST APIs to perform tasks and get data from your organization.

Informatica Resources
Informatica provides you with a range of product resources through the Informatica Network and other online
portals. Use the resources to get the most from your Informatica products and solutions and to learn from
other Informatica users and subject matter experts.

Informatica Documentation
Use the Informatica Documentation Portal to explore an extensive library of documentation for current and
recent product releases. To explore the Documentation Portal, visit https://docs.informatica.com.

If you have questions, comments, or ideas about the product documentation, contact the Informatica
Documentation team at infa_documentation@informatica.com.

Informatica Intelligent Cloud Services web site

You can access the Informatica Intelligent Cloud Services web site at http://www.informatica.com/cloud.
This site contains information about Informatica Cloud integration services.

Informatica Intelligent Cloud Services Communities

Use the Informatica Intelligent Cloud Services Community to discuss and resolve technical issues. You can
also find technical tips, documentation updates, and answers to frequently asked questions.

To access the Informatica Intelligent Cloud Services Community, see

Master Data Management SaaS Community.

Developers can learn more and share tips at the Cloud Developer community:

https://network.informatica.com/community/informatica-network/products/cloud-integration/cloud-
developers

Informatica Intelligent Cloud Services Marketplace

Visit the Informatica Marketplace to try and buy Data Integration Connectors, templates, and mapplets:

https://marketplace.informatica.com/

5
 Informatica Knowledge Base
Use the Informatica Knowledge Base to find product resources such as how-to articles, best practices, video
tutorials, and answers to frequently asked questions.

To search the Knowledge Base, visit https://search.informatica.com. If you have questions, comments, or
ideas about the Knowledge Base, contact the Informatica Knowledge Base team at
KB_Feedback@informatica.com.

Informatica Intelligent Cloud Services Trust Center

The Informatica Intelligent Cloud Services Trust Center provides information about Informatica security
policies and real-time system availability.

You can access the trust center at https://www.informatica.com/trust-center.html.

Subscribe to the Informatica Intelligent Cloud Services Trust Center to receive upgrade, maintenance, and
incident notifications. The Informatica Intelligent Cloud Services Status page displays the production status
of all the Informatica cloud products. All maintenance updates are posted to this page, and during an outage,
it will have the most current information. To ensure you are notified of updates and outages, you can
subscribe to receive updates for a single component or all Informatica Intelligent Cloud Services
components. Subscribing to all components is the best way to be certain you never miss an update.

To subscribe, on the Informatica Intelligent Cloud Services Status page, click SUBSCRIBE TO UPDATES. You
can choose to receive notifications sent as emails, SMS text messages, webhooks, RSS feeds, or any
combination of the four.

Informatica Global Customer Support

You can contact a Global Support Center through the Informatica Network or by telephone.

To find online support resources on the Informatica Network, click Contact Support in the Informatica
Intelligent Cloud Services Help menu to go to the Cloud Support page. The Cloud Support page includes
system status information and community discussions. Log in to Informatica Network and click Need Help to
find additional resources and to contact Informatica Global Customer Support through email.

The telephone numbers for Informatica Global Customer Support are available from the Informatica web site
at https://www.informatica.com/services-and-training/support-services/contact-us.html.

6 Preface
Chapter 1

Business 360 REST API

Use the Business 360 REST APIs to interact with your Informatica Intelligent Cloud Services organization
through API calls. You can use the REST APIs to perform tasks and get data from your organization.

REST API guidelines

Use the following guidelines when working with the Business 360 REST APIs:

• All resources and attributes are case sensitive.

• Use the login resource to start a REST API session. The session expires after 30 minutes of inactivity.
• Use the logout resource to log out of the Business 360 session included in the request header.
• Specify the format of the request and response in the header. Use the Content-Type attribute to specify
the request format and the Accept attribute to specify the response format.
• If a request or response type is not configured, Business 360 uses JSON by default.
• For requests in XML, use an enclosing tag to define an object.
• XML responses that include a list of objects return the objects enclosed in the tag.
• For all resources except login, use a placeholder for the session ID in request headers. Replace the
placeholder with the session ID data returned when you log in to a session.
• For all resources except login, use a placeholder for the base URL. For version 2 resources, replace the
placeholder with the URL returned in the serverUrl. For version 3 resources, replace the placeholder with
the URL returned in the baseApiUrl.
• For POST requests, you must include all fields in the request object unless you submit the request in the
JSON format using partial mode. Partial mode is not applicable to most resources. By default, the REST
API uses full mode.
• Where indicated, enclose POST request attributes in the specified object. When no object is specified,
include attributes in the request body.

7
REST API collection
The API collection contains all the REST API requests that you can use to interact with MDM SaaS. You can
use this API collection to test the APIs before you deploy them to production. You can import the API
collection to any API platform and then test the APIs.

You can download the REST API collection from the following link:

Business 360 API collection

After you import the API collection into an API platform, you can authenticate the API requests. For more
information about authenticating the API requests, see “Authentication method ” on page 9.

REST API versions of the login resource

You can log in to Informatica Intelligent Cloud Services using the platform REST API version 2 or version 3
login resource.

Note: The version of any subsequent resource that you use does not need to match the version of the login
resource that you use to log in.

Note the following differences between REST API version 2 and version 3 calls:

Format

You can use the following formats depending upon which API version you use:

• Version 2 supports XML and JSON calls.

• Version 3 supports JSON calls.

Login URL

Use one of the following login URLs:

• For version 2, use https://dm-<POD region>.informaticacloud.com/ma/api/v2/user/login.

• For version 3, use https://dm-<POD region>.informaticacloud.com/saas/public/core/v3/login.

Your POD (Point of Deployment) region is based on the location of your Informatica Intelligent Cloud Services
data center. The POD region is included in the URL that you received when you registered with Informatica
Intelligent Cloud Services. For North America, use us.

Base URL

The login response includes the base URL that you must include in subsequent calls. The base URL includes
the following components:

• The name and region of the POD that your organization uses, for example, use4.dm-us.
• The Informatica Intelligent Cloud Services domain, informaticacloud.com.
• The internal service that manages the API calls, for example, saas.

The following example is a base URL for an organization on the use4.dm-us POD:
https://use4.dm-us.informaticacloud.com/saas

8 Chapter 1: Business 360 REST API

 In the login response, the attribute that provides the base URL depends on the API version that you use to log
in. For example:

• In a version 2 response, the attribute name is serverUrl.

• In a version 3 response, the attribute name is baseApiUrl.

Session ID

The login response includes a session ID that you must include in headers for subsequent requests during
this session. In the login response, the name of the session ID attribute depends on the API version that you
used to log in.
Use one of the following attributes:

• For version 2, use icSessionId in the header.

• For version 3, use sessionId in the header.

For more information about session IDs, see “Session IDs” on page 10

Authentication method
The REST APIs use the basic HTTP authentication method to authenticate users. When you first log in with
your browser, you must provide your user name and password. After successful authentication, you get the
<baseApiUrl>, which you must modify before you can make your REST API calls.

To log in and authenticate, you can use Login API V3 or Login API V2.

Login API V3

To get a session ID using Login API V3, submit the following POST request with your credentials:
POST https://dm-us.informaticacloud.com/saas/public/core/v3/login \
Accept: application/json \
Content-Type: application/json \

{
"username": "myUser",
"password": "myPassword",
}
The login response includes the session ID and base URL that you need to include in subsequent REST API
calls. Use values from the following fields:

• sessionId. A REST API session ID that you include in the header for version 3 REST API calls. The session
ID expires after 30 minutes of inactivity. After the session ID expires, log in again to continue working with
the REST API.
• baseApiUrl. The base URL that you use for subsequent requests during this session.

Login API V2

To get a session ID using Login API V2, submit the following POST request with your credentials:
POST https://dm-us.informaticacloud.com/ma/api/v2/user/login \
Accept: application/json \
Content-Type: application/json \

{
"username": "myUser",
"password": "myPassword",
}

Authentication method 9
 Use the base URL and session ID returned in the response for subsequent requests during this session. Use
the logout resource to end the session.

Modifying the baseApiUrl

When you log in, you get the following <baseApiUrl> value:
https://use4.dm-us.informaticacloud.com/saas
Modify the <baseApiUrl> value as follows:

• Remove /saas.
• Replace use4 with use4-mdm.
To make your REST API calls, use the following <baseApiUrl> value:
https://use4-mdm.dm-us.informaticacloud.com

Session IDs
Each Business 360 REST API request must be authenticated. To authenticate your requests, you must get a
session ID, and then add the session ID to the header of every request. The Informatica Intelligent Cloud
Services (IICS) Identity Service issues the session ID.

Note: If your session ID expires, log in again to get a new session ID.

To get a session ID, submit a POST request with your credentials. For more information, see “Authentication
method ” on page 9.

The response returns a session ID. For example, you might receive the following response:

{
...
"sessionId": "XXXXXXXXXXXXXXXXXXXXXX",
"sessionExpireTime": "2000-01-01T00:00:00.000Z",
...
}
To make a request, add the session ID you retrieved in to the IDS-SESSION-ID field of the request header.

The following example shows how to use a retrieved session ID in the request header:
POST https://use4.dm-us.informaticacloud.com/search/public/api/v1/search \
--header 'Accept: application/json \
--header 'Content-Type: application/json \
--header 'IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX \

{
"entityType": "Example Entity"

10 Chapter 1: Business 360 REST API

Resources
Use the Business 360 REST API resources to interact with your Informatica Intelligent Cloud Services
organization through API calls.

The following table describes the resources that you can use:

Resource Supported API Resource Description

search Search Finds records that match your search criteria across all the
business entities or within a specific business entity.

entity Create master record Creates, reads, or updates master records. Searches for
Read Master Record by Business ID source records that contribute to a master record.
Read Master Record by SourcePKey
Update Master Record (PUT)
Update Master Record (PATCH)
Read Source Records by Master Record

entity-xref Read source record Reads and updates source records.

Update Source Record (PUT)
Update Source Record (PATCH)

entity-group Merge Merges and unmerges source records and master records.
Unmerge

relationship Filter Relationship Filters, creates, reads, updates, and deletes business entity
Create Relationship relationships.
Read Relationship by Business ID
Update Relationship
Delete Relationship

jobInstance Create Ingress Mob Instance Manage ingress, egress, and match and merge jobs. Create
Create Egress Job Instance and run job instances, search for job instances, and retrieve
a short summary or the complete details of a job instance.
Create Match and Merge Job Instance
Search Job Instances
Read Job Instance Summary
Read Job instance Details

searchmatch Search Match API Use the search match API to search for matching records
based on the published match model configuration.
The required input parameters for the REST API vary based
on the business entity and selected match model.

Resources 11
Request header
Use a request header to define the operating parameters or the metadata of a REST operation.

The following table lists the request header parameters:

Parameter Description

Content-Type Format of the request body.

Accept Format of the request response. Accepts application/json.

IDS-SESSION-ID The session ID of the user. See “Session IDs” on page 10.

To construct the REST API request header for a resource, add the header parameter after the following
request line:

//<baseURL>/v1/api/

Use the following syntax to construct the REST API request header for a REST API resource:
<METHOD> https: //<baseApiURL>/business-entity/public/api/v1/<resource name>
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
For example, you might use the following request to read a business entity master record:
GET https: //<baseApiURL>/business-entity/public/api/v1/entity/c360.organization/
70046899550283630729399822719 HTTP/1.1
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

Response header
The following response header parameter applies to the GET, POST, PUT, PATCH and DELETE methods:

Parameter Description

Content-Type The format of the response body. Accepts application/json.

12 Chapter 1: Business 360 REST API

REST API requests and responses
When you make a REST API request, the REST API returns an HTTP response code.

The following table describes the responses to the REST API requests:

REST API Successful Response Failure Response

Request

GET For an information request, returns the requested object or an HTTP 403 error, including a REST
array of objects when applicable. For an action request, API error object.
returns the HTTP 200 success code. Can also return the REST
API success object.

POST The object that you created or updated. Can also return the HTTP 403 error, including a REST
HTTP 200 or 201 success codes. API error object.

PUT The object that you updated. Can also return the HTTP 201 HTTP 403 error, including a REST
success code. API error object.

DELETE The object that you deleted. Can also return the HTTP 201 HTTP 403 error, including a REST
success code. API error object.

PATCH The object that you updated. Can also return the HTTP 201 HTTP 403 error, including a REST
success code. API error object.

Read content meta

You can use the _showContentMeta parameter to retrieve the content meta of the record. The content meta
provides the trust score and survivorship configuration information. For example, you can get trust scores of
all the fields in the record.

Use the _showContentMeta parameter with the following APIs:

• Read Master Record by Business ID

• Read Master Record by SourcePKey
• Read Source Record
To get the content meta, add the _showContentMeta query parameter at the end of the REST API URI.

For example, submit a GET request with the following URI:

GET <baseApiURL>/business-entity/public/api/v1/entity/<businessEntity>/<id>?
_showContentMeta=true
The response body includes the content meta.

REST API requests and responses 13

 The following table lists the parameters that appear in the _contentMeta section of the response body:

Parameter Type Description

fieldRef String Fields that participated in the trust score calculation. The value "/"
indicates that all the fields in the record share the same trust score.

lastUpdatedDate String Date when the referenced field was last updated.

manualOverride String Specifies whether the user can manually override the trust score.

SourcePrimaryKey String The primary key of the record.

sourceSystem String Internal ID of the source system to which the record belongs.

trustRule String Survivorship configuration that identified the best value for the field. The
configuration can be rule or source ranking.

trustScore Number The current trust score of the field.

downgradeTrustScorePercent Number Percentage of trust score to downgrade when the validation fails. You can
get the downgradeTrustScorePercent parameter when you use the Read
Source Record API.

Search API
Use the search API to search for records that match your search criteria across all the business entities or
within a specific business entity. You can filter the search results based on severity levels and validation
statuses. The API uses the search resource.

Note: Effective in the May 2023 release, the ability to filter search results based on error severity levels and
validation statuses is available for preview.

Preview functionality is supported for evaluation purposes but is unwarranted and is not supported in
production environments or any environment that you plan to push to production. Informatica intends to
include the preview functionality in an upcoming release for production use, but might choose not to in
accordance with changing market or technical circumstances. For more information, contact Informatica
Global Customer Support.
To search for records, submit a POST request with the following URI:

<baseApiUrl>/search/public/api/v1/search

The response is in the JSON format.

14 Chapter 1: Business 360 REST API

Request body
You can use the following parameters in the search request body:

Note: You can use either the search or fields parameters but not both.

Parameter Type Description

search String Search string.

To retrieve all the records, use an asterisk
(*).
To perform a fuzzy search, enter a search
word or phrase. When you search for
records, you can use additional wildcard
characters, such as *, ~, &&, and ||.
You can use search strings similar to the
ones in the following examples:
- John Smith. Searches for records that
contain John Smith as a field value.
- Jo*n. Searches for records that start
with Jo and end with n, such as
Johansson or Jordan.
- Hans && Williams. Searches for
records that contain Hans and
Williams in the same record. For
example, the first name is Hans, and the
last name is Williams.
For more information about these wildcard
characters, see Using the search box to
find records in the Customer 360 help.

fields String Searches records for specific fields. For

example , searching "J*" for the first name
field returns all names starting with "J".

entityType String Internal ID of the business entity you want

to search. To search across all the
business entities, enter "*".

filters Array Specifies a list of fields that you want to

use to filter the search results.

filter > operator String The Boolean operator that joins multiple
filters that you specify. Use AND or OR as
the Boolean operator.

Search API 15
 Parameter Type Description

filters > filter > comparison operator String Condition that specifies how to filter the
search results.
Use one of the following comparison
operators:
- EQUALS
- NOT_EQUALS
- IN
- BETWEEN
- GREATER_THAN
- LESS_THAN
- GREATER_THAN_EQUAL_TO
- LESS_THAN_EQUAL_TO
- CONTAINS
- STARTS_WITH

filters > filter > fieldName String Name of the field that you want to use as
a filter.

filters > filter > fieldValue String Value that you want to use to filter the
results.
Note: You can use a partial word or value
with the STARTS_WITH or CONTAINS
comparison operators.

filters > filter > fieldValueGroups String Type of validation errors based on which
you want to filter the records. Use one of
the following values:
- WARNING. Filters records with minor
issues that might not require any
immediate fix.
- INFO. Filters records with information
that might be helpful when you add or
update values.
- ERROR.
Filters records with issues that impact
the quality of data.
- OTHERS. Filters records with issues
that can't be categorized as
information, warnings, or errors, but
affect the quality of data.

pageSize Number Number of search results to display on

each page.

pageOffset Number Optional. Number of pages to skip. For

example, pageOffset=2 means that the
search must skip the first two pages of
the search results. Default is 0.

recordsToReturn Number Number of search results to return.

recordOffset Number Number of records to skip. For example,

recordOffset=200 indicates that the
search must skip the first 200 search
results. Default is 0.

16 Chapter 1: Business 360 REST API

 Parameter Type Description

maxRecords Number Maximum number of records to return.

Note: The search cannot return more than
10,000 records per page.

sort Array Specifies a list of fields based on which

you want to sort the search results.

sort > fieldName String Name of the field by which you want to
sort the search results.

sort > order String Order in which you want to sort the search
results.
Use one of the following sort orders:
- ASCENDING
- DESCENDING

Request response
The request response returns the search results.

The following table lists the response parameters:

Parameter Type Description

searchResult Object Contains the search results.

hits Number Number of search results.

records Array Contains all the search results that are filtered and sorted based on the criteria you
specify.
Contains the vader parameter that lists the internal IDs of the failed rule associations
for search results with validation errors.

pageSize Number Number of search results on a page.

pageOffset Number Number of pages to skip. For example, pageOffset=2 means that the search must skip
the first two pages of the search results. Default is 0.

recordsToReturn Number Number of search results to return.

recordOffset Number Number of records to skip. For example, recordOffset=200 indicates that the search
must skip the first 200 search results. Default is 0.

maxRecords Number Maximum number of records to return.

Note: The search cannot return more than 10,000 records per page.

Search API 17
 The POST response includes the following meta parameters:

Parameter Type Description

score Number The current trust score of the record.

businessId String Unique identifier of the business entity record.

id String Internal ID of the record. Do not use.

businessEntity String Name of the business entity to which the record belongs.

createdBy String Name of the person who created the record.

creationDate String Date when the record was created.

updatedBy String Name of the user who last updated the record.

lastUpdateDate String Date when the master record was last updated.

type String Internal ID of the business entity to which the record belongs.

status String Indicates whether the record is active, inactive, or in pending status.
Note: This parameter is the same as the state parameter in the business entity record
APIs. For more information about the state parameter, see “Read Master Record by
Business ID ” on page 25.

Sample Requests
Request with the search parameter
You might use the following request to find all the records of the Person business entity associated with the
name Arny and the state of California:
POST https://use4-mdm.dm-us.informaticacloud.com/search/public/api/v1/search
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

{
"entityType":"c360.person",
"search":"Arny*",
"filters":{
"filter":[
{
"comparator":"EQUALS",
"fieldName":"c360person.PostalAddress.state.Name",
"fieldValue":"California"
}
]
}
}

Request with the fields parameter

You might use the following request to find all the records that start with "Jona" for the full name field:

{
"entityType": "c360.person",
"fields": {
"c360person.fullName": "Jona*"

18 Chapter 1: Business 360 REST API

 },
"filters": {
"filter": [
{
"comparator": "EQUALS",
"fieldName": "c360person.gender.Name",
"fieldValue": "Male"
}
]
}
}

Request to filter search results based on validation errors

Use the fieldValueGroups parameter to search for results based on validation errors, such as ERROR,
WARNING, INFO, or OTHERS. Use the fieldValue parameter to search for results based on validation
statuses, such as PASS or FAIL.

You might use the following request to filter records based on the error severity INFO:

{
"recordOffset": 0,
"debug": true,
"recordsToReturn": 25,
"sort": [],
"entityType": "c360.person",
"search": "*",
"pageSize": 25,
"pageOffset": 0,
"filters": {
"filter": [
{"comparator": "IN","fieldName": "validationType", "fieldValueGroups":
["INFO"]}
]},
"facets": [
{
"facetField": "validationType",
"type": "SIMPLE",
"orderField": "KEY",
"order": "ASCENDING"
}
],
"highlight": true,
"hierarchyFilters": []
}

Sample Response
When you make a search request, the response retrieves records that match your search criteria.

Response with the search parameter

The following search response contains the Person business entity record associated with the name Arny:
{
"searchResult": {
"hits": 1,
"pageSize": 25,
"pageOffset": 0,
"recordsToReturn": -1,
"recordOffset": -1,
"maxRecords": 10000,
"records": [{
"c360person.Insurance": [{
"insuranceType": {

Search API 19
 "Name": "Casualty"
}
}],
"_meta": {
"score": 13.0,
"lastUpdateDate": "1622227656589",
"businessId": "29924818400438832441125634728",
"id": "60b13ac80cabf75604b602a9",
"businessEntity": "c360.person",
"type": "c360.person",
"status": "ACTIVE"
},
"c360person.designation": "Assistant Professor",
"c360person.lastName": "Eidelburg",
"c360person.Phone": [{
"phoneNumber": "016-7658"
}],
"c360person.AlternateName": [{
"AlternateName": "Arny Eidelburg"
}],
"c360person.firstName": "Arny",
"c360person.gender": {
"Name": "Male"
},
"c360person.PostalAddress": [{
"country": {
"Name": "United States"
},
"city": "San Jose",
"postalCode": "95111",
"county": "Santa Clara",
"addressLine1": "17 W Jackson Blvd",
"state": {
"Name": "California"
}
}]
}]
}
}

Response with the fields parameter

The following search response contains all records for the full name field that start with "Jona":

{
"searchResult": {
"hits": 1,
"pageSize": 25,
"pageOffset": 0,
"recordsToReturn": -1,
"recordOffset": -1,
"maxRecords": 10000,
"records": [
{
"c360person.fullName": "Jonathon Javier Crasford",
"_meta": {
"score": 13.0,
"lastUpdateDate": "1617657132604",
"businessId": "29840506262486653401553471970",
"id": "29840506262486653401553471970",
"businessEntity": "c360.person",
"type": "c360.person",
"status": "ACTIVE"
},
"c360person.designation": "Analyst Programmer",
"c360person.lastName": "Crasford",
"c360person.Phone": [
{
"phoneNumber": "298-9816"
}

20 Chapter 1: Business 360 REST API

 ],
"c360person.AlternateName": [
{
"AlternateName": "Ferrel Vannah"
}
],
"c360person.firstName": "Jonathon",
"c360person.gender": {
"Name": "Male"
},
"c360person.PostalAddress": [
{
"country": {
"Name": "United States"
},
"city": "Los Angeles",
"postalCode": "90006",
"county": "Los Angeles",
"addressLine1": "5 Tomahawk Dr",
"state": {
"Name": "California"
}
}
]
}
]
}
}

Response with search results containing validation errors

When a record contains validation errors, the vader parameter lists the internal IDs of the failed rule
associations.

The following sample response contains results with validation errors:

{
"searchResult": {
"hits": 1,
"pageSize": 25,
"pageOffset": 0,
"recordsToReturn": 25,
"recordOffset": 0,
"maxRecords": 10000,
"records": [
{
"_cm": {
"vader": {
"fail": [
{
"provider": "mdm-business-entity",
"rule": [
{
"id": "No__1684296876217"
},
{
"id": "maxi10_1684296925529"
},
{
"id": "specialchar_1684296977124"
}
]
}
]
}
},
"_meta": {
"score": 5.1987,
"updatedBy": "c360_delta_mrel1s1_16may",

Search API 21
 "createdBy": "c360_delta_mrel1s1_16may",
"lastUpdateDate": "1684297607665",
"businessId": "MDM00000000000",
"id": "MDM00000000000",
"businessEntity": "c360.person",
"type": "c360.person",
"creationDate": "1684297607665",
"states": {
"validation": "FAILED"
},
"status": "ACTIVE"
},
"c360person.middleName": "#",
"c360person.lastName": "uuuuuuuuuuu",
"c360person.firstName": "Delta@"
}
}
}

Filtering and sorting search results

When you submit a search request, you can specify how to filter and search the search results.

The following table lists the predefined fields you can use to filter and sort the search results:

Business Filter by Sort by

Entity

Person - c360person.gender.Name - c360person.firstName

- c360person.PostalAddress.city - c360person.lastName
- c360person.PostalAddress.country.Name - c360person.designation
- c360person.PostalAddress.state.Name - c360person.gender.Name
- c360person.AlternateName.AlternateName
- c360person.PostalAddress.addressLine1
- c360person.PostalAddress.city
- c360person.PostalAddress.county
- c360person.PostalAddress.country.Name
- c360person.PostalAddress.state.Name
- c360person.PostalAddress.postalCode
- c360person.Phone.phoneNumber

Organization - c360organization.companyType.Name - c360organization.name

- c360organization.PostalAddress.city - c360organization.companyType.Name
- c360organization.PostalAddress.country.Name - c360organization.PostalAddress.addressLine1
- c360organization.PostalAddress.state.Name - c360organization.PostalAddress.country.Name
- c360organization.PostalAddress.state.Name
- c360organization.PostalAddress.city
- c360organization.PostalAddress.county
- c360organization.PostalAddress.postalCode
- c360organization.PhoneCommunication.phoneNumber
- c360organization.AlternateName.name
- c360organization.Segment.segmentType.Name

22 Chapter 1: Business 360 REST API

Business entity record APIs
Use the business entity record APIs to read, create, or update business entity master records. These APIs use
the entity resource.

Note: Effective in the July 2023 release, the response of the read master record by business ID and read
master record by SourcePKey APIs include the validation statuses that are available for preview. Preview
functionality is supported for evaluation purposes but is unwarranted and is not supported in production
environments or any environment that you plan to push to production. Informatica intends to include the
preview functionality in an upcoming release for production use, but might choose not to in accordance with
changing market or technical circumstances. For more information, contact Informatica Global Customer
Support.

Create Master Record

Use the Create Master Record API to create a master record for a business entity.

The API supports the POST method.

POST request
To create a business entity master record, submit a POST request with the following URI:
POST <baseApiURL>/business-entity/public/api/v1/entity/<businessEntity>?
sourceSystem=<sourceSystem>[&sourcePKey=<pkey>][&_resolveCrosswalk=true|false]
The following table lists the parameters that you can use in the URI:

Name Description

businessEntity Internal ID of the business entity for which you want to create a master
record.

sourceSystem Internal ID of the source system to which the record belongs.

sourcePKey The primary key of the source record.

_resolveCrosswalk Indicates whether to standardize picklist values based on the source system
configuration.
To standardize the picklist values, set to true. If set to true, ensure that the
picklist values belong to a code list that's part of a crosswalk.
Default is false.
For more information about standardizing picklist values, see Define Source
Systems.

You must include the record details in the request body.

If a business entity field in a field group has a data quality rule, specify the _id parameter value for the field
group entry that you create. For example, if the Postal Code field in the Address field group has a data quality
rule, specify an ID for an address entry that you create.

For more information about data quality rules, see Configure Data Quality.

POST response
The response is in the JSON format. The response shows the HTTP 200 OK response code and retrieves the
business ID of the record you created. When you submit a REST API request to create a record, Business 360

Business entity record APIs 23

 verifies your existing user role permissions and the approval workflow configuration. The response indicates
whether a data steward must approve the records you created.

POST example
You might use the following request to create a master record for the c360.organization business entity:
POST <baseApiUrl>/business-entity/public/api/v1/entity/c360.organization?
sourceSystem=c360.default.system&sourcePKey=pkey910&_resolveCrosswalk=true
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

"firstName": "Lewis",
"lastName": "Hamilton",
"middleName": "Decay",
"PostalAddress": [
{
"_id": "3d4a8f4d07cb4f0db9ea1be9bf8d27e8",
"defaultIndicator": true,
"addressType": {
"Name": "Home",
"Code": "Home"
},
"usageType": {
"Name": "Home",
"Code": "Home"
},
"addressStatus": {
"Name": "Active",
"Code": "Active"
},
"addressLine1": "789456, park road",
"country": {
"Name": "United States",
"Code": "US"
},
"state": {
"Name": "California",
"Code": "CA"
},
"city": "California"
}
],
"Phone": [
{
"_id": "f142a11b916c4a1b8239466f15852",
"phoneUsageType": {
"Name": "Home",
"Code": "Home"
},
"phoneType": {
"Name": "Mobile",
"Code": "Mobile"
},
"phoneNumber": "9900202777"
}
],
"_contentMeta": {
"trust": {
"fieldData": [
{
"fieldRef": "/",
"sourceLastUpdateDate": 1654058410000
},
{
"fieldRef": "PostalAddress[3d4a8f4d07cb4f0db9ea1be9bf8d27e8]",
"sourceLastUpdateDate": 1654058410000
},

24 Chapter 1: Business 360 REST API

 {
"fieldRef": "Phone[f142a11b916c4a1b8239466f15852]",
"sourceLastUpdateDate": 1654839671000
}
]

}
}
}

If no approval workflow is configured, you get the following response:

HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired":false,
"id":"30021813492832022246278776088",
"businessId:"30021813492832022246278776088"
}
If the approval workflow is configured, you get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired":true,
"id":"30021813492832022246278776088",
"businessId:"30021813492832022246278776088"
}
Note: You might use the business ID to retrieve the business entity master record. For more information, see
“Read Master Record by Business ID ” on page 25.

Read Master Record by Business ID

Use the Read Master Record by Business ID API to retrieve the active business entity master record based on
the business ID of the record.

Before you begin, you must know the business ID of the record. To get the business ID of a record, you can
submit a search request.

The API supports the GET method.

GET request
To retrieve a business entity master record, submit a GET request with the following URI:
GET <baseApiURL>/business-entity/public/api/v1/entity/<businessEntity>/<businessId>
The GET request contains the following parameters that you can use in the URI:

Name Description

businessEntity Internal ID of the business entity from which you want to retrieve the master record.

businessId Unique identifier of the business entity record.

GET response
The response is in the JSON format. The response body contains the business entity master record data.

Business entity record APIs 25

 The GET response includes the following _meta parameters:

Name Type Description

businessId String Unique identifier of the business entity record.

id String Unique identifier of the business entity record. Do not use.

businessEntity String Internal ID of the business entity from which you retrieved the master record.

createdBy String Name of the person who created the record.

creationDate String Date when the record was created.

updatedBy String Name of the user who last updated the record.

lastUpdateDate String Date when the master record was last updated.

state String Indicates whether the record is active, inactive, or in pending state.
Note: This parameter is the same as the status parameter in the search API. For more
information about the status parameter, see “Request response ” on page 17.

validation String Indicates the validation status of the record.

The record can have one of the following statuses:
- PENDING. Indicates that the record is not yet validated.
- PASSED. Indicates that the record is validated and has no errors.
- FAILED. Indicates that the record is validated and has validation and data quality errors.

GET examples
You might use the following request to retrieve the active master record based on the business ID
30021755350133630729399872184:
GET <baseApiURL>/business-entity/public/api/v1/entity/c360.organization/
30021755350133630729399872184 HTTP/1.1
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
Content-Type: application/json
The sample response shows the HTTP 200 OK response code and retrieves the business entity master record
that matches the specified business ID.
{
"name": "NewElectronics",
"numberOfEmployees": 12,
"companyType": {
"Code": "Chartered",
"Name": "Chartered"
},
"dateOfIncorporation": "2021-06-01",
"TaxDetail": [
{
"_id": "610169fa9f45df408e8caab7",
"taxNumberType": {
"Code": "ITIN",
"Name": "Individual Taxpayer Identification Number"
},
"taxNumber": "12"
}
],
"_meta": {
"businessId": "30021755350133630729399872184",
"id": "30021755350133630729399872184",
"businessEntity": "c360.organization",

26 Chapter 1: Business 360 REST API

 "createdBy": "bejoyjacob",
"creationDate": 1627482617102,
"updatedBy": "iansmith,
"lastUpdateDate": 1627482617102,
"state": "ACTIVE"
}
}
To get the content meta, add _showContentMeta=true at the end of the request URL. You might use the
following request to retrieve the Person business entity master record with the business ID
30031351063540315477991729267:
GET master-/business-entity/public/api/v1/entity/c360.person/
30031351063540315477991729267?_showContentMeta=true
The sample response shows the HTTP 200 OK response code and retrieves the business entity master record
that matches the specified business ID. The response shows the content metadata in the _contentMeta
section.
{
"PhoneCommunication": [
{
"_id": "pkeyPhone03",
"phoneNumber": "9900201000",
"phoneType": {
"Code": "Cell",
"Name": "Cell"
}
}
],
"PostalAddress": [
{
"_id": "padd061",
"addressLine1": "Bagmane Tech Park",
"addressLine2": "CV Raman Nagar",
"addressLine3": "Bengaluru",
"city": "Bangalore",
"country": {
"Code": "US",
"Name": "United States"
},
"state": {
"Code": "AK",
"Name": "Alaska"
}
}
],
"name": "Informatica",
"numberOfEmployees": 5555,
"_meta": {
"id": "MDM0000005CWG0",
"businessId": "MDM0000005CWG0",
"businessEntity": "c360.organization",
"createdBy": "c360_delta_automation_org_Target",
"creationDate": 1662452659261,
"updatedBy": "c360_delta_automation_org_Target",
"lastUpdateDate": 1662452659261,
"states": {
"base": "ACTIVE",
"consolidation": "MATCH_INDEXED",
"searchIndex": "SEARCH_DIRTY"
},
"sourceSystem": "sals_bid",
"sourcePrimaryKey": "pkey190",
"xrefType": "DATA"
},
"_contentMeta": {
"trust": {
"updateCount": 1,

Business entity record APIs 27

 "fieldData": [
{
"fieldRef": "PostalAddress[padd061]",
"lastUpdatedDate": 1662452659261,
"downgradeTrustScorePercent": 0.0,
"sourceLastUpdatedDate": 1656996071000
},
{
"fieldRef": "PhoneCommunication[pkeyPhone03]",
"lastUpdatedDate": 1662452659261,
"downgradeTrustScorePercent": 0.0,
"sourceLastUpdatedDate": 1657428071000
},
{
"fieldRef": "/",
"lastUpdatedDate": 1662452659261,
"downgradeTrustScorePercent": 0.0,
"sourceLastUpdatedDate": 1657428071000
}
]
}
}
}

For more information about content metadata, see “Read content meta ” on page 13.

Read Master Record by SourcePKey

Use the Read Master Record by SourcePKey API to retrieve an active business entity master record
associated with a particular source system and the primary key.

The API supports the GET method.

GET request
To retrieve a business entity master record, submit a GET request with the following URI:
GET <baseApiURL>/business-entity/public/api/v1/entity/<businessEntity>/<sourceSystem>/
<sourcePKey>
The GET request contains the following parameters that you can use in the URI:

Parameter Description

businessEntity Internal ID of the business entity for which you want to retrieve the master record.

sourceSystem Internal ID of the source system to which the record belongs.

sourcePKey The primary key of the source record.

GET response
The response is in the JSON format. The response body contains the business entity master record data.

28 Chapter 1: Business 360 REST API

The GET response includes the following _meta parameters:

Name Type Description

businessId String Unique identifier of the business entity record.

id String Unique identifier of the business entity record. Do not use.

businessEntity String Internal ID of the business entity from which you retrieved the master record.

createdBy String Name of the person that created the record.

creationDate String Date when the record was created.

updatedBy String Name of the person that updated the record.

lastUpdateDate String Date when the record was last updated.

state String Indicates whether the record is active, inactive, or in pending state.
Note: This parameter is the same as the status parameter in the search API. For more
information about the status parameter, see “Request response ” on page 17.

validation String Indicates the validation status of the record.

The record can have one of the following statuses:
- PENDING. Indicates that the record is not yet validated.
- PASSED. Indicates that the record is validated and has no errors.
- FAILED. Indicates that the record is validated and has validation and data quality errors.

GET examples
You might use the following request to retrieve the business entity master record associated with the
c360.default.system source system and the ex60dd654d2d1dce73a206edd2 primary key:
GET <baseApiURL>/business-entity/public/api/v1/entity/c360.organization/
c360.default.system/ex60dd654d2d1dce73a206edd2 HTTP/1.1
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
Content-Type: application/json
The following sample response shows the active master record that matches the specified source name and
sourcePKey:
HTTP/1.1 200 OK
IDS-SESSION-ID: sessionID
Content-Type: application/json

{
"name": "NewElectronics",
"numberOfEmployees": 12,
"companyType": {
"Code": "Chartered",
"Name": "Chartered"
},
"dateOfIncorporation": "2021-06-01",
"TaxDetail": [
{
"_id": "610169fa9f45df408e8caab7",
"taxNumberType": {
"Code": "ITIN",
"Name": "Individual Taxpayer Identification Number"
},
"taxNumber": "12"
}
],

Business entity record APIs 29

 "_meta": {
"businessId": "30021755350133630729399872184",
"id": "30021755350133630729399872184",
"businessEntity": "c360.organization",
"createdBy": "bejoyjacob",
"creationDate": 1627482617102,
"updatedBy": "iansmith",
"lastUpdateDate": 1627482617102,
"state": "ACTIVE"
}
}
To get the content metadata, add _showContentMeta=true at the end of the request URL. You might use the
following request to retrieve the active master record for the Person business entity, which is associated with
the c360.default.system source system and the 610959f149cba67ca253a872 primary key:
GET <baseApiURL>/business-entity/public/api/v1/entity-xref/c360.person/
c360.default.system/610959f149cba67ca253a872?_showContentMeta=true
The sample response shows the HTTP 200 OK response code and retrieves the active master record that
matches the specified source name and sourcePKey. The response shows the content metadata in the
_contentMeta section.
{
"firstName":"Bhavani",
"lastName":"Shankar",
"fullName":"Bhavani Shankar",
"prefixName":{
"Code":"Dr.",
"Name":"Dr."
},
"suffixName":{
"Code":"II",
"Name":"II"
},
"title":"MR",
"designation":"QA",
"PostalAddress":[
{
"_id":"1ebb60fbf93d41518f86f79f7211c3be",
"addressType":{
"Code":"Billing",
"Name":"Billing"
},
"usageType":{
"Code":"Business",
"Name":"Business"
},
"addressStatus":{
"Code":"Active",
"Name":"Active"
},
"addressLine1":"Ali",
"country":{
"Code":"IN",
"Name":"India"
},
"state":{
"Code":"KA",
"Name":"Karnataka"
}
}
],
"_meta":{
"businessId": "30031351063540315477991729267",
"id":"30031351063540315477991729267",
"businessEntity":"c360.person",
"createdBy":"bejoyjacob",
"creationDate":1628002796882,

30 Chapter 1: Business 360 REST API

 "updatedBy":"iansmith",
"lastUpdateDate":1628002796882,
"state":"ACTIVE"
},
"_contentMeta":{
"trust":{
"fieldData":[
{
"fieldRef":"lastName",
"lastUpdatedDate":1628002796882,
"manualOverride":false,
"sourcePrimaryKey":"610959f149cba67ca253a872",
"sourceSystem":"c360.default.system",
"trustRule":"SourceRanking",
"trustScore":1.0
},
{
"fieldRef":"prefixName",
"lastUpdatedDate":1628002796882,
"manualOverride":false,
"sourcePrimaryKey":"610959f149cba67ca253a872",
"sourceSystem":"c360.default.system",
"trustRule":"Decay",
"trustScore":0.9
},
{
"fieldRef":"/",
"lastUpdatedDate":1628002796882,
"manualOverride":false,
"sourcePrimaryKey":"610959f149cba67ca253a872",
"sourceSystem":"c360.default.system",
"trustRule":"SourceRanking",
"trustScore":1.0
}
]
}
}
}
For more information about content metadata, see “Read content meta ” on page 13.

Update Master Record

Use the Update Master Record API to update an existing business entity record based on the business ID that
you specify.

The API supports the PUT method.

PUT request
To update a business entity master record associated with a business ID, submit a PUT request with the
following URI:
PUT <baseApiURL>/business-entity/public/api/v1/entity/<businessEntity>/<businessId>?
sourceSystem=<sourceSystem>[&_resolveCrosswalk=true|false]
The PUT request contains the following parameters that you can use in the URI:

Parameter Description

businessEntity Internal ID of the business entity for which you want to update the master record.

businessId Unique identifier of the business entity record.

Business entity record APIs 31

 Parameter Description

sourceSystem Internal ID of the source system to which the record belongs.

_resolveCrosswalk Indicates whether to standardize picklist values based on the source system
configuration.
To standardize the picklist values, set to true. If set to true, ensure that the picklist
values belong to a code list that's part of a crosswalk.
Default is false.
For more information about standardizing picklist values, see Define Source
Systems.

If a business entity field in a field group has a data quality rule, specify the _id parameter value for the field
group entry that you create. For example, if the Postal Code field in the Address field group has a data quality
rule, specify an ID for an address entry that you create.

For more information about data quality rules, see Configure Data Quality.

PUT response
The response is in the JSON format. The PUT response returns HTTP 200 success code. When you submit a
REST API request to update a record, Business 360 verifies your existing user role permissions and the
approval workflow configuration. The response indicates whether a data steward must approve the records
you updated.

PUT examples
The following request updates a master record for the c360.organization business entity:
PUT <baseApiUrl>/business-entity/public/api/v1/entity/c360.organization/
30135099501325521983619650821?sourceSystem=c360.default.system&_resolveCrosswalk=true
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

{
"name": "NewElectronics",
"numberOfEmployees": 12,
"companyType": {
"Code": "Chartered"
},
"dateOfIncorporation": "2021-06-01",
"TaxDetail": [
{
"taxNumberType": {
"Code": "ITIN"
},
"taxNumber": "12"
}
]
}
}
If no approval workflow is configured, you get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired":false
}
If the approval workflow is configured, you get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

32 Chapter 1: Business 360 REST API

 {
"approvalRequired":true
}

Update Master Record Field

Use the Update Master Record API to add, replace, or remove a field in an existing business entity record
based on the business ID that you specify.

The API supports the PATCH method.

PATCH request
To update a business entity master record associated with a business ID, submit a PATCH request with the
following URI:
PATCH <baseApiURL>/business-entity/public/api/v1/entity/<businessEntity>/<businessId>?
sourceSystem=<sourceSystem>[&_resolveCrosswalk=true|false]
The PATCH request contains the following parameters that you can use in the URI:

Parameter Description

businessEntity Internal ID of the business entity for which you want to

update the master record.

businessId Unique identifier of the business entity record.

sourceSystem Internal ID of the source system to which the record

belongs.

_resolveCrosswalk Indicates whether to standardize picklist values based on

the source system configuration.
To standardize the picklist values, set to true. If set to
true, ensure that the picklist values belong to a code list
that's part of a crosswalk.
Default is false.
For more information about standardizing picklist values,
see Define Source Systems.

The PATCH request body includes the following parameters:

Parameter Description

op The operator that indicates the type of update. You can specify the following operators:
- add. Adds new data to the record.
- replace. Replaces the existing data.
- remove. Removes the data from the record.

path The name of the field you want to update.

Note: If the field contains multiple values, specify the name and the internal ID of the field. For example,
the Postal Address field contains multiple values.

value Contains the values that you want to use to update the record.

Business entity record APIs 33

 PATCH response
The response is in the JSON format. The PATCH response returns HTTP 200 success code. When you submit
a REST API request to update a record, Business 360 verifies your existing user role permissions and the
approval workflow configuration. The response indicates whether a data steward must approve the records
you updated.

PATCH examples
The following request updates the first name of a person to Marko:
PATCH <baseApiUrl>/business-entity/public/api/v1/entity/c360.person/
30007167057089073281821852231?sourceSystem=c360.default.system&_resolveCrosswalk=true
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

[
{
"op":"replace",
"path":"firstName",
"value":"Marko"
}
]
The following request adds a postal address, replaces a postal address, and removes a postal address:
[{
"op": "add",
"path": "PostalAddress",
"value": {
"_id": "60f01672b9bac05632a3111111",
"addressLine1": "Nikola Tesla Avenue",
"country": {
"Code": "US",
"Name": "America"
},
"state": {
"Code": "CA",
"Name": "California"
}
}
},
{
"op": "replace",
"path": "PostalAddress[1ebb60fbf93d41518f86f79f7211c3be]",
"value": {
"_id": "1ebb60fbf93d41518f86f79f7211c3be",
"addressLine1": "Cambie Street",
"country": {
"Code": "US",
"Name": "America"
}
}
},
{
"op": "remove",
"path": "PostalAddress[60f01672b9bac05632a3d522]"
}
]
If no approval workflow is configured, you get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired":false
}

34 Chapter 1: Business 360 REST API

 If the approval workflow is configured, you get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired":true
}

Read Source Records by Master Record

Use the Read Source Records by Master Record API to identify all the source records that contribute to a
master record.

Before you begin, you must know the business ID of the master record. To get the business ID of a master
record, you can submit a search request.

The API supports the GET method.

GET request
To get the source records that contribute to a master record, submit a GET request with the following URI:
GET <baseApiURL>/business-entity/public/api/v1/entity-member/<businessEntity>/
<businessId>
The GET request contains the following parameters that you can use in the URI:

Parameter Description

businessEntity Internal ID of the business entity to which the master record belongs.

businessId Unique identifier of the master record whose source records you want to retrieve.

GET response
The response is in the JSON format. The response body contains the source records that contribute to the
specified master record.

Name Type Description

sourcePKey String Primary source key of the source record.

sourceSystem String Unique identifier of the source system for the source record.

GET examples
You might use the following request to retrieve the business entity source member records based on the
business ID MDM0000007QMV4:
GET <baseURL>/business-entity/public/api/v1/entity-member/c360.person/
MDM0000007QMV4
The sample response retrieves the source records that contribute to the master record that matches the
specified business ID.
{
"content": [
{
"sourcePKey": "ex62854adaf03192610b6ad9c0",
"sourceSystem": "c360.default.system"
},

Business entity record APIs 35

 {
"sourcePKey": "ex628547194fa64531c105625f",
"sourceSystem": "c360.default.system"
},
{
"sourcePKey": "001",
"sourceSystem": "microsoft"
},
{
"sourcePKey": "ex628549c94fa64531c105631c",
"sourceSystem": "c360.default.system"
},
{
"sourcePKey": "001",
"sourceSystem": "salesforce"
}
]
}

Delete Master Record

Use the Delete Master Record API to delete a business entity master record based on the business ID of the
record.

The API supports the DELETE method.

DELETE request
To delete a business entity master record, submit a DELETE request with the following URI:
DELETE <baseApiURL>/business-entity/public/api/v1/entity/<businessEntity>/<businessId>?
sourceSystem=<source_system>

The DELETE request contains the following parameters:

Parameter Description

businessEntity Internal ID of the business entity from which you want to delete the master record.

businessId Unique identifier of the master record.

sourceSystem Internal ID of the source system to which the record belongs.

DELETE response
The DELETE response returns the HTTP 200 success code. When you submit a REST API request to delete a
record, Business 360 Console verifies your existing user role permissions and the approval workflow
configuration. The response indicates whether the deletion requires approval.

If no approval workflow is configured for your user role, you get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired":false
}
If an approval workflow is configured for your user role, you get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

36 Chapter 1: Business 360 REST API

 "approvalRequired":true
}

Source record API

Use the source record API to read a source record based on the business entity, source system, and the
primary key. The API uses the entity-xref resource.

Read Source Record

Use the Read Source Record API to retrieve a business entity source record based on the source system and
the primary key of the record that you specify.

The API supports the GET method.

GET request
To retrieve a source record, submit a GET request with the following URI:
GET <baseApiURL>/business-entity/public/api/v1/entity-xref/<businessEntity>/
<sourceSystem>/<sourcePKey>
The GET request contains the following parameters:

Parameter Description

businessEntity Internal ID of the business entity for which you want to retrieve the source record.

sourceSystem Internal ID of the source system to which the record belongs.

sourcePKey The primary key of the source record.

GET response
The response is in the JSON format. The response body contains the business entity source record data.

The GET response includes the following _meta parameters:

Parameter Type Description

businessId String Unique identifier of the business entity record.

id String Unique identifier of the business entity record. Do not use.

businessEntity String Internal ID of the business entity from which you retrieved the master record.

createdBy String Name of the person that created the record.

creationDate String Date when the record was created.

updatedBy String Name of the user who last updated the record.

Source record API 37

 Parameter Type Description

lastUpdateDate String Date when the master record was last updated.

sourceLastUpdatedDate String Date when the source record was last updated.

states String The different statuses of the active source record.

Source records can have the following statuses:
- base. The current status of the source record. The base value is ACTIVE.
- consolidation. The status of the source record in the match and merge process.
- MATCH_DIRTY. Indicates that the source record is a new record that didn't
undergo the match process.
- MATCH_INDEXED. Indicates that the record is indexed and can be matched.
During indexing, match candidates are generated for use in the match
process.
- MATCHED. Indicates that the record is matched and ready to be merged.
- CONSOLIDATED. Indicates that the source record is merged, determined to
be unique, and represents the best version of the truth.
- searchIndex. Indicates that the record is in a SEARCH_DIRTY state and is not
searchable. In the current release, source records are not searchable.
- validation. Indicates the validation status of the record.
- PENDING. Indicates that the record is not yet validated.
- PASSED. Indicates that the record is validated and has no errors.
- FAILED. Indicates that the record is validated and has validation and data
quality errors.
Note: Effective in the May 2023 release, validation statuses are available for
preview. Preview functionality is supported for evaluation purposes but is
unwarranted and is not supported in production environments or any environment
that you plan to push to production. Informatica intends to include the preview
functionality in an upcoming release for production use, but might choose not to
in accordance with changing market or technical circumstances. For more
information, contact Informatica Global Customer Support.

GET examples
You might use the following request to retrieve the source record for the Person business entity associated
with the c360.default.system source system and the primary key 611d13e9e6dbd16ffa69a143:
GET <baseApiUrl>/business-entity/public/api/v1/entity-xref/c360.person/
c360.default.system/611d13e9e6dbd16ffa69a143 HTTP/1.1
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
Content-Type: application/json
The GET response returns HTTP 200 success code and retrieves the matching source record.
HTTP/1.1 200 OK
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
Content-Type: application/json

{
"firstName":"john",
"lastName":"hedge",
"fullName":"john hedge",
"prefixName":{
"Code":"Dr.",
"Name":"Dr."
},
"_meta":{
"businessId":"30007199962170814218819710935",
"id":"30007199962170814218819710935",
"businessEntity":"c360.person",
"createdBy":"bejoyjacob",
"creationDate":1626693564993,

38 Chapter 1: Business 360 REST API

 "updatedBy":"iansmith",
"lastUpdateDate":1626694724610,
"states":{
"base":"ACTIVE",
"consolidation":"MATCH_INDEXED",
"searchIndex":"SEARCH_DIRTY"
},
"sourceSystem":"c360.default.system",
"sourcePrimaryKey":"611d13e9e6dbd16ffa69a143",
"xrefType":"DATA"
}
}
To get the content metadata, add _showContentMeta=true at the end of the request URL. You might use the
following request to retrieve the source record for the Person business entity, which is associated with the
c360.default.system source system and the 610959f149cba67ca253a872 primary key:
GET <baseApiUrl>/business-entity/public/api/v1/entity-xref/c360.person/
c360.default.system/610959f149cba67ca253a872?_showContentMeta=true
The sample response shows the HTTP 200 OK response code and retrieves the source record that matches
the specified source name and sourcePKey. The response shows the content metadata in the _contentMeta
section.
{
"PhoneCommunication": [
{
"_id": "pkeyPhone03",
"phoneNumber": "9900201000",
"phoneType": {
"Code": "Cell",
"Name": "Cell"
}
}
],
"PostalAddress": [
{
"_id": "padd061",
"addressLine1": "Bagmane Tech Park",
"addressLine2": "CV Raman Nagar",
"addressLine3": "Bengaluru",
"city": "Bangalore",
"country": {
"Code": "US",
"Name": "United States"
},
"state": {
"Code": "AK",
"Name": "Alaska"
}
}
],
"name": "Informatica",
"numberOfEmployees": 5555,
"_meta": {
"id": "MDM0000005CWG0",
"businessId": "MDM0000005CWG0",
"businessEntity": "c360.organization",
"createdBy": "c360_delta_automation_org_Target",
"creationDate": 1662452659261,
"updatedBy": "c360_delta_automation_org_Target",
"lastUpdateDate": 1662452659261,
"states": {
"base": "ACTIVE",
"consolidation": "MATCH_INDEXED",
"searchIndex": "SEARCH_DIRTY"
},
"sourceSystem": "sals_bid",
"sourcePrimaryKey": "pkey190",

Source record API 39

 "xrefType": "DATA"
},
"_contentMeta": {
"trust": {
"updateCount": 1,
"fieldData": [
{
"fieldRef": "PostalAddress[padd061]",
"lastUpdatedDate": 1662452659261,
"downgradeTrustScorePercent": 0.0,
"sourceLastUpdatedDate": 1656996071000
},
{
"fieldRef": "PhoneCommunication[pkeyPhone03]",
"lastUpdatedDate": 1662452659261,
"downgradeTrustScorePercent": 0.0,
"sourceLastUpdatedDate": 1657428071000
},
{
"fieldRef": "/",
"lastUpdatedDate": 1662452659261,
"downgradeTrustScorePercent": 0.0,
"sourceLastUpdatedDate": 1657428071000
}
]
}
}
}

For more information about content meta, see “Read content meta ” on page 13.

Update Source Record

Use the Update Source Record API to update a business entity source record based on the source system
and the primary key of the record that you specify.

The API supports the PUT method.

PUT request
To update a source record, submit a PUT request with the following URI:
PUT <baseApiURL>/business-entity/public/api/v1/entity-xref/<businessEntity>/
<sourceSystem>/<sourcePKey>[?_forceUpdate=true|false][&_resolveCrosswalk=true|false]
[&notReadyForMatch=true|false]
The PUT request contains the following parameters:

Parameter Description

businessEntity Internal ID of the business entity for which you want to update the source
record.

sourceSystem Internal ID of the source system to which the source record belongs.

sourcePKey The primary key of the source record.

_forceUpdate Specifies whether to force update existing records irrespective of their source
last updated dates. Default is false.

40 Chapter 1: Business 360 REST API

 Parameter Description

_resolveCrosswalk Indicates whether to standardize picklist values based on the source system
configuration.
To standardize the picklist values, set to true. If set to true, ensure that the
picklist values belong to a code list that's part of a crosswalk.
Default is false.
For more information about standardizing picklist values, see Define Source
Systems.

notReadyForMatch Specifies whether a source record can participate in the match process.
Default is false.

PUT response
The response is in the JSON format. The PUT response returns HTTP 200 success code. When you submit a
REST API request to update a source record, Business 360 verifies your existing user role permissions and
the approval workflow configuration. The response indicates whether a data steward must approve the
source records you updated.

PUT example
The following request force updates a record that belongs to the Person business entity associated with the
c360.default.system source system:
PUT <baseApiUrl>/business-entity/public/api/v1/entity-xref/c360.person/
c360.default.system/pkey600?
_forceUpdate=true&_resolveCrosswalk=true&notReadyForMatch=true
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
{
"firstName":"john",
"lastName":"smith",
"middleName":"hedge",
"title":"F1 Driver",
"designation":"Aston Martin",
"PostalAddress":[
{
"_id":"0dec181346114a6196d1313ca135bcee",
"defaultIndicator":true,
"addressType":{
"Name":"Home",
"Code":"Home"
},
"usageType":{
"Name":"Home",
"Code":"Home"
},
"addressStatus":{
"Name":"Active",
"Code":"Active"
},
"addressLine1":"7777, park road",
"country":{
"Name":"United States",
"Code":"US"
},
"state":{
"Name":"California",
"Code":"CA"
},
"city":"BLR"
},
{

Source record API 41

 "_id":"1dec181346114a6196d1313ca135bcee",
"defaultIndicator":true,
"addressType":{
"Name":"Home",
"Code":"Home"
},
"usageType":{
"Name":"Home",
"Code":"Home"
},
"addressStatus":{
"Name":"Active",
"Code":"Active"
},
"addressLine1":"7777, park road",
"country":{
"Name":"United States",
"Code":"US"
},
"state":{
"Name":"California",
"Code":"CA"
},
"city":"MYS"
}
],
"Phone":[
{
"_id":"5d14a94931db4515857465c950f9b997",
"phoneUsageType":{
"Name":"Home",
"Code":"Home"
},
"phoneType":{
"Name":"Mobile",
"Code":"Mobile"
},
"phoneNumber":"9900223344"
}
],
"_contentMeta":{
"trust":{
"fieldData":[
{
"fieldRef":"/",
"sourceLastUpdateDate":1654836010000 // An earlier source last updated
date
},
{
"fieldRef":"PostalAddress[0dec181346114a6196d1313ca135bcee]",
"sourceLastUpdateDate":1657428010000
},
{
"fieldRef":"PostalAddress[1dec181346114a6196d1313ca135bcee]",
"sourceLastUpdateDate":1657428010000
},
{
"fieldRef":"Phone[5d14a94931db4515857465c950f9b997]",
"sourceLastUpdateDate":1657428010000
}
]
}
}
}
If the _forceUpdate parameter isn't set to true, you get the following response:
{
"path":"PostalAddress[0dec181346114a6196d1313ca135bcee]",
"errorCode":"BES.00092.4",

42 Chapter 1: Business 360 REST API

 "message":"Cannot update the field group with a sourceLastUpdateDate value older or
equal to the sourceLastUpdateDate value in the existing record.",
"localizedMessage":"Cannot update the field group with a sourceLastUpdateDate value
older or equal to the sourceLastUpdateDate value in the existing record."
}
Note: You can't force update a record if the source last updated date is later than current system date.

If no approval workflow is configured, you get the following response:

HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired":false
}
If the approval workflow is configured, you get the following response:

HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired":true
}

Update Source Record Field

Use the Update Source Record API to add, replace, or remove a field in a business entity source record based
on the source system and the primary key of the record that you specify.

The API supports the PATCH method.

PATCH request
To update a business entity source record associated with a business ID, submit a PATCH request with the
following URI:
PATCH <baseApiURL>/business-entity/public/api/v1/entity-xref/<businessEntity>/
<sourceSystem>/<sourcePKey>[?_forceUpdate=true|false][&_resolveCrosswalk=true|false]
[&notReadyForMatch=true|false]
You can use the following parameters in the request:

Parameter Description

businessEntity Internal ID of the business entity for which you want to update the source
record.

sourceSystem Internal ID of the source system to which the source record belongs.

sourcePKey The primary key of the source record.

_forceUpdate Specifies whether to force update existing records irrespective of their

source last updated dates. Default is false.

Source record API 43

 Parameter Description

_resolveCrosswalk Indicates whether to standardize picklist values based on the source system
configuration.
To standardize the picklist values, set to true. If set to true, ensure that the
picklist values belong to a code list that's part of a crosswalk.
Default is false.
For more information about standardizing picklist values, see Define Source
Systems.

notReadyForMatch Specifies whether a source record can participate in the match process.
Default is false.

You can use the following parameters in the request body:

Parameter Description

op The operator that indicates the type of update. You can specify the following
operators:
- add. Adds new data to the record.
- replace. Replaces the existing data.
- remove. Removes the data from the source record.
- setSourceLastUpdateDate. Sets the last updated date for a root or a field
group of a source record.

path The internal ID of the field you want to update.

Note: If the field contains multiple values, specify the name and the internal
ID of the field. For example, the Postal Address field contains multiple
values.

value Contains the values that you want to use to update the source record.

PATCH response
The response is in the JSON format. The PATCH response returns HTTP 200 success code. When you submit
a REST API request to update a source record, Business 360 verifies your existing user role permissions and
the approval workflow configuration. The response indicates whether a data steward must approve the
source records you updated.

PATCH example
The following request force updates the first name, last name, and the source last updated date in the
business entity source record:

PATCH <baseApiUrl>/business-entity/public/api/v1/entity-xref/c360.person/
c360.default.system/pkey3132?
_forceUpdate=true&_resolveCrosswalk=true&notReadyForMatch=true
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

[
{ "op": "replace", "path": "firstName", "value": "john" },
{ "op": "replace", "path": "lastName", "value": "hedge" },
{ "op": "setSourceLastUpdateDate", "path": "/",
"value": 1668487210000 // An earlier source last updated date
}
]

44 Chapter 1: Business 360 REST API

The following request updates a postal address:
[
[
{
"op": "replace",
"path": "firstName",
"value": "john"
},
{
"op": "replace",
"path": "lastName",
"value": "hedge"
},
{
"op": "setSourceLastUpdateDate",
"path": "/",
"value": 1668487210000
},
{
"op": "replace",
"path": "PostalAddress[0dec181346114a6196d1313ca135bcee]",
"value": {
"_id": "0dec181346114a6196d1313ca135bcee",
"addressType": {
"Code": "Home",
"Name": "Home"
},
"usageType": {
"Code": "Home",
"Name": "Home"
},
"addressStatus": {
"Code": "Active",
"Name": "Active"
},
"addressLine1": "AvenuePlaza200",
"country": {
"Code": "US",
"Name": "UnitedStates"
},
"state": {
"Code": "CA",
"Name": "California"
},
"city": "blr"
}
},
{
"op": "setSourceLastUpdateDate",
"path": "PostalAddress[0dec181346114a6196d1313ca135bcee]",
"value": 1668487210000
},
{
"op": "replace",
"path": "PostalAddress[1dec181346114a6196d1313ca135bcee]",
"value": {
"_id": "1dec181346114a6196d1313ca135bcee",
"addressType": {
"Code": "Home",
"Name": "Home"
},
"usageType": {
"Code": "Home",
"Name": "Home"
},
"addressStatus": {
"Code": "Active",
"Name": "Active"
},
"addressLine1": "AvenuePlaza100",

Source record API 45

 "country": {
"Code": "US",
"Name": "UnitedStates"
},
"state": {
"Code": "CA",
"Name": "California"
},
"city": "mys"
}
},
{
"op": "setSourceLastUpdateDate",
"path": "PostalAddress[1dec181346114a6196d1313ca135bcee]",
"value": 1667623210000
},
{
"op": "replace",
"path": "Phone[5d14a94931db4515857465c950f9b997]",
"value": {
"_id": "5d14a94931db4515857465c950f9b997",
"phoneUsageType": {
"Code": "Home",
"Name": "Home"
},
"phoneType": {
"Code": "Mobile",
"Name": "Mobile"
},
"phoneNumber": "4400202799"
}
},
{
"op": "setSourceLastUpdateDate",
"path": "Phone[5d14a94931db4515857465c950f9b997]",
"value": 1667623210000
}
]

If the _forceUpdate parameter isn't set to true, you get the following response:
{
"path":"PostalAddress[0dec181346114a6196d1313ca135bcee]",
"errorCode":"BES.00092.4",
"message":"Cannot update the field group with a sourceLastUpdateDate value older or
equal to the sourceLastUpdateDate value in the existing record.",
"localizedMessage":"Cannot update the field group with a sourceLastUpdateDate value
older or equal to the sourceLastUpdateDate value in the existing record."
}
Note: You can't force update a record if the source last updated date is later than current system date.

If no approval workflow is configured, you get the following response:

HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired":false
}
If the approval workflow is configured, you get the following response:

HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired":true
}

46 Chapter 1: Business 360 REST API

Relationship API
Use the relationship resource to filter, create, read, update, and delete business entity relationships.

Metadata API
Use the Metadata API to get the relationship_Internal_ID parameter required for the Relationship APIs.
The response also contains the relationship attributes that you can include in the request body of the Create
Relationship and Update Relationship APIs.

The API supports the GET method.

GET request
To get the relationship_Internal_ID parameter, submit a GET request with the following URI:
GET <baseApiURL>/metadata/api/v2/objects/relationship/?name=<>
You can use the following parameter in the request:

Parameter Type Description

name String The name of the relationship.

GET response
The response is in the JSON format. The response body contains the relationship_internal_ID parameter
required for the Relationship APIs and the relationship attributes you can include in the request body of the
Create Relationship and Update Relationship APIs.

Note: In the response, guid is the relationship_internal_ID parameter and name under field is a
relationship attribute.

GET example
You might use the following request to get the relationship_Internal_ID parameter and relationship
attributes based on the relationship name "Work for":
GET <baseApiURL>/metadata/api/v2/objects/relationship/?name=Work+for
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The sample response shows the HTTP 200 OK response code and retrieves the relationship_Internal_ID
parameter and the relationship attributes:
{
"last": true,
"size": 1000,
"number": 0,
"sort": [],
"first": true,
"numberOfElements": 1,
"content": [
{
"eClass": "http://informatica.com/mdm/v2/Core#//Relationship",
"guid": "c360_person_to_c360_organization",
"storage": "hierarchy",
"name": "Work for",
"_meta": {
"eClass": "http://informatica.com/mdm/v2/Core#//Meta",
"creationDate": 1633713964007,
"lastUpdatedDate": 1634039933086,
"createdByUser": "jacobkb_mrel",

Relationship API 47
 "lastUpdatedByUser": "jacobkb_mrel",
"version": 2,
"references": [
{
"eClass": "http://informatica.com/mdm/v2/Core#//
MetadataReference",
"referencePath": "//@businessEntity[guid='c360.person']",
"elementPath": "//@relationship[guid='c360_person_to_
c360_organization']/@from"
},
{
"eClass": "http://informatica.com/mdm/v2/Core#//
MetadataReference",
"referencePath": "//@businessEntity[guid='c360.organization']",
"elementPath": "//@relationship[guid='c360_person_to_
c360_organization']/@to"
}
]
},
"field": [
{
"eClass": "http://informatica.com/mdm/v2/Core#//IntegerField",
"name": "employee_number",
"description": "",
"mandatory": false,
"position": 0,
"defaultValue": 0,
"allowMany": false,
"hasDefaultValue": false,
"options": {
"eClass": "http://informatica.com/mdm/v2/Core#//FieldOptions",
"uiConfiguration": {
"eClass": "http://informatica.com/mdm/v2/Core#//
FieldUIConfiguration",
"primary": true
}
},
"label": {
"eClass": "http://informatica.com/mdm/v2/Core#//LocalizedText",
"en": "Employee Number"
}
},
{
"eClass": "http://informatica.com/mdm/v2/Core#//TextField",
"name": "details",
"description": "",
"mandatory": false,
"position": 0,
"length": 255,
"allowMany": false,
"hasDefaultValue": false,
"options": {
"eClass": "http://informatica.com/mdm/v2/Core#//FieldOptions",
"uiConfiguration": {
"eClass": "http://informatica.com/mdm/v2/Core#//
FieldUIConfiguration",
"primary": true
}
},
"label": {
"eClass": "http://informatica.com/mdm/v2/Core#//LocalizedText",
"en": "Details"
}
}
],
"label": {
"eClass": "http://informatica.com/mdm/v2/Core#//LocalizedText",
"en": "Work for"
},
"from": {
"eClass": "http://informatica.com/mdm/v2/Core#//BusinessEntityReference",

48 Chapter 1: Business 360 REST API

 "name": "_from",
"mandatory": true,
"role": "",
"businessEntity": {
"$ref": "c360.person"
}
},
"to": {
"eClass": "http://informatica.com/mdm/v2/Core#//BusinessEntityReference",
"name": "_to",
"mandatory": true,
"role": "",
"businessEntity": {
"$ref": "c360.organization"
}
}
}
]
}

Filter Relationship
Use the Filter Relationship API to retrieve a list of business entities in a relationship.

The API supports the POST method.

POST request
To filter a relationship, submit a POST request with the following URI:
POST <baseApiURL>/business-entity/public/api/v1/relationship/<relationship_Internal_ID>/
filter
You can use the following parameters in the request:

Parameter Type Description

relationship_Internal_ID String Internal ID of the relationship. To get the

internal ID, use the Metadata API. For
more information, see “Metadata API” on
page 47.

You can use the following parameters in the request body:

Parameter Type Description

pageOffset Integer Number of pages to skip. For example,

pageOffset=2 means that the search
must skip the first two pages of the
search results. Minimum value is 0.

pageSize Integer Number of search results to display on

each page. Minimum value is 1.

filter String The relationship information that needs

to be filtered.

_from String The business entity that you want to

start the relationship from.

Relationship API 49
 Parameter Type Description

_to String The business entity that you want to

link the relationship to.

businessEntity String The internal ID of the business entity.

businessId String Unique identifier of the business entity.

POST response
The response is in the JSON format. The response shows the list of business entities in a relationship.

The POST response includes the following parameters:

Parameter Type Description

first Boolean The first page indicator.

last Boolean The last page indicator.

page Integer The page number.

size Integer The requested page size.

numberOfElements Integer The actual number of elements on the

current page.

totalNumberofElements Integer The total number of elements in the

collection.

The POST response includes the following meta parameters:

Parameter Type Description

relationship String The internal ID of the relationship.

businessId String Unique identifier of the business entity

relationship.

state String Indicates the state of the relationship.

For example, indicates whether the
relationship is active.

createdBy String Name of the person who created the

relationship.

creationDate String Date when the relationship was created.

50 Chapter 1: Business 360 REST API

 Parameter Type Description

updatedBy String Name of the person who updated the

relationship.

lastUpdateDate String Date when the relationship was last

updated.

POST example
You might use the following request to filter a relationship:
POST <baseApiUrl>/business-entity/public/api/v1/relationship/colleague_of/filter
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

{
"pageoffset": "0",
"pageSize": "5",
"filter": {
"_from": {
"businessEntity": "c360.person",
"businessId": "29846697843782815893804472910"
},
"_to": {
"businessEntity": "c360.organization",
"businessId": "29843230161211928798481229322"
}
}
}
You get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

{
"first": true,
"last": true,
"page": 0,
"size": 10,
"numberOfElements": 1,
"totalNumberOfElements": 1,
"content": [
{
"employee_id": 1031,
"_from": {
"businessEntity": "c360.person",
"businessId": "29846697843782815893804472910"
},
"_to": {
"businessEntity": "c360.organization",
"businessId": "29843230161211928798481229322"
},
"_meta": {
"relationship": "c360_person_to_c360_organization",
"businessId": "30200631346953769148683291539",
"state": "ACTIVE",
"createdBy": "bjacob_PM",
"creationDate": 1637179505098,
"updatedBy": "bjacob_PM",
"lastUpdateDate": 1637179669092
}
}
]
}

Relationship API 51
 Create Relationship
Use the Create Relationship API to create a relationship between two business entities.

The API supports the POST method.

POST request
To create a relationship, submit a POST request with the following URI:
POST <baseApiURL>/business-entity/public/api/v1/relationship/<relationship_Internal_ID>?
sourceSystem=<sourceSystem>[&hierarchyType=<model name>][&hierarchyId=<ID of hierarchy>]
You can use the following parameters in the request:

Note: The hierarchyType and hierarchyId parameters apply only to hierarchical relationships.

Parameter Type Description

relationship_Internal_ID String Internal ID of the relationship. To get

the internal ID, use the Metadata API.
For more information, see “Metadata
API” on page 47.

sourceSystem String Internal ID of the source system to

which the relationship belongs.

hierarchyType String Optional. Name of the hierarchy model

you want to base your hierarchy on.

hierarchyId String Optional. The business ID of the

hierarchy model.

You can use the following parameters in the request body:

Parameter Type Description

_from String The business entity that you want to

start the relationship from.

_to String The business entity that you want to

link the relationship to.

businessEntity String The internal ID of the business entity.

businessId String Unique identifier of the business entity.

POST response
The response is in the JSON format. The response shows the HTTP 200 OK response code and retrieves the
business ID of the relationship you created. When you submit a REST API request to create a relationship,
Business 360 verifies your existing user role permissions and the approval workflow configuration. The
response indicates whether a data steward must approve the records you created.

POST example
You might use the following request to create a relationship between two business entities:
POST <baseApiUrl>/business-entity/public/api/v1/relationship/colleague_of?
sourceSystem=c360.default.system&hierarchyType=organization&hierarchyId=20142786670219119
049037064968

52 Chapter 1: Business 360 REST API

 Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

{
"location": "North America",
"details": "New Employee",
"_from": {
"businessEntity": "c360.person",
"businessId": "30136693806248569236179512998"
},
"_to": {
"businessEntity": "c360.person",
"businessId": "30136693824695313309889064620"
}
}
In the request example, location and details are relationship attributes that you can add to the request
body. For more information about relationship attributes, see Define the Data Model. You can use the
Metadata API to get the relationship attributes. For more information, see “Metadata API” on page 47.
If no approval workflow is configured, you get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired": false,
"businessId": "30142770971179375003667162584"
}
If the approval workflow is configured, you get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired": true,
"businessId": "30142770971179375003667162584"
}

Note: You might use the business ID to retrieve the relationship. For more information, see “Read
Relationship by Business ID” on page 53.

Read Relationship by Business ID

Use the Read Relationship by Business ID API to retrieve an active business entity relationship based on the
business ID of the relationship.

Before you begin, you must know the business ID of the relationship. To get the business ID of a relationship,
you can submit a search request.

The API supports the GET method.

GET request
To retrieve a business entity relationship, submit a GET request with the following URI:
GET <baseApiURL>/business-entity/public/api/v1/relationship/<relationship_Internal_ID>/
<businessId>

Relationship API 53
 The GET request contains the following path parameters:

Parameter Type Description

relationship_Internal_ID String Internal ID of the relationship. To get the

internal ID, use the Metadata API. For
more information, see “Metadata API” on
page 47.

businessId String Unique identifier of the business entity

relationship.

GET response
The response is in the JSON format. The response body contains the business entity relationship data.

The GET response includes the following _meta parameters:

Parameter Type Description

relationship String The internal ID of the relationship.

businessId String Unique identifier of the business entity

relationship.

state String Indicates the state of the relationship. For

example, indicates whether the
relationship is active.

createdBy String Name of the user who created the

relationship.

creationDate String Date when the relationship was created in

the Unix epoch time format.

updatedBy String Name of the user who last updated the

relationship.

lastUpdateDate String Date when the relationship was last

updated.

GET examples
You might use the following request to retrieve an active relationship based on the business id
30142770971179375003667162584:
GET <baseApiURL>/business-entity/public/api/v1/relationship/colleague_of/
30142770971179375003667162584
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The sample response shows the HTTP 200 OK response code and retrieves the business entity relationship
that matches the specified business ID.

{
"_from": {
"businessEntity": "c360.person",
"businessId": "30136693806248569236179512998"
},
"_to": {

54 Chapter 1: Business 360 REST API

 "businessEntity": "c360.person",
"businessId": "30136693824695313309889064620"
},
"_meta": {
"relationship": "colleague_of",
"businessId": "30142770971179375003667162584",
"state": "ACTIVE",
"createdBy": "JACOBKB_MREL",
"creationDate": 1634050073948,
"updatedBy": "JACOBKB_MREL",
"lastUpdateDate": 1634763714047
}
}

To get the content metadata, add _showContentMeta=true at the end of the request URI. You might use the
following request to retrieve the active relationship with the content meta:
GET <baseApiURL>/business-entity/public/api/v1/relationship/colleague_of/
30142770971179375003667162584_showContentMeta=true
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

{
"_from": {
"businessEntity": "c360.person",
"businessId": "30136693806248569236179512998"
},
"_to": {
"businessEntity": "c360.person",
"businessId": "30136693824695313309889064620"
},
"_meta": {
"relationship": "colleague_of",
"businessId": "30142770971179375003667162584",
"state": "ACTIVE",
"createdBy": "JACOBKB_MREL",
"creationDate": 1634050073948,
"updatedBy": "JACOBKB_MREL",
"lastUpdateDate": 1634763714047
},
"_contentMeta": {
"trust": {
"fieldData": [
{
"fieldRef": "/",
"lastUpdatedDate": 1634763714047,
"manualOverride": false,
"sourcePrimaryKey": "617083c2030f0f0759d5594b",
"sourceSystem": "c360.default.system",
"trustRule": "NoRule",
"trustScore": 0.0
}
]
}
}
}
For more information about content metadata, see “Read content meta ” on page 13.

Update Relationship
Use the Update Relationship API to update an existing relationship between two business entities.

The API supports the PUT method.

Relationship API 55
 PUT request
To update an existing relationship between two business entities, submit a PUT request with the following
URI:
PUT <baseApiURL>/business-entity/public/api/v1/relationship/<rel_name>/<businessId>?
sourceSystem=<sourceSystem>[&hierarchyType=<model name>][&hierarchyId=<ID of hierarchy>]
You can use the following parameters in the request:

Note: The hierarchyType and hierarchyId parameters apply only to hierarchical relationships.

Parameter Type Description

relationship_Internal_ID String Internal ID of the relationship. To get

the internal ID, use the Metadata API.
For more information, see “Metadata
API” on page 47.

businessId String Unique identifier of the relationship.

sourceSystem String Internal ID of the source system to

which the record belongs.

hierarchyType String Optional. Name of the hierarchy model

you want to base your hierarchy on.

hierarchyId String Optional. The business ID of the

hierarchy model.

PUT response
The response is in the JSON format. The PUT response returns HTTP 200 success code. When you submit a
REST API request to update a relationship, Business 360 verifies your existing user role permissions and the
approval workflow configuration. The response indicates whether a data steward must approve the
relationship you updated.

PUT example
You might use the following request to update a relationship between two business entities:

PUT <baseApiUrl>/business-entity/public/api/v1/relationship/colleague_of/
30142786670219119049037064968?
sourceSystem=c360.default.system&hierarchyType=organization&hierarchyId=20142786670219119
049037064968
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

{
"location": "North America",
"details": "New Employee",
}
Note: In the request example, location and details are relationship attributes that you can add to the
request body. For more information about relationship attributes, see Define the Data Model. You can use the
Metadata API to get the relationship attributes. For more information, see “Metadata API” on page 47.

If no approval workflow is configured, you get the following response:

HTTP/1.1 200 OK
Content-Type: application/json

56 Chapter 1: Business 360 REST API

 "approvalRequired": false,
}
If the approval workflow is configured, you get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired": true,
}

Delete Relationship
Use the Delete Relationship API to delete a relationship between two business entities.

The API supports the DELETE method.

DELETE request
To delete a relationship, submit a DELETE request with the following URI:
DELETE <baseApiURL>/business-entity/public/api/v1/relationship/<rel_name>/<businessId>?
sourceSystem=<sourceSystem>[&hierarchyType=<model name>][&hierarchyId=<ID of hierarchy>]
The DELETE request contains the following path parameters:

Note: The hierarchyType and hierarchyId parameters apply only to hierarchical relationships.

Parameter Type Description

relationship_Internal_ID String Internal ID of the relationship. To get the

internal ID, use the Metadata API. For
more information, see “Metadata API” on
page 47.

businessId String Unique identifier of the relationship.

sourceSystem String Internal ID of the source system to which

the record belongs.

hierarchyType String Optional. Name of the hierarchy model

that you want to delete.

hierarchyId String Optional. The business ID of the hierarchy

model.

DELETE example
You might use the following request to delete the active relationship based on the business ID
30142786670219119049037064968:

DELETE <baseApiURL>/business-entity/public/api/v1/relationship/colleague_of/
30142786670219119049037064968?
sourceSystem=c360.default.system&hierarchyType=organization&hierarchyId=20142786670219119
049037064968
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
If no approval workflow is configured, you get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

Relationship API 57
 {
"approvalRequired": false,
}
If the approval workflow is configured, you get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

{
"approvalRequired": true,
}

Merge API
Use the merge API to merge multiple source records or master records into a single master record. You can
merge up to 10 records in a single API request. The API uses the entity-group resource.

To merge records, submit a POST request with the following URI:

<baseApiUrl>/business-entity/public/api/v1/entity-group/<businessEntity>

Where, <businessEntity> is the internal ID of the business entity to which the records belong.

The response is in the JSON format.

Request body
To merge records, you can either use a combination of the sourcePKey and sourceSystem parameters or the
businessId parameter in the request body.

To merge records, you can use the following parameters in the request body:

Parameter Type Description

sourcePKey String The primary key of the source record. Used along with the sourceSystem parameter.

sourceSystem String Internal ID of the source system to which the record belongs. Used along with the
sourcePKey parameter.

businessId String Unique identifier of the record to merge.

58 Chapter 1: Business 360 REST API

Request response
The request response returns the business ID of the master record into which all the records were merged.

The following table lists the response parameters:

Parameter Type Description

approvalRequired Boolean Specifies whether approval workflow is configured. If the response is true, approval
workflow is configured. If the response is false, approval workflow is not configured.

businessId String Unique identifier of the business entity record.

Sample Request
You might use the following request to merge the source records of the Person business entity into a single
master record:
POST https://use4-mdm.dm-us.informaticacloud.com/business-entity/public/api/v1/entity-
group/c360.person
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

[
{
"sourcePKey": "KR_001",
"sourceSystem": "sales_force"
},
{
"sourcePKey": "KR_002",
"sourceSystem": "sales_force"
},
{
"sourcePKey": "KR_003",
"sourceSystem": "sales_force"
}
]
You might use the following request to merge master records identified by business IDs into a single master
record:
POST https://use4-mdm.dm-us.informaticacloud.com/business-entity/public/api/v1/entity-
group/c360.person
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

[
{
"businessId": "30144671469908735024405177548"
},
{
"businessId": "30135930585603624912243111103"
},
{
"businessId": "30135877211979043715615298521"
}
]

Merge API 59
 Sample Response
When you make a merge request, the response returns the business ID of the master record into which all the
records are merged.

The following merge response contains the business ID of the master record into which multiple records
merged:
HTTP/1.1 200 OK
Content-Type: application/json
{
"approvalRequired": false,
"businessId": "30144667303107074155788161103"
}

Unmerge API
Use the unmerge API to unmerge source records from a master record. The API uses the entity-group
resource.

To unmerge source records, submit a POST request with the following URI:

<baseApiUrl>/business-entity/public/api/v1/entity-group/<businessEntity>/<businessId>

The URI uses the following parameters:

• businessEntity. Internal ID of the business entity to which the records belong.

• businessId. Unique identifier of the master record.

The response is in the JSON format.

Request body
To unmerge records, you use a combination of the sourcePKey and sourceSystem parameters in the request
body.

To unmerge records, you can use the following parameters in the request body:

Parameter Type Description

sourcePKey String The primary key of the source record.

sourceSystem String Internal ID of the source system to which the record belongs.

60 Chapter 1: Business 360 REST API

Request response
The request response indicates whether a data steward must approve the unmerge action.

The following table lists the response parameter:

Parameter Type Description

approvalRequired Boolean Specifies whether approval workflow is configured. If the response is true, approval
workflow is configured. If the response is false, approval workflow is not configured.

Sample Request
You might use the following request to unmerge the source records of the Person business entity from a
master record with the business ID 30144667303107074155788161103:
POST https://use4-mdm.dm-us.informaticacloud.com/business-entity/public/api/v1/entity-
group/c360.person/30144667303107074155788161103
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

[
{
"sourcePKey": "KR_001",
"sourceSystem": "sales_force"
},
{
"sourcePKey": "KR_003",
"sourceSystem": "sales_force"
}
]

Sample Response
When you make an umerge request, the Business 360 application verifies your user role permissions and the
approval workflow configuration. The response indicates whether a data steward must approve the unmerge
action.

If no approval workflow is configured, you get the following response:

HTTP/1.1 200 OK
Content-Type: application/json
{
"approvalRequired": false,
}
If approval workflow is configured, you get the following response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"approvalRequired": true,
}

Unmerge API 61
Search Match API
Use the Search Match API to search for matching records based on the published match model
configuration. The required input parameters for the REST API vary based on the business entity and its
match model.

The Search Match API searches on the source records, performs matching based on the candidate selection
criteria and match rules, and returns the matched records.

For the Search Match API to use a match model configuration, you can use one of the following methods:

• Specify a match model ID and the required fields of the declarative rules in the Search Match API.
• Set a default match model for the Search Match API in Business 360 Console and specify the required
fields of the declarative rules in the Search Match API.
• Specify at least one field for which you created a declarative rule.

Note: Ensure that you have the list of required fields in the declarative rules of the match models published in
Business 360 Console.

To search for matching records, submit a POST request with the following URI:
<baseApiUrl>match-ng-pair-gen/public/api/v1/searchmatch/<businessEntity>?
[matchmodel=<matchModelId>]&[version=<matchModelVersion>]
The following table describes the parameters that you specify in the POST request:

Parameter Type Description

businessEntity String Internal ID of the business entity that

contains the published match model. You
must have a read access to the business
entity.

matchmodel String Optional. Unique identifier of the

published match model that contains the
candidate selection criteria and
declarative rules required for matching the
records.
If you do not specify a match model, the
API uses the default match model that you
set for the Search Match API in Business
360 Console.

version Number Optional. Version number of the match

model.
Default is the latest version of the match
model.

For more information about finding the identifiers and version numbers, see “Finding details for the
request” on page 64.

The response is in the JSON format.

62 Chapter 1: Business 360 REST API

Request body
You can use the following parameters in the Search Match API request body:

Parameter Type Description

maxRecordsToReturn Number Maximum number of records to return in

the search results.
The search can return a maximum of 100
records.
Default is 100.

searchLevel String Candidate search level that the match

model uses to determine how stringently
and thoroughly to search for match
candidates.
You can configure the following search
levels:
- Narrow
- Typical
- Exhaustive
- Extreme
If you do not provide this value, the REST
API uses the value from the match model.

fileRecordLimit Number Maximum number of source records to

search. The REST API searches on the
source records and returns the master
record data.
The REST API performs a search on a
maximum of 1000 source records based
on the candidate selection criteria of the
match model. For example, if the source
collection has 8000 records, the REST API
can identify a maximum of 1000 similar
source records to perform matching of
records.
Default is 1000.

searchRecord Array Contains the search values, such as the

required match field identifiers and their
values, based on which you want to find
the matching records.
Enter the internal identifiers for the
required match fields. For example,
birthDate and fullName. For more
information about finding the required
match fields and their identifiers, see
“Finding details for the request” on page 64 .
Ensure that you have read access to the
match fields.

Search Match API 63

 Finding details for the request
You must enter identifier details, such as match field identifier and match model identifier, in the REST API
request. To get these details, navigate to the Business 360 Console.

Business entity identifier

To view the identifiers for a business entity, open a business entity from Business 360 Console. Click the
Actions menu and view the properties, such as display name and internal ID.

The following image shows the properties of a business entity:

In the image, the business entity has the internal ID c360.person.

Match model version

To view the version of a match model, click the Match tab of a business entity.

The following image shows the version numbers of the sample match models:

Match model identifier

To view the match model identifier, open a match model. The match model identifier appears in the Model
Configuration tab

64 Chapter 1: Business 360 REST API

The following image shows the Model Configuration tab that contains the match model identifier:

Match fields and identifiers

To view the required match fields in a match model, open a published match model of a business entity. Click
the Machine Learning Model tab and view the match fields.

The following image shows the sample match fields for a published match model:

In the image, you can view the match fields that are part of the match model. Some fields are basic fields and
some fields are part of a field group. For example, Address Line 1 and Address Line 2 are part of the Address
field group. The internal ID of the Address field group is PostalAddress that you can view in the Field Path
column.

The Internal ID column displays the internal identifiers of each match field. For example, the internal
identifier for the Full Name field is fullName and for the Address Line 1 field is addressLine1.

When you enter the required match fields for a field group in the search match API request body, specify the
internal identifiers for the match fields and the field group in the search record. For example, enter the
address details in the following format:
"PostalAddress": [
{
"addressLine1": "QUINCE RD"

}
]

Search Match API 65

 Request response
The request response returns the matching records.

The following table lists the response parameters:

Parameter Type Description

searchResult Object Contains the matching records.

totalRecords Number Total number of matching records that the request returns.

records Array Contains all the matching records that are filtered and sorted based on the specified
criteria.

sourceSystem String Internal ID of the source system to which the record belongs.

sourcePKey String The primary key of the source record.

population String Certain characteristics of data in the records that you want to match.

The POST response includes the following _meta parameters:

Parameter Type Description

score Number The match score of the record.

rank Number Ranking of the matching record. Returned if a record is matched using a rank-based rule.

matchRule String Threshold value of the match rule. Returned if a record is matched using a threshold-based
rule.

businessId String Unique business identifier of the master record.

data Object Data in the master record.

Sample Request
The following sample request specifies the match fields, such as name, address, and address type, that a
published match model uses:
{
"searchControls": {
"maxRecordsToReturn": 20,
"searchLevel": "Typical",
"fileRecordLimit": 1000
},
"data": {
"searchRecord": {
"first_name": "JAMES",
"full_name": "JAMES Gilgen",
"middle_name": "H",
"last_name": "Gilgen",
"Address": [
{
"_id": "add_id2",
"addressLine1": "12012 N MO PAC EXPY",
"addressLine2": "Sound.",

66 Chapter 1: Business 360 REST API

 "addressLine3": "Phone leg.",
"addressStatus": {
"Code": "Inactive",
"Name": "Inactive"
},
"addressType": {
"Code": "Office",
"Name": "Office"
},
"coordinateSystem": "Staff.",
"country": {
"Code": "US",
"Name": "United States"
},
"defaultIndicator": true,
"enrichedIndicator": {
"Code": "VALID",
"Name": "Valid"
},
"latitude": "28 N",
"locationCoordinateDesc": "Coordinates",
"longitude": "77 E",
"postalCode": "78758",
"postalCodeExtension": "2241",
"usageType": {
"Code": "Home",
"Name": "Home"
}
}
]
}
}
}
The following sample request specifies only the required fields:

{
"searchControls": {
"maxRecordsToReturn": 10,
"searchLevel": "Typical",
"fileRecordLimit": 1000
},
"data": {
"searchRecord": {
"fullName": "ALEXANDRA NORMAN"
}
}
}

Sample Response
When you make a search request, the response retrieves records based on the configured match rules.

The following sample response contains two matching master records for the specified search values:
{
"searchResult": {
"totalRecords": 2,
"records": [
{
"_meta": {
"score": 96.0,
"rank": 1,
"businessId": "MDM0000003KLMO"
},
"data": {
"PostalAddress": [
{

Search Match API 67

 "addressLine1": "QUINCE RD STE"
}
],
"birthDate": "2022-03-04",
"fullName": "BETTE Briggs"
}
},

{
"_meta": {
"score": 85.0,
"matchRule": "THD1",
"businessId": "MDM0000003KLMO"
},
"data": {
"PostalAddress": [
{
"addressLine1": "KUINCE RD""
}
],
"birthDate": "2022-03-04",
"fullName": "BETTE Briggs"
}
}
]
}

}
You get the following sample response when you specify only the required fields:

{
"searchResult": {
"totalRecords": 1,
"records": [
{
"_meta": {
"matchModelName": "nir_test",
"matchModelVersion": 1,
"score": 100.0,
"rank": 1,
"businessId": "MDM000000G2PC6",
"xrefSourceSystem": "b360.default.system",
"xrefSourcePKey": "pkey727",
"population": "usa"
},
"data": {
"fullName": "ALEXANDRA NORMAN"
}
}
]
}
}

Job instance API

Use the job instance APIs to manage ingress, egress, and match and merge jobs. You can create and run job
instances, search for job instances, and retrieve a short summary or the complete details of a job instance.
The APIs use the jobInstance resource.

68 Chapter 1: Business 360 REST API

Create Ingress Job Instance
Use the Create Ingress Job Instance API to create and run an ingress job instance that imports data from an
external source system to Business 360 data store.

Before using this API, you must first define an ingress job in Business 360 Console. For more information
about defining an ingress job, see Ingress data.

The API supports the POST method.

POST request
To create and run an ingress job instance, submit a POST request with the following URI:
POST <baseApiURL>/job/public/api/v1/jobInstance/Ingress
You can use the following parameters in the request body:

Parameter Type Description

jobDefinitionId String The internal ID of a job.

You can view the internal ID of a job when
you open the job definition in Business
360 Console.

POST response
The response is in the JSON format. The response shows the HTTP 200 OK response code and returns the ID
of job instance.

POST example
You might use the following sample request to create and run an ingress job instance:
POST <baseApiUrl>/job/public/api/v1/jobInstance/Ingress
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

"jobDefinitionId": "ingress_org"

}
The following sample response contains the HTTP 200 OK response code and the job instance ID:
HTTP/1.1 200 OK
Content-Type: application/json

{
"id": "714189942313869312"
}
Note: Use the value of id to retrieve a summary or the complete details of a job instance. For more
information about retrieving a summary of a job instance, see “Read Job Instance Summary” on page 76.
For more information about retrieving the complete details of a job instance, see “Read Job Instance
Details” on page 78.

Job instance API 69

 Create Egress Job Instance
Use the Create Egress Job Instance API to create and run an egress job instance that exports data from
Business 360 data store to an external data source.

Before using this API, you must first define an egress job in Business 360 Console. For more information
about defining an egress job, see Egress data.

The API supports the POST method.

POST request
To create and run an egress job, submit a POST request with the following URI:
POST <baseApiURL>/job/public/api/v1/jobInstance/Egress
You can use the following parameters in the request body:

Parameter Type Description

jobDefinitionId String The internal ID of a job.

You can view the internal ID of a job when
you open the job definition in Business
360 Console.

POST response
The response is in the JSON format. The response shows the HTTP 200 OK response code and returns the ID
of job instance.

POST example
You might use the following sample request to create and run an egress job instance:
POST <baseApiUrl>/job/public/api/v1/jobInstance/Egress
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

"jobDefinitionId": "egress_org"

}
The following sample response contains the HTTP 200 OK response code and the job instance ID:
HTTP/1.1 200 OK
Content-Type: application/json

{
"id": "714195872447352832"
}
Note: Use the value of id to retrieve a summary or the complete details of a job instance. For more
information about retrieving a summary of a job instance, see “Read Job Instance Summary” on page 76.
For more information about retrieving the complete details of a job instance, see “Read Job Instance
Details” on page 78.

70 Chapter 1: Business 360 REST API

Create Match and Merge Job Instance
Use the Create Match and Merge Job Instance API to create and run a match and merge job that identifies
and resolves duplicate records.

Before using this API, you must first define a match and merge job in Business 360 Console. For more
information about defining a match and merge job, see Define and run a match and merge job.

The API supports the POST method.

POST request
To crate and run a match and merge job, submit a POST request with the following URI:
POST <baseApiURL>/job/public/api/v1/jobInstance/MatchMerge
You can use the following parameters in the request body::

Parameter Type Description

jobDefinitionId String The internal ID of a job.

You can view the internal ID of a job when
you open the job definition in Business
360 Console.

matchModelId String The ID of the match model. You can view

the ID of match model when you open it in
Business 360 Console.

matchModelVersion String The version of the match model.

businessEntity String The internal ID of the business entity.

POST response
The response is in the JSON format. The response shows the HTTP 200 OK response code and returns the ID
of job instance.

POST example
You might use the following sample request to create and run a match and merge job:
POST <baseApiUrl>/job/public/api/v1/jobInstance/MatchMerge
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

{
"jobDefinitionId": "matchmerge1",
"matchModelId": "org.ruleset1",
"matchModelVersion": 1,
"businessEntity": "c360.organization"
}
The following sample response contains the HTTP 200 OK response code and the job instance ID:
HTTP/1.1 200 OK
Content-Type: application/json

{
"id": "714542403541159936"
}
Note: Use the value of id to retrieve a summary or the complete details of a job instance. For more
information about retrieving a summary of a job instance, see “Read Job Instance Summary” on page 76.

Job instance API 71

 For more information about retrieving the complete details of a job instance, see “Read Job Instance
Details” on page 78.

Search Job Instances

Use the Search Job Instances API to search for matching job instances based on the job name, the job type,
the status of job instances, or the user who started the job instance.

The API supports the POST method.

POST request
To search for ingress, egress, and match and merge jobs, submit a POST request with the following URI:
POST <baseApiURL>/job/public/api/v1/search
You can use the following parameters in the request body:

Parameter Type Description

search String Search string to search for matching job

name, job type, status of job instances, or
user who started the job instance.

pageSize Number Number of search results to display on

each page. Minimum value is 1.

pageOffset Number Optional. Number of pages to skip. For

example, pageOffset=2 means that the
search must skip the first two pages of the
search results. Minimum value is 0.

filter Array Specifies a list of fields that you want to

use to filter the search results.

filters > operator String The boolean operator that joins multiple
filters. Use AND or OR as the boolean
operator.
Use AND if fieldName has different
values. Use OR if fieldName has the
same values but fieldValue has
different values.

fieldName String Type of values based on which you want to

filter the job instances.
Use of one of the following types:
- jobName. Filters job instances based on
the specified job name.
- state. Filters job instances based on
the specified status of jobs.
- jobType. Filters job instances based on
specified job type.

fieldValue String Value based on which you want to filter

the job instances.

POST response
The response is in the JSON format. The response returns the matching job instances.

72 Chapter 1: Business 360 REST API

The response includes the following parameters:

Parameter Type Description

totalRecords Number The number of job instances returned in

the search.

totalPages Number The number of pages returned in the

search.

currentPage Number The page number from which you view the
search results.

jobInstances Array The list of job instances returned in the

search.

metadataEntities String The metadata details of the job instance.

runTimeParameters String The runtime parameters that were used to

run the job instance.

jobLevelMetrics String The key metrics of the job instance.

completedAt String Date when the job instance was

completed.

state String Status of job instances.

createdAt String Date when the job was created.

createdBy String Name of the user who created the job.

updatedAt String Date when the job was updated.

updatedBy String Name of the user who last updated the

job.

startedAt String Date when the job instance was started.

startedBy String Name of the user who started the job

instance.

isCompleted Boolean Indicates whether the job instance was

completed.

POST example
You might use the following request to search for a job:
POST <baseApiUrl>/job/public/api/v1/search
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

{
"search": "*",
"pageSize": 25,
"pageOffset": 0,
"filters": {
"operator": "or",
"filter": [
{

Job instance API 73

 "fieldName": "jobType",
"fieldValue": "c360.be.match.finishTraining"
},
{
"fieldName": "jobType",
"fieldValue": "c360.be.matchmerge"
},
{
"fieldName": "jobType",
"fieldValue": "c360.be.match.startTraining"
}
]
}
}
You get the following response:
HTTP/1.1 200 OK
Content-Type: application/json

{
"totalRecords": 49,
"totalPages": 2,
"currentPage": 0,
"jobInstances": [
{
"id": "714542403541159936",
"name": "seanci1",
"jobType": "c360.be.matchmerge",
"jobDefinition": {
"id": "seanci1",
"caiProcess": {
"name": "MatchMerge"
},
"metadataEntities": [
{
"name": "TARGET_ENTITY",
"entities": [
{
"name": "Baseline Match Model for person Deduplication",
"id": "c360.person"
}
]
}
],
"parameters": [
{
"name": "MATCH_MODEL_ID",
"value": "person.ruleset1",
"type": "String"
},
{
"name": "MATCH_MODEL_VERSION",
"value": "1",
"type": "String"
},
{
"name": "MATCH_MODEL_NAME",
"value": "Baseline Match Model for person Deduplication",
"type": "String"
},
{
"name": "SEARCH_INDEX_LOAD_TYPE",
"value": "ALL",
"type": "String"
},
{
"name": "PROCESS_TYPE",
"value": "Match and Merge",
"type": "String"
},

74 Chapter 1: Business 360 REST API

 {
"name": "JOB_FLOW_NAME",
"value": "MATCH_MERGE",
"type": "String"
}
]
},
"runTimeParameters": [
{
"name": "MATCH_MODEL_ID",
"value": "person.ruleset1",
"type": "String"
},
{
"name": "MATCH_MODEL_VERSION",
"value": "1",
"type": "String"
},
{
"name": "MATCH_MODEL_NAME",
"value": "Baseline Match Model for person Deduplication",
"type": "String"
},
{
"name": "SEARCH_INDEX_LOAD_TYPE",
"value": "ALL",
"type": "String"
},
{
"name": "PROCESS_TYPE",
"value": "Match and Merge",
"type": "String"
},
{
"name": "JOB_FLOW_NAME",
"value": "MATCH_MERGE",
"type": "String"
},
{
"name": "isTerminationAllowed",
"value": true,
"type": "Boolean"
},
{
"name": "MODEL_VERSION",
"value": "1653588983323",
"type": "String"
}
],
"jobLevelMetrics": null,
"_meta": {
"completedAt": 1653589344087,
"state": "SUCCESS",
"createdAt": 1653588985202,
"createdBy": "impactci1",
"updatedAt": 1653589344087,
"updatedBy": "impactci1",
"startedAt": 1653588985202,
"startedBy": "impactci1",
"isCompleted": true
}
}
...

Job instance API 75

 Read Job Instance Summary
Use the Read Job Instance Summary API to retrieve a brief summary about the job instance. The summary
contains the details of runtime parameters and metrics of a job instance.

The API supports the GET method.

GET request
To retrieve the summary of a job instance, submit a GET request with the following URI:
GET <baseApiURL>/job/public/api/v1/jobInstance/<jobInstanceId>
The GET request contains the following path parameters:

Parameter Type Description

jobInstanceId String The ID of the job instance.

GET response
The response is in the JSON format. The response body contains the summary of a job instance.

The GET response includes the following parameters:

Parameter Type Description

metadataEntities String The metadata details of the job instance.

runTimeParameters String The runtime parameters that were used to

run the underlying taskflow related to the
job.

jobLevelMetrics String The key metrics of the job instance.

completedAt String Date when the job was completed.

state String Indicates whether the job was successful.

createdAt String Date when the job was created.

createdBy String Name of the user who created the job.

updatedAt String Date when the job was updated.

updatedBy String Name of the user who last updated the

job.

startedAt String Date when the job was started.

startedBy String Name of the user who started the job.

isCompleted Boolean Indicates whether the job was completed.

Note: All dates are in the Unix epoch time format.

76 Chapter 1: Business 360 REST API

GET example
You might use the following request to retrieve the summary of a job instance based on the job instance ID
93d25c14-c874-438b-8ed0-442944a37a54:
GET <baseApiURL>/job/public/api/v1/jobInstance/93d25c14-c874-438b-8ed0-442944a37a54
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The sample response shows the HTTP 200 OK response code and retrieves the summary of a job instance.

{
"id": "93d25c14-c874-438b-8ed0-442944a37a54",
"name": "ingress_organization",
"jobDefinition": {
"id": "internal.c360.ingress.fileImportJob",
"caiProcess": {
"name": "MDMFlowFileImportDQ"
},
"metadataEntities": [
{
"name": "TARGET_ENTITY",
"entities": [
{
"name": "Organizationwefwef",
"id": "c360.organization"
}
]
},
{
"name": "Source_System",
"entities": [
{
"name": "Default",
"id": "b360.default.system"
}
]
}
],
"parameters": [
{
"name": "continueOnError",
"value": true,
"type": "Boolean"
}
]
},
"runTimeParameters": [
{
"name": "continueOnError",
"value": true,
"type": "Boolean"
},
{
"name": "USER_ID",
"value": "9EKrJA9TwrWbrqwEUn6gA4",
"type": "String"
},
{
"name": "MODEL_VERSION",
"value": "1649151390520",
"type": "String"
}
],
"jobLevelMetrics": [
{
"id": "NUM_OF_ASSETS",
"name": "Target Assets",
"type": "PROCESSED",
"value": 1

Job instance API 77

 },
{
"id": "NUM_OF_INCOMING_RECORDS",
"name": "Input Rows",
"type": "INPUT",
"value": 10000
},
{
"id": "NUM_OF_REC_SUCCEEDED",
"name": "Success Rows",
"type": "SUCCESS",
"value": 10000
},
{
"id": "NUM_OF_REC_FAILED",
"name": "Error Rows",
"type": "FAILED",
"value": 0
},
{
"id": "NUM_OF_REC_LOAD_CREATED",
"name": "Success Records",
"type": "SUCCESS",
"value": 10000
},
{
"id": "NUM_OF_REC_LOAD_FAILED",
"name": "Failed Records",
"type": "FAILED",
"value": 0
}
],
"_meta": {
"completedAt": 1649151874361,
"state": "SUCCESS",
"createdAt": 1649151399754,
"createdBy": "impactci1",
"updatedAt": 1649151874361,
"updatedBy": "impactci1",
"startedAt": 1649151399754,
"startedBy": "impactci1",
"isCompleted": true
}
}

Read Job Instance Details

Use the Read Job Instance Details API to retrieve the complete details of a job instance. The details include a
brief summary of the job instance and the information about steps related to the job instance.

The API supports the GET method.

GET request
To retrieve the details of a job instance, submit a GET request with the following URI:
GET <baseApiURL>/job/public/api/v1/jobInstance/<jobInstanceId>?details=true
The GET request contains the following path parameters:

Parameter Type Description

jobInstanceId String The ID of the job instance.

78 Chapter 1: Business 360 REST API

GET response
The response is in the JSON format. The response body contains the complete details of a job instance.

The GET response includes the following parameters:

Parameter Type Description

metadataEntities String The metadata details of the job instance.

runTimeParameters String The runtime parameters that were used to

run the underlying taskflow related to the
job.

jobLevelMetrics String The key metrics of the job instance.

steps String Lists the steps and their details.

completedAt String Date when the job was completed.

state String Indicates whether the job was successful.

createdAt String Date when the job was created.

createdBy String Name of the user who created the job.

updatedAt String Date when the job was updated.

updatedBy String Name of the user who last updated the

job.

startedAt String Date when the job was started.

startedBy String Name of the user who started the job.

isCompleted Boolean Indicates whether the job was completed.

Note: All dates are in the Unix epoch time format.

GET example
You might use the following request to retrieve the details of a job instance based on the job instance ID
93d25c14-c874-438b-8ed0-442944a37a54:
GET <baseApiURL>/job/public/api/v1/jobInstance/93d25c14-c874-438b-8ed0-442944a37a54?
details=true
Content-Type: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the HTTP 200 OK response code and retrieves the details of a job
instance:

{
"id": "93d25c14-c874-438b-8ed0-442944a37a54",
"name": "ingress_organization",
"jobDefinition": {
"id": "internal.c360.ingress.fileImportJob",
"caiProcess": {
"name": "MDMFlowFileImportDQ"
},
"metadataEntities": [

Job instance API 79

 {
"name": "TARGET_ENTITY",
"entities": [
{
"name": "Organizationwefwef",
"id": "c360.organization"
}
]
},
{
"name": "Source_System",
"entities": [
{
"name": "Default",
"id": "b360.default.system"
}
]
}
],
"parameters": [
{
"name": "continueOnError",
"value": true,
"type": "Boolean"
}
]
},
"runTimeParameters": [
{
"name": "continueOnError",
"value": true,
"type": "Boolean"
},
{
"name": "USER_ID",
"value": "9EKrJA9TwrWbrqwEUn6gA4",
"type": "String"
},
{
"name": "MODEL_VERSION",
"value": "1649151390520",
"type": "String"
}
],
"jobLevelMetrics": [
{
"id": "NUM_OF_ASSETS",
"name": "Target Assets",
"type": "PROCESSED",
"value": 1
},
{
"id": "NUM_OF_INCOMING_RECORDS",
"name": "Input Rows",
"type": "INPUT",
"value": 10000
},
{
"id": "NUM_OF_REC_SUCCEEDED",
"name": "Success Rows",
"type": "SUCCESS",
"value": 10000
},
{
"id": "NUM_OF_REC_FAILED",
"name": "Error Rows",
"type": "FAILED",
"value": 0
},
{
"id": "NUM_OF_REC_LOAD_CREATED",

80 Chapter 1: Business 360 REST API

 "name": "Success Records",
"type": "SUCCESS",
"value": 10000
},
{
"id": "NUM_OF_REC_LOAD_FAILED",
"name": "Failed Records",
"type": "FAILED",
"value": 0
}
],
"steps": [
{
"name": "Index for Search",
"runTimeParameters": [
{
"name": "SEARCH_INDEX_STATUS",
"value": {
"startedBy": "impactci1",
"startTime": 1649151812429,
"endTime": 1649151826197,
"entityInfo": [
{
"entityName": "c360.organization",
"jobCompleted": true,
"jobId": "es-index-25ca8b7ff91ba641-driver",
"jobContext": {
"jobCallbackData": {
"jobCallbackAttemptCount": 1
},
"jobStatus": "SUCCESS",
"metrics": {
"indexRecordProcessed": 10000,
"deleteRecordProcessed": 0,
"total_record_count": 10000,
"deleteTimeTaken": 0,
"deleteRecordSuccess": 0,
"deleteRecordFailure": 0,
"indexTimeTaken": 5205,
"updateTimeTaken": 5136,
"indexRecordFailure": 0,
"indexRecordSuccess": 10000,
"record_failure_count": 0
},
"runTimeParameters": {
"jobInstanceId": "93d25c14-
c874-438b-8ed0-442944a37a54",
"tenantId": "6MZknGZ16fLbrn9mRY2C2r",
"stepId": "INDEX",
"entityGuid": "c360.organization",
"startTime": 1649151813374,
"endTime": 1649151826164
},
"outputParameters": {}
},
"retry": false
}
]
}
}
],
"type": "STEP",
"metrics": [
{
"id": "SEARCH_INDEX_TOTAL_RECORDS",
"name": "SEARCH_INDEX_TOTAL_RECORDS",
"type": "PROCESSED",
"value": 10000,
"subMetrics": [
{
"id": "c360.organization",

Job instance API 81

 "name": "c360.organization",
"type": "PROCESSED",
"value": 10000
}
]
},
{
"id": "SEARCH_INDEX_FAILED_RECORDS",
"name": "SEARCH_INDEX_FAILED_RECORDS",
"type": "PROCESSED",
"value": 0,
"subMetrics": [
{
"id": "c360.organization",
"name": "c360.organization",
"type": "PROCESSED",
"value": 0
}
]
}
],
"id": "93d25c14-c874-438b-8ed0-442944a37a54_INDEX",
"_meta": {
"completedAt": 1649151826350,
"state": "SUCCESS",
"createdAt": 1649151812184,
"createdBy": "impactci1",
"updatedAt": 1649151826350,
"updatedBy": "impactci1",
"startedAt": 1649151812184,
"startedBy": "impactci1",
"isCompleted": true
}
...

Export and import API

Use the Business 360 REST API to migrate assets and other objects between organizations.

To use the REST API requests, the source and target organizations must have the appropriate license.

To migrate objects, you export them from the source organization and then import them into the target
organization.

When you export assets, you can choose whether to include dependent objects. During the import operation,
you can choose which assets to import.

For more information about export and import, see Export and Import.

82 Chapter 1: Business 360 REST API

Index

A S
adding search API 14
record 23 search match API 62
API source record API 37
business entity record 23 status
merge 58 Informatica Intelligent Cloud Services 6
search 14, 62 system status 6
source record 37

T
I trust site
Informatica Global Customer Support description 6
contact information 6
Informatica Intelligent Cloud Services
web site 5
U
upgrade notifications 6

M
maintenance outages 6
merge API 58
W
web site 5

R
resources
search 60

83