openapi: 3.0.1 info: title: Configure description: Define metadata configuration of your tenants from a collection of APIs. contact: name: Reltio url: http://www.reltio.com email: support@reltio.com version: '2020.2' extensions: {} servers: - url: / security: [] tags: '0': name: Data Model '1': name: Metadata Security paths: /services/api/{tenantId}/dataValidationFunctions: get: tags: - Data Validation Function summary: Retrieves the Data Validation Functions configured for the tenant description: This API retrieves the Functions configured for a tenant operationId: getTenantValidationFunctions parameters: - name: env in: header description: Environment name like r360,test etc. required: true schema: type: string - name: tenantId in: path description: The ID of the tenant required: true schema: type: string responses: '200': description: Tenant functions content: application/json: schema: $ref: '#/components/schemas/TenantFunctions' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: unauthorized error_description: Full authentication is required to access this resource '403': description: >- The operation is forbidden for the current user, please check your privileges content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: access_denied error_description: Access is denied '404': description: Functions are not configured for the tenant content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: severity: Error errorMessage: Validation Functions are not configured for the given tenant. errorCode: 901 errorDetailMessage: 'No Validation Functions defined for tenant: devTenantId.' innerErrorData: exception: >- com.reltio.services.data.validation.common.exception.DataValidationServiceException:Validation Functions are not configured for the given tenant. stack: - >- com.reltio.services.data.validation.service.FunctionManagementService.getTenantFunctions at FunctionManagementService.java, line 67 extensions: x-module: data-validation-function x-controllerName: >- com.reltio.services.data.validation.controller.FunctionManagementController x-path: >- /private/swagger.htm?module=Configuration#/Data%20Validation%20Function/getTenantValidationFunctions /services/api/{tenantId}/dataValidationFunctions/{functionURI}: get: tags: - Data Validation Function summary: Retrieves the Data Validation Function details description: Retrieves the Function for a particular function URI in the tenant. operationId: getValidationFunctionbyUri parameters: - name: tenantId in: path description: The ID of the tenant required: true schema: type: string - name: functionURI in: path description: The uri of the function to be retrieved required: true schema: type: string example: 39a5c79f-4831-4db9-977a-48086ac20eb3 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ValidationFunctionResponse' example: uri: 800ee05e-93b9-4c41-ac57-faced7b3e457 name: Contact.FirstName label: Contact.FirstName description: Contact.FirstName expression: missing(attributes.FirstName) action: WARNING validationEvent: CREATE message: FirstName attributes required one createdBy: user1@reltio.com createdTime: '1614226939275' updatedBy: user2@reltio.com updatedTime: '1614260811984' status: ACTIVE attribute: configuration/entityTypes/Contact/attributes/FirstName applyOn: BOTH sourceTypes: - Twitter - DnB '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: unauthorized error_description: Full authentication is required to access this resource '403': description: >- The operation is forbidden for the current user, please check your privileges content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: access_denied error_description: Access is denied '404': description: Function does not exist content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: severity: Error errorMessage: >- Given validation function with uri: 800ee05e-93b9-4c41-ac57-faced7b3e4571 does not exist errorCode: 903 errorDetailMessage: >- Validation Function is not configured for the function URI. Provide valid uri to process the requested operation. innerErrorData: exception: >- com.reltio.services.data.validation.common.exception.DataValidationServiceException:Given validation function with uri: 800ee05e-93b9-4c41-ac57-faced7b3e4571 does not exist stack: - >- com.reltio.services.data.validation.service.FunctionManagementService.checkAndGetFunction at FunctionManagementService.java, line 193 extensions: x-module: data-validation-function x-controllerName: >- com.reltio.services.data.validation.controller.FunctionManagementController x-path: >- /private/swagger.htm?module=Configuration#/Data%20Validation%20Function/getValidationFunctionbyUri put: tags: - Data Validation Function summary: Updates the Data Validation Function description: This API updates the function for a particular function URI operationId: updateValidationFunction parameters: - name: env in: header description: Environment name like r360,test etc. required: true schema: type: string - name: tenantId in: path description: The ID of the tenant required: true schema: type: string - name: functionURI in: path description: The uri of the function to be updated required: true schema: type: string example: 39a5c79f-4831-4db9-977a-48086ac20eb3 requestBody: description: >- Indicates the set of body attributes such as name, expression, action, validationEvent, uri, label, description, attribute, status content: application/json: schema: $ref: '#/components/schemas/Function' examples: sample: description: Sample request for API value: uri: 800ee05e-93b9-4c41-ac57-faced7b3e457 name: Contact.FirstName label: Contact.FirstName description: Contact.FirstName expression: missing(attributes.FirstName) action: WARNING validationEvent: CREATE applyOn: BOTH sourceTypes: - Twitter - DnB message: FirstName attributes required one status: ACTIVE attribute: configuration/entityTypes/Contact/attributes/FirstName required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ValidationFunctionResponse' example: uri: 800ee05e-93b9-4c41-ac57-faced7b3e457 name: Contact.FirstName label: Contact.FirstName description: Contact.FirstName expression: missing(attributes.FirstName) action: WARNING validationEvent: CREATE message: FirstName attributes required one createdBy: user1@reltio.com createdTime: '1614226939275' updatedBy: user1@reltio.com updatedTime: '1614260735599' status: ACTIVE attribute: configuration/entityTypes/Contact/attributes/FirstName applyOn: BOTH sourceTypes: - Twitter - DnB '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: 900 message: Invalid function. details: Refer internal errors for more details. internalErrors: - code: 955 message: Mandatory properties missing details: 'Mandatory properties missing : [name]' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: unauthorized error_description: Full authentication is required to access this resource '403': description: >- The operation is forbidden for the current user, please check your privileges content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: access_denied error_description: Access is denied '404': description: Function does not exist to update content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: 903 message: >- Given validation function with uri: 5c7a1353-5d1e-4e44-8da0-c2cedab62d5b does not exist details: >- Validation Function is not configured for the function URI. Provide valid uri to process the requested operation. extensions: x-module: data-validation-function x-controllerName: >- com.reltio.services.data.validation.controller.FunctionManagementController x-codegen-request-body-name: Request Body x-path: >- /private/swagger.htm?module=Configuration#/Data%20Validation%20Function/updateValidationFunction delete: tags: - Data Validation Function summary: Deletes the Data Validation Function description: This API deletes the Function in the tenant. operationId: deleteValidationFunctionbyUri parameters: - name: tenantId in: path description: The ID of the tenant required: true schema: type: string - name: functionURI in: path description: The uri of the function to be deleted required: true schema: type: string example: 39a5c79f-4831-4db9-977a-48086ac20eb3 responses: '200': description: Successful operation content: application/json: schema: type: object additionalProperties: type: object example: status: success '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: unauthorized error_description: Full authentication is required to access this resource '403': description: >- The operation is forbidden for the current user, please check your privileges content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: access_denied error_description: Access is denied '404': description: Function does not exist content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: severity: Error errorMessage: >- Given validation function with uri: 39a5c79f-4831-4db9-977a-48086ac20eb3 does not exist errorCode: 903 errorDetailMessage: >- Validation Function is not configured for the function URI. Provide valid uri to process the requested operation. innerErrorData: exception: >- com.reltio.services.data.validation.common.exception.DataValidationServiceException:Given validation function with uri: 39a5c79f-4831-4db9-977a-48086ac20eb3 does not exist stack: - >- com.reltio.services.data.validation.service.FunctionManagementService.checkAndGetFunction at FunctionManagementService.java, line 193 extensions: x-module: data-validation-function x-controllerName: >- com.reltio.services.data.validation.controller.FunctionManagementController x-path: >- /private/swagger.htm?module=Configuration#/Data%20Validation%20Function/deleteValidationFunctionbyUri /services/api/{tenantId}/dataValidationFunctions/{objectType}/{object}: get: tags: - Data Validation Function summary: Retrieves the Data Validation Functions for an entity/relation type description: Retrieves Functions for an entity/relation type operationId: getValidationFunctionforObjectType parameters: - name: env in: header description: Environment name like r360,test etc. required: true schema: type: string - name: tenantId in: path description: The ID of the tenant required: true schema: type: string - name: object in: path required: true schema: type: string - name: objectType in: path description: Entity/Relation Type for which Functions need to be retrieved required: true schema: type: string enum: - entityTypes - relationTypes example: entityTypes responses: '200': description: Entity functions content: application/json: schema: $ref: '#/components/schemas/ObjectFunctions' '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/ErrorResponse' '404': description: Functions are not configured for the Entity/Relation Type content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' extensions: x-module: data-validation-function x-controllerName: >- com.reltio.services.data.validation.controller.FunctionManagementController x-path: >- /private/swagger.htm?module=Configuration#/Data%20Validation%20Function/getValidationFunctionforObjectType post: tags: - Data Validation Function summary: Creates the Data Validation Functions description: This API saves the Functions for an entity/relation type in the tenant. operationId: createValidationFunctionsForObjectType parameters: - name: env in: header description: Environment name like r360,test etc. required: true schema: type: string - name: tenantId in: path description: The ID of the tenant required: true schema: type: string - name: object in: path required: true schema: type: string - name: objectType in: path description: Entity/Relation Type for which functions need to be created required: true schema: type: string enum: - entityTypes - relationTypes example: entityTypes requestBody: description: >- Indicates the set of body parameters such as name, expression, action, label, description, attribute, status content: application/json: schema: type: array items: $ref: '#/components/schemas/Function' required: true responses: '201': description: Functions created successfully content: application/json: schema: type: array items: $ref: '#/components/schemas/Function' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '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/ErrorResponse' extensions: x-module: data-validation-function x-controllerName: >- com.reltio.services.data.validation.controller.FunctionManagementController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Data%20Validation%20Function/createValidationFunctionsForObjectType delete: tags: - Data Validation Function summary: Deletes the Data Validation Functions for an entity type description: This API deletes all the Functions for the entity type in the tenant. operationId: deleteValidationFunctionsEntityType parameters: - name: env in: header description: Environment name like r360,test etc. required: true schema: type: string - name: tenantId in: path description: The ID of the tenant required: true schema: type: string - name: objectType in: path description: >- The entity type for which the Validation Functions are to be deleted. required: true schema: type: string - name: object in: path required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: object additionalProperties: type: object '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/ErrorResponse' '404': description: >- Functions are not configured for the entity/relation type in the tenant. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' extensions: x-module: data-validation-function x-controllerName: >- com.reltio.services.data.validation.controller.FunctionManagementController x-path: >- /private/swagger.htm?module=Configuration#/Data%20Validation%20Function/deleteValidationFunctionsEntityType /services/api/{tenantId}/actions: get: tags: - Life Cycle Actions summary: Retrieves the list of Life Cycle Actions (LCAs) description: >- This API retrieves a list of registered LCAs for a specific tenant. The response lists an array of objects representing all registered actions (LCAs) for the tenant. operationId: getTenantLCAObjects parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string responses: '200': description: List of life cycle action objects content: application/json: schema: type: array items: $ref: '#/components/schemas/ActionTO' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '404': description: The resource you were trying to reach is not found content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '500': description: Internal server error, see details in the returned error message content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '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/LCARestErrorRepresentation' extensions: x-module: lca x-controllerName: com.reltio.microservices.lcaservice.controller.ActionsController x-path: >- /private/swagger.htm?module=Configuration#/Life%20Cycle%20Actions/getTenantLCAObjects post: tags: - Life Cycle Actions summary: Registers Life Cycle Actions (LCAs) description: >- This API registers LCAs for a specific tenant. The response lists an array of objects representing the registered actions for the specific tenant. Registration requires the JAR file to be placed in the S3 storage and the S3 path should be passed as an input to the API.
Note: The jar file(s) needs to be placed into S3 bucket even for GCP tenants. Google Cloud Storage (GCS) is not yet supported. operationId: registerLifeCycleAction parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string requestBody: description: List of life cycle action objects to be registered content: application/json: schema: type: array items: $ref: '#/components/schemas/ActionTO' required: false responses: '200': description: List of life cycle action objects created/updated content: application/json: schema: type: array items: $ref: '#/components/schemas/ActionTO' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '404': description: The resource you were trying to reach is not found content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '500': description: Internal server error, see details in the returned error message content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '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/LCARestErrorRepresentation' extensions: x-module: lca x-controllerName: com.reltio.microservices.lcaservice.controller.ActionsController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Life%20Cycle%20Actions/registerLifeCycleAction /services/api/{tenantId}/actions/{name}: get: tags: - Life Cycle Actions summary: Gets details for the named Life Cycle Action (LCA) object description: This API returns details about a named LCA. operationId: getLifeCycleActionByName parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string - name: name in: path description: Name of the LCA to be retrieved required: true schema: type: string responses: '200': description: Life Cycle Action object content: application/json: schema: $ref: '#/components/schemas/ActionTO' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '404': description: The resource you were trying to reach is not found content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '500': description: Internal server error, see details in the returned error message content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '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/LCARestErrorRepresentation' extensions: x-module: lca x-controllerName: com.reltio.microservices.lcaservice.controller.ActionsController x-path: >- /private/swagger.htm?module=Configuration#/Life%20Cycle%20Actions/getLifeCycleActionByName delete: tags: - Life Cycle Actions summary: Deregister Life Cycle Action description: This API deletes the specified Life Cycle Action operationId: deleteLCAFromCollectionByTenant parameters: - name: tenantId in: path required: true schema: type: string - name: name in: path required: true schema: pattern: .+ type: string responses: '200': description: Life Cycle Action deleted successfully content: application/json: schema: type: string enum: - SUCCESS - ERROR example: status: success '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' example: severity: Error errorMessage: Access is denied errorCode: -1 innerErrorData: exception: Access Denied Exception:Access is denied stack: - >- org.springframework.security.access.vote.AffirmativeBased.decide at AffirmativeBased.java, line 84 '404': description: Life Cycle Action does not exist to delete content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' example: severity: Error errorMessage: Invalid action errorDetailMessage: >- No active Life Cycle Action handler with name sample for tenant devtenant found errorCode: 4 innerErrorData: exception: LCA Service Exception:Invalid action stack: - >- com.reltio.microservices.lcaservice.service.services.ActionsService.getAction at ActionsService.java, line 177 extensions: x-module: lca x-controllerName: com.reltio.microservices.lcaservice.controller.ActionsController x-path: >- /private/swagger.htm?module=Configuration#/Life%20Cycle%20Actions/deleteLCAFromCollectionByTenant /services/api/{tenantId}/actions/{name}/{hookName}: post: tags: - Life Cycle Actions summary: Executes a specified Life Cycle Action (LCA) for an object description: >- This API executes a specified LCA on an object. The response object represents the output data after applying the LCA at the specified hook. operationId: executeLCAForAnObject parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string - name: name in: path description: Name of the specific LCA to be invoked required: true schema: type: string example: EntityScoreCalculator - name: hookName in: path description: Name of the Hook required: true schema: type: string enum: - beforeSave - afterSave - beforeUpdate - afterUpdateBeforeCleanse - beforeOverride - afterOverrideBeforeCleanse - beforeDelete - afterDelete - rawDataBeforeCleanse - rawDataAfterCleanse - beforeMerge - afterMerge - beforeUnmerge - afterUnmerge - potentialMatchesFound - potentialMatchesRemoved - beforeNotAMatchSet - afterNotAMatchSet - beforeNotAMatchReset - afterNotAMatchReset - beforeMarkAsMatch - afterMarkAsMatch - beforeUnmarkAsMatch - afterUnmarkAsMatch - beforeReferenceAttributeAdded - afterReferenceAttributeAdded - beforeReferenceAttributeChanged - afterReferenceAttributeChanged - beforeReferenceAttributeRemoved - afterReferenceAttributeRemoved - afterDCRSave - validate example: beforeSave requestBody: description: LifeCycle execution data object content: application/json: schema: $ref: '#/components/schemas/LifeCycleDataExecReq' examples: sample: description: Sample request for API value: environment: https://test.reltio.com/reltio tenant: reltiotenant token: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx 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: {} label: William Harley application/x-jackson-smile: schema: $ref: '#/components/schemas/LifeCycleDataExecReq' required: false responses: '200': description: Result of the hook execution content: application/json: schema: $ref: '#/components/schemas/LifeCycleDataResponse' example: successful: true environment: https://test.reltio.com/reltio tenant: reltiotenant 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 Score: - type: configuration/entityTypes/Individual/attributes/Score ov: true value: '40' uri: entities/1jc0x5UK/attributes/Score/3Z3Tq5DCA 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 - entities/1jc0x5UK/attributes/Score/3Z3Tq5DCA singleAttributeUpdateDates: {} label: William Harley application/x-jackson-smile: schema: $ref: '#/components/schemas/LifeCycleDataResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' application/x-jackson-smile: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' application/x-jackson-smile: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' application/x-jackson-smile: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '404': description: The resource you were trying to reach is not found content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' application/x-jackson-smile: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '500': description: Internal server error, see details in the returned error message content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' application/x-jackson-smile: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '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/LCARestErrorRepresentation' application/x-jackson-smile: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' extensions: x-module: lca x-controllerName: >- com.reltio.microservices.lcaservice.controller.ActionsExecuteController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Life%20Cycle%20Actions/executeLCAForAnObject /services/api/{tenantId}/execute/{hook}: post: tags: - Life Cycle Actions summary: Executes Life Cycle Actions (LCAs) for list of objects description: >- This API executes a list of LCAs at the specified hook for the given list of objects. The response represents the list of output data after applying the LCAs at the specified hook for each object. operationId: executeLCAForBatchOfObjects parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string - name: hook in: path description: Name of the Hook required: true schema: type: string enum: - beforeSave - afterSave - beforeUpdate - afterUpdateBeforeCleanse - beforeOverride - afterOverrideBeforeCleanse - beforeDelete - afterDelete - rawDataBeforeCleanse - rawDataAfterCleanse - beforeMerge - afterMerge - beforeUnmerge - afterUnmerge - potentialMatchesFound - potentialMatchesRemoved - beforeNotAMatchSet - afterNotAMatchSet - beforeNotAMatchReset - afterNotAMatchReset - beforeMarkAsMatch - afterMarkAsMatch - beforeUnmarkAsMatch - afterUnmarkAsMatch - beforeReferenceAttributeAdded - afterReferenceAttributeAdded - beforeReferenceAttributeChanged - afterReferenceAttributeChanged - beforeReferenceAttributeRemoved - afterReferenceAttributeRemoved - afterDCRSave - validate example: beforeSave requestBody: description: LifeCycle batch execution data object content: application/json: schema: $ref: '#/components/schemas/LifeCycleDataBatchExec' examples: sample: description: Sample request for API value: environment: https://test.reltio.com/reltio tenant: reltiotenant token: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx hookName: beforeSave requests: - actions: - EntityScoreCalculator data: 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: {} label: William Harley extra: actionType: CREATE application/x-jackson-smile: schema: $ref: '#/components/schemas/LifeCycleDataBatchExec' required: false responses: '200': description: Result of the hook execution content: application/json: schema: type: array items: $ref: '#/components/schemas/LifeCycleDataResponse' example: - successful: true environment: https://test.reltio.com/reltio tenant: reltiotenant 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 Score: - type: >- configuration/entityTypes/Individual/attributes/Score ov: true value: '40' uri: entities/1jc0x5UK/attributes/Score/3Z3Tq5DCA 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 - entities/1jc0x5UK/attributes/Score/3Z3Tq5DCA singleAttributeUpdateDates: {} label: William Harley application/x-jackson-smile: schema: type: array items: $ref: '#/components/schemas/LifeCycleDataResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' application/x-jackson-smile: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' application/x-jackson-smile: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' application/x-jackson-smile: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '404': description: The resource you were trying to reach is not found content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' application/x-jackson-smile: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '500': description: Internal server error, see details in the returned error message content: application/json: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' application/x-jackson-smile: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' '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/LCARestErrorRepresentation' application/x-jackson-smile: schema: $ref: '#/components/schemas/LCARestErrorRepresentation' extensions: x-module: lca x-controllerName: >- com.reltio.microservices.lcaservice.controller.ActionsExecuteController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Life%20Cycle%20Actions/executeLCAForBatchOfObjects /services/api/v1.0/{tenantId}/config: get: tags: - Match IQ summary: Get the Match IQ configuration for the tenant description: >- Get the Match IQ configuration for the tenant. Will return default configuration if no specific configuration found operationId: getMatchIQConfig parameters: - name: tenantId in: path required: true schema: {} - name: sync in: query description: If set to true, will sync the latest configuration from MDM schema: default: 'false' enum: - 'true' - 'false' responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Match IQ Configuration' '400': description: Bad request '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 '404': description: The requested resource not found '429': description: Too many requests, please try later '500': description: Internal server error, see details in the returned error message '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. '507': description: The request consumes more resources than it is allowed extensions: x-module: match-iq x-controllerName: >- com.reltio.services.ml.match.flow.controller.MLMatchConfigurationController x-path: /private/swagger.htm?module=Configuration#/Match%20IQ/getMatchIQConfig put: tags: - Match IQ summary: Update Match IQ configuration for the tenant description: >- Allows to over ride default Match IQ configuration and add specific configuration for the tenant operationId: updateMatchIQConfig parameters: - name: tenantId in: path required: true schema: {} requestBody: description: Configuration specific to the tenant content: application/json: schema: $ref: '#/components/schemas/Match IQ Configuration' examples: sample: description: Sample request for API value: modelsLimit: 10 attributesLimit: 10 enabled: true tenantId: B76gpysdudmNP featureToggles: createNewModel: true publishModel: true trainModel: true shareModel: true autoMerge: true defaultSamplingConfig: samplingMode: FULL minFraction: 0.01 minEntities: 1000000 required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Match IQ Configuration' '400': description: Bad request '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 '404': description: The requested resource not found '429': description: Too many requests, please try later '500': description: Internal server error, see details in the returned error message '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. '507': description: The request consumes more resources than it is allowed extensions: x-module: match-iq x-controllerName: >- com.reltio.services.ml.match.flow.controller.MLMatchConfigurationController x-codegen-request-body-name: request x-path: >- /private/swagger.htm?module=Configuration#/Match%20IQ/updateMatchIQConfig delete: tags: - Match IQ summary: Delete the Match IQ configuration for the tenant description: >- Delete the specific Match IQ configuration for the tenant. Will revert to default configuration operationId: deleteMatchIQConfig parameters: - name: tenantId in: path required: true schema: {} responses: '200': description: Match IQ configuration deleted content: application/json: schema: type: object additionalProperties: type: string '400': description: Bad request '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 '404': description: The requested resource not found '429': description: Too many requests, please try later '500': description: Internal server error, see details in the returned error message '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. '507': description: The request consumes more resources than it is allowed extensions: x-module: match-iq x-controllerName: >- com.reltio.services.ml.match.flow.controller.MLMatchConfigurationController x-path: >- /private/swagger.htm?module=Configuration#/Match%20IQ/deleteMatchIQConfig /services/api/v1.0/{tenantId}/config/_noInheritance: get: tags: - Match IQ summary: Get the updated Match IQ configuration for the tenant description: >- Get the specific Match IQ configuration for the tenant.
Will not return default configuration if no specific configuration found operationId: getUpdatedMatchIQConfig parameters: - name: tenantId in: path required: true schema: {} responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Match IQ Configuration' '400': description: Bad request '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 '404': description: Default configuration doesn't find for the tenant '429': description: Too many requests, please try later '500': description: Internal server error, see details in the returned error message '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. '507': description: The request consumes more resources than it is allowed extensions: x-module: match-iq x-controllerName: >- com.reltio.services.ml.match.flow.controller.MLMatchConfigurationController x-path: >- /private/swagger.htm?module=Configuration#/Match%20IQ/getUpdatedMatchIQConfig /services/oauth/customers/{customerId}: get: tags: - Customer Management summary: Retrieves the customer details description: >- The user must be a customer administrator (must have the 'ROLE_CUSTOMER_ADMIN' role) to use this API. The retrieved customer details include the external provider configuration, if available. operationId: getCustomerById parameters: - name: customerId in: path required: true schema: pattern: .+ type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/Customer' example: id: BestCustomer tenants: - devTenantId - testTenantId - prodtenantId externalProviderConfig: - providerId: devTenant_provide vendor: okta oidc loginEndpoint: https://dev.okta.com/oauth2/default/v1/authorize tokenEndpoint: https://dev.okta.com/oauth2/default/v1/token userInfoEndpoint: https://dev.okta.com/oauth2/default/v1/userinfo callbackEndpoint: https://auth.reltio.com/oauth/callback clientId: '*********' clientSecret: '********' scope: openid profile email userIdMapping: email userEmailMapping: email defaultNewUserRoleList: - ROLE_API - ROLE_USER tenants: - devTenantId jwt: true jwtSignatureConfig: algorithm: RSA256 issuer: https://dev.okta.com/oauth2/default jwksURL: https://dev.okta.com/oauth2/default/v1/keys rolePerTenantSsoEnabled: false sendClientCredentialsInBody: true description: description of the customer passwordPolicy: inactivePeriodInDays: 1 numberOfFailedLoginAttempts: 2 userSessionTimeoutSeconds: 300 caseSensitiveLoginEnabled: true applicationClients: - test-export-client customerSpecificRoles: - ROLE_DATALOADER_TST_CUSTOM - ROLE_ADMIN_READONLY_DUPL - ROLE_P_FULLACCESS_DEV '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Customer with id:'BestCustomer' doesn't exist extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.CustomersController x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/getCustomerById put: tags: - Customer Management summary: Updates the Customer details description: >- The user must be a customer administrator (must have the 'ROLE_CUSTOMER_ADMIN' role) to use this API. operationId: updateCustomer parameters: - name: customerId in: path required: true schema: pattern: .+ type: string requestBody: description: The request body must be a customer object content: application/json: schema: $ref: '#/components/schemas/Customer' examples: sample: description: Sample request for API value: id: BestCustomer tenants: - devTenantId - testTenantId - prodtenantId externalProviderConfig: - providerId: devTenant_provide vendor: okta oidc loginEndpoint: https://dev.okta.com/oauth2/default/v1/authorize tokenEndpoint: https://dev.okta.com/oauth2/default/v1/token userInfoEndpoint: https://dev.okta.com/oauth2/default/v1/userinfo callbackEndpoint: https://auth.reltio.com/oauth/callback clientId: '*********' clientSecret: '********' scope: openid profile email userIdMapping: email userEmailMapping: email defaultNewUserRoleList: - ROLE_API - ROLE_USER tenants: - devTenantId jwt: true jwtSignatureConfig: algorithm: RSA256 issuer: https://dev.okta.com/oauth2/default jwksURL: https://dev.okta.com/oauth2/default/v1/keys rolePerTenantSsoEnabled: false sendClientCredentialsInBody: true description: description of the customer passwordPolicy: passwordRules: - type: .HistoryPRule lastPasswordVerifyCount: 2 - type: .LengthPRule min: 4 max: 10 - type: .CharacterCharacteristicsPRule ruleList: - type: .UppercaseCharacterPRule numCharacters: 2 numberOfCharacteristics: 1 - type: .UsernamePRule matchBackwards: false ignoreCase: true expirePeriodInDays: 2 inactivePeriodInDays: 1 numberOfFailedLoginAttempts: 2 userSessionTimeoutSeconds: 300 caseSensitiveLoginEnabled: true applicationClients: - test-export-client customerSpecificRoles: - ROLE_DATALOADER_TST_CUSTOM - ROLE_ADMIN_READONLY_DUPL - ROLE_P_FULLACCESS_DEV required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/Customer' example: id: BestCustomer tenants: - devTenantId - testTenantId - prodtenantId externalProviderConfig: - providerId: devTenant_provide vendor: okta oidc loginEndpoint: https://dev.okta.com/oauth2/default/v1/authorize tokenEndpoint: https://dev.okta.com/oauth2/default/v1/token userInfoEndpoint: https://dev.okta.com/oauth2/default/v1/userinfo callbackEndpoint: https://auth.reltio.com/oauth/callback clientId: '*********' clientSecret: '********' scope: openid profile email userIdMapping: email userEmailMapping: email defaultNewUserRoleList: - ROLE_API - ROLE_USER tenants: - devTenantId jwt: true jwtSignatureConfig: algorithm: RSA256 issuer: https://dev.okta.com/oauth2/default jwksURL: https://dev.okta.com/oauth2/default/v1/keys rolePerTenantSsoEnabled: false sendClientCredentialsInBody: true description: description of the customer passwordPolicy: inactivePeriodInDays: 1 numberOfFailedLoginAttempts: 2 userSessionTimeoutSeconds: 300 caseSensitiveLoginEnabled: true applicationClients: - test-export-client customerSpecificRoles: - ROLE_DATALOADER_TST_CUSTOM - ROLE_ADMIN_READONLY_DUPL - ROLE_P_FULLACCESS_DEV '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Customer with id:'BestCustomer' doesn't exist extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.CustomersController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/updateCustomer /services/oauth/customers/{customerId}/clients: get: tags: - Client Management summary: >- This API request displays a list of details of application clients that are associated with a specific customer description: >- The list of client details such as their id, roles, authentication methods is displayed. operationId: getCustomerClients parameters: - name: transform in: query schema: type: boolean default: true - name: customerId in: path description: ' ID of the customer for which you want to find its associated clients with details.' required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientDetailsWrapper' example: - clientId: clientId1 authorizedGrantTypes: - client_credentials redirectUri: - http://localhost clientAuthenticationMethods: - client_secret_post - client_secret_basic clientPermissions: roles: ROLE_API: - testTenant ROLE_USER: - testTenant permissions: {} permissionsByService: {} consumer: test - clientId: clientId2 authorizedGrantTypes: - client_credentials redirectUri: - http://localhost clientAuthenticationMethods: - client_secret_post - client_secret_basic clientPermissions: roles: ROLE_API: - testTenant1 ROLE_USER: - testTenant1 ROLE_WORKFLOW: - testTenant1 permissions: {} permissionsByService: {} consumer: test - clientId: clientId3 authorizedGrantTypes: - client_credentials redirectUri: - http://localhost clientAuthenticationMethods: - client_secret_post - client_secret_basic clientPermissions: roles: ROLE_API: - testTenant2 ROLE_USER: - testTenant2 ROLE_TEST: - testTenant2 permissions: {} permissionsByService: {} consumer: test '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: invalid_token error_description: 'Invalid access token: token' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Customer 'customerId' not found extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.ClientsController x-path: >- /private/swagger.htm?module=Configuration#/Client%20Management/getCustomerClients post: tags: - Client Management summary: >- This API creates the clients with the specific roles configured for the customer. operationId: addCustomerClients parameters: - name: customerId in: path description: ' Valid Customer ID.' required: true schema: type: string requestBody: description: ' Request body must be an array with client details.' content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientDetailsWrapper' examples: sample: description: Sample request for API value: - clientId: clientId clientDescription: description2 clientName: null clientEmail: email authorizedGrantTypes: - client_credentials redirectUri: - http://localhost accessTokenValidity: null refreshTokenValidity: null clientSecret: secret clientAuthenticationMethods: - client_secret_post - client_secret_basic clientPermissions: roles: ROLE_API: - testTenant1 ROLE_USER: - testTenant1 consumer: test required: false responses: '201': description: successful operation content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientDetailsWrapper' example: - clientId: clientId authorizedGrantTypes: - client_credentials clientDescription: description2 clientEmail: email redirectUri: - http://localhost clientSecret: secret clientAuthenticationMethods: - client_secret_post - client_secret_basic clientPermissions: roles: ROLE_API: - testTenant1 ROLE_USER: - testTenant1 permissions: {} permissionsByService: {} consumer: test '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: invalid_token error_description: 'Invalid access token: token' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Customer 'CustomerId' not found extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.ClientsController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Client%20Management/addCustomerClients /services/oauth/customers/{customerId}/clients/{clientId}: get: tags: - Client Management summary: >- This API request displays the details of an application client for a specific customer, based on the Client ID and Customer ID mentioned in the path description: >- The client details such as id, roles, authentication methods are displayed. operationId: getCustomerClient parameters: - name: clientId in: path required: true schema: pattern: .+ type: string - name: customerId in: path description: ' ID of the customer for which you want to check the client details.' required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ClientDetailsWrapper' example: clientId: clientId authorizedGrantTypes: - client_credentials redirectUri: - http://localhost clientAuthenticationMethods: - client_secret_post - client_secret_basic clientPermissions: roles: ROLE_API: - testTenant ROLE_USER: - testTenant permissions: {} permissionsByService: {} consumer: test '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: invalid_token error_description: 'Invalid access token: token' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Client with id:'clientId' isn't registered extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.ClientsController x-path: >- /private/swagger.htm?module=Configuration#/Client%20Management/getCustomerClient put: tags: - Client Management summary: >- API request updates the client associated with the customer with the JSON object send in the request body. operationId: updateCustomerClient parameters: - name: skipTokenRevocation in: query schema: type: boolean - name: customerId in: path description: ' Valid customer ID.' required: true schema: type: string - name: clientId in: path description: ' Unique ID of the specific client.' required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientDetailsWrapper' examples: sample: description: Sample request for API value: clientId: clientId authorizedGrantTypes: - client_credentials clientDescription: description2 clientName: null clientEmail: email redirectUri: - http://localhost accessTokenValidity: null refreshTokenValidity: null clientAuthenticationMethods: - client_secret_post - client_secret_basic clientPermissions: roles: ROLE_API: - testTenant ROLE_USER: - testTenant consumer: test required: false responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ClientDetailsWrapper' example: clientId: clientId authorizedGrantTypes: - client_credentials clientDescription: description2 clientEmail: email redirectUri: - http://localhost clientAuthenticationMethods: - client_secret_post - client_secret_basic clientPermissions: roles: roles: ROLE_API: - testTenant ROLE_USER: - testTenant permissions: {} permissionsByService: {} consumer: test '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: invalid_token error_description: 'Invalid access token: token' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Client with id:'clientId' isn't registered extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.ClientsController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Client%20Management/updateCustomerClient delete: tags: - Client Management summary: >- This API request deletes the client associated with the specified customer. operationId: deleteCustomerClient parameters: - name: customerId in: path description: ' Valid Customer ID.' required: true schema: type: string - name: clientId in: path description: ' Unique ID of the client to be deleted.' required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/OperationStatus' example: status: success '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: invalid_token error_description: 'Invalid access token: token' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Client with id:'clientId' isn't registered extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.ClientsController x-path: >- /private/swagger.htm?module=Configuration#/Client%20Management/deleteCustomerClient /services/oauth/customers/{customerId}/clients/{clientId}/multitokens: get: tags: - Client Management summary: >- This API represents the status of multitokens usage for Client ID of Customer ID mentioned in the path operationId: getMultitokenStatsForCustomerClient parameters: - name: customerId in: path description: ' ID of the customer for which you want to see the status of multitokens usage.' required: true schema: type: string - name: clientId in: path description: ' ID of the client for which you want to see the status of multitokens usage.' required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ClientMultitokenStats' example: status: enabled tokensCount: 100 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied. '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Client with id:'clientId' isn't registered extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.ClientsController x-path: >- /private/swagger.htm?module=Configuration#/Client%20Management/getMultitokenStatsForCustomerClient /services/oauth/customers/{customerId}/clients/{clientId}/revoketokens: put: tags: - Client Management summary: >- This API revokes all active client credentials tokens for Client ID of Customer ID mentioned in the path operationId: revokeTokensForCustomerClient parameters: - name: customerId in: path description: ' ID of the customer for which you want to revoke all client credentials tokens.' required: true schema: type: string - name: clientId in: path description: ' ID of the client for which you want to revoke all client credentials tokens.' required: true schema: type: string requestBody: {} responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/OperationStatus' example: status: success '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied. '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Client with id:'clientId' isn't registered extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.ClientsController x-path: >- /private/swagger.htm?module=Configuration#/Client%20Management/revokeTokensForCustomerClient /services/oauth/customers/{customerId}/mfa: get: tags: - Customer Management summary: >- You can retrieve the Update MFA enablement details status: specifies the status of the MFA allowed values are [ENROLL, ENFORCE, DISABLED], availables: Specify allowed MFA that user can enroll = AUTHENTICATOR operationId: getMFADetails parameters: - name: customerId in: path required: true schema: pattern: .+ type: string requestBody: description: Specify the MFA details. content: application/json: schema: $ref: '#/components/schemas/MFAConfig' required: false responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/MFAConfig' example: status: ENABLED availables: - AUTHENTICATOR '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden '404': description: The resource you were trying to reach is not found extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.CustomersController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/getMFADetails put: tags: - Customer Management summary: >- You can update the Update MFA enablement details status: specifies the status of the MFA allowed values are [ENROLL, ENFORCE, DISABLED], availables: Specify allowed MFA that user can enroll = AUTHENTICATOR operationId: updateMFADetails parameters: - name: customerId in: path required: true schema: pattern: .+ type: string requestBody: description: Specify the MFA details. content: application/json: schema: $ref: '#/components/schemas/MFAConfig' examples: sample: description: Sample request for API value: status: ENABLED availables: - AUTHENTICATOR required: false responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/MFAConfig' example: status: ENABLED availables: - AUTHENTICATOR '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden '404': description: The resource you were trying to reach is not found extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.CustomersController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/updateMFADetails /services/oauth/customers/{customerId}/passwordPolicy: get: tags: - Customer Management summary: Get Customer Password Policy of a customer. description: You can retrieve the password policy operationId: getCustomerPasswordPolicy parameters: - name: customerId in: path required: true schema: pattern: .+ type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/PasswordPolicy' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden '404': description: The resource you were trying to reach is not found extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.CustomersController x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/getCustomerPasswordPolicy put: tags: - Customer Management summary: >- Update Customer Password Policy API updates the password policy of a customer. description: >- You can specify the password policy in the following parameters:

operationId: updateCustomerPasswordPolicy parameters: - name: customerId in: path required: true schema: pattern: .+ type: string requestBody: description: Specify the password policy details. content: application/json: schema: $ref: '#/components/schemas/PasswordPolicy' required: false responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/PasswordPolicy' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Customer with id:'BestCustomer' doesn't exist extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.CustomersController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/updateCustomerPasswordPolicy /services/oauth/customers/{customerId}/roles: get: tags: - Customer Management summary: >- Returns roles that are available for assignment for users of that customer description: >- Returns roles that are available for assignment for users of that customer operationId: getRolesByCustomer parameters: - name: customerId in: path required: true schema: pattern: .+ type: string - name: for in: query schema: type: string enum: - clients responses: '200': description: successful operation content: application/json: schema: type: array items: type: string example: - ROLE_ADMIN_TENANT - ROLE_API - CUSTOMER_SPECIFIC_ROLE '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Customer with id:'BestCustomer' doesn't exist extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.CustomersController x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/getRolesByCustomer put: tags: - Customer Management summary: Updates the customer specific roles description: Updates the customer specific roles to the customer operationId: updateCustomerRoles parameters: - name: customerId in: path required: true schema: pattern: .+ type: string requestBody: description: Roles list content: application/json: schema: type: array items: type: string examples: sample: description: Sample request for API value: - ROLE_EXPORT required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/Customer' example: id: BestCustomer tenants: - devTenantId - testTenantId - prodtenantId externalProviderConfig: - providerId: devTenant_provide vendor: okta oidc loginEndpoint: https://dev.okta.com/oauth2/default/v1/authorize tokenEndpoint: https://dev.okta.com/oauth2/default/v1/token userInfoEndpoint: https://dev.okta.com/oauth2/default/v1/userinfo callbackEndpoint: https://auth.reltio.com/oauth/callback clientId: '*********' clientSecret: '********' scope: openid profile email userIdMapping: email userEmailMapping: email defaultNewUserRoleList: - ROLE_API - ROLE_USER tenants: - devTenantId jwt: true jwtSignatureConfig: algorithm: RSA256 issuer: https://dev.okta.com/oauth2/default jwksURL: https://dev.okta.com/oauth2/default/v1/keys rolePerTenantSsoEnabled: false sendClientCredentialsInBody: true description: description of the customer passwordPolicy: inactivePeriodInDays: 1 numberOfFailedLoginAttempts: 2 caseSensitiveLoginEnabled: true applicationClients: - test-export-client customerSpecificRoles: - ROLE_DATALOADER_TST_CUSTOM - ROLE_ADMIN_READONLY_DUPL - ROLE_P_FULLACCESS_DEV '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Customer with id:'BestCustomer' doesn't exist extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.CustomersController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/updateCustomerRoles post: tags: - Customer Management summary: Adds the customer specific roles description: Adds the customer specific roles to customer operationId: addCustomerRoles parameters: - name: customerId in: path required: true schema: pattern: .+ type: string requestBody: description: Roles list content: application/json: schema: type: array items: type: string examples: sample: description: Sample request for API value: - ROLE_EXPORT required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/Customer' example: id: BestCustomer tenants: - devTenantId - testTenantId - prodtenantId externalProviderConfig: - providerId: devTenant_provide vendor: okta oidc loginEndpoint: https://dev.okta.com/oauth2/default/v1/authorize tokenEndpoint: https://dev.okta.com/oauth2/default/v1/token userInfoEndpoint: https://dev.okta.com/oauth2/default/v1/userinfo callbackEndpoint: https://auth.reltio.com/oauth/callback clientId: '*********' clientSecret: '********' scope: openid profile email userIdMapping: email userEmailMapping: email defaultNewUserRoleList: - ROLE_API - ROLE_USER tenants: - devTenantId jwt: true jwtSignatureConfig: algorithm: RSA256 issuer: https://dev.okta.com/oauth2/default jwksURL: https://dev.okta.com/oauth2/default/v1/keys rolePerTenantSsoEnabled: false sendClientCredentialsInBody: true description: description of the customer passwordPolicy: inactivePeriodInDays: 1 numberOfFailedLoginAttempts: 2 caseSensitiveLoginEnabled: true applicationClients: - test-export-client customerSpecificRoles: - ROLE_DATALOADER_TST_CUSTOM - ROLE_ADMIN_READONLY_DUPL - ROLE_P_FULLACCESS_DEV '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Customer with id:'BestCustomer' doesn't exist extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.CustomersController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/addCustomerRoles /services/oauth/customers/{customerId}/roles/permissions: post: tags: - Customer Management summary: Adds the permissions to role under the customer description: >- The user must be a customer administrator (must have the 'ROLE_CUSTOMER_ADMIN' role) to use this API. operationId: createCustomRolePermissions parameters: - name: customerId in: path description: ID of the customer required: true schema: type: string example: BestCustomer requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RolesPermissions' examples: sample: description: Sample request for API value: - roleName: ROLE_DATALOADER_INT servicePermissions: - id: dataloader resourcePermissions: - id: config allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: mappings allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: project allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: jobs allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: storage allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: limits allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: tasks allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: jobs allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: MDM resourcePermissions: - id: data resourcePermissions: - id: entities resourcePermissions: - id: profile allowedPrivileges: - CREATE - UPDATE - id: relations allowedPrivileges: - CREATE - UPDATE - id: tasks resourcePermissions: - id: periodic allowedPrivileges: - READ - EXECUTE - UPDATE required: true responses: '200': description: successful operation content: application/json: schema: type: array items: $ref: '#/components/schemas/RolesPermissions' example: - roleName: ROLE_DATALOADER_INT servicePermissions: - id: dataloader resourcePermissions: - id: config allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: mappings allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: project allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: jobs allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: storage allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: limits allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: tasks allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: jobs allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: MDM resourcePermissions: - id: data resourcePermissions: - id: entities resourcePermissions: - id: profile allowedPrivileges: - CREATE - UPDATE - id: relations allowedPrivileges: - CREATE - UPDATE - id: tasks resourcePermissions: - id: periodic allowedPrivileges: - READ - EXECUTE - UPDATE '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: invalid_token error_description: 'Invalid access token: 7056b0b5-11f6-407a-ae16-126b8daf88281' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: Customer 'customerId' not found extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.CustomerRolePermissionsController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/createCustomRolePermissions /services/oauth/customers/{customerId}/roles/permissions/{roleName}: get: tags: - Customer Management summary: >- Retrieves all the permissions configured for the specified role under the customer description: >- The user must be a customer administrator (must have the 'ROLE_CUSTOMER_ADMIN' role) to use this API. operationId: getCustomRolePermissionsByRole parameters: - name: customerId in: path description: ID of the customer required: true schema: type: string example: BestCustomer - name: roleName in: path description: Customer Role name required: true schema: type: string example: ROLE_DATALOADER_API responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/RolesPermissions' example: roleName: ROLE_DATALOADER_API servicePermissions: - id: dataloader resourcePermissions: - id: config allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: mappings allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: project allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: jobs allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: storage allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: limits allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: tasks allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: jobs allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: MDM resourcePermissions: - id: data resourcePermissions: - id: entities resourcePermissions: - id: profile allowedPrivileges: - CREATE - UPDATE - id: relations allowedPrivileges: - CREATE - UPDATE - id: tasks resourcePermissions: - id: periodic allowedPrivileges: - READ - EXECUTE - UPDATE '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: invalid_token error_description: 'Invalid access token: 7056b0b5-11f6-407a-ae16-126b8daf88281' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: example: errorCode: 404 errorMessage: No permissions found for role ROLE_DATALOADER_API extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.CustomerRolePermissionsController x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/getCustomRolePermissionsByRole put: tags: - Customer Management summary: >- Updates the permissions configured for the specified role under the customer description: >- The user must be a customer administrator (must have the 'ROLE_CUSTOMER_ADMIN' role) to use this API. operationId: updateCustomRolePermissions parameters: - name: customerId in: path description: ID of the customer required: true schema: type: string example: BestCustomer - name: roleName in: path description: Customer Role name required: true schema: type: string example: ROLE_DATALOADER_API requestBody: content: application/json: schema: $ref: '#/components/schemas/RolesPermissions' examples: sample: description: Sample request for API value: roleName: ROLE_DATALOADER_API servicePermissions: - id: dataloader resourcePermissions: - id: config allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: mappings allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: project allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: jobs allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: storage allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: limits allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: tasks allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: jobs allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: MDM resourcePermissions: - id: data resourcePermissions: - id: entities resourcePermissions: - id: profile allowedPrivileges: - CREATE - UPDATE - id: relations allowedPrivileges: - CREATE - UPDATE - id: tasks resourcePermissions: - id: periodic allowedPrivileges: - READ - EXECUTE - UPDATE required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/RolesPermissions' example: roleName: ROLE_DATALOADER_API servicePermissions: - id: dataloader resourcePermissions: - id: config allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: mappings allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: project allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: jobs allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: storage allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: limits allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: tasks allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE resourcePermissions: - id: jobs allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: MDM resourcePermissions: - id: data resourcePermissions: - id: entities resourcePermissions: - id: profile allowedPrivileges: - CREATE - UPDATE - id: relations allowedPrivileges: - CREATE - UPDATE - id: tasks resourcePermissions: - id: periodic allowedPrivileges: - READ - EXECUTE - UPDATE '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: invalid_token error_description: 'Invalid access token: 7056b0b5-11f6-407a-ae16-126b8daf88281' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied '404': description: The resource you were trying to reach is not found extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.CustomerRolePermissionsController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/updateCustomRolePermissions delete: tags: - Customer Management summary: >- Deletes all the permissions configured for the specified role under the customer description: >- The user must be a customer administrator (must have the 'ROLE_CUSTOMER_ADMIN' role) to use this API.
This will delete only the customer specific role and System roles cannot be deleted operationId: deleteCustomRolePermissions parameters: - name: customerId in: path description: ID of the customer required: true schema: type: string example: BestCustomer - name: roleName in: path description: Customer Role name required: true schema: type: string example: ROLE_DATALOADER_API responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/OperationStatus' example: status: success '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: invalid_token error_description: 'Invalid access token: 7056b0b5-11f6-407a-ae16-126b8daf88281' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.CustomerRolePermissionsController x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/deleteCustomRolePermissions /services/oauth/roles/permissions/{roleName}: get: tags: - Customer Management summary: Retrieves the System role details description: Retrieves the permissions configured for the specified System role operationId: getSystemRolePermissionsByRole parameters: - name: roleName in: path description: Role name required: true schema: type: string example: ROLE_DATALOADER responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/RolesPermissions' example: roleName: ROLE_DATALOADER servicePermissions: - id: scheduler allowedPrivileges: - READ - DELETE - CREATE - UPDATE - id: dataloader allowedPrivileges: - READ - EXECUTE - DELETE - CREATE - UPDATE - id: MDM resourcePermissions: - id: data resourcePermissions: - id: entities resourcePermissions: - id: profile allowedPrivileges: - CREATE - UPDATE - id: relations allowedPrivileges: - CREATE - UPDATE - id: tasks resourcePermissions: - id: periodic allowedPrivileges: - READ - EXECUTE - UPDATE '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' '403': description: The resource you were trying to reach is forbidden content: application/json: example: errorCode: 403 errorMessage: Access is denied extensions: x-module: oauth2-security x-controllerName: com.reltio.auth.rest.controller.GlobalRolePermissionsController x-path: >- /private/swagger.htm?module=Configuration#/Customer%20Management/getSystemRolePermissionsByRole /services/configuration/{tenantId}: get: tags: - Reference Data Management summary: >- Get Tenant Configuration API retrieves the configuration details of RDM tenant. description: This API allows you to review the configuration of RDM tenant. operationId: getByTenant parameters: - name: tenantId in: path description: ID of the RDM tenant. required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RDM Tenant Configuration' '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.TenantsController x-path: >- /private/swagger.htm?module=Configuration#/Reference%20Data%20Management/getByTenant put: tags: - Reference Data Management summary: >- Update Tenant Configuration API will update/set configuration of RDM tenant. description: >- This API sets the configuration for RDM tenant. If a configuration was already defined for the tenant, then that configuration is overridden with this operation. If the configuration is persisted successfully, then the response contains JSON of the saved configuration for the tenant. operationId: updateByTenant parameters: - name: tenantId in: path description: ID of the RDM tenant. required: true schema: type: string requestBody: description: Configuration to be updated. content: application/json: schema: $ref: '#/components/schemas/RDM Tenant Configuration' required: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/RDM Tenant Configuration' '400': description: The operation cannot be performed because input data are incorrect content: application/json: schema: $ref: '#/components/schemas/API Error' '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 '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.TenantsController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Reference%20Data%20Management/updateByTenant /services/generators/{tenantId}: post: tags: - Reference Data Management summary: >- Create Generator API automatically generates canonical codes for all the canonical values in a lookup type. description: >- You can assign one generator to multiple lookup types. You can generate UUID or Sequential types of generator. A UUID generator generates universally unique identifier codes for canonical values. A Sequential generator generates codes in a sequence. operationId: rdmAddGeneratorsByTenant parameters: - name: tenantId in: path description: ID of the RDM tenant required: true schema: type: string requestBody: description: A list of generators to be created. content: application/json: schema: type: array items: $ref: '#/components/schemas/Generator model' required: true responses: '200': description: Successful operation content: application/json: schema: type: array items: $ref: '#/components/schemas/Generator model' '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.GeneratorsController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Reference%20Data%20Management/rdmAddGeneratorsByTenant /services/generators/{tenantId}/{name}: get: tags: - Reference Data Management summary: Get a generator for a tenant by it's name description: >- This API returns a generator details by it's name. The details include details such as the name of the generator, type, start value of the range, and current value are retrieved. operationId: rdmGetGeneratorByTenant parameters: - name: tenantId in: path description: ID of the RDM tenant required: true schema: type: string - name: name in: path description: Name of the generator required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Generator model' '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.GeneratorsController x-path: >- /private/swagger.htm?module=Configuration#/Reference%20Data%20Management/rdmGetGeneratorByTenant delete: tags: - Reference Data Management summary: Delete a generator description: >- This API deletes a generator. If a generator is being used by any lookup type, then you cannot delete it. Please remove the dependencies first. operationId: rdmDeleteGeneratorByTenant parameters: - name: tenantId in: path description: ID of the RDM tenant required: true schema: type: string - name: name in: path description: Name of the generator required: true schema: type: string example: country_gen responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/Operation status' '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.GeneratorsController x-path: >- /private/swagger.htm?module=Configuration#/Reference%20Data%20Management/rdmDeleteGeneratorByTenant /services/generators/{tenantId}/{name}/generate: get: tags: - Reference Data Management summary: Get the next value generated by the generator description: >- This API generates and returns the next value for a specified generator. For example, if the generator type is sequential and the current value is 100, then the next generated value will be 101. If you call this API one more time, then the next value will be generated and returned for that generator 102. operationId: rdmGetGeneratedValueByTenant parameters: - name: tenantId in: path description: ID of the RDM tenant required: true schema: type: string - name: name in: path description: Name of the generator required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: type: string example: 101 '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.GeneratorsController x-path: >- /private/swagger.htm?module=Configuration#/Reference%20Data%20Management/rdmGetGeneratedValueByTenant /services/api/v1/security/samlconfig/{customerId}/{tenantId}: get: tags: - SAML summary: Retrieves SAML Configuration description: Retrieves SAML configuration for the tenant operationId: getSAMLConfig parameters: - name: customerId in: path description: Customer Id required: true schema: type: string example: SSOCustomer - name: tenantId in: path description: ID of the tenant required: true schema: type: string responses: '200': description: SAML configuration retrieved successfully content: application/json: schema: $ref: '#/components/schemas/SAMLConfigResponse' example: metadata: >- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified acsURL: >- https://reltio-test.auth.us-east-1.amazoncognito.com/saml2/idpresponse entityID: urn:amazon:cognito:sp:us-east-1_7tzK7YiR2 defaultRoles: - ROLE_API - ROLE_USER emailSAMLAttribute: email rolesSAMLAttribute: roles rolesMappingRegex: ([-a-zA-Z0-9_]*),*? defaultGroups: - SALES_GROUP groupsSAMLAttribute: groups groupsMappingRegex: ([-a-zA-Z0-9_]*),*? '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: unauthorized error_description: Full authentication is required to access this resource '403': description: The resource you were trying to reach is forbidden content: application/json: schema: $ref: '#/components/schemas/SAMLServiceErrorRepresentation' example: error: access_denied error_description: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: schema: $ref: '#/components/schemas/SAMLServiceErrorRepresentation' example: severity: Error errorMessage: No identity providers configured for tenant 'devTenantId' errorCode: 4 errorDetailMessage: >- Failed in Authentication Server: Failed in Authentication Server: com.reltio.auth.exception.NoProviderForTenantException:No identity providers configured for tenant 'devTenantId' innerErrorData: exception: >- com.reltio.services.security.common.exception.SecurityServiceException:No identity providers configured for tenant 'devTenantId' stack: - >- com.reltio.services.security.service.cognito.CognitoSAMLConfigServiceImpl.getSAMLConfig at CognitoSAMLConfigServiceImpl.java, line 98 innerErrorData: exception: >- com.reltio.services.security.common.exception.SecurityServiceException:No identity providers configured for tenant 'devTenantId' stack: - >- com.reltio.services.security.service.cognito.CognitoUtil.executeRemoteCall at CognitoUtil.java, line 107 extensions: x-module: security x-controllerName: com.reltio.services.security.controller.SAMLConfigController x-path: /private/swagger.htm?module=Configuration#/SAML/getSAMLConfig put: tags: - SAML summary: Updates SAML Configuration description: Updates SAML configuration for the tenant operationId: updateSAML parameters: - name: customerId in: path description: Customer Id required: true schema: type: string example: SSOCustomer - name: tenantId in: path description: ID of the tenant required: true schema: type: string requestBody: description: SAML Config Request content: application/json: schema: $ref: '#/components/schemas/SAMLConfigRequest' examples: sample: description: Sample request for API value: metaData: >- MIIDpDCCAoygAwIBAgIGAVyqFHG8MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEG A1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU MBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi04OTg2NTAxHDAaBgkqhkiG9w0BCQEW DWluZm9Ab2t0YS5jb20wHhcNMTcwNjE1MDQ0NzA1WhcNMjcwNjE1MDQ0ODA1WjCBkjELMAkGA1UE BhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNV BAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtODk4NjUwMRwwGgYJ KoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA ivQEv6UjYWBZ86Fzi5EAy9XV8EAIUtRgIpH1LX/+Pfov0ifbHE53uc2JzztZnuZ8S8W24O9PW9XS noSGrM+twAyRKIINDvuTGdIBJUopzHMlxLbYm+3z5hO6TaqwELeUc2y5XE7rrV0W0qhfpg6yUlmr YKUhPzA+xhL0urBJbVa1nkFPWyoiVRzHDA/pgFlGSdOJvHirtUb3laiOzizA6jZMgarj5vme9nAF wr4q8zPhWdac9ZmqjXMDwICoi7f5EDkBbNLDciFPQOAA1I8S7l0kKrpn+YGYB3+DLMfUJgiujfki DF7GhWTXaYxa5SzsE2uLcp/I+91Qm39lMRNu3QIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQBLyraa h8HQsTXqnSQHFiK1qm0wuRE82i210Gq0ustILPC46AF+0L9XpnGPdWgNtyegDApLw5u60t3iZhpG xE22iuiLmtz52w1KwC0gfBlRV8pLRlqU9pCUC1niOMC94xJUR7eAJtd9t55a2SATIHngZjKjRSsF hTo0sm6LG1Z6D3tzsXRe9YlUCHAkeREwrXd8gnMSoT2CewwwHaHSAWXnxKalANsn5DEefM9+Fo/x B6mvYeTmKZ8BF4mGyCVUPkNfPpjxIyvpIv/ca6ZT5fnWxsEJcjR6MV16a2Jco8D4y/wdhUf0sE5/ L1FgFesAiNewkNnSm023ItUnrBDRvzPz urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress emailSAMLAttribute: email rolesSAMLAttribute: roles rolesMappingRegex: ([-a-zA-Z0-9_]*),*? defaultRoles: - ROLE_API - ROLE_USER defaultGroups: - SALES_GROUP groupsMappingRegex: ([-a-zA-Z0-9_]*),*? groupsSAMLAttribute: groups required: true responses: '200': description: SAML configuration updated successfully content: application/json: schema: $ref: '#/components/schemas/SAMLConfigResponse' example: metadata: >- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified acsURL: >- https://reltio-test.auth.us-east-1.amazoncognito.com/saml2/idpresponse entityID: urn:amazon:cognito:sp:us-east-1_7tzK7YiR2 defaultRoles: - ROLE_API - ROLE_USER emailSAMLAttribute: email rolesSAMLAttribute: roles rolesMappingRegex: ([-a-zA-Z0-9_]*),*? defaultGroups: - SALES_GROUP groupsSAMLAttribute: groups groupsMappingRegex: ([-a-zA-Z0-9_]*),*? '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/SAMLServiceErrorRepresentation' example: severity: Error errorMessage: >- At least one of the MetadataURL or MetadataFile should be provided. errorCode: 3 errorDetailMessage: >- An Error occurred in the IdP side: At least one of the MetadataURL or MetadataFile should be provided. innerErrorData: exception: >- com.reltio.services.security.common.exception.SecurityServiceException:At least one of the MetadataURL or MetadataFile should be provided. stack: - >- com.reltio.services.security.service.cognito.CognitoSAMLConfigServiceImpl.updateSAMLConfig at CognitoSAMLConfigServiceImpl.java, line 72 innerErrorData: exception: >- software.amazon.awssdk.services.cognitoidentityprovider.model.InvalidParameterException:At least one of the MetadataURL or MetadataFile should be provided. (Service: AWSCognitoIdentityProvider; Status Code: 400; Error Code: InvalidParameterException; Request ID: 424cd3cd-4965-4a5a-a972-8b34bef2b7aa) stack: - >- software.amazon.awssdk.core.internal.http.AmazonSyncHttpClient$RequestExecutor.handleErrorResponse at AmazonHttpClient.java, line 1588 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: unauthorized error_description: Full authentication is required to access this resource '403': description: The resource you were trying to reach is forbidden content: application/json: schema: $ref: '#/components/schemas/SAMLServiceErrorRepresentation' example: error: access_denied error_description: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: schema: $ref: '#/components/schemas/SAMLServiceErrorRepresentation' example: severity: Error errorMessage: No identity providers configured for tenant 'devTenantId' errorCode: 4 errorDetailMessage: >- Failed in Authentication Server: Failed in Authentication Server: com.reltio.auth.exception.NoProviderForTenantException:No identity providers configured for tenant 'devTenantId' innerErrorData: exception: >- com.reltio.services.security.common.exception.SecurityServiceException:No identity providers configured for tenant 'devTenantId' stack: - >- com.reltio.services.security.service.cognito.CognitoSAMLConfigServiceImpl.getSAMLConfig at CognitoSAMLConfigServiceImpl.java, line 98 innerErrorData: exception: >- com.reltio.services.security.common.exception.SecurityServiceException:No identity providers configured for tenant 'devTenantId' stack: - >- com.reltio.services.security.service.cognito.CognitoUtil.executeRemoteCall at CognitoUtil.java, line 107 '500': description: Internal server error, see details in the returned error message content: application/json: schema: $ref: '#/components/schemas/SAMLServiceErrorRepresentation' extensions: x-module: security x-controllerName: com.reltio.services.security.controller.SAMLConfigController x-codegen-request-body-name: body x-path: /private/swagger.htm?module=Configuration#/SAML/updateSAML post: tags: - SAML summary: Adds SAML Configuration description: Adds SAML configuration for the tenant operationId: configureSAML parameters: - name: customerId in: path description: Customer Id required: true schema: type: string example: SSOCustomer - name: tenantId in: path description: ID of the tenant required: true schema: type: string requestBody: description: SAML Config Request content: application/json: schema: $ref: '#/components/schemas/SAMLConfigRequest' examples: sample: description: Sample request for API value: metaData: >- MIIDpDCCAoygAwIBAgIGAVyqFHG8MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEG A1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU MBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi04OTg2NTAxHDAaBgkqhkiG9w0BCQEW DWluZm9Ab2t0YS5jb20wHhcNMTcwNjE1MDQ0NzA1WhcNMjcwNjE1MDQ0ODA1WjCBkjELMAkGA1UE BhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNV BAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtODk4NjUwMRwwGgYJ KoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA ivQEv6UjYWBZ86Fzi5EAy9XV8EAIUtRgIpH1LX/+Pfov0ifbHE53uc2JzztZnuZ8S8W24O9PW9XS noSGrM+twAyRKIINDvuTGdIBJUopzHMlxLbYm+3z5hO6TaqwELeUc2y5XE7rrV0W0qhfpg6yUlmr YKUhPzA+xhL0urBJbVa1nkFPWyoiVRzHDA/pgFlGSdOJvHirtUb3laiOzizA6jZMgarj5vme9nAF wr4q8zPhWdac9ZmqjXMDwICoi7f5EDkBbNLDciFPQOAA1I8S7l0kKrpn+YGYB3+DLMfUJgiujfki DF7GhWTXaYxa5SzsE2uLcp/I+91Qm39lMRNu3QIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQBLyraa h8HQsTXqnSQHFiK1qm0wuRE82i210Gq0ustILPC46AF+0L9XpnGPdWgNtyegDApLw5u60t3iZhpG xE22iuiLmtz52w1KwC0gfBlRV8pLRlqU9pCUC1niOMC94xJUR7eAJtd9t55a2SATIHngZjKjRSsF hTo0sm6LG1Z6D3tzsXRe9YlUCHAkeREwrXd8gnMSoT2CewwwHaHSAWXnxKalANsn5DEefM9+Fo/x B6mvYeTmKZ8BF4mGyCVUPkNfPpjxIyvpIv/ca6ZT5fnWxsEJcjR6MV16a2Jco8D4y/wdhUf0sE5/ L1FgFesAiNewkNnSm023ItUnrBDRvzPz urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress defaultRoles: - ROLE_API - ROLE_USER emailSAMLAttribute: email rolesSAMLAttribute: roles rolesMappingRegex: ([-a-zA-Z0-9_]*),*? defaultGroups: - SALES_GROUP groupsSAMLAttribute: groups groupsMappingRegex: ([-a-zA-Z0-9_]*),*? required: true responses: '200': description: SAML configuration added successfully content: application/json: schema: $ref: '#/components/schemas/SAMLConfigResponse' example: metadata: >- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified acsURL: >- https://reltio-test.auth.us-east-1.amazoncognito.com/saml2/idpresponse entityID: urn:amazon:cognito:sp:us-east-1_7tzK7YiR2 defaultRoles: - ROLE_API - ROLE_USER emailSAMLAttribute: email rolesSAMLAttribute: roles rolesMappingRegex: ([-a-zA-Z0-9_]*),*? defaultGroups: - SALES_GROUP groupsSAMLAttribute: groups groupsMappingRegex: ([-a-zA-Z0-9_]*),*? '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/SAMLServiceErrorRepresentation' example: severity: Error errorMessage: >- The domain name contains an invalid character. Domain names can only contain lower-case letters, numbers, and hyphens. Please enter a different name that follows this format: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$ errorCode: 3 errorDetailMessage: >- An Error occurred in the IdP side: The domain name contains an invalid character. Domain names can only contain lower-case letters, numbers, and hyphens. Please enter a different name that follows this format: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$ innerErrorData: exception: >- com.reltio.services.security.common.exception.SecurityServiceException:The domain name contains an invalid character. Domain names can only contain lower-case letters, numbers, and hyphens. Please enter a different name that follows this format: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$ stack: - >- com.reltio.services.security.service.cognito.CognitoSAMLConfigServiceImpl.configureSAML at CognitoSAMLConfigServiceImpl.java, line 56 innerErrorData: exception: >- software.amazon.awssdk.services.cognitoidentityprovider.model.InvalidParameterException:The domain name contains an invalid character. Domain names can only contain lower-case letters, numbers, and hyphens. Please enter a different name that follows this format: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$ (Service: AWSCognitoIdentityProvider; Status Code: 400; Error Code: InvalidParameterException; Request ID: 0778938e-2364-4012-a4a1-a4c57a0ad4eb) stack: - >- software.amazon.awssdk.core.internal.http.AmazonSyncHttpClient$RequestExecutor.handleErrorResponse at AmazonHttpClient.java, line 1588 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: unauthorized error_description: Full authentication is required to access this resource '403': description: The resource you were trying to reach is forbidden content: application/json: schema: $ref: '#/components/schemas/SAMLServiceErrorRepresentation' example: error: access_denied error_description: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: schema: $ref: '#/components/schemas/SAMLServiceErrorRepresentation' example: severity: Error errorMessage: >- Tenant with id "devtenantId" doesn't exist under customer SSOCustomer errorCode: 4 errorDetailMessage: >- Failed in Authentication Server: Failed in Authentication Server: com.reltio.auth.exception.AuthServiceException:Tenant with id "devtenantId" doesn't exist under customer SSOCustomer innerErrorData: exception: >- com.reltio.services.security.common.exception.SecurityServiceException:Tenant with id "devtenantId" doesn't exist under customer SSOCustomer stack: - >- com.reltio.services.security.service.cognito.CognitoSAMLConfigServiceImpl.getSAMLConfig at CognitoSAMLConfigServiceImpl.java, line 98 innerErrorData: exception: >- com.reltio.services.security.common.exception.SecurityServiceException:Tenant with id "devtenantId" doesn't exist under customer SSOCustomer stack: - >- com.reltio.services.security.service.cognito.CognitoUtil.executeRemoteCall at CognitoUtil.java, line 107 extensions: x-module: security x-controllerName: com.reltio.services.security.controller.SAMLConfigController x-codegen-request-body-name: body x-path: /private/swagger.htm?module=Configuration#/SAML/configureSAML delete: tags: - SAML summary: Deletes SAML Configuration description: Deletes SAML configuration for the tenant operationId: deleteSAMLConfig parameters: - name: customerId in: path description: Customer Id required: true schema: type: string example: SSOCustomer - name: tenantId in: path description: ID of the tenant required: true schema: type: string responses: '200': description: Request for deleting SAML Configuration received content: application/json: schema: type: object additionalProperties: type: object example: status: success '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: unauthorized error_description: Full authentication is required to access this resource '403': description: The resource you were trying to reach is forbidden content: application/json: schema: $ref: '#/components/schemas/SAMLServiceErrorRepresentation' example: error: access_denied error_description: Access is denied '404': description: The resource you were trying to reach is not found content: application/json: schema: $ref: '#/components/schemas/SAMLServiceErrorRepresentation' example: severity: Error errorMessage: No identity providers configured for tenant 'devTenantId' errorCode: 4 errorDetailMessage: >- Failed in Authentication Server: Failed in Authentication Server: com.reltio.auth.exception.NoProviderForTenantException:No identity providers configured for tenant 'devTenantId' innerErrorData: exception: >- com.reltio.services.security.common.exception.SecurityServiceException:No identity providers configured for tenant 'devTenantId' stack: - >- com.reltio.services.security.service.cognito.CognitoSAMLConfigServiceImpl.getSAMLConfig at CognitoSAMLConfigServiceImpl.java, line 98 innerErrorData: exception: >- com.reltio.services.security.common.exception.SecurityServiceException:No identity providers configured for tenant 'devTenantId' stack: - >- com.reltio.services.security.service.cognito.CognitoUtil.executeRemoteCall at CognitoUtil.java, line 107 extensions: x-module: security x-controllerName: com.reltio.services.security.controller.SAMLConfigController x-path: /private/swagger.htm?module=Configuration#/SAML/deleteSAMLConfig /services/reltio/api/{tenantId}/configuration: get: tags: - Data Model summary: Gets the configuration for a tenant with inheritance from verticals description: >- This API fetches the configuration of a tenant with inheritance of the related verticals operationId: getConfigurationByTenant parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ReltioBusinessModel' example: uri: configuration description: Example of Reltio Metadata Configuration label: Business Model schemaVersion: 2.2.5 sources: - uri: configuration/sources/LNKD label: Linkedin icon: images/source/linkedin.png abbreviation: LNKD - uri: configuration/sources/Reltio label: Reltio icon: images/source/reltio.png abbreviation: Reltio - uri: configuration/sources/ReltioCleanser label: Reltio Data Cleanser icon: images/source/reltio.png priority: 100500 abbreviation: ReltioCleanser - uri: configuration/sources/FB label: Facebook icon: images/source/facebook.png abbreviation: FB - uri: configuration/sources/TWITTER label: Twitter icon: images/source/twitter.png abbreviation: TWITTER abstract: false referenceConfigurationURI: configuration/_vertical/reltio-core-2020-1 attributeTypes: - uri: configuration/attributeTypes/AddressLine valueType: String matchTokenClass: class: com.reltio.match.token.AddressLineMatchToken comparatorClass: class: com.reltio.match.comparator.AddressLineComparator - uri: configuration/attributeTypes/PhoneNumber valueType: String matchTokenClass: class: com.reltio.match.token.PhoneNumberMatchToken comparatorClass: class: com.reltio.match.comparator.PhoneNumberComparator - uri: configuration/attributeTypes/Email valueType: String matchTokenClass: class: com.reltio.match.token.TextMatchToken - uri: configuration/attributeTypes/SimpleName valueType: String matchTokenClass: class: com.reltio.match.token.ComplexPhoneticNameToken comparatorClass: class: >- com.reltio.match.comparator.DynamicDamerauLevenshteinDistance - uri: configuration/attributeTypes/OrganizationName valueType: String matchTokenClass: class: com.reltio.match.token.OrganizationNameMatchToken comparatorClass: class: >- com.reltio.match.comparator.EqfOrganizationNameComparator - uri: configuration/attributeTypes/WebsiteURL valueType: URL comparatorClass: class: >- com.reltio.match.comparator.StringComparatorIgnoringNulls entityTypes: - uri: configuration/entityTypes/Organization label: Organization description: Organization entity type details typeColor: '#80D557' typeIcon: images/base_type/org.png typeImage: images/defaultImage/no-org.png typeGraphIcon: images/graphIcon/organization-icon.png entitySmartLogic: Organization extendsTypeURI: configuration/entityTypes/Party attributes: - label: Name name: Name description: Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Organization/attributes/Name skipInDataAccess: false - label: Doing Business As Name name: DoingBusinessAsName type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DoingBusinessAsName skipInDataAccess: false - label: Company Type name: CompanyType type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/CompanyType skipInDataAccess: false - label: CUSIP name: CUSIP type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/CUSIP skipInDataAccess: false - label: Sector name: Sector description: Sector type: String hidden: false important: false system: false values: - Public - Private attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Sector skipInDataAccess: false - label: Industry name: Industry type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Industry skipInDataAccess: false - label: Founded Year name: FoundedYear type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/FoundedYear skipInDataAccess: false - label: End Year name: EndYear type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/EndYear skipInDataAccess: false - label: IPO Year name: IPOYear type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IPOYear skipInDataAccess: false - label: Domicile State name: LegalDomicile description: State of Legal Domicile type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/LegalDomicile skipInDataAccess: false - label: Email Domain name: EmailDomain description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/EmailDomain skipInDataAccess: false - label: Status name: Status description: '' type: String hidden: false important: false system: false faceted: true values: - Operating - Operating Subsidiary - Reorganizing - Out of Business - Acquired attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Status skipInDataAccess: false - label: Ownership Status name: OwnershipStatus description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/OwnershipStatus skipInDataAccess: false - label: Trade Style Name name: TradeStyleName type: Nested hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/TradeStyleName attributes: - label: Name name: OrganizationName type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/TradeStyleName/attributes/OrganizationName skipInDataAccess: false - label: Language name: LanguageCode type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/TradeStyleName/attributes/LanguageCode skipInDataAccess: false - label: Former Organization Primary Name name: FormerOrganizationPrimaryName type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/TradeStyleName/attributes/FormerOrganizationPrimaryName skipInDataAccess: false - label: Display Sequence name: DisplaySequence type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/TradeStyleName/attributes/DisplaySequence skipInDataAccess: false - label: Type name: Type type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/TradeStyleName/attributes/Type skipInDataAccess: false skipInDataAccess: false - label: Prior DUNS NUmber name: PriorDUNSNUmber type: Nested hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/PriorDUNSNUmber attributes: - label: DUNS Number name: TransferDUNSNumber type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/PriorDUNSNUmber/attributes/TransferDUNSNumber skipInDataAccess: false - label: Reason name: TransferReasonText type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/PriorDUNSNUmber/attributes/TransferReasonText skipInDataAccess: false - label: Reason Code name: TransferReasonCode type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/PriorDUNSNUmber/attributes/TransferReasonCode skipInDataAccess: false - label: Transfer Date name: TransferDate type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/PriorDUNSNUmber/attributes/TransferDate skipInDataAccess: false - label: Transferred From DUNS Number name: TransferredFromDUNSNumber type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/PriorDUNSNUmber/attributes/TransferredFromDUNSNumber skipInDataAccess: false - label: Transferred To DUNS Number name: TransferredToDUNSNumber type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/PriorDUNSNUmber/attributes/TransferredToDUNSNumber skipInDataAccess: false skipInDataAccess: false - label: Is Subsidiary name: IsSubsidiary type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IsSubsidiary skipInDataAccess: false - label: Public/Private Indicator name: IsPublicPrivate type: String hidden: true important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IsPublicPrivate skipInDataAccess: false - label: Activation Date name: ActivationDate type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/ActivationDate skipInDataAccess: false - label: DnB Full Report Date name: DnBFullReportDate type: Date hidden: true important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DnBFullReportDate skipInDataAccess: false - label: DnB Last Update Date name: DnBLastUpdateDate type: Date hidden: true important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DnBLastUpdateDate skipInDataAccess: false - label: DUNS Number name: DUNSNumber type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DUNSNumber skipInDataAccess: false - label: DnB Global Ultimate Indicator name: DnBGlobalUltimateIndicator type: String hidden: true important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DnBGlobalUltimateIndicator skipInDataAccess: false - label: DnB Number of Family Members name: DnBNumberOfFamilyMembers type: Int hidden: true important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DnBNumberOfFamilyMembers skipInDataAccess: false - label: DnB Dias Code name: DnBDIASCode type: String hidden: true important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DnBDIASCode skipInDataAccess: false - label: Hierarchy Code name: DnBHierarchyCode type: String hidden: true important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DnBHierarchyCode skipInDataAccess: false - label: Is Manufacturing name: IsManufacturing type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IsManufacturing skipInDataAccess: false - label: Is Minority Owned name: IsMinorityOwned type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IsMinorityOwned skipInDataAccess: false - label: Owns Or Rents name: OwnsOrRents type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/OwnsOrRents skipInDataAccess: false - label: Facility Size In Sq Feet name: FacilitySizeInSqFeet type: Int hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/FacilitySizeInSqFeet skipInDataAccess: false - label: Legal Status Code name: LegalStatusCode type: String hidden: true important: false system: false required: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/LegalStatusCode skipInDataAccess: false - label: Status Code name: StatusCode type: String hidden: true important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/StatusCode skipInDataAccess: false - label: Marketability Indicator name: MarketabilityIndicator type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/MarketabilityIndicator skipInDataAccess: false - label: Start Year name: StartYear type: Int hidden: true important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/StartYear skipInDataAccess: false - label: Industry Code name: IndustryCode type: Nested hidden: true important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IndustryCode attributes: - label: DNB Code name: DNBCode type: Int hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IndustryCode/attributes/DNBCode skipInDataAccess: false - label: Industry Code name: IndustryCode type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IndustryCode/attributes/IndustryCode skipInDataAccess: false - label: Industry Code Description name: IndustryCodeDescription type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IndustryCode/attributes/IndustryCodeDescription skipInDataAccess: false - label: Industry Code Language Code name: IndustryCodeLanguageCode type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IndustryCode/attributes/IndustryCodeLanguageCode skipInDataAccess: false - label: Industry Code Writing Script name: IndustryCodeWritingScript type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IndustryCode/attributes/IndustryCodeWritingScript skipInDataAccess: false - label: Display Sequence name: DisplaySequence type: Int hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IndustryCode/attributes/DisplaySequence skipInDataAccess: false - label: Sales Percentage name: SalesPercentage type: Number hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IndustryCode/attributes/SalesPercentage skipInDataAccess: false - label: Type name: Type type: String hidden: false important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IndustryCode/attributes/Type skipInDataAccess: false - label: Industry Type Code name: IndustryTypeCode type: String hidden: false important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IndustryCode/attributes/IndustryTypeCode skipInDataAccess: false - label: Import/Export/Agent Code name: ImportExportAgent type: String hidden: false important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/IndustryCode/attributes/ImportExportAgent skipInDataAccess: false skipInDataAccess: false - label: Activities And Operations name: ActivitiesAndOperations type: Nested hidden: true important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/ActivitiesAndOperations attributes: - label: Line Of Business Description name: LineOfBusinessDescription type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/ActivitiesAndOperations/attributes/LineOfBusinessDescription skipInDataAccess: false - label: Language Code name: LanguageCode type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/ActivitiesAndOperations/attributes/LanguageCode skipInDataAccess: false - label: Writing Script Code name: WritingScriptCode type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/ActivitiesAndOperations/attributes/WritingScriptCode skipInDataAccess: false - label: Import Indicator name: ImportIndicator type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/ActivitiesAndOperations/attributes/ImportIndicator skipInDataAccess: false - label: Export Indicator name: ExportIndicator type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/ActivitiesAndOperations/attributes/ExportIndicator skipInDataAccess: false - label: Agent Indicator name: AgentIndicator type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/ActivitiesAndOperations/attributes/AgentIndicator skipInDataAccess: false skipInDataAccess: false - label: Employee Details name: EmployeeDetails type: Nested hidden: true important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/EmployeeDetails attributes: - label: Individual Employee Figures Date name: IndividualEmployeeFiguresDate type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/EmployeeDetails/attributes/IndividualEmployeeFiguresDate skipInDataAccess: false - label: Employees at this Location name: IndividualTotalEmployeeQuantity type: Int hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/EmployeeDetails/attributes/IndividualTotalEmployeeQuantity skipInDataAccess: false - label: Individual Employee Reliability name: IndividualReliabilityText type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/EmployeeDetails/attributes/IndividualReliabilityText skipInDataAccess: false - label: Total Employees name: TotalEmployeeQuantity type: Int hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/EmployeeDetails/attributes/TotalEmployeeQuantity skipInDataAccess: false - label: Total Employee Reliability name: TotalEmployeeReliability type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/EmployeeDetails/attributes/TotalEmployeeReliability skipInDataAccess: false - label: Principals Included name: PrincipalsIncluded type: String hidden: false important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/EmployeeDetails/attributes/PrincipalsIncluded skipInDataAccess: false skipInDataAccess: false - label: Key Financial Figures name: KeyFinancialFiguresOverview type: Nested hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview attributes: - label: Financial Statement To Date name: FinancialStatementToDate type: Date hidden: false important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/FinancialStatementToDate skipInDataAccess: false - label: Period Duration name: FinancialPeriodDuration description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/FinancialPeriodDuration skipInDataAccess: false - label: Sales Revenue Currency name: SalesRevenueCurrency description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/SalesRevenueCurrency skipInDataAccess: false - label: Sales Revenue Currency Code name: SalesRevenueCurrencyCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/SalesRevenueCurrencyCode skipInDataAccess: false - label: Sales Revenue Reliability Code name: SalesRevenueReliabilityCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/SalesRevenueReliabilityCode skipInDataAccess: false - label: Sales Revenue Unit Size name: SalesRevenueUnitOfSize description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/SalesRevenueUnitOfSize skipInDataAccess: false - label: Sales Revenue Amount name: SalesRevenueAmount description: '' type: Number hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/SalesRevenueAmount skipInDataAccess: false - label: Profit Or Loss Currency name: ProfitOrLossCurrency description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/ProfitOrLossCurrency skipInDataAccess: false - label: Profit Or Loss Reliability name: ProfitOrLossReliabilityText description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/ProfitOrLossReliabilityText skipInDataAccess: false - label: Profit Or Loss Unit name: ProfitOrLossUnitOfSize description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/ProfitOrLossUnitOfSize skipInDataAccess: false - label: Profit Or Loss Amount name: ProfitOrLossAmount description: '' type: Number hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/ProfitOrLossAmount skipInDataAccess: false - label: Sales Turnover Growth Rate name: SalesTurnoverGrowthRate description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/SalesTurnoverGrowthRate skipInDataAccess: false - label: Sales 3yr Growth Rate name: Sales3YryGrowthRate type: Int hidden: false important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/Sales3YryGrowthRate skipInDataAccess: false - label: Sales 5yr Growth Rate name: Sales5YryGrowthRate type: Int hidden: false important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/Sales5YryGrowthRate skipInDataAccess: false - label: Employee 3yr Growth Rate name: Employee3YryGrowthRate type: Int hidden: false important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/Employee3YryGrowthRate skipInDataAccess: false - label: Employee 5yr Growth Rate name: Employee5YryGrowthRate type: Int hidden: false important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/KeyFinancialFiguresOverview/attributes/Employee5YryGrowthRate skipInDataAccess: false skipInDataAccess: false - label: Match Quality name: MatchQuality type: Nested hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/MatchQuality attributes: - label: Confidence Code name: ConfidenceCode description: DnB Match Quality Confidence Code type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/MatchQuality/attributes/ConfidenceCode skipInDataAccess: false - label: Display Sequence name: DisplaySequence description: DnB Match Quality Display Sequence type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/MatchQuality/attributes/DisplaySequence skipInDataAccess: false - label: Match Code name: MatchCode type: String hidden: false important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/MatchQuality/attributes/MatchCode skipInDataAccess: false - label: BEMFAB (Marketability) name: BEMFAB type: String hidden: false important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/MatchQuality/attributes/BEMFAB skipInDataAccess: false - label: MatchGrade name: MatchGrade type: String hidden: false important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/MatchQuality/attributes/MatchGrade skipInDataAccess: false skipInDataAccess: false - label: Organization Detail name: OrganizationDetail type: Nested hidden: true important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/OrganizationDetail dataLabelPattern: '{MemberRole} {OperatingStatus}' attributes: - label: Member Role name: MemberRole type: String hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/OrganizationDetail/attributes/MemberRole skipInDataAccess: false - label: Standalone name: Standalone type: Boolean hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/OrganizationDetail/attributes/Standalone skipInDataAccess: false - label: Ownership Date name: ControlOwnershipDate type: Date hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/OrganizationDetail/attributes/ControlOwnershipDate skipInDataAccess: false - label: Operating Status name: OperatingStatus type: String hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/OrganizationDetail/attributes/OperatingStatus skipInDataAccess: false - label: Start Year name: StartYear type: String hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/OrganizationDetail/attributes/StartYear skipInDataAccess: false - label: Franchise Operation Type name: FranchiseOperationType type: String hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/OrganizationDetail/attributes/FranchiseOperationType skipInDataAccess: false - label: Boneyard Organization name: BoneyardOrganization type: Boolean hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/OrganizationDetail/attributes/BoneyardOrganization skipInDataAccess: false - label: Operating Status Comment name: OperatingStatusComment type: String hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/OrganizationDetail/attributes/OperatingStatusComment skipInDataAccess: false skipInDataAccess: false - label: DUNS Hierarchy name: DUNSHierarchy type: Nested hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DUNSHierarchy attributes: - label: Global Ultimate DUNS name: GlobalUltimateDUNS description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DUNSHierarchy/attributes/GlobalUltimateDUNS skipInDataAccess: false - label: Global Ultimate Organization name: GlobalUltimateOrganization description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DUNSHierarchy/attributes/GlobalUltimateOrganization skipInDataAccess: false - label: Domestic Ultimate DUNS name: DomesticUltimateDUNS description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DUNSHierarchy/attributes/DomesticUltimateDUNS skipInDataAccess: false - label: Domestic Ultimate Organization name: DomesticUltimateOrganization description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DUNSHierarchy/attributes/DomesticUltimateOrganization skipInDataAccess: false - label: Parent DUNS name: ParentDUNS description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DUNSHierarchy/attributes/ParentDUNS skipInDataAccess: false - label: Parent Organization name: ParentOrganization description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DUNSHierarchy/attributes/ParentOrganization skipInDataAccess: false - label: Headquarters DUNS name: HeadquartersDUNS description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DUNSHierarchy/attributes/HeadquartersDUNS skipInDataAccess: false - label: Headquarters Organization name: HeadquartersOrganization description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DUNSHierarchy/attributes/HeadquartersOrganization skipInDataAccess: false skipInDataAccess: false - label: Manual Verification Flag name: ManualVerificationFlag type: Boolean hidden: true important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/ManualVerificationFlag skipInDataAccess: false - label: Do Not Enrich name: DoNotEnrich type: Boolean hidden: true important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DoNotEnrich skipInDataAccess: false - label: Vendor Verification Date name: VendorVerificationDate type: Date hidden: true important: false system: false required: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/VendorVerificationDate skipInDataAccess: false - label: Vendor Verification Status name: VendorVerificationStatus type: String hidden: true important: false system: false required: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/VendorVerificationStatus skipInDataAccess: false - label: Legal Status Description name: LegalStatusDescription type: String hidden: true important: false system: false required: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/LegalStatusDescription skipInDataAccess: false - label: Image Link name: ImageLinks type: Image URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/ImageLinks skipInDataAccess: false - label: Video Link name: VideoLinks type: URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/VideoLinks skipInDataAccess: false - label: Document Link name: DocumentLinks type: URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/DocumentLinks skipInDataAccess: false - label: Phone name: Phone type: Nested hidden: false important: false system: false attributeOrdering: fieldURI: >- configuration/entityTypes/Organization/attributes/Phone/attributes/Rank orderType: ASC orderingStrategy: FieldBased uri: >- configuration/entityTypes/Organization/attributes/Phone dataLabelPattern: '{Number} {Type}' attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false values: - Mobile - Home - Work - Fax - Main - Work Fax - Home Fax - Pager - Other attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/Type skipInDataAccess: false - label: Number name: Number description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/Number skipInDataAccess: false - label: Extension name: Extension description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/Extension skipInDataAccess: false - label: Rank name: Rank description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/Rank skipInDataAccess: false - label: Country Code name: CountryCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/CountryCode skipInDataAccess: false - label: Area Code name: AreaCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/AreaCode skipInDataAccess: false - label: Local Number name: LocalNumber description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/LocalNumber skipInDataAccess: false - label: Validation Status name: ValidationStatus description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/ValidationStatus skipInDataAccess: false - label: Line Type name: LineType description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/LineType skipInDataAccess: false - label: Format Mask name: FormatMask description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/FormatMask skipInDataAccess: false - label: Digit Count name: DigitCount description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/DigitCount skipInDataAccess: false - label: Geo Area name: GeoArea description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/GeoArea skipInDataAccess: false - label: Geo Country name: GeoCountry description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/GeoCountry skipInDataAccess: false - label: Active name: Active description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Phone/attributes/Active skipInDataAccess: false skipInDataAccess: false - label: Website URL name: WebsiteURL type: URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/WebsiteURL skipInDataAccess: false - label: Identifiers name: Identifiers type: Nested hidden: false important: false system: false attributeOrdering: fieldURI: >- configuration/entityTypes/Organization/attributes/Identifiers/attributes/Type orderType: ASC orderingStrategy: FieldBased uri: >- configuration/entityTypes/Organization/attributes/Identifiers dataLabelPattern: '{Type} {ID} {Status}' matchFieldURIs: - >- configuration/entityTypes/Party/attributes/Identifiers/attributes/Type - >- configuration/entityTypes/Party/attributes/Identifiers/attributes/ID attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Identifiers/attributes/Type skipInDataAccess: false - label: ID name: ID description: '' type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Identifiers/attributes/ID skipInDataAccess: false - label: Status name: Status description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Identifiers/attributes/Status skipInDataAccess: false - label: Activation Date name: ActivationDate type: Date hidden: false important: false system: false required: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Identifiers/attributes/ActivationDate skipInDataAccess: false - label: Deactivation Reason Code name: DeactivationReasonCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Identifiers/attributes/DeactivationReasonCode skipInDataAccess: false - label: Deactivation Date name: DeactivationDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Identifiers/attributes/DeactivationDate skipInDataAccess: false - label: Reactivation Date name: ReactivationDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Identifiers/attributes/ReactivationDate skipInDataAccess: false skipInDataAccess: false - label: Email name: Email type: Nested hidden: false important: false system: false attributeOrdering: fieldURI: >- configuration/entityTypes/Organization/attributes/Email/attributes/Rank orderType: ASC orderingStrategy: FieldBased uri: >- configuration/entityTypes/Organization/attributes/Email dataLabelPattern: '{Email} {Type}' attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false values: - Home - Work - Other attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Email/attributes/Type skipInDataAccess: false - label: Email name: Email description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Email/attributes/Email skipInDataAccess: false - label: Domain name: Domain description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Email/attributes/Domain skipInDataAccess: false - label: Domain Type name: DomainType description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Email/attributes/DomainType skipInDataAccess: false - label: Username name: Username description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Email/attributes/Username skipInDataAccess: false - label: Rank name: Rank description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Email/attributes/Rank skipInDataAccess: false - label: Validation Status name: ValidationStatus description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Email/attributes/ValidationStatus skipInDataAccess: false - label: Active name: Active description: '' type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Email/attributes/Active skipInDataAccess: false - label: Source CD name: SourceCD description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Email/attributes/SourceCD skipInDataAccess: false skipInDataAccess: false - label: Address name: Address type: Reference hidden: false important: false system: false relationshipLabelPattern: '{AddressType}' attributeOrdering: fieldURI: >- configuration/relationTypes/HasAddress/attributes/AddressRank orderType: ASC orderingStrategy: FieldBased uri: >- configuration/entityTypes/Organization/attributes/Address referencedAttributeURIs: - >- configuration/relationTypes/HasAddress/attributes/AddressType - >- configuration/relationTypes/HasAddress/attributes/CareOf - >- configuration/relationTypes/HasAddress/attributes/Primary - >- configuration/relationTypes/HasAddress/attributes/AddressRank - >- configuration/entityTypes/Location/attributes/AddressLine1 - >- configuration/entityTypes/Location/attributes/AddressLine2 - configuration/entityTypes/Location/attributes/City - >- configuration/entityTypes/Location/attributes/Premise - configuration/entityTypes/Location/attributes/Street - >- configuration/entityTypes/Location/attributes/StateProvince - configuration/entityTypes/Location/attributes/Zip - >- configuration/entityTypes/Location/attributes/Country - >- configuration/entityTypes/Location/attributes/GeoLocation - >- configuration/entityTypes/Location/attributes/AddressInput - >- configuration/relationTypes/HasAddress/attributes/Phone - >- configuration/relationTypes/HasAddress/attributes/Active referencedEntityTypeURI: configuration/entityTypes/Location relationshipTypeURI: configuration/relationTypes/HasAddress skipInDataAccess: false - label: Tax ID name: TaxID description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/TaxID skipInDataAccess: false - label: Description name: Description description: '' type: Blob hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Description skipInDataAccess: false - label: Status Update Date name: StatusUpdateDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/StatusUpdateDate skipInDataAccess: false - label: StatusReasonCode name: StatusReasonCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/StatusReasonCode lookupCode: StatusReasonCode skipInDataAccess: false - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Organization/attributes/Commenters skipInDataAccess: false geoLocationAttributes: - latitude: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Latitude longitude: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Longitude dataLabelPattern: '{Name}' secondaryLabelPattern: '{businessCardAttributes}' survivorshipGroups: - uri: >- configuration/entityTypes/Organization/survivorshipGroups/default default: true mapping: - attribute: >- configuration/entityTypes/Organization/attributes/Address survivorshipStrategy: Aggregation - attribute: >- configuration/entityTypes/Organization/attributes/Identifiers survivorshipStrategy: Aggregation surrogateCrosswalks: - enforce: true source: configuration/sources/FB attributes: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/entityTypes/Organization/attributes/CompanyType - >- configuration/entityTypes/Organization/attributes/FoundedYear - >- configuration/entityTypes/Organization/attributes/Status - enforce: true source: configuration/sources/LNKD attributes: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/entityTypes/Organization/attributes/CompanyType - >- configuration/entityTypes/Organization/attributes/FoundedYear - >- configuration/entityTypes/Organization/attributes/Status abstract: false imageAttributeURIs: - >- configuration/entityTypes/Organization/attributes/ImageLinks analyticsAttributes: - uri: >- configuration/entityTypes/Organization/analyticsAttributes/DQ label: Data Quality description: >- DQ Score helps in evaluating the quality of the data in the profile name: DQ type: Nested maxOccurs: 1 analyticsAttributes: - uri: >- configuration/entityTypes/Organization/analyticsAttributes/DQ/analyticsAttributes/score label: Data Quality Score description: '' name: score type: Int maxOccurs: 1 - uri: >- configuration/entityTypes/Organization/analyticsAttributes/DQ/analyticsAttributes/updatedDate label: Updated date description: '' name: updatedDate type: Timestamp maxOccurs: 1 - uri: >- configuration/entityTypes/Organization/analyticsAttributes/IQ label: Reltio Rank description: >- Reltio Rank highlights the importance and relevance of a profile name: IQ type: Nested maxOccurs: 1 analyticsAttributes: - uri: >- configuration/entityTypes/Organization/analyticsAttributes/IQ/analyticsAttributes/score label: Reltio Rank Score description: '' name: score type: Int maxOccurs: 1 - uri: >- configuration/entityTypes/Organization/analyticsAttributes/IQ/analyticsAttributes/updatedDate label: Updated date description: '' name: updatedDate type: Timestamp maxOccurs: 1 - uri: configuration/entityTypes/Location label: Location description: Address information with GeoLocation dataTooltipPattern: Tooltip {VerificationStatus} typeColor: '#573eb5' typeIcon: images/base_type/house.png typeImage: images/defaultImage/no-loc.png typeGraphIcon: images/graphIcon/location-icon.png matchBeforeCreate: true cleanseConfig: mappings: - uri: >- configuration/entityTypes/Location/cleanse/mappings/address outputMapping: - attribute: >- configuration/entityTypes/Location/attributes/VerificationStatus mandatory: false allValues: false cleanseAttribute: VerificationStatus - attribute: >- configuration/entityTypes/Location/attributes/VerificationStatusDetails mandatory: false allValues: false cleanseAttribute: VerificationStatusDetails - attribute: >- configuration/entityTypes/Location/attributes/StateProvince mandatory: false allValues: false cleanseAttribute: AdministrativeArea - attribute: >- configuration/entityTypes/Location/attributes/City mandatory: false allValues: false cleanseAttribute: Locality - attribute: >- configuration/entityTypes/Location/attributes/SuperAdministrativeArea mandatory: false allValues: false cleanseAttribute: SuperAdministrativeArea - attribute: >- configuration/entityTypes/Location/attributes/DoubleDependentLocality mandatory: false allValues: false cleanseAttribute: DoubleDependentLocality - attribute: >- configuration/entityTypes/Location/attributes/Neighborhood mandatory: false allValues: false cleanseAttribute: DependentLocality - attribute: >- configuration/entityTypes/Location/attributes/DependentThoroughfare mandatory: false allValues: false cleanseAttribute: DependentThoroughfare - attribute: >- configuration/entityTypes/Location/attributes/Country mandatory: false allValues: false cleanseAttribute: CountryName - attribute: >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip5 mandatory: false allValues: false cleanseAttribute: PostalCodePrimary - attribute: >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip4 mandatory: false allValues: false cleanseAttribute: PostalCodeSecondary - attribute: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Latitude mandatory: false allValues: false cleanseAttribute: Latitude - attribute: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Longitude mandatory: false allValues: false cleanseAttribute: Longitude - attribute: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/GeoAccuracy mandatory: false allValues: false cleanseAttribute: GeoAccuracy - attribute: >- configuration/entityTypes/Location/attributes/POBox mandatory: false allValues: false cleanseAttribute: PostBox - attribute: >- configuration/entityTypes/Location/attributes/SubAdministrativeArea mandatory: false allValues: false cleanseAttribute: SubAdministrativeArea - attribute: >- configuration/entityTypes/Location/attributes/Building mandatory: false allValues: false cleanseAttribute: Building - attribute: >- configuration/entityTypes/Location/attributes/SubBuilding mandatory: false allValues: false cleanseAttribute: SubBuilding - attribute: >- configuration/entityTypes/Location/attributes/Organization mandatory: false allValues: false cleanseAttribute: Organization - attribute: >- configuration/entityTypes/Location/attributes/DeliveryAddress1 mandatory: false allValues: false cleanseAttribute: DeliveryAddress1 - attribute: >- configuration/entityTypes/Location/attributes/AddressLine1 mandatory: false allValues: false cleanseAttribute: DeliveryAddress1 - attribute: >- configuration/entityTypes/Location/attributes/AddressLine2 mandatory: false allValues: false cleanseAttribute: DeliveryAddress2 - attribute: >- configuration/entityTypes/Location/attributes/ISO3166-2 mandatory: false allValues: false cleanseAttribute: ISO3166-2 - attribute: >- configuration/entityTypes/Location/attributes/ISO3166-3 mandatory: false allValues: false cleanseAttribute: ISO3166-3 - attribute: >- configuration/entityTypes/Location/attributes/DeliveryAddress mandatory: false allValues: false cleanseAttribute: DeliveryAddress - attribute: >- configuration/entityTypes/Location/attributes/PremiseNumber mandatory: false allValues: false cleanseAttribute: PremiseNumber - attribute: >- configuration/entityTypes/Location/attributes/Premise mandatory: false allValues: false cleanseAttribute: Premise - attribute: >- configuration/entityTypes/Location/attributes/Street mandatory: false allValues: false cleanseAttribute: Thoroughfare - attribute: >- configuration/entityTypes/Location/attributes/ISO3166-N mandatory: false allValues: false cleanseAttribute: ISO3166-N - attribute: >- configuration/entityTypes/Location/attributes/Unmatched mandatory: false allValues: false cleanseAttribute: Unmatched - attribute: >- configuration/entityTypes/Location/attributes/AVC mandatory: false allValues: false cleanseAttribute: AVC - attribute: >- configuration/entityTypes/Location/attributes/AutoZoneIndicator mandatory: false allValues: false cleanseAttribute: AutoZoneIndicator - attribute: >- configuration/entityTypes/Location/attributes/CarrierRoute mandatory: false allValues: false cleanseAttribute: CarrierRoute - attribute: >- configuration/entityTypes/Location/attributes/CMRAIndicator mandatory: false allValues: false cleanseAttribute: CMRAIndicator - attribute: >- configuration/entityTypes/Location/attributes/CongressionalDistrict mandatory: false allValues: false cleanseAttribute: CongressionalDistrict - attribute: >- configuration/entityTypes/Location/attributes/DefaultFlag mandatory: false allValues: false cleanseAttribute: DefaultFlag - attribute: >- configuration/entityTypes/Location/attributes/DeliveryPointBarCode mandatory: false allValues: false cleanseAttribute: DeliveryPointBarCode - attribute: >- configuration/entityTypes/Location/attributes/DPVConfirmedIndicator mandatory: false allValues: false cleanseAttribute: DPVConfirmedIndicator - attribute: >- configuration/entityTypes/Location/attributes/DPVFootnotes mandatory: false allValues: false cleanseAttribute: DPVFootnotes - attribute: >- configuration/entityTypes/Location/attributes/eLOTCode mandatory: false allValues: false cleanseAttribute: eLOTCode - attribute: >- configuration/entityTypes/Location/attributes/eLOTNumber mandatory: false allValues: false cleanseAttribute: eLOTNumber - attribute: >- configuration/entityTypes/Location/attributes/EWSFlag mandatory: false allValues: false cleanseAttribute: EWSFlag - attribute: >- configuration/entityTypes/Location/attributes/FalsePositiveIndicator mandatory: false allValues: false cleanseAttribute: FalsePositiveIndicator - attribute: >- configuration/entityTypes/Location/attributes/FIPSCountyCode mandatory: false allValues: false cleanseAttribute: FIPSCountyCode - attribute: >- configuration/entityTypes/Location/attributes/Footnotes mandatory: false allValues: false cleanseAttribute: Footnotes - attribute: >- configuration/entityTypes/Location/attributes/LACSLinkCode mandatory: false allValues: false cleanseAttribute: LACSLinkCode - attribute: >- configuration/entityTypes/Location/attributes/LACSLinkIndicator mandatory: false allValues: false cleanseAttribute: LACSLinkIndicator - attribute: >- configuration/entityTypes/Location/attributes/LACSStatus mandatory: false allValues: false cleanseAttribute: LACSStatus - attribute: >- configuration/entityTypes/Location/attributes/NoStatIndicator mandatory: false allValues: false cleanseAttribute: NoStatIndicator - attribute: >- configuration/entityTypes/Location/attributes/PMBNumber mandatory: false allValues: false cleanseAttribute: PMBNumber - attribute: >- configuration/entityTypes/Location/attributes/PMBType mandatory: false allValues: false cleanseAttribute: PMBType - attribute: >- configuration/entityTypes/Location/attributes/PrimaryAddressLine mandatory: false allValues: false cleanseAttribute: PrimaryAddressLine - attribute: >- configuration/entityTypes/Location/attributes/RecordType mandatory: false allValues: false cleanseAttribute: RecordType - attribute: >- configuration/entityTypes/Location/attributes/ReturnCode mandatory: false allValues: false cleanseAttribute: ReturnCode - attribute: >- configuration/entityTypes/Location/attributes/ResidentialDelivery mandatory: false allValues: false cleanseAttribute: ResidentialDelivery - attribute: >- configuration/entityTypes/Location/attributes/SecondaryAddressLine mandatory: false allValues: false cleanseAttribute: SecondaryAddressLine - attribute: >- configuration/entityTypes/Location/attributes/SUITELinkFootnote mandatory: false allValues: false cleanseAttribute: SUITELinkFootnote - attribute: >- configuration/entityTypes/Location/attributes/VacantIndicator mandatory: false allValues: false cleanseAttribute: VacantIndicator infos: - uri: >- configuration/entityTypes/Location/cleanse/infos/default useInCleansing: true sequence: - chain: - cleanseFunction: Loqate resultingValuesSourceTypeUri: configuration/sources/ReltioCleanser proceedOnSuccess: true proceedOnFailure: false mapping: inputMapping: - attribute: >- configuration/entityTypes/Location/attributes/AddressInput mandatory: true allValues: false cleanseAttribute: Address outputMappingRef: >- configuration/entityTypes/Location/cleanse/mappings/address/outputMapping - uri: >- configuration/entityTypes/Location/cleanse/infos/other useInCleansing: true sequence: - chain: - cleanseFunction: Loqate resultingValuesSourceTypeUri: configuration/sources/ReltioCleanser proceedOnSuccess: true proceedOnFailure: false mapping: inputMapping: - attribute: >- configuration/entityTypes/Location/attributes/AddressLine1 mandatory: true allValues: false cleanseAttribute: Address1 - attribute: >- configuration/entityTypes/Location/attributes/AddressLine2 mandatory: false allValues: false cleanseAttribute: Address2 - attribute: >- configuration/entityTypes/Location/attributes/Country mandatory: false allValues: false cleanseAttribute: Country - attribute: >- configuration/entityTypes/Location/attributes/StateProvince mandatory: false allValues: false cleanseAttribute: AdministrativeArea - attribute: >- configuration/entityTypes/Location/attributes/City mandatory: false allValues: false cleanseAttribute: Locality - attribute: >- configuration/entityTypes/Location/attributes/Street mandatory: false allValues: false cleanseAttribute: Thoroughfare - attribute: >- configuration/entityTypes/Location/attributes/Premise mandatory: false allValues: false cleanseAttribute: Premise - attribute: >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip5 mandatory: false allValues: false cleanseAttribute: PostalCode - attribute: >- configuration/entityTypes/Location/attributes/Organization mandatory: false allValues: false cleanseAttribute: Organization outputMappingRef: >- configuration/entityTypes/Location/cleanse/mappings/address/outputMapping attributes: - label: Address Input name: AddressInput type: Blob hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/AddressInput skipInDataAccess: false - label: Address Line 1 name: AddressLine1 type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/AddressLine1 skipInDataAccess: false - label: Address Line 2 name: AddressLine2 type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/AddressLine2 skipInDataAccess: false - label: City name: City type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/City skipInDataAccess: false - label: State name: StateProvince type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/StateProvince skipInDataAccess: false - label: Country name: Country type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/Country skipInDataAccess: false - label: Zip name: Zip type: Nested hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/Zip dataLabelPattern: '{Zip5}-{Zip4}' attributes: - label: Postal Code name: PostalCode type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/Zip/attributes/PostalCode skipInDataAccess: false - label: Zip5 name: Zip5 type: String hidden: false important: false system: false searchable: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip5 skipInDataAccess: false - label: Zip4 name: Zip4 type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip4 skipInDataAccess: false skipInDataAccess: false - label: Verification Status name: VerificationStatus type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/VerificationStatus skipInDataAccess: false - label: Verification Status Details name: VerificationStatusDetails type: Blob hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/VerificationStatusDetails skipInDataAccess: false - label: AVC name: AVC type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/AVC skipInDataAccess: false - label: Country Name name: CountryName description: DO NOT USE this field - use Country instead type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/CountryName skipInDataAccess: false - label: ISO3166-2 name: ISO3166-2 description: >- This field holds the ISO 3166 2-character country code. type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/ISO3166-2 skipInDataAccess: false - label: ISO3166-3 name: ISO3166-3 description: >- This field holds the ISO 3166 3-character country code. type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/ISO3166-3 skipInDataAccess: false - label: ISO3166-N name: ISO3166-N description: >- This field holds the ISO 3166 N-digit numeric country code. type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/ISO3166-N skipInDataAccess: false - label: Super Admin Area name: SuperAdministrativeArea description: >- This field holds the largest geographic data element within a country. type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/SuperAdministrativeArea skipInDataAccess: false - label: Street name: Street type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/Street skipInDataAccess: false - label: Admin Area name: AdministrativeArea description: >- This field holds the most common geographic data element within a country. For instance, USA State, and Canadian Province. type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/AdministrativeArea skipInDataAccess: false - label: County name: SubAdministrativeArea description: >- This field holds the smallest geographic data element within a country. For instance, USA County. type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/SubAdministrativeArea skipInDataAccess: false - label: Postal Code Extension name: PostalCodeExtension description: DO NOT USE this field - use Zip/zip4 instead type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/PostalCodeExtension skipInDataAccess: false - label: Unit name: Unit type: Nested hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/Unit dataLabelPattern: '{UnitName}-{UnitValue}' attributes: - label: UnitName name: UnitName type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/Unit/attributes/UnitName skipInDataAccess: false - label: UnitValue name: UnitValue type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/Unit/attributes/UnitValue skipInDataAccess: false skipInDataAccess: false - label: Floor name: Floor description: N/A type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/Floor skipInDataAccess: false - label: Building name: Building description: N/A type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/Building skipInDataAccess: false - label: SubBuilding name: SubBuilding type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/SubBuilding skipInDataAccess: false - label: PO Box name: POBox type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/POBox skipInDataAccess: false - label: Neighborhood name: Neighborhood type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/Neighborhood skipInDataAccess: false - label: Double Dependent Locality name: DoubleDependentLocality type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/DoubleDependentLocality skipInDataAccess: false - label: Dependent Thoroughfare name: DependentThoroughfare type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/DependentThoroughfare skipInDataAccess: false - label: Locality name: Locality description: >- This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality. type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/Locality skipInDataAccess: false - label: GeoLocation name: GeoLocation type: Nested hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/GeoLocation dataLabelPattern: '{Latitude}, {Longitude}' attributes: - label: Latitude name: Latitude type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Latitude skipInDataAccess: false - label: Longitude name: Longitude type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Longitude skipInDataAccess: false - label: GeoAccuracy name: GeoAccuracy description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/GeoAccuracy skipInDataAccess: false skipInDataAccess: false - label: Organization name: Organization type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/Organization skipInDataAccess: false - label: Premise name: Premise type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/Premise skipInDataAccess: false - label: PremiseNumber name: PremiseNumber type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/PremiseNumber skipInDataAccess: false - label: Delivery Address name: DeliveryAddress type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/DeliveryAddress skipInDataAccess: false - label: 'Delivery Address #1' name: DeliveryAddress1 type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/DeliveryAddress1 skipInDataAccess: false - label: Leftover name: Unmatched type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/Unmatched skipInDataAccess: false - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/Commenters skipInDataAccess: false - label: Automated Zone Indicator name: AutoZoneIndicator type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/AutoZoneIndicator skipInDataAccess: false - label: Carrier Route name: CarrierRoute type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/CarrierRoute skipInDataAccess: false - label: CMRA Indicator name: CMRAIndicator type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/CMRAIndicator skipInDataAccess: false - label: Congressional District name: CongressionalDistrict type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/CongressionalDistrict skipInDataAccess: false - label: Default Flag name: DefaultFlag type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/DefaultFlag skipInDataAccess: false - label: Delivery Point Bar Code name: DeliveryPointBarCode type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/DeliveryPointBarCode skipInDataAccess: false - label: DPV Confirmed Indicator name: DPVConfirmedIndicator type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/DPVConfirmedIndicator skipInDataAccess: false - label: DPV Footnotes name: DPVFootnotes type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/DPVFootnotes skipInDataAccess: false - label: eLOT Code name: eLOTCode type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/eLOTCode skipInDataAccess: false - label: eLOT Number name: eLOTNumber type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/eLOTNumber skipInDataAccess: false - label: EWS Flag name: EWSFlag type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/EWSFlag skipInDataAccess: false - label: False Positive Indicator name: FalsePositiveIndicator type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/FalsePositiveIndicator skipInDataAccess: false - label: FIPS County Code name: FIPSCountyCode type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/FIPSCountyCode skipInDataAccess: false - label: Footnotes name: Footnotes type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/Footnotes skipInDataAccess: false - label: LACS Link Code name: LACSLinkCode type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/LACSLinkCode skipInDataAccess: false - label: LACS Link Indicator name: LACSLinkIndicator type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/LACSLinkIndicator skipInDataAccess: false - label: LACS Status name: LACSStatus type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/LACSStatus skipInDataAccess: false - label: No Stat Indicator name: NoStatIndicator type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/NoStatIndicator skipInDataAccess: false - label: PMB Number name: PMBNumber type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/PMBNumber skipInDataAccess: false - label: PMB Type name: PMBType type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Location/attributes/PMBType skipInDataAccess: false - label: Primary Address Line name: PrimaryAddressLine type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/PrimaryAddressLine skipInDataAccess: false - label: Record Type name: RecordType type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/RecordType skipInDataAccess: false - label: Return Code name: ReturnCode type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/ReturnCode skipInDataAccess: false - label: Residential Delivery name: ResidentialDelivery type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/ResidentialDelivery skipInDataAccess: false - label: Secondary Address Line name: SecondaryAddressLine type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/SecondaryAddressLine skipInDataAccess: false - label: SUITE Link Footnote name: SUITELinkFootnote type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/SUITELinkFootnote skipInDataAccess: false - label: Vacant Indicator name: VacantIndicator type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Location/attributes/VacantIndicator skipInDataAccess: false geoLocationAttributes: - latitude: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Latitude longitude: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Longitude dataLabelPattern: '{AddressLine1} {City} {StateProvince} {Zip.Zip5}' survivorshipGroups: - uri: >- configuration/entityTypes/Location/survivorshipGroups/default default: true mapping: - attribute: >- configuration/entityTypes/Location/attributes/AddressLine1 survivorshipStrategy: CleanserWinsStrategy - attribute: >- configuration/entityTypes/Location/attributes/AddressLine2 survivorshipStrategy: CleanserWinsStrategy - attribute: configuration/entityTypes/Location/attributes/City survivorshipStrategy: CleanserWinsStrategy - attribute: >- configuration/entityTypes/Location/attributes/StateProvince survivorshipStrategy: CleanserWinsStrategy - attribute: >- configuration/entityTypes/Location/attributes/Country survivorshipStrategy: CleanserWinsStrategy - attribute: configuration/entityTypes/Location/attributes/Zip survivorshipStrategy: CleanserWinsStrategy surrogateCrosswalks: - enforce: true source: configuration/sources/FB attributes: - >- configuration/entityTypes/Location/attributes/AddressLine1 - >- configuration/entityTypes/Location/attributes/AddressLine2 - configuration/entityTypes/Location/attributes/City - >- configuration/entityTypes/Location/attributes/StateProvince - >- configuration/entityTypes/Location/attributes/Country - configuration/entityTypes/Location/attributes/Street - >- configuration/entityTypes/Location/attributes/SubBuilding - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip5 - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip4 - enforce: true source: configuration/sources/LNKD attributes: - >- configuration/entityTypes/Location/attributes/AddressLine1 - >- configuration/entityTypes/Location/attributes/AddressLine2 - configuration/entityTypes/Location/attributes/City - >- configuration/entityTypes/Location/attributes/StateProvince - >- configuration/entityTypes/Location/attributes/Country - configuration/entityTypes/Location/attributes/Street - >- configuration/entityTypes/Location/attributes/SubBuilding - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip5 - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip4 abstract: false matchGroups: - uri: >- configuration/entityTypes/Location/matchGroups/AutoMatch label: Automatic on load Addresses match type: automatic useOvOnly: 'true' rule: exact: - >- configuration/entityTypes/Location/attributes/AddressLine1 - configuration/entityTypes/Location/attributes/City - >- configuration/entityTypes/Location/attributes/StateProvince - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip5 - >- configuration/entityTypes/Location/attributes/Country exactOrAllNull: - >- configuration/entityTypes/Location/attributes/AddressLine2 ignoreInToken: - >- configuration/entityTypes/Location/attributes/AddressLine2 scoreStandalone: 0 scoreIncremental: 0 - uri: configuration/entityTypes/HCP label: HCP description: Health care provider typeColor: '#99CCFF' extendsTypeURI: configuration/entityTypes/Individual attributes: - label: Gender name: Gender description: '' type: String hidden: false important: false system: false required: false faceted: true searchable: true values: - Male - Female - Unknown attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Gender lookupCode: GENDER_CD skipInDataAccess: false - label: Prof Designation name: ProfDesignation description: String type: String hidden: false important: false system: false required: false faceted: true searchable: true attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/ProfDesignation lookupCode: PROF_DESG skipInDataAccess: false - label: Specialty name: Specialities type: Nested hidden: true important: false system: false required: false faceted: false searchable: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Specialities dataLabelPattern: '{SpecialtyType} - {Specialty}' matchFieldURIs: - >- configuration/entityTypes/Party/attributes/Specialities/attributes/SpecialtyType - >- configuration/entityTypes/Party/attributes/Specialities/attributes/Specialty attributes: - label: Specialty Type name: SpecialtyType description: '' type: String hidden: false important: false system: false required: false faceted: false searchable: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Specialities/attributes/SpecialtyType lookupCode: SPEC_TYPE skipInDataAccess: false - label: Specialty name: Specialty description: '' type: String hidden: false important: false system: false required: false faceted: false searchable: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Specialities/attributes/Specialty lookupCode: SPEC skipInDataAccess: false - label: Specialty Detail name: SpecialtyDetail description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Specialities/attributes/SpecialtyDetail skipInDataAccess: false skipInDataAccess: false - label: Prof Type name: ProfType description: '' type: String hidden: false important: false system: false required: false faceted: true searchable: true attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/ProfType lookupCode: PROF_TYPE skipInDataAccess: false - label: Employment name: Employment type: Reference hidden: false important: false system: false required: false faceted: false searchable: false relationshipLabelPattern: '{Title}' attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Employment referencedAttributeURIs: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/relationTypes/Employment/attributes/Title - >- configuration/relationTypes/Employment/attributes/Summary - >- configuration/relationTypes/Employment/attributes/IsCurrent referencedEntityTypeURI: configuration/entityTypes/Organization relationshipTypeURI: configuration/relationTypes/Employment skipInDataAccess: false - label: ME name: ME description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: String hidden: true important: false system: false required: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/ME skipInDataAccess: false - label: Prefix name: Prefix description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Prefix skipInDataAccess: false - label: Former First Name name: FormerFirstName description: '' type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/FormerFirstName skipInDataAccess: false - label: Former Last Name name: FormerLastName description: '' type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/FormerLastName skipInDataAccess: false - label: Former Middle Name name: FormerMiddleName description: '' type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/FormerMiddleName skipInDataAccess: false - label: Former Suffix Name name: FormerSuffixName description: '' type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/FormerSuffixName skipInDataAccess: false - label: Full Name name: Name description: Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Name skipInDataAccess: false - label: Last Name name: LastName description: Last Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/LastName skipInDataAccess: false - label: First Name name: FirstName description: First Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/FirstName skipInDataAccess: false - label: Middle Name name: MiddleName description: Middle Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/MiddleName skipInDataAccess: false - label: Middle Initial name: MiddleInitial description: >- Middle Initial. This attribute is populated from Middle Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/MiddleInitial skipInDataAccess: false - label: Suffix Name name: SuffixName description: Generation Suffix type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/SuffixName skipInDataAccess: false - label: Preferred Name name: PreferredName description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/PreferredName skipInDataAccess: false - label: Nickname name: Nickname description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Nickname skipInDataAccess: false - label: Title name: Title description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Title skipInDataAccess: false - label: Tax ID name: TaxID description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/TaxID skipInDataAccess: false - label: SSN name: SSN description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/SSN skipInDataAccess: false - label: SSN Last 4 name: SSNLast4 description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/SSNLast4 skipInDataAccess: false - label: Date of Birth name: DoB description: Date of Birth type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/DoB skipInDataAccess: false - label: Year of Birth name: YoB description: Birth Year type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/YoB skipInDataAccess: false - label: Birth City name: BirthCity description: Birth City type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/BirthCity skipInDataAccess: false - label: Birth State name: BirthState description: Birth State type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/BirthState skipInDataAccess: false - label: Birth Country name: BirthCountry description: Birth Country type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/BirthCountry skipInDataAccess: false - label: Date of Death name: DoD description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/DoD skipInDataAccess: false - label: Year of Death name: YoD description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/YoD skipInDataAccess: false - label: Phone name: Phone type: Nested hidden: false important: false system: false attributeOrdering: fieldURI: >- configuration/entityTypes/HCP/attributes/Phone/attributes/Rank orderType: ASC orderingStrategy: FieldBased uri: configuration/entityTypes/HCP/attributes/Phone dataLabelPattern: '{Number} {Type}' attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false values: - Mobile - Home - Work - Fax - Main - Work Fax - Home Fax - Pager - Other attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/Type skipInDataAccess: false - label: Number name: Number description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/Number skipInDataAccess: false - label: Extension name: Extension description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/Extension skipInDataAccess: false - label: Rank name: Rank description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/Rank skipInDataAccess: false - label: Country Code name: CountryCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/CountryCode skipInDataAccess: false - label: Area Code name: AreaCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/AreaCode skipInDataAccess: false - label: Local Number name: LocalNumber description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/LocalNumber skipInDataAccess: false - label: Validation Status name: ValidationStatus description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/ValidationStatus skipInDataAccess: false - label: Line Type name: LineType description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/LineType skipInDataAccess: false - label: Format Mask name: FormatMask description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/FormatMask skipInDataAccess: false - label: Digit Count name: DigitCount description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/DigitCount skipInDataAccess: false - label: Geo Area name: GeoArea description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/GeoArea skipInDataAccess: false - label: Geo Country name: GeoCountry description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/GeoCountry skipInDataAccess: false - label: Active name: Active description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Phone/attributes/Active skipInDataAccess: false skipInDataAccess: false - label: Email name: Email type: Nested hidden: false important: false system: false attributeOrdering: fieldURI: >- configuration/entityTypes/HCP/attributes/Email/attributes/Rank orderType: ASC orderingStrategy: FieldBased uri: configuration/entityTypes/HCP/attributes/Email dataLabelPattern: '{Email} {Type}' attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false values: - Home - Work - Other attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Email/attributes/Type skipInDataAccess: false - label: Email name: Email description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Email/attributes/Email skipInDataAccess: false - label: Domain name: Domain description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Email/attributes/Domain skipInDataAccess: false - label: Domain Type name: DomainType description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Email/attributes/DomainType skipInDataAccess: false - label: Username name: Username description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Email/attributes/Username skipInDataAccess: false - label: Rank name: Rank description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Email/attributes/Rank skipInDataAccess: false - label: Validation Status name: ValidationStatus description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Email/attributes/ValidationStatus skipInDataAccess: false - label: Active name: Active description: '' type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Email/attributes/Active skipInDataAccess: false - label: Source CD name: SourceCD description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Email/attributes/SourceCD skipInDataAccess: false skipInDataAccess: false - label: Delete Entity name: DeleteEntity description: Property for GDPR removing type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/DeleteEntity skipInDataAccess: false - label: Privacy Prefs name: PrivacyPreferences type: Nested hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/PrivacyPreferences dataLabelPattern: 'Phone: {PhoneOptOut}' attributes: - label: Opt Out name: OptOut description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/PrivacyPreferences/attributes/OptOut skipInDataAccess: false - label: Opt Out Start Date name: OptOutStartDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/PrivacyPreferences/attributes/OptOutStartDate skipInDataAccess: false - label: Allowed To Contact name: AllowedToContact description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/PrivacyPreferences/attributes/AllowedToContact skipInDataAccess: false - label: Phone Opt Out name: PhoneOptOut description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/PrivacyPreferences/attributes/PhoneOptOut skipInDataAccess: false - label: Email Opt Out name: EmailOptOut description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/PrivacyPreferences/attributes/EmailOptOut skipInDataAccess: false - label: Fax Opt Out name: FaxOptOut description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/PrivacyPreferences/attributes/FaxOptOut skipInDataAccess: false - label: Text Message Opt Out name: TextMessageOptOut description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/PrivacyPreferences/attributes/TextMessageOptOut skipInDataAccess: false - label: Mail Opt Out name: MailOptOut description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/PrivacyPreferences/attributes/MailOptOut skipInDataAccess: false skipInDataAccess: false - label: Education name: Education type: Nested hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Education dataLabelPattern: '{SchoolName} {Degree}, {EducationEndYear}' attributes: - label: School Name name: SchoolName type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Education/attributes/SchoolName skipInDataAccess: false - label: Type name: Type type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Education/attributes/Type skipInDataAccess: false - label: Degree name: Degree type: String hidden: false important: false system: false faceted: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Education/attributes/Degree skipInDataAccess: false - label: Year of graduation name: YearOfGraduation description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: Int hidden: false important: false system: false faceted: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Education/attributes/YearOfGraduation skipInDataAccess: false - label: Graduated name: Graduated description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Education/attributes/Graduated skipInDataAccess: false - label: GPA name: GPA type: Number hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Education/attributes/GPA skipInDataAccess: false - label: Years In Program name: YearsInProgram description: >- Year in Grad Training Program, Year in training in current program type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Education/attributes/YearsInProgram skipInDataAccess: false - label: Start Year name: StartYear description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Education/attributes/StartYear skipInDataAccess: false - label: End Year name: EndYear description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Education/attributes/EndYear skipInDataAccess: false - label: Field of Study name: FieldofStudy description: Specialty Focus or Specialty Training type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Education/attributes/FieldofStudy skipInDataAccess: false - label: Eligibility name: Eligibility description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Education/attributes/Eligibility skipInDataAccess: false - label: Type name: EducationType description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Education/attributes/EducationType skipInDataAccess: false skipInDataAccess: false - label: Affiliated with name: affiliatedwith type: Reference hidden: true important: false system: false relationshipLabelPattern: '{Title}' attributeOrdering: fieldURI: >- configuration/relationTypes/affiliatedwith/attributes/Rank orderType: ASC orderingStrategy: FieldBased uri: >- configuration/entityTypes/HCP/attributes/affiliatedwith referencedAttributeURIs: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/relationTypes/affiliatedwith/attributes/Title - >- configuration/relationTypes/affiliatedwith/attributes/PrefOrActive - >- configuration/relationTypes/affiliatedwith/attributes/Rank referencedEntityTypeURI: configuration/entityTypes/Organization relationshipTypeURI: configuration/relationTypes/affiliatedwith skipInDataAccess: false - label: Address name: Address type: Reference hidden: false important: false system: false relationshipLabelPattern: '{AddressType}' attributeOrdering: fieldURI: >- configuration/relationTypes/HasAddress/attributes/AddressRank orderType: ASC orderingStrategy: FieldBased uri: configuration/entityTypes/HCP/attributes/Address referencedAttributeURIs: - >- configuration/relationTypes/HasAddress/attributes/AddressType - >- configuration/relationTypes/HasAddress/attributes/CareOf - >- configuration/relationTypes/HasAddress/attributes/Primary - >- configuration/relationTypes/HasAddress/attributes/AddressRank - >- configuration/entityTypes/Location/attributes/AddressLine1 - >- configuration/entityTypes/Location/attributes/AddressLine2 - configuration/entityTypes/Location/attributes/City - >- configuration/entityTypes/Location/attributes/Premise - configuration/entityTypes/Location/attributes/Street - >- configuration/entityTypes/Location/attributes/StateProvince - configuration/entityTypes/Location/attributes/Zip - >- configuration/entityTypes/Location/attributes/Country - >- configuration/entityTypes/Location/attributes/GeoLocation - >- configuration/entityTypes/Location/attributes/AddressInput - >- configuration/relationTypes/HasAddress/attributes/Phone - >- configuration/relationTypes/HasAddress/attributes/Active referencedEntityTypeURI: configuration/entityTypes/Location relationshipTypeURI: configuration/relationTypes/HasAddress skipInDataAccess: false - label: Status name: Status description: '' type: String hidden: false important: false system: false faceted: true values: - New - Active - Deceased - Moved - Retired attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Status skipInDataAccess: false - label: Presumed Dead name: PresumedDead description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/PresumedDead skipInDataAccess: false - label: Image Link name: ImageLinks type: Image URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/ImageLinks skipInDataAccess: false - label: Video Link name: VideoLinks type: URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/VideoLinks skipInDataAccess: false - label: Document Link name: DocumentLinks type: URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/DocumentLinks skipInDataAccess: false - label: Website URL name: WebsiteURL type: URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/WebsiteURL skipInDataAccess: false - label: Description name: Description description: '' type: Blob hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Description skipInDataAccess: false - label: Identifiers name: Identifiers type: Nested hidden: false important: false system: false attributeOrdering: fieldURI: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type orderType: ASC orderingStrategy: FieldBased uri: configuration/entityTypes/HCP/attributes/Identifiers dataLabelPattern: '{Type} {ID} {Status}' matchFieldURIs: - >- configuration/entityTypes/Party/attributes/Identifiers/attributes/Type - >- configuration/entityTypes/Party/attributes/Identifiers/attributes/ID attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type skipInDataAccess: false - label: ID name: ID description: '' type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID skipInDataAccess: false - label: Status name: Status description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Status skipInDataAccess: false - label: Activation Date name: ActivationDate type: Date hidden: false important: false system: false required: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ActivationDate skipInDataAccess: false - label: Deactivation Reason Code name: DeactivationReasonCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/DeactivationReasonCode skipInDataAccess: false - label: Deactivation Date name: DeactivationDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/DeactivationDate skipInDataAccess: false - label: Reactivation Date name: ReactivationDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ReactivationDate skipInDataAccess: false skipInDataAccess: false - label: Status Update Date name: StatusUpdateDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/StatusUpdateDate skipInDataAccess: false - label: StatusReasonCode name: StatusReasonCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/StatusReasonCode lookupCode: StatusReasonCode skipInDataAccess: false - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Commenters skipInDataAccess: false geoLocationAttributes: - latitude: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Latitude longitude: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Longitude dataLabelPattern: >- {Prefix} {FirstName} {MiddleName} {LastName}, {SuffixName} {Credentials} {AddressLine} secondaryLabelPattern: '{Address}' survivorshipGroups: - uri: >- configuration/entityTypes/HCP/survivorshipGroups/default default: true mapping: - attribute: >- configuration/entityTypes/HCP/attributes/Employment survivorshipStrategy: Aggregation - attribute: configuration/entityTypes/HCP/attributes/Address survivorshipStrategy: Aggregation - attribute: >- configuration/entityTypes/HCP/attributes/Identifiers survivorshipStrategy: Aggregation abstract: false imageAttributeURIs: - configuration/entityTypes/HCP/attributes/ImageLinks matchGroups: - uri: >- configuration/entityTypes/HCP/matchGroups/PersonByMEAuto label: HCP by ME and Fuzzy name type: automatic rule: matchTokenClass: com.reltio.match.token.ExactNumberMatchToken comparatorClasses: mapping: - attribute: >- configuration/entityTypes/HCP/attributes/FirstName class: >- com.reltio.match.comparator.DynamicDamerauLevenshteinDistance - attribute: >- configuration/entityTypes/HCP/attributes/LastName class: >- com.reltio.match.comparator.DynamicDamerauLevenshteinDistance and: exact: - configuration/entityTypes/HCP/attributes/ME fuzzy: - >- configuration/entityTypes/HCP/attributes/FirstName - >- configuration/entityTypes/HCP/attributes/LastName ignoreInToken: - >- configuration/entityTypes/HCP/attributes/FirstName - >- configuration/entityTypes/HCP/attributes/LastName matchServiceClass: >- com.reltio.businesslogic.match.providers.internal.InternalMatchService scoreStandalone: 0 scoreIncremental: 0 - uri: >- configuration/entityTypes/HCP/matchGroups/PersonByIMSID label: HCP by IMS ID (#0) type: automatic rule: matchTokenClass: com.reltio.match.token.ExactMatchToken and: exact: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID equals: - value: IMS ID values: - IMS ID uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type matchServiceClass: >- com.reltio.businesslogic.match.providers.internal.InternalMatchService scoreStandalone: 0 scoreIncremental: 0 - uri: >- configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1 label: HCP by Identifiers (by TM) type: suspect rule: and: exact: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID equals: - value: TM values: - TM uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type exactOrNull: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Status scoreStandalone: 0 scoreIncremental: 0 analyticsAttributes: - uri: configuration/entityTypes/HCP/analyticsAttributes/DQ label: Data Quality description: >- DQ Score helps in evaluating the quality of the data in the profile name: DQ type: Nested maxOccurs: 1 analyticsAttributes: - uri: >- configuration/entityTypes/HCP/analyticsAttributes/DQ/analyticsAttributes/score label: Data Quality Score description: '' name: score type: Int maxOccurs: 1 - uri: >- configuration/entityTypes/HCP/analyticsAttributes/DQ/analyticsAttributes/updatedDate label: Updated date description: '' name: updatedDate type: Timestamp maxOccurs: 1 - uri: configuration/entityTypes/HCP/analyticsAttributes/IQ label: Reltio Rank description: >- Reltio Rank highlights the importance and relevance of a profile name: IQ type: Nested maxOccurs: 1 analyticsAttributes: - uri: >- configuration/entityTypes/HCP/analyticsAttributes/IQ/analyticsAttributes/score label: Reltio Rank Score description: '' name: score type: Int maxOccurs: 1 - uri: >- configuration/entityTypes/HCP/analyticsAttributes/IQ/analyticsAttributes/updatedDate label: Updated date description: '' name: updatedDate type: Timestamp maxOccurs: 1 - uri: configuration/entityTypes/Individual label: Individual description: Entity type representing person entity typeColor: '#99CCFF' typeIcon: images/base_type/Individual.png typeImage: images/defaultImage/no-photo.png typeGraphIcon: images/graphIcon/person-icon.png entitySmartLogic: Individual extendsTypeURI: configuration/entityTypes/Party attributes: - label: Prefix name: Prefix description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Individual/attributes/Prefix skipInDataAccess: false - label: Former First Name name: FormerFirstName description: '' type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/FormerFirstName skipInDataAccess: false - label: Former Last Name name: FormerLastName description: '' type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/FormerLastName skipInDataAccess: false - label: Former Middle Name name: FormerMiddleName description: '' type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/FormerMiddleName skipInDataAccess: false - label: Former Suffix Name name: FormerSuffixName description: '' type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/FormerSuffixName skipInDataAccess: false - label: Full Name name: Name description: Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Individual/attributes/Name skipInDataAccess: false - label: Last Name name: LastName description: Last Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/LastName skipInDataAccess: false - label: First Name name: FirstName description: First Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/FirstName skipInDataAccess: false - label: Middle Name name: MiddleName description: Middle Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/MiddleName skipInDataAccess: false - label: Middle Initial name: MiddleInitial description: >- Middle Initial. This attribute is populated from Middle Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/MiddleInitial skipInDataAccess: false - label: Suffix Name name: SuffixName description: Generation Suffix type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/SuffixName skipInDataAccess: false - label: Preferred Name name: PreferredName description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/PreferredName skipInDataAccess: false - label: Nickname name: Nickname description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Nickname skipInDataAccess: false - label: Title name: Title description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Individual/attributes/Title skipInDataAccess: false - label: Gender name: Gender description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Individual/attributes/Gender skipInDataAccess: false - label: Tax ID name: TaxID description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Individual/attributes/TaxID skipInDataAccess: false - label: SSN name: SSN description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Individual/attributes/SSN skipInDataAccess: false - label: SSN Last 4 name: SSNLast4 description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/SSNLast4 skipInDataAccess: false - label: Date of Birth name: DoB description: Date of Birth type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Individual/attributes/DoB skipInDataAccess: false - label: Year of Birth name: YoB description: Birth Year type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Individual/attributes/YoB skipInDataAccess: false - label: Birth City name: BirthCity description: Birth City type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/BirthCity skipInDataAccess: false - label: Birth State name: BirthState description: Birth State type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/BirthState skipInDataAccess: false - label: Birth Country name: BirthCountry description: Birth Country type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/BirthCountry skipInDataAccess: false - label: Date of Death name: DoD description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Individual/attributes/DoD skipInDataAccess: false - label: Year of Death name: YoD description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Individual/attributes/YoD skipInDataAccess: false - label: Phone name: Phone type: Nested hidden: false important: false system: false attributeOrdering: fieldURI: >- configuration/entityTypes/Individual/attributes/Phone/attributes/Rank orderType: ASC orderingStrategy: FieldBased uri: configuration/entityTypes/Individual/attributes/Phone dataLabelPattern: '{Number} {Type}' attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false values: - Mobile - Home - Work - Fax - Main - Work Fax - Home Fax - Pager - Other attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/Type skipInDataAccess: false - label: Number name: Number description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/Number skipInDataAccess: false - label: Extension name: Extension description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/Extension skipInDataAccess: false - label: Rank name: Rank description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/Rank skipInDataAccess: false - label: Country Code name: CountryCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/CountryCode skipInDataAccess: false - label: Area Code name: AreaCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/AreaCode skipInDataAccess: false - label: Local Number name: LocalNumber description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/LocalNumber skipInDataAccess: false - label: Validation Status name: ValidationStatus description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/ValidationStatus skipInDataAccess: false - label: Line Type name: LineType description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/LineType skipInDataAccess: false - label: Format Mask name: FormatMask description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/FormatMask skipInDataAccess: false - label: Digit Count name: DigitCount description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/DigitCount skipInDataAccess: false - label: Geo Area name: GeoArea description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/GeoArea skipInDataAccess: false - label: Geo Country name: GeoCountry description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/GeoCountry skipInDataAccess: false - label: Active name: Active description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Phone/attributes/Active skipInDataAccess: false skipInDataAccess: false - label: Email name: Email type: Nested hidden: false important: false system: false attributeOrdering: fieldURI: >- configuration/entityTypes/Individual/attributes/Email/attributes/Rank orderType: ASC orderingStrategy: FieldBased uri: configuration/entityTypes/Individual/attributes/Email dataLabelPattern: '{Email} {Type}' attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false values: - Home - Work - Other attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Email/attributes/Type skipInDataAccess: false - label: Email name: Email description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Email/attributes/Email skipInDataAccess: false - label: Domain name: Domain description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Email/attributes/Domain skipInDataAccess: false - label: Domain Type name: DomainType description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Email/attributes/DomainType skipInDataAccess: false - label: Username name: Username description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Email/attributes/Username skipInDataAccess: false - label: Rank name: Rank description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Email/attributes/Rank skipInDataAccess: false - label: Validation Status name: ValidationStatus description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Email/attributes/ValidationStatus skipInDataAccess: false - label: Active name: Active description: '' type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Email/attributes/Active skipInDataAccess: false - label: Source CD name: SourceCD description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Email/attributes/SourceCD skipInDataAccess: false skipInDataAccess: false - label: Delete Entity name: DeleteEntity description: Property for GDPR removing type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/DeleteEntity skipInDataAccess: false - label: Privacy Prefs name: PrivacyPreferences type: Nested hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/PrivacyPreferences dataLabelPattern: 'Phone: {PhoneOptOut}' attributes: - label: Opt Out name: OptOut description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/PrivacyPreferences/attributes/OptOut skipInDataAccess: false - label: Opt Out Start Date name: OptOutStartDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/PrivacyPreferences/attributes/OptOutStartDate skipInDataAccess: false - label: Allowed To Contact name: AllowedToContact description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/PrivacyPreferences/attributes/AllowedToContact skipInDataAccess: false - label: Phone Opt Out name: PhoneOptOut description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/PrivacyPreferences/attributes/PhoneOptOut skipInDataAccess: false - label: Email Opt Out name: EmailOptOut description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/PrivacyPreferences/attributes/EmailOptOut skipInDataAccess: false - label: Fax Opt Out name: FaxOptOut description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/PrivacyPreferences/attributes/FaxOptOut skipInDataAccess: false - label: Text Message Opt Out name: TextMessageOptOut description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/PrivacyPreferences/attributes/TextMessageOptOut skipInDataAccess: false - label: Mail Opt Out name: MailOptOut description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/PrivacyPreferences/attributes/MailOptOut skipInDataAccess: false skipInDataAccess: false - label: Education name: Education type: Nested hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Education dataLabelPattern: '{SchoolName} {Degree}, {EducationEndYear}' attributes: - label: School Name name: SchoolName type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Education/attributes/SchoolName skipInDataAccess: false - label: Type name: Type type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Education/attributes/Type skipInDataAccess: false - label: Degree name: Degree type: String hidden: false important: false system: false faceted: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Education/attributes/Degree skipInDataAccess: false - label: Year of graduation name: YearOfGraduation description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: Int hidden: false important: false system: false faceted: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Education/attributes/YearOfGraduation skipInDataAccess: false - label: Graduated name: Graduated description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Education/attributes/Graduated skipInDataAccess: false - label: GPA name: GPA type: Number hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Education/attributes/GPA skipInDataAccess: false - label: Years In Program name: YearsInProgram description: >- Year in Grad Training Program, Year in training in current program type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Education/attributes/YearsInProgram skipInDataAccess: false - label: Start Year name: StartYear description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Education/attributes/StartYear skipInDataAccess: false - label: End Year name: EndYear description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Education/attributes/EndYear skipInDataAccess: false - label: Field of Study name: FieldofStudy description: Specialty Focus or Specialty Training type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Education/attributes/FieldofStudy skipInDataAccess: false - label: Eligibility name: Eligibility description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Education/attributes/Eligibility skipInDataAccess: false - label: Type name: EducationType description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Education/attributes/EducationType skipInDataAccess: false skipInDataAccess: false - label: Employment name: Employment type: Reference hidden: false important: false system: false relationshipLabelPattern: '{Title}' attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Employment referencedAttributeURIs: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/relationTypes/Employment/attributes/Title - >- configuration/relationTypes/Employment/attributes/Summary - >- configuration/relationTypes/Employment/attributes/IsCurrent referencedEntityTypeURI: configuration/entityTypes/Organization relationshipTypeURI: configuration/relationTypes/Employment skipInDataAccess: false - label: Affiliated with name: affiliatedwith type: Reference hidden: true important: false system: false relationshipLabelPattern: '{Title}' attributeOrdering: fieldURI: >- configuration/relationTypes/affiliatedwith/attributes/Rank orderType: ASC orderingStrategy: FieldBased uri: >- configuration/entityTypes/Individual/attributes/affiliatedwith referencedAttributeURIs: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/relationTypes/affiliatedwith/attributes/Title - >- configuration/relationTypes/affiliatedwith/attributes/PrefOrActive - >- configuration/relationTypes/affiliatedwith/attributes/Rank referencedEntityTypeURI: configuration/entityTypes/Organization relationshipTypeURI: configuration/relationTypes/affiliatedwith skipInDataAccess: false - label: Address name: Address type: Reference hidden: false important: false system: false relationshipLabelPattern: '{AddressType}' attributeOrdering: fieldURI: >- configuration/relationTypes/HasAddress/attributes/AddressRank orderType: ASC orderingStrategy: FieldBased uri: >- configuration/entityTypes/Individual/attributes/Address referencedAttributeURIs: - >- configuration/relationTypes/HasAddress/attributes/AddressType - >- configuration/relationTypes/HasAddress/attributes/CareOf - >- configuration/relationTypes/HasAddress/attributes/Primary - >- configuration/relationTypes/HasAddress/attributes/AddressRank - >- configuration/entityTypes/Location/attributes/AddressLine1 - >- configuration/entityTypes/Location/attributes/AddressLine2 - configuration/entityTypes/Location/attributes/City - >- configuration/entityTypes/Location/attributes/Premise - configuration/entityTypes/Location/attributes/Street - >- configuration/entityTypes/Location/attributes/StateProvince - configuration/entityTypes/Location/attributes/Zip - >- configuration/entityTypes/Location/attributes/Country - >- configuration/entityTypes/Location/attributes/GeoLocation - >- configuration/entityTypes/Location/attributes/AddressInput - >- configuration/relationTypes/HasAddress/attributes/Phone - >- configuration/relationTypes/HasAddress/attributes/Active referencedEntityTypeURI: configuration/entityTypes/Location relationshipTypeURI: configuration/relationTypes/HasAddress skipInDataAccess: false - label: Status name: Status description: '' type: String hidden: false important: false system: false faceted: true values: - New - Active - Deceased - Moved - Retired attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Individual/attributes/Status skipInDataAccess: false - label: Presumed Dead name: PresumedDead description: '' type: Boolean hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/PresumedDead skipInDataAccess: false - label: Image Link name: ImageLinks type: Image URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/ImageLinks skipInDataAccess: false - label: Video Link name: VideoLinks type: URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/VideoLinks skipInDataAccess: false - label: Document Link name: DocumentLinks type: URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/DocumentLinks skipInDataAccess: false - label: Website URL name: WebsiteURL type: URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/WebsiteURL skipInDataAccess: false - label: Description name: Description description: '' type: Blob hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Description skipInDataAccess: false - label: Identifiers name: Identifiers type: Nested hidden: false important: false system: false attributeOrdering: fieldURI: >- configuration/entityTypes/Individual/attributes/Identifiers/attributes/Type orderType: ASC orderingStrategy: FieldBased uri: >- configuration/entityTypes/Individual/attributes/Identifiers dataLabelPattern: '{Type} {ID} {Status}' matchFieldURIs: - >- configuration/entityTypes/Party/attributes/Identifiers/attributes/Type - >- configuration/entityTypes/Party/attributes/Identifiers/attributes/ID attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Identifiers/attributes/Type skipInDataAccess: false - label: ID name: ID description: '' type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Identifiers/attributes/ID skipInDataAccess: false - label: Status name: Status description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Identifiers/attributes/Status skipInDataAccess: false - label: Activation Date name: ActivationDate type: Date hidden: false important: false system: false required: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Identifiers/attributes/ActivationDate skipInDataAccess: false - label: Deactivation Reason Code name: DeactivationReasonCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Identifiers/attributes/DeactivationReasonCode skipInDataAccess: false - label: Deactivation Date name: DeactivationDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Identifiers/attributes/DeactivationDate skipInDataAccess: false - label: Reactivation Date name: ReactivationDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Identifiers/attributes/ReactivationDate skipInDataAccess: false skipInDataAccess: false - label: Status Update Date name: StatusUpdateDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/StatusUpdateDate skipInDataAccess: false - label: StatusReasonCode name: StatusReasonCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/StatusReasonCode lookupCode: StatusReasonCode skipInDataAccess: false - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Individual/attributes/Commenters skipInDataAccess: false geoLocationAttributes: - latitude: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Latitude longitude: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Longitude dataLabelPattern: '{Name}' secondaryLabelPattern: '{businessCardAttributes}' survivorshipGroups: - uri: >- configuration/entityTypes/Individual/survivorshipGroups/default default: true mapping: - attribute: >- configuration/entityTypes/Individual/attributes/Employment survivorshipStrategy: Aggregation - attribute: >- configuration/entityTypes/Individual/attributes/Address survivorshipStrategy: Aggregation - attribute: >- configuration/entityTypes/Individual/attributes/Identifiers survivorshipStrategy: Aggregation abstract: true imageAttributeURIs: - >- configuration/entityTypes/Individual/attributes/ImageLinks analyticsAttributes: - uri: >- configuration/entityTypes/Individual/analyticsAttributes/DQ label: Data Quality description: >- DQ Score helps in evaluating the quality of the data in the profile name: DQ type: Nested maxOccurs: 1 analyticsAttributes: - uri: >- configuration/entityTypes/Individual/analyticsAttributes/DQ/analyticsAttributes/score label: Data Quality Score description: '' name: score type: Int maxOccurs: 1 - uri: >- configuration/entityTypes/Individual/analyticsAttributes/DQ/analyticsAttributes/updatedDate label: Updated date description: '' name: updatedDate type: Timestamp maxOccurs: 1 - uri: >- configuration/entityTypes/Individual/analyticsAttributes/IQ label: Reltio Rank description: >- Reltio Rank highlights the importance and relevance of a profile name: IQ type: Nested maxOccurs: 1 analyticsAttributes: - uri: >- configuration/entityTypes/Individual/analyticsAttributes/IQ/analyticsAttributes/score label: Reltio Rank Score description: '' name: score type: Int maxOccurs: 1 - uri: >- configuration/entityTypes/Individual/analyticsAttributes/IQ/analyticsAttributes/updatedDate label: Updated date description: '' name: updatedDate type: Timestamp maxOccurs: 1 - uri: configuration/entityTypes/Party label: Party description: Organization entity type details attributes: - label: Name name: Name description: Name type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Party/attributes/Name skipInDataAccess: false - label: Image Link name: ImageLinks type: Image URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Party/attributes/ImageLinks skipInDataAccess: false - label: Video Link name: VideoLinks type: URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Party/attributes/VideoLinks skipInDataAccess: false - label: Document Link name: DocumentLinks type: URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/DocumentLinks skipInDataAccess: false - label: Phone name: Phone type: Nested hidden: false important: false system: false attributeOrdering: fieldURI: >- configuration/entityTypes/Party/attributes/Phone/attributes/Rank orderType: ASC orderingStrategy: FieldBased uri: configuration/entityTypes/Party/attributes/Phone dataLabelPattern: '{Number} {Type}' attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false values: - Mobile - Home - Work - Fax - Main - Work Fax - Home Fax - Pager - Other attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/Type skipInDataAccess: false - label: Number name: Number description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/Number skipInDataAccess: false - label: Extension name: Extension description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/Extension skipInDataAccess: false - label: Rank name: Rank description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/Rank skipInDataAccess: false - label: Country Code name: CountryCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/CountryCode skipInDataAccess: false - label: Area Code name: AreaCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/AreaCode skipInDataAccess: false - label: Local Number name: LocalNumber description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/LocalNumber skipInDataAccess: false - label: Validation Status name: ValidationStatus description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/ValidationStatus skipInDataAccess: false - label: Line Type name: LineType description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/LineType skipInDataAccess: false - label: Format Mask name: FormatMask description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/FormatMask skipInDataAccess: false - label: Digit Count name: DigitCount description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/DigitCount skipInDataAccess: false - label: Geo Area name: GeoArea description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/GeoArea skipInDataAccess: false - label: Geo Country name: GeoCountry description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/GeoCountry skipInDataAccess: false - label: Active name: Active description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Phone/attributes/Active skipInDataAccess: false skipInDataAccess: false - label: Website URL name: WebsiteURL type: URL hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Party/attributes/WebsiteURL skipInDataAccess: false - label: Identifiers name: Identifiers type: Nested hidden: false important: false system: false attributeOrdering: fieldURI: >- configuration/entityTypes/Party/attributes/Identifiers/attributes/Type orderType: ASC orderingStrategy: FieldBased uri: configuration/entityTypes/Party/attributes/Identifiers dataLabelPattern: '{Type} {ID} {Status}' matchFieldURIs: - >- configuration/entityTypes/Party/attributes/Identifiers/attributes/Type - >- configuration/entityTypes/Party/attributes/Identifiers/attributes/ID attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Identifiers/attributes/Type skipInDataAccess: false - label: ID name: ID description: '' type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Identifiers/attributes/ID skipInDataAccess: false - label: Status name: Status description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Identifiers/attributes/Status skipInDataAccess: false - label: Activation Date name: ActivationDate type: Date hidden: false important: false system: false required: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Identifiers/attributes/ActivationDate skipInDataAccess: false - label: Deactivation Reason Code name: DeactivationReasonCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Identifiers/attributes/DeactivationReasonCode skipInDataAccess: false - label: Deactivation Date name: DeactivationDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Identifiers/attributes/DeactivationDate skipInDataAccess: false - label: Reactivation Date name: ReactivationDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Identifiers/attributes/ReactivationDate skipInDataAccess: false skipInDataAccess: false - label: Email name: Email type: Nested hidden: false important: false system: false attributeOrdering: fieldURI: >- configuration/entityTypes/Party/attributes/Email/attributes/Rank orderType: ASC orderingStrategy: FieldBased uri: configuration/entityTypes/Party/attributes/Email dataLabelPattern: '{Email} {Type}' attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false values: - Home - Work - Other attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Email/attributes/Type skipInDataAccess: false - label: Email name: Email description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Email/attributes/Email skipInDataAccess: false - label: Domain name: Domain description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Email/attributes/Domain skipInDataAccess: false - label: Domain Type name: DomainType description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Email/attributes/DomainType skipInDataAccess: false - label: Username name: Username description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Email/attributes/Username skipInDataAccess: false - label: Rank name: Rank description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Email/attributes/Rank skipInDataAccess: false - label: Validation Status name: ValidationStatus description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Email/attributes/ValidationStatus skipInDataAccess: false - label: Active name: Active description: '' type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Email/attributes/Active skipInDataAccess: false - label: Source CD name: SourceCD description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/Email/attributes/SourceCD skipInDataAccess: false skipInDataAccess: false - label: Address name: Address type: Reference hidden: false important: false system: false relationshipLabelPattern: '{AddressType}' attributeOrdering: fieldURI: >- configuration/relationTypes/HasAddress/attributes/AddressRank orderType: ASC orderingStrategy: FieldBased uri: configuration/entityTypes/Party/attributes/Address referencedAttributeURIs: - >- configuration/relationTypes/HasAddress/attributes/AddressType - >- configuration/relationTypes/HasAddress/attributes/CareOf - >- configuration/relationTypes/HasAddress/attributes/Primary - >- configuration/relationTypes/HasAddress/attributes/AddressRank - >- configuration/entityTypes/Location/attributes/AddressLine1 - >- configuration/entityTypes/Location/attributes/AddressLine2 - configuration/entityTypes/Location/attributes/City - >- configuration/entityTypes/Location/attributes/Premise - configuration/entityTypes/Location/attributes/Street - >- configuration/entityTypes/Location/attributes/StateProvince - configuration/entityTypes/Location/attributes/Zip - >- configuration/entityTypes/Location/attributes/Country - >- configuration/entityTypes/Location/attributes/GeoLocation - >- configuration/entityTypes/Location/attributes/AddressInput - >- configuration/relationTypes/HasAddress/attributes/Phone - >- configuration/relationTypes/HasAddress/attributes/Active referencedEntityTypeURI: configuration/entityTypes/Location relationshipTypeURI: configuration/relationTypes/HasAddress skipInDataAccess: false - label: Tax ID name: TaxID description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Party/attributes/TaxID skipInDataAccess: false - label: Description name: Description description: '' type: Blob hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Party/attributes/Description skipInDataAccess: false - label: Status name: Status description: '' type: String hidden: false important: false system: false faceted: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Party/attributes/Status skipInDataAccess: false - label: Status Update Date name: StatusUpdateDate description: '' type: Date hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/StatusUpdateDate skipInDataAccess: false - label: StatusReasonCode name: StatusReasonCode description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/Party/attributes/StatusReasonCode lookupCode: StatusReasonCode skipInDataAccess: false - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/Party/attributes/Commenters skipInDataAccess: false geoLocationAttributes: - latitude: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Latitude longitude: >- configuration/entityTypes/Location/attributes/GeoLocation/attributes/Longitude dataLabelPattern: '{Name}' secondaryLabelPattern: '{businessCardAttributes}' survivorshipGroups: - uri: >- configuration/entityTypes/Party/survivorshipGroups/default default: true mapping: - attribute: configuration/entityTypes/Party/attributes/Address survivorshipStrategy: Aggregation - attribute: >- configuration/entityTypes/Party/attributes/Identifiers survivorshipStrategy: Aggregation abstract: true businessCardAttributeURIs: - configuration/entityTypes/Party/attributes/Address imageAttributeURIs: - configuration/entityTypes/Party/attributes/ImageLinks analyticsAttributes: - uri: configuration/entityTypes/Party/analyticsAttributes/DQ label: Data Quality description: >- DQ Score helps in evaluating the quality of the data in the profile name: DQ type: Nested maxOccurs: 1 analyticsAttributes: - uri: >- configuration/entityTypes/Party/analyticsAttributes/DQ/analyticsAttributes/score label: Data Quality Score description: '' name: score type: Int maxOccurs: 1 faceted: true searchable: true - uri: >- configuration/entityTypes/Party/analyticsAttributes/DQ/analyticsAttributes/updatedDate label: Updated date description: '' name: updatedDate type: Timestamp maxOccurs: 1 - uri: configuration/entityTypes/Party/analyticsAttributes/IQ label: Reltio Rank description: >- Reltio Rank highlights the importance and relevance of a profile name: IQ type: Nested maxOccurs: 1 analyticsAttributes: - uri: >- configuration/entityTypes/Party/analyticsAttributes/IQ/analyticsAttributes/score label: Reltio Rank Score description: '' name: score type: Int maxOccurs: 1 faceted: true searchable: true - uri: >- configuration/entityTypes/Party/analyticsAttributes/IQ/analyticsAttributes/updatedDate label: Updated date description: '' name: updatedDate type: Timestamp maxOccurs: 1 roles: - uri: configuration/roles/Vendor label: Vendor description: '' - uri: configuration/roles/Prospect label: Prospect description: >- Individuals and Organizations can be Clients. Prospects are potential clients, who can be converted to customers of a product. - uri: configuration/roles/Supplier label: Supplier description: '' - uri: configuration/roles/Customer label: Customer description: '' - uri: configuration/roles/Partner label: Partner description: '' - uri: configuration/roles/Employee label: Employee description: Employee of an organization that is using Reltio - uri: configuration/roles/Client label: Client description: >- Individuals and Organizations can be Clients. Clients are customers who have purchased products. groupTypes: - uri: configuration/groupTypes/Test label: Path Household description: Households loaded from PATH dataTooltipPattern: '[primaryMember]({LastName}) Household' hasPrimaryMember: true multiplePrimaryMembers: false limitMemberToOneGroupInstance: true type: manual attributes: - label: Type name: Type type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/groupTypes/Test/attributes/Type skipInDataAccess: false dataLabelPattern: '[primaryMember]({LastName}) Household' groupElements: - uri: >- configuration/groupTypes/PathHHGroupType/groupElements/1 entityTypeURIs: - configuration/entityTypes/Individual memberTypes: - uri: >- configuration/groupTypes/PathHHGroupType/memberTypes/Member label: Member primaryMember: false - uri: >- configuration/groupTypes/PathHHGroupType/memberTypes/PrimaryMember label: Primary Member primaryMember: true relationTypes: - uri: configuration/relationTypes/Contractor label: Contractor description: '' typeColor: '#663344' startObject: uri: configuration/relationTypes/Contractor/startObject directionalContext: - uri: >- configuration/relationTypes/Contractor/startObject/directionalContext labelPattern: contractor objectTypeURI: configuration/entityTypes/Party endObject: uri: configuration/relationTypes/Contractor/endObject directionalContext: - uri: >- configuration/relationTypes/Contractor/endObject/directionalContext labelPattern: customer objectTypeURI: configuration/entityTypes/Party implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Contractor/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/HasAddress label: has address description: >- Types of relationships between Parties (Individuals and Organizations) and Location typeColor: '#663344' startObject: uri: configuration/relationTypes/HasAddress/startObject directionalContext: - uri: >- configuration/relationTypes/HasAddress/startObject/directionalContext labelPattern: has address objectTypeURI: configuration/entityTypes/Party endObject: uri: configuration/relationTypes/HasAddress/endObject directionalContext: - uri: >- configuration/relationTypes/HasAddress/endObject/directionalContext labelPattern: locates objectTypeURI: configuration/entityTypes/Location implicit: true attributes: - label: Status name: Status type: String hidden: true important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Status skipInDataAccess: false - label: Address Type name: AddressType type: String hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/AddressType skipInDataAccess: false - label: Primary name: Primary type: Boolean hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Primary skipInDataAccess: false - label: AddressRank name: AddressRank type: Int hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/AddressRank skipInDataAccess: false - label: Care Of name: CareOf type: String hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/CareOf skipInDataAccess: false - label: Active name: Active type: Boolean hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Active skipInDataAccess: false - label: Phone name: Phone type: Nested hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone dataLabelPattern: '{Number} {Type}' attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false values: - Mobile - Home - Work - Fax - Main - Work Fax - Home Fax - Pager - Other attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Type skipInDataAccess: false - label: Number name: Number description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Number skipInDataAccess: false - label: Extension name: Extension description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Extension skipInDataAccess: false - label: Rank name: Rank description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Rank skipInDataAccess: false - label: Active name: Active description: '' type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Active skipInDataAccess: false skipInDataAccess: false - label: Source CD name: SourceCD description: '' type: String hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/SourceCD skipInDataAccess: false - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Commenters skipInDataAccess: false survivorshipGroups: - uri: >- configuration/relationTypes/HasAddress/survivorshipGroups/default default: true mapping: - attribute: >- configuration/relationTypes/HasAddress/attributes/AddressType survivorshipStrategy: Aggregation direction: directed - uri: configuration/relationTypes/Friend label: Friend description: >- Types of relationships between Individual and Individual - representing Friend relationship type typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Friend/startObject objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/Friend/endObject objectTypeURI: configuration/entityTypes/Individual implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Friend/attributes/Commenters skipInDataAccess: false direction: bidirectional - uri: configuration/relationTypes/Advisor label: Advisor description: '' typeColor: '#663344' startObject: uri: configuration/relationTypes/Advisor/startObject directionalContext: - uri: >- configuration/relationTypes/Advisor/startObject/directionalContext labelPattern: client objectTypeURI: configuration/entityTypes/Party endObject: uri: configuration/relationTypes/Advisor/endObject directionalContext: - uri: >- configuration/relationTypes/Advisor/endObject/directionalContext labelPattern: advisor objectTypeURI: configuration/entityTypes/Party implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Advisor/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Relative label: Relative typeColor: '#777777' startObject: uri: configuration/relationTypes/Family/startObject objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/Family/endObject objectTypeURI: configuration/entityTypes/Individual implicit: false extendsTypeURI: configuration/relationTypes/Family attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Relative/attributes/Commenters skipInDataAccess: false direction: bidirectional - uri: configuration/relationTypes/Assistant label: Assistant description: '' typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Assistant/startObject directionalContext: - uri: >- configuration/relationTypes/Assistant/startObject/directionalContext labelPattern: assistant objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/Assistant/endObject directionalContext: - uri: >- configuration/relationTypes/Assistant/endObject/directionalContext labelPattern: has assistant objectTypeURI: configuration/entityTypes/Individual implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Assistant/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Business label: Business description: '' typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Business/startObject objectTypeURI: configuration/entityTypes/Party endObject: uri: configuration/relationTypes/Business/endObject objectTypeURI: configuration/entityTypes/Party implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Business/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Manager label: Manager description: '' typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Manager/startObject directionalContext: - uri: >- configuration/relationTypes/Manager/startObject/directionalContext labelPattern: manager objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/Manager/endObject directionalContext: - uri: >- configuration/relationTypes/Manager/endObject/directionalContext labelPattern: reportee objectTypeURI: configuration/entityTypes/Individual implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Manager/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Accountant label: Accountant description: '' typeColor: '#663344' startObject: uri: configuration/relationTypes/Accountant/startObject directionalContext: - uri: >- configuration/relationTypes/Accountant/startObject/directionalContext labelPattern: client objectTypeURI: configuration/entityTypes/Party endObject: uri: configuration/relationTypes/Accountant/endObject directionalContext: - uri: >- configuration/relationTypes/Accountant/endObject/directionalContext labelPattern: accountant objectTypeURI: configuration/entityTypes/Party implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Accountant/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Contact label: Contact description: '' typeColor: '#663344' startObject: uri: configuration/relationTypes/Contact/startObject directionalContext: - uri: >- configuration/relationTypes/Contact/startObject/directionalContext labelPattern: firm objectTypeURI: configuration/entityTypes/Organization endObject: uri: configuration/relationTypes/Contact/endObject directionalContext: - uri: >- configuration/relationTypes/Contact/endObject/directionalContext labelPattern: contact objectTypeURI: configuration/entityTypes/Individual implicit: false attributes: - label: Desc name: Desc description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/relationTypes/Contact/attributes/Desc skipInDataAccess: false - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Contact/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/affiliatedwith label: Affiliated with description: >- Types of relationships between Individual and Organization - representing Individual employment for some Organization typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/affiliatedwith/startObject directionalContext: - uri: >- configuration/relationTypes/affiliatedwith/startObject/directionalContext labelPattern: affiliated with objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/affiliatedwith/endObject directionalContext: - uri: >- configuration/relationTypes/affiliatedwith/endObject/directionalContext labelPattern: affiliated with objectTypeURI: configuration/entityTypes/Organization implicit: false attributes: - label: Title name: Title type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/affiliatedwith/attributes/Title skipInDataAccess: false - label: PrefOrActive name: PrefOrActive type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/affiliatedwith/attributes/PrefOrActive skipInDataAccess: false - label: Rank name: Rank type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/affiliatedwith/attributes/Rank skipInDataAccess: false - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/affiliatedwith/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/ReferredBy label: ReferredBy description: '' typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/ReferredBy/startObject directionalContext: - uri: >- configuration/relationTypes/ReferredBy/startObject/directionalContext labelPattern: referred by objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/ReferredBy/endObject directionalContext: - uri: >- configuration/relationTypes/ReferredBy/endObject/directionalContext labelPattern: refers objectTypeURI: configuration/entityTypes/Individual implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/ReferredBy/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Partner label: Partner description: '' typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Partner/startObject objectTypeURI: configuration/entityTypes/Organization endObject: uri: configuration/relationTypes/Partner/endObject objectTypeURI: configuration/entityTypes/Organization implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Partner/attributes/Commenters skipInDataAccess: false direction: bidirectional - uri: configuration/relationTypes/Parent label: Parent description: >- Types of relationships between Individual and Individual - representing Parent relationship type typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Parent/startObject directionalContext: - uri: >- configuration/relationTypes/Parent/startObject/directionalContext rule: - attribute: Gender type: condition condition: '=' value: Female labelPattern: mother - uri: >- configuration/relationTypes/Parent/startObject/directionalContext rule: - attribute: Gender type: condition condition: '=' value: Male labelPattern: father - uri: >- configuration/relationTypes/Parent/startObject/directionalContext labelPattern: parent objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/Parent/endObject directionalContext: - uri: >- configuration/relationTypes/Parent/endObject/directionalContext rule: - attribute: Gender type: condition condition: '=' value: Female labelPattern: daughter - uri: >- configuration/relationTypes/Parent/endObject/directionalContext rule: - attribute: Gender type: condition condition: '=' value: Male labelPattern: son - uri: >- configuration/relationTypes/Parent/endObject/directionalContext labelPattern: child objectTypeURI: configuration/entityTypes/Individual implicit: false extendsTypeURI: configuration/relationTypes/Family attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Parent/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Leased label: Leased description: >- Types of relationships between Organization and Organization - representing Subsidiary of relationship type typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Leased/startObject directionalContext: - uri: >- configuration/relationTypes/Leased/startObject/directionalContext labelPattern: lessor objectTypeURI: configuration/entityTypes/Organization endObject: uri: configuration/relationTypes/Leased/endObject directionalContext: - uri: >- configuration/relationTypes/Leased/endObject/directionalContext labelPattern: lessee objectTypeURI: configuration/entityTypes/Organization implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Leased/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Employment label: Employment description: >- Types of relationships between Individuals and Organizations - representing Individual employment for some Organization typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Employment/startObject directionalContext: - uri: >- configuration/relationTypes/Employment/startObject/directionalContext labelPattern: employee objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/Employment/endObject directionalContext: - uri: >- configuration/relationTypes/Employment/endObject/directionalContext labelPattern: employer objectTypeURI: configuration/entityTypes/Organization implicit: false attributes: - label: Title name: Title type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Employment/attributes/Title skipInDataAccess: false - label: Summary name: Summary type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Employment/attributes/Summary skipInDataAccess: false - label: Is Current name: IsCurrent type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Employment/attributes/IsCurrent skipInDataAccess: false - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Employment/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Spouse label: Spouse description: >- Types of relationships between Individual and Individual - representing Spouse relationship type typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Spouse/startObject directionalContext: - uri: >- configuration/relationTypes/Spouse/startObject/directionalContext rule: - attribute: Gender type: condition condition: '=' value: Female labelPattern: wife - uri: >- configuration/relationTypes/Spouse/startObject/directionalContext rule: - attribute: Gender type: condition condition: '=' value: Male labelPattern: husband objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/Spouse/endObject directionalContext: - uri: >- configuration/relationTypes/Spouse/endObject/directionalContext rule: - attribute: Gender type: condition condition: '=' value: Female labelPattern: wife - uri: >- configuration/relationTypes/Spouse/endObject/directionalContext rule: - attribute: Gender type: condition condition: '=' value: Male labelPattern: husband objectTypeURI: configuration/entityTypes/Individual implicit: false extendsTypeURI: configuration/relationTypes/Family attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Spouse/attributes/Commenters skipInDataAccess: false direction: bidirectional - uri: configuration/relationTypes/Sibling label: Sibling description: >- Types of relationships between Individual and Individual - representing Sibling relationship type typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Sibling/startObject directionalContext: - uri: >- configuration/relationTypes/Sibling/startObject/directionalContext rule: - attribute: Gender type: condition condition: '=' value: Female labelPattern: sister - uri: >- configuration/relationTypes/Sibling/startObject/directionalContext rule: - attribute: Gender type: condition condition: '=' value: Male labelPattern: brother objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/Sibling/endObject directionalContext: - uri: >- configuration/relationTypes/Sibling/endObject/directionalContext rule: - attribute: Gender type: condition condition: '=' value: Female labelPattern: sister - uri: >- configuration/relationTypes/Sibling/endObject/directionalContext rule: - attribute: Gender type: condition condition: '=' value: Male labelPattern: brother objectTypeURI: configuration/entityTypes/Individual implicit: false extendsTypeURI: configuration/relationTypes/Family attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Sibling/attributes/Commenters skipInDataAccess: false direction: bidirectional - uri: configuration/relationTypes/DomesticPartner label: domestic partner description: '' typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/DomesticPartner/startObject objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/DomesticPartner/endObject objectTypeURI: configuration/entityTypes/Individual implicit: false extendsTypeURI: configuration/relationTypes/Family attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/DomesticPartner/attributes/Commenters skipInDataAccess: false direction: bidirectional - uri: configuration/relationTypes/Attorney label: Attorney description: '' typeColor: '#663344' startObject: uri: configuration/relationTypes/Attorney/startObject directionalContext: - uri: >- configuration/relationTypes/Attorney/startObject/directionalContext labelPattern: client objectTypeURI: configuration/entityTypes/Party endObject: uri: configuration/relationTypes/Attorney/endObject directionalContext: - uri: >- configuration/relationTypes/Attorney/endObject/directionalContext labelPattern: attorney objectTypeURI: configuration/entityTypes/Party implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Attorney/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Family label: Family description: Relationship between Families typeColor: '#777777' startObject: uri: configuration/relationTypes/Family/startObject objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/Family/endObject objectTypeURI: configuration/entityTypes/Individual implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Family/attributes/Commenters skipInDataAccess: false direction: bidirectional - uri: configuration/relationTypes/Subsidiary label: Subsidiary of description: >- Types of relationships between Organization and Organization - representing Subsidiary of relationship type typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Subsidiary/startObject directionalContext: - uri: >- configuration/relationTypes/Subsidiary/startObject/directionalContext labelPattern: parent objectTypeURI: configuration/entityTypes/Organization endObject: uri: configuration/relationTypes/Subsidiary/endObject directionalContext: - uri: >- configuration/relationTypes/Subsidiary/endObject/directionalContext labelPattern: subsidiary objectTypeURI: configuration/entityTypes/Organization implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Subsidiary/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Owned label: Owned description: >- Types of relationships between Organization and Organization - representing Subsidiary of relationship type typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Owned/startObject directionalContext: - uri: >- configuration/relationTypes/Owned/startObject/directionalContext labelPattern: owner objectTypeURI: configuration/entityTypes/Organization endObject: uri: configuration/relationTypes/Owned/endObject directionalContext: - uri: >- configuration/relationTypes/Owned/endObject/directionalContext labelPattern: owned objectTypeURI: configuration/entityTypes/Organization implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Owned/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Officer label: Officer description: '' typeColor: '#663344' startObject: uri: configuration/relationTypes/Officer/startObject directionalContext: - uri: >- configuration/relationTypes/Officer/startObject/directionalContext labelPattern: officer objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/Officer/endObject directionalContext: - uri: >- configuration/relationTypes/Officer/endObject/directionalContext labelPattern: has officer objectTypeURI: configuration/entityTypes/Organization implicit: false extendsTypeURI: configuration/relationTypes/Employment attributes: - label: Title name: Title type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/relationTypes/Officer/attributes/Title skipInDataAccess: false - label: Summary name: Summary type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/relationTypes/Officer/attributes/Summary skipInDataAccess: false - label: Is Current name: IsCurrent type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Officer/attributes/IsCurrent skipInDataAccess: false - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Officer/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Boardmember label: Boardmember description: '' typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Boardmember/startObject directionalContext: - uri: >- configuration/relationTypes/Boardmember/startObject/directionalContext labelPattern: firm objectTypeURI: configuration/entityTypes/Organization endObject: uri: configuration/relationTypes/Boardmember/endObject directionalContext: - uri: >- configuration/relationTypes/Boardmember/endObject/directionalContext labelPattern: boardmember objectTypeURI: configuration/entityTypes/Individual implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Boardmember/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Managed label: Managed description: >- Types of relationships between Organization and Organization - representing Subsidiary of relationship type typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Managed/startObject directionalContext: - uri: >- configuration/relationTypes/Managed/startObject/directionalContext labelPattern: manager objectTypeURI: configuration/entityTypes/Organization endObject: uri: configuration/relationTypes/Managed/endObject directionalContext: - uri: >- configuration/relationTypes/Managed/endObject/directionalContext labelPattern: managed objectTypeURI: configuration/entityTypes/Organization implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Managed/attributes/Commenters skipInDataAccess: false direction: directed - uri: configuration/relationTypes/Influencer label: Influencer description: '' typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Influencer/startObject directionalContext: - uri: >- configuration/relationTypes/Influencer/startObject/directionalContext labelPattern: influenced objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/Influencer/endObject directionalContext: - uri: >- configuration/relationTypes/Influencer/endObject/directionalContext labelPattern: influencer objectTypeURI: configuration/entityTypes/Individual implicit: false attributes: - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Influencer/attributes/Commenters skipInDataAccess: false direction: directed graphTypes: - uri: configuration/graphTypes/FamilyGraph label: Family Graph limitMemberToOneGraphInstance: false type: logical layout: family allowCycles: true relationshipTypeURIs: - configuration/relationTypes/Family graphStructure: network - uri: configuration/graphTypes/CompanyHierarchy label: Company Hierarchy limitMemberToOneGraphInstance: false type: logical layout: hierarchy allowCycles: false relationshipTypeURIs: - configuration/relationTypes/Subsidiary - configuration/relationTypes/Leased - configuration/relationTypes/Managed - configuration/relationTypes/Owned graphStructure: hierarchy survivorshipStrategies: - uri: configuration/survivorshipStrategies/CleanserWinsStrategy label: Reltio Cleanser or Nothing winnerSourceType: configuration/sources/ReltioCleanser winnerSourceAttributes: - >- configuration/entityTypes/Location/attributes/AddressLine1 - uri: configuration/survivorshipStrategies/LUD label: Recency - uri: configuration/survivorshipStrategies/Frequency label: Frequency - uri: configuration/survivorshipStrategies/Aggregation label: Aggregation - uri: configuration/survivorshipStrategies/SRC_SYS label: Source system - uri: configuration/survivorshipStrategies/OldestValue label: Oldest value - uri: configuration/survivorshipStrategies/MinValue label: Minimum value - uri: configuration/survivorshipStrategies/MaxValue label: Maximum value - uri: >- configuration/survivorshipStrategies/OtherAttributeWinnerCrosswalk label: Other Attribute Winner Crosswalk '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.configuration.spring.ConfigurationController x-path: >- /private/swagger.htm?module=Configuration#/Data%20Model/getConfigurationByTenant put: tags: - Data Model summary: Sets the configuration for a tenant description: >- This API sets the configuration for a tenant. If a configuration was already defined for the tenant, then that configuration is overridden with this operation.
If the configuration is persisted successfully, then the response contains JSON of the saved configuration for the tenant operationId: setConfigurationForTenant parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string - name: checkParallelUpdate in: query schema: type: boolean default: false requestBody: description: Configuration to be applied content: application/json: schema: $ref: '#/components/schemas/ReltioBusinessModel' examples: sample: description: Sample request for API value: uri: configuration description: Example of Reltio Metadata Configuration label: Business Model schemaVersion: 2.2.5 sources: - uri: configuration/sources/LNKD label: Linkedin icon: images/source/linkedin.png abbreviation: LNKD - uri: configuration/sources/Reltio label: Reltio icon: images/source/reltio.png abbreviation: Reltio - uri: configuration/sources/ReltioCleanser label: Reltio Data Cleanser icon: images/source/reltio.png priority: 100500 abbreviation: ReltioCleanser - uri: configuration/sources/FB label: Facebook icon: images/source/facebook.png abbreviation: FB - uri: configuration/sources/TWITTER label: Twitter icon: images/source/twitter.png abbreviation: TWITTER abstract: false referenceConfigurationURI: configuration/_vertical/reltio-core-2020-1 entityTypes: - uri: configuration/entityTypes/Organization typeColor: '#80D557' abstract: false surrogateCrosswalks: - enforce: true source: configuration/sources/FB attributes: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/entityTypes/Organization/attributes/CompanyType - >- configuration/entityTypes/Organization/attributes/FoundedYear - >- configuration/entityTypes/Organization/attributes/Status - enforce: true source: configuration/sources/LNKD attributes: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/entityTypes/Organization/attributes/CompanyType - >- configuration/entityTypes/Organization/attributes/FoundedYear - >- configuration/entityTypes/Organization/attributes/Status - uri: configuration/entityTypes/Location typeColor: '#573eb5' abstract: false surrogateCrosswalks: - enforce: true source: configuration/sources/FB attributes: - >- configuration/entityTypes/Location/attributes/AddressLine1 - >- configuration/entityTypes/Location/attributes/AddressLine2 - configuration/entityTypes/Location/attributes/City - >- configuration/entityTypes/Location/attributes/StateProvince - >- configuration/entityTypes/Location/attributes/Country - >- configuration/entityTypes/Location/attributes/Street - >- configuration/entityTypes/Location/attributes/SubBuilding - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip5 - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip4 - enforce: true source: configuration/sources/LNKD attributes: - >- configuration/entityTypes/Location/attributes/AddressLine1 - >- configuration/entityTypes/Location/attributes/AddressLine2 - configuration/entityTypes/Location/attributes/City - >- configuration/entityTypes/Location/attributes/StateProvince - >- configuration/entityTypes/Location/attributes/Country - >- configuration/entityTypes/Location/attributes/Street - >- configuration/entityTypes/Location/attributes/SubBuilding - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip5 - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip4 - uri: configuration/entityTypes/HCP label: HCP description: Health care provider typeColor: '#99CCFF' extendsTypeURI: configuration/entityTypes/Individual attributes: - label: Gender name: Gender description: '' type: String hidden: false important: false system: false required: false faceted: true searchable: true values: - Male - Female - Unknown attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Gender lookupCode: GENDER_CD skipInDataAccess: false - label: Prof Designation name: ProfDesignation description: String type: String hidden: false important: false system: false required: false faceted: true searchable: true attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/ProfDesignation lookupCode: PROF_DESG skipInDataAccess: false - label: Specialty name: Specialities type: Nested hidden: true important: false system: false required: false faceted: false searchable: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Specialities dataLabelPattern: '{SpecialtyType} - {Specialty}' matchFieldURIs: - >- configuration/entityTypes/Party/attributes/Specialities/attributes/SpecialtyType - >- configuration/entityTypes/Party/attributes/Specialities/attributes/Specialty attributes: - label: Specialty Type name: SpecialtyType description: '' type: String hidden: false important: false system: false required: false faceted: false searchable: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Specialities/attributes/SpecialtyType lookupCode: SPEC_TYPE skipInDataAccess: false - label: Specialty name: Specialty description: '' type: String hidden: false important: false system: false required: false faceted: false searchable: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Specialities/attributes/Specialty lookupCode: SPEC skipInDataAccess: false - label: Specialty Detail name: SpecialtyDetail description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Specialities/attributes/SpecialtyDetail skipInDataAccess: false skipInDataAccess: false - label: Prof Type name: ProfType description: '' type: String hidden: false important: false system: false required: false faceted: true searchable: true attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/ProfType lookupCode: PROF_TYPE skipInDataAccess: false - label: Employment name: Employment type: Reference hidden: false important: false system: false required: false faceted: false searchable: false relationshipLabelPattern: '{Title}' attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Employment referencedAttributeURIs: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/relationTypes/Employment/attributes/Title - >- configuration/relationTypes/Employment/attributes/Summary - >- configuration/relationTypes/Employment/attributes/IsCurrent referencedEntityTypeURI: configuration/entityTypes/Organization relationshipTypeURI: configuration/relationTypes/Employment skipInDataAccess: false - label: ME name: ME description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: String hidden: true important: false system: false required: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/ME skipInDataAccess: false dataLabelPattern: >- {Prefix} {FirstName} {MiddleName} {LastName}, {SuffixName} {Credentials} {AddressLine} secondaryLabelPattern: '{Address}' survivorshipGroups: - uri: >- configuration/entityTypes/HCP/survivorshipGroups/default default: true mapping: - attribute: >- configuration/entityTypes/HCP/attributes/Employment survivorshipStrategy: Aggregation abstract: false matchGroups: - uri: >- configuration/entityTypes/HCP/matchGroups/PersonByMEAuto label: HCP by ME and Fuzzy name type: automatic rule: matchTokenClass: com.reltio.match.token.ExactNumberMatchToken comparatorClasses: mapping: - attribute: >- configuration/entityTypes/HCP/attributes/FirstName class: >- com.reltio.match.comparator.DynamicDamerauLevenshteinDistance - attribute: >- configuration/entityTypes/HCP/attributes/LastName class: >- com.reltio.match.comparator.DynamicDamerauLevenshteinDistance and: exact: - configuration/entityTypes/HCP/attributes/ME fuzzy: - >- configuration/entityTypes/HCP/attributes/FirstName - >- configuration/entityTypes/HCP/attributes/LastName ignoreInToken: - >- configuration/entityTypes/HCP/attributes/FirstName - >- configuration/entityTypes/HCP/attributes/LastName matchServiceClass: >- com.reltio.businesslogic.match.providers.internal.InternalMatchService scoreStandalone: 0 scoreIncremental: 0 - uri: >- configuration/entityTypes/HCP/matchGroups/PersonByIMSID label: HCP by IMS ID (#0) type: automatic rule: matchTokenClass: com.reltio.match.token.ExactMatchToken and: exact: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID equals: - value: IMS ID values: - IMS ID uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type matchServiceClass: >- com.reltio.businesslogic.match.providers.internal.InternalMatchService scoreStandalone: 0 scoreIncremental: 0 - uri: >- configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1 label: HCP by Identifiers (by TM) type: suspect rule: and: exact: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID equals: - value: TM values: - TM uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type exactOrNull: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Status scoreStandalone: 0 scoreIncremental: 0 relationTypes: - uri: configuration/relationTypes/HasAddress label: has address description: >- Types of relationships between Parties (Individuals and Organizations) and Location typeColor: '#663344' startObject: uri: configuration/relationTypes/HasAddress/startObject directionalContext: - uri: >- configuration/relationTypes/HasAddress/startObject/directionalContext labelPattern: has address objectTypeURI: configuration/entityTypes/Party endObject: uri: configuration/relationTypes/HasAddress/endObject directionalContext: - uri: >- configuration/relationTypes/HasAddress/endObject/directionalContext labelPattern: locates objectTypeURI: configuration/entityTypes/Location implicit: true attributes: - label: Status name: Status type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Status skipInDataAccess: false - label: Address Type name: AddressType type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/AddressType skipInDataAccess: false - label: Primary name: Primary type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Primary skipInDataAccess: false - label: AddressRank name: AddressRank type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/AddressRank skipInDataAccess: false - label: Care Of name: CareOf type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/CareOf skipInDataAccess: false - label: Active name: Active type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Active skipInDataAccess: false - label: Phone name: Phone type: Nested hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone dataLabelPattern: '{Number} {Type}' attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false values: - Mobile - Home - Work - Fax - Main - Work Fax - Home Fax - Pager - Other attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Type skipInDataAccess: false - label: Number name: Number description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Number skipInDataAccess: false - label: Extension name: Extension description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Extension skipInDataAccess: false - label: Rank name: Rank description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Rank skipInDataAccess: false - label: Active name: Active description: '' type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Active skipInDataAccess: false skipInDataAccess: false - label: Source CD name: SourceCD description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/SourceCD skipInDataAccess: false - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Commenters skipInDataAccess: false survivorshipGroups: - uri: >- configuration/relationTypes/HasAddress/survivorshipGroups/default default: true mapping: - attribute: >- configuration/relationTypes/HasAddress/attributes/AddressType survivorshipStrategy: Aggregation direction: directed survivorshipStrategies: - uri: >- configuration/survivorshipStrategies/CleanserWinsStrategy label: Reltio Cleanser or Nothing winnerSourceType: configuration/sources/ReltioCleanser winnerSourceAttributes: - >- configuration/entityTypes/Location/attributes/AddressLine1 - uri: configuration/survivorshipStrategies/LUD label: Recency - uri: configuration/survivorshipStrategies/Frequency label: Frequency - uri: configuration/survivorshipStrategies/Aggregation label: Aggregation - uri: configuration/survivorshipStrategies/SRC_SYS label: Source system - uri: configuration/survivorshipStrategies/OldestValue label: Oldest value - uri: configuration/survivorshipStrategies/MinValue label: Minimum value - uri: configuration/survivorshipStrategies/MaxValue label: Maximum value - uri: >- configuration/survivorshipStrategies/OtherAttributeWinnerCrosswalk label: Other Attribute Winner Crosswalk required: false responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/ReltioBusinessModel' example: uri: configuration description: Example of Reltio Metadata Configuration label: Business Model schemaVersion: 2.2.5 sources: - uri: configuration/sources/LNKD label: Linkedin icon: images/source/linkedin.png abbreviation: LNKD - uri: configuration/sources/Reltio label: Reltio icon: images/source/reltio.png abbreviation: Reltio - uri: configuration/sources/ReltioCleanser label: Reltio Data Cleanser icon: images/source/reltio.png priority: 100500 abbreviation: ReltioCleanser - uri: configuration/sources/FB label: Facebook icon: images/source/facebook.png abbreviation: FB - uri: configuration/sources/TWITTER label: Twitter icon: images/source/twitter.png abbreviation: TWITTER abstract: false referenceConfigurationURI: configuration/_vertical/reltio-core-2020-1 entityTypes: - uri: configuration/entityTypes/Organization typeColor: '#80D557' surrogateCrosswalks: - enforce: true source: configuration/sources/FB attributes: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/entityTypes/Organization/attributes/CompanyType - >- configuration/entityTypes/Organization/attributes/FoundedYear - >- configuration/entityTypes/Organization/attributes/Status - enforce: true source: configuration/sources/LNKD attributes: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/entityTypes/Organization/attributes/CompanyType - >- configuration/entityTypes/Organization/attributes/FoundedYear - >- configuration/entityTypes/Organization/attributes/Status abstract: false - uri: configuration/entityTypes/Location typeColor: '#573eb5' surrogateCrosswalks: - enforce: true source: configuration/sources/FB attributes: - >- configuration/entityTypes/Location/attributes/AddressLine1 - >- configuration/entityTypes/Location/attributes/AddressLine2 - configuration/entityTypes/Location/attributes/City - >- configuration/entityTypes/Location/attributes/StateProvince - >- configuration/entityTypes/Location/attributes/Country - configuration/entityTypes/Location/attributes/Street - >- configuration/entityTypes/Location/attributes/SubBuilding - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip5 - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip4 - enforce: true source: configuration/sources/LNKD attributes: - >- configuration/entityTypes/Location/attributes/AddressLine1 - >- configuration/entityTypes/Location/attributes/AddressLine2 - configuration/entityTypes/Location/attributes/City - >- configuration/entityTypes/Location/attributes/StateProvince - >- configuration/entityTypes/Location/attributes/Country - configuration/entityTypes/Location/attributes/Street - >- configuration/entityTypes/Location/attributes/SubBuilding - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip5 - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip4 abstract: false - uri: configuration/entityTypes/HCP label: HCP description: Health care provider typeColor: '#99CCFF' extendsTypeURI: configuration/entityTypes/Individual attributes: - label: Gender name: Gender description: '' type: String hidden: false important: false system: false required: false faceted: true searchable: true values: - Male - Female - Unknown attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Gender lookupCode: GENDER_CD skipInDataAccess: false - label: Prof Designation name: ProfDesignation description: String type: String hidden: false important: false system: false required: false faceted: true searchable: true attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/ProfDesignation lookupCode: PROF_DESG skipInDataAccess: false - label: Specialty name: Specialities type: Nested hidden: true important: false system: false required: false faceted: false searchable: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Specialities dataLabelPattern: '{SpecialtyType} - {Specialty}' matchFieldURIs: - >- configuration/entityTypes/Party/attributes/Specialities/attributes/SpecialtyType - >- configuration/entityTypes/Party/attributes/Specialities/attributes/Specialty attributes: - label: Specialty Type name: SpecialtyType description: '' type: String hidden: false important: false system: false required: false faceted: false searchable: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Specialities/attributes/SpecialtyType lookupCode: SPEC_TYPE skipInDataAccess: false - label: Specialty name: Specialty description: '' type: String hidden: false important: false system: false required: false faceted: false searchable: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Specialities/attributes/Specialty lookupCode: SPEC skipInDataAccess: false - label: Specialty Detail name: SpecialtyDetail description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Specialities/attributes/SpecialtyDetail skipInDataAccess: false skipInDataAccess: false - label: Prof Type name: ProfType description: '' type: String hidden: false important: false system: false required: false faceted: true searchable: true attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/ProfType lookupCode: PROF_TYPE skipInDataAccess: false - label: Employment name: Employment type: Reference hidden: false important: false system: false required: false faceted: false searchable: false relationshipLabelPattern: '{Title}' attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Employment referencedAttributeURIs: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/relationTypes/Employment/attributes/Title - >- configuration/relationTypes/Employment/attributes/Summary - >- configuration/relationTypes/Employment/attributes/IsCurrent referencedEntityTypeURI: configuration/entityTypes/Organization relationshipTypeURI: configuration/relationTypes/Employment skipInDataAccess: false - label: ME name: ME description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: String hidden: true important: false system: false required: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/ME skipInDataAccess: false dataLabelPattern: >- {Prefix} {FirstName} {MiddleName} {LastName}, {SuffixName} {Credentials} {AddressLine} secondaryLabelPattern: '{Address}' survivorshipGroups: - uri: >- configuration/entityTypes/HCP/survivorshipGroups/default default: true mapping: - attribute: >- configuration/entityTypes/HCP/attributes/Employment survivorshipStrategy: Aggregation abstract: false matchGroups: - uri: >- configuration/entityTypes/HCP/matchGroups/PersonByMEAuto label: HCP by ME and Fuzzy name type: automatic rule: matchTokenClass: com.reltio.match.token.ExactNumberMatchToken comparatorClasses: mapping: - attribute: >- configuration/entityTypes/HCP/attributes/FirstName class: >- com.reltio.match.comparator.DynamicDamerauLevenshteinDistance - attribute: >- configuration/entityTypes/HCP/attributes/LastName class: >- com.reltio.match.comparator.DynamicDamerauLevenshteinDistance and: exact: - configuration/entityTypes/HCP/attributes/ME fuzzy: - >- configuration/entityTypes/HCP/attributes/FirstName - >- configuration/entityTypes/HCP/attributes/LastName ignoreInToken: - >- configuration/entityTypes/HCP/attributes/FirstName - >- configuration/entityTypes/HCP/attributes/LastName matchServiceClass: >- com.reltio.businesslogic.match.providers.internal.InternalMatchService scoreStandalone: 0 scoreIncremental: 0 - uri: >- configuration/entityTypes/HCP/matchGroups/PersonByIMSID label: HCP by IMS ID (#0) type: automatic rule: matchTokenClass: com.reltio.match.token.ExactMatchToken and: exact: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID equals: - value: IMS ID values: - IMS ID uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type matchServiceClass: >- com.reltio.businesslogic.match.providers.internal.InternalMatchService scoreStandalone: 0 scoreIncremental: 0 - uri: >- configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1 label: HCP by Identifiers (by TM) type: suspect rule: and: exact: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID equals: - value: TM values: - TM uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type exactOrNull: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Status scoreStandalone: 0 scoreIncremental: 0 relationTypes: - uri: configuration/relationTypes/HasAddress label: has address description: >- Types of relationships between Parties (Individuals and Organizations) and Location typeColor: '#663344' startObject: uri: configuration/relationTypes/HasAddress/startObject directionalContext: - uri: >- configuration/relationTypes/HasAddress/startObject/directionalContext labelPattern: has address objectTypeURI: configuration/entityTypes/Party endObject: uri: configuration/relationTypes/HasAddress/endObject directionalContext: - uri: >- configuration/relationTypes/HasAddress/endObject/directionalContext labelPattern: locates objectTypeURI: configuration/entityTypes/Location implicit: true attributes: - label: Status name: Status type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Status skipInDataAccess: false - label: Address Type name: AddressType type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/AddressType skipInDataAccess: false - label: Primary name: Primary type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Primary skipInDataAccess: false - label: AddressRank name: AddressRank type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/AddressRank skipInDataAccess: false - label: Care Of name: CareOf type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/CareOf skipInDataAccess: false - label: Active name: Active type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Active skipInDataAccess: false - label: Phone name: Phone type: Nested hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone dataLabelPattern: '{Number} {Type}' attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false values: - Mobile - Home - Work - Fax - Main - Work Fax - Home Fax - Pager - Other attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Type skipInDataAccess: false - label: Number name: Number description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Number skipInDataAccess: false - label: Extension name: Extension description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Extension skipInDataAccess: false - label: Rank name: Rank description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Rank skipInDataAccess: false - label: Active name: Active description: '' type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Active skipInDataAccess: false skipInDataAccess: false - label: Source CD name: SourceCD description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/SourceCD skipInDataAccess: false - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Commenters skipInDataAccess: false survivorshipGroups: - uri: >- configuration/relationTypes/HasAddress/survivorshipGroups/default default: true mapping: - attribute: >- configuration/relationTypes/HasAddress/attributes/AddressType survivorshipStrategy: Aggregation direction: directed survivorshipStrategies: - uri: configuration/survivorshipStrategies/CleanserWinsStrategy label: Reltio Cleanser or Nothing winnerSourceType: configuration/sources/ReltioCleanser winnerSourceAttributes: - >- configuration/entityTypes/Location/attributes/AddressLine1 - uri: configuration/survivorshipStrategies/LUD label: Recency - uri: configuration/survivorshipStrategies/Frequency label: Frequency - uri: configuration/survivorshipStrategies/Aggregation label: Aggregation - uri: configuration/survivorshipStrategies/SRC_SYS label: Source system - uri: configuration/survivorshipStrategies/OldestValue label: Oldest value - uri: configuration/survivorshipStrategies/MinValue label: Minimum value - uri: configuration/survivorshipStrategies/MaxValue label: Maximum value - uri: >- configuration/survivorshipStrategies/OtherAttributeWinnerCrosswalk label: Other Attribute Winner Crosswalk '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.configuration.spring.ConfigurationController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Data%20Model/setConfigurationForTenant /services/reltio/api/{tenantId}/configuration/_noInheritance: get: tags: - Data Model summary: >- Gets the configuration for a tenant without any inheritance from verticals description: >- This API fetches the configuration of a tenant without any inheritance from the related verticals operationId: getConfigurationByTenantNoInheritance parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/ReltioBusinessModel' example: uri: configuration description: Example of Reltio Metadata Configuration label: Business Model schemaVersion: 2.2.5 sources: - uri: configuration/sources/LNKD label: Linkedin icon: images/source/linkedin.png abbreviation: LNKD - uri: configuration/sources/Reltio label: Reltio icon: images/source/reltio.png abbreviation: Reltio - uri: configuration/sources/ReltioCleanser label: Reltio Data Cleanser icon: images/source/reltio.png priority: 100500 abbreviation: ReltioCleanser - uri: configuration/sources/FB label: Facebook icon: images/source/facebook.png abbreviation: FB - uri: configuration/sources/TWITTER label: Twitter icon: images/source/twitter.png abbreviation: TWITTER abstract: false referenceConfigurationURI: configuration/_vertical/reltio-core-2020-1 entityTypes: - uri: configuration/entityTypes/Organization typeColor: '#80D557' surrogateCrosswalks: - enforce: true source: configuration/sources/FB attributes: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/entityTypes/Organization/attributes/CompanyType - >- configuration/entityTypes/Organization/attributes/FoundedYear - >- configuration/entityTypes/Organization/attributes/Status - enforce: true source: configuration/sources/LNKD attributes: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/entityTypes/Organization/attributes/CompanyType - >- configuration/entityTypes/Organization/attributes/FoundedYear - >- configuration/entityTypes/Organization/attributes/Status abstract: false - uri: configuration/entityTypes/Location typeColor: '#573eb5' surrogateCrosswalks: - enforce: true source: configuration/sources/FB attributes: - >- configuration/entityTypes/Location/attributes/AddressLine1 - >- configuration/entityTypes/Location/attributes/AddressLine2 - configuration/entityTypes/Location/attributes/City - >- configuration/entityTypes/Location/attributes/StateProvince - >- configuration/entityTypes/Location/attributes/Country - configuration/entityTypes/Location/attributes/Street - >- configuration/entityTypes/Location/attributes/SubBuilding - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip5 - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip4 - enforce: true source: configuration/sources/LNKD attributes: - >- configuration/entityTypes/Location/attributes/AddressLine1 - >- configuration/entityTypes/Location/attributes/AddressLine2 - configuration/entityTypes/Location/attributes/City - >- configuration/entityTypes/Location/attributes/StateProvince - >- configuration/entityTypes/Location/attributes/Country - configuration/entityTypes/Location/attributes/Street - >- configuration/entityTypes/Location/attributes/SubBuilding - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip5 - >- configuration/entityTypes/Location/attributes/Zip/attributes/Zip4 abstract: false - uri: configuration/entityTypes/HCP label: HCP description: Health care provider typeColor: '#99CCFF' extendsTypeURI: configuration/entityTypes/Individual attributes: - label: Gender name: Gender description: '' type: String hidden: false important: false system: false required: false faceted: true searchable: true values: - Male - Female - Unknown attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Gender lookupCode: GENDER_CD skipInDataAccess: false - label: Prof Designation name: ProfDesignation description: String type: String hidden: false important: false system: false required: false faceted: true searchable: true attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/ProfDesignation lookupCode: PROF_DESG skipInDataAccess: false - label: Specialty name: Specialities type: Nested hidden: true important: false system: false required: false faceted: false searchable: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Specialities dataLabelPattern: '{SpecialtyType} - {Specialty}' matchFieldURIs: - >- configuration/entityTypes/Party/attributes/Specialities/attributes/SpecialtyType - >- configuration/entityTypes/Party/attributes/Specialities/attributes/Specialty attributes: - label: Specialty Type name: SpecialtyType description: '' type: String hidden: false important: false system: false required: false faceted: false searchable: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Specialities/attributes/SpecialtyType lookupCode: SPEC_TYPE skipInDataAccess: false - label: Specialty name: Specialty description: '' type: String hidden: false important: false system: false required: false faceted: false searchable: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Specialities/attributes/Specialty lookupCode: SPEC skipInDataAccess: false - label: Specialty Detail name: SpecialtyDetail description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Specialities/attributes/SpecialtyDetail skipInDataAccess: false skipInDataAccess: false - label: Prof Type name: ProfType description: '' type: String hidden: false important: false system: false required: false faceted: true searchable: true attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/ProfType lookupCode: PROF_TYPE skipInDataAccess: false - label: Employment name: Employment type: Reference hidden: false important: false system: false required: false faceted: false searchable: false relationshipLabelPattern: '{Title}' attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Employment referencedAttributeURIs: - >- configuration/entityTypes/Organization/attributes/Name - >- configuration/relationTypes/Employment/attributes/Title - >- configuration/relationTypes/Employment/attributes/Summary - >- configuration/relationTypes/Employment/attributes/IsCurrent referencedEntityTypeURI: configuration/entityTypes/Organization relationshipTypeURI: configuration/relationTypes/Employment skipInDataAccess: false - label: ME name: ME description: DO NOT USE THIS ATTRIBUTE - will be deprecated type: String hidden: true important: false system: false required: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/ME skipInDataAccess: false dataLabelPattern: >- {Prefix} {FirstName} {MiddleName} {LastName}, {SuffixName} {Credentials} {AddressLine} secondaryLabelPattern: '{Address}' survivorshipGroups: - uri: >- configuration/entityTypes/HCP/survivorshipGroups/default default: true mapping: - attribute: >- configuration/entityTypes/HCP/attributes/Employment survivorshipStrategy: Aggregation abstract: false matchGroups: - uri: >- configuration/entityTypes/HCP/matchGroups/PersonByMEAuto label: HCP by ME and Fuzzy name type: automatic rule: matchTokenClass: com.reltio.match.token.ExactNumberMatchToken comparatorClasses: mapping: - attribute: >- configuration/entityTypes/HCP/attributes/FirstName class: >- com.reltio.match.comparator.DynamicDamerauLevenshteinDistance - attribute: >- configuration/entityTypes/HCP/attributes/LastName class: >- com.reltio.match.comparator.DynamicDamerauLevenshteinDistance and: exact: - configuration/entityTypes/HCP/attributes/ME fuzzy: - >- configuration/entityTypes/HCP/attributes/FirstName - >- configuration/entityTypes/HCP/attributes/LastName ignoreInToken: - >- configuration/entityTypes/HCP/attributes/FirstName - >- configuration/entityTypes/HCP/attributes/LastName matchServiceClass: >- com.reltio.businesslogic.match.providers.internal.InternalMatchService scoreStandalone: 0 scoreIncremental: 0 - uri: >- configuration/entityTypes/HCP/matchGroups/PersonByIMSID label: HCP by IMS ID (#0) type: automatic rule: matchTokenClass: com.reltio.match.token.ExactMatchToken and: exact: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID equals: - value: IMS ID values: - IMS ID uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type matchServiceClass: >- com.reltio.businesslogic.match.providers.internal.InternalMatchService scoreStandalone: 0 scoreIncremental: 0 - uri: >- configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1 label: HCP by Identifiers (by TM) type: suspect rule: and: exact: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID equals: - value: TM values: - TM uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type exactOrNull: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Status scoreStandalone: 0 scoreIncremental: 0 relationTypes: - uri: configuration/relationTypes/HasAddress label: has address description: >- Types of relationships between Parties (Individuals and Organizations) and Location typeColor: '#663344' startObject: uri: configuration/relationTypes/HasAddress/startObject directionalContext: - uri: >- configuration/relationTypes/HasAddress/startObject/directionalContext labelPattern: has address objectTypeURI: configuration/entityTypes/Party endObject: uri: configuration/relationTypes/HasAddress/endObject directionalContext: - uri: >- configuration/relationTypes/HasAddress/endObject/directionalContext labelPattern: locates objectTypeURI: configuration/entityTypes/Location implicit: true attributes: - label: Status name: Status type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Status skipInDataAccess: false - label: Address Type name: AddressType type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/AddressType skipInDataAccess: false - label: Primary name: Primary type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Primary skipInDataAccess: false - label: AddressRank name: AddressRank type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/AddressRank skipInDataAccess: false - label: Care Of name: CareOf type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/CareOf skipInDataAccess: false - label: Active name: Active type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Active skipInDataAccess: false - label: Phone name: Phone type: Nested hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone dataLabelPattern: '{Number} {Type}' attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false values: - Mobile - Home - Work - Fax - Main - Work Fax - Home Fax - Pager - Other attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Type skipInDataAccess: false - label: Number name: Number description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Number skipInDataAccess: false - label: Extension name: Extension description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Extension skipInDataAccess: false - label: Rank name: Rank description: '' type: Int hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Rank skipInDataAccess: false - label: Active name: Active description: '' type: Boolean hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Active skipInDataAccess: false skipInDataAccess: false - label: Source CD name: SourceCD description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/SourceCD skipInDataAccess: false - label: Commenters name: Commenters description: Commenters type: String hidden: true important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/Commenters skipInDataAccess: false survivorshipGroups: - uri: >- configuration/relationTypes/HasAddress/survivorshipGroups/default default: true mapping: - attribute: >- configuration/relationTypes/HasAddress/attributes/AddressType survivorshipStrategy: Aggregation direction: directed survivorshipStrategies: - uri: configuration/survivorshipStrategies/CleanserWinsStrategy label: Reltio Cleanser or Nothing winnerSourceType: configuration/sources/ReltioCleanser winnerSourceAttributes: - >- configuration/entityTypes/Location/attributes/AddressLine1 - uri: configuration/survivorshipStrategies/LUD label: Recency - uri: configuration/survivorshipStrategies/Frequency label: Frequency - uri: configuration/survivorshipStrategies/Aggregation label: Aggregation - uri: configuration/survivorshipStrategies/SRC_SYS label: Source system - uri: configuration/survivorshipStrategies/OldestValue label: Oldest value - uri: configuration/survivorshipStrategies/MinValue label: Minimum value - uri: configuration/survivorshipStrategies/MaxValue label: Maximum value - uri: >- configuration/survivorshipStrategies/OtherAttributeWinnerCrosswalk label: Other Attribute Winner Crosswalk '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.configuration.spring.ConfigurationController x-path: >- /private/swagger.htm?module=Configuration#/Data%20Model/getConfigurationByTenantNoInheritance /services/reltio/api/{tenantId}/configuration/entityTypes: get: tags: - Data Model summary: Gets the entity types configured for a tenant description: >- This API retrieves an array of entity types defined in the configuration for a tenant operationId: getEntityTypesForTenant parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string - name: inheritance in: query schema: type: boolean responses: '200': description: Successful operation content: application/json: schema: type: array items: $ref: '#/components/schemas/EntityType' example: - uri: configuration/entityTypes/HCP label: HCP description: Health care provider typeColor: '#99CCFF' attributes: - label: Gender name: Gender description: '' type: String hidden: false important: false system: false required: false faceted: true searchable: true values: - Male - Female - Unknown attributeOrdering: orderType: ASC orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/Gender lookupCode: GENDER_CD skipInDataAccess: false - label: Last Name name: LastName description: Last Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/LastName skipInDataAccess: false - label: First Name name: FirstName description: First Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/FirstName skipInDataAccess: false - label: Middle Name name: MiddleName description: Middle Name type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/MiddleName skipInDataAccess: false - label: SSN name: SSN description: '' type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/entityTypes/HCP/attributes/SSN skipInDataAccess: false - label: Identifiers name: Identifiers type: Nested hidden: false important: false system: false attributeOrdering: fieldURI: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type orderType: ASC orderingStrategy: FieldBased uri: configuration/entityTypes/HCP/attributes/Identifiers dataLabelPattern: '{Type} {ID} {Status}' matchFieldURIs: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID attributes: - label: Type name: Type description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type skipInDataAccess: false - label: ID name: ID description: '' type: String hidden: false important: false system: false searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID skipInDataAccess: false - label: Status name: Status description: '' type: String hidden: false important: false system: false faceted: true searchable: true attributeOrdering: orderingStrategy: LUD uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Status skipInDataAccess: false skipInDataAccess: false dataLabelPattern: '{FirstName} {MiddleName} {LastName}' survivorshipGroups: - uri: configuration/entityTypes/HCP/survivorshipGroups/default default: true mapping: - attribute: configuration/entityTypes/HCP/attributes/Identifiers survivorshipStrategy: Aggregation abstract: false matchGroups: - uri: configuration/entityTypes/HCP/matchGroups/PersonByIMSID label: HCP by IMS ID (#0) type: automatic rule: matchTokenClass: com.reltio.match.token.ExactMatchToken and: exact: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID equals: - value: IMS ID values: - IMS ID uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type matchServiceClass: >- com.reltio.businesslogic.match.providers.internal.InternalMatchService scoreStandalone: 0 scoreIncremental: 0 - uri: >- configuration/entityTypes/HCP/matchGroups/PersonByIdentifiers label: HCP by Identifiers (by TM) type: suspect rule: and: exact: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID equals: - value: TM values: - TM uri: >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type exactOrNull: - >- configuration/entityTypes/HCP/attributes/Identifiers/attributes/Status scoreStandalone: 0 scoreIncremental: 0 '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.configuration.spring.ConfigurationController x-path: >- /private/swagger.htm?module=Configuration#/Data%20Model/getEntityTypesForTenant /services/reltio/api/{tenantId}/configuration/relationTypes: get: tags: - Data Model summary: Gets the relation types configured for a tenant description: >- This API retrieves all relation types defined in the configuration for a tenant. Following are the examples of relation types: operationId: getRelationTypesForTenant parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string - name: inheritance in: query schema: type: boolean responses: '200': description: Successful operation content: application/json: schema: type: array items: $ref: '#/components/schemas/RelationshipType' example: - uri: configuration/relationTypes/Employment label: Employment description: >- Types of relationships between Individuals and Organizations - representing Individual employment for some Organization typeColor: '#AA3A44' startObject: uri: configuration/relationTypes/Employment/startObject directionalContext: - uri: >- configuration/relationTypes/Employment/startObject/directionalContext labelPattern: employee objectTypeURI: configuration/entityTypes/Individual endObject: uri: configuration/relationTypes/Employment/endObject directionalContext: - uri: >- configuration/relationTypes/Employment/endObject/directionalContext labelPattern: employer objectTypeURI: configuration/entityTypes/Organization implicit: false attributes: - label: Title name: Title type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: configuration/relationTypes/Employment/attributes/Title skipInDataAccess: false - label: Summary name: Summary type: String hidden: false important: false system: false attributeOrdering: orderingStrategy: LUD uri: >- configuration/relationTypes/Employment/attributes/Summary skipInDataAccess: false direction: directed - uri: configuration/relationTypes/HasAddress label: has address description: >- Types of relationships between Parties (Individuals and Organizations) and Location typeColor: '#663344' startObject: uri: configuration/relationTypes/HasAddress/startObject directionalContext: - uri: >- configuration/relationTypes/HasAddress/startObject/directionalContext labelPattern: has address objectTypeURI: configuration/entityTypes/Party endObject: uri: configuration/relationTypes/HasAddress/endObject directionalContext: - uri: >- configuration/relationTypes/HasAddress/endObject/directionalContext labelPattern: locates objectTypeURI: configuration/entityTypes/Location implicit: true attributes: - label: Address Type name: AddressType type: String hidden: false important: false system: false attributeOrdering: orderType: ASC orderingStrategy: LUD uri: >- configuration/relationTypes/HasAddress/attributes/AddressType skipInDataAccess: false survivorshipGroups: - uri: >- configuration/relationTypes/HasAddress/survivorshipGroups/default default: true mapping: - attribute: >- configuration/relationTypes/HasAddress/attributes/AddressType survivorshipStrategy: Aggregation direction: directed '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.configuration.spring.ConfigurationController x-path: >- /private/swagger.htm?module=Configuration#/Data%20Model/getRelationTypesForTenant /services/reltio/api/{tenantId}/configuration/sources: post: tags: - Data Model summary: Appends a source system to an existing configuration description: >- This operation appends a source system to the configuration. If the source type is created successfully, then the response will contain a JSON with this source type operationId: addSourceTypeForTenant parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string requestBody: description: Source to be appended to the configuration content: application/json: schema: $ref: '#/components/schemas/SourceType' examples: sample: description: Sample request for API value: uri: configuration/sources/NEWSOURCE label: Some new source icon: images/source/newsource.png abbreviation: NS required: false responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/SourceType' example: uri: configuration/sources/NEWSOURCE label: Some new source icon: images/source/newsource.png abbreviation: NS '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.configuration.spring.ConfigurationController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Data%20Model/addSourceTypeForTenant /services/reltio/api/{tenantId}/configuration/{objectType}/{typeName}: get: tags: - Data Model summary: Gets the specific object type based on name configured for a tenant description: >- This API retrieves an object type defined in the configuration for a tenant operationId: getObjectTypeForTenant parameters: - name: objectType in: path required: true schema: pattern: >- ^(?:entityTypes|groupTypes|relationTypes|graphTypes|interactionTypes|categoryTypes)$ type: string - name: tenantId in: path required: true schema: type: string - name: typeName in: path required: true schema: type: string - name: inheritance in: query schema: type: boolean responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/AbstractTypeWithAttributesObject' extensions: x-module: server x-controllerName: com.reltio.rest.configuration.spring.ConfigurationController x-path: >- /private/swagger.htm?module=Configuration#/Data%20Model/getObjectTypeForTenant /services/reltio/permissions/{tenantId}/_getAccessRoles: post: tags: - Metadata Security summary: Retrieves the access permissions and roles for the specified object URIs description: >- This API call allows you to specify Object URI for entities and change requests to view the details of the roles and access permissions applicable to those Object URIs.
For each URI from an input list, the response contains information about all access permissions for all roles.

Note: If there is an empty accessRoles field in the response, then analyze the values of the allPermitted field. If it is true, then any role has all permissions, otherwise there are no roles which have any permission for that particular object.

This API call returns the role and access details for the entities/change requests. However, if you want to check the role details based on specific access type, you can use this API with specific accessTypes mentioned in the Query parameter. For example, permissions/{tenant}/_getAccessRoles?accessTypes=READ,MERGE
API call's response would specify which roles are available with those specific access permissions for the specified Object URIs.
operationId: getAccessRolesByTenant parameters: - name: tenantId in: path required: true schema: type: string - name: accessTypes in: query description: List of accessTypes schema: type: string example: READ,UPDATE requestBody: content: application/json: schema: type: array items: type: string examples: sample: description: Sample request for API value: - changeRequests/B9sHK8Ks - entities/1T53ss8D required: true responses: '200': description: Successful operation content: application/json: schema: type: array items: $ref: '#/components/schemas/ObjectAccessRoles' example: - objectUri: changeRequests/B9sHK8Ks changeRequestUri: changeRequests/B9sHK8Ks allPermitted: false - objectUri: entities/1T53ss8D allPermitted: false accessRoles: - access: UPDATE '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorModel' example: error: unauthorized error_description: Full authentication is required to access this resource '404': description: The resource you were trying to reach is not found content: application/json: 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 extensions: x-module: server x-controllerName: com.reltio.rest.permissions.PermissionsController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Configuration#/Metadata%20Security/getAccessRolesByTenant /services/reltio/tenants/{tenantId}/cleanse: put: tags: - Data Model summary: Sets the cleanse configuration for a tenant description: >- This API sets the cleanse configuration for a tenant. If a configuration was already defined for the tenant, then that configuration is overridden with this operation. operationId: setTenantCleanseConfig parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string requestBody: description: cleanse configuration which will be updated for tenantId content: application/json: schema: type: array items: $ref: '#/components/schemas/TenantCleanseFunctionConfiguration' examples: sample: description: Sample request for API value: - cleanseFunction: Loqate options: process: v+g loqateKey: '**************' ovOnly: 'true' returnUnverifiedStatus: 'true' loqateDefaultCountry: US opts: PreferPrimaryValidAlias: 'Yes' SuppressAddressFields: Building - cleanseFunction: PhoneCleanser1 type: com.reltio.plugin.cleanse.service.PhoneCleanser module: reltio-modules/cleanse/custom-cleanse-functions-0.0.6.jar - cleanseFunction: EmailCleanser1 type: com.reltio.plugin.cleanse.service.EmailCleanser module: reltio-modules/cleanse/custom-cleanse-functions-0.0.6.jar required: true responses: '200': description: Cleanse configuration added successfully content: application/json: schema: type: array items: $ref: '#/components/schemas/TenantCleanseFunctionConfiguration' example: - cleanseFunction: Loqate options: process: v+g loqateKey: '**************' ovOnly: 'true' returnUnverifiedStatus: 'true' loqateDefaultCountry: US opts: PreferPrimaryValidAlias: 'Yes' SuppressAddressFields: Building - cleanseFunction: PhoneCleanser1 type: com.reltio.plugin.cleanse.service.PhoneCleanser module: reltio-modules/cleanse/custom-cleanse-functions-0.0.6.jar - cleanseFunction: EmailCleanser1 type: com.reltio.plugin.cleanse.service.EmailCleanser module: reltio-modules/cleanse/custom-cleanse-functions-0.0.6.jar '400': description: >- Cleanse configuration is not saved due to a reason provided in the error message content: application/json: schema: $ref: '#/components/schemas/APIErrorRepresentation' example: severity: Error errorMessage: >- Tenant devTenantId not configured. Use admin API to configure tenant errorCode: 127 errorDetailMessage: >- Tenant devTenantId not configured. Use admin API to configure tenant '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.admin.TenantsController x-codegen-request-body-name: cleanse configuration x-path: >- /private/swagger.htm?module=Configuration#/Data%20Model/setTenantCleanseConfig /services/reltio/tools/matching/{tenantId}/matchGroupFactorsSummary: get: tags: - Data Model summary: Returns the matching factors summary based on the tenant configuration description: The API computes a summary of match groups information operationId: getMatchGroupFactorsSummary parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string - name: entityTypeName in: query description: >- The name of an entity type to get match groups from. All tenant match groups contribute if not specified. schema: type: string example: Individual - name: matchGroups in: query description: The list of match group URIs to include in the summary. schema: type: list[string] example: >- configuration/entityTypes/Individual/matchGroups/IndividualByEmail,configuration/entityTypes/Individual/matchGroups/IndividualBySSN - name: scopes in: query description: The list of match groups scopes to include it in the summary. schema: type: list[string] default: ALL,INTERNAL,EXTERNAL example: ALL,INTERNAL - name: types in: query description: The list of match group types to include in the summary. schema: type: list[string] example: suspect,automatic - name: includeBypassed in: query description: >- The parameter specifies whether it includes bypassed match rules or not. schema: type: boolean default: false example: true responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/MatchGroupsFactorsSummary' example: matchGroups: - configuration/entityTypes/Character/matchGroups/AutoLastName - >- configuration/entityTypes/SimpleLocation/matchGroups/AutoMatch - >- configuration/entityTypes/Individual/matchGroups/PersonByFullNameOrSSNSuspect - >- configuration/entityTypes/Individual/matchGroups/PersonByFullNameAndSSN - >- configuration/entityTypes/SimpleLocation2/matchGroups/AutoMatch - >- configuration/entityTypes/Individual/matchGroups/PersonByFuzzyFullNameAndAddress - >- configuration/entityTypes/Individual/matchGroups/PersonBySoundexFuzzyFullNameAndAddress - configuration/entityTypes/Location/matchGroups/AutoMatch - >- configuration/entityTypes/LocationDupAttributes/matchGroups/AutoMatch matchGroupsTotal: 9 distinctTokenizationSchemesTotal: 6 suspectMatchGroupsTotal: 1 automaticMatchGroupsTotal: 6 nonOVMatchGroupsTotal: 5 internalMatchGroupsTotal: 9 oneFuzzyAttributeTotal: 0 twoFuzzyAttributesTotal: 1 threeFuzzyAttributesTotal: 0 fourPlusFuzzyAttributesTotal: 0 oneAttributeInTokenTotal: 2 twoAttributesInTokenTotal: 0 threeAttributesInTokenTotal: 1 fourAttributesInTokenTotal: 1 fiveAttributesInTokenTotal: 2 sixPlusAttributesInTokenTotal: 0 multiOperandsInTokenTotal: 0 heavyMatchTokenClassesTotal: 0 '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.match.tools.MatchingToolsController x-path: >- /private/swagger.htm?module=Configuration#/Data%20Model/getMatchGroupFactorsSummary /services/reltio/tools/matching/{tenantId}/tokenizationSchemes/{entityType}: get: tags: - Data Model summary: Get tokenization schemes explanation of match groups description: This API returns tokenization schemes explanation of match groups operationId: getTokenizationSchemesExplanation parameters: - name: entityType in: path required: true schema: type: string - name: tenantId in: path description: ID of the tenant required: true schema: type: string - name: scopes in: query description: Match group scopes to participate in the analysis schema: type: string default: ALL,INTERNAL,EXTERNAL,NONE example: INTERNAL - name: types in: query description: Match group types to participate in the analysis schema: type: string default: all example: suspect,relevance_based - name: rules in: query description: Match group URIs to participate in the analysis schema: type: string default: all example: ruleUri1,ruleUri2 - name: includeRules in: query description: Match group URIs to participate in the output schema: type: string default: all example: ruleUri1,ruleUri2 responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/TokenizationSchemesExplanation' '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.match.tools.MatchingToolsController x-path: >- /private/swagger.htm?module=Configuration#/Data%20Model/getTokenizationSchemesExplanation /services/reltio/tools/matching/{tenantId}/validateRegexpDictionaries: get: tags: - Data Model summary: >- Gets all the RegexpReplaceCleansers dictionaries validation notes for the tenant description: This API validates all the RegexpReplaceCleansers dictionaries of tenant operationId: validateRegexpDictionaries parameters: - name: tenantId in: path required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: >- #/components/schemas/TenantCleanserDictionariesValidationDetails '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.match.tools.MatchingToolsController x-path: >- /private/swagger.htm?module=Configuration#/Data%20Model/validateRegexpDictionaries components: schemas: ObjectFunctions: type: object properties: functions: type: array items: $ref: '#/components/schemas/Function' type: type: string description: >- URI of the Entity/Relation type to which the validation function applies example: configuration/entityTypes/Contact Function: required: - attribute - expression - message - name type: object properties: uri: type: string description: URI of the validation function created readOnly: true example: 3eccb2a4-06bd-4270-89ea-76a2b4fbe51b name: type: string description: Name of the validation function example: Mandatory FirstName label: type: string description: Label of the validation function example: Mandatory FirstName description: type: string description: description of the function example: This function validates the existence of the FirstName attribute: type: string description: Fully qualified attributes URI on which validation is applied example: configuration/entityTypes/Contact/attributes/FirstName expression: type: string description: >- Filter which will be evaluated on entity and if satisfied respective action will be taken example: missing(attributes.FirstName.value) action: type: string description: Action Type for the function example: WARNING enum: - WARNING - ERROR validationEvent: type: string description: >- Validation should be applicable to a given entity event type. Create event should be used when entity is being created any other event is of type Update example: ALL enum: - CREATE - UPDATE - ALL applyOn: type: string description: Validation on Operational values, crosswalk level or both example: OV enum: - OV - CW - BOTH sourceTypes: uniqueItems: true type: array items: type: string message: type: string description: >- Validation message for the function when expression evaluated as true example: Firstname is a required attribute status: type: string description: >- Status of the function, INACTIVE function will not validate the data where as ACTIVE one will validates the record example: ACTIVE enum: - ACTIVE - INACTIVE updatedTime: type: string description: Time of update of this object (Timestamp) readOnly: true example: '1604467649891' updatedBy: type: string description: Identifier of user updated this object readOnly: true example: ACTIVE createdBy: type: string description: Identifier of user created this object readOnly: true example: user@reltio.com createdTime: type: string description: Time of creation of this object (Timestamp) readOnly: true example: '1604467649890' TenantFunctions: type: object properties: tenantId: type: string description: Tenant Id readOnly: true example: devTenantId entityTypes: type: array items: $ref: '#/components/schemas/ObjectFunctions' relationTypes: type: array items: $ref: '#/components/schemas/ObjectFunctions' 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 ErrorResponse: type: object properties: code: type: integer description: Error code of the failed operation format: int32 readOnly: true example: 968 message: type: string description: Error Message readOnly: true example: Invalid function. details: type: string description: Details of the error occurred readOnly: true example: Refer internal errors for more details. internalErrors: type: array items: $ref: '#/components/schemas/ErrorResponse' ValidationFunctionResponse: required: - attribute - expression - message - name type: object properties: uri: type: string description: URI of the validation function created readOnly: true example: 3eccb2a4-06bd-4270-89ea-76a2b4fbe51b name: type: string description: Name of the validation function example: Mandatory FirstName label: type: string description: Label of the validation function example: Mandatory FirstName description: type: string description: description of the function example: This function validates the existence of the FirstName attribute: type: string description: Fully qualified attributes URI on which validation is applied example: configuration/entityTypes/Contact/attributes/FirstName expression: type: string description: >- Filter which will be evaluated on entity and if satisfied respective action will be taken example: missing(attributes.FirstName.value) action: type: string description: Action Type for the function example: WARNING enum: - WARNING - ERROR validationEvent: type: string description: >- Validation should be applicable to a given entity event type. Create event should be used when entity is being created any other event is of type Update example: ALL enum: - CREATE - UPDATE - ALL applyOn: type: string description: Validation on Operational values, crosswalk level or both example: OV enum: - OV - CW - BOTH sourceTypes: uniqueItems: true type: array items: type: string message: type: string description: >- Validation message for the function when expression evaluated as true example: Firstname is a required attribute status: type: string description: >- Status of the function, INACTIVE function will not validate the data where as ACTIVE one will validates the record example: ACTIVE enum: - ACTIVE - INACTIVE createdBy: type: string description: Identifier of user created this object readOnly: true example: user@reltio.com createdTime: type: string description: Time of creation of this object (Timestamp) readOnly: true example: '1604467649890' updatedBy: type: string description: Identifier of user updated this object readOnly: true example: ACTIVE updatedTime: type: string description: Time of update of this object (Timestamp) readOnly: true example: '1604467649891' error: $ref: '#/components/schemas/ErrorResponse' ActionTO: required: - module - name - type type: object properties: name: type: string description: Name of the life cycle action which is unique for a specific tenant. example: EntityScoreCalculator type: type: string description: Fully qualified life cycle action class. example: com.reltio.lca.customername.EntityScoreCalculatorAction module: type: string description: >- S3 Path of the JAR file which contains the action class.
Note: The jar file(s) needs to be placed into S3 bucket even for GCP tenants. Google Cloud Storage (GCS) is not yet supported. example: life-cycle-actions/dev/ReltioTenantId/reltio.score.calc.lca.jar state: type: string description: >- State of the life cycle action. Possible values are active and inactive. example: active enum: - active - inactive description: type: string description: Description of the life cycle action. example: >- This LCA calculates score for the profile based on the attribute values. updatedBy: type: string description: Identifier of user updated this object. readOnly: true example: somebody@example.com updatedTime: type: integer description: Time of update of this object (Timestamp). format: int64 readOnly: true example: 1599015741719 description: LifeCycleAction object model LCARestErrorRepresentation: type: object properties: severity: type: string description: Severity of the error message readOnly: true example: Error errorDetailMessage: type: string description: Detailed error message readOnly: true example: Detailed error message here errorMessage: type: string description: Brief error message readOnly: true example: Brief error message here errorCode: type: string description: Unique code of the error readOnly: true example: '123' CrosswalkExternalInfo: type: object properties: dtssInfo: $ref: '#/components/schemas/DTSSInfo' description: >- Additional information of crosswalk. This information is filled by Reltio services like DTSS. ReltioObject: type: object properties: 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: {} updatedTime: type: integer description: Time of update of this object (Timestamp). format: int64 example: 1599015741719 updatedBy: type: string description: Identifier of user updated this object. example: somebody@example.com createdBy: type: string description: Identifier of user created this object. example: somebody@example.com createdTime: type: integer description: Time of creation of this object (Timestamp). format: int64 example: 1599015741719 label: type: string description: >- An entity label that is built using the entity type configuration dataLabelPattern and data of an entity. example: John Smith type: type: string description: Type of entity example: configuration/{entityTypes|relationTypes}/Individual uri: type: string description: Unique identifier of entity example: entities/Bco79gB crosswalks: $ref: '#/components/schemas/CrosswalkTO' description: Reltio object model LifeCycleDataExecReq: type: object properties: environment: type: string description: Reltio API URL for the respective environment example: https://test.reltio.com/reltio tenant: type: string description: ID of the tenant example: reltiotenant object: $ref: '#/components/schemas/ReltioObject' token: type: string description: Reltio auth token example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx description: LifeCycleData batch execution object model LifeCycleDataResponse: type: object properties: object: $ref: '#/components/schemas/ReltioObject' successful: type: boolean description: This represents whether the lca execution success or not readOnly: true example: true description: LifeCycle data execution response object model. 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 LifeCycleDataBatchExec: type: object properties: environment: type: string description: Reltio API URL for the respective environment example: https://test.reltio.com/reltio hookName: type: string description: Name of the hook for which the LCA has been triggered example: beforeSave enum: - beforeSave - afterSave - beforeUpdate - afterUpdateBeforeCleanse - beforeOverride - afterOverrideBeforeCleanse - beforeDelete - afterDelete - rawDataBeforeCleanse - rawDataAfterCleanse - beforeMerge - afterMerge - beforeUnmerge - afterUnmerge - potentialMatchesFound - potentialMatchesRemoved - beforeNotAMatchSet - afterNotAMatchSet - beforeNotAMatchReset - afterNotAMatchReset - beforeMarkAsMatch - afterMarkAsMatch - beforeUnmarkAsMatch - afterUnmarkAsMatch - beforeReferenceAttributeAdded - afterReferenceAttributeAdded - beforeReferenceAttributeChanged - afterReferenceAttributeChanged - beforeReferenceAttributeRemoved - afterReferenceAttributeRemoved - afterDCRSave - validate tenant: type: string description: ID of the tenant example: reltiotenant token: type: string description: Reltio auth token example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx requests: type: array items: $ref: '#/components/schemas/LifeCycleObjectData' description: LifeCycleData batch execution object model LifeCycleObjectData: type: object properties: object: $ref: '#/components/schemas/ReltioObject' actionType: type: string description: Action Type example: CREATE enum: - CREATE - UPDATE - MERGE - SPLIT - VALIDATE - UNKNOWN - RECLEANSE 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 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. 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. AttributeValueTO: type: object properties: 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' type: type: string description: Type of attribute readOnly: true example: >- configuration/{entityTypes|relationTypes}/Individual/attributes/FirstName 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' Feature Toggles: type: object properties: createNewModel: type: boolean description: >- If this flag is set to false, creating a new model flow is not allowed publishModel: type: boolean description: If this flag is set to false, publishing a model flow is not allowed trainModel: type: boolean description: If this flag is set to false, training a model is not allowed shareModel: type: boolean description: If this flag is set to false, sharing a model flow is not allowed autoMerge: type: boolean description: >- If this flag is set to false, auto merge is not allowed as matching action while publishing a model flow description: Feature toggle flags Match IQ Configuration: type: object properties: jobClusterType: type: string description: cluster type to use for tenant ml jobs enum: - dataproc - databricks dataStorageId: type: string description: DataStorage Id to use for this tenant matchJobsLimit: type: integer description: >- Number of match flow jobs that can be created. 'matchJobLimitType' will determine if the limit is DAILY or CONSOLIDATED format: int32 example: 10 activeModels: type: integer description: Number of active models under this tenant format: int32 example: 10 modelsLimit: type: integer description: Number of models that can be created under this tenant format: int32 example: 10 activeMatchJobs: type: integer description: >- Number of active match flow jobs under this tenant. Type is determined by 'matchJobLimitType' format: int32 example: 10 attributesLimit: type: integer description: >- Number of attributes that can be selected while creating a model flow format: int32 example: 10 enabled: type: boolean description: >- If disabled, all the controls will be disabled. Used by UI to disable the UI matchJobLimitType: type: string enum: - DAILY - CONSOLIDATED featureToggles: $ref: '#/components/schemas/Feature Toggles' defaultSamplingConfig: $ref: '#/components/schemas/Feature Generation Sampling Configuration' storageProvider: type: string description: Match IQ configuration details Feature Generation Sampling Configuration: type: object properties: maxFlatRows: type: integer description: Maximum appropriate number of rows in the sampled table format: int64 example: 10000000 samplingStrategy: type: string description: >- This property set the sampling strategy. OV_FIRST (default) - try to flatten all values in the tenant table. If the flattened table size exceeds the maxFlatRows limit try using OV values only. If the flattened table is still too big, try taking fewer entities (but not less than minSampleSize) SAMPLING_FIRST - try to flatten all values in the tenant table. If the flattened table size exceeds the maxFlatRows limit, try taking fewer entities. If you have to take less than minSampleSize, try taking the OV values only as a fallback strategy example: OV_FIRST enum: - OV_FIRST - SAMPLING_FIRST minSampleSize: type: integer description: Minimum number of entities to participate in feature generation format: int64 example: 10000 description: Feature Generation Sampling Configuration Object PasswordRule: type: object MultitokenConfig: type: object properties: clientCredentialsMultiTokenConfig: uniqueItems: true type: array description: Client Credentials MultiToken Config $ref: '#/components/schemas/ClientCredentialsMultiTokenConfig' nullable: true readOnly: false writeOnly: false extensions: {} items: anyOf: - $ref: '#/components/schemas/ClientCredentialsMultiTokenConfig' Customer: required: - id - tenants type: object properties: id: type: string description: Id of the customer example: BestCustomer tenants: uniqueItems: true type: array description: list of tenants belongs to this customer example: '["devtenantId"]' items: type: string description: type: string description: description of this customer example: this is the pharma company passwordPolicy: $ref: '#/components/schemas/PasswordPolicy' caseSensitiveLoginEnabled: type: boolean description: if this enabled users will validated case sensitively example: true applicationClients: uniqueItems: true type: array description: list of applicationClients for this customer example: '["client_dataloader"]' items: type: string customerSpecificRoles: uniqueItems: true type: array items: $ref: '#/components/schemas/UserRole' multitokenConfig: uniqueItems: true type: array description: multitokenConfig $ref: '#/components/schemas/MultitokenConfig' nullable: true readOnly: false writeOnly: false extensions: {} items: anyOf: - $ref: '#/components/schemas/MultitokenConfig' customerCustomSettings: $ref: '#/components/schemas/CustomerCustomSettings' mfa: $ref: '#/components/schemas/MFAConfig' externalProviderConfig: type: object additionalProperties: $ref: '#/components/schemas/ExternalProviderConfig' ExternalProviderConfig: required: - callbackEndpoint - clientId - clientSecret - defaultGroups - defaultNewUserRoleList - externalClientId - jwt - loginEndpoint - oauthParameters - revokeEndpoint - rolePerTenantSsoEnabled - scope - sendClientCredInBody - tenants - tokenEndpoint - userEmailMapping - userGroupRegExp - userGroupsMapping - userIdMapping - userInfoEndpoint - userRoleMapping - userRoleRegexp - vendor type: object properties: providerId: type: string description: providerId example: okta vendor: type: string description: vendor example: okta loginEndpoint: type: string description: loginEndpoint of the external provider example: >- https://login.microsoftonline.com/bbd85ce3-ead8-493e-b35c-78uhjy57y/oauth2/authorize tokenEndpoint: type: string description: tokenEndpoint of the external provider example: >- https://login.microsoftonline.com/bbd85ce3-ead8-493e-b35c-78uhjy57y/oauth2/token userInfoEndpoint: type: string description: userInfoEndpoint of the external provider example: >- https://graph.windows.net/bbd85ce3-ead8-493e-b35c-78uhjy57y/me?api-version=1.6 callbackEndpoint: type: string description: >- callbackEndpoint once the authentication successful from external provider will be call example: https://auth.reltio.com/oauth/callback revokeEndpoint: type: string description: token epoint of the external provider for revoke example: >- https://login.microsoftonline.com/bbd85ce3-ead8-493e-b35c-78uhjy57y/oauth2/revoke clientId: type: string description: clientId of the external provider example: bbd85ce3-ead8-493e-b35c-78uhjy57y clientSecret: type: string description: client secret external provider example: 23bbd85ce3-ead8-493e-b35c-78uhjy57y isClientSecretEncrypted: type: boolean externalClientId: type: string description: externalClientId example: external_client_hr_prod scope: type: string description: scopes that are required while authentication with external provider example: openid email profile offline_access oauthParameters: type: string description: oauthParameters example: pfidpadapterid=TAM userIdMapping: type: string description: username mapping from external provider example: email userEmailMapping: type: string description: email mapping external provider example: email userRoleMapping: type: string description: >- applicable if roles are managed at external provider side the role coming from the external provider will be copied to the user example: custom:roles userRoleRegexp: type: string description: applicable if roles are managed at external provider side example: ([-a-zA-Z0-9_]*),*? defaultNewUserRoleList: uniqueItems: true type: array description: default role list of the user example: '[''ROLE_API'',''ROLE_USER'']' items: type: string tenants: uniqueItems: true type: array description: list of the tenants to which external provider is associated example: '[''devTenantId'',''testTenantId'']' items: type: string jwt: type: boolean description: jwt example: true debug: type: boolean description: debug example: true sendClientCredInBody: type: string description: >- this property determines clientId has to be sent as part of the body while authentication example: true jwtSignatureConfig: $ref: '#/components/schemas/JWTSignatureConfig' userGroupsMapping: type: string description: >- applicable if groups are managed at external provider side and group coming from the external provider will be copied to the user example: custom:groups userGroupRegExp: type: string description: applicable if groups are managed at external provider example: ([-a-zA-Z0-9_]*),*? defaultGroups: uniqueItems: true type: array description: tenants example: '[''READ_ONLY_GROUP'']' items: type: string rolePerTenantSsoEnabled: type: boolean description: >- if this enabled roles that are coming from external provider will be associated to a particular tenant to the user example: true logoutEndpoint: type: string description: logoutEndpoint example: logoutEndpoint UserRole: required: - role type: object properties: role: type: string description: Name of the role example: ROLE_DATALOADER PasswordPolicy: required: - expirePeriodInDays - inactivePeriodInDays - numberOfFailedLoginAttempts - userSessionTimeoutSeconds type: object properties: passwordRules: uniqueItems: true type: array description: Password Rules nullable: true readOnly: false writeOnly: false extensions: {} items: anyOf: - $ref: '#/components/schemas/EmailPRule' - $ref: '#/components/schemas/AllowedCharacterPRule' - $ref: '#/components/schemas/AlphabeticalSequencePRule' - $ref: '#/components/schemas/CharacterCharacteristicsPRule' - $ref: '#/components/schemas/DictionaryPRule' - $ref: '#/components/schemas/DigitCharacterPRule' - $ref: '#/components/schemas/HistoryPRule' - $ref: '#/components/schemas/IllegalCharacterPRule' - $ref: '#/components/schemas/LowercaseCharacterPRule' - $ref: '#/components/schemas/NonAlphanumericCharacterPRule' - $ref: '#/components/schemas/QwertySequencePRule' - $ref: '#/components/schemas/NumericalSequencePRule' - $ref: '#/components/schemas/RepeatCharacterRegexPRule' - $ref: '#/components/schemas/UppercaseCharacterPRule' - $ref: '#/components/schemas/UsernamePRule' - $ref: '#/components/schemas/WhitespacePRule' expirePeriodInDays: type: integer description: Expire Period In Days format: int32 example: 180 inactivePeriodInDays: type: integer description: inactivePeriodInDays format: int32 example: 30 numberOfFailedLoginAttempts: type: integer description: Number Of Failed Login Attempts after which user will be locked format: int32 example: 5 userSessionTimeoutSeconds: type: integer description: User Session idle Timeout Seconds format: int32 example: 300 numberOfFailedMFALoginAttempts: type: integer format: int32 CustomerCustomSettings: type: object properties: resetPasswordEmailTemplateId: type: string description: resetPasswordEmailTemplateId of the customer example: reltio jwtVersion: type: string description: jwtVersion of the customer example: V1 enum: - V1 ClientCredentialsMultiTokenConfig: required: - maxActiveTokensAllowed type: object properties: maxActiveTokensAllowed: type: integer description: maxActiveTokensAllowed format: int32 example: 5 MFAConfig: required: - availables - status type: object properties: status: type: string description: ENABLED example: ENABLED enum: - ENROLL - ENFORCE - DISABLED availables: type: array description: AUTHENTICATOR example: '[''AUTHENTICATOR'']' items: type: string enum: - AUTHENTICATOR - EMAIL JWTSignatureConfig: required: - issuer - jwksURL type: object properties: algorithm: type: string enum: - RSA256 issuer: type: string description: issuer example: https://login.microsoftonline.com/{{tenantIed}}}/v2.0 jwksURL: type: string description: jwksURL example: https://login.microsoftonline.com/common/discovery/v2.0/keys ClientDetailsWrapper: type: object properties: details: $ref: '#/components/schemas/AuthClientDetails' exposeSecret: type: boolean AuthClientDetails: type: object properties: clientId: type: string resourceIds: type: string scopes: type: string grantTypes: type: string authorities: type: string redirectUris: type: string clientSecret: type: string clientDescription: type: string clientName: type: string clientEmail: type: string consumer: type: string accessTokenValiditySeconds: type: integer format: int32 refreshTokenValiditySeconds: type: integer format: int32 additionalInformation: type: object additionalProperties: type: object lastModified: type: integer format: int64 encrypted: type: boolean enabled: type: boolean createdBy: type: string updatedBy: type: string createdDate: type: integer format: int64 updatedDate: type: integer format: int64 lastLoginDate: type: integer format: int64 customerId: type: string jwtVersion: type: string enum: - V1 clientPermissions: $ref: '#/components/schemas/ReltioUserPermissions' ReltioUserPermissions: type: object properties: roles: type: object additionalProperties: uniqueItems: true type: array items: type: string permissions: type: object additionalProperties: type: object additionalProperties: uniqueItems: true type: array items: type: string OperationStatus: type: object properties: status: type: string ClientMultitokenStats: type: object properties: status: type: string enum: - disabled - enabled tokensCount: type: integer format: int32 RolesPermissions: required: - roleName type: object properties: roleName: type: string description: Name of the role example: ROLE_READ_ONLY isMFAExempted: type: boolean roleScope: type: string description: >- Scope of the role for tenant assignment during token generation. CUSTOMER: All customer tenants auto-assigned, no manual tenant assignment allowed. TENANT: Tenants must be explicitly specified when assigning this role. Empty/null: Default behavior (backward compatible). example: CUSTOMER enum: - CUSTOMER - TENANT createdBy: type: string updatedBy: type: string createdDate: type: integer format: int64 updatedDate: type: integer format: int64 servicePermissions: uniqueItems: true type: array description: servicePermissions nullable: true readOnly: false writeOnly: false extensions: {} items: anyOf: - $ref: '#/components/schemas/ReltioServiceResourcePermissions' description: Role Permissions model ReltioServiceResourcePermissions: required: - allowedPrivileges - id type: object properties: id: type: string description: id example: dataloader allowedPrivileges: uniqueItems: true type: array description: allowedPrivileges example: '["READ","CREATE","DELETE","UPDATE"]' items: type: string resourcePermissions: uniqueItems: true type: array description: resourcePermissions nullable: true readOnly: false writeOnly: false extensions: {} items: anyOf: - $ref: '#/components/schemas/ReltioServiceResourcePermissions' description: Resource permission object model LowercaseCharacterPRule: required: - numCharacters type: object properties: numCharacters: type: integer description: numCharacters format: int32 example: 3 type: type: string description: type of rule example: .LowercaseCharacterPRule CharacterCharacteristicsPRule: required: - numberOfCharacteristics type: object properties: ruleList: type: array description: Password Rules nullable: true readOnly: false writeOnly: false extensions: {} items: anyOf: - $ref: '#/components/schemas/DigitCharacterPRule' - $ref: '#/components/schemas/LowercaseCharacterPRule' - $ref: '#/components/schemas/NonAlphanumericCharacterPRule' - $ref: '#/components/schemas/UppercaseCharacterPRule' numberOfCharacteristics: type: integer description: numberOfCharacteristics format: int32 example: 3 type: type: string description: type of rule example: .CharacterCharacteristicsPRule QwertySequencePRule: required: - type type: object properties: type: type: string description: type of rule example: .NonAlphanumericCharacterPRule AlphabeticalSequencePRule: required: - length type: object properties: length: type: integer description: length format: int32 example: 30 type: type: string description: type of rule example: .AlphabeticalSequencePRule DigitCharacterPRule: required: - numCharacters type: object properties: numCharacters: type: integer description: numCharacters format: int32 example: 3 type: type: string description: type of rule example: .DigitCharacterPRule HistoryPRule: required: - lastPasswordVerifyCount type: object properties: lastPasswordVerifyCount: type: integer description: >- Rule for determining if a password matches one of any previous password a user has chosen, Size of the history list format: int32 example: 5 type: type: string description: type of rule example: .HistoryPRule DictionaryPRule: required: - caseSensitive - dictionary type: object properties: dictionary: uniqueItems: true type: array description: dictionary example: '["p4t3t#none"]' items: type: string caseSensitive: type: boolean description: caseSensitive example: true type: type: string description: type of rule example: .DictionaryPRule AllowedCharacterPRule: required: - values type: object properties: values: type: string description: values example: '30' type: type: string description: type of rule example: .AllowedCharacterPRule UsernamePRule: required: - ignoreCase - matchBackwards type: object properties: matchBackwards: type: boolean description: matchBackwards example: true ignoreCase: type: boolean description: ignoreCase example: true type: type: string description: type of rule example: .UsernamePRule RepeatCharacterRegexPRule: required: - length type: object properties: length: type: integer description: length format: int32 example: 3 type: type: string description: type of rule example: .RepeatCharacterRegexPRule IllegalCharacterPRule: required: - values type: object properties: values: type: string description: values example: '~' type: type: string description: type of rule example: .IllegalCharacterPRule NonAlphanumericCharacterPRule: required: - numCharacters type: object properties: numCharacters: type: integer description: numCharacters format: int32 example: 3 type: type: string description: type of rule example: .NonAlphanumericCharacterPRule EmailPRule: required: - ignoreCase - matchBackwards type: object properties: matchBackwards: type: boolean description: matchBackwards example: true ignoreCase: type: boolean description: ignoreCase example: true type: type: string description: type of rule example: .EmailPRule WhitespacePRule: required: - type type: object properties: type: type: string description: type of rule example: .WhitespacePRule NumericalSequencePRule: required: - length type: object properties: length: type: integer description: length format: int32 example: 3 type: type: string description: type of rule example: .NumericalSequencePRule UppercaseCharacterPRule: required: - numCharacters type: object properties: numCharacters: type: integer description: numCharacters format: int32 example: 3 type: type: string description: type of rule example: .UppercaseCharacterPRule 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 Type Attribute: required: - name - type type: object properties: name: type: string description: Name of the attribute example: Population type: type: string description: >- Type of the attribute. One of the following types: Number, Boolean, Integer, Float, Time, Date, String example: Number required: type: boolean description: >- Flag required allows to control which attributes have to be defined when a lookup value is created example: false visible: type: boolean description: >- Flag visible allows to control which attributes should be visible on the MDM side example: true description: >- Attributes can be used for storing lookup type related information in each lookup value. 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 System: required: - abbreviation - uri type: object properties: uri: type: string description: Source System URI. It has to starts with 'configuration/sources/'. example: configuration/sources/Reltio label: type: string description: User-friendly name of the Source System for display purposes only. example: Reltio Source System description: type: string description: Description of the Source System example: Source system for values which come from Reltio icon: type: string description: Path to icon that will be used in RDM UI for the Source System. example: icons/Reltio.png abbreviation: type: string description: Abbreviation of the Source System. It has to match value in URI. example: Reltio canonicalValueProvider: type: boolean description: >- Flag canonicalValueProvider makes the Source System to the first candidate which will be used for canonical values. example: false description: >- Data may come from multiple sources. Each source system must be registered in RDM, all these source systems can be used to define mappings between source system and value which comes from it for further transcoding to canonical values. Lookup Type: required: - uri type: object properties: uri: type: string description: Lookup Type URI. It has to starts with 'rdm/lookupTypes/'. example: rdm/lookupTypes/Country label: type: string description: User-friendly name of the Lookup Type for display purposes only. example: Countries Lookup Type description: type: string description: Description of the Lookup Type example: Type for Countries enabled: type: boolean description: >- Status flag for the lookup type to enable it to use in a consuming application. Default value is true. example: true startDate: type: integer description: Timestamp of the start date when the lookup type will be enabled format: int64 example: 1608114397263 endDate: type: integer description: Timestamp of the end date when the lookup type will be disabled format: int64 example: 1608812360000 attributes: type: array description: Attributes of the lookup type items: $ref: '#/components/schemas/Lookup Type Attribute' generator: type: string description: >- Name of the configured generator to use for generating canonical codes for lookup values example: UUID Tenant Generator description: Definition of particular Lookup Type RDM Tenant Configuration: required: - tenantId 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 label: type: string description: User-friendly name of the RDM Tenant for display purposes only. example: Countries Tenant description: type: string description: Description of the RDM Tenant configuration example: RDM Tenant for Countries caseInsensitiveTranscoding: type: boolean description: >- The property to control the case sensitivity of the values being transcoded. By default it is false.
If value has changed, then first execute the cleanupTranscoder task, wait for completion and then the populateTranscoder task to apply change. example: false trackTranscodeErrors: type: boolean description: >- The property to control the tracking mapping errors on transcoding into unmapped values. By default it is false.
Does not support tracking mapping errors in nested requests of the hierarchical transcoding. example: false trackUnidentifiedLookups: type: boolean description: >- The property to control the tracking unidentified (without canonical code) lookups into unmapped values. By default it is false. example: false lookupTypes: type: array description: List of lookup types present in this RDM tenant items: $ref: '#/components/schemas/Lookup Type' sources: type: array description: List of Source Systems associated with this RDM tenant items: $ref: '#/components/schemas/Source System' 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: Configuration of the RDM tenant metadata Generator model: required: - name - type type: object properties: name: type: string description: Name of the generator example: country_gen type: type: string description: Type of the generator - UUID or SEQUENTIAL example: SEQUENTIAL enum: - UUID - SEQUENTIAL rangeStart: type: integer description: Start range for a SEQUENTIAL generator format: int32 example: 1 currentValue: type: integer description: Current value of the generator format: int32 example: 100 Operation status: required: - status type: object properties: status: type: string description: Status of the operation example: success enum: - success - error SAMLServiceErrorRepresentation: type: object properties: severity: type: string description: Severity of the error message example: Error errorDetailMessage: type: string description: Detailed error message example: Detailed error message here errorMessage: type: string description: Brief error message example: Brief error message here errorCode: type: string description: Unique code of the error example: '123' SAMLConfigResponse: type: object properties: metadata: type: string description: Metadata example: >- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified acsURL: type: string description: Assertion Consumer Service (ACS) URL example: >- https://reltio-samlssotenant.auth.us-east-1.amazoncognito.com/saml2/idpresponse entityID: type: string description: Entity Id example: urn:amazon:cognito:sp:us-east-1_uvzCxB8FG defaultRoles: uniqueItems: true type: array description: Default roles for the sso users example: '[ROLE_API, ROLE_USER]' items: type: string emailSAMLAttribute: type: string description: Email attribute example: email rolesSAMLAttribute: type: string description: Roles attribute example: email rolesMappingRegex: type: string description: Regex for the roles mapping example: ([-a-zA-Z0-9_]*),*? defaultGroups: uniqueItems: true type: array description: Default groups for the sso users example: '[SALES_GROUP, SALES_DEMO_GROUP]' items: type: string groupsSAMLAttribute: type: string description: Groups attribute example: groups groupsMappingRegex: type: string description: Regex for the groups mapping example: ([-a-zA-Z0-9_]*),*? SAMLConfigRequest: type: object properties: metaData: type: string description: Metadata Configuration example: >- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified rolesSAMLAttribute: type: string description: Roles attribute mapping identifier in the IDP example: roles groupsMappingRegex: type: string description: regex for the groups mapping example: ([-a-zA-Z0-9_]*),*? defaultGroups: uniqueItems: true type: array description: >- Default groups which will be assigned to the sso user as part of the login example: '[SALES_GROUP, SALES_DEMO_GROUP]' items: type: object groupsSAMLAttribute: type: string description: Group attribute mapping identifier in the IDP example: memberOf defaultRoles: uniqueItems: true type: array description: >- Default roles which will be assigned to the sso user as part of the login example: '[ROLE_API, ROLE_USER]' items: type: object rolesMappingRegex: type: string description: regex for the roles mapping example: ([-a-zA-Z0-9_]*),*? emailSAMLAttribute: type: string description: Email attribute mapping identifier in the IDP example: email MatchMethodsWeightingAlgorithm: type: object properties: type: type: string parameters: type: array items: $ref: '#/components/schemas/MatchParam' list: type: array items: type: string fallback: type: string DirectionalContext: type: object properties: uri: type: string description: >- Path that is used to identify a directional context of startPoint/endPoint configuration element example: configuration/relationTypes/ParentChild/endObject/directionalContext label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format rule: type: array description: Rules when the label pattern should be applied items: $ref: '#/components/schemas/Rule' description: Directional Context of start or end object of a Relationship Type ComparatorConfig: required: - klass - class type: object properties: parameters: type: array description: The parameters of the comparator class items: $ref: '#/components/schemas/MatchParam' fernConfig: $ref: '#/components/schemas/FernConfig' class: type: string description: The fully qualified name of the comparator class example: com.reltio.ml.match.comparator.MLDocumentComparator description: The structure to describe the match comparator class and its properties SurrogateCrosswalkConfig: required: - attributeUris - enforce - sourceUri - attributes - source type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format enforce: type: boolean description: >- Specifies whether the value of the crosswalk should always be calculated (true) or not (false) generationLogic: type: string description: Specifies generation logic for surrogate crosswalks. example: ovOnly enum: - ovOnly - useFirstNonOvWhenOvMissing - generateUidWhenOvMissing - generateUidWhenOvAndNonOvMissing - generateUidWhenAllOvMissing source: type: string description: URI of source configuration element attributes: type: array description: >- List of attributes URIs. Operation values (OV) of those attributes used to calculate value of surrogate crosswalk items: type: string description: >- Configuration of surrogate crosswalk definitions for particular source system that do not provide value MatchGroupAttributeMapping: type: object properties: dataModelAttribute: type: string matchMethodAttribute: type: string AndCondition: required: - operator - uri type: object properties: uri: type: string operator: type: string value: type: string or: type: array description: 'List of ' items: $ref: '#/components/schemas/OrCondition' and: type: array description: 'List of ' items: $ref: '#/components/schemas/AndCondition' FilterGreaterOrEqualCriteria: required: - uri - value type: object properties: uri: type: string description: uri of attribute example: configuration/entityTypes/Individual/attributes/FirstName value: type: string description: Exact value to compare with example: John description: Defines 'great or equal' criteria FilterInCriteria: required: - uri - value type: object properties: uri: type: string description: uri of attribute example: configuration/entityTypes/Individual/attributes/FirstName value: type: string description: List of the values to compare with example: John,Bob,Joe description: Defines 'in' criteria IReltioBusinessModelLocalizer: type: object NullValue: required: - attribute - value type: object properties: attribute: type: string description: Attribute URI example: configuration/entityTypes/Individual/attributes/FirstName value: type: string description: Value to be considered as null for an attribute example: unknown description: >- Allows to ignore irrelevant values during matching by specifying the words that must be considered as nulls. If there is a value like unknown, then the entities having the same unknown values must not be matched ComparatorClassMappingsArray: required: - mapping type: object properties: mapping: type: array description: Defines the list of attribute URI mappings to comparator classes items: $ref: '#/components/schemas/ComparatorClassMapping' description: List of mappings SurvivorshipGroupMapping: required: - attribute - survivorshipStrategyString - survivorshipStrategy type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format attribute: type: string description: uri of attribute for which OV values are calculating example: configuration/entityTypes/Individual/attributes/FirstName sortAs: type: string description: >- Defines type of data that will be used for calculation of min/max value for MinMax OV strategy example: int enum: - '[''number''' - '''boolean''' - '''dollar''' - '''long''' - '''int''' - '''integer''' - '''float''' - '''double''' - '''date''' - '''time''' - '''timestamp''' - '''blob''' - '''string'']' sourcesUriOrder: type: array description: >- Ordered list of sources. Used in SRC_SYS strategy and override such parameter defined in current survivorship group example: >- ['configuration/sources/ReltioCleanser', 'configuration/sources/FB', 'configuration/sources/Twitter'] items: type: string valuesPriorityOrder: type: array description: Ordered list of values. Used in ValuesPriorityOrder strategy example: '[''Bart'', ''Donald'', ''Joe'']' items: type: string lookupComparisonField: type: string description: >- Single lookup resolution type. Used in ValueBasedPriority strategy to determine which lookup value to use for comparison. Possible values: lookupCode, lookupValue, lookupRawValue example: lookupCode enum: - lookupCode - lookupValue - lookupRawValue sourcesForOv: uniqueItems: true type: array description: >- List of sources which may be OV. The sources which aren't included in this list will be ignored example: '[''configuration/sources/Reltio'', ''configuration/sources/FB''' items: type: string comparisonAttributeUri: type: string description: >- Uri of simple attribute, child of nested/reference attribute, used for comparison in MinValue, MaxValue, Frequency strategies only example: configuration/entityTypes/Location/attributes/Zip/attributes/Zip4 comparisonAttributeOvOnly: type: boolean description: >- Defines if only OV values of subnested attribute defined as comparisonAttributeUri should be used. This setting is applicable in MinValue, MaxValue, Frequency strategies only. If false, all values are used for comparison, if true - only OV values are used. Default is false example: true primaryAttributeUri: type: string description: >- Uri of simple attribute, used in OtherAttributeWinnerCrosswalk strategy.It gets all winner crosswalks from this primary attribute. If the current value has any crosswalk as primary attribute's winner crosswalks, all of them and all values provided by them become winners example: configuration/entityTypes/Location/attributes/AddressLine1 filter: $ref: '#/components/schemas/SurvivorshipGroupMappingFilter' fallbackStrategies: type: array description: >- List of survivorship strategy mappings to be applied to current attribute values if 'fallbackUsingCriteria' met condition items: $ref: '#/components/schemas/SurvivorshipGroupMapping' fallbackUsingCriteria: type: string description: >- Defines condition when 'fallbackStrategies' are applied to attribute values example: MORE_THAN_ONE enum: - '[''MORE_THAN_ONE''' - '''ZERO_OR_MORE_THAN_ONE''' - '''ZERO'']' ignoreCase: type: boolean description: >- If true, string comparisons are case-insensitive. Applicable to strategies that compare string values (ValueBasedPriority, Frequency, MinValue/MaxValue when sortAs='string'). Default is false example: true survivorshipStrategy: type: string description: Name of survivorship strategy used for calculation example: SRC_SYS description: >- Allows to specify survivorship strategy used to calculate operation value (OV) for particular attribute. Survivorship rules are defined for object attributes by survivorship mappings. All rules are defined separately for each attribute and are calculated independently of each other HiddenEntityTypeConfiguration: type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format matchGroups: type: array items: $ref: '#/components/schemas/MatchGroup' skippedMatchRules: type: array items: type: string MultiAttributesOperand: required: - attributes - uri type: object properties: uri: type: string description: URI of multi group example: configuration/entityTypes/Location/attributes/GeoLocationMulti attributes: type: array description: >- List of attribute URIs which participate in comparison with a multi-attributes comparator example: >- ["configuration/entityTypes/Location/attributes/GeoLocation/attributes/Latitude", "configuration/entityTypes/Location/attributes/GeoLocation/attributes/Longitude"] items: type: string combinationsConfig: $ref: '#/components/schemas/CombinationsConfig' description: Defines a group URI for set of attributes MatchGroupAliasMapping: type: object properties: from: type: string to: type: string SurvivorshipGroupMappingFilter: required: - equals type: object properties: equals: type: array description: List of 'equals' filtering criteria items: $ref: '#/components/schemas/FilterEqualsCriteria' ne: type: array description: List of 'not equals' filtering criteria items: $ref: '#/components/schemas/FilterNotEqualsCriteria' lt: type: array description: List of 'less' filtering criteria items: $ref: '#/components/schemas/FilterLessCriteria' lte: type: array description: List of 'less or equals' filtering criteria items: $ref: '#/components/schemas/FilterLessOrEqualCriteria' gt: type: array description: List of 'great' filtering criteria items: $ref: '#/components/schemas/FilterGreaterCriteria' gte: type: array description: List of 'great or equal' filtering criteria items: $ref: '#/components/schemas/FilterGreaterOrEqualCriteria' missing: type: array description: List of 'missing' filtering criteria items: $ref: '#/components/schemas/FilterMissingCriteria' exists: type: array description: List of 'exists' filtering criteria items: $ref: '#/components/schemas/FilterExistsCriteria' in: type: array description: List of 'in' filtering criteria items: $ref: '#/components/schemas/FilterInCriteria' notIn: type: array description: List of 'not in' filtering criteria items: $ref: '#/components/schemas/FilterNotInCriteria' or: type: array description: List of 'or condition' filtering criteria items: $ref: '#/components/schemas/OrCondition' and: type: array description: List of 'and condition' filtering criteria items: $ref: '#/components/schemas/AndCondition' discardIgnoredDeletedValues: type: boolean description: >- Boolean value, specify true if you want to discard ignored and end-dated crosswalk values example: true description: >- Defines list of filtering rules applies to values set. The value should meet all rules conditions in this list.In other words: each FilterEqualsCriteria combined in the filter by 'AND' GeoLocationAttribute: type: object properties: latitude: type: string description: Geo location latitude example: '37.52802455433206' longitude: type: string description: Geo location longitude example: '-122.26282991454705' UnmergeActionDefinition: required: - enabled - proceed - type type: object properties: enabled: type: boolean description: The toggle to enable or disable the action example: true type: type: string description: The type of the action example: tag enum: - unmerge - tag - dcr proceed: type: boolean description: >- Whether processing should continue with the next configured unmerge action example: true parameters: type: array description: The parameters of the action items: $ref: '#/components/schemas/MatchParam' 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 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 AbstractTypeWithLifecycleActions: type: object properties: lifecycleActions: type: object additionalProperties: uniqueItems: true type: array items: $ref: '#/components/schemas/LifecycleActionConfig' description: >- Life Cycle Action (LCA) allows to inject custom logic for various operations on Reltio profile. Reltio supported operations(hooks) are: beforeSave, afterSave, beforeMerge etc. Configuration of LCA can be done in 2 ways: 1. Simple configuration: {"beforeSave":["BeforeSaveAction","Lambda/BinaryJSON/LambdaAction"], "afterMerge":["AfterMergeAction"]} 2. Conditional configuration: {"beforeSave": [{"actions":["BeforeSaveAction"], "filter":"equals(clientType, 'Reltio UI')"}]} uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format extendsTypeURI: type: string description: >- URI of generic attribute type that is extended by this attribute type.
Note it is required to provide one of extendsTypeURI or valueType attributes example: configuration/attributeTypes/OrganizationName description: Base class of EntityType and RelationshipType discriminator: propertyName: type MatchAssetsType: type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format algorithm: type: string description: The algorithm to create match assets rematchOnThreshold: type: boolean description: >- Reevaluate matches or check for Automatic Unmerge when common asset(s) cross a threshold (default: true) definitions: type: array description: The list of match asset definitions items: $ref: '#/components/schemas/MatchAssetType' description: A definition of a set of match asset types CleanseAttributeMappings: type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format inputMapping: type: array description: List of Input mappings items: $ref: '#/components/schemas/CleanseAttributeMapping' inputMappingRef: type: string description: Uri of input mapping configuration from other sections example: >- configuration/entityTypes/Individual/cleanse/mappings/Address/inputMapping outputMapping: type: array description: List of Output mappings items: $ref: '#/components/schemas/CleanseAttributeMapping' outputMappingRef: type: string description: Uri of output mapping configuration from other sections example: >- configuration/entityTypes/Individual/cleanse/mappings/Address/outputMapping description: >- The mapping section of cleanseConfig contains information about the common input and output mappings for the cleanse functions. These mappings may be used inside the cleanse infos.
Input mapping determines the attributes that are collected from an entity of the cleanse function MatchAssetAttributeTransformerConfig: type: object properties: type: type: string parameters: type: object additionalProperties: type: string GroupType: required: - attributeModelHelperList - attributes type: object properties: uri: type: string description: Path that is used to identify a group type configuration element example: configuration/groupTypes/Physicians label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format dataPipelineTypeConfig: $ref: '#/components/schemas/DataPipelineTypeConfig' geoLocationAttributes: type: array description: Geolocation attributes definitions list of current object type items: $ref: '#/components/schemas/GeoLocationAttribute' dataTooltipPattern: type: string description: >- Pattern that is used to build the entity object's tooltip. Can include static text as well as patterns-attributes in curly brackets. example: 'Tooltip: {configuration/entityTypes/Individual/attributes/FullName}' typeColor: type: string description: Color that will be used to visualize this object type example: '#00FF00' survivorshipGroups: type: array description: >- List of survivorship groups which belong to this object type. One group in this list must be marked as default. items: $ref: '#/components/schemas/SurvivorshipGroup' ruleBasedAttributes: type: array description: >- Rules that can be used to define show dependent fields based on the defined expression items: $ref: '#/components/schemas/RuleBasedAttribute' indexingConfig: $ref: '#/components/schemas/IndexingConfig' hasPrimaryMember: type: boolean description: >- If true, group type instances required to have a primary member. This is validation rule - so groups can be created without primary members but it will be reflected in validation warning. Default: false example: true multiplePrimaryMembers: type: boolean description: >- If true, group instances will have multiple primary members. This is validation rule - so groups that are defined with single primary member can have more then one primary member but it will be reflected in validation warning. Default: true example: true limitMemberToOneGroupInstance: type: boolean description: >- If true, restricts group object to being related to only one instance of that group type example: true groupElements: type: array description: A collection of possible group elements items: $ref: '#/components/schemas/GroupElement' memberTypes: type: array description: A collection of possible member types items: $ref: '#/components/schemas/GroupMember' type: type: string description: >- Type of a group. Supported types are: example: logical enum: - manual - logical - manual-logical extendsTypeURI: type: string description: >- URI of generic attribute type that is extended by this attribute type.
Note it is required to provide one of extendsTypeURI or valueType attributes example: configuration/attributeTypes/OrganizationName cleanseConfig: $ref: '#/components/schemas/CleanseInfo' attributes: type: array description: Attributes definitions list of current object type items: $ref: '#/components/schemas/Attribute' activenessAttributes: type: array description: >- Objects dynamics functionality allows to specify a period for which object should be considered as active. Inactiveness for object means that it won't appear in any search results by default. example: >- [{"uri": "configuration/entityTypes/Individual/attributes/DoB","type": "start"}] items: $ref: '#/components/schemas/ActivenessAttribute' surrogateCrosswalks: type: array description: List of surrogate crosswalks defined for this object type items: $ref: '#/components/schemas/SurrogateCrosswalkConfig' defaultFacetedAttributes: type: array description: List of attributes that should be faceted for this object type example: >- ['configuration/entityTypes/HCP/attributes/FirstName', 'configuration/entityTypes/HCP/attributes/LastName'] items: type: string defaultSearchAttributes: type: array description: >- List of attributes that should be searchable dy default for this object type example: >- ['configuration/entityTypes/HCP/attributes/FirstName', 'configuration/entityTypes/HCP/attributes/LastName'] items: type: string description: >- Examples of group types are: Household, Alumni, Extended Family, ER Staff Rule: type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format attribute: type: string description: Attribute URI to verify in the rule example: configuration/entityTypes/Individual/attributes/Gender type: type: string description: Type of the rule example: condition enum: - condition condition: type: string description: Condition type example: '=' enum: - '=' value: type: string description: Value to verify example: Female description: Rule for Directional Context of a Relationship Type OrCondition: required: - operator - uri type: object properties: uri: type: string operator: type: string value: type: string or: type: array description: 'List of ' items: $ref: '#/components/schemas/OrCondition' and: type: array description: 'List of ' items: $ref: '#/components/schemas/AndCondition' Prefilter: type: object properties: enabled: type: boolean description: Whether prefiltering is enabled for this feature example: true algorithm: type: string description: Similarity algorithm to use for prefiltering example: JaroWinkler enum: - JaroWinkler - Levenshtein - MinMax - Exact threshold: type: string description: 'Similarity threshold range for prefiltering (format: ''min-max'')' example: 0.2-0.9 description: >- Prefilter configuration for Fern LLM inference. Applies lightweight similarity checks before expensive LLM inference to optimize performance and cost. MatchGroupOverrides: type: object properties: attributesMapping: type: array items: $ref: '#/components/schemas/MatchGroupAttributeMapping' AnalyticsAttribute: required: - name - type type: object properties: uri: type: string description: >- Path that is used to identify a analytics attribute configuration element example: configuration/entityTypes/Party/analyticsAttributes/Name label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format name: type: string description: >- Name of the attribute used by Data API. Should be exactly the same as the last part of uri example: Name type: type: string description: Type of attribute from the configuration. example: String enum: - String - StringNotTokenized - Long - Int - Number - Float - Boolean - Date - Timestamp - Blob - URL - Blog URL - Image URL - SSN - Id card (Passport) - SIC-code - NAICS-code - Email domains - Ticker symbol - CIK id - Stock exchange - GeoLocation - Nested - Reference maxOccurs: type: integer description: >- Analytics attributes can contain multiple values, maximum number of values is limited by the maxOccurs property. By default, 1 format: int32 example: 1 faceted: type: boolean description: >- If true, this attribute will be displayed in the +More list on the Search page when the entity is selected. By default, false example: false searchable: type: boolean description: >- If true, this attribute will be displayed in the Advanced Search page when the entity is selected. By default, false example: false couldUpdateWithLCA: type: boolean description: If true, this attribute will be persisted. By default, false example: false analyticsAttributes: type: array description: Array of possible nested analyticsAttributes items: $ref: '#/components/schemas/AnalyticsAttribute' description: >- Analytics attributes are special attributes that are used to store analytics' results. Analytics attributes are the properties of an entity. There are two types of analytics attributes: simple and nested. Nested attributes contain a set of analytics attributes. Analytics attributes can contain multiple values, maximum number of values is limited by the maxOccurs property. GroupMember: type: object properties: uri: type: string description: Path that is used to identify a group element configuration element example: configuration/groupTypes/Physicians/memberTypes/Member label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format primaryMember: type: boolean description: Whether this member primary or not example: true description: Group Member MatchMethodMetadata: required: - packageVersion type: object properties: packageVersion: type: string description: Match package version. example: 1.0.0 packageId: type: string description: Match package id example: HCP_1.2 packageProfile: type: string description: Match package profile id example: fern_ds origin: type: string description: Match method origin example: velocity_pack matchMethodApplicability: type: string description: >- Allows marking a match method as applicable to any pair that was discovered or not. Default: if-tokens-generated example: all enum: - if-tokens-generated - all description: Represents metadata for a match group SurvivorshipGroup: required: - isDefault - mappingsList - default - mapping type: object properties: uri: type: string description: >- Path that is used to identify a survivorship group configuration element example: configuration/entityTypes/Individual/survivorshipGroups/default label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format sourcesUriOrder: type: array description: >- Ordered list of sources. Used in SRC_SYS strategy as default list for all SurvivorshipGroupMappings in current group example: >- ['configuration/sources/ReltioCleanser', 'configuration/sources/FB', 'configuration/sources/Twitter'] items: type: string sourcesForOv: uniqueItems: true type: array description: >- Default list of sources which may be OV. The sources which aren't included in this list will be ignored.Can be overridden in survivorship group mapping for particular attribute example: '[''configuration/sources/Reltio'', ''configuration/sources/FB''' items: type: string roles: type: array description: >- List of user roles for which this survivorshipGroup is applied to. The list of roles can be specified to non default survivorshipGroup only example: '[''ROLE1'', ''ROLE2'']' items: type: string default: type: boolean description: >- Defines if the survivorshipGroup is flagged as default for particular object type or not example: true mapping: type: array description: List of SurvivorshipGroupMapping items: $ref: '#/components/schemas/SurvivorshipGroupMapping' description: >- A survivorship group consolidates a set of survivorship mapping.survivorshipGroup could be added to every type in the configuration. Each survivorship group has mapping of attribute URIs to survivorship strategies. One group for type could be set as default from the API.An object type can have multiple survivorship groups: one of them must be marked as default. A default group is used in most cases. Other, non-default groups are applied for users with specific roles only (roles are also defined in a group settings). CleanseInfoSequence: required: - sequence type: object properties: uri: type: string description: >- Path that is used to identify a cleanse info sequence configuration element example: configuration/entityTypes/Location/cleanse/infos/default label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format useInCleansing: type: boolean description: >- Specifies whether the cleanse info is automatically used to cleanse the updated or created entity example: true sequence: type: array description: >- Specifies a list of cleansing chains that are applied one by one during the cleansing items: $ref: '#/components/schemas/CleanseInfoChain' nestedAttributeToCleanse: type: string description: Nested attribute URI to be cleansed example: configuration/entityTypes/Individual/attributes/Email extendsTypeURI: type: string description: >- URI of generic attribute type that is extended by this attribute type.
Note it is required to provide one of extendsTypeURI or valueType attributes example: configuration/attributeTypes/OrganizationName description: >- Specification of the format in which the input and output mappings are configured for data cleanse Attribute: required: - name - type type: object properties: uri: type: string description: >- The path used to reach an attribute configuration.
Format: configuration/{objectType}/attributes/{AttributeName} example: configuration/entityTypes/Organization/attributes/Name label: type: string description: Name of the attribute how to display it in Reltio UI example: Organization Name columnName: type: string description: Name of the attribute in the underlying database example: PurchaseAmt name: type: string description: >- Name of the attribute used by Data API. Should be exactly the same as the last part of uri example: Name description: type: string description: Description of the attribute example: Name of the Organization type: type: string description: Type of attribute from the configuration. example: String enum: - String - StringNotTokenized - Long - Int - Number - Float - Boolean - Date - Timestamp - Blob - URL - Blog URL - Image URL - SSN - Id card (Passport) - SIC-code - NAICS-code - Email domains - Ticker symbol - CIK id - Stock exchange - GeoLocation - Nested - Reference valueType: type: string lookupCode: type: string description: Lookup code example: rdm/lookupTypes/Country dependentLookupAttributes: type: string description: Dependent lookup attributes example: >- configuration/entityTypes/Organization/attributes/TypeCode, configuration/entityTypes/Organization/attributes/SubTypeCode resolveLookupCode: type: boolean description: Resolve lookup and use a canonical code as the attribute value example: false hidden: type: boolean description: >- It allows marking an attribute as hidden. The hidden attributes will be present in the response only when the sendHidden option is used in the request. This flag can be used by applications to determine when to display characteristics of attributes. For example, the Reltio UI does not display attributes marked as hidden example: false important: type: boolean description: >- Deprecated - do not use. Marks the attributes that are important in the UI with a bold font or asterisks example: false system: type: boolean description: >- Marker that the attribute is system. System attributes cannot be changed during configuration inheritance example: false required: type: boolean description: >- Specifies whether at least one value for the attribute required or not example: false dataLabelPattern: type: string faceted: type: boolean description: >- If true, this attribute will be displayed in the +More list on the Search page when the entity is selected example: false searchable: type: boolean description: >- If true, this attribute will be displayed in the Advanced Search page when the entity is selected example: false maxOccurs: minimum: 1 type: integer description: Maximum number of values to display at Reltio UI format: int32 example: 5 autoGenerated: type: boolean description: >- If true, the value of attribute will be auto-generated. By default, false example: false generator: type: string description: The generator name (if autoGenetated is true example: SequentialGenerator autoGenerationPattern: type: string description: >- Pattern for autogenerated value. {value} will be substituted by generated value example: ID_{value} generateIfEmpty: type: boolean description: >- If true, the value will be generated even if it wasn't sent. By default, false example: false generateIfNotEmpty: type: boolean description: >- If true, the value will be generated if it was sent. By default, true example: true generatedValueUniqueForCrosswalk: type: boolean description: >- If true, existing value by crosswalk will be reused instead of generating a new one. By default, false example: false autoGenerationNestedPattern: type: object additionalProperties: type: string description: Used to specify auto-generated patterns for sub-attributes example: '{"Type": "UID", "Value": "ID_{value}"}' values: type: array description: List of possible values for the attribute example: Value1, Value2, Value3 items: type: string referencedAttributeURIs: type: array description: >- A Reference attribute does not have its own attributes. It is using attributes of a relationship and referenced entity. In this property, an array of relationship and referenced entity URIs is the set that will be used as part of the reference attribute example: >- configuration/relationTypes/HasAddress/attributes/AddressType, configuration/entityTypes/Location/attributes/City items: type: string immutableForSources: uniqueItems: true type: array description: >- Used to define an array of source systems (URIs and ids can be used) for which it is not possible to change the value of sub-attributes that came from the referenced entity (you still can change values from the relation) example: configuration/sources/Source1, configuration/sources/Source2 items: type: string immutableExceptForSources: uniqueItems: true type: array description: >- Defines a list of sources that will ignore the immutable parameter. As a result, attribute values that come from one of defined sources will anyway change the reference object example: configuration/sources/Source3, configuration/sources/Source4 items: type: string immutable: type: boolean description: >- Defines the Immutable Reference Attributes. This parameter overrides the immutableRefAttrsByDefault parameter from the tenant configuration for this particular attribute example: false doNotOverrideForSourceURIs: type: array description: >- In case of profile override, if the reference attribute is not provided in a request, then the existing reference attributes from sources (specified in this parameter) will not be deleted. You will need to delete relationships that are no longer needed example: configuration/sources/Source5, configuration/sources/Source6 items: type: string keyAttributeURIs: type: array description: >- Array of sub-attribute uris whose values are compared by Exact logic: example: >- configuration/entityTypes/Organization/attributes/Address/attributes/AddressType items: type: string keyAttributeURIsExactOrNull: type: array description: >- Array of sub-attribute uris whose values are compared by Exact Or NULL logic: example: >- configuration/entityTypes/Organization/attributes/Address/attributes/AddressType items: type: string keyAttributeURIsExactOrAllNull: type: array description: >- Array of sub-attribute uris whose values are compared by Exact or All NULL logic: example: >- configuration/entityTypes/Organization/attributes/Address/attributes/AddressType items: type: string keyAttributeURIsIgnoreCase: type: boolean description: >- Is used along with other keyAttributeURIs. By enabling this flag, it makes comparison case insensitive example: false matchFieldURIs: type: array description: >- Is used to define match rules for merging nested attributes: example: >- configuration/entityTypes/Individual/attributes/Education/University, configuration/entityTypes/Individual/attributes/Education/Degree items: type: string matchFieldURIsExactOrNull: type: array description: >- Is used to define match rules for merging nested attributes: example: >- configuration/entityTypes/Individual/attributes/Education/GPA, configuration/entityTypes/Individual/attributes/Education/Graduated items: type: string matchFieldURIsExactOrAllNull: type: array description: >- Is used to define match rules for merging nested attributes: example: >- configuration/entityTypes/Individual/attributes/Education/YearOfGraduation, configuration/entityTypes/Individual/attributes/Education/YearsInProgram items: type: string matchFieldURIsIgnoreCase: type: boolean description: >- Is used along with other matchFieldURIs for merging nested attributes. By enabling this flag, it makes comparison case insensitive example: false matchOvOnly: type: boolean description: >- Is used to define match rules for merging nested attributes. Specifies whether non-OV values of sub-attributes would be considered when merging different values of the nested attribute example: false singleValue: type: boolean description: >- If true, then only one value can appear in the attribute in the entity. If you specify several different values (possibly from different sources), then all these values will be combined into one nested attribute value (with different values for sub-attributes) example: false singleValueByCrosswalk: type: boolean description: >- If true, then only one value for a particular source can appear in the attribute in the entity. If you specify several different values (from the same source), then all these values will be combined into one nested attribute value (with different values for sub-attributes). In case of partial override, such nested attribute from the request body will not substitute whole value for the "data provider" crosswalk, but it will override (partially) sub-attributes inside the value example: false singleValueByCrosswalkSources: $ref: '#/components/schemas/SingleValueByCrosswalkSources' referencedEntityTypeURI: type: string description: >- The URI of entity type or role that is referenced from an entity though relationshipTypeURI example: configuration/entityTypes/Location relationshipTypeURI: type: string description: >- A Reference attribute does not have its own attributes. It is using attributes of a relationship and referenced entity. In this property, an array of relationship and referenced entity URIs is the set that will be used as part of the reference attribute example: configuration/relationTypes/HasAddress referenceAttributeDirection: type: string description: >- Specifies whether the reference attribute should appear in the entity when a relationship of type relationshipTypeURI is present example: both enum: - both - parentToChild - childToParent relationshipLabelPattern: type: string description: >- The pattern that is used to build the attribute relationship value label. It can include static text as well as patterns-attributes in curly brackets. With square brackets you can define conditional label patterns: if an attribute used inside the brackets does not exist, then all content inside the brackets will be skipped. If relationshipLabelPatternis not specified, label is used example: '{FirstName} {MiddleName} {LastName}[, {Credentials}]' survivorshipStrategy: type: string description: Name of the survivorship strategy to be applied for the attribute example: SRC_SYS attributeOrdering: $ref: '#/components/schemas/OrderingStrategy' attributeMasking: $ref: '#/components/schemas/masking' attributes: type: array description: Array of possible nested attributes items: $ref: '#/components/schemas/Attribute' dataLabelPatternHolder: $ref: '#/components/schemas/LocalizablePatternHolder' cardinality: $ref: '#/components/schemas/Cardinality' defaultValue: type: string description: Default value for the attribute example: A value skipInDataAccess: type: boolean description: Whether to skip the attribute in Reltio Analytics example: false customReltioId: type: boolean description: >- Specifies if we should skip generation of the attribute value for the ReltioId attribute and use value specified in a request body example: false vectorized: type: boolean description: >- If true, the attribute will be vectorized and available for semantic search filters. By default, false example: false indexingConfig: $ref: '#/components/schemas/IndexingConfig' enableNestedPartialOverride: type: boolean description: >- This boolean value determine, whether this attribute can be partial override or not. This has more priority than tenant config enableNestedPartialOverride. description: >- In the Reltio Business Model configuration you can configure the attributes within Entity Types, Relation Types, and Interaction Types.
Reltio supports six types of attributes:
GroupElement: type: object properties: uri: type: string description: Path that is used to identify a group element configuration element example: configuration/groupTypes/Physicians/groupElements/1 label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format entityTypeUris: type: array description: List of Entity Types example: >- configuration/entityTypes/Individual, configuration/entityTypes/Location items: type: string reachByRelationTypeUris: type: array description: List of Relation Types example: >- configuration/relationTypes/Parent, configuration/relationTypes/Child items: type: string description: Group Member MatchRule: type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format or: type: array properties: size: type: integer format: int32 description: Logical operand OR, applied to single or multiple match rules items: $ref: '#/components/schemas/MatchRule' and: type: array properties: size: type: integer format: int32 description: >- Logical operand AND, applied to single or multiple match rules items: $ref: '#/components/schemas/MatchRule' not: type: array properties: size: type: integer format: int32 description: >- Logical operand NOT, applied to single match rule. It is a unary operand and hence, only one argument/sub-operand is allowed. If you do not want to use a more complex condition after NOT, use the AND or OR logical operand as a container items: $ref: '#/components/schemas/MatchRule' exact: type: array description: >- Evaluates to True if there is an exact match between attribute values.List of attribute URIs.If there is no parent rule, the AND logical operator is used. example: >- ['configuration/entityTypes/Individual/attributes/FirstName', 'configuration/entityTypes/Individual/attributes/LastName'] items: type: string notExact: type: array description: Evaluates to True if there is no match between attribute values items: $ref: '#/components/schemas/NotExactOperand' equals: type: array description: >- This operator serves as a match filter, reducing the number of records that will be considered for a rule. Helps in identifying records that will be considered for matching items: $ref: '#/components/schemas/EqualsOperand' exactOrNull: type: array description: >- Evaluates to True when both values match, one value is null, or both values are null.List of attribute URIs, evaluates to True if there is an exact match between attribute values.If there is no parent rule, the AND logical operator is used. example: >- ['configuration/entityTypes/Individual/attributes/FirstName', 'configuration/entityTypes/Individual/attributes/LastName'] items: type: string exactOrAllNull: type: array description: >- Evaluates to True when both values match or both values are null.When you use the ExactOrAllNull operator, the rule evaluates to True if there is an exact match between attributes based on the value you specify or the value is null in both entities.If there is no parent rule, the AND logical operator is used. example: '[''configuration/entityTypes/Individual/attributes/LastName'']' items: type: string fuzzy: type: array description: >- Checks for similarity of attribute values.This operator uses the comparator classes to check for similarity of attribute values between two entities.Note: It's strongly recommends to define an appropriate comparator class whenever a fuzzy match operator is used. If you do not specify a comparator, the system chooses a default comparator that may not produce the desired match results. example: '[''configuration/entityTypes/Individual/attributes/LastName'']' items: type: string ignoreInToken: uniqueItems: true type: array description: >- List of attribute URIs which aren't included in match token saved in database. It's used to decrease token's size. example: '[''configuration/entityTypes/Individual/attributes/MiddleName'']' items: type: string multi: type: array description: Defines a list of groups of attributes items: $ref: '#/components/schemas/MultiAttributesOperand' weights: type: array description: List of mappings between attributes URIs and their weight items: $ref: '#/components/schemas/AttributeWeight' actionThresholds: type: array description: List of threshold range mapping to particular action type items: $ref: '#/components/schemas/MatchActionThreshold' cleanse: type: array description: >- List of cleansers can be used in match rules to cleanse matching attributes items: $ref: '#/components/schemas/MatchRuleCleanseInfo' matchTokenClass: type: string description: >- Fully qualified Java class name used for computing match tokens based on some predefined logic example: com.reltio.match.token.SoundexTextMatchToken comparatorClass: type: string description: >- Fully qualified Java class name used for comparing values based on some predefined logic. It's default for all matching attribute in particular object type example: com.reltio.match.comparator.SoundexComparator matchTokenClasses: $ref: '#/components/schemas/MatchTokenClassMappingsArray' comparatorClasses: $ref: '#/components/schemas/ComparatorClassMappingsArray' nullValues: type: array description: >- List of attribute mappings to ignore irrelevant values during matching items: $ref: '#/components/schemas/NullValue' notEquals: type: array description: >- Defines the list of attribute to value mappings that helps in identifying records that will not be considered for matching items: $ref: '#/components/schemas/EqualsOperand' in: type: array description: >- Defines the list of attribute to value mappings where boolean OR condition that is available for multiple values items: $ref: '#/components/schemas/EqualsOperand' description: >- Defines a set of attributes that must be used to compare two entities and the type of comparison used for each attribute. CandidateLookupMethod: required: - type type: object properties: type: type: string description: Type of the candidate selection algorithm example: vector-based enabled: type: boolean params: type: array description: Additional parameters for the candidate lookup items: $ref: '#/components/schemas/MatchParam' description: >- Represents a source of additional candidate pairs in the match method definition. FeatureDefaults: type: object properties: promptTemplate: type: string description: Default prompt template for LLM inference example: MULTIVALUE enum: - SINGLEVALUE - MULTIVALUE prefilter: $ref: '#/components/schemas/Prefilter' description: >- Default configuration settings for Fern LLM inference applied to all features unless overridden masking: type: object properties: regexPattern: type: string description: >- Regular expression pattern to match substring of the value to be masked example: .* maskMatched: type: boolean description: >- Mask matched drives which part of value to mask: if true (default) then matched substring is masked, if false then matched substring is not masked, but the rest of the value is masked example: false description: >- Attribute masking is configuration how whether attribute values should be masked and which parts of value are masked DependentAttributeValues: type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format valuesList: type: array description: List of values example: '[''value_1'', ''value_2'']' items: type: string visibleAttributes: type: array description: List of visible attributes URIs example: >- ['configuration/entityTypes/Party/attributes/DocumentLinks', 'configuration/entityTypes/Individual/attributes/Prefix', 'configuration/entityTypes/Party/attributes/ImageLinks'] items: type: string description: Definition of dependent attribute values and their visibility ruleBasedAttributesControlFunction: type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format extendsTypeURI: type: string description: >- URI of generic attribute type that is extended by this attribute type.
Note it is required to provide one of extendsTypeURI or valueType attributes example: configuration/attributeTypes/OrganizationName expression: type: string description: Expression on which fields has to be shown example: >- listEquals(attributes.Country.value, 'abc', 'def') and listEquals(attributes.State.value, 'abc', 'def') showAttributeURI: type: array description: List of attributes to be shown based on the expression example: >- [ "configuration/entityTypes/Organization12/attributes/LegalBusinessName" ] items: type: string ruleBasedAttributes: type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format extendsTypeURI: type: string description: >- URI of generic attribute type that is extended by this attribute type.
Note it is required to provide one of extendsTypeURI or valueType attributes example: configuration/attributeTypes/OrganizationName name: type: string description: Name of the rule example: Rule 1 type: type: string description: Type of the rule, allowed value is conditional example: Conditional enum: - Conditional controlFunction: $ref: '#/components/schemas/ruleBasedAttributesControlFunction' MatchAssetSourceSystemCondition: type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format included: type: array items: type: string ReltioBusinessModel: type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for a model example: Business Model description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format schemaVersion: type: string description: >- Version of Reltio API Configuration schema used to describe objects. Value of schemaVersion field should be chosen according to customer's internal processes. With every change of business configuration of tenant value of schema version schould be changed. example: 1.1.1 createdTime: type: integer description: Creation time of this configuration format: int64 example: 1662566038186 updatedTime: type: integer description: Update time of this configuration format: int64 example: 1662566038186 createdBy: type: string description: Identifier of a user created the Reltio Business Model example: somebody@example.com updatedBy: type: string description: Identifier of a user updated the Reltio Business Model last time example: somebody@example.com abstractModel: type: boolean description: >- Defines if this configuration is abstract and can be used only in inheritance hierarchy on top levels example: false referenceConfigurationURI: type: string description: URI of configuration which current configuration inherits from example: configuration/_vertical/life-sciences rdmTenantId: type: string description: Identifier of Reference Data Management tenant example: rdm entityTypes: type: array description: List of entity types definitions items: $ref: '#/components/schemas/EntityType' changeRequestTypes: type: array description: List of changeRequest types definitions items: $ref: '#/components/schemas/ChangeRequestType' roles: type: array description: List of roles definitions items: $ref: '#/components/schemas/Role' groupTypes: type: array description: List of groupType definitions items: $ref: '#/components/schemas/GroupType' matchActions: type: array description: List of match actions definitions items: $ref: '#/components/schemas/MatchAction' interactionTypes: type: array description: List of interactions types definitions items: $ref: '#/components/schemas/InteractionType' graphTypes: type: array description: List of graphs types definitions items: $ref: '#/components/schemas/GraphType' survivorshipStrategies: type: array description: List of survivorship strategies definitions items: $ref: '#/components/schemas/SurvivorshipStrategy' sources: uniqueItems: true type: array description: List of all sources definitions items: $ref: '#/components/schemas/SourceType' pinIgnoredPriority: type: array description: >- Defines priority of pin/ignored/neutral value statuses when equal values are merged or being overridden. Allowable value is ordered list of 3 value status name with descending priority. By default, ['ignored', 'pin', 'neutral'] example: '["ignored", "pin", "neutral"]' items: type: string enum: - ignored - pin - neutral attributeTypes: type: array description: List of generic attribute types definitions items: $ref: '#/components/schemas/GenericAttributeType' relationTypes: type: array description: List of relationship types definitions items: $ref: '#/components/schemas/RelationshipType' ratings: $ref: '#/components/schemas/Ratings' activity: $ref: '#/components/schemas/ActivityConfig' description: Configuration of the tenant metadata MatchGroup: required: - type - useOvOnly type: object properties: uri: type: string description: Path that is used to identify a match group configuration element example: configuration/entityTypes/Individual/matchGroups/IndividualByEmail label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format type: type: string description: >- Defines how to proceed duplicates found using this group: merge automatically ("automatic"), create a potential match which could be merged after user confirmation ("suspect"),merge or create a potential match or not match based on relevance ("relevance_based"),or even proceed with custom match action. example: automatic enum: - '[''automatic''' - '''suspect''' - '''relevance_based''' - '''automatic_grouping'']' scope: type: string description: >- Option to classify a rule as external only or internal only.Provides information about how to enable and disable match rules. By default, 'ALL' example: ALL enum: - '[''NONE''' - '''INTERNAL''' - '''EXTERNAL''' - '''ALL'']' useOvOnly: type: string description: >- If set to true, then only the OV value will be used for matching. By default, false. example: 'false' matchMethodMetadata: $ref: '#/components/schemas/MatchMethodMetadata' rule: $ref: '#/components/schemas/MatchRule' negativeRule: $ref: '#/components/schemas/NegativeMatchRule' documentComparator: $ref: '#/components/schemas/ComparatorConfig' documentTokenizer: $ref: '#/components/schemas/MatchTokenConfig' matchServiceClass: type: string description: >- Fully qualified Java class name of the match service implementation. Using this attribute external implementation of match service can be configured to use. example: >- com.reltio.businesslogic.match.providers.internal.InternalMatchService scoreStandalone: type: integer description: >- Numeric value (0, 100), the total match score for entity is based on in case of entity matched on this rule. The base match score is a max value of standalone scores between each match rule that the entity matched on. Total match score for entity is a sum of the base match score and incremental match scores EXCLUDING the rule that provided the standaloneScore. format: int32 scoreIncremental: type: integer description: >- Numeric value (0, 100), added to the base match score in case of entity matched on this rule. Total match score for entity is a sum of the base match score and incremental match scores EXCLUDING the rule that provided the standaloneScore format: int32 matchMethod: type: string description: >- Differentiate between the customer-defined match rules versus Match IQ defined match rules. All the match rules that do not have value for this field should default to customer-defined match rule. enum: - match_iq - rule_based aliasing: $ref: '#/components/schemas/MatchGroupAliasing' overrides: $ref: '#/components/schemas/MatchGroupOverrides' compositeMatchMethodParticipants: $ref: '#/components/schemas/CompositeMatchMethodParticipants' matchMethodPostEvaluation: $ref: '#/components/schemas/MatchMethodPostEvaluation' candidatesLookup: $ref: '#/components/schemas/CandidateLookup' matchMethodPrerequisites: $ref: '#/components/schemas/MatchMethodPrerequisites' filter: type: string description: >- ES-style filter expression to determine if this match rule is applicable to an entity. If the entity does not satisfy the filter, no match tokens will be generated for this rule. Supports functions like: equals, missing, exists, gt, gte, lt, lte, startsWith, containsWordStartingWith, range. Example: 'not missing(attributes.Phone)' or 'equals(attributes.Status, "Active")' example: not missing(attributes.Phone) description: >- A match group defines match rule or negative match rule to compare entities within the entity type. RetainMergeCondition: type: object properties: sources: type: array items: type: string matchGroups: type: array items: $ref: '#/components/schemas/UnmergeMatchGroup' MatchMethodPostEvaluation: type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format type: type: string description: The type of the post-evaluation example: common_assets assetsList: type: array description: List of match assets to be used for the matching process example: >- ['configuration/entityTypes/Individual/matchAssets/NameAsset', 'configuration/entityTypes/Individual/matchAssets/PhoneAsset'] items: type: string description: >- A common assets rule defines the conditions checked by the matching process to determine if two entities are allowed to merge/match. AttributeVerificationMappingConfig: type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format verificationFunction: type: string description: Name of the verification function used for verifying attributes resultingValuesSourceTypeUri: type: string description: >- Specify the source type URI for writing response attributes. If omitted, the input's source type will be used. params: type: object additionalProperties: type: object description: Additional parameters required for the verification function inputMapping: type: array description: List of input attribute mappings used for verification items: $ref: '#/components/schemas/AttributeVerificationMapping' outputMapping: type: array description: List of output attribute mappings after verification items: $ref: '#/components/schemas/AttributeVerificationMapping' extendsTypeURI: type: string description: >- URI of generic attribute type that is extended by this attribute type.
Note it is required to provide one of extendsTypeURI or valueType attributes example: configuration/attributeTypes/OrganizationName description: Configuration of attribute verification mapping for Entity Types MatchActionThreshold: required: - threshold - type type: object properties: type: type: string description: >- Action type. When a match pair is detected the action with this type is invoked. Predefined types are: auto_merge, not_a_match, potential_match. Custom match actions could also be used. example: not_a_match threshold: type: string description: >- Weight range: floating point numbers separated by '-'. Allowed range for start and end values is [0, 1] example: 0.7-0.9 label: type: string description: Readable name for the configuration element example: Recommended for workflow description: >- Defines a threshold range for particular action type. When a match pair is detected the action with this type is invoked FilterNotEqualsCriteria: required: - uri - value type: object properties: uri: type: string description: uri of attribute example: configuration/entityTypes/Individual/attributes/FirstName value: type: string description: Exact value to compare with example: John description: Defines 'not equal' criteria FilterExistsCriteria: required: - uri type: object properties: uri: type: string description: uri of attribute example: configuration/entityTypes/Individual/attributes/FirstName description: Defines 'exists' criteria CleanseInfoChain: required: - chain type: object properties: uri: type: string description: Path that is used to reach the configuration element example: >- For verticals: "configuration/_vertical/verticalName". For non-abstract configurations: "configuration" label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format chain: type: array description: >- List of cleanse functions that are applied one by one depending on the proceedOnSuccess or proceedOnError parameters items: $ref: '#/components/schemas/CleanseInfoElement' extendsTypeURI: type: string description: >- URI of generic attribute type that is extended by this attribute type.
Note it is required to provide one of extendsTypeURI or valueType attributes example: configuration/attributeTypes/OrganizationName description: Chain of cleanse functions that are applied one by one MatchTokenClassMappingsArray: required: - mapping type: object properties: mapping: type: array description: Defines the list of attribute URI mappings to match token classes items: $ref: '#/components/schemas/MatchTokenClassMapping' description: List of mappings UnmergeMatchGroup: type: object properties: uri: type: string description: Path that is used to identify a match group configuration element example: configuration/entityTypes/Individual/matchGroups/IndividualByEmail description: >- A reference to a match group to compare entities within the entity type for unmerge purposes SourceType: type: object properties: uri: type: string description: Path that is used to identify a source type configuration element example: configuration/sources/ReltioCleanser label: type: string description: Readable name for the configuration element example: Test configuration element description: type: string description: >- Freeform verbose explanation of the part of the configuration where this description appears example: Test configuration element used to describe Configuration API format priority: type: integer description: >- Priority of the Source that could be used by some Survivorship Strategies format: int32 example: 10 abbreviation: type: string description: >- Abbreviation of a source system that will be used in Reltio Data API requests for crosswalks example: FB icon: type: string description: Icon of the source to be displayed at Reltio UI example: sources/icon.png autoGenerated: type: boolean description: >- If true, the value of an appropriate crosswalk will be auto-generated example: false generator: type: string description: The generator name (if autoGenerated is true) example: SequentialGenerator autoGenerationPattern: type: string description: >- Pattern for autogenerated value. {value} will be substituted by generated value example: ID_{value} indexingConfig: $ref: '#/components/schemas/IndexingConfig' description: >- Data may come to Reltio from multiple sources. Each source must be registered in Reltio, and all data loaded into a tenant will be associated with a data source. If no source is specified when creating an object, the source will default to "Reltio" MatchActionMapping: required: - clazz - class type: object properties: parameters: type: array description: >- List of additional parameters passing to custom handler Java class items: $ref: '#/components/schemas/MappingParam' class: type: string description: Match Action handler Java class name example: com.reltio.businesslogic.match.handlers.SuspectMatchHandler description: Match Action handler class mapping for attributes RelationshipType: required: - attributeModelHelperList type: object properties: description: type: string extendsTypeUri: type: string cleanse: $ref: '#/components/schemas/CleanseInfo' attributeModelHelperList: type: array items: $ref: '#/components/schemas/AttributeModelHelper' activenessAttributeModelHelpers: type: array items: $ref: '#/components/schemas/ActivenessAttributeModelHelper' surrogateCrosswalksList: type: array items: $ref: '#/components/schemas/SurrogateCrosswalkConfig' defaultFacetedAttributeNames: type: array items: type: string defaultSearchAttributeNames: type: array items: type: string reverceOfTypeUris: type: string directionString: type: string allOf: - $ref: '#/components/schemas/AbstractTypeWithLifecycleActions' - required: - attributes type: object properties: uri: type: string description: >- Path that is used to identify a relationship type configuration element example: configuration/relationTypes/HasAddress label: type: string description: Readable name for the configuration element example: Test configuration element cleanseConfig: $ref: '#/components/schemas/CleanseInfo' dataPipelineTypeConfig: $ref: '#/components/schemas/DataPipelineTypeConfig' attributes: type: array description: Attributes definitions list of current object type items: $ref: '#/components/schemas/Attribute' activenessAttributes: type: array description: >- Objects dynamics functionality allows to specify a period for which object should be considered as active. Inactiveness for object means that it won't appear in any search results by default. example: >- [{"uri": "configuration/entityTypes/Individual/attributes/DoB","type": "start"}] items: $ref: '#/components/schemas/ActivenessAttribute' geoLocationAttributes: type: array description: Geolocation attributes definitions list of current object type items: $ref: '#/components/schemas/GeoLocationAttribute' dataTooltipPattern: type: string description: >- Pattern that is used to build the entity object's tooltip. Can include static text as well as patterns-attributes in curly brackets. example: >- Tooltip: {configuration/entityTypes/Individual/attributes/FullName} typeColor: type: string description: Color that will be used to visualize this object type example: '#00FF00' survivorshipGroups: type: array description: >- List of survivorship groups which belong to this object type. One group in this list must be marked as default. items: $ref: '#/components/schemas/SurvivorshipGroup' surrogateCrosswalks: type: array description: List of surrogate crosswalks defined for this object type items: $ref: '#/components/schemas/SurrogateCrosswalkConfig' defaultFacetedAttributes: type: array description: List of attributes that should be faceted for this object type example: >- ['configuration/entityTypes/HCP/attributes/FirstName', 'configuration/entityTypes/HCP/attributes/LastName'] items: type: string defaultSearchAttributes: type: array description: >- List of attributes that should be searchable dy default for this object type example: >- ['configuration/entityTypes/HCP/attributes/FirstName', 'configuration/entityTypes/HCP/attributes/LastName'] items: type: string ruleBasedAttributes: type: array description: >- Rules that can be used to define show dependent fields based on the defined expression items: $ref: '#/components/schemas/ruleBasedAttributes' indexingConfig: $ref: '#/components/schemas/IndexingConfig' startObject: $ref: '#/components/schemas/RelationshipEndPoint' endObject: $ref: '#/components/schemas/RelationshipEndPoint' sameAsTypeURIs: type: string description: >- Collection URI of the relation type that has the same semantics as this type. In all graphs the configuration of these relation types is used as synonyms; therefore, there is no need to list all possible types in the graph configuration example: configuration/relationTypes/HasLocation reverseOfTypeURIs: type: string description: >- Collection of URIs that define the semantic reverse relation type as this type example: configuration/relationTypes/Parent implicit: type: boolean description: >- If true, the relationship is marked as an Implicit relationship.

Default is false; that is, explicit example: true direction: type: string description: >- Identifies directional semantics of relationship object of the type. Supported directions:

Default is directed example: directed enum: - directed - undirected - bidirectional entityEndDateStrategy: type: string description: >- Defines how to handle the relation when the start/end entity is end dated.

Defaults to END_DATE_RELATION_CROSSWALKS example: END_DATE_RELATION_CROSSWALKS enum: - END_DATE_RELATION - END_DATE_RELATION_CROSSWALKS analyticsAttributes: type: array description: >- Allows to define list of attributes that not stored with relation but calculated on the fly according some rules. items: $ref: '#/components/schemas/AnalyticsAttribute' contributorCrosswalkSingleSourceUpdateMode: type: boolean description: >- If true, the relation crosswalks will be consolidated when crosswalks.