Adobe Captivate · Schema

Relationship

A JSON:API relationship object

AuthoringEducationeLearningLMSSCORMTrainingxAPI

Properties

Name Type Description
data object
links object
View JSON Schema on GitHub

JSON Schema

prime-api-relationship-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe-captivate/refs/heads/main/json-schema/prime-api-relationship-schema.json",
  "title": "Relationship",
  "description": "A JSON:API relationship object",
  "type": "object",
  "properties": {
    "data": {
      "oneOf": [
        {
          "type": "object",
          "description": "JSON:API resource identifier",
          "required": [
            "id",
            "type"
          ],
          "properties": {
            "id": {
              "type": "string",
              "description": "Resource identifier"
            },
            "type": {
              "type": "string",
              "description": "Resource type name"
            }
          }
        },
        {
          "type": "array",
          "items": {
            "type": "object",
            "description": "JSON:API resource identifier",
            "required": [
              "id",
              "type"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "Resource identifier"
              },
              "type": {
                "type": "string",
                "description": "Resource type name"
              }
            }
          }
        }
      ]
    },
    "links": {
      "type": "object",
      "properties": {
        "related": {
          "type": "string",
          "format": "uri",
          "description": "URL to fetch the related resource"
        }
      }
    }
  }
}