openapi: 3.0.1 info: title: '' description: '' contact: name: Reltio url: http://www.reltio.com email: support@reltio.com version: v1 servers: - url: / tags: '0': name: DTSS paths: /services/dnb/getDetailedProfile: post: tags: - D&B summary: >- Get Detailed Profile API retrieves the latest and most updated data by passign the D&B DUNS number description: >- Get Detailed Profile API is called when using the Get Company Details button on the UI. It is a real time API used to enrich the account data with most recent and updated information from D&B. It takes the DUNS number as the input and fetches the complete account profile from D&B. operationId: getDetailedProfileByTenant parameters: - name: environmentUrl in: header description: >- Test to checkThe environment details of the tenant for which the organization match is required. required: true schema: type: string - name: tenantId in: header description: ID of the tenant for which the organization match is required. required: true schema: type: string - name: Authorization in: header description: >- The access token in the Bearer: <> format. This parameter is required if you do not specify Reltio-User and Reltio-Password. schema: type: string - name: Reltio-User in: header description: >- The Reltio login username that must be used. You must specify this if the access token is not specified for authorization. schema: type: string - name: Reltio-Password in: header description: >- The Reltio login password that must be used. You must specify this if the access token is not specified for authorization. schema: type: string - name: DnB-Token in: header description: >- The D&B token in the Bearer: format. This parameter is required if you do not specify DnB-User and DnB-Password. schema: type: string - name: DnB-User in: header description: >- The D&B account username or Consumer Key in Direct+. You must specify this if the access token is not specified for authorization. schema: type: string - name: DnB-Password in: header description: >- The D&B account password or Consumer Secret in Direct+. You must specify this if the access token is not specified for authorization. schema: type: string - name: entityURI in: query description: Entity URI's in the entities/XXXX format. required: true schema: type: string - name: plus in: query description: >- This can be set to true or false. If set to true, then the Direct+ based Get Org Match call or Direct+ based Get Detailed Profile is started. Note: You must have a token or an account with the privileges for Direct+ API usage. Otherwise, an authentication error is raised. schema: type: boolean default: false - name: product in: query description: >- This can be set to cmpelf or cmpelk. The default value is cmpelf. Note: Your account must have access to required product. If you set an arbitrary value for this parameter, the following DnB error appears: Supplied product or version of the product does not exist. schema: type: string default: cmpelf enum: - cmpelf - cmpelk requestBody: {} responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/RealtimeAPIResponse' example: success: OK message: Enrichment successful extensions: x-module: dnb x-controllerName: >- com.reltio.account360.connector.dnb.web.controller.DnbConnectorResource x-path: >- /private/swagger.htm?module=Integration#/D&B/getDetailedProfileByTenant /services/dnb/getFamilyTree: post: tags: - D&B summary: >- Get Upward Account Hierarchy API provides a hierarchical defined structure to complete the organization hierarchy to its global ultimate account description: >- The Get Upward Account Hierarchy API allows you to request for all parent organizations (all organizations from the current organization to its global ultimate) for a current organization. The API takes the DUNS number of the organization for which all the parent organizations are requested operationId: getFamilyTreeByTenant parameters: - name: environmentUrl in: header description: >- The environment details of the tenant for which the organization match is required. schema: type: string - name: tenantId in: header description: 'ID of the tenant for which the organization match is required. ' schema: type: string - name: Authorization in: header description: >- The access token in the Bearer: <> format. This parameter is required if you do not specify Reltio-User and Reltio-Password. schema: type: string - name: Reltio-User in: header description: >- The Reltio login username that must be used. You must specify this if the access token is not specified for authorization. schema: type: string - name: Reltio-Password in: header description: >- The Reltio login password that must be used. You must specify this if the access token is not specified for authorization. schema: type: string - name: DnB-Token in: header description: >- The D&B token in the Bearer: format. This parameter is required if you do not specify DnB-User and DnB-Password. schema: type: string - name: DnB-User in: header description: >- The D&B account username or Consumer Key in Direct+. You must specify this if the access token is not specified for authorization. schema: type: string - name: DnB-Password in: header description: >- The D&B account password or Consumer Secret in Direct+. You must specify this if the access token is not specified for authorization. schema: type: string - name: entityURI in: query description: Entity URI's in the entities/XXXX format required: true schema: type: string - name: plus in: query description: >- This can be set to true or false. If set to true, then the Direct+ based Get Org Match call or Direct+ based Get Detailed Profile is started.Note: You must have a token or an account with the privileges for Direct+ API usage. Otherwise, an authentication error is raised. schema: type: boolean requestBody: {} responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/RealtimeAPIResponse' example: success: OK message: Family tree successful entities: - entities/sbrWEPB - entities/sbrWIfR - entities/1QvQsDUm extensions: x-module: dnb x-controllerName: >- com.reltio.account360.connector.dnb.web.controller.DnbConnectorResource x-path: /private/swagger.htm?module=Integration#/D&B/getFamilyTreeByTenant /services/dnb/getOrgMatch: post: tags: - D&B summary: >- Get Match API returns the D&B DUNS number using the basic account data like name and address description: >- The Get Match API is called using the Get Match button on the UI. It is a real time API, that uses the account data like name and address and returns the D&B DUNS number.
The D&B DUNS number is updated in the Reltio account profile. If more than one DUNS numbers are found, multiple account profiles with matching criteria are returned and updated in the associated data tenant. If no match is found, the API returns an error with an appropriate message. operationId: getOrgMatchByTenant parameters: - name: environmentUrl in: header description: The URL of the environment. required: true schema: type: string - name: tenantId in: header description: The ID of the tenant for which the organization match is required. required: true schema: type: string - name: Authorization in: header description: >- The access token in the Bearer format. This parameter is required if you do not specify Reltio-User and Reltio-Password. schema: type: string - name: Reltio-User in: header description: >- The Reltio login username that must be used. You must specify this if the access token is not specified for authorization. schema: type: string - name: Reltio-Password in: header description: >- The Reltio login password that must be used. You must specify this if the access token is not specified for authorization. schema: type: string - name: DnB-Token in: header description: >- The D&B token in the Bearer: <> format. This parameter is required if you do not specify D&B-User and D&B-Password. schema: type: string - name: DnB-User in: header description: >- The D&B account username or Consumer Key in Direct+. You must specify this if the access token is not specified for authorization. schema: type: string - name: DnB-Password in: header description: >- The D&B account password or Consumer Secret in Direct+. You must specify this if the access token is not specified for authorization. schema: type: string - name: entityURI in: query description: Entity URIs in the entities/XXXX format. required: true schema: type: string - name: plus in: query description: >- This parameter can be set to true or false. If set to true, Direct+ based Get Org Match call or Direct+ based Get Detailed Profile is started. Note: You must have a token or an account with the privileges for Direct+ API usage. Otherwise, an authentication error is raised. schema: type: boolean default: false requestBody: {} responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/RealtimeAPIResponse' example: success: OK message: 1 Match(es) entities: - entities/1GsuMoU2 extensions: x-module: dnb x-controllerName: >- com.reltio.account360.connector.dnb.web.controller.DnbConnectorResource x-path: /private/swagger.htm?module=Integration#/D&B/getOrgMatchByTenant //config/mappings/{mappingName}: get: tags: - D&B summary: Allows you to obtain a tenant's mapping description: >- D&B Connector Get mapping API enables you to fetch the mappings for various operations like batch, enrichment etc. performed through D&B Connector.
You can pass the following mappingName as part of the API parameter:
batch, enrichment, filter, match, corporate_linkage operationId: getTenantMapping parameters: - name: plus in: query schema: type: boolean default: true - name: mappingName in: path description: ' The name of the mapping' required: true schema: type: string - name: environmentUrl in: header description: ' The URL of the environment.' required: true schema: type: string - name: tenantId in: header description: ' The ID of the tenant.' required: true schema: type: string - name: Authorization in: header description: ' The access token in the Bearer format.' required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object example: - operation: shift spec: '*': type: '[&1].type' attributes: VendorVerificationStatus: '*': value: >- [&4].attributes.VendorVerification[0].value.VendorVerificationStatus[].value VendorVerificationDate: '*': value: >- [&4].attributes.VendorVerification[0].value.VendorVerificationDate[].value SuspectMatchFlag: '*': value: '[&4].attributes.SuspectMatchFlag[].value' AutoMatchFlag: '*': value: '[&4].attributes.AutoMatchFlag[].value' entityURI: '*': value: '[&4].attributes.entityURI[].value' DUNSNumber: '*': value: '[&4].attributes.DUNSNumber[].value' crosswalks: '*': '[&2].crosswalks[]' extensions: x-module: dnb x-controllerName: com.reltio.account360.connector.dnb.web.controller.TenantAdminResource x-path: /private/swagger.htm?module=Integration#/D&B/getTenantMapping //config/profiles/{profileName}/mappings/{mappingName}: get: tags: - D&B summary: Returns mapping from the profile by name description: >- D&B Connector Get mapping API enables you to fetch the mappings for various operations like batch, enrichment etc. performed through D&B Connector. The profileName is the D&B Connector profile specific for your tenant. You can obtain the profile name using the Get /services/config/tenants API.
You can pass the following mappingName as part of the API parameter:
batch, enrichment, filter, match, corporate_linkage operationId: getMapping parameters: - name: Authorization in: header description: ' Reltio token, in the Bearer {{YourTokenId}} format.' required: true schema: type: string - name: profileName in: path description: Profile name required: true schema: type: string - name: mappingName in: path description: Mapping name required: true schema: type: string - name: plus in: query description: This parameter can be set to true or false. schema: type: boolean default: true responses: '200': description: successful operation content: application/json: schema: type: object example: - operation: shift spec: data: matchCandidates: '*': displaySequence: >- [&1].attributes.MatchQuality[0].value.DisplaySequence[].value '@(4,context.goldenId)': - '[&1].crosswalks[0].goldenId' - '[&1].attributes.entityURI[].value' '@(4,context.dtssCustomerTenantId)': '[&1].attributes.DtssCustomerTenantId[].value' '@(4,context.entityType)': '[&1].type' '#DnB': '[&1].attributes.DnBType[].value' '#Real Time Plus': '[&1].attributes.DnBSource[].value' organization: duns: '[&2].attributes.DUNSNumber[].value' dunsControlStatus: operatingStatus: description: >- [&4].attributes.OrganizationDetail[0].value.OperatingStatus[].value primaryName: '[&2].attributes.Name[].value' telephone: '*': telephoneNumber: - >- [&4].attributes.Phone[&1].value.Number[].value - xxx '#Phone': '[&4].attributes.Phone[&1].value.Type[].value' '#true': >- [&4].attributes.Phone[&1].value.PrimaryPhoneFlag[].value isUnreachable: >- [&4].attributes.Phone[&1].value.Unreachable[].value corporateLinkage: familytreeRolesPlayed: '*': description: >- [&5].attributes.OrganizationDetail[0].value.MemberRole[].value primaryAddress: streetAddress: line1: '@': >- [&5].attributes.Address[0].value.AddressLine1[].value '@(1,line2)': >- [&5].attributes.Address[0].value.AddressLine2[].value '@(2,postalCode)': >- [&5].attributes.Address[0].value.Zip[].value.PostalCode[].value '@(2,addressLocality)': name: >- [&6].attributes.Address[0].value.City[].value '@(2,addressCountry)': name: >- [&6].attributes.Address[0].value.Country[].value '@(2,addressRegion)': abbreviatedName: >- [&6].attributes.Address[0].value.StateProvince[].value '#true': >- [&5].attributes.Address[0].value.Primary[].value '#Shipping': >- [&5].attributes.Address[0].value.AddressType[].value mailingAddress: streetAddress: line1: '@': >- [&5].attributes.Address[1].value.AddressLine1[].value '@(1,line2)': >- [&5].attributes.Address[1].value.AddressLine2[].value '@(2,postalCode)': >- [&5].attributes.Address[1].value.Zip[].value.PostalCode[].value '@(2,addressLocality)': name: >- [&6].attributes.Address[1].value.City[].value '@(2,addressCountry)': name: >- [&6].attributes.Address[1].value.Country[].value '@(2,addressRegion)': abbreviatedName: >- [&6].attributes.Address[1].value.StateProvince[].value '#Mailing': >- [&5].attributes.Address[1].value.AddressType[].value matchQualityInformation: confidenceCode: 10|9: $: >- [&4].attributes.MatchQuality[0].value.ConfidenceCode[].value '@(3,organization)': dunsControlStatus: operatingStatus: description: Active: '#true': '[&9].attributes.AutoMatchFlag[].value' '*': '#true': '[&9].attributes.SuspectMatchFlag[].value' '*': '#true': '[&4].attributes.SuspectMatchFlag[].value' $: >- [&4].attributes.MatchQuality[0].value.ConfidenceCode[].value matchGrade: >- [&2].attributes.MatchQuality[0].value.MatchGrade[].value matchDataProfileComponents: '*': componentType: Name: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.NameProfileCode[].value Street Number: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.StreetNumberProfileCode[].value Street Name: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.StreetNameProfileCode[].value City: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.CityProfileCode[].value State: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.StateProvinceProfileCode[].value PO Box: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.POBoxProfileCode[].value Phone: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.PhoneProfileCode[].value Postal Code: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.ZIPProfileCode[].value SIC: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.SICProfileCode[].value Density: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.DensityProfileCode[].value Uniqueness: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.UniquenessProfileCode[].value DUNS: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.DUNSProfileCode[].value National ID: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.NationalIDProfileCode[].value URL: '@(2,componentValue)': >- [&6].attributes.MatchQuality[0].value.URLProfileCode[].value - operation: modify-default-beta spec: '*': crosswalks: '*': type: configuration/sources/DnB value: >- =concat(@(3,attributes.DUNSNumber[0].value),'-',@(1,goldenId)) - operation: remove spec: '*': crosswalks: '*': goldenId: '' extensions: x-module: dnb x-controllerName: >- com.reltio.account360.connector.dnb.web.controller.ProfileAdminResource x-path: /private/swagger.htm?module=Integration#/D&B/getMapping post: tags: - D&B summary: Update mapping in the profile by name description: >- Enables you to update the mappings for various operations like batch, enrichment etc. performed through D&B Connector. The profileName is the D&B Connector profile specific for your tenant. You can obtain the profile name using the Get /services/config/tenants API.
You can pass the following mappingName as part of the API parameter: batch, enrichment, filter, match, corporate_linkage operationId: updateMapping parameters: - name: Authorization in: header description: ' Reltio token, in the Bearer {{YourTokenId}} format.' required: true schema: type: string - name: profileName in: path description: Profile name required: true schema: type: string - name: mappingName in: path description: Mapping name required: true schema: type: string - name: plus in: query description: This parameter can be set to true or false. schema: type: boolean default: true requestBody: description: Mapping content content: application/json: schema: $ref: '#/components/schemas/ProfileAdminResource' examples: sample: description: Sample request for API value: - operation: shift spec: data: GetCleanseMatchResponse: GetCleanseMatchResponseDetail: MatchResponseDetail: MatchCandidate: '*': '@(6,context.goldenId)': - '[&1].crosswalks[0].goldenId' - '[&1].attributes.entityURI[].value' '@(6,context.dtssCustomerTenantId)': '[&1].attributes.DtssCustomerTenantId[].value' '@(6,context.entityType)': '[&1].type' '#DnB': '[&1].attributes.DnBType[].value' '#Real Time': '[&1].attributes.DnBSource[].value' DUNSNumber: '[&1].attributes.DUNSNumber[].value' OrganizationPrimaryName: OrganizationName: \$: '[&3].attributes.Name[].value' PrimaryAddress: StreetAddressLine: '0': LineText: >- [&4].attributes.Address[0].value.AddressLine1[].value '1': LineText: >- [&4].attributes.Address[0].value.AddressLine2[].value '@(1,PrimaryTownName)': >- [&3].attributes.Address[0].value.City[].value '@(1,CountryISOAlpha2Code)': >- [&3].attributes.Address[0].value.Country[].value '@(1,PostalCode)': >- [&3].attributes.Address[0].value.Zip[].value.PostalCode[].value '@(1,TerritoryAbbreviatedName)': >- [&3].attributes.Address[0].value.StateProvince[].value '#Shipping': >- [&3].attributes.Address[0].value.AddressType[].value '#true': >- [&3].attributes.Address[0].value.Primary[].value MailingAddress: StreetAddressLine: '0': LineText: >- [&4].attributes.Address[1].value.AddressLine1[].value '1': LineText: >- [&4].attributes.Address[1].value.AddressLine2[].value '@(1,PrimaryTownName)': >- [&3].attributes.Address[1].value.City[].value '@(1,CountryISOAlpha2Code)': >- [&3].attributes.Address[1].value.Country[].value '@(1,PostalCode)': >- [&3].attributes.Address[1].value.Zip[].value.PostalCode[].value '@(1,TerritoryAbbreviatedName)': >- [&3].attributes.Address[1].value.StateProvince[].value '#Mailing': >- [&3].attributes.Address[1].value.AddressType[].value OperatingStatusText: \$: >- [&2].attributes.OrganizationDetail[0].value.OperatingStatus[].value FamilyTreeMemberRole: '*': FamilyTreeMemberRoleText: \$: >- [&4].attributes.OrganizationDetail[0].value.MemberRole[].value StandaloneOrganizationIndicator: >- [&1].attributes.IsStandaloneOrganization[].value MatchQualityInformation: ConfidenceCodeValue: 10|9: $: >- [&4].attributes.MatchQuality[0].value.ConfidenceCode[].value '@(3,OperatingStatusText)': \$: Active: '#true': '[&7].attributes.AutoMatchFlag[].value' '*': '#true': '[&7].attributes.SuspectMatchFlag[].value' 8|7|6|5: '#true': '[&4].attributes.SuspectMatchFlag[].value' $: >- [&4].attributes.MatchQuality[0].value.ConfidenceCode[].value '*': $: >- [&4].attributes.MatchQuality[0].value.ConfidenceCode[].value MatchGradeText: >- [&2].attributes.MatchQuality[0].value.MatchGradeText[].value MatchDataProfileText: >- [&2].attributes.MatchQuality[0].value.MatchDataProfileText[].value TelephoneNumber: TelecommunicationNumber: >- [&2].attributes.Phone[0].value.Number[].value '#Phone': >- [&2].attributes.Phone[0].value.Type[].value '#true': >- [&2].attributes.Phone[0].value.PrimaryPhoneFlag[].value - operation: modify-default-beta spec: '*': crosswalks: '*': type: configuration/sources/DnB value: >- =concat(@(3,attributes.DUNSNumber[0].value),'-',@(1,goldenId)) - operation: remove spec: '*': crosswalks: '*': goldenId: '' required: true responses: '200': description: successful operation content: application/json: schema: type: object example: - operation: shift spec: data: GetCleanseMatchResponse: GetCleanseMatchResponseDetail: MatchResponseDetail: MatchCandidate: '*': '@(6,context.goldenId)': - '[&1].crosswalks[0].goldenId' - '[&1].attributes.entityURI[].value' '@(6,context.dtssCustomerTenantId)': '[&1].attributes.DtssCustomerTenantId[].value' '@(6,context.entityType)': '[&1].type' '#DnB': '[&1].attributes.DnBType[].value' '#Real Time': '[&1].attributes.DnBSource[].value' DUNSNumber: '[&1].attributes.DUNSNumber[].value' OrganizationPrimaryName: OrganizationName: \$: '[&3].attributes.Name[].value' PrimaryAddress: StreetAddressLine: '0': LineText: >- [&4].attributes.Address[0].value.AddressLine1[].value '1': LineText: >- [&4].attributes.Address[0].value.AddressLine2[].value '@(1,PrimaryTownName)': >- [&3].attributes.Address[0].value.City[].value '@(1,CountryISOAlpha2Code)': >- [&3].attributes.Address[0].value.Country[].value '@(1,PostalCode)': >- [&3].attributes.Address[0].value.Zip[].value.PostalCode[].value '@(1,TerritoryAbbreviatedName)': >- [&3].attributes.Address[0].value.StateProvince[].value '#Shipping': >- [&3].attributes.Address[0].value.AddressType[].value '#true': >- [&3].attributes.Address[0].value.Primary[].value MailingAddress: StreetAddressLine: '0': LineText: >- [&4].attributes.Address[1].value.AddressLine1[].value '1': LineText: >- [&4].attributes.Address[1].value.AddressLine2[].value '@(1,PrimaryTownName)': >- [&3].attributes.Address[1].value.City[].value '@(1,CountryISOAlpha2Code)': >- [&3].attributes.Address[1].value.Country[].value '@(1,PostalCode)': >- [&3].attributes.Address[1].value.Zip[].value.PostalCode[].value '@(1,TerritoryAbbreviatedName)': >- [&3].attributes.Address[1].value.StateProvince[].value '#Mailing': >- [&3].attributes.Address[1].value.AddressType[].value OperatingStatusText: \$: >- [&2].attributes.OrganizationDetail[0].value.OperatingStatus[].value FamilyTreeMemberRole: '*': FamilyTreeMemberRoleText: \$: >- [&4].attributes.OrganizationDetail[0].value.MemberRole[].value StandaloneOrganizationIndicator: >- [&1].attributes.IsStandaloneOrganization[].value MatchQualityInformation: ConfidenceCodeValue: 10|9: $: >- [&4].attributes.MatchQuality[0].value.ConfidenceCode[].value '@(3,OperatingStatusText)': \$: Active: '#true': '[&7].attributes.AutoMatchFlag[].value' '*': '#true': '[&7].attributes.SuspectMatchFlag[].value' 8|7|6|5: '#true': '[&4].attributes.SuspectMatchFlag[].value' $: >- [&4].attributes.MatchQuality[0].value.ConfidenceCode[].value '*': $: >- [&4].attributes.MatchQuality[0].value.ConfidenceCode[].value MatchGradeText: >- [&2].attributes.MatchQuality[0].value.MatchGradeText[].value MatchDataProfileText: >- [&2].attributes.MatchQuality[0].value.MatchDataProfileText[].value TelephoneNumber: TelecommunicationNumber: >- [&2].attributes.Phone[0].value.Number[].value '#Phone': '[&2].attributes.Phone[0].value.Type[].value' '#true': >- [&2].attributes.Phone[0].value.PrimaryPhoneFlag[].value - operation: modify-default-beta spec: '*': crosswalks: '*': type: configuration/sources/DnB value: >- =concat(@(3,attributes.DUNSNumber[0].value),'-',@(1,goldenId)) - operation: remove spec: '*': crosswalks: '*': goldenId: '' extensions: x-module: dnb x-controllerName: >- com.reltio.account360.connector.dnb.web.controller.ProfileAdminResource x-codegen-request-body-name: body x-path: /private/swagger.htm?module=Integration#/D&B/updateMapping //config/tenants: get: tags: - D&B summary: Obtain profile name by a tenant description: >- You can object the D&B Connector profile name configured for your tenant. You use this profile to obtain, and update the mappings for your D&B connector setup operationId: profileByTenant parameters: - name: environmentUrl in: header description: ' The URL of the environment.' required: true schema: type: string - name: tenantId in: header description: ' The ID of the tenant.' required: true schema: type: string - name: Authorization in: header description: ' The access token in the Bearer format.' required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ConfigResponse' example: success: OK tenant: environmentUrl: https://tst-01.reltio.com tenantId: ACC360CT profile: tst-01-nested extensions: x-module: dnb x-controllerName: com.reltio.account360.connector.dnb.web.controller.TenantAdminResource x-path: /private/swagger.htm?module=Integration#/D&B/profileByTenant //dnb/batch/restart/{jobId}: post: tags: - D&B summary: Restart an inactive job based on the Job ID specified in the request description: Restart an inactive job based on the Job ID specified in the request operationId: restartJob parameters: - name: jobId in: header description: ' The ID of the Job that must be restarted.' required: true schema: type: string - name: environmentUrl in: header description: ' The URL of the environment.' required: true schema: type: string - name: tenantId in: header description: ' The ID of the tenant for which the organization match is required.' required: true schema: type: string - name: Authorization in: header description: ' The access token in the Bearer format.' schema: type: string requestBody: {} responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/BatchScheduleProcessResponse' extensions: x-module: dnb x-controllerName: >- com.reltio.account360.connector.dnb.web.controller.DnbConnectorResource x-path: /private/swagger.htm?module=Integration#/D&B/restartJob //dnb/batch/{jobId}: get: tags: - D&B summary: Retrieves the job status by using the Job ID operationId: getJobByTenant parameters: - name: jobId in: header description: ' The ID of the Job for which the details are required.' required: true schema: type: string - name: environmentUrl in: header description: ' The URL of the environment.' required: true schema: type: string - name: tenantId in: header description: ' The ID of the tenant for which the organization match is required.' required: true schema: type: string - name: Authorization in: header description: ' The access token in the Bearer format.' schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/BatchJobStatusResponse' extensions: x-module: dnb x-controllerName: >- com.reltio.account360.connector.dnb.web.controller.DnbConnectorResource x-path: /private/swagger.htm?module=Integration#/D&B/getJobByTenant post: tags: - D&B summary: Cancel an active job based on the Job ID specified in the request description: >- Cancel an active job based on the Job ID specified in the request. Use DELETE request to do it. operationId: cancelJob parameters: - name: jobId in: header description: ' The ID of the Job that must be canceled.' required: true schema: type: string - name: environmentUrl in: header description: ' The URL of the environment.' required: true schema: type: string - name: tenantId in: header description: ' The ID of the tenant for which the organization match is required.' required: true schema: type: string - name: Authorization in: header description: ' The access token in the Bearer format.' schema: type: string requestBody: {} responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/BatchScheduleProcessResponse' extensions: x-module: dnb x-controllerName: >- com.reltio.account360.connector.dnb.web.controller.DnbConnectorResource x-path: /private/swagger.htm?module=Integration#/D&B/cancelJob //dnb/getOrgMatch: put: tags: - D&B summary: >- Get Match API returns the D&B DUNS number using the basic account data like name and address description: >- The Get Match API is called by external service on entity created event and provides an entity JSON body. operationId: getOrgMatchByTenantEntityProvided parameters: - name: plus in: query schema: type: boolean default: false - name: disableNestedPartialOverride in: query schema: type: boolean default: true - name: partialOverride in: query schema: type: boolean default: true - name: updateAttributeUpdateDates in: query schema: type: boolean default: false - name: environmentUrl in: header required: true schema: type: string - name: tenantId in: header required: true schema: type: string - name: Authorization in: header required: true schema: type: string - name: DnB-Token in: header schema: type: string - name: DnB-User in: header schema: type: string - name: DnB-Password in: header schema: type: string requestBody: {} responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/RealtimeAPIResponse' extensions: x-module: dnb x-controllerName: >- com.reltio.account360.connector.dnb.web.controller.DnbConnectorResource x-path: >- /private/swagger.htm?module=Integration#/D&B/getOrgMatchByTenantEntityProvided post: tags: - D&B summary: >- Get Match API returns the D&B DUNS number using the basic account data like name and address description: >- The Get Match API is called using the Get Match button on the UI. It is a real time API, that uses the account data like name and address and returns the D&B DUNS number.
The D&B DUNS number is updated in the Reltio account profile. If more than one DUNS numbers are found, multiple account profiles with matching criteria are returned and updated in the associated data tenant. If no match is found, the API returns an error with an appropriate message. operationId: getOrgMatchByTenant parameters: - name: disableNestedPartialOverride in: query schema: type: boolean default: true - name: partialOverride in: query schema: type: boolean default: true - name: updateAttributeUpdateDates in: query schema: type: boolean default: false - name: environmentUrl in: header description: The URL of the environment. required: true schema: type: string example: https://dev.reltio.com - name: tenantId in: header description: The ID of the tenant for which the organization match is required. required: true schema: type: string - name: Authorization in: header description: The access token in the Bearer <token> format. schema: type: string example: Bearer b6b01623-1dee-4702-a477-d35581e4f3be - name: DnB-Token in: header description: >- The D&B token in the Bearer: <> format. This parameter is required if you do not specify D&B-User and D&B-Password. schema: type: string - name: DnB-User in: header description: >- The D&B account username or Consumer Key in Direct+. You must specify this if the access token is not specified for authorization. schema: type: string - name: DnB-Password in: header description: >- The D&B account password or Consumer Secret in Direct+. You must specify this if the access token is not specified for authorization. schema: type: string - name: entityURI in: query description: Entity URIs in the entities/XXXX format. required: true schema: type: string example: entities/1QvQsDUm - name: plus in: query description: >- This parameter can be set to true or false. If set to true, Direct+ based Get Org Match call is started. Note: You must have a token or an account with the privileges for Direct+ API usage. Otherwise, an authentication error is raised. schema: type: boolean default: false requestBody: {} responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/RealtimeAPIResponse' example: success: OK message: 1 Match(es) entities: - entities/1GsuMoU2 extensions: x-module: dnb x-controllerName: >- com.reltio.account360.connector.dnb.web.controller.DnbConnectorResource x-path: /private/swagger.htm?module=Integration#/D&B/getOrgMatchByTenant //dnb/monitoring/background: post: tags: - D&B summary: >- Start or schedule background process to handle events for the monitoring registration description: >- A monitoring background job is a process that lists the event's destination, reads event files and notification files, and uploads them to the corresponding Reltio tenant. The destination, for now, is the S3 bucket only. The monitoring background job can be started manually to immediately process incoming data or can be scheduled using a cron expression.