Help Center/ EventGrid/ API Reference/ APIs/ Event Schema Management/ Obtaining Event Schema Version Details

Updated on 2025-11-07 GMT+08:00

View PDF

Obtaining Event Schema Version Details

Function

This API is used to obtain the details about an event schema version.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/{project_id}/schemas/{schema_id}/versions/{version}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant resource space ID.
schema_id	Yes	String	ID of the event schema.
version	Yes	Integer	Version of the event schema.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	ID of the event schema version.
schema_id	String	ID of the event schema.
version	Integer	Version number of the event schema.
format	String	Format of the event schema.
created_time	String	Time when the event schema is created.
updated_time	String	Time when the event schema is updated.
definition	String	Event schema content definition.

Example Requests

Obtain the event schema version details.

GET https://{endpoint}/v1/{project_id}/schemas/{schema_id}/versions/{version}

Example Responses

Status code: 200

Operation successful.

{
  "id" : "6f70e150-f20c-4c22-85aa-78ceecd52b98",
  "schema_id" : "2a0ee4f2-78a4-4122-80af-7455e37f64ee",
  "version" : 1,
  "format" : "OPENAPI_3_0",
  "created_time" : "2021-12-09 09:00:00",
  "updated_time" : "2021-12-09 09:00:00",
  "definition" : "{\"$schema\": \"http://json-schema.org/draft-06/schema#\",\"title\": \"fileUpload\",\"definitions\": {\"fileUpload\": {\"properties\": {\"fileName\": {\"type\": \"string\"},\"fileSize\": {\"type\": \"integer\"}},\"required\": [\"foo\",\"bar\"],\"type\": \"object\"}},\"properties\": {\"specversion\": {\"type\": \"string\"},\"id\": {\"type\": \"string\"},\"type\": {\"type\": \"string\"},\"source\": {\"type\": \"string\"},\"subject\": {\"type\": \"string\"},\"datacontenttype\": {\"type\": \"string\"},\"dataschema\": {\"type\": \"string\"},\"time\": {\"format\": \"date-time\",\"type\": \"string\"},\"data\": {\"$ref\": \"#/definitions/fileUpload\"}},\"required\": [\"id\",\"source\",\"time\",\"type\",\"specversion\"],\"type\": \"object\"}"
}