Subscriptions API
Learn about Subscriptions API to configure subscriptions between your data tenants and customer tenants.
Request
Tenant subscription enables you to request and obtain data from a Data Tenant to a Customer Tenant.
POST {DTSSURL}/subscriptionsSample Request Body
[
{
"dataTenant": {
"id": "{dataTenantId}"
},
"customerTenant": {
"id": "{customerTenantId}"
},
"bringGoldenRecord": "{bringGoldenRecord}",
"bringInternalSources": "{bringInternalSources}",
"mappings": "{mappings}",
"security": "{security}",
"eventsConfiguration": "{eventsConfiguration}",
"importRelationsConfig": "{importConnectionConfiguration}",
"groupContributors": "{groupContributors}",
"supportEmail": "{email}",
"fullImportLogCF": "{cassandraColumnFamily}",
"fullImportLogESIndex": "{elasticsearchIndex}"
}
]Request Example
{
"dataTenant": {
"id": "DTData"
},
"customerTenant": {
"id": "TestData"
},
"bringGoldenRecord": false,
"bringInternalSources": [
"configuration/sources/Veeva",
"configuration/sources/AMA"
],
"id": "DTData_TestData",
"mappings": [
{
"copyFromDT": "configuration/entityTypes/HCP",
"copyToCT": "configuration/entityTypes/HCP",
"attributes": [
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/FirstName",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/FirstName"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/LastName",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/LastName"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/MiddleName",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/MiddleName"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Prefix",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Prefix"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/SuffixName",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/SuffixName"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Phone",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Phone"
],
"attributes": [
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Phone/attributes/Active",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Phone/attributes/Active"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Phone/attributes/AreaCode",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Phone/attributes/AreaCode"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Phone/attributes/CountryCode",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Phone/attributes/CountryCode"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Phone/attributes/DigitCount",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Phone/attributes/DigitCount"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Phone/attributes/FormatMask",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Phone/attributes/FormatMask"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Phone/attributes/GeoArea",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Phone/attributes/GeoArea"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Phone/attributes/GeoCountry",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Phone/attributes/GeoCountry"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Phone/attributes/LineType",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Phone/attributes/LineType"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Phone/attributes/LocalNumber",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Phone/attributes/LocalNumber"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Phone/attributes/Number",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Phone/attributes/Number"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Phone/attributes/Type",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Phone/attributes/Type"
],
"transformValue": [
{
"from": "Business",
"to": "Work"
}
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Phone/attributes/ValidationStatus",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Phone/attributes/ValidationStatus"
]
}
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/ProfDesignation",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/AccountType"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Specialities",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Specialities"
],
"attributes": [
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Specialities/attributes/Rank",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Specialities/attributes/Rank"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Specialities/attributes/Specialty",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Specialities/attributes/Specialty"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Specialities/attributes/SpecialtyType",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Specialities/attributes/SpecialtyType"
]
}
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/License",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/License"
],
"attributes": [
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/License/attributes/ExpirationDate",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/License/attributes/ExpirationDate"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/License/attributes/Number",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/License/attributes/Number"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/License/attributes/State",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/License/attributes/State"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/License/attributes/Status",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/License/attributes/Status"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/License/attributes/WorkType",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/License/attributes/WorkType"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/License/attributes/Qualifier",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/License/attributes/Qualifier"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/License/attributes/SubQualifier",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/License/attributes/SubQualifier"
]
}
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Identifiers",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Identifiers"
],
"attributes": [
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Identifiers/attributes/Rank",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Identifiers/attributes/Rank"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Identifiers/attributes/Status",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Identifiers/attributes/Status"
]
}
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Credentials",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Credentials"
]
},
{
"copyFromDT": "configuration/entityTypes/HCP/attributes/Address",
"copyToCT": [
"configuration/entityTypes/HCP/attributes/Address"
]
}
]
},
{
"copyFromDT": "configuration/entityTypes/Location",
"copyToCT": "configuration/entityTypes/Location",
"attributes": [
{
"copyFromDT": "configuration/entityTypes/Location/attributes/AddressLine1",
"copyToCT": [
"configuration/entityTypes/Location/attributes/AddressLine1"
]
},
{
"copyFromDT": "configuration/entityTypes/Location/attributes/AddressLine2",
"copyToCT": [
"configuration/entityTypes/Location/attributes/AddressLine2"
]
},
{
"copyFromDT": "configuration/entityTypes/Location/attributes/City",
"copyToCT": [
"configuration/entityTypes/Location/attributes/City"
]
},
{
"copyFromDT": "configuration/entityTypes/Location/attributes/StateProvince",
"copyToCT": [
"configuration/entityTypes/Location/attributes/StateProvince"
]
},
{
"copyFromDT": "configuration/entityTypes/Location/attributes/SubAdministrativeArea",
"copyToCT": [
"configuration/entityTypes/Location/attributes/SubAdministrativeArea"
]
},
{
"copyFromDT": "configuration/entityTypes/Location/attributes/Country",
"copyToCT": [
"configuration/entityTypes/Location/attributes/Country"
]
},
{
"copyFromDT": "configuration/entityTypes/Location/attributes/Zip",
"copyToCT": [
"configuration/entityTypes/Location/attributes/Zip"
],
"attributes": [
{
"copyFromDT": "configuration/entityTypes/Location/attributes/Zip/attributes/Zip5",
"copyToCT": [
"configuration/entityTypes/Location/attributes/Zip/attributes/Zip5"
]
},
{
"copyFromDT": "configuration/entityTypes/Location/attributes/Zip/attributes/Zip4",
"copyToCT": [
"configuration/entityTypes/Location/attributes/Zip/attributes/Zip4"
]
}
]
}
]
},
{
"copyFromDT": "configuration/relationTypes/HasAddress",
"copyToCT": "configuration/relationTypes/HasAddress",
"filter": [
{
"attribute": "configuration/relationTypes/HasAddress/attributes/AddressRank",
"values": [
"1",
"2"
]
}
],
"attributes": [
{
"copyFromDT": "configuration/relationTypes/HasAddress/attributes/AddressRank",
"copyToCT": [
"configuration/relationTypes/HasAddress/attributes/AddressRank"
],
"transformValue": [
{
"from": "1",
"to": "0"
},
{
"from": "2",
"to": "0"
}
]
},
{
"copyFromDT": "configuration/relationTypes/HasAddress/attributes/AddressType",
"copyToCT": [
"configuration/relationTypes/HasAddress/attributes/AddressType"
]
},
{
"copyFromDT": "configuration/relationTypes/HasAddress/attributes/Phone",
"copyToCT": [
"configuration/relationTypes/HasAddress/attributes/Phone"
],
"attributes": [
{
"copyFromDT": "configuration/relationTypes/HasAddress/attributes/Phone/attributes/Active",
"copyToCT": [
"configuration/relationTypes/HasAddress/attributes/Phone/attributes/Active"
]
},
{
"copyFromDT": "configuration/relationTypes/HasAddress/attributes/Phone/attributes/Type",
"copyToCT": [
"configuration/relationTypes/HasAddress/attributes/Phone/attributes/Type"
],
"transformValue": [
{
"from": "Business",
"to": "Work"
}
]
},
{
"copyFromDT": "configuration/relationTypes/HasAddress/attributes/Phone/attributes/Rank",
"copyToCT": [
"configuration/relationTypes/HasAddress/attributes/Phone/attributes/Rank"
]
},
{
"copyFromDT": "configuration/relationTypes/HasAddress/attributes/Phone/attributes/Number",
"copyToCT": [
"configuration/relationTypes/HasAddress/attributes/Phone/attributes/Number"
]
}
]
},
{
"copyFromDT": "configuration/relationTypes/HasAddress/attributes/DEA",
"copyToCT": [
"configuration/relationTypes/HasAddress/attributes/DEA"
],
"attributes": [
{
"copyFromDT": "configuration/relationTypes/HasAddress/attributes/DEA/attributes/Number",
"copyToCT": [
"configuration/relationTypes/HasAddress/attributes/DEA/attributes/Number"
]
},
{
"copyFromDT": "configuration/relationTypes/HasAddress/attributes/DEA/attributes/ExpirationDate",
"copyToCT": [
"configuration/relationTypes/HasAddress/attributes/DEA/attributes/ExpirationDate"
]
},
{
"copyFromDT": "configuration/relationTypes/HasAddress/attributes/DEA/attributes/Status",
"copyToCT": [
"configuration/relationTypes/HasAddress/attributes/DEA/attributes/Status"
]
}
]
}
]
}
],
"synchronizationConfig": {
"dtSyncType": "REALTIME",
"ctSyncType": "REALTIME",
"entities": [
{
"action": "AUTOSUBSCRIBE",
"types": [
"configuration/entityTypes/HCP"
],
"matchRules": [
"configuration/entityTypes/HCP/matchGroups/PersonByMEAuto",
"configuration/entityTypes/HCP/matchGroups/PersonByMESuspect2"
],
"filter": "<filter>"
}
],
"relationTypes": [
{
"types": [
"configuration/relationTypes/AffiliatedWith"
],
"action": "COPY"
}
]
},
"importRelationsConfig": {
"defaultStrategy": "ALL",
"strategyPerRelationType": []
},
"groupContributors": true,
"supportEmail": "example@mail.com"
}