You can call this operation to query detailed information of tickets.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListOrders

The operation that you want to perform. Set the value to ListOrders.

EndTime String No 2019-10-10 00:00:00

The end of the time range to query.

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 tickets submitted by the current user.
  • AS_HANDLER: the tickets to be processed by the current user.
  • AS_OWNER: the tickets processed by the current user.
  • AS_Related: the tickets related to the current user.
OrderStatus String No ALL

The status of the ticket. Valid values:

  • ALL: all tickets.
  • FINISHED: the closed tickets.
  • RUNNING: the ongoing tickets.
PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 10

The number of entries to return on each page.

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.
SearchContent String No test

The content to query.

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 beginning of the time range to query.

Tid Long No -1

The ID of the tenant.

Response parameters

Parameter Type Example Description
Orders Array

The detailed information of tickets.

Order

The detailed information of a ticket.

Comment String test

The description of the ticket.

Committer String test

The user who submitted the ticket.

CommitterId Long 1

The ID of the user who submitted the ticket.

CreateTime String 2019-10-10 00:00:00

The time when the ticket was created.

LastModifyTime String 2019-10-10 00:00:00

The last time when the ticket was modified.

OrderId Long 1432

The ID of the ticket.

PluginType String DC_COMMON

The type of the ticket.

StatusCode String success

The status code of the ticket.

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 was successful.

TotalCount Long 100

The total number of tickets that met the query conditions.

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[RAM user]</Committer>
        <StatusDesc>Data change is successful.</StatusDesc>
        <LastModifyTime>2019-11-19 13:53:05</LastModifyTime>
        <CreateTime>2019-11-19 13:52:36</CreateTime>
        <OrderId>737160</OrderId>
        <Comment>Test the data change.</Comment>
        <CommitterId>104442</CommitterId>
    </Order>
    <Order>
        <StatusCode>new</StatusCode>
        <PluginType>DC_COMMON</PluginType>
        <Committer>xxx[RAM user]</Committer>
        <StatusDesc>The ticket is 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 data change ticket creation.</Comment>
        <CommitterId>104442</CommitterId>
    </Order>
    <Order>
        <StatusCode>closed</StatusCode>
        <PluginType>DC_COMMON</PluginType>
        <Committer>xxx[RAM user]</Committer>
        <StatusDesc>The ticket is closed: Database-level operations are not supported.</StatusDesc>
        <LastModifyTime>2019-10-20 22:09:38</LastModifyTime>
        <CreateTime>2019-10-20 22:08:19</CreateTime>
        <OrderId>737089</OrderId>
        <Comment>Test database creation.</Comment>
        <CommitterId>104442</CommitterId>
    </Order>
    <Order>
        <StatusCode>new</StatusCode>
        <PluginType>DC_COMMON</PluginType>
        <Committer>xxx[RAM user]</Committer>
        <StatusDesc>Precheck fails.</StatusDesc>
        <LastModifyTime>2019-09-30 16:58:35</LastModifyTime>
        <CreateTime>2019-09-30 16:58:34</CreateTime>
        <OrderId>737016</OrderId>
        <Comment>Test</Comment>
        <CommitterId>104442</CommitterId>
    </Order>
    <Order>
        <StatusCode>success</StatusCode>
        <PluginType>DC_COMMON</PluginType>
        <Committer>xxx[RAM user]</Committer>
        <StatusDesc>Data change is successful.</StatusDesc>
        <LastModifyTime>2019-08-17 14:07:54</LastModifyTime>
        <CreateTime>2019-08-17 14:07:42</CreateTime>
        <OrderId>736774</OrderId>
        <Comment>Test the common data change.</Comment>
        <CommitterId>104442</CommitterId>
    </Order>
</Orders>
<Success>true</Success>

JSON format

{
	"TotalCount":5,
	"RequestId":"7AC17A86-9E6F-484B-AE8D-F9416986A108",
	"Orders":{
		"Order":[
			{
				"StatusCode":"success",
				"PluginType":"DC_COMMON",
				"Committer":"xxx[RAM user]",
				"StatusDesc":"Data change is successful.",
				"LastModifyTime":"2019-11-19 13:53:05",
				"OrderId":737160,
				"CreateTime":"2019-11-19 13:52:36",
				"Comment":"Test the data change.",
				"CommitterId":104442
			},
			{
				"StatusCode":"new",
				"PluginType":"DC_COMMON",
				"Committer":"xxx[RAM user]",
				"StatusDesc":"The ticket is to be submitted for approval.",
				"LastModifyTime":"2019-10-29 20:51:37",
				"OrderId":737116,
				"CreateTime":"2019-10-29 20:51:36",
				"Comment":"Test data change ticket creation.",
				"CommitterId":104442
			},
			{
				"StatusCode":"closed",
				"PluginType":"DC_COMMON",
				"Committer":"xxx[RAM user]",
				"StatusDesc":"The ticket is closed: Database-level operations are not supported.",
				"LastModifyTime":"2019-10-20 22:09:38",
				"OrderId":737089,
				"CreateTime":"2019-10-20 22:08:19",
				"Comment":"Test database creation.",
				"CommitterId":104442
			},
			{
				"StatusCode":"new",
				"PluginType":"DC_COMMON",
				"Committer":"xxx[RAM user]",
				"StatusDesc":"Precheck fails.",
				"LastModifyTime":"2019-09-30 16:58:35",
				"OrderId":737016,
				"CreateTime":"2019-09-30 16:58:34",
				"Comment":"Test",
				"CommitterId":104442
			},
			{
				"StatusCode":"success",
				"PluginType":"DC_COMMON",
				"Committer":"xxx[RAM user]",
				"StatusDesc":"Data change is successful.",
				"LastModifyTime":"2019-08-17 14:07:54",
				"OrderId":736774,
				"CreateTime":"2019-08-17 14:07:42",
				"Comment":"Test the common data change.",
				"CommitterId":104442
			}
		]
	},
	"Success":true
}

Error codes

For a list of error codes, visit the API Error Center.