This product(
fnf/2019-03-15) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Flow
| API | Title | Description |
|---|---|---|
| CreateFlow | CreateFlow | Creates a flow. |
| DeleteFlow | DeleteFlow | Deletes an existing flow. |
| UpdateFlow | UpdateFlow | Updates a flow. |
| DescribeFlow | DescribeFlow | Queries the information about a flow. |
| ListFlows | ListFlows | Queries a list of flows. |
Execution
| API | Title | Description |
|---|---|---|
| StartExecution | StartExecution | Starts the execution of a workflow. |
| StopExecution | StopExecution | Stops an execution that is in progress in a flow. |
| DescribeExecution | DescribeExecution | Queries an execution in a flow. The long polling mode is supported. The maximum waiting period for long polling depends on the value of the WaitTimeSeconds parameter. |
| ListExecutions | ListExecutions | Queries all historical executions of a flow. |
| GetExecutionHistory | GetExecutionHistory | Queries the details about each step in an execution process. |
| StartSyncExecution | StartSyncExecution | Synchronously starts an execution in a flow. |
Task
| API | Title | Description |
|---|---|---|
| ReportTaskFailed | ReportTaskFailed | Reports a failed task. |
| ReportTaskSucceeded | ReportTaskSucceeded | Reports a successful task. |
Time-Based Schedules
| API | Title | Description |
|---|---|---|
| CreateSchedule | CreateSchedule | Creates a time-based schedule. |
| DeleteSchedule | DeleteSchedule | Deletes a time-based schedule. |
| UpdateSchedule | UpdateSchedule | Updates a time-based schedule. |
| DescribeSchedule | DescribeSchedule | Queries the detailed information about a time-based schedule. |
| ListSchedules | ListSchedules | Queries time-based schedules in a flow. |