查询自动化流程配置

接口说明

本接口用于获取 Smartsheet 自动化流程配置

请求格式

描述	定义
Path	/openapi/smartsheet/v2/files/{fileID}/{workflowID}
Method	GET
Content-Type	application/json

请求头部

详见Headers。

请求参数

路径参数

参数名	类型	必选	描述
fileID	string	是	文档唯一标识，详见fileID
workflowID	string	是	自动化流程ID

查询参数

无

请求体

无

响应参数

响应体

参数名	类型	描述
workflow	JSON Object(Workflow)	自动化流程信息

自动化流程配置 Workflow

参数名	类型	描述
id	string	自动化流程流程id
name	string	自动化流程流程名称
trigger	JSON Object(Trigger)	触发器信息

自动化流程配置 Trigger

参数名	类型	描述
id	string	触发器id
tableId	string	子表 id
type	enum(TriggerType)	触发器类型
data	oneof(InsertRecordTriggerData/UpdateRecordTriggerData/ CycleReminderTriggerData/RecordTimerTriggerData)	触发器内容

请求包体

POST /openapi/smartsheet/v2/files/DAAAAAAAAAAAA/sheets/at5j8y/fields:list HTTP/1.1
Access-Token: ACCESS_TOKEN
Client-Id: CLIENT_ID
Content-Type: application/json

示例

curl --location --request GET 'https://{domain}/openapi/smartsheet/v2/files/AurUuwEGJXrwMZlqaQ/1728984436645705709' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--header 'Content-Type: application/json' \

响应示例

{
    "workflow": {
        "id": "1730983559555411364",
        "name": "空白流程",
        "trigger": {
            "id": "triggerusfm4",
            "tableId": "BB08J2",
            "type": "TRIGGER_TYPE_ INSERT_RECORD",
            "insertRecordTriggerData": {
                "notEmptyFieldId": "TxDpU"
            }
        }
    }
}