Adobe Captivate · Schema

Skill

A skill competency defined in the Learning Manager system

AuthoringEducationeLearningLMSSCORMTrainingxAPI

Properties

Name Type Description
id string Unique skill identifier
type string
attributes object
relationships object
View JSON Schema on GitHub

JSON Schema

prime-api-skill-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-skill-schema.json",
  "title": "Skill",
  "description": "A skill competency defined in the Learning Manager system",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique skill identifier"
    },
    "type": {
      "type": "string",
      "const": "skill"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "description": "Skill description"
        },
        "name": {
          "type": "string",
          "description": "Skill name"
        },
        "state": {
          "type": "string",
          "description": "Skill state",
          "enum": [
            "Active",
            "Retired"
          ]
        }
      }
    },
    "relationships": {
      "type": "object",
      "properties": {
        "skillLevels": {
          "type": "object",
          "description": "A JSON:API relationship 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"
                }
              }
            }
          }
        },
        "learningObjects": {
          "type": "object",
          "description": "A JSON:API relationship 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"
                }
              }
            }
          }
        }
      }
    }
  }
}