Use ListWorkFlowTemplates to query approval templates - Data Management - Alibaba Cloud - Data Management

Queries approval templates.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ListWorkFlowTemplates

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. Note To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see View information about the current tenant.	-1
SearchName	string	No	The name used to search for approval templates.	Admin

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	41067071-0243-4AAB-B3CF-4DE6D54F53B4
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Success	boolean	Indicates whether the request was successful.	true
WorkFlowTemplates	object
WorkFlowTemplate	array<object>	The approval templates.
	array<object>
IsSystem	integer	Indicates whether the approval template is predefined by the system. Valid values: 1: The approval template is predefined by the system. 0: The approval template is not predefined by the system.	1
WorkflowNodes	object
WorkflowNode	array<object>	The details of approval nodes.
	object
Comment	string	The description of the approval node.	test
NodeType	string	The type of the approval node. Valid values: SYS: The approval node is predefined by the system. USER_LIST: The approval node is created by a user.	SYS
NodeName	string	The name of the approval node.	test
Position	integer	The position of the approval node.	1
CreateUserId	integer	The ID of the creator.	1234
TemplateId	integer	The ID of the template.	12345
NodeId	integer	The ID of the approval node.	123
Comment	string	The description of the approval template.	test
Enabled	string	Indicates whether the approval template is enabled. Valid values: Y: The approval template is enabled. N: The approval template is disabled.	Y
TemplateName	string	The name of the approval template.	Admin
TemplateId	integer	The ID of the approval template.	12345
CreateUserId	integer	The ID of the creator.	1234

Examples

Success response

JSON format

{
  "RequestId": "41067071-0243-4AAB-B3CF-4DE6D54F53B4",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "WorkFlowTemplates": {
    "WorkFlowTemplate": [
      {
        "IsSystem": 1,
        "WorkflowNodes": {
          "WorkflowNode": [
            {
              "Comment": "test",
              "NodeType": "SYS",
              "NodeName": "test",
              "Position": 1,
              "CreateUserId": 1234,
              "TemplateId": 12345,
              "NodeId": 123
            }
          ]
        },
        "Comment": "test",
        "Enabled": "Y",
        "TemplateName": "Admin",
        "TemplateId": 12345,
        "CreateUserId": 1234
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.