Call ListOrders to obtain the ticket list information.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes ListOrders

The operation that you want to perform. Valid values: ListOrders .

Tid Long No -1

The ID of the tenant.

Note The tenant ID is taken from the avatar in the upper-right corner of the system. For more information, see Tenant ID and Tenant .
PluginType String No DC_COMMON

The type of the ticket. Valid values:

  • PERM_APPLY: a permission application ticket.
  • OWNER_APPLY: an owner application ticket.
  • DATA_CORRECT: a data change ticket.
  • NDDL: a schema design change ticket.
  • DATA_TRACK: a data tracking ticket.
  • TABLE_SYNC: a database and table synchronization ticket.
  • DATA_EXPORT: a data export ticket.
  • SENSITIVITY: a column sensitivity level change ticket.
OrderResultType String No AS_ADMIN

The type of the ticket to query. Valid values:

  • AS_ADMIN: all tickets of the current user.
  • AS_COMMITTER: the ticket that I initiated
  • AS_HANDLER: the ticket to be handled by me
  • AS_OWNER: the tickets that have been handled by me
  • AS_Related:
SearchDateType String No CREATE_TIME

The time condition for the ticket to query. Valid values:

  • CREATE_TIME: the time when the ticket is created.
  • MODIFY_TIME: the time when the ticket is modified.
StartTime String No 2019-10-10 00:00:00

The start of the time range.
EndTime String No 2019-10-10 00:00:00

The end of the time range to query.
SearchContent String No test

The search content.
OrderStatus String No ALL

The status of the ticket. Valid values:

  • ALL: all tickets.
  • FINISHED: the closed tickets.
  • RUNNING: the ongoing tickets.
PageSize Integer No 10

The number of entries returned per page.
PageNumber Integer No 1

The page number of the returned page.

Response parameters

Parameter Type Example Description
ErrorCode String UnknownError

The error code.
ErrorMessage String UnknownError

The error message.
Orders Array of Order

The information of the ticket list.
Order
Comment String test

The remarks about the ticket.
Committer String test

The person who submits the ticket.
CommitterId Long 1

The ID of the ticket submitter.
CreateTime String 2019-10-10 00:00:00

The time when the ticket was created.
LastModifyTime String 2019-10-10 00:00:00

The time when the ticket was last modified.
OrderId Long 1432

The ID of the ticket.
PluginType String DC_COMMON

The type of the ticket.
StatusCode String success

The ticket status code.
StatusDesc String success

The status description of the ticket.
RequestId String 427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D

The ID of the request.
Success Boolean true

Indicates whether the request is successful.
TotalCount Long 100

The total number of entries returned.

Examples

Sample requests


     http(s)://[Endpoint]/? Action=ListOrders &<common request parameters>

Sample success responses

XML format 


     <TotalCount> 5 </TotalCount> <RequestId> 7AC17A86-9E6F-484B-AE8D-F9416986A108 </RequestId> <Orders> <Order> <StatusCode> success </StatusCode> <PluginType> dc_common </PluginType> <Committer> xxx [account] </Committer> <StatusDesc> data change successfully </StatusDesc> <LastModifyTime> 2019-11-19 13:53:05 </LastModifyTime> <CreateTime> 2019-11-19 13:52:36 </CreateTime> <OrderId> 737160 </OrderId> <Comment> test data change </Comment> <CommitterId> 104442 </CommitterId> </Order> <Order> <StatusCode> new </StatusCode> <PluginType> DC_COMMON </PluginType> <Committer> xxx [sub-account] </Committer> <StatusDesc> to be submitted for approval </StatusDesc> <LastModifyTime> 2019-10-29 20:51:37 </LastModifyTime> <CreateTime> 2019-10-29 20:51:36 </CreateTime> <OrderId> 737116 </OrderId> <Comment> test the </Comment> <CommitterId> 104442 </CommitterId> </Order> of creating a data change ticket <Order> <StatusCode> closed </StatusCode> <PluginType> DC_COMMON </PluginType> <Committer> xxx [subaccount] </Committer> <StatusDesc> ticket closed: Database-level operations still not supported </StatusDesc> <LastModifyTime> 2019-10-20 22:09:38 </LastModifyTime> <CreateTime> the test database creation </CreateTime> <OrderId> 737089 </OrderId> <Comment> <Order> </Comment> <CommitterId> 104442 </CommitterId> </Order> 2019-10-20 22:08:19 <StatusCode> new </StatusCode> <PluginType> DC_COMMON </PluginType> <Committer> xxx [sub-account] </Committer> <StatusDesc> pre-check failed </StatusDesc> <LastModifyTime> 2019-09-30 16:58:35 </LastModifyTime> <CreateTime> 16:58:34 on 2019-09-30 </CreateTime> <OrderId> 737016 </OrderId> <Comment> test </Comment> <CommitterId> 104442 </CommitterId> </Order> <Order> <StatusCode> success </StatusCode> <PluginType> dc_common </PluginType> <Committer> xxx [account] </Committer> <StatusDesc> data change successfully </StatusDesc> <LastModifyTime> 2019-08-17 14:07:54 </LastModifyTime> <CreateTime> 2019-08-17 14:07:42 </CreateTime> <OrderId> 736774 </OrderId> <Comment> test common data change </Comment> <CommitterId> 104442 </CommitterId> </Order> </Orders> <Success> true </Success>

JSON Format 


     {"TotalCount": 5, "RequestId": "7AC17A86-9 E6 F-484B-AE8D-F9416986A108", "Orders": { "Order": [ { "StatusCode": "success", "PluginType": "DC_COMMON", "Committer": "xxx [sub-account]", "StatusDesc": "Data Change succeeded", "LastModifyTime": "2019-11-19 13:53:05", "CreateTime": "2019-11-19 13:52:36", " OrderId ": 737160, " Comment ": " test data change ", " CommitterId ": 104442 }, { " StatusCode ": " new ", " PluginType ": " DC_COMMON ", " Committer ": " xxx [sub-account] ", " StatusDesc ": " to be submitted for approval ", " LastModifyTime ": " 2019-10-29 20:51:37 ", " CreateTime ": " 2019-10-29 20:51:36 ", " OrderId ": 737116, "Comment": "test to create a data change ticket", "CommitterId": 104442 }, { "StatusCode": "closed", "PluginType": "DC_COMMON", "Committer": "xxx [sub-account]", "StatusDesc": "The ticket has been closed: still, database-level operations are not supported.", "LastModifyTime": "2019-10-20 22:09:38", "CreateTime": "2019-10-20 22:08:19", "OrderId": 737089, "Comment": " Test database creation ", " CommitterId ": 104442 },{" StatusCode ": " new ", " PluginType ": " DC_COMMON ", " Committer ": " xxx [subaccount] ", " StatusDesc ": " PreCheck failed ", " LastModifyTime ": " 2019-09-30 16:58:35 ", " CreateTime ": " 2019-09-30 16:58:34 ", " OrderId ": 737016, " Comment ": " test ", CommitterId ": 104442 },{" StatusCode ": " success ", " PluginType ": " DC_COMMON ", " Committer ": " xxx [sub-account] ", " StatusDesc ": " Data Change succeeded ", " LastModifyTime ": " 2019-08-17 14:07:54 ", " CreateTime ": " 2019-08-17 14:07:42 ", " OrderId ": 736774, " Comment ": " Test common data change ", " CommitterId ": 104442} ] }, "Success": true}

Error codes

Go to the Error Center For more information, see error codes.