Get schema by Id and Version

Returns an unique active schema type of particular version for given id and version
Format is as specified in http://json-schema.org/documentation.html (draft 6)
Sample – refer here http://json-schema.org/examples.html

URL

https://{{HOST}}/apollo/schema/entitytypes/{id}/versions/{ver}
https://{{HOST}}/apollo/schema/relationshiptypes/{id}/versions/{ver}
https://{{HOST}}/apollo/schema/messagetypes/{id}/versions/{ver}
https://{{HOST}}/apollo/schema/eventtypes/{id}/versions/{ver}

Method

Required IMS Scopes

• apollo_read

URL Path Parameters

URL Query Parameters

Request Header Parameters

Example

Request

curl -X GET 
  'https://{{HOST}}/apollo/schema/entitytypes/{entityTypes}/versions/{ver}?includeSystemData=false' 
  -H 'Authorization: Bearer {access_token}' 

Response

{
    "status": {
        "message": "Operation completed",
        "code": "200"
    },
    "transactionId": "5BB888CE813F4BB4B39A49777F086AA9",
    "data": {
        "schema": {
            "$schema": "http://json-schema.org/draft-06/schema#",
            "description": "Schema for Entity BRICK_0_4__Building",
            "additionalProperties": false,
            "type": "object",
            "title": "BRICK_0_4__Building",
            "required": [
                "id",
                "name"
            ],
            "properties": {
                "name": {
                    "description": "source entity id",
                    "type": "string"
                },
                "id": {
                    "description": "The unique identifier for the relation",
                    "type": "string"
                }
            }
        }
    },
    "paging": null
}

Errors

Response Body Parameters