All Products
Search
Document Center

Data Management:ListWorkFlowTemplates

Last Updated:Nov 27, 2024

Queries approval templates.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:ListWorkFlowTemplateslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

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
SearchNamestringNo

The name that is used to query approval templates.

Admin

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

41067071-0243-4AAB-B3CF-4DE6D54F53B4
ErrorCodestring

The error code returned if the request failed.

UnknownError
ErrorMessagestring

The error message returned if the request failed.

UnknownError
Successboolean

Indicates whether the request is successful.

true
WorkFlowTemplatesarray<object>

The approval templates.

WorkFlowTemplateobject
IsSysteminteger

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
WorkflowNodesarray<object>

The details of approval nodes.

WorkflowNodeobject
Commentstring

The description of the approval node.

test
NodeTypestring

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
NodeNamestring

The name of the approval node.

test
Positioninteger

The position of the approval node.

1
CreateUserIdlong

The ID of the creator.

1234
TemplateIdlong

The ID of the template.

12345
NodeIdlong

The ID of the approval node.

123
Commentstring

The description of the approval template.

test
Enabledstring

Indicates whether the approval template is enabled. Valid values:

  • Y: The approval template is enabled.
  • N: The approval template is disabled.
Y
TemplateNamestring

The name of the approval template.

Admin
TemplateIdlong

The ID of the approval template.

12345
CreateUserIdlong

The ID of the creator.

1234

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history