Contents
The Links Object
Key-Value Object. Where Key is Unique identifier for the Content object and Value is Content Metadata.
Dictionary of keystring
and value object ContentMetadata
. THE LINKS OBJECT
The Content Metadata Object
Content Metadata define short information about a Content for navigation reason.
Properties
- Name
id
- Type
- Required string of format uri
- Description
Unique identifier for the object.
- Name
kind
- Type
- Required enum
- Description
Define the type of Content, whether it is a FOLDER or DOCUMENT.
Possible enum values:- FOLDER
- DOCUMENT
- Name
name
- Type
- Required string
- Description
Name of the Content
- Name
slug
- Type
- Required string
- Description
SLUG of the Content
- Name
parentSlug
- Type
- Required string
- Description
Parent SLUG of the Content
- Name
fullSlug
- Type
- Required string
- Description
Combination of SLUG and Parent SLUG of the Content
- Name
createdAt
- Type
- Required string of format date-time
- Description
Date and Time at which the Content was created.
- Name
updatedAt
- Type
- Required string of format date-time
- Description
Date and Time at which the Content was updated.
- Name
publishedAt
- Type
- Optional string of format date-time
- Description
Date and Time at which the Content was published.
THE CONTENT METADATA OBJECT
The Content Object
Content define shared object for all possible Content Types.
Properties
- Name
id
- Type
- Required string of format uri
- Description
Unique identifier for the object.
- Name
kind
- Type
- Required enum
- Description
Define the type of Content, whether it is a FOLDER or DOCUMENT.
Possible enum values:- FOLDER
- DOCUMENT
- Name
name
- Type
- Required string
- Description
Name of the Content
- Name
locale
- Type
- Optional string
- Description
Locale unique identifier (ISO 639-1).
- Name
slug
- Type
- Required string
- Description
SLUG of the Content
- Name
parentSlug
- Type
- Required string
- Description
Parent SLUG of the Content
- Name
fullSlug
- Type
- Required string
- Description
Combination of SLUG and Parent SLUG of the Content
- Name
createdAt
- Type
- Required string of format date-time
- Description
Date and Time at which the Content was created.
- Name
updatedAt
- Type
- Required string of format date-time
- Description
Date and Time at which the Content was updated.
- Name
publishedAt
- Type
- Optional string of format date-time
- Description
Date and Time at which the Content was published.
- Name
data
- Type
- Object
ContentData
- Description
THE CONTENT OBJECT
The Content Data Object
ContentData defined Object to connect all possible root Schemas.
THE CONTENT DATA OBJECT
Retrieve Links to all Contents
The endpoint allows you to retrieve all Content summery metadata mainly used to recreate content tree. In case cache version is not present, it will redirect to the latest version.
Parameters
- Name
spaceId
- Type
- Required string in path
- Description
Unique identifier for the Space object.
- Name
kind
- Type
- Optional enum in query
- Description
Content Kind. FOLDER or DOCUMENT. If not provided, it will return all.
Possible enum values:- FOLDER
- DOCUMENT
- Name
startSlug
- Type
- Optional string in query
- Description
Content start slug.
- Name
cv
- Type
- Optional string in query
- Description
Cache version.
- Name
token
- Type
- Required string in query
- Description
Authentication Token.
Returns
- Description
Return the Links Object if the request succeeded.
Response
Retrieve Content by Slug
The endpoint allows you to retrieve a specific Content by the content full slug. In case cache version is not present, it will redirect to the latest version.
Parameters
- Name
spaceId
- Type
- Required string in path
- Description
Unique identifier for the Space object.
- Name
contentSlug
- Type
- Required string in path
- Description
Content full slug.
- Name
cv
- Type
- Optional string in query
- Description
Cache version.
- Name
locale
- Type
- Optional string in query
- Description
Locale unique identifier (ISO 639-1).
- Name
version
- Type
- Optional enum in query
- Description
Content version.
Possible enum values:- draft
- Name
token
- Type
- Required string in query
- Description
Authentication Token.
Returns
- Description
Return the Content Object if the request succeeded.
Response
Retrieve Content By ID
The endpoint allows you to retrieve a specific Content by Unique identifier for the Content object. In case cache version is not present, it will redirect to the latest version.
Parameters
- Name
spaceId
- Type
- Required string in path
- Description
Unique identifier for the Space object.
- Name
contentId
- Type
- Required string in path
- Description
Unique identifier for the Content object.
- Name
cv
- Type
- Optional string in query
- Description
Cache version.
- Name
locale
- Type
- Optional string in query
- Description
Locale unique identifier (ISO 639-1).
- Name
version
- Type
- Optional enum in query
- Description
Content version.
Possible enum values:- draft
- Name
token
- Type
- Required string in query
- Description
Authentication Token.
Returns
- Description
Return the Content Object if the request succeeded.