Retrieve Portfolio Asset
| Products | D&B Direct 2.0, D&B Direct Onboard |
| Product Code(s) | Not Applicable |
| Options(s) | None |
| Monitoring Available | No |
| Interface | REST |
| Method | GET |
| Format(s) | JSON |
| Service | Portfolio |
| {version} | 2.0 |
| Initial Release | October 3, 2013 |
Returns the previously ordered product as a base 64 encoded MTOM attachment.
Update History
No modifications have been made to this data layer since the initial release.
What to do First
Before you can retrieve or delete an asset(s), you need to perform the following operation to obtain the asset ID value(s).
Feature Request
IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.
Overview
D&B Direct customers are assigned a temporary storage area where copies of the data and report products requested via the API can be retained for 120 days (extendable up to 365 days or remaining length of the current contract, whichever is less). This portfolio feature provides a convenient way to retrieve previously accessed information for comparison or recovery purposes.
When the archiving option is selected, a portfolio asset ID is returned by requests for a D&B Direct data or report product. This asset ID can be used to retrieve the copied information from the portfolio. Alternatively, a separate service exists that can be used to obtain a list of the portfolio contents.
Three operations (List, Retrieve and Delete) are provided to access and manage the information contained in the Product Request Archive.
Data Layer Entitlement
For customers in U.S. and Canadian markets, the API is provisioned for specific collections of products, reports, and/or features (collectively referred to as data layers) for production and trial usage. Entitlement is not required for testing in the sandbox environment.
- This particular feature does not require entitlement for production and trial usage for D&B Direct 2.0 customers.
For customers in the UK, Ireland, Belgium, Netherlands and Luxembourg markets, the API is provisioned as a specific set of data layers for production, trial, and sandbox usage.
- This particular data layer is included in the D&B Direct Onboard 2.0 suite.
Specification
https://direct.dnb.com/V2/assets/35875432 Authorization:<MyToken>
| Name | Characteristics |
|---|---|
| ApplicationTransactionID | string up to 64 chars., Optional |
| TransactionTimestamp | dateTime, Optional |
| SubmittingOfficeID | string up to 64 chars., Optional |
| {assetID} | PortfolioAssetIDType, Optional |
| InvestigationTrackingID | InvestigationTrackingID at least 1 chars. up to 50 chars., Optional |
| IncludeAttachmentIndicator | boolean, Optional |
Previously ordered products may also be retrieved by using the RetrieveProduct (REST) operation when the specific product code is known.
Endpoint
Use the following endpoint for requesting this feature. The {version} is dependent on the underlying service delivering the response.
| Endpoint (Portfolio) |
|---|
| GET https://direct.dnb.com/V{version}/assets/{assetid} |
Testing
This operation will function the same regardless of the environment. Portfolio operation requests made in the D&B Direct sandbox (test) environment will return results based on any previous product calls performed using sandbox credentials.
Feature Response
NOTE: The D&B Direct REST implementation uses the BadgerFish approach for JSON with some minor variations.
Specification
The following is a list of the possible data fields returned by this operation in the JSON response. Samples are provided for testing successful and failed retrieval, and to demonstrate the basic layout of a response. The data returned in samples may not represent actual values that this feature will deliver.
NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.
{"RetrievePortfolioAssetResponse": {
"@ServiceVersionNumber": "",
"TransactionDetail": {
"ApplicationTransactionID": null,
"ServiceTransactionID": "Id-064975ca527ba8e010fb470b-1",
"TransactionTimestamp": "2013-11-07T09:51:12.299-05:00"
},
"TransactionResult": {
"SeverityText": "Information",
"ResultID": "CM000",
"ResultText": "Success"
},
"RetrievePortfolioAssetResponseDetail": {
"SubjectDetail": {
"DUNSNumber": "241019574",
"OrganizationPrimaryName": {"OrganizationName": {"$": "Canadian Test Case 5"}},
"PrimaryAddress": {
"StreetAddressLine": [{"LineText": "5770 Hurontario St"}],
"PrimaryTownName": "MISSISSAUGA",
"CountryISOAlpha2Code": "CA",
"FullPostalCode": "L5R 3G5"
}
},
"OrderTimestamp": "2013-11-07T09:49:49.009-05:00",
"ApplicationTransactionID": "Id-238fa04b527ba88c13cb742e-2",
"Product": [ {
"ArchiveDetail": {
"ExtendArchivePeriodIndicator": false,
"PortfolioAssetID": 35875432
},
"DNBProductID": "DCP_STD",
"DNBProductName": "Firmographics Marketing Basic",
"UserReadIndicator": false,
"GroupAdminReadIndicator": false,
"ObjectAttachment": [ {
"ContentObject": "PE9yZGVyUHJvZHVjdFJlc3BvbnNlRGV0YWlsIHhtbG5zOnNvYXBlbnY9Imh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3NvYXAvZW52ZWxvcGUvIiB4bWxuczpjdXM9Imh0dHA6Ly9zZXJ2aWNlcy5kbmIuY29tL0N1c3RvbVByb2R1Y3RTZXJ2aWNlVjIuMCIgeG1sbnM6c29hcC1lbnY9Imh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3NvYXAvZW52ZWxvcGUvIiB4bWxuczp4c2k9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIj48SW5xdWlyeURldGFpbD48RFVOU051bWJlcj4yNDEwMTk1NzQ8L0RVTlNOdW1iZXI+PENvdW50cnlJU09BbHBoYTJDb2RlPkNBPC9Db3VudHJ5SVNPQWxwaGEyQ29kZT48L0lucXVpcnlEZXRhaWw+PFByb2R1Y3Q+PEROQlByb2R1Y3RJRD5EQ1BfU1REPC9ETkJQcm9kdWN0SUQ+PE9yZ2FuaXphdGlvbj48U3ViamVjdEhlYWRlcj48RFVOU051bWJlcj4yNDEwMTk1NzQ8L0RVTlNOdW1iZXI+PE9yZ2FuaXphdGlvblN1bW1hcnlUZXh0PkJ1c2luZXNzIHNlcnZpY2VzLCBuZWMsIG5zazwvT3JnYW5pemF0aW9uU3VtbWFyeVRleHQ+PExhc3RVcGRhdGVEYXRlPjIwMTItMDYtMjA8L0xhc3RVcGRhdGVEYXRlPjxNYXJrZXRhYmlsaXR5SW5kaWNhdG9yPmZhbHNlPC9NYXJrZXRhYmlsaXR5SW5kaWNhdG9yPjxOb25NYXJrZXRhYmxlUmVhc29uVGV4dCBETkJDb2RlVmFsdWU9IjExMDI4Ij5EZS1saXN0ZWQ8L05vbk1hcmtldGFibGVSZWFzb25UZXh0PjxOb25NYXJrZXRhYmxlUmVhc29uVGV4dCBETkJDb2RlVmFsdWU9IjI1ODM3Ij5JbnN1ZmZpY2llbnQgRGF0YTwvTm9uTWFya2V0YWJsZVJlYXNvblRleHQ+PC9TdWJqZWN0SGVhZGVyPjxMb2NhdGlvbj48UHJpbWFyeUFkZHJlc3M+PFN0cmVldEFkZHJlc3NMaW5lPgogICAgICAgICAgPExpbmVUZXh0PjU3NzAgSHVyb250YXJpbyBTdDwvTGluZVRleHQ+CiAgICAgICAgPC9TdHJlZXRBZGRyZXNzTGluZT48UHJpbWFyeVRvd25OYW1lPk1JU1NJU1NBVUdBPC9QcmltYXJ5VG93bk5hbWU+PENvdW50cnlJU09BbHBoYTJDb2RlPkNBPC9Db3VudHJ5SVNPQWxwaGEyQ29kZT48VGVycml0b3J5QWJicmV2aWF0ZWROYW1lPk9OPC9UZXJyaXRvcnlBYmJyZXZpYXRlZE5hbWU+PFBvc3RhbENvZGU+TDVSIDNHNTwvUG9zdGFsQ29kZT48Q291bnRyeUdyb3VwTmFtZT5Ob3J0aCBBbWVyaWNhPC9Db3VudHJ5R3JvdXBOYW1lPjxVbmRlbGl2ZXJhYmxlSW5kaWNhdG9yPmZhbHNlPC9VbmRlbGl2ZXJhYmxlSW5kaWNhdG9yPjxSZWdpc3RlcmVkQWRkcmVzc0luZGljYXRvcj5mYWxzZTwvUmVnaXN0ZXJlZEFkZHJlc3NJbmRpY2F0b3I+PFJlc2lkZW50aWFsQWRkcmVzc0luZGljYXRvcj5mYWxzZTwvUmVzaWRlbnRpYWxBZGRyZXNzSW5kaWNhdG9yPjwvUHJpbWFyeUFkZHJlc3M+PE1haWxpbmdBZGRyZXNzPjxDb3VudHJ5SVNPQWxwaGEyQ29kZT5DQTwvQ291bnRyeUlTT0FscGhhMkNvZGU+PC9NYWlsaW5nQWRkcmVzcz48L0xvY2F0aW9uPjxPcmdhbml6YXRpb25OYW1lPjxPcmdhbml6YXRpb25QcmltYXJ5TmFtZT4KICAgICAgICA8T3JnYW5pemF0aW9uTmFtZT5DYW5hZGlhbiBUZXN0IENhc2UgNTwvT3JnYW5pemF0aW9uTmFtZT4KICAgICAgPC9Pcmdhbml6YXRpb25QcmltYXJ5TmFtZT48L09yZ2FuaXphdGlvbk5hbWU+PE9yZ2FuaXphdGlvbkRldGFpbD48U3RhbmRhbG9uZU9yZ2FuaXphdGlvbkluZGljYXRvcj50cnVlPC9TdGFuZGFsb25lT3JnYW5pemF0aW9uSW5kaWNhdG9yPjxDb250cm9sT3duZXJzaGlwRGF0ZT4yMDAwPC9Db250cm9sT3duZXJzaGlwRGF0ZT48Q29udHJvbE93bmVyc2hpcFR5cGVUZXh0IEROQkNvZGVWYWx1ZT0iMCI+VW5rbm93bjwvQ29udHJvbE93bmVyc2hpcFR5cGVUZXh0PjxPcGVyYXRpbmdTdGF0dXNUZXh0IEROQkNvZGVWYWx1ZT0iOTA3NCI+QWN0aXZlPC9PcGVyYXRpbmdTdGF0dXNUZXh0PjxPcmdhbml6YXRpb25TdGFydFllYXI+MjAwMDwvT3JnYW5pemF0aW9uU3RhcnRZZWFyPjwvT3JnYW5pemF0aW9uRGV0YWlsPjxSZWdpc3RlcmVkRGV0YWlsPjxJbmNvcnBvcmF0aW9uWWVhcj4yMDAwPC9JbmNvcnBvcmF0aW9uWWVhcj48L1JlZ2lzdGVyZWREZXRhaWw+PEluZHVzdHJ5Q29kZT48SW5kdXN0cnlDb2RlIEROQkNvZGVWYWx1ZT0iMjU4MzgiIFR5cGVUZXh0PSJEJmFtcDtCIEhvb3ZlcnMgSW5kdXN0cnkgQ29kZSI+CiAgICAgICAgPEluZHVzdHJ5Q29kZT4xMDU0PC9JbmR1c3RyeUNvZGU+CiAgICAgICAgPEluZHVzdHJ5Q29kZURlc2NyaXB0aW9uIExhbmd1YWdlQ29kZT0iMzkiIEluZHVzdHJ5Q29kZURlc2NyaXB0aW9uTGVuZ3RoQ29kZT0iOTEyMCI+QnVzaW5lc3MgU2VydmljZXMgU2VjdG9yPC9JbmR1c3RyeUNvZGVEZXNjcmlwdGlvbj4KICAgICAgICA8RGlzcGxheVNlcXVlbmNlPjE8L0Rpc3BsYXlTZXF1ZW5jZT4KICAgICAgPC9JbmR1c3RyeUNvZGU+PEluZHVzdHJ5Q29kZSBETkJDb2RlVmFsdWU9IjI1ODM4IiBUeXBlVGV4dD0iRCZhbXA7QiBIb292ZXJzIEluZHVzdHJ5IENvZGUiPgogICAgICAgIDxJbmR1c3RyeUNvZGU+MTA1NDwvSW5kdXN0cnlDb2RlPgogICAgICAgIDxJbmR1c3RyeUNvZGVEZXNjcmlwdGlvbiBMYW5ndWFnZUNvZGU9IjM5IiBJbmR1c3RyeUNvZGVEZXNjcmlwdGlvbkxlbmd0aENvZGU9IjkxMjAiPkJ1c2luZXNzIFNlcnZpY2VzIFNlY3RvcjwvSW5kdXN0cnlDb2RlRGVzY3JpcHRpb24+CiAgICAgIDwvSW5kdXN0cnlDb2RlPjxJbmR1c3RyeUNvZGUgRE5CQ29kZVZhbHVlPSI3MDAiIFR5cGVUZXh0PSJOQUlDUyI+CiAgICAgICAgPEluZHVzdHJ5Q29kZT41NjE0OTk8L0luZHVzdHJ5Q29kZT4KICAgICAgICA8SW5kdXN0cnlDb2RlRGVzY3JpcHRpb24gTGFuZ3VhZ2VDb2RlPSIzOSIgSW5kdXN0cnlDb2RlRGVzY3JpcHRpb25MZW5ndGhDb2RlPSI5MTIwIj5BbGwgT3RoZXIgQnVzaW5lc3MgU3VwcG9ydCBTZXJ2aWNlczwvSW5kdXN0cnlDb2RlRGVzY3JpcHRpb24+CiAgICAgICAgPERpc3BsYXlTZXF1ZW5jZT4xPC9EaXNwbGF5U2VxdWVuY2U+CiAgICAgIDwvSW5kdXN0cnlDb2RlPjxJbmR1c3RyeUNvZGUgRE5CQ29kZVZhbHVlPSI3MDAiIFR5cGVUZXh0PSJOQUlDUyI+CiAgICAgICAgPEluZHVzdHJ5Q29kZT41NjE0OTk8L0luZHVzdHJ5Q29kZT4KICAgICAgICA8SW5kdXN0cnlDb2RlRGVzY3JpcHRpb24gTGFuZ3VhZ2VDb2RlPSIzOSIgSW5kdXN0cnlDb2RlRGVzY3JpcHRpb25MZW5ndGhDb2RlPSI5MTIwIj5BbGwgT3RoZXIgQnVzaW5lc3MgU3VwcG9ydCBTZXJ2aWNlczwvSW5kdXN0cnlDb2RlRGVzY3JpcHRpb24+CiAgICAgIDwvSW5kdXN0cnlDb2RlPjxJbmR1c3RyeUNvZGUgRE5CQ29kZVZhbHVlPSIyMTE4MiIgVHlwZVRleHQ9IlVLIFNJQyAyMDAzIj4KICAgICAgICA8SW5kdXN0cnlDb2RlPjc0LjgwMDwvSW5kdXN0cnlDb2RlPgogICAgICAgIDxEaXNwbGF5U2VxdWVuY2U+MTwvRGlzcGxheVNlcXVlbmNlPgogICAgICA8L0luZHVzdHJ5Q29kZT48SW5kdXN0cnlDb2RlIEROQkNvZGVWYWx1ZT0iMjExODIiIFR5cGVUZXh0PSJVSyBTSUMgMjAwMyI+CiAgICAgICAgPEluZHVzdHJ5Q29kZT43NC44MDA8L0luZHVzdHJ5Q29kZT4KICAgICAgICA8SW5kdXN0cnlDb2RlRGVzY3JpcHRpb24+TWlzY2VsbGFuZW91cyBidXNpbmVzcyBhY3Rpdml0aWVzIG5vdCBlbHNld2hlcmUgY2xhc3NpZmllZDwvSW5kdXN0cnlDb2RlRGVzY3JpcHRpb24+CiAgICAgIDwvSW5kdXN0cnlDb2RlPjxJbmR1c3RyeUNvZGUgRE5CQ29kZVZhbHVlPSIzNTk5IiBUeXBlVGV4dD0iRCZhbXA7QiBTdGFuZGFyZCBJbmR1c3RyeSBDb2RlIj4KICAgICAgICA8SW5kdXN0cnlDb2RlPjczODkwMDAwPC9JbmR1c3RyeUNvZGU+CiAgICAgICAgPEluZHVzdHJ5Q29kZURlc2NyaXB0aW9uIExhbmd1YWdlQ29kZT0iMzkiIEluZHVzdHJ5Q29kZURlc2NyaXB0aW9uTGVuZ3RoQ29kZT0iMjEyMSI+QlVTSU5FU1MgU0VSVklDRVM8L0luZHVzdHJ5Q29kZURlc2NyaXB0aW9uPgogICAgICAgIDxEaXNwbGF5U2VxdWVuY2U+MTwvRGlzcGxheVNlcXVlbmNlPgogICAgICA8L0luZHVzdHJ5Q29kZT48SW5kdXN0cnlDb2RlIEROQkNvZGVWYWx1ZT0iMzU5OSIgVHlwZVRleHQ9IkQmYW1wO0IgU3RhbmRhcmQgSW5kdXN0cnkgQ29kZSI+CiAgICAgICAgPEluZHVzdHJ5Q29kZT43Mzg5MDAwMDwvSW5kdXN0cnlDb2RlPgogICAgICAgIDxJbmR1c3RyeUNvZGVEZXNjcmlwdGlvbiBMYW5ndWFnZUNvZGU9IjM5IiBJbmR1c3RyeUNvZGVEZXNjcmlwdGlvbkxlbmd0aENvZGU9IjIxMjEiPkJVU0lORVNTIFNFUlZJQ0VTPC9JbmR1c3RyeUNvZGVEZXNjcmlwdGlvbj4KICAgICAgPC9JbmR1c3RyeUNvZGU+PC9JbmR1c3RyeUNvZGU+PEFjdGl2aXRpZXNBbmRPcGVyYXRpb25zPjxMaW5lT2ZCdXNpbmVzc0RldGFpbHM+CiAgICAgICAgPExpbmVPZkJ1c2luZXNzRGVzY3JpcHRpb24+QnVzaW5lc3Mgc2VydmljZXMsIG5lYywgbnNrPC9MaW5lT2ZCdXNpbmVzc0Rlc2NyaXB0aW9uPgogICAgICA8L0xpbmVPZkJ1c2luZXNzRGV0YWlscz48L0FjdGl2aXRpZXNBbmRPcGVyYXRpb25zPjxFbXBsb3llZUZpZ3VyZXM+PEluZGl2aWR1YWxFbnRpdHlFbXBsb3llZURldGFpbHM+CiAgICAgICAgPFRvdGFsRW1wbG95ZWVRdWFudGl0eT4xPC9Ub3RhbEVtcGxveWVlUXVhbnRpdHk+CiAgICAgICAgPFJlbGlhYmlsaXR5VGV4dCBETkJDb2RlVmFsdWU9IjkwOTMiPkVzdGltYXRlZDwvUmVsaWFiaWxpdHlUZXh0PgogICAgICA8L0luZGl2aWR1YWxFbnRpdHlFbXBsb3llZURldGFpbHM+PENvbnNvbGlkYXRlZEVtcGxveWVlRGV0YWlscz4KICAgICAgICA8VG90YWxFbXBsb3llZVF1YW50aXR5PjE8L1RvdGFsRW1wbG95ZWVRdWFudGl0eT4KICAgICAgICA8RW1wbG95ZWVDYXRlZ29yeURldGFpbHM+CiAgICAgICAgICA8RW1wbG95ZWVCYXNpc1RleHQgRE5CQ29kZVZhbHVlPSI5MDY0Ij5QcmluY2lwYWxzPC9FbXBsb3llZUJhc2lzVGV4dD4KICAgICAgICA8L0VtcGxveWVlQ2F0ZWdvcnlEZXRhaWxzPgogICAgICAgIDxSZWxpYWJpbGl0eVRleHQgRE5CQ29kZVZhbHVlPSI5MDkzIj5Fc3RpbWF0ZWQ8L1JlbGlhYmlsaXR5VGV4dD4KICAgICAgPC9Db25zb2xpZGF0ZWRFbXBsb3llZURldGFpbHM+PC9FbXBsb3llZUZpZ3VyZXM+PFByaW5jaXBhbHNBbmRNYW5hZ2VtZW50PjxDdXJyZW50UHJpbmNpcGFsPgogICAgICAgIDxQcmluY2lwYWxOYW1lIHhzaTp0eXBlPSJjdXM6SW5kaXZpZHVhbE5hbWVUeXBlIj48RnVsbE5hbWU+SW1hIFNvbWVib2J5PC9GdWxsTmFtZT48L1ByaW5jaXBhbE5hbWU+CiAgICAgICAgPEpvYlRpdGxlPgogICAgICAgICAgPEpvYlRpdGxlVGV4dD5Qcm9wcmlldG9yPC9Kb2JUaXRsZVRleHQ+CiAgICAgICAgPC9Kb2JUaXRsZT4KICAgICAgICA8UHJpbmNpcGFsSWRlbnRpZmljYXRpb25OdW1iZXJEZXRhaWwgRE5CQ29kZVZhbHVlPSIyNDIxNSIgVHlwZVRleHQ9IlByb2Zlc3Npb25hbCBDb250YWN0IElkZW50aWZpZXIiPgogICAgICAgICAgPFByaW5jaXBhbElkZW50aWZpY2F0aW9uTnVtYmVyPjI0MTAxOTU3NDE8L1ByaW5jaXBhbElkZW50aWZpY2F0aW9uTnVtYmVyPgogICAgICAgIDwvUHJpbmNpcGFsSWRlbnRpZmljYXRpb25OdW1iZXJEZXRhaWw+CiAgICAgIDwvQ3VycmVudFByaW5jaXBhbD48L1ByaW5jaXBhbHNBbmRNYW5hZ2VtZW50PjxTb2Npb0Vjb25vbWljSWRlbnRpZmljYXRpb24+PE1pbm9yaXR5T3duZWRJbmRpY2F0b3I+ZmFsc2U8L01pbm9yaXR5T3duZWRJbmRpY2F0b3I+PFNtYWxsQnVzaW5lc3NJbmRpY2F0b3I+ZmFsc2U8L1NtYWxsQnVzaW5lc3NJbmRpY2F0b3I+PE93bmVyc2hpcEV0aG5pY2l0eT4KICAgICAgICA8RXRobmljaXR5VHlwZVRleHQgRE5CQ29kZVZhbHVlPSIwIj5Vbmtub3duPC9FdGhuaWNpdHlUeXBlVGV4dD4KICAgICAgPC9Pd25lcnNoaXBFdGhuaWNpdHk+PC9Tb2Npb0Vjb25vbWljSWRlbnRpZmljYXRpb24+PC9Pcmdhbml6YXRpb24+PC9Qcm9kdWN0PjwvT3JkZXJQcm9kdWN0UmVzcG9uc2VEZXRhaWw+",
"ObjectFormatTypeText": {
"@DNBCodeValue": 7004,
"$": "7004"
}
}]
}]
}
}}
Response Codes & Error Handling
Successful service requests will return a CM000 response code in the TransactionResult ResultID field. Otherwise, one of the D&B Direct standard response codes will be returned.
This operation may return the following response codes: CM001, CM004, PT001, and SC001-SC009.
Operation-specific supplemental response code explanations:
| PT001 | No Portfolio item found for given portfolio identifier or investigation tracking ID or item removed from archive. |
D&B Direct 2.0 API requests are provided on a metered basis; and may require entitlement prior to use in the production environment. In addition, a concurrency limit (QPS) is monitored to ensure that it is not exceeded. An error code will be returned in the event that a transaction is throttled.
While this operation is provided on a metered basis, usage is tracked; however, no billing for successful calls is recorded.
Feature Notes
While the portfolio feature is utilized by other D&B services, only items created by D&B Direct can be managed using this service.
The portfolio feature is also utilized by the D&B Direct Investigation Service.
- © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.