Adobe Captivate · JSON Structure
Prime Api Catalog List Response Structure
Paginated list of catalogs
Type: object
Properties: 2
AuthoringEducationeLearningLMSSCORMTrainingxAPI
CatalogListResponse is a JSON Structure definition published by Adobe Captivate, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
data
links
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/adobe-captivate/refs/heads/main/json-structure/prime-api-catalog-list-response-structure.json",
"name": "CatalogListResponse",
"description": "Paginated list of catalogs",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"description": "A catalog that organizes and controls access to learning objects",
"properties": {
"id": {
"type": "string",
"description": "Unique catalog identifier"
},
"type": {
"type": "string",
"const": "catalog"
},
"attributes": {
"type": "object",
"properties": {
"dateCreated": {
"type": "datetime",
"description": "Timestamp when the catalog was created"
},
"dateUpdated": {
"type": "datetime",
"description": "Timestamp of the last update"
},
"description": {
"type": "string",
"description": "Catalog description"
},
"isDefault": {
"type": "boolean",
"description": "Whether this is the default catalog"
},
"isInternallySearchable": {
"type": "boolean",
"description": "Whether learning objects in this catalog appear in search"
},
"name": {
"type": "string",
"description": "Catalog name"
},
"state": {
"type": "string",
"description": "Catalog state",
"enum": [
"Enabled",
"Disabled"
]
}
}
},
"relationships": {
"type": "object",
"properties": {
"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": "uri",
"description": "URL to fetch the related resource"
}
}
}
}
}
}
}
}
}
},
"links": {
"type": "object",
"description": "Pagination links following JSON:API conventions",
"properties": {
"self": {
"type": "uri",
"description": "URL for the current page"
},
"next": {
"type": "uri",
"description": "URL for the next page"
},
"prev": {
"type": "uri",
"description": "URL for the previous page"
}
}
}
}
}