检索格式化文本的 API

用于检索格式化文本的 API¶

检索数据集分区某个字段中引用的格式化文本。该字段由以下组合标识：

database_id，
workspace_code，
dataset_code，
field_code

在 url 中指定，以及以下组合：

process，
scenario，
period，
entity，
filters

在 url 中指定，以及以下组合：

方法¶

POST

URL¶

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

属性¶

以下与执行上下文相关的属性可以以 JSON 格式包含在请求体中：

属性	描述	选项
process	用于标识分区的流程。仅对分区数据集为必填	默认：$
scenario	用于标识分区的场景。仅对按场景和期间提交的流程为必填。	默认：$
period	用于标识分区的期间。仅对按场景和期间提交的流程为必填。	默认：$
entity	用于标识分区的实体。仅对按业务周期和实体分区的数据集为必填	默认：$
filters	用于唯一标识记录的筛选器	field：要筛选的字段名称 op：可以是 EQUALS 或 IS_NULL value：当 op=EQUALS 时字段的值

示例

复制

从未分区数据集中提取格式化文本

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

复制

从按业务周期分区、采用单次提交流程的数据集中检索格式化文本

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

复制

从按业务周期分区、采用按场景和期间提交流程的数据集中检索格式化文本

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

复制

从按业务周期和实体分区、采用单次提交流程的数据集中检索格式化文本

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

复制

从按业务周期和实体分区、采用按场景和期间提交流程的数据集中检索格式化文本

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

返回的数据¶

响应返回格式化文本的内容