Cookies Settings

Loading

dnb-logo
Direct 2.0
Collapse

Update Monitoring Profile

This function allows a customer to update or cancel an active monitoring profile.

Update History

  • August 26, 2016 (vALL SOAP & REST): Multicondition for Create Monitoring Profile and Update Monitoring Profile now supports up to 10 change conditions.
  • July 15, 2016 (v6.1 SOAP & REST)): New multi-condition values, ValueBecomesNULL and ValueBecomesNOTNULL, have been added for create monitoring profile and update monitoring profile.
  • April 22, 2016 (v6.0 SOAP &REST): Changed the current implementation on the conditions, Value Goes Beyond and Value Goes Below, based on the ContinuousChangeNotificationIndicator. This establishes the following features: If ContinuousChangeNotificationIndicator is set to TRUE (by default), change notices are sent when the new value is less than or greater than the customer threshold. If ContinuousChangeNotificationIndicator is set to FALSE, change notices are sent only when the new value crosses through the customer threshold range relative to the former value.
  • March 11, 2016 (v6.0 SOAP & REST)): Multiple conditions may now be specified for any one particular element in create monitoring profile and update monitoring profile. This feature is applicable for any monitorable numeric element.

What to do First

Feature Request

IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.

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 function does not require entitlement for production and trial usage. Entitlement for monitoring is only required for the Add Monitoring Registration function, and for the data layers that will monitored.

Specification

Monitoring Profiles can be removed by setting the status to "Cancelled"; however, if the profile is referenced in a Monitoring Registration it may not be removed.

Restriction: The sequence of Request Parameters submitted to POST/PUT operations currently MUST follow the order presented in this section. This applies to REST calls only.

Restriction: An XML namespace statement MUST be included as the first statement within the primary Aggregate of the request. Please refer to the Sample Request for an example. This applies to REST calls only.

Sample Request (Update)
PUT https://direct.dnb.com/V4.2/monitoring/monitoringprofiles/862
Content-Type: application/json
Authorization: <My Token>

{
  "mon:UpdateMonitoringProfileRequest": {
    "@xmlns$mon": "http://services.dnb.com/MonitoringServiceV2.0",
    "UpdateMonitoringProfileRequestDetail": {
      "MonitoringProfileUpdateSpecification": {
        "MonitoringProfileStatusText": "Active",
        "InquiryReferenceText": { "CustomerReferenceText": "ReferenceText1" }
      }
    }
  }
}
Name Characteristics
{MonitoringProfileID} int, Required

A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS.

 

Name Characteristics
UpdateMonitoringProfileRequest Aggregate
UpdateMonitoringProfileRequest@ServiceVersionNumber Attribute
UpdateMonitoringProfileRequest@xsi:schemaLocation Attribute
UpdateMonitoringProfileRequest { TransactionDetail Aggregate, Optional

Records information necessary to process this request.

UpdateMonitoringProfileRequest { TransactionDetail { ApplicationTransactionID string up to 64 chars., Optional

A number assigned by the calling application to uniquely identify this request.

UpdateMonitoringProfileRequest { TransactionDetail { TransactionTimestamp DateTimestamp, Optional

The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary.

UpdateMonitoringProfileRequest { TransactionDetail { SubmittingOfficeID string up to 64 chars., Optional

A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&B business segment or delivery channel from where this request originated.

END: UpdateMonitoringProfileRequest } TransactionDetail /Aggregate
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail Aggregate, Required
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileDetail Aggregate, Required
END: UpdateMonitoringProfileRequest } UpdateMonitoringProfileRequestDetail } MonitoringProfileDetail /Aggregate
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification Aggregate, Required
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional

A name that is provided by the user to the profile.

UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail Aggregate, Optional
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement Aggregate, Required (Infinite)
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement { PCMElementXPATHText string up to 3000 chars., Required
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement { MonitoringChanges Aggregate, Required (Infinite)
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeCondition ChangeConditionEnum, Required

Criteria to monitor an element.

 

Possible values: AnyChange; ValueIncreaseByPercentage; ValueDecreaseByPercentage; ValueChangeByPercentage; ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy; ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy; DateEquals; MultiCondition, ValueBecomesNULL, ValueBecomesNOTNULL

The Continuous Change Notification Indicator is considered for values: ValueGoesBeyond and ValueGoesBelow.

Refer to the MultiCondition table for more details.

UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeValue string, up to 3000 chars., Optional

Threshold value corresponding to monitoring criteria.

CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ContinuousChangeNotificationIndicator boolean, Optional

When 'true' (default), change notices are sent when the new value is less than or greater than the customer threshold. When 'false', change notices are sent only when the new value crosses through the customer threshold range relative to the former value.

END: UpdateMonitoringProfileRequest } UpdateMonitoringProfileRequestDetail } MonitoringProfileUpdateSpecification } MonitoringElementDetail } MonitoringElement } MonitoringChanges /Aggregate
END: UpdateMonitoringProfileRequest } UpdateMonitoringProfileRequestDetail } MonitoringProfileUpdateSpecification } MonitoringElementDetail } MonitoringElement /Aggregate
END: UpdateMonitoringProfileRequest } UpdateMonitoringProfileRequestDetail } MonitoringProfileUpdateSpecification } MonitoringElementDetail /Aggregate
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringProfileStatusText MonitoringProfileStatusTextEnum, Optional

Records the status of the monitoring profile

Possible values: Active; Cancelled

UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail { ReturnChangedDataOnlyIndicator boolean

When 'true' indicates that Change Notices will only include information for fields whose value has changed. When 'false' indicates that Change Notices will include information for all fields, regardless if the values have changed. The latter scenario applies when a whole data layer and/or aggregate is being monitored.

UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { InquiryReferenceText Aggregate, Optional

Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.

UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { InquiryReferenceText { CustomerReferenceText string up to 240 chars., Optional(Up to 5x)

A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation.

END: UpdateMonitoringProfileRequest } UpdateMonitoringProfileRequestDetail } MonitoringProfileUpdateSpecification } InquiryReferenceText /Aggregate
END: UpdateMonitoringProfileRequest } UpdateMonitoringProfileRequestDetail } MonitoringProfileUpdateSpecification /Aggregate
END: UpdateMonitoringProfileRequest } UpdateMonitoringProfileRequestDetail /Aggregate
END: UpdateMonitoringProfileRequest /Aggregate

Deleting a Profile

To remove a profile, change the status to "Cancelled" through an update request. Canceled items can be restored within 24-hours of the update, after which they are deleted by the system.

"MonitoringProfileUpdateSpecification": {
     "MonitoringProfileStatusText": "Cancelled"
},

Endpoint

Use the following endpoint for requesting this feature. The {version} is dependent on the underlying service delivering the response.

Endpoint (Monitoring)
PUT https://direct.dnb.com/V{version}/monitoring/monitoringprofiles/{MonitoringProfileID}

Testing

This operation will return a static set of results in the D&B Direct test environment (sandbox), regardless of the request parameters.

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.

Sample Response (Update)
{"UpdateMonitoringProfileResponse": {
   "@ServiceVersionNumber": "2.0",
   "TransactionDetail":    {
      "ServiceTransactionID": "Id-82a4d309542c1f8d01fb742e-1",
      "TransactionTimestamp": "2014-10-01T11:36:45.206-04:00"
   },
   "TransactionResult":    {
      "SeverityText": "Information",
      "ResultID": "CM000",
      "ResultText": "Success"
   },
   "UpdateMonitoringProfileResponseDetail": {"MonitoringProfileDetail":    {
      "MonitoringProfileID": 862,
      "MonitoringProfileStatusText": "Active",
      "InquiryReferenceText": {"CustomerReferenceText": ["ReferenceText1"]},
      "FormerMonitoringProfileDetail":       {
         "MonitoringProfileName": "ATLAS_DCP_STD",
         "MonitoringElementDetail": {"MonitoringElement":          [
                        {
               "PCMElementXPATHText": "//Organization/OrganizationDetail/StandaloneOrganizationIndicator",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/OrganizationName/OrganizationPrimaryName/OrganizationName",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/RegistrationIssuerName",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/OrganizationDetail/ControlOwnershipTypeText",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/OrganizationDetail/ControlOwnershipDate",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/Financial/KeyFinancialFiguresOverview/SalesRevenueAmount",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/EmployeeFigures/IndividualEntityEmployeeDetails/TotalEmployeeQuantity",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/EmployeeFigures/IndividualEntityEmployeeDetails/ReliabilityText@DNBCodeValue",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/EmployeeFigures/ConsolidatedEmployeeDetails/TotalEmployeeQuantity",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/EmployeeFigures/ConsolidatedEmployeeDetails/ReliabilityText@DNBCodeValue",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/EmployeeFigures/ConsolidatedEmployeeDetails/EmployeeCategoryDetails/EmployeeBasisText@DNBCodeValue",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/ActivitiesAndOperations/SubjectIsAgentDetails/AgentIndicator",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/ActivitiesAndOperations/ImportDetails/ImportIndicator",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/ActivitiesAndOperations/ExportDetails/ExportIndicator",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/SubjectHeader/LastUpdateDate",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/SocioEconomicIdentification/SmallBusinessIndicator",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/SocioEconomicIdentification/MinorityOwnedIndicator",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/SocioEconomicIdentification/LaborSurplusAreaIndicator",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/StartDate",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/Financial/KeyFinancialFiguresOverview/TotalEquityAmount",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/RegistrationIssuerDUNSNumber",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/OrganizationIdentificationNumber",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/FilingOrganizationName",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/AssignmentMethodText",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/OrganizationDetail/OrganizationStartYear",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/FinancialAssetArticle/AssetArticleSummary/AssetTypeText@DNBCodeValue",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/FinancialAssetArticle/AssetArticleSummary/AssetArticleQuantity",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/Financial/KeyFinancialFiguresOverview/StatementHeaderDetails/FinancialStatementToDate",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/Linkage/HeadquartersOrganization/DUNSNumber",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/OrganizationDetail/OperatingStatusText@DNBCodeValue",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/OrganizationName/FormerOrganizationPrimaryName@RegisteredNameIndicator/OrganizationName",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/SubjectHeader/MarketabilityIndicator",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/SubjectHeader/NonMarketableReasonText@DNBCodeValue",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/SubjectHeader/OrganizationSummaryText",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/RegisteredDetail/IncorporationYear",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/EmployeeFigures/EmployeeQuantityGrowthRate",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/Financial/KeyFinancialFiguresOverview/EmployeeQuantityGrowthRate",
               "MonitoringChanges": [               {
                  "ChangeCondition": "AnyChange",
                  "ChangeValue": null
               }]
            },
                        {
               "PCMElementXPATHText": "//Organization/Location/PrimaryAddress",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/Location/MailingAddress",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/Telecommunication",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/SubjectHeader/TransferDUNSNumberRegistration",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/RegistrationLocation/PrimaryAddress",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/RegisteredDetail/StockExchangeDetails",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/IndustryCode/IndustryCode@DNBCodeValue",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/ActivitiesAndOperations/LineOfBusinessDetails",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/PrincipalsAndManagement/CurrentPrincipal",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/PrincipalsAndManagement/MostSeniorPrincipal",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/SocioEconomicIdentification/OwnershipEthnicity",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/OrganizationDetail/FamilyTreeMemberRole",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/ThirdPartyAssessment/ThirdPartyAssessment",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/OrganizationName/TradeStyleName",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            },
                        {
               "PCMElementXPATHText": "//Organization/Financial/FinancialStatement",
               "MonitoringChanges": [{"ChangeCondition": "AnyChange"}]
            }
         ]},
         "MonitoringProfileStatusText": "Cancelled",
         "InquiryReferenceText": {"CustomerReferenceText":          [
            "ATLAS_DCP_STD",
            "ATLAS_DCP_STD"
         ]}
      }
   }}
}}
Name Characteristics
UpdateMonitoringProfileResponse Aggregate
UpdateMonitoringProfileResponse @ServiceVersionNumber
UpdateMonitoringProfileResponse @xsi:schemaLocation
UpdateMonitoringProfileResponse { TransactionDetail Aggregate, Required

Records information necessary to process a particular request. Examples of a request is the ordering of a product.

UpdateMonitoringProfileResponse { TransactionDetail { ApplicationTransactionID string, up to 64 chars, Optional

A number assigned by the calling application to uniquely identify this request.

UpdateMonitoringProfileResponse { TransactionDetail { ServiceTransactionID string, up to 64 chars, Required

A number assigned by the D&B service to uniquely identify this transaction.

UpdateMonitoringProfileResponse { TransactionDetail { TransactionTimestamp dateTime, Required

The date and time when this request was submitted or the date and time when the requesting intermediary, such as a workflow manager or service bus, sent the message to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary.

END: UpdateMonitoringProfileResponse } TransactionDetail /Aggregate
UpdateMonitoringProfileResponse { TransactionResult Aggregate, Required

An aggregate that can repeat multiple times to record the different outcomes of the transaction.

UpdateMonitoringProfileResponse { TransactionResult { SeverityText string, up to 16 chars, Required

Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal.

UpdateMonitoringProfileResponse { TransactionResult { ResultID string, up to 32 chars, Required

An alphanumeric string that uniquely identifies the outcome of the transaction.

UpdateMonitoringProfileResponse { TransactionResult { ResultText string, up to 512 chars, Optional

Text that explains the outcome of the transaction.

UpdateMonitoringProfileResponse { TransactionResult { ResultMessage Aggregate, Optional (Infinite)

An aggregate that can repeat multiple times to record textual data that expands on the ResultID and ResultText to provide additional information to the user regarding the status of the transaction. If the status implies that there is a problem this may also provide guidance to the user on how to address it.

UpdateMonitoringProfileResponse { TransactionResult { ResultMessage { ResultDescription string, up to 512 chars, Required

Text that describes the additional information regarding the outcome of the transaction.

END: UpdateMonitoringProfileResponse } TransactionResult } ResultMessage /Aggregate
END: UpdateMonitoringProfileResponse } TransactionResult /Aggregate
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail Aggregate, Optional
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail Aggregate, Optional
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileID integer, Required

A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS.

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileName string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Required

A name that is provided by the user to the profile.

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail Aggregate, Optional
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { PCMElementXPATHText string, up to 3000 chars, Required
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeCondition Criteria to monitor an element.

 

Possible values: AnyChange; ValueIncreaseByPercentage; ValueDecreaseByPercentage; ValueChangeByPercentage; ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy; ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy; DateEquals; MultiCondition

Refer to the MultiCondition table for more details.

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeValue string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
END: UpdateMonitoringProfileResponse } UpdateMonitoringProfileResponseDetail } MonitoringProfileDetail } MonitoringElementDetail } MonitoringElement } MonitoringChanges /Aggregate
END: UpdateMonitoringProfileResponse } UpdateMonitoringProfileResponseDetail } MonitoringProfileDetail } MonitoringElementDetail } MonitoringElement /Aggregate
END: UpdateMonitoringProfileResponse } UpdateMonitoringProfileResponseDetail } MonitoringProfileDetail } MonitoringElementDetail /Aggregate
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileStatusText MonitoringProfileStatusTextEnum, Optional

Records the status of the monitoring profile

Possible values: Active; Cancelled

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { InquiryReferenceText Aggregate, Optional

Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { InquiryReferenceText { CustomerReferenceText string, up to 240 chars, Optional (Up to 5x)

A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation.

END: UpdateMonitoringProfileResponse } UpdateMonitoringProfileResponseDetail } MonitoringProfileDetail } InquiryReferenceText /Aggregate
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail Aggregate, Optional
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringProfileName string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional

A name that is provided by the user to the profile.

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail Aggregate, Optional
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { PCMElementXPATHText string, up to 3000 chars, Required
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeCondition ChangeConditionEnum, Required

Possible values: AnyChange; ValueIncreaseByPercentage; ValueDecreaseByPercentage; ValueChangeByPercentage; ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy; ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy; DateEquals

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeValue string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
END: UpdateMonitoringProfileResponse } UpdateMonitoringProfileResponseDetail } MonitoringProfileDetail } FormerMonitoringProfileDetail } MonitoringElementDetail } MonitoringElement } MonitoringChanges /Aggregate
END: UpdateMonitoringProfileResponse } UpdateMonitoringProfileResponseDetail } MonitoringProfileDetail } FormerMonitoringProfileDetail } MonitoringElementDetail } MonitoringElement /Aggregate
END: UpdateMonitoringProfileResponse } UpdateMonitoringProfileResponseDetail } MonitoringProfileDetail } FormerMonitoringProfileDetail } MonitoringElementDetail /Aggregate
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringProfileStatusText MonitoringProfileStatusTextEnum, Optional

Records the status of the monitoring profile

Possible values: Active; Cancelled

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { ReturnChangedDataOnlyIndicator boolean

When 'true' indicates that Change Notices will only include information for fields whose value has changed. When 'false' indicates that Change Notices will include information for all fields, regardless if the values have changed. The latter scenario applies when a whole data layer and/or aggregate is being monitored.

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { InquiryReferenceText Aggregate, Optional

Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { InquiryReferenceText { CustomerReferenceText string, up to 240 chars, Optional (Up to 5x)

A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation.

END: UpdateMonitoringProfileResponse } UpdateMonitoringProfileResponseDetail } MonitoringProfileDetail } FormerMonitoringProfileDetail } InquiryReferenceText /Aggregate
END: UpdateMonitoringProfileResponse } UpdateMonitoringProfileResponseDetail } MonitoringProfileDetail } FormerMonitoringProfileDetail /Aggregate
END: UpdateMonitoringProfileResponse } UpdateMonitoringProfileResponseDetail } MonitoringProfileDetail /Aggregate
END: UpdateMonitoringProfileResponse } UpdateMonitoringProfileResponseDetail /Aggregate
END: UpdateMonitoringProfileResponse /Aggregate

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, CM002, CM004, CM007, CM023, MN001, MN004, SC001-SC009.

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.

Operation-specific supplemental response code explanations:

Feature Notes

Here are some constraints of the <ChangeCondition> component in the Monitoring profile.

  • Profiles may have a single change condition or multiple change conditions per element.
  • The default condition for any element is AnyChange
  • <ChangeValue> values should match the data type of the element being monitored

The following table highlights the condition options applicable for each data type:

Data type Supported change condition
String AnyChange
Numeric AnyChange
String ValueEquals
Numeric ValueEquals
Numeric ValueIncreaseByPercentage
Numeric ValueDecreaseByPercentage
Numeric ValueChangeByPercentage
Numeric ValueIncreaseBy
Numeric ValueDecreaseBy
Numeric ValueChangeBy
Numeric ValueGoesBeyond
Numeric ValueGoesBelow
Boolean AnyChange
Date AnyChange
Date DateChangeBy
Date DateEquals
EnumString AnyChange
EnumString ValueEquals

Multiple Conditions

Multiple conditions may be specified for any one element, currently restricted to up to ten conditions. Multiple conditions may not be combined. The following operators support multicondition scenarios.

NOTE: Some of the following operators support single condition scenarios, as well as, multicondition scenarios.

Supported Operators

Operators

Description

Data Types SupportedOperands Supported
AND, And, andAND condition  
OR, Or, or

OR condition

  
= equal to Numeric/ Stringelement
!=not equal to Numericelement
< less thanNumericelement
> greater thanNumericelement
<= less than or equal to Numericelement
>= greater than or equal toNumericelement
ValueIncreaseByPercentageValueIncreaseByPercentageNumericelement
ValueIncreaseByPercentageValueDecreaseByPercentageNumericelement
ValueIncreaseByPercentage ValueChangeByPercentageNumericelement
ValueIncreaseByValueIncreaseByNumericelement
ValueDecreaseBy ValueDecreaseByNumericelement
ValueChangeByValueChangeByNumericelement
ValueGoesBeyond ValueGoesBeyondNumericelement
ValueGoesBelowValueGoesBelowNumericelement
ValueEquals ValueEqualsNumeric/ Stringelement, elementPrevious
ValueBecomesNullValueBecomesNullNumeric/ Stringelement
ValueBecomesNotNullValueBecomesNotNullNumeric/ Stringelement

 

Supported Operands

Operators

Description

Data Types Supported
elementRepresents the new value of the element after the changeNumeric, string
elementPrevious

Represents the previous value of the element before the change

String

 

Sample Multicondition Expression

Example

OperatorsOperands
((element < 25) AND (element > 100)) <, >element, 25, 100

An error code will be returned in the event that a given expression is invalid in the request.