API to retrieve formatted text

API to retrieve formatted text¶

Retrieves the formatted text referenced within a field of a dataset partition. The field is identified by the combination of:

database_id,
workspace_code,
dataset_code,
field_code

specified in the url and the combination of:

process,
scenario,
period,
entity,
filters

specified in the url and the combination of:

Method¶

POST

URL¶

api-root>/aih/richtext/v1/database_id/workspace_code/dataset_code/field_code

Property¶

The following properties related to the execution context can be included in JSON format in the body of the request:

Property	Description	Options
process	Process for identifying the partition. Only mandatory for partitioned datasets	Default: $
scenario	Scenario for identifying the partition. Only required for processes with submission by scenario and period.	Default: $
period	Period for identifying the partition. Only required for processes with submission by scenario and period.	Default: $
entity	Entity for identifying the partition. Mandatory only for datasets partitioned by Business Cycle and Entity	Default: $
filters	Filters to uniquely identify a record	field: name of the field on which to filter op: may be EQUALS or IS_NULL value: value of the field in the case of op=EQUALS

Examples

Copy

Extracting formatted text from an unpartitioned dataset

{
    "filters": [{
        "field": "ACCOUNT", 
        "op": "EQUALS",
        "value": "001"
    }, {
        "field": "CATEGORY", 
        "op": "IS_NULL"
    }]
}

Copy

Retrieving formatted text from a partitioned dataset for Business Cycle with single Submission process

{
    "process": "BUDGET",
    "filters": [{
        "field": "ACCOUNT", 
        "op": "EQUALS",
        "value": "001"
    }, {
        "field": "CATEGORY", 
        "op": "IS_NULL"
    }]
}

Copy

Retrieving formatted text from a partitioned dataset by Business Cycle with Submission process by scenario and period

{
    "process": "ACTUAL",
    "scenario": "2024ACT",
    "period": "12",
    "filters": [{
        "field": "ACCOUNT",
        "op": "EQUALS",
        "value": "001"
    }, {
        "field": "CATEGORY", 
        "op": "IS_NULL"
    }]
}

Copy

Retrieving formatted text from a partitioned dataset for Business Cycle and Entity with single Submission process

{
    "process": "BUDGET",
    "entity": "001",
    "filters": [{
        "field": "ACCOUNT", 
        "op": "EQUALS",
        "value": "001"
    }, {
        "field": "CATEGORY", 
        "op": "IS_NULL"
    }]
}

Copy

Retrieving formatted text from a partitioned dataset for Business Cycle and Entity with Submission process by scenario and period

{
    "process": "ACT",
    "scenario": "2024ACT",
    "period": "12",
    "entity": "001",
    "filters": [{
        "field": "ACCOUNT", 
        "op": "EQUALS",
        "value": "001"
    }, {
        "field": "CATEGORY", 
        "op": "IS_NULL"
    }]
}

Data returned¶

The response returns the content of the formatted text