Create a new schema

Request format should be as specified in http://json-schema.org/documentation.html (draft 6)
Sample – refer here http://json-schema.org/examples.html
Below additional system fields will be included while persisting in database

• sysCorrelationId – unique id to identify transaction which created the schema
• sysClientId – client id which user, which updated schema, belong to
• sysSchemaCollectionId – id to logical group various schema
• sysEntityType / sysRelationType / sysMessageType / sysEventType – unique identifier for schema to be updated (part of request URI)
• sysTimestamp – time at which schema was updated
• sysSchemaVersion – new version of schema
• sysState – state of schema viz. new / published; default to new when updated
• sysActive – default to true
• sysRequestorId – id of user who updated schema
• schema – the json schema body sent as part of request

URL

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

Method

Required IMS Scopes

• apollo_admin

URL Query Parameters

Request Header Parameters

Request Body Parameters

Example

Request

curl -X POST 
  'https://{{HOST}}/apollo/schema/entitytypes '
  -H 'Authorization: Bearer {access_token}' 
  -H 'Content-Type: application/schema+json' 
  -H 'schemaCollectionId: Brick:Draft' 
  -d '[{
  "type": "object",
  "title": "Brick:Timeseries",
  "sysEntityType": "Brick:Timeseries",
  "required": [
    "id",
    "timeseriesId"
  ],
  "$schema": "http://json-schema.org/draft-06/schema#",
  "description": "Schema for Entity Brick:Timeseries",
   "schemaMetadata": {
      "entityTypeTags": [
        "Timeseries"
      ],
      "entityType": "Brick:Timeseries",
      "schemaCollectionId": "Brick:Draft",
      "entityIsSubClassOf": [

      ]
    },
  "properties": {
    "id": {
      "type": "string",
      "description": "Same as timeseriesId"
    },
    "entityType": {
      "type": "string",
      "description": "Name of the Timeseries"
    },
    "timeseriesId": {
      "type": "string",
      "description": "Id of Timeseries in TS API"
    },
    "customData": {
      "type": "object",
      "description": "Dictionary to hold any data that you want"
    }
  }
}]'

Response

{
    "status": {
        "message": "success",
        "code": "201"
    },
    "transactionId": "22083F068363470197991E885D21E6E9",
    "data": {
        "status": "success",
        "reason": "attempted '1' schemas: inserted '0' schemas, updated '1' schemas, '0' failed",
        "success": [
            "Brick:Timeseries"
        ],
        "failed": []
    },
    "paging": null
}

Errors

Response Body Parameters