DSS Debt Corporate Actions Iso Report Template

Hi Team,

Could you please share working API request for Debt Corporate Actions ISO 15022? I've been trying to use example provided in API tree, but the query isn't working. Here's what I've been running:

{
"ExtractionRequest": {
"@odata .type": "#DataScope.Select.Api.Extractions.ReportTemplates.DebtCorporateActionsIsoReportTemplate",
"OutputFormat": "IsoFormat",
"Headers": [

],

"Trailers": [


],

"ContentFields": [


],

"Condition": {

    "ReportDateRangeType": "Init",

    "ExcludeDeletedEvents": false,

    "IncludeNonPendingEvents": true,

    "ReportIsoEvents": [

        "BRUP",

        "ACTV",

        "CHAN",

        "CONS",

        "DFLT",

        "DLST",

        "OTHR",

        "MCAL",

        "REDM",

        "BPUT",

        "DRAW",

        "PCAL",

        "PRED",

        "PARI",

        "EXOF",

        "BIDS",

        "CONV",

        "EXTM",

        "TEND",

        "INTR",

        "MRGR"

    ],

    "IncludeCusipCinsIn35B": false,

    "Wrap35BLines": false,

    "IncludeBankruptcyEvents": false,

    "LastUpdate": true,

    "IncludeActivationEvents": false,

    "IncludeDeactivationEvents": false,

    "IncludeBondDefaultEvents": false,

    "IncludeConsentEvents": false,

    "IncludeChangeEvents": false,

    "IncludeOtherEvents": false,

    "IncludePutRedemptionEvents": false,

    "IncludeDrawingEvents": false,

    "IncludeFullCallEarlyRedemptionEvents": false,

    "IncludePartialRedemptionWithReductionOfNVEvents": false,

    "IncludeFinalMaturityEvents": false,

    "IncludeExchangeEvents": false,

    "IncludePartialRedemptionWithoutReductionOfNVEvents": false,

    "IncludeAssimilationEvents": false,

    "IncludeRepurchaseOfferEvents": false,

    "IncludeConversionEvents": false,

    "IncludeMaturityExtensionEvents": false,

    "IncludeTenderAcquisitionTakeoverPurchaseOfferEvents": false,

    "IncludeInterestPaymentEvents": false,

    "IncludeMergerEvents": false

}

}
},
"IdentifiersList": {
"@odata .type": "#DataScope.Select.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",
"InstrumentIdentifiers": [
{ "Identifier": "XS2310945048", "IdentifierType": "Isin" },
{ "Identifier": "US023663AB31", "IdentifierType": "Isin" },
{ "Identifier": "US40048CAB90", "IdentifierType": "Isin" }
]
}
}

Thank you!

Find more posts tagged with

api

rest-api

datascope-select

#technology

Accepted answers

All comments

Gurpreet

Hello @rafal.chmura,

The correct report template should be as shown. There are instrument identifiers in your json message, which should not be part of this request message payload.

{
  "ExtractionRequest": {
    "@odata .type": "#DataScope.Select.Api.Extractions.ReportTemplates.DebtCorporateActionsIsoReportTemplate",
    "OutputFormat": "IsoFormat",
    "Headers": [],
    "Trailers": [],
    "ContentFields": [],
    "Condition": {
      "ReportDateRangeType": "Init",
      "ExcludeDeletedEvents": false,
      "IncludeNonPendingEvents": true,
      "ReportIsoEvents": ["BRUP", "ACTV", "CHAN", "CONS", "DFLT", "DLST", "OTHR", "MCAL", "REDM", "BPUT", "DRAW", "PCAL", "PRED", "PARI", "EXOF", "BIDS", "CONV", "EXTM", "TEND", "INTR", "MRGR"],
      "IncludeCusipCinsIn35B": false,
      "Wrap35BLines": false,
      "IncludeBankruptcyEvents": false,
      "LastUpdate": true,
      "IncludeActivationEvents": false,
      "IncludeDeactivationEvents": false,
      "IncludeBondDefaultEvents": false,
      "IncludeConsentEvents": false,
      "IncludeChangeEvents": false,
      "IncludeOtherEvents": false,
      "IncludePutRedemptionEvents": false,
      "IncludeDrawingEvents": false,
      "IncludeFullCallEarlyRedemptionEvents": false,
      "IncludePartialRedemptionWithReductionOfNVEvents": false,
      "IncludeFinalMaturityEvents": false,
      "IncludeExchangeEvents": false,
      "IncludePartialRedemptionWithoutReductionOfNVEvents": false,
      "IncludeAssimilationEvents": false,
      "IncludeRepurchaseOfferEvents": false,
      "IncludeConversionEvents": false,
      "IncludeMaturityExtensionEvents": false,
      "IncludeTenderAcquisitionTakeoverPurchaseOfferEvents": false,
      "IncludeInterestPaymentEvents": false,
      "IncludeMergerEvents": false
    }
  }
}

I am unable to verify this JSON request message or create this report, due to the lack of permissions. What error message do you get when executing it.

rafal.chmura

Hi Gurpreet,

When I run your code I get:

{ "error": { "message": "Malformed request payload: '@odata .type' is either missing or misplaced for type DataScope.Select.Api.Extractions.ExtractionRequests.ExtractionRequest" }}

rafal.chmura

@Gurpreet

I think there was a typo: "@odata .type", I removed an additional space, but know i got a new error:

{
"error": {
"message": "Invalid request parameter ExtractionRequest"
}
}

Gurpreet

Apologies, I merged the entries from my report template into your sample without checking.

Here, try this JSON request message -

POST https://selectapi.datascope.refinitiv.com/RestApi/v1/Extractions/DebtCorporateActionsIsoReportTemplates

{
  "@odata.type": "#DataScope.Select.Api.Extractions.ReportTemplates.DebtCorporateActionsIsoReportTemplate",
  "OutputFormat": "IsoFormat",
  "Headers": [],
  "Trailers": [],
  "ContentFields": [],
    "Name": "1e2b2a0d-78f8-46de-a35c-b177995e5646",
  "Condition": {
    "ReportDateRangeType": "Init",
    "ExcludeDeletedEvents": false,
    "IncludeNonPendingEvents": true,
    "ReportIsoEvents": ["BRUP", "ACTV", "CHAN", "CONS", "DFLT", "DLST", "OTHR", "MCAL", "REDM", "BPUT", "DRAW", "PCAL", "PRED", "PARI", "EXOF", "BIDS", "CONV", "EXTM", "TEND", "INTR", "MRGR"],
    "IncludeCusipCinsIn35B": false,
    "Wrap35BLines": false,
    "IncludeBankruptcyEvents": false,
    "LastUpdate": true,
    "IncludeActivationEvents": false,
    "IncludeDeactivationEvents": false,
    "IncludeBondDefaultEvents": false,
    "IncludeConsentEvents": false,
    "IncludeChangeEvents": false,
    "IncludeOtherEvents": false,
    "IncludePutRedemptionEvents": false,
    "IncludeDrawingEvents": false,
    "IncludeFullCallEarlyRedemptionEvents": false,
    "IncludePartialRedemptionWithReductionOfNVEvents": false,
    "IncludeFinalMaturityEvents": false,
    "IncludeExchangeEvents": false,
    "IncludePartialRedemptionWithoutReductionOfNVEvents": false,
    "IncludeAssimilationEvents": false,
    "IncludeRepurchaseOfferEvents": false,
    "IncludeConversionEvents": false,
    "IncludeMaturityExtensionEvents": false,
    "IncludeTenderAcquisitionTakeoverPurchaseOfferEvents": false,
    "IncludeInterestPaymentEvents": false,
    "IncludeMergerEvents": false
  }
}

rafal.chmura

Sorry, I wasn't specific enough in my request. I meant to ask for ondemand extraction using Debt Corporate Actions Iso Report Template, not create the template. Do you know if it can be done?

Jirapongse

@rafal.chmura

I also don't have permission to extract data from this template.

You may need to check the REST API Reference Tree in the On Demand Extraction folder to see the structure of the request message.

The request message will be used with the Extractions/ExtractRaw endpoint.

rafal.chmura

Hi,

I think I got it, just don't reuse the ISINs, they don't have any data. Thank you for your help :)

{
"ExtractionRequest": {
"@odata .type": "#DataScope.Select.Api.Extractions.ExtractionRequests.DebtCorporateActionsIsoExtractionRequest",
"IdentifierList": {
"@odata .type": "#DataScope.Select.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",
"InstrumentIdentifiers": [
{ "Identifier": "XS2750338985", "IdentifierType": "Isin" },
{ "Identifier": "XS2790905439", "IdentifierType": "Isin" },
{ "Identifier": "US69448WFA71", "IdentifierType": "Isin" },
{ "Identifier": "MXCDNA0Q00G8", "IdentifierType": "Isin" },
{ "Identifier": "XS2861330533", "IdentifierType": "Isin" },
{ "Identifier": "XS3025646046", "IdentifierType": "Isin" },
{ "Identifier": "IT0006767815", "IdentifierType": "Isin" },
{ "Identifier": "IT0005599862", "IdentifierType": "Isin" }
]
},
"Condition": {
"ReportDateRangeType": "Init",
"ExcludeDeletedEvents": false,
"IncludeNonPendingEvents": true,
"ReportIsoEvents": [
"BRUP", "ACTV", "CHAN", "CONS", "DFLT", "DLST", "OTHR", "MCAL", "REDM",
"BPUT", "DRAW", "PCAL", "PRED", "PARI", "EXOF", "BIDS", "CONV", "EXTM",
"TEND", "INTR", "MRGR"
],
"IncludeCusipCinsIn35B": false,
"Wrap35BLines": false,
"IncludeBankruptcyEvents": false,
"LastUpdate": true,
"IncludeActivationEvents": false,
"IncludeDeactivationEvents": false,
"IncludeBondDefaultEvents": false,
"IncludeConsentEvents": false,
"IncludeChangeEvents": false,
"IncludeOtherEvents": false,
"IncludePutRedemptionEvents": false,
"IncludeDrawingEvents": false,
"IncludeFullCallEarlyRedemptionEvents": false,
"IncludePartialRedemptionWithReductionOfNVEvents": false,
"IncludeFinalMaturityEvents": false,
"IncludeExchangeEvents": false,
"IncludePartialRedemptionWithoutReductionOfNVEvents": false,
"IncludeAssimilationEvents": false,
"IncludeRepurchaseOfferEvents": false,
"IncludeConversionEvents": false,
"IncludeMaturityExtensionEvents": false,
"IncludeTenderAcquisitionTakeoverPurchaseOfferEvents": false,
"IncludeInterestPaymentEvents": false,
"IncludeMergerEvents": false
}
}
}

rafal.chmura

Hi @Jirapongse @Gurpreet

Do you know how can I change my API call:

{
"ExtractionRequest": {
"@odata .type": "#DataScope.Select.Api.Extractions.ExtractionRequests.DebtCorporateActionsIsoExtractionRequest",
"Condition": {
"ReportDateRangeType": "Init",
"ReportIsoEvents": [
"CONV", "DFLT", "MCAL"
],
"IncludeNonPendingEvents": true,
"Wrap35BLines": false
},
"IdentifierList": {
"@odata .type": "#DataScope.Select.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",
"InstrumentIdentifiers": [
{
"Identifier": "DEA4D9DJ=F",
"IdentifierType": "Ric"
}
],
"ValidationOptions": null,
"UseUserPreferencesForValidationOptions": false
}
}
}

To imitate following settings from GUI:

I assume I'd need to change line "ReportDateRangeType": "Init"," to something. I couldn't find anything on API Tree.

Thank you!

Gurpreet

I would think, if you specified the ReportDateRangeType as Range and omitted the query start and end dates, it would return all historic and future events.

For content related questions such as these, please reach out to the DSS specialists. We are only able to help with technical questions.

rafal.chmura

Hi @Gurpreet

Thank you, I tried to change "INIT" to "Range":

"ReportDateRangeType": "Range ",
It gives me an error:

{ "error": { "message": "Malformed request payload: Error while parsing an enum value for ReportDateRangeType: The enum value Range is not one of the defined enum numeric values." }}

rafal.chmura

I managed to fix it:

{
"ExtractionRequest": {
"@odata .type": "#DataScope.Select.Api.Extractions.ExtractionRequests.DebtCorporateActionsIsoExtractionRequest",
"Condition": {
"ReportDateRangeType": "Range",
"ReportIsoEvents": [
"BRUP", "ACTV", "CHAN", "CONS", "DFLT", "DLST", "OTHR", "MCAL", "REDM",
"BPUT", "DRAW", "PCAL", "PRED", "PARI", "EXOF", "BIDS", "CONV", "EXTM",
"TEND", "INTR", "MRGR"
],
"IncludeNonPendingEvents": true,
"Wrap35BLines": false
},
"IdentifierList": {
"@odata .type": "#DataScope.Select.Api.Extractions.ExtractionRequests.InstrumentIdentifierList",
"InstrumentIdentifiers": [
{
"Identifier": "DEA4D9DJ=F",
"IdentifierType": "Ric"
}
],
"ValidationOptions": null,
"UseUserPreferencesForValidationOptions": false
}
}
}

But now the error states:

"Validation Error:\r\n\r\nAt least one Debt Corporate Actions Iso event must be selected.", but I have list of ISO events. Do you have any advice on that?

Gurpreet

Sorry, I don't have entitlements to run this report and am unable to test or advise.

{
  "error": {
    "message": "No permission for template \"DebtCorporateActionsIsoReportTemplate\"."
  }
}

EXPLORE OUR SITES