ListCommonTicketFields-阿里云帮助中心

Retrieves the ticket field types that are defined for an instance.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID.	ccc-test

Response elements

Element	Type	Description	Example
	object	GetSchemaResponse
Data	object	Data.
InstanceId	string	Instance ID.	ccc-test
Id	string	Schema ID.	ticketing
Properties	object	List of fields.
	object	Field.
DisplayName	string	Display name.	姓名
Description	string	Description.	name
Name	string	Name.	name
DataType	string	Data type.	string
Pattern	string	Regular expression validation rule.	^
PatternErrorMessage	string	Regular expression validation error message.	不是有效的email地址
MinLength	integer	Minimum length.	1
MaxLength	integer	Maximum length.	10
Minimum	number	Minimum numeric value.	1
Maximum	number	Maximum numeric value.	10
Required	boolean	Whether the field is required.	false
System	boolean	Whether the field is a system field.	false
Disabled	boolean	Whether the field is disabled.	false
Array	boolean	Whether the field is an array.	false
ReadOnly	boolean	Whether the field is read-only.	false
EditorType	string	Editor type.	textbox
Attributes	string	Extension attributes.	{}
DisplayOrder	integer	Display order in the list.	1
CreatedTime	integer	Creation time.	1703517780627
UpdatedTime	integer	Update time.	1716211430928
Creator	string	Creator.	creator@ccc-test
CreatedTime	string	Creation time.	1703517780627
UpdatedTime	string	Last modification time.	1716211430928
RequestId	string	Request ID.	30C7D235-DDCF-4C7F-A462-5E2598252C2B
HttpStatusCode	integer	HTTP status code.	200
Code	string	Response code.	OK
Message	string	Response message.	无
Params	array	List of error parameters.
	string	Error parameter.	无

Examples

Success response

JSON format

{
  "Data": {
    "InstanceId": "ccc-test",
    "Id": "ticketing",
    "Properties": {
      "key": {
        "DisplayName": "姓名",
        "Description": "name",
        "Name": "name",
        "DataType": "string",
        "Pattern": "^",
        "PatternErrorMessage": "不是有效的email地址",
        "MinLength": 1,
        "MaxLength": 10,
        "Minimum": 1,
        "Maximum": 10,
        "Required": false,
        "System": false,
        "Disabled": false,
        "Array": false,
        "ReadOnly": false,
        "EditorType": "textbox",
        "Attributes": "{}\n",
        "DisplayOrder": 1,
        "CreatedTime": 1703517780627,
        "UpdatedTime": 1716211430928,
        "Creator": "creator@ccc-test"
      }
    },
    "CreatedTime": "1703517780627",
    "UpdatedTime": "1716211430928"
  },
  "RequestId": "30C7D235-DDCF-4C7F-A462-5E2598252C2B",
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "无",
  "Params": [
    "无"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	NotExists.InstanceId	The specified instance %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.