)
schema:
type: string
example: filter=equals(accountType, GCP)
responses:
'200':
description: Resources retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StorageAccountTO'
example:
- createdBy: user@reltio.com
createdDate: 1633501736082
accountId: 36617
accountName: HCPLoad
accountType: GCP
credentials: '***************'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
error: access_denied
error_description: Access is denied
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Brief error message here
errorCode: 123
errorDetailMessage: Detailed error message here
innerErrorData:
exception: >-
com.reltio.services.dataloader.common.exception.DataLoaderServiceException
Details here
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
timestamp: 1634719769759
status: 500
error: Internal Server Error
message: Brief error message here
path: Api context path here
extensions:
x-module: dataloader
x-controllerName: >-
com.reltio.services.dataloader.controller.DataLoaderStorageAccountsController
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Data%20Load%20Job/getAllStorageAccountsByFilters
/services/dataloader/api/{tenantId}/storage/{directory}/upload:
post:
tags:
- Data Load Job
summary: Upload files from a local machine to load data
description: >-
Upload a file from your system to remote storage for carrying out load
operation
operationId: uploadFiles
parameters:
- name: fileType
in: query
schema:
type: string
enum:
- CSV
- JSON
- RELTIO_JSON
- XLSX
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: directory
in: path
description: GCS path for uploading the file
required: true
schema:
type: string
example: abcd
- name: replace
in: query
description: If set to 'true', the existing file is overwritten with the new file
schema:
type: boolean
example: false
- name: projectId
in: query
description: >-
When provided, the API uploads the file and updates the provided job
definition and maps the storage ID to the uploaded file
schema:
type: string
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
- name: delimiter
in: query
description: 'CSV file delimiter character, supported values are , | || ; '
schema:
type: string
example: '|'
requestBody:
content:
multipart/form-data:
schema:
required:
- file
properties:
file:
type: string
description: MIME file that must be uploaded
format: binary
required: true
responses:
'200':
description: File uploaded
content:
application/json:
schema:
$ref: '#/components/schemas/StorageDetailsTO'
example:
createdBy: user@reltio.com
createdDate: 1633501736082
storageId: a69d6ea7-57fd-4ff1-88c8-63dc8cc9b1b6
bucketName: GCP Bucket
sourcePath: abc/reltio/entities
fileMask: HCP
shareSourceInfo: true
storageAccount:
createdBy: user@reltio.com
createdDate: 1633501736082
accountId: 36617
accountName: HCPLoad
accountType: GCP
credentials: '***************'
totalRecords: 0
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
error: access_denied
error_description: Access is denied
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Brief error message here
errorCode: 123
errorDetailMessage: Detailed error message here
innerErrorData:
exception: >-
com.reltio.services.dataloader.common.exception.DataLoaderServiceException
Details here
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
timestamp: 1634719769759
status: 500
error: Internal Server Error
message: Brief error message here
path: Api context path here
extensions:
x-module: dataloader
x-controllerName: com.reltio.services.dataloader.controller.DataLoaderStorageController
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Data%20Load%20Job/uploadFiles
/services/dataloader/api/{tenantId}/storage/{sourceId}:
delete:
tags:
- Data Load Job
summary: Removes the uploaded file Cloud Storage
description: Removes the uploaded file from Cloud Storage
operationId: removeFile
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: sourceId
in: path
description: Source details ID to delete
required: true
schema:
type: string
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
responses:
'200':
description: Source file deleted successfully
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
error: access_denied
error_description: Access is denied
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Brief error message here
errorCode: 123
errorDetailMessage: Detailed error message here
innerErrorData:
exception: >-
com.reltio.services.dataloader.common.exception.DataLoaderServiceException
Details here
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
timestamp: 1634719769759
status: 500
error: Internal Server Error
message: Brief error message here
path: Api context path here
extensions:
x-module: dataloader
x-controllerName: com.reltio.services.dataloader.controller.DataLoaderStorageController
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Data%20Load%20Job/removeFile
/services/dataloader/api/{tenantId}/storage/{sourceId}/read:
get:
tags:
- Data Load Job
summary: Reads existing source files
description: >-
Reads the specified number of lines from the existing source details and
returns the information
operationId: readFiles
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: sourceId
in: path
description: Existing Storage ID from which the files are to be read
required: true
schema:
type: string
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
- name: linesToRead
in: query
description: Number of lines to be read from the source file for preview
schema:
type: integer
default: 10
example: 10
responses:
'200':
description: Source files are read successfully
content:
application/json:
schema:
type: object
additionalProperties:
type: array
items:
type: string
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
error: access_denied
error_description: Access is denied
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Brief error message here
errorCode: 123
errorDetailMessage: Detailed error message here
innerErrorData:
exception: >-
com.reltio.services.dataloader.common.exception.DataLoaderServiceException
Details here
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
timestamp: 1634719769759
status: 500
error: Internal Server Error
message: Brief error message here
path: Api context path here
extensions:
x-module: dataloader
x-controllerName: com.reltio.services.dataloader.controller.DataLoaderStorageController
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Data%20Load%20Job/readFiles
/services/lookups/{tenantId}:
post:
tags:
- Reference Data Management
summary: Saves lookups
description: >-
This API saves a collection of lookups in RDM tenant according to the
JSON object definition. If you need to create just one lookup value then
please specify one JSON object in the array. The same API should be used
for create and update operations.
You can create a maximum of
100 lookup codes in a single request.
operationId: createByTenant
parameters:
- name: tenantId
in: path
description: ID of the RDM tenant
required: true
schema:
type: string
requestBody:
description: A collection of lookups to be saved in a tenant
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Lookup Code'
examples:
sample:
description: Sample request for API
value:
- tenantId: user_tenant_id
type: rdm/lookupTypes/Country
code: US
enabled: true
startDate: 1577836800000
endDate: 3471292800000
parents:
- rdm/lookupTypes/Continent/NA
sourceMappings:
- source: Reltio
values:
- code: RLT_US
value: United States of America
description: USA definition in the Reltio source system.
enabled: true
canonicalValue: false
downStreamDefaultValue: false
localizations:
- languageCode: it-it
value: Stati Uniti d'America
description: United States of America in Italian translation.
attributes:
- name: Population
value: '331002651'
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation Result'
'401':
description: The operation cannot be performed because user is unauthorized
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/API Error'
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/API Error'
extensions:
x-module: rdm
x-controllerName: com.reltio.rdm.rest.controller.DataController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Reference%20Data%20Management/createByTenant
/services/lookups/{tenantId}/{type}:
post:
tags:
- Reference Data Management
summary: Saves lookups for the specified lookup type
description: >-
This API saves a collection of lookups in RDM tenant according to the
JSON object definition. If you need to create just one lookup value then
please specify one JSON object in the array. The same API should be used
for create and update operations.
You can create a maximum of
100 lookup codes in a single request.
operationId: createTypeByTenant
parameters:
- name: tenantId
in: path
description: ID of the RDM tenant
required: true
schema:
type: string
- name: type
in: path
description: Lookup type for which values must be created
required: true
schema:
type: string
example: Country
requestBody:
description: A collection of lookups to be saved in a tenant
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Lookup Code'
examples:
sample:
description: Sample request for API
value:
- tenantId: user_tenant_id
type: rdm/lookupTypes/Country
code: US
enabled: true
startDate: 1577836800000
endDate: 3471292800000
parents:
- rdm/lookupTypes/Continent/NA
sourceMappings:
- source: Reltio
values:
- code: RLT_US
value: United States of America
description: USA definition in the Reltio source system.
enabled: true
canonicalValue: false
downStreamDefaultValue: false
localizations:
- languageCode: it-it
value: Stati Uniti d'America
description: United States of America in Italian translation.
attributes:
- name: Population
value: '331002651'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Response for lookup values'
example:
- uri: user_tenant_id/Country/US
value:
tenantId: user_tenant_id
type: rdm/lookupTypes/Country
code: US
enabled: true
sourceMappings:
- source: Reltio
values:
- code: RLT_US
value: United States of America
description: USA definition in the Reltio source system.
enabled: true
canonicalValue: true
downStreamDefaultValue: true
localizations:
- languageCode: it-it
value: Stati Uniti d'America
description: United States of America in Italian translation.
parents:
- rdm/lookupTypes/Continent/NA
attributes:
- name: Population
value: '331002651'
startDate: 1577836800000
endDate: 3471292800000
updatedBy: test.user
updateDate: 1611879917565
version: 5
'401':
description: The operation cannot be performed because user is unauthorized
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/API Error'
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/API Error'
extensions:
x-module: rdm
x-controllerName: com.reltio.rdm.rest.controller.DataController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Reference%20Data%20Management/createTypeByTenant
/services/lookups/{tenantId}/{type}/{code}:
put:
tags:
- Reference Data Management
summary: Saves lookups for the specified lookup type and specified code
description: >-
This API updates a lookup value for the specified lookup type and lookup
code. The response returns Success if the value is successfully
updated.
operationId: updateByTypeByLookupCode
parameters:
- name: code
in: path
required: true
schema:
pattern: .+
type: string
- name: tenantId
in: path
description: ID of the RDM tenant
required: true
schema:
type: string
- name: type
in: path
description: Lookup type for which values must be created
required: true
schema:
type: string
example: Country
requestBody:
description: A lookup to be saved in a tenant
content:
application/json:
schema:
$ref: '#/components/schemas/Lookup Code'
examples:
sample:
description: Sample request for API
value:
tenantId: user_tenant_id
type: rdm/lookupTypes/Country
code: US
enabled: true
startDate: 1577836800000
endDate: 3471292800000
parents:
- rdm/lookupTypes/Continent/NA
sourceMappings:
- source: Reltio
values:
- code: RLT_US
value: United States of America
description: USA definition in the Reltio source system.
enabled: true
canonicalValue: false
downStreamDefaultValue: false
localizations:
- languageCode: it-it
value: Stati Uniti d'America
description: United States of America in Italian translation.
attributes:
- name: Population
value: '331002651'
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Lookup Code'
'401':
description: The operation cannot be performed because user is unauthorized
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/API Error'
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/API Error'
extensions:
x-module: rdm
x-controllerName: com.reltio.rdm.rest.controller.DataController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Reference%20Data%20Management/updateByTypeByLookupCode
/services/unmapped/{tenantId}:
post:
tags:
- Reference Data Management
summary: Save lookup values that are not mapped to a canonical value.
description: >-
This API saves a collection of unmapped lookups in RDM tenant according
to the JSON object definition. If you need to create just one unmapped
lookup value then please specify one JSON object in the array. The same
API should be used for create and update operations.
You should
use this API when you have lookups from a source but still don't have
the corresponding canonical value in the lookup type. Once the canonical
value is defined for those unmapped lookups from a source, please use
Save Lookup API with the details from unmapped mapping and then delete
the unmapped value.
You can create a maximum of 100
unmapped values in a single request.
operationId: unmappedCreateByTenant
parameters:
- name: tenantId
in: path
description: ID of the RDM tenant
required: true
schema:
type: string
- name: onlyIfNoMapping
in: query
description: >-
If set to true, then unmapped values are created for values that do
not have a mapping on the tenant. If set to false, then unmapped
values are created for all values that are sent in the request.
schema:
type: boolean
enum:
- false
- true
default: false
requestBody:
description: A collection of unmapped lookups to be saved in a tenant
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Unmapped lookup'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Response for unmapped values'
example:
- uri: user_tenant_id/State/Reltio/AR
value:
tenantId: user_tenant_id
type: rdm/lookupTypes/State
source: Reltio
code: AR
value: Arkansas
attributes:
- name: Population
value: '3032812'
updatedBy: test.user
updateDate: 1611011146598
version: 0
'401':
description: The operation cannot be performed because user is unauthorized
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/API Error'
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/API Error'
extensions:
x-module: rdm
x-controllerName: com.reltio.rdm.rest.controller.UnmappedValuesController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Reference%20Data%20Management/unmappedCreateByTenant
/services/unmapped/{tenantId}/{type}:
post:
tags:
- Reference Data Management
summary: >-
Save lookup values that are not mapped to a canonical value for the
specified lookup type.
description: >-
This API saves a collection of unmapped lookups in RDM tenant according
to the JSON object definition. If you need to create just one unmapped
lookup value then please specify one JSON object in the array. The same
API should be used for create and update operations.
You should
use this API when you have lookups from a source but still don't have
the corresponding canonical value in the lookup type. Once the canonical
value is defined for those unmapped lookups from a source, please use
Save Lookup API with the details from unmapped mapping and then delete
the unmapped value.
You can create a maximum of 100
unmapped values in a single request.
operationId: unmappedCreateTypeByTenant
parameters:
- name: tenantId
in: path
description: ID of the RDM tenant
required: true
schema:
type: string
example: user_tenant_id
- name: type
in: path
description: Lookup type for which unmapped values must be created
required: true
schema:
type: string
example: Country
- name: onlyIfNoMapping
in: query
description: >-
If set to true, then unmapped values are created for values that do
not have a mapping on the tenant. If set to false, then unmapped
values are created for all values that are sent in the request.
schema:
type: boolean
enum:
- false
- true
default: false
requestBody:
description: >-
A collection of unmapped lookups to be saved in a tenant for the
specified lookup type
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Unmapped lookup'
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation Result'
example:
- uri: user_tenant_id/State/Reltio/AR
value:
tenantId: user_tenant_id
type: rdm/lookupTypes/State
source: Reltio
code: AR
value: Arkansas
attributes:
- name: Population
value: '3032812'
updatedBy: test.user
updateDate: 1611011146598
version: 0
'401':
description: The operation cannot be performed because user is unauthorized
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/API Error'
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/API Error'
extensions:
x-module: rdm
x-controllerName: com.reltio.rdm.rest.controller.UnmappedValuesController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Reference%20Data%20Management/unmappedCreateTypeByTenant
/services/reltio/api/{tenantId}/entities:
post:
tags:
- Entities
summary: Save Entities API creates entities.
description: >-
This API saves a collection of entities in Reltio Platform according to
JSON object definition. To create just one entity using this API,
specify one JSON object in the array.
If you post an entity with
some crosswalks (for example, crosswalk1 and crosswalk2),
and that entity corresponds to some existing entities (entity1
and entity2) in the Reltio Platform, then these entities are
merged in one entity referred as the survivor (for example,
entity1 would be merged in entity2). After this, the
resultant survivor entity (for example, entity2) is updated with
the new information from a posted entity. If no entities are found or
provided in the posted entity crosswalk or no crosswalks are provided,
then a new entity is created.
Note: If you do not specify
roles in the request, then all roles from the entity being overwritten
remain unchanged. To remove all roles from the resultant entity specify
an empty array of roles in the POST /entities request.
operationId: addToCollectionExtended
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: returnObjects
in: query
description: >-
Specifies if the response should contain created entities. Default
is true.
schema:
type: boolean
- name: options
in: query
description: >-
Comma-separated list of different options which affect endpoints
behaviour. Available options:- nonOvOnly - If it is specified,
then only attributes with ov="false" will be present in the
resulting JSON. This option is mutually exclusive with the ovOnly
option. Has a lower priority than ovOnly
- ovOnly - If it is
specified, then only attributes with ov="true" will be present in
the resulting JSON
- partialOverride - This option may be used
for POST /entities or POST /relations (override entity or relation)
request. If this option is presented, platform overrides attributes
that are specified in the request. We do not touch any other
attributes of the dataprovider
crosswalk
- partialOverrideForReference - This option may be
used for POST /entities (override entity) request. If this option is
presented, platform override all attributes, but for references we
do not touch any attributes not involved to
referencedAttributeURIs
- preserveHidden - This option may be
used for the POST /entities request. If it is true then API will not
delete hidden attributes if they are not specified in the
request
- preserveURIs - This option may be used for the POST
/entities request. If it is true then API takes into account uris
that are specified for attribute values inside the
request
- updateAttributeUpdateDates - This option may be used
for POST /entities and POST /relations requests.
'singleAttributeUpdateDates' property of crosswalks will be updated
for changed and new attributes if this option is
presented.
style: FORM
explode: false
schema:
type: array
items:
type: string
example: partialOverride
enum:
- partialOverride
- partialOverrideForReference
- updateAttributeUpdateDates
- ovOnly
- nonOvOnly
- preserveURIs
- preserveHidden
example: partialOverride
requestBody:
description: List of entities
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EntityTO'
examples:
sample:
description: Sample request for API
value:
- type: configuration/entityTypes/Individual
tags:
- motorcycles
attributes:
FirstName:
- value: William
LastName:
- value: Harley
BithCity:
- value: Milwaukee
Education:
- value:
Specialty:
value: Mechanical Engineering
SchoolName:
value: University of Nebraska
crosswalks:
- type: configuration/sources/LNKD
value: LNKD.123456
- type: configuration/entityTypes/Organization
tags:
- motorcycles
attributes:
Name:
- value: Harley-Davidson
Address:
value:
AddressLine1:
- value: 3700 West Juneau Avenue
City:
- value: Milwaukee
Country:
- value: US
refEntity:
crosswalks:
- type: configuration/sources/LNKD
value: LNKD.00000
crosswalks:
- type: configuration/sources/LNKD
value: LNKD.7891
required: true
responses:
'200':
description: Entities are successfully saved
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ObjectEntryEntityTO'
example:
- index: 0
object:
uri: entities/1jc0x5UK
type: configuration/entityTypes/Individual
createdBy: user
createdTime: 1609325607520
updatedBy: user
updatedTime: 1609325607520
attributes:
LastName:
- type: >-
configuration/entityTypes/Individual/attributes/LastName
ov: true
value: Harley
uri: entities/1jc0x5UK/attributes/LastName/3Z3Tq6FRU
FirstName:
- type: >-
configuration/entityTypes/Individual/attributes/FirstName
ov: true
value: William
uri: entities/1jc0x5UK/attributes/FirstName/3Z3Tq6BBE
Education:
- label: University of Nebraska,
value:
SchoolName:
- type: >-
configuration/entityTypes/Individual/attributes/Education/attributes/SchoolName
ov: true
value: University of Nebraska
uri: >-
entities/1jc0x5UK/attributes/Education/3Z3Tq6Jhk/SchoolName/3Z3Tq6Ny0
ov: true
uri: entities/1jc0x5UK/attributes/Education/3Z3Tq6Jhk
isFavorite: false
crosswalks:
- uri: entities/1jc0x5UK/crosswalks/3Z3Tq6SEG
type: configuration/sources/LNKD
value: LNKD.123456
reltioLoadDate: '2020-12-30T10:53:27.520Z'
createDate: '2020-12-30T10:53:27.520Z'
updateDate: '2020-12-30T10:53:27.520Z'
attributes:
- entities/1jc0x5UK/attributes/Education/3Z3Tq6Jhk
- entities/1jc0x5UK/attributes/FirstName/3Z3Tq6BBE
- >-
entities/1jc0x5UK/attributes/Education/3Z3Tq6Jhk/SchoolName/3Z3Tq6Ny0
- entities/1jc0x5UK/attributes/LastName/3Z3Tq6FRU
singleAttributeUpdateDates: {}
analyticsAttributes: {}
tags:
- motorcycles
label: ''
secondaryLabel: ''
successful: true
- index: 1
object:
uri: entities/1jc0x9ka
type: configuration/entityTypes/Organization
createdBy: user
createdTime: 1609325607520
updatedBy: user
updatedTime: 1609325607520
attributes:
Name:
- type: >-
configuration/entityTypes/Organization/attributes/Name
ov: true
value: Harley-Davidson
uri: entities/1jc0x9ka/attributes/Name/3Z3Tq6WUW
Address:
- label: 3700 West Juneau Avenue Milwaukee
relationshipLabel: ''
value:
AddressLine1:
- type: >-
configuration/entityTypes/Location/attributes/AddressLine1
ov: true
value: 3700 West Juneau Avenue
uri: >-
entities/1jc0x9ka/attributes/Address/1BlYvJy8/AddressLine1/3Z3Tq6jHI
City:
- type: >-
configuration/entityTypes/Location/attributes/City
ov: true
value: Milwaukee
uri: >-
entities/1jc0x9ka/attributes/Address/1BlYvJy8/City/3Z3Tq6nXY
Country:
- type: >-
configuration/entityTypes/Location/attributes/Country
ov: true
value: USA
lookupCode: US
lookupRawValue: US
uri: >-
entities/1jc0x9ka/attributes/Address/1BlYvJy8/Country/3Z3Tq6rno
ov: true
uri: entities/1jc0x9ka/attributes/Address/1BlYvJy8
refEntity:
type: configuration/entityTypes/Location
crosswalks:
- uri: >-
entities/1jc0x9ka/crosswalks/1jc0xE0q.3Z3Tq6w44
type: configuration/sources/LNKD
value: LNKD.00000
attributeURIs:
- >-
entities/1jc0x9ka/attributes/Address/1BlYvJy8/City/3Z3Tq6nXY
- >-
entities/1jc0x9ka/attributes/Address/1BlYvJy8/Country/3Z3Tq6rno
- >-
entities/1jc0x9ka/attributes/Address/1BlYvJy8
- >-
entities/1jc0x9ka/attributes/Address/1BlYvJy8/AddressLine1/3Z3Tq6jHI
objectURI: entities/1jc0xE0q
refRelation:
type: configuration/relationTypes/HasAddress
crosswalks:
- uri: >-
entities/1jc0x9ka/crosswalks/1BlYvJy8.3Z3Tq78qq
type: configuration/sources/Reltio
value: 1BlYvJy8
startRefPinned: false
endRefPinned: false
startRefIgnored: false
endRefIgnored: false
objectURI: relations/1BlYvJy8
startObjectCrosswalks:
- type: configuration/sources/LNKD
value: LNKD.7891
isFavorite: false
crosswalks:
- uri: entities/1jc0x9ka/crosswalks/3Z3Tq70KK
type: configuration/sources/LNKD
value: LNKD.7891
reltioLoadDate: '2020-12-30T10:53:27.520Z'
createDate: '2020-12-30T10:53:27.520Z'
updateDate: '2020-12-30T10:53:27.520Z'
attributes:
- entities/1jc0x9ka/attributes/Name/3Z3Tq6WUW
singleAttributeUpdateDates: {}
analyticsAttributes: {}
tags:
- motorcycles
label: Harley-Davidson
secondaryLabel: ''
successful: true
'400':
description: Entities aren't saved due to a reason provided in the error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.data.spring.EntityController
x-codegen-request-body-name: entitiesArray
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Entities/addToCollectionExtended
/services/reltio/api/{tenantId}/entities/_conditional:
post:
tags:
- Entities
summary: Search Before Create Aggregated API
description: >-
This API is an aggregate of Search and Save API.It retrieves the
individual entities or searches for multiple entities and based on the
search result, this API saves a collection of entities in Reltio
Platform according to JSON object definition.
operationId: aggregatedSearchBeforeCreate
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: filter
in: query
description: >-
Enables entities filtering by a condition. Format for filter query
parameter: filter=({Condition Type}[AND/OR {Condition Type}]*).
For more information, please visit https://docs.reltio.com
schema:
type: string
example: equals(type,'configuration/entityTypes/Individual')
- name: select
in: query
description: >-
Comma-separated list of properties from object structure that should
be returned in a response. Allows you to return a partial object.
List of object properties you can find at the response model.
Additional system properties are:- attributes._lookupCodes:
return codes for lookup
attributes.
- attributes._lookupValues: return values for
lookup attributes.
schema:
type: string
example: >-
uri,label,type,updatedTime,createdTime,createdBy,updatedBy,tags,crosswalks,attributes.SimpleAttribute,attributes._lookupCodes,attributes._lookupValues
- name: max
in: query
description: >-
Positive Integer value to identify maximum number of entities to
return in a response. Can be used to organize pagination in
combination with the "offset" parameter.
schema:
type: int
default: '50'
- name: offset
in: query
description: >-
Positive Integer value to identify starting what element in a result
set should be returned in a response. Can be used to organize
pagination in combination with the max parameter.
schema:
type: int
default: '0'
- name: sort
in: query
description: >-
Entity objects property that should be used for sorting. Can be used
in combination with the "order" parameter to have reverse order. If
this parameter is not provided or if the value cannot be recognized,
then no sorting is used.
schema:
type: string
example: attributes.FirstName
- name: order
in: query
description: >-
Order of sorting. Applicable only in combination with the sort
parameter. Possible values:
- asc - results are shown in ascending order.
- desc -
results are shown in descending order.
schema:
type: string
default: asc
enum:
- asc
- desc
example: desc
- name: defaultMaxValues
in: query
description: >-
Specifies maximum number of values listed in attributes. This
restriction is intended for more efficient responses in the case of
very long lists of values in some attributes.
schema:
type: int
- name: scoreEnabled
in: query
description: >-
When set to true, documents with search hits in labels get more
search relevance score.
schema:
type: boolean
default: false
- name: activeness
in: query
description: >-
Defines whether to include active and expired entities into the
results. By default, only active entities are included in the
response. Possible values:
- all - include both active and expired
entities
- active - include only active
entities
- not_active - include only expired
entities
schema:
type: string
default: active
enum:
- all
- active
- not_active
example: all
- name: returnObjects
in: query
description: >-
Specifies if the response should contain created entities. Default
is true.
schema:
type: boolean
- name: options
in: query
description: >-
Comma-separated list of different options which affect endpoints
behaviour. Available options:- nonOvOnly - If it is specified,
then only attributes with ov="false" will be present in the
resulting JSON. This option is mutually exclusive with the ovOnly
option. Has a lower priority than ovOnly
- ovOnly - If it is
specified, then only attributes with ov="true" will be present in
the resulting JSON
- partialOverride - This option may be used
for POST /entities or POST /relations (override entity or relation)
request. If this option is presented, platform overrides attributes
that are specified in the request. We do not touch any other
attributes of the dataprovider
crosswalk
- partialOverrideForReference - This option may be
used for POST /entities (override entity) request. If this option is
presented, platform override all attributes, but for references we
do not touch any attributes not involved to
referencedAttributeURIs
- preserveHidden - This option may be
used for the POST /entities request. If it is true then API will not
delete hidden attributes if they are not specified in the
request
- preserveURIs - This option may be used for the POST
/entities request. If it is true then API takes into account uris
that are specified for attribute values inside the
request
- updateAttributeUpdateDates - This option may be used
for POST /entities and POST /relations requests.
'singleAttributeUpdateDates' property of crosswalks will be updated
for changed and new attributes if this option is
presented.
style: FORM
explode: false
schema:
type: array
items:
type: string
example: partialOverride
enum:
- partialOverride
- partialOverrideForReference
- updateAttributeUpdateDates
- ovOnly
- nonOvOnly
- preserveURIs
- preserveHidden
example: partialOverride
- name: applyIfNoMatches
in: query
description: >-
Specifies if the system should apply the request body depending on
search results. Default is true.
schema:
type: boolean
default: true
- name: returnMatches
in: query
description: >-
Specifies if the system should return the search results in the
response. Default is true.
schema:
type: boolean
default: true
requestBody:
description: List of entities
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EntityTO'
examples:
sample:
description: Sample request for API
value:
- type: configuration/entityTypes/Individual
tags:
- motorcycles
attributes:
FirstName:
- value: William
LastName:
- value: Harley
BithCity:
- value: Milwaukee
Education:
- value:
Specialty:
value: Mechanical Engineering
SchoolName:
value: University of Nebraska
crosswalks:
- type: configuration/sources/LNKD
value: LNKD.123456
- type: configuration/entityTypes/Organization
tags:
- motorcycles
attributes:
Name:
- value: Harley-Davidson
Address:
value:
AddressLine1:
- value: 3700 West Juneau Avenue
City:
- value: Milwaukee
Country:
- value: US
refEntity:
crosswalks:
- type: configuration/sources/LNKD
value: LNKD.00000
crosswalks:
- type: configuration/sources/LNKD
value: LNKD.7891
required: true
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ObjectEntryEntityTO'
extensions:
x-module: server
x-controllerName: com.reltio.rest.data.spring.EntityController
x-codegen-request-body-name: entitiesArray
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Entities/aggregatedSearchBeforeCreate
/services/reltio/api/{tenantId}/interactions:
post:
tags:
- Interactions
summary: Creates a collection of interactions in a tenant
description: >-
This API creates a collection of interactions in the Reltio Platform
according to the JSON object definition. To create just one interaction
using this API, specify one JSON object in the array.
operationId: addToCollectionByTenant
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: Source-System
in: header
description: >-
This parameter indicates the source system that this request is
representing. For example, "configuration/sources/Reltio" indicates
that the data is not loaded from other source systems and is instead
created in the Reltio Platform directly.
schema:
type: string
example: configuration/sources/Reltio
- name: crosswalkValue
in: query
description: >-
This parameter indicates the identifier of an interaction object in
the source system
schema:
type: string
- name: returnObjects
in: query
description: >-
This parameter specifies if the response must contain the created
objects
schema:
type: boolean
default: true
- name: options
in: query
description: >-
Comma-separated list of different options which affect endpoints
behaviour. Available options:- sendHidden - Specifies whether
the hidden attributes will appear in the response
style: FORM
explode: false
schema:
type: array
items:
type: string
example: sendHidden
enum:
- sendHidden
example: sendHidden
requestBody:
description: Interactions
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/InteractionTO'
examples:
sample:
description: Sample request for API
value:
- type: configuration/interactionTypes/Lunch
timestamp: 1338580800000
attributes:
Place:
- value: Shire, Bag End in Hobbiton
Notes:
- value: All participants eat Lembas
members:
Organizers:
type: >-
configuration/interactionTypes/Lunch/memberTypes/Organizers
members:
- objectURI: entities/1k4YosFA
Chefs:
type: configuration/interactionTypes/Lunch/memberTypes/Chefs
members:
- objectURI: entities/1bEwbLFb
Participants:
type: >-
configuration/interactionTypes/Lunch/memberTypes/Participants
members:
- objectURI: entities/1bEwbPVr
- objectURI: entities/2eBqY9qG
- objectURI: entities/1k4YpQLE
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ObjectEntryInteractionTO'
example:
- index: 0
object:
uri: interactions/Reltio+17607182221208
type: configuration/interactionTypes/Lunch
createdBy: user
createdTime: 1611834353203
updatedBy: user
updatedTime: 1611834353203
timestamp: 1338580800000
attributes:
Place:
- type: >-
configuration/interactionTypes/Lunch/attributes/Place
ov: true
value: Shire, Bag End in Hobbiton
uri: >-
interactions/Reltio+17607182221208/attributes/Place/0
Notes:
- type: >-
configuration/interactionTypes/Lunch/attributes/Notes
ov: true
value: All participants eat Lembas
uri: >-
interactions/Reltio+17607182221208/attributes/Notes/1
crosswalks:
- uri: >-
interactions/Reltio+17607182221208/crosswalks/3rxcFjuuW
type: configuration/sources/Reltio
value: '17607182221208'
reltioLoadDate: '2021-01-28T11:45:53.203Z'
createDate: '2021-01-28T11:45:53.203Z'
updateDate: '2021-01-28T11:45:53.203Z'
attributes:
- >-
interactions/Reltio+17607182221208/attributes/Place/0
- >-
interactions/Reltio+17607182221208/attributes/Notes/1
singleAttributeUpdateDates: {}
members:
Participants:
type: >-
configuration/interactionTypes/Lunch/memberTypes/Participants
uri: >-
interactions/Reltio+17607182221208/members/Participants
members:
- objectURI: entities/1bEwbPVr
- objectURI: entities/2eBqY9qG
- objectURI: entities/1k4YpQLE
Chefs:
type: configuration/interactionTypes/Lunch/memberTypes/Chefs
uri: interactions/Reltio+17607182221208/members/Chefs
members:
- objectURI: entities/1bEwbLFb
Organizers:
type: >-
configuration/interactionTypes/Lunch/memberTypes/Organizers
uri: interactions/Reltio+17607182221208/members/Organizers
members:
- objectURI: entities/1k4YosFA
isFavorite: false
successful: true
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.data.spring.InteractionController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Interactions/addToCollectionByTenant
/services/reltio/api/{tenantId}/rawInteractions:
post:
tags:
- Interactions
summary: Creates a raw collection of interactions in a tenant
description: >-
This API creates a collection of raw interactions in the Reltio Platform
according to the JSON object definition. To create just one interaction
using this API, specify one JSON object in the array.
operationId: addRawToCollectionByTenant
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: Source-System
in: header
description: >-
This parameter indicates the source system that this request is
representing. For example, "configuration/sources/Reltio" indicates
that the data is not loaded from other source systems and is instead
created in the Reltio Platform directly.
schema:
type: string
example: configuration/sources/Reltio
- name: crosswalkValue
in: query
description: >-
This parameter indicates the identifier of an interaction object in
the source system
schema:
type: string
- name: returnObjects
in: query
description: >-
This parameter specifies if the response must contain the created
objects
schema:
type: boolean
default: true
- name: options
in: query
description: >-
Comma-separated list of different options which affect endpoints
behaviour. Available options:- sendHidden - Specifies whether
the hidden attributes will appear in the response
style: FORM
explode: false
schema:
type: array
items:
type: string
example: sendHidden
enum:
- sendHidden
example: sendHidden
requestBody:
description: Interactions
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/InteractionTO'
examples:
sample:
description: Sample request for API
value:
- type: configuration/interactionTypes/Lunch
timestamp: 1338580800000
attributes:
Place:
- value: Shire, Bag End in Hobbiton
Notes:
- value: All participants eat Lembas
members:
Organizers:
type: >-
configuration/interactionTypes/Lunch/memberTypes/Organizers
members:
- objectURI: entities/1k4YosFA
Chefs:
type: configuration/interactionTypes/Lunch/memberTypes/Chefs
members:
- objectURI: entities/1bEwbLFb
Participants:
type: >-
configuration/interactionTypes/Lunch/memberTypes/Participants
members:
- objectURI: entities/1bEwbPVr
- objectURI: entities/2eBqY9qG
- objectURI: entities/1k4YpQLE
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ObjectEntryRawInteractionTO'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.data.spring.InteractionController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Interactions/addRawToCollectionByTenant
/services/reltio/api/{tenantId}/relations:
post:
tags:
- Relationships
summary: Save Relationships API creates relationships.
description: >-
This API saves a collection of relations in the Reltio Platform
according to the JSON object definition or to create just one relation
using this API, specify one JSON object in the array. You can use the
referenced entityURI or referenced entity crosswalk to describe
the startObject and/or the endObject.
When a new
relation is created with URIs for start and end objects, inconsistencies
may appear if the relation is created with empty crosswalks inside the
startObject and endObject sections. If the
connectRelationsToDefaultCrosswalk property available in the
physical configuration is enabled and then you create a relation, the
startObject and endObject sections are filled with the
default crosswalks automatically.
Note: A crosswalk with
the source, which is equal to the value of the default crosswalk in the
physical configuration (default value is Reltio), and
value= is considered as the default
crosswalk.
If the connectRelationsToDefaultCrosswalk
property is set to true when a relation is created with empty
crosswalks for the start and end objects of the relation, the following
rules are applied:- If the start entity has a Reltio crosswalk
with the same value as its ID, this crosswalk is used as the crosswalk
for the start object in the relation. Else, a new Reltio crosswalk with
the value equal to the entity ID is created. This new crosswalk is added
to the winner contributor of the start entity and the start object of
the relation is connected to this new Reltio crosswalk.
- The
behavior is the same for the end entity. If the end entity has a Reltio
crosswalk with the same value as its ID, this crosswalk is used as the
crosswalk for the end object in the relation. Else, a new Reltio
crosswalk with the value equal to the entity ID is created. This new
crosswalk is added to the winner contributor of the end entity and the
end object of the relation is connected to this new Reltio
crosswalk.
operationId: addToCollectionExtendedByTenant
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: returnObjects
in: query
description: >-
Specifies if the response should contain created relations. Default
is true.
schema:
type: boolean
- name: options
in: query
description: >-
Comma-separated list of different options which affect endpoints
behaviour. Available options:- ignoreOverrideIgnorePinSetting
- This option may be used for POST /entities and POST /relations
requests. If it is specified then 'overrideIgnorePin' setting in
business model will be ignored for the 'override'
action
- partialOverride - This option may be used for POST
/entities or POST /relations (override entity or relation) request.
If this option is presented, platform overrides attributes that are
specified in the request. We do not touch any other attributes of
the dataprovider crosswalk
- rejectRelationsToInactiveObjects
- This option may be used to validate entities used for creating
relations should be active. If the value is present it will not
allow the creation of relation if any/both entity is/are
inactive
- updateAttributeUpdateDates - This option may be
used for POST /entities and POST /relations requests.
'singleAttributeUpdateDates' property of crosswalks will be updated
for changed and new attributes if this option is
presented.
style: FORM
explode: false
schema:
type: array
items:
type: string
example: partialOverride
enum:
- partialOverride
- updateAttributeUpdateDates
- ignoreOverrideIgnorePinSetting
- rejectRelationsToInactiveObjects
example: partialOverride
requestBody:
description: List of relations
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RelationTO'
examples:
sample:
description: Sample request for API
value:
- type: configuration/relationTypes/affiliatedwith
startObject:
crosswalks:
- type: configuration/sources/LNKD
value: LNKD.123456
endObject:
crosswalks:
- type: configuration/sources/LNKD
value: LNKD.7891
attributes:
Title:
- value: Co-Founder
required: true
responses:
'200':
description: Relationships are successfully saved
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ObjectEntryRelationTO'
example:
- index: 0
object:
uri: relations/160J8a4W
type: configuration/relationTypes/affiliatedwith
createdBy: user
createdTime: 1608726311406
updatedBy: user
updatedTime: 1608726311406
startRefPinned: false
startRefIgnored: false
endRefPinned: false
endRefIgnored: false
attributes:
Title:
- type: >-
configuration/relationTypes/affiliatedwith/attributes/Title
ov: true
value: Co-Founder
uri: relations/160J8a4W/attributes/Title/3oF6b2Kvw
crosswalks:
- uri: relations/160J8a4W/crosswalks/3oF6b2PCC
type: configuration/sources/Reltio
value: 160J8a4W
reltioLoadDate: '2020-12-23T12:25:11.406Z'
createDate: '2020-12-23T12:25:11.406Z'
updateDate: '2020-12-23T12:25:11.406Z'
attributes:
- relations/160J8a4W/attributes/Title/3oF6b2Kvw
singleAttributeUpdateDates: {}
startObject:
type: configuration/entityTypes/Individual
objectURI: entities/1Gwx4T0r
label: ''
directionalLabel: affiliated with
crosswalks:
- uri: entities/1Gwx4T0r/crosswalks/37Fe8QRwH
type: configuration/sources/LNKD
value: LNKD.123456
reltioLoadDate: '2020-12-22T22:19:14.633Z'
createDate: '2020-12-22T22:19:14.633Z'
updateDate: '2020-12-22T22:19:14.633Z'
attributes:
- entities/1Gwx4T0r/attributes/Education/37Fe8QJPl
- >-
entities/1Gwx4T0r/attributes/Education/37Fe8QJPl/SchoolName/37Fe8QNg1
- entities/1Gwx4T0r/attributes/FirstName/37Fe8QAtF
- entities/1Gwx4T0r/attributes/LastName/37Fe8QF9V
singleAttributeUpdateDates: {}
endObject:
type: configuration/entityTypes/Organization
objectURI: entities/1ZZpxD8S
label: Harley-Davidson
directionalLabel: affiliated with
crosswalks:
- uri: entities/1ZZpxD8S/crosswalks/2yk1U7FHM
type: configuration/sources/LNKD
value: LNKD.7891
reltioLoadDate: '2020-12-23T12:24:12.381Z'
createDate: '2020-12-23T12:24:12.381Z'
updateDate: '2020-12-23T12:24:12.381Z'
attributes:
- entities/1ZZpxD8S/attributes/Name/2yk1U6lRY
singleAttributeUpdateDates: {}
successful: true
'400':
description: >-
Relationships aren't saved due to a reason provided in the error
message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.data.spring.RelationController
x-codegen-request-body-name: relations
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Relationships/addToCollectionExtendedByTenant
/services/reltio/api/{tenantId}/segments:
post:
tags:
- Segments
summary: Creates a collection of segments in a tenant
description: >-
This API creates a collection of segments in the Reltio Platform
according to the JSON object definition. To create just one segment
using this API, specify one JSON object in the array.
operationId: addToCollectionByTenant
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
requestBody:
description: Segments
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SegmentTO'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ObjectEntrySegmentTO'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.data.spring.SegmentController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Data%20Ingestion#/Segments/addToCollectionByTenant
components:
schemas:
APIErrorRepresentation:
type: object
properties:
severity:
type: string
description: Severity of the error message
readOnly: true
example: Error
errorMessage:
type: string
description: Brief error message
readOnly: true
example: Brief error message here
errorCode:
type: integer
description: Unique code of the error
format: int32
readOnly: true
example: 123
errorDetailMessage:
type: string
description: Detailed error message
readOnly: true
example: Detailed error message here
innerErrorData:
$ref: '#/components/schemas/APIException'
description: Model representing API error
UnauthorizedErrorModel:
type: object
properties:
error:
type: string
description: Brief information about the error
readOnly: true
example: invalid_token
error_description:
type: string
description: Additional details about the error
readOnly: true
example: 'Token is invalid: 6e4f0d00-7bcf-4be5-b583-f47916495d39'
description: Model representing API error
MappingDetailsTO:
required:
- mappingForObjectType
- mappingName
- mappingSummary
- objectTypeUri
type: object
properties:
createdBy:
type: string
description: Created by user
readOnly: true
example: abc@reltio.com
createdDate:
type: string
description: Creation date is milliseconds
format: date-time
readOnly: true
updatedBy:
type: string
description: Updated by user
readOnly: true
example: xyz@reltio.com
updatedDate:
type: string
description: Update date is milliseconds
format: date-time
readOnly: true
mappingId:
type: integer
description: System generated read only mapping id
format: int32
readOnly: true
mappingName:
type: string
description: 'User defined mapping name '
tenantId:
type: string
description: Tenant Id for which the mapping is created
readOnly: true
shareMappingDetails:
type: boolean
description: Allow use of mapping with multiple job definitions
projectIds:
type: array
description: IDs of Job definition using mapping
readOnly: true
items:
type: string
mappingForObjectType:
type: string
description: Reltio object type
enum:
- ENTITIES
- RELATIONS
- ANALYTICS_ATTRIBUTES
- INTERACTIONS
- SCHEMALESS_INTERACTIONS
objectTypeUri:
type: string
description: Reltio object type uri
mappingSummary:
type: string
description: Attributes to source mapping
description: Mapping object model
CustomBucketsDetailsTO:
type: object
properties:
createdBy:
type: string
description: Created by user
readOnly: true
example: abc@reltio.com
createdDate:
type: string
description: Creation date is milliseconds
format: date-time
readOnly: true
updatedBy:
type: string
description: Updated by user
readOnly: true
example: xyz@reltio.com
updatedDate:
type: string
description: Update date is milliseconds
format: date-time
readOnly: true
id:
type: string
description: System generated storage ID
readOnly: true
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
shared:
type: boolean
errorBucket:
type: string
description: Custom bucket to store the final error files of the load job
example: my-bucket-for-data-load-error-files
errorAccount:
$ref: '#/components/schemas/StorageAccountTO'
description: Custom Buckets Details object model
StorageAccountTO:
type: object
properties:
createdBy:
type: string
description: Created by user
readOnly: true
example: abc@reltio.com
createdDate:
type: string
description: Creation date is milliseconds
format: date-time
readOnly: true
updatedBy:
type: string
description: Updated by user
readOnly: true
example: xyz@reltio.com
updatedDate:
type: string
description: Update date is milliseconds
format: date-time
readOnly: true
accountId:
type: integer
description: System generated account id
format: int32
readOnly: true
accountName:
type: string
description: Storage Account name
accountType:
type: string
description: Storage Account type
enum:
- UPLOADED
- GCP
- AWS_S3
- SFTP
- AZURE
credentials:
type: string
description: >-
Credentials with keys and secret to connect to remote storages. Can
be provided as JSON object or Base64 encoded string (Legacy way).
Response returns credentials as Base64 encoded string.
AWS S3 (Role-Based - Recommended):
{
"role": "arn:aws:iam::123456789012:role/role.client.dataloader.myname",
"externalId": "reltio-dataloader",
"region": "us-west-1"
}AWS S3 (Access Key/Secret - Legacy):
{
"accessKey": "ABC...EXAMPLE",
"secretKey": "xyz...EXAMPLEKEY",
"region": "us-east-1"
}GCP (Service Account):
{
"type": "service_account",
"project_id": "my-project",
"private_key_id": "key-id",
"private_key": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n",
"client_email": "service-account@project.iam.gserviceaccount.com",
...
}Azure (Storage Account):
{
"cloudAccountName": "mystorageaccount",
"cloudAccountKey": "my-azure-storage-key"
}SFTP:
{
"host": "sftp.example.com",
"userName": "myuser",
"password": "mypassword"
}
description: Storage Account object model
SchedulingDetailsTO:
type: object
properties:
createdBy:
type: string
description: Created by user
readOnly: true
example: abc@reltio.com
createdDate:
type: string
description: Creation date is milliseconds
format: date-time
readOnly: true
updatedBy:
type: string
description: Updated by user
readOnly: true
example: xyz@reltio.com
updatedDate:
type: string
description: Update date is milliseconds
format: date-time
readOnly: true
id:
type: string
description: System generated read only scheduled job id
readOnly: true
scheduledJobId:
type: string
readOnly: true
cronExpression:
type: string
description: Expression representing scheduler
example: 0 0 0 * * *
startDate:
type: integer
description: Job start date
format: int64
endDate:
type: integer
description: Schedule end date
format: int64
StorageDetailsTO:
required:
- sourcePath
type: object
properties:
createdBy:
type: string
description: Created by user
readOnly: true
example: abc@reltio.com
createdDate:
type: string
description: Creation date is milliseconds
format: date-time
readOnly: true
updatedBy:
type: string
description: Updated by user
readOnly: true
example: xyz@reltio.com
updatedDate:
type: string
description: Update date is milliseconds
format: date-time
readOnly: true
storageId:
type: string
description: System generated storage ID
readOnly: true
shareSourceInfo:
type: boolean
description: Allow use of storage details with multiple job definitions
bucketName:
type: string
description: S3/GCP/Azure storage bucket name
sourcePath:
type: string
description: source file location
fileMask:
type: string
description: >-
common file prefix to filter and pick one or more files from
provided source path
delimiter:
type: string
description: CSV file delimiter value
storageAccount:
$ref: '#/components/schemas/StorageAccountTO'
totalRecords:
type: integer
format: int32
readOnly: true
projectDetailsTO:
$ref: '#/components/schemas/ProjectDetailsTO'
fileType:
type: string
enum:
- CSV
- JSON
- RELTIO_JSON
- XLSX
description: Storage Details object model
ProjectDetailsTO:
required:
- environment
- loadType
type: object
properties:
createdBy:
type: string
description: Created by user
readOnly: true
example: abc@reltio.com
createdDate:
type: string
description: Creation date is milliseconds
format: date-time
readOnly: true
updatedBy:
type: string
description: Updated by user
readOnly: true
example: xyz@reltio.com
updatedDate:
type: string
description: Update date is milliseconds
format: date-time
readOnly: true
id:
type: string
description: System generated job definition id
readOnly: true
name:
type: string
description: Job definition name
projectStatus:
type: string
description: Project status
example: COMPLETED
progressStatus:
type: string
description: Job definition creation progress status
example: Define
environment:
type: string
description: Environment for which job definition is getting created
tenantId:
type: string
description: Job definition tenant
readOnly: true
priority:
type: string
enum:
- LOW
- NORMAL
- HIGH
updateType:
type: string
description: Update type, full or partial update
example: UPDATE_MERGED
enum:
- FULL_UPDATE
- UPDATE_MERGED
errorFileLocation:
type: string
description: Location of error files
readOnly: true
operationStatus:
type: string
description: Operation status
loadType:
type: string
description: Loading for object type
enum:
- ENTITIES
- RELATIONS
- ANALYTICS_ATTRIBUTES
- INTERACTIONS
- SCHEMALESS_INTERACTIONS
platformDomain:
type: string
description: Domain Name for PlatformUrl's default reltio.com
enum:
- reltio.com
- reltiocn.cn
additionalAttributes:
type: string
description: json representing additional configuration of job definition
groupingEnabled:
type: boolean
premiumMode:
type: boolean
storageDetails:
$ref: '#/components/schemas/StorageDetailsTO'
customBucketsDetails:
$ref: '#/components/schemas/CustomBucketsDetailsTO'
mappingDetails:
$ref: '#/components/schemas/MappingDetailsTO'
schedulingDetails:
$ref: '#/components/schemas/SchedulingDetailsTO'
JobDetailsTO:
type: object
properties:
createdBy:
type: string
description: Created by user
readOnly: true
example: abc@reltio.com
createdDate:
type: string
description: Creation date is milliseconds
format: date-time
readOnly: true
updatedBy:
type: string
description: Updated by user
readOnly: true
example: xyz@reltio.com
updatedDate:
type: string
description: Update date is milliseconds
format: date-time
readOnly: true
isDeleted:
type: boolean
description: Is job deleted
readOnly: true
udl:
type: boolean
description: Is udl job
id:
type: string
description: System generated job id
readOnly: true
name:
type: string
jobStatus:
type: string
enum:
- ERROR
- JOB_EXECUTED
- FILE_DOWNLOAD
- FILE_DOWNLOAD_FINISHED
- DATAFLOW_EXECUTED
- DATAFLOW_FINISHED
- STOPPING_DATAFLOW
- UPLOAD_TO_S3
- UPLOAD_TO_S3_FINISHED
- DATA_LOAD_TASK_EXECUTED
- DATALOAD_COMPLETED_WITH_ERRORS
- PROCESSING_ERRORS
- COMPLETED
- COMPLETED_WITH_ERRORS
- SCHEDULED
- STOPPING
- STOPPED
- SAVED
- DELETED
- MAPPING_PROCESSING
- MAPPING_PROCESSING_FINISHED
- DATA_LOAD_TASK_PAUSED
- DATA_LOAD_TASK_CANCELED
- DATA_LOAD_TASK_FAILED
- DATA_LOAD_TASK_COMPLETED_WITH_ERRORS
- PROFILES_LOAD_IN_PROGRESS
- DCR_LOAD_IN_PROGRESS
- CANCELLED
- CANCELLING_PLATFORM_TASK
- PLATFORM_TASK_FAILED
- PLATFORM_TASK_CANCELED
- PLATFORM_TASK_COMPLETED_WITH_ERRORS
- WAITING_FOR_AVAILABLE_THREADS
- WAITING_FOR_PREMIUM_JOBS_TO_COMPLETE
- WAITING_FOR_OLD_JOBS_TO_COMPLETE
- PREPROCESSING
- PAUSING
- PAUSED
dataProcessingJobId:
type: string
description: Data processing job id
readOnly: true
dataFlowId:
type: string
description: Data flow id
readOnly: true
periodicTasks:
type: string
description: Platform task IDs
readOnly: true
loadType:
type: string
description: Data load type
readOnly: true
enum:
- ENTITIES
- RELATIONS
- ANALYTICS_ATTRIBUTES
- INTERACTIONS
- SCHEMALESS_INTERACTIONS
errorDetails:
type: string
description: Job error details
readOnly: true
errorFileBucket:
type: string
description: Error file bucket
readOnly: true
errorFileLocation:
type: string
description: Location of error files in GCS
readOnly: true
errorFileNamesWithPath:
type: string
errorFileSourceType:
type: string
executedDate:
type: integer
description: Job execution date
format: int64
readOnly: true
endDate:
type: integer
description: Job end date
format: int64
readOnly: true
totalRecords:
type: integer
description: Total records processed by job
format: int32
readOnly: true
processedRecordsCount:
type: integer
description: Success records count
format: int32
readOnly: true
failedRecords:
type: string
readOnly: true
failedRecordsCount:
type: integer
description: Failed records count
format: int32
readOnly: true
jobSummary:
type: string
description: Additional information about various job statistics
readOnly: true
premiumMode:
type: boolean
description: Enables job to run in premium mode
priority:
type: string
description: Defines job execution order
enum:
- LOW
- NORMAL
- HIGH
projectDetails:
$ref: '#/components/schemas/ProjectDetailsTO'
API Error:
type: object
properties:
errorMessage:
type: string
description: Error message
readOnly: true
example: >-
Incorrect tenant id provided for value:
user_tenant_id/State/Reltio/AR
errorCode:
type: integer
description: Error code
format: int32
readOnly: true
example: 400
innerErrorData:
$ref: '#/components/schemas/API Exception'
description: Contains detailed information about occurred error
Lookup Code:
required:
- tenantId
- type
type: object
properties:
tenantId:
type: string
description: >-
ID of the RDM tenant. It has to match the following Regex pattern:
[a-zA-Z_0-9]{2,32}.
example: user_tenant_id
type:
type: string
description: Lookup Type URI. It has to starts with 'rdm/lookupTypes/'.
example: rdm/lookupTypes/Country
code:
type: string
description: >-
Canonical code. If a generator is defined for the Lookup Type then
code might be omitted otherwise it is required.
example: US
enabled:
type: boolean
description: >-
Status flag for the lookup code to enable it to use in transcoding
operations. Default value is true.
example: true
startDate:
type: integer
description: Timestamp of the date when the lookup code will be enabled.
format: int64
example: 1577836800000
endDate:
type: integer
description: Timestamp of the date when the lookup code will be disabled.
format: int64
example: 3471292800000
parents:
type: array
description: List of parents for the lookup code.
example: '["rdm/lookupTypes/Continent/NA"]'
items:
type: string
sourceMappings:
type: array
description: >-
Mapping definitions between a source system and values which can
come from this source system.
items:
$ref: '#/components/schemas/Source Mapping'
localizations:
type: array
description: Lookup value definitions for different languages.
items:
$ref: '#/components/schemas/Lookup Localization'
attributes:
type: array
description: Attribute values of the lookup code.
items:
$ref: '#/components/schemas/Lookup Attribute Value'
updatedBy:
type: string
description: Identifier of the user who made last update
readOnly: true
example: test.user
updateDate:
type: integer
description: Timestamp of the latest update
format: int64
readOnly: true
example: 1608114397263
version:
type: integer
description: Version of the object
format: int64
readOnly: true
example: 1
description: >-
Definition of a lookup code along with its hierarchy, localizations,
source mappings and attributes.
Lookup Attribute Value:
required:
- name
- value
type: object
properties:
name:
type: string
description: Name of the attribute.
example: Population
value:
type: string
description: Value of the attribute.
example: '331002651'
description: Definition of a value of the lookup type attribute.
Operation Result:
required:
- uri
type: object
properties:
uri:
type: string
description: Unique ID for an object
example: user_tenant_id/State/Reltio/AR
value:
type: object
error:
$ref: '#/components/schemas/API Error'
warning:
$ref: '#/components/schemas/API Warning'
Lookup Localization:
required:
- languageCode
- value
type: object
properties:
languageCode:
type: string
description: Language code.
example: it-it
value:
type: string
description: Localized value of a lookup code for the specified language code.
example: Stati Uniti d'America
description:
type: string
description: Description of the localization.
example: United States of America in Italian translation.
description: Definition of a localization for a lookup code.
API Exception:
type: object
properties:
innerErrorData:
$ref: '#/components/schemas/API Exception'
exception:
type: string
description: Exception message
readOnly: true
example: |2-
"com.reltio.rdm.utils.RDMUtils.precondition at RDMUtils.java, line 153",
"com.reltio.rdm.model.base.Model.setRdTenantId at Model.java, line 91",...
stack:
type: array
description: Exception stack
readOnly: true
example: >-
com.reltio.rdm.RDMException:Incorrect tenant id provided for value:
user_tenant_id/State/Reltio/AR
items:
type: string
Source Value:
required:
- code
- value
type: object
properties:
code:
type: string
description: Source code which comes from a source system.
example: RLT_US
value:
type: string
description: Source value to represent the source code.
example: United States of America
description:
type: string
description: Description of the source value.
example: USA definition in the Reltio source system.
enabled:
type: boolean
description: >-
Status flag for the source value to enable it to use in transcoding
operations. Default value is true.
example: true
canonicalValue:
type: boolean
description: >-
Flag for the source value to make its value property as a
canonical value for the lookup code.
Only one source value can
be defined as canonical value.
example: false
downStreamDefaultValue:
type: boolean
description: >-
Flag for the source value to make it as default value of LoV
bounded fields. If set to true, the code and value become the
default values for that source. Only one value can be set to true
per source.
This is applicable only for reverse transcoding when
there are several values/codes for the same source. For more
information on reverse transcoding, see Reltio Documentation.
example: false
description: Definition of a value from a source system.
Source Mapping:
required:
- source
type: object
properties:
source:
type: string
description: Source system
example: Reltio
values:
type: array
description: Values which can come from the source system
items:
$ref: '#/components/schemas/Source Value'
description: >-
Definition of a mapping between a source system and values which can
come from this source system.
API Warning:
type: object
properties:
warningMessage:
type: string
description: Warning message
readOnly: true
example: Tenant has already got a mapping for this type, source and value.
description: Contains detailed information about occurred warning
Response for lookup values:
required:
- uri
type: object
properties:
uri:
type: string
description: Unique ID for an object
example: user_tenant_id/State/Reltio/AR
value:
$ref: '#/components/schemas/Lookup Code'
error:
$ref: '#/components/schemas/API Error'
warning:
$ref: '#/components/schemas/API Warning'
Unmapped lookup:
required:
- code
- source
- tenantId
- type
- value
type: object
properties:
tenantId:
type: string
description: >-
ID of the RDM tenant. It has to match the following Regex pattern:
[a-zA-Z_0-9]{2,32}.
example: user_tenant_id
type:
type: string
description: Lookup type that has an unmapped value
example: rdm/lookupTypes/State
source:
type: string
description: A source for unmapped lookup
example: Reltio
code:
type: string
description: Lookup code for an unmapped lookup
example: AR
value:
type: string
description: Lookup value for an unmapped lookup
example: Arkansas
attributes:
type: array
description: Custom attributes for an unmapped lookup
items:
$ref: '#/components/schemas/Lookup Attribute Value'
updatedBy:
type: string
description: Identifier of the user who made last update
readOnly: true
example: test.user
updateDate:
type: integer
description: Timestamp of the latest update
format: int64
readOnly: true
example: 1608114397263
version:
type: integer
description: Version of the object
format: int64
readOnly: true
example: 1
description: Definition of a lookup that is not mapped to a canonical value.
Response for unmapped values:
required:
- uri
type: object
properties:
uri:
type: string
description: Unique ID for an object
example: user_tenant_id/State/Reltio/AR
value:
$ref: '#/components/schemas/Unmapped lookup'
error:
$ref: '#/components/schemas/API Error'
warning:
$ref: '#/components/schemas/API Warning'
EntityTO:
type: object
properties:
crosswalks:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/CrosswalkTO'
createdBy:
type: string
updatedBy:
type: string
createdTime:
type: integer
format: int64
updatedTime:
type: integer
format: int64
activenessStartInternalMap:
type: object
additionalProperties:
type: integer
format: int64
activenessEndInternalMap:
type: object
additionalProperties:
type: integer
format: int64
attributes:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
anyOf:
- $ref: '#/components/schemas/SimpleAttributeValueTO'
- $ref: '#/components/schemas/NestedAttributeValueTO'
- $ref: '#/components/schemas/ReferenceAttributeValueTO'
description: Attributes of entity
nullable: true
readOnly: false
writeOnly: false
extensions: {}
allOf:
- $ref: '#/components/schemas/ObjectTO'
- type: object
properties:
analyticsAttributes:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/AnalyticsAttributeValueTO'
description: >-
Analytics attributes the entity possesses. Analytics attributes
can include simple and nested attributes. Each analytics
attribute has a reference to its configuration type. Analytics
attributes are grouped by attribute configuration.
AnalyticsAttributeValueTO values must of the
SimpleAnalyticsAttributeValueTO, NestedAnalyticsAttributeValueTO
types.
secondaryLabel:
type: string
description: >-
An entity label that is built using the entity type
configuration secondaryLabelPattern and data from an entity.
Since label information is generally used in the results of a
search, more information can be included in the entity label to
give it more unique characteristics when displayed near similar
results.
readOnly: true
example: Washington DC, the USA
label:
type: string
description: >-
An entity label that is built using the entity type
configuration dataLabelPattern and data of an entity.
readOnly: true
example: John Smith
type:
type: string
description: Type of entity
example: configuration/entityTypes/Individual
uri:
type: string
description: Unique identifier of entity
readOnly: true
example: entities/Bco79gB
refUpdatedBy:
type: string
refUpdatedTime:
type: integer
format: int64
refCommitTime:
type: integer
format: int64
roles:
type: array
description: An array of entity roles associated with the entity.
items:
type: string
description: Entity object model
CrosswalkExternalInfo:
type: object
properties:
dtssInfo:
$ref: '#/components/schemas/DTSSInfo'
description: >-
Additional information of crosswalk. This information is filled by
Reltio services like DTSS.
APIException:
type: object
properties:
exception:
type: string
description: Brief information about the exception
readOnly: true
example: >-
com.reltio.metadata.errors.CommonException:Code: OBJECT_NOT_FOUND;
Message parameters: [entities/someId]. Object with
id=entities/someId not found. No object with specified id found at
com.reltio.businesslogic.crud.AbstractCRUDService.getBusinessObjects,
line 633
description: Model representing API exception
ObjectTO:
type: object
properties:
type:
type: string
description: Type of Object
example: configuration/{entityTypes|relationTypes}/Object
crosswalks:
uniqueItems: true
type: array
description: Crosswalks of object
items:
$ref: '#/components/schemas/CrosswalkTO'
createdBy:
type: string
description: >-
Identifier of user created this object. This field is filled in
automatically.
readOnly: true
example: somebody@example.com
updatedBy:
type: string
description: >-
Identifier of user updated this object. This field is filled in
automatically.
readOnly: true
example: somebody@example.com
createdTime:
type: integer
description: >-
Time of creation of this object (Timestamp). This field is filled in
automatically.
format: int64
readOnly: true
example: 1599015741719
updatedTime:
type: integer
description: >-
Time of update of this object (Timestamp). This field is filled in
automatically.
format: int64
readOnly: true
example: 1599015741719
activenessStartInternalMap:
type: object
additionalProperties:
type: integer
format: int64
activenessEndInternalMap:
type: object
additionalProperties:
type: integer
format: int64
attributes:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
anyOf:
- $ref: '#/components/schemas/SimpleAttributeValueTO'
- $ref: '#/components/schemas/NestedAttributeValueTO'
description: Attributes of object
nullable: true
readOnly: false
writeOnly: false
extensions: {}
uri:
type: string
description: Unique identifier of Object
readOnly: true
example: '{entities|relations}/Bco79gB'
description: Base object model of EntityTO, RelationTO
discriminator:
propertyName: type
ObjectEntryEntityTO:
required:
- index
type: object
properties:
index:
type: integer
description: Index of an attribute value in JSON Array from response
format: int32
readOnly: true
errors:
$ref: '#/components/schemas/APIErrorRepresentation'
object:
$ref: '#/components/schemas/EntityTO'
successful:
type: boolean
description: Is this operation successful
readOnly: true
DTSSInfo:
type: object
properties:
tenantId:
type: string
description: Tenant Id of Data Tenant provided by DTSS
example: dfsdfsdf2
operationId:
type: string
description: Operation Id provided by DTSS
example: 123e4567-e89b-12d3-a456-556642440000
matchReasons:
uniqueItems: true
type: array
description: Set of reasons why DTSS has updated this object
items:
type: string
updatedBy:
type: string
description: UpdatedBy provided by DTSS
updatedTime:
type: integer
description: Updated Time provided by DTSS
format: int64
status:
type: string
description: Status provided by DTSS
matchRuleUris:
uniqueItems: true
type: array
description: Match Rules provided by DTSS
items:
type: string
description: Additional information of crosswalk provided by DTSS
CrosswalkTO:
type: object
properties:
type:
type: string
description: Source system type
example: configuration/sources/SDS
value:
type: string
description: ID of a record in a source system
example: '10000007'
sourceTable:
type: string
description: Name of a table for a record in a source system
example: UserDataTable
url:
type: string
description: URL of crosswalk
example: http://example.com
createDate:
type: string
description: Create Date of crosswalk
format: date-time
example:
offset:
totalSeconds: 0
id: Z
rules:
fixedOffset: true
nano: 997000000
year: 2017
monthValue: 10
dayOfMonth: 5
hour: 18
minute: 7
second: 32
month: OCTOBER
dayOfWeek: THURSDAY
dayOfYear: 278
updateDate:
type: string
description: Update Date of crosswalk
format: date-time
example:
offset:
totalSeconds: 0
id: Z
rules:
fixedOffset: true
nano: 997000000
year: 2017
monthValue: 10
dayOfMonth: 5
hour: 18
minute: 7
second: 32
month: OCTOBER
dayOfWeek: THURSDAY
dayOfYear: 278
reltioLoadDate:
type: string
description: Load Date to "Reltio" of crosswalk
format: date-time
readOnly: true
example:
offset:
totalSeconds: 0
id: Z
rules:
fixedOffset: true
nano: 368000000
year: 2018
monthValue: 10
dayOfMonth: 15
hour: 5
minute: 26
second: 13
month: OCTOBER
dayOfWeek: MONDAY
dayOfYear: 288
deleteDate:
type: string
description: Delete Date of crosswalk
example: '2019-10-15T05:26:13.368Z'
crosswalkExternalInfo:
$ref: '#/components/schemas/CrosswalkExternalInfo'
singleAttributeUpdateDates:
type: object
additionalProperties:
type: string
description: >-
This field of crosswalk contains update date for specific
attributes.
readOnly: true
example: >-
{"{entities|relations}/khOIjHK/attributes/FirstName/JLKhIU":"2018-10-14T09:53:38.317Z","{entities|relations}/khOIjHK/attributes/LastName/LKJhLMk":"2018-10-14T09:53:38.317Z"}
attributes:
type: array
description: Set of attributes of this crosswalk
readOnly: true
example: |-
["{entities|relations}/khOIjHK/attributes/FirstName/JLKhIU",
"{entities|relations}/khOIjHK/attributes/LastName/LKJhLMk"]
items:
type: string
dataProvider:
type: boolean
description: >-
This field determines if this crosswalk is data provider. Default is
true
example: true
uri:
type: string
description: Unique URI of Crosswalk
readOnly: true
example: '{entities|relations}/Bco79gB/crosswalks/Q3hbdpb9'
description: Crosswalks of object
AnalyticsAttributeValueTO:
type: object
properties:
type:
type: string
description: Type of attribute
readOnly: true
example: >-
configuration/{entityTypes|relationTypes}/Individual/attributes/FirstName
uri:
type: string
description: URI of Analytics Attribute
description: >-
Base model of SimpleAnalyticsAttributeValueTO,
NestedAnalyticsAttributeValueTO attribute objects.
discriminator:
propertyName: type
ObjectEntryInteractionTO:
required:
- index
type: object
properties:
index:
type: integer
description: Index of an attribute value in JSON Array from response
format: int32
readOnly: true
errors:
$ref: '#/components/schemas/APIErrorRepresentation'
object:
$ref: '#/components/schemas/InteractionTO'
successful:
type: boolean
description: Is this operation successful
readOnly: true
InteractionTO:
type: object
properties:
crosswalks:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/CrosswalkTO'
createdBy:
type: string
updatedBy:
type: string
createdTime:
type: integer
format: int64
updatedTime:
type: integer
format: int64
activenessStartInternalMap:
type: object
additionalProperties:
type: integer
format: int64
activenessEndInternalMap:
type: object
additionalProperties:
type: integer
format: int64
attributes:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
anyOf:
- $ref: '#/components/schemas/SimpleAttributeValueTO'
- $ref: '#/components/schemas/NestedAttributeValueTO'
description: Attributes of interaction
nullable: true
readOnly: false
writeOnly: false
extensions: {}
members:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
anyOf:
- $ref: '#/components/schemas/InteractionMemberNode'
description: Map of interaction members by member type
nullable: true
readOnly: false
writeOnly: false
extensions: {}
timestamp:
description: >-
Timestamp when the interaction
occurred.
Accepts:
- YYYY-MM-dd'T'HH:mm:ss.SSSZ
- MM/dd/YYYY
- MM.dd.YYYY
- MM-dd-YYYY
- YYYY/MM/dd
- YYYY-MM-dd
- YYYY.MM.dd
- YYYYMMdd
- MM/dd/YYYY
HH.mm
- MM.dd.YYYY HH.mm
- MM-dd-YYYY
HH.mm
- YYYY/MM/dd HH:mm:ss
- Unix time in
milliseconds
Returns:
- Unix time in
milliseconds
Note: the Reltio Platform accepts a
value of the integer or string type, but always
returns a value of the integer type (Unix time in
milliseconds)
nullable: true
readOnly: false
writeOnly: false
extensions: {}
oneOf:
- type: integer
format: int64
- type: string
allOf:
- $ref: '#/components/schemas/ObjectTO'
- type: object
properties:
type:
type: string
description: Type of interaction
example: configuration/interactionTypes/Lunch
uri:
type: string
description: Unique identifier of interaction
readOnly: true
example: interactions/Bco79gB
description: Interaction object model
RawInteractionTO:
type: object
properties:
type:
type: string
description: Type of Object
example: configuration/{entityTypes|relationTypes}/Object
crosswalks:
uniqueItems: true
type: array
description: Crosswalks of object
items:
$ref: '#/components/schemas/CrosswalkTO'
uri:
type: string
description: Unique identifier of Interaction
readOnly: true
example: interactions/Bco79gB
ObjectEntryRawInteractionTO:
required:
- index
type: object
properties:
index:
type: integer
description: Index of an attribute value in JSON Array from response
format: int32
readOnly: true
errors:
$ref: '#/components/schemas/APIErrorRepresentation'
object:
$ref: '#/components/schemas/RawInteractionTO'
successful:
type: boolean
description: Is this operation successful
readOnly: true
ObjectEntryRelationTO:
required:
- index
type: object
properties:
index:
type: integer
description: Index of an attribute value in JSON Array from response
format: int32
readOnly: true
errors:
$ref: '#/components/schemas/APIErrorRepresentation'
object:
$ref: '#/components/schemas/RelationTO'
successful:
type: boolean
description: Is this operation successful
readOnly: true
RelationTO:
type: object
properties:
crosswalks:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/CrosswalkTO'
createdBy:
type: string
updatedBy:
type: string
createdTime:
type: integer
format: int64
updatedTime:
type: integer
format: int64
activenessStartInternalMap:
type: object
additionalProperties:
type: integer
format: int64
activenessEndInternalMap:
type: object
additionalProperties:
type: integer
format: int64
startEntityTO:
$ref: '#/components/schemas/EntityTO'
endEntityTO:
$ref: '#/components/schemas/EntityTO'
attributes:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
anyOf:
- $ref: '#/components/schemas/SimpleAttributeValueTO'
- $ref: '#/components/schemas/NestedAttributeValueTO'
description: Attributes of relation
nullable: true
readOnly: false
writeOnly: false
extensions: {}
allOf:
- $ref: '#/components/schemas/ObjectTO'
- type: object
properties:
startRefPinned:
type: boolean
description: >-
A flag indicates whether the reference attribute of the start
entity defined by this relationship is pinned.
example: false
analyticsAttributes:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/AnalyticsAttributeValueTO'
description: >-
Analytics attributes the relation possesses. Analytics
attributes can include simple and nested attributes. Each
analytics attribute has a reference to its configuration type.
Analytics attributes are grouped by attribute configuration.
AnalyticsAttributeValueTO values must of the
SimpleAnalyticsAttributeValueTO, NestedAnalyticsAttributeValueTO
types.
endRefPinned:
type: boolean
description: >-
A flag indicates whether the reference attribute of the end
entity defined by this relationship is pinned.
example: false
endRefIgnored:
type: boolean
description: >-
A flag indicates whether the reference attribute of the end
entity defined by this relationship is ignored.
example: false
type:
type: string
description: Type of relationship
example: configuration/relationTypes/HasAddress
startRefIgnored:
type: boolean
description: >-
A flag indicates whether the reference attribute of the start
entity defined by this relationship is ignored.
example: false
uri:
type: string
description: Unique identifier of relationship
readOnly: true
example: relations/Bco79gB
refUpdatedBy:
type: string
refUpdatedTime:
type: integer
format: int64
refCommitTime:
type: integer
format: int64
startObject:
$ref: '#/components/schemas/EntityTOConnection'
endObject:
$ref: '#/components/schemas/EntityTOConnection'
description: Relationship object model, defines a connection between two entities
EntityTOConnection:
required:
- crosswalks
type: object
properties:
directionalLabel:
type: string
description: >-
A label for the relationship, from the start/end object's
perspective
readOnly: true
label:
type: string
description: >-
An entity label that is built using the entity type configuration
dataLabelPattern and data of an entity.
readOnly: true
objectURI:
type: string
description: Entity URI
readOnly: true
type:
type: string
description: Entity type
readOnly: true
crosswalks:
type: array
description: Entity's crosswalks
items:
$ref: '#/components/schemas/CrosswalkTO'
description: Start/end entity object of a RelationTO
ObjectEntrySegmentTO:
required:
- index
type: object
properties:
index:
type: integer
description: Index of an attribute value in JSON Array from response
format: int32
readOnly: true
errors:
$ref: '#/components/schemas/APIErrorRepresentation'
object:
$ref: '#/components/schemas/SegmentTO'
successful:
type: boolean
description: Is this operation successful
readOnly: true
SegmentTO:
type: object
properties:
id:
type: string
description: Id of Segment
example: kz9xuFJQbQhZax4BSszjqr
parentId:
type: string
description: >-
Parent Id of the Item. Segment can be a child of another Folder.
Folder can be a child of another Folder.
example: kz9xuFJQbQhZax4BSszjqr
itemType:
type: string
description: Item Type
example: segment/folder
enum:
- SEGMENT
- FOLDER
status:
type: string
description: Status of Segment
example: submitted/in_progress/live/disabled
enum:
- SUBMITTED
- IN_PROGRESS
- LIVE
- DISABLED
label:
type: string
description: Segment Label
example: High Net Worth Group
owner:
type: string
description: Segment Owner
example: User
sharing:
type: string
description: Segment Sharing Type
example: private/public
enum:
- PRIVATE
- PUBLIC
rule:
type: string
description: Segment Rule
example: count(gt(interactions.attributes.itemPrice, 100)
lastEvaluationDate:
type: string
description: Last Evaluation Date
format: date-time
example:
offset:
totalSeconds: -18000
id: '-05:00'
rules:
fixedOffset: true
nano: 0
year: 2000
monthValue: 10
dayOfMonth: 31
hour: 1
minute: 30
second: 0
month: OCTOBER
dayOfWeek: TUESDAY
dayOfYear: 305
type:
type: string
description: Segment Type
example: realtime/batch
enum:
- REALTIME
- BATCH
schedule:
type: string
description: Segment schedule in iCal RRULE format
example: |-
{
"startTime": "2000-10-31T01:30:00.000-05:00",
"repeat":"RRULE:FREQ=HOURLY;INTERVAL=12"
}
description:
type: string
description: Segment description
example: Customers who has an annual income above $5M
favorite:
type: boolean
description: Segment is marked as favorite. Default is false
example: true
integrationIDs:
type: array
description: Segment integration IDs
example: '[''salesforce'', ''customDst'']'
items:
type: string
segmentSize:
type: integer
description: Number of entities in the segment
format: int64
readOnly: true
example: 8
path:
type: string
description: >-
Array of paths with folder id and label of the segment/folder in the
folder hierarchy
readOnly: true
example: >-
[{"id":"id1","label":"New Product
Launch"},{"id":"id2","label":"Promotional Offers"}]
items:
$ref: '#/components/schemas/Path'
incremental:
type: boolean
SimpleAttributeValueTO:
required:
- value
type: object
allOf:
- $ref: '#/components/schemas/AttributeValueTO'
- required:
- value
type: object
properties:
type:
type: string
description: Type of attribute
readOnly: true
example: >-
configuration/{entityTypes,relationTypes}/Individual/attributes/FirstName
uri:
type: string
description: URI of Attribute
readOnly: true
example: '{entities,relations}/liugfgU/attributes/FirstName/NiyjVY90'
value:
type: string
description: Value of attribute
example: Ilya
description: Simple Attribute Object
NestedAttributeValueTO:
type: object
properties:
value:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
anyOf:
- $ref: '#/components/schemas/SimpleAttributeValueTO'
- $ref: '#/components/schemas/NestedAttributeValueTO'
description: Attributes of Nested Attribute
nullable: true
readOnly: false
writeOnly: false
extensions: {}
allOf:
- $ref: '#/components/schemas/AttributeValueTO'
- type: object
properties:
type:
type: string
description: Type of attribute
readOnly: true
example: configuration/{entityTypes|relationTypes}/Party/attributes/Phone
uri:
type: string
description: URI of Attribute
readOnly: true
example: '{entities|relations}/liugfgU/attributes/Phone/NiyjVY90'
description: >-
Nested Attribute is a object which can contain another
interconnected attributes. NestedAttributeValueTO can contain
NestedAttributeValueTO and SimpleAttributeValueTO.
InteractionMemberNode:
type: object
properties:
type:
type: string
uri:
type: string
members:
type: array
items:
$ref: '#/components/schemas/InteractionObjectTO'
Path:
type: object
properties:
id:
type: string
label:
type: string
ReferenceAttributeValueTO:
type: object
properties:
value:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
anyOf:
- $ref: '#/components/schemas/SimpleAttributeValueTO'
- $ref: '#/components/schemas/NestedAttributeValueTO'
description: Attributes of Reference Attribute
nullable: true
readOnly: false
writeOnly: false
extensions: {}
allOf:
- $ref: '#/components/schemas/AttributeValueTO'
- type: object
properties:
startObjectCrosswalks:
type: array
description: start objects crosswalks of reference attribute
items:
$ref: '#/components/schemas/StartObjectCrosswalk'
refEntity:
$ref: '#/components/schemas/RefEntityObject'
type:
type: string
description: Type of attribute
readOnly: true
example: >-
configuration/{entityTypes|relationTypes}/Party/attributes/Address
refRelation:
$ref: '#/components/schemas/RefRelationObject'
uri:
type: string
description: URI of Attribute
readOnly: true
example: '{entities|relations}/liugfgU/attributes/Address/NiyjVY90'
description: >-
This object is combination of attributes of EntityTO and RelationTO.
ReferenceAttributeValueTO can contain SimpleAttributeValueTO,
NestedAttributeValueTO.
AttributeValueTO:
type: object
properties:
type:
type: string
description: Type of attribute
readOnly: true
example: >-
configuration/{entityTypes|relationTypes}/Individual/attributes/FirstName
ov:
type: boolean
description: Is value OV?
example: false
value:
type: string
description: Attribute value
example: HCP AddressLine1 01
uri:
type: string
description: URI of Attribute
readOnly: true
example: '{entities|relations}/liugfgU/attributes/FirstName/NiyjVY90'
description: >-
Super model for NestedAttributeValueTO, ReferenceAttributeValueTO,
SimpleAttributeValueTO for Attribute item
StartObjectCrosswalk:
type: object
properties:
type:
type: string
description: Type of crosswalk
example: configuration/sources/OOSource
value:
type: string
description: Value of crosswalk
example: ABSourceValue
RefEntityObject:
type: object
properties:
objectURI:
type: string
description: Ref Entity Uri
example: entities/uI8GeUq
type:
type: string
description: Ref Entity Type
example: configuration/entityTypes/Location
crosswalks:
type: array
description: Ref Entity Crosswalks
items:
$ref: '#/components/schemas/CrosswalkTO'
RefRelationObject:
type: object
properties:
startRefPinned:
type: boolean
description: Ref Relation Uri is start Pinned?
example: false
endRefPinned:
type: boolean
description: Ref Relation Uri is end Pinned?
example: false
objectURI:
type: string
description: Ref Relation Uri
example: relations/6lJRhZb
endRefIgnored:
type: boolean
description: Ref Relation is end Ignored?
example: false
type:
type: string
description: Ref Relation Type
example: configuration/relationTypes/HasAddress
startRefIgnored:
type: boolean
description: Ref Relation Uri is start Ignored?
example: false
crosswalks:
type: array
description: Ref Relation Crosswalks
items:
$ref: '#/components/schemas/CrosswalkTO'
InteractionObjectTO:
type: object
properties:
resolvedEntityURI:
type: string
description: >-
URI of the resolved entity type or role that can be a member of the
type
example: configuration/entityTypes/Bco79gB
initialEntityURI:
type: string
description: >-
URI of an initial entity type or role that can be a member of the
type
example: configuration/entityTypes/Bco79gB
entityType:
type: string
description: Type of member entity
readOnly: true
example: configuration/entityTypes/Individual
label:
type: string
description: >-
An entity label that is built using the entity type configuration
dataLabelPattern and data of an member entity.
readOnly: true
example: John Smith
description: Interaction Member Object
extensions:
x-original-swagger-version: '2.0'