The identity and technical contract details declared by the specification.
Asset0
object
40 properties
1 required
QueryResult0
object
6 properties
4 required
ErrorResponse0
object
an error response.
5 properties
5 required
Error0
object
an individual error, info or warning message.
8 properties
8 required
NewCategory1
object
7 properties
1 required
Category1
object
16 properties
8 required
QueryResult1
object
6 properties
QueryResultV21
object
6 properties
ErrorResponse1
object
an error response.
5 properties
5 required
Error1
object
an individual error, info or warning message.
10 properties
10 required
ProjectCreate2
object
4 properties
1 required
BulkRequest2
object
1 property
BulkRequestWithId2
object
1 property
1 required
BulkMoveRequest2
object
2 properties
2 required
BulkResponse2
object
6 properties
ErrorResponse2
object
an error response.
5 properties
5 required
Error2
object
an individual error, info or warning message.
10 properties
10 required
QueryResult2
object
6 properties
Project2
object
18 properties
2 required
ResponseComment4
object
14 properties
14 required
NewComment4
object
2 properties
2 required
EditComment4
object
1 property
1 required
QueryResult4
object
6 properties
4 required
ErrorResponse4
object
An error response.
5 properties
5 required
Error4
object
an individual error, info or warning message.
8 properties
8 required
Cognitive5
object
2 properties
Count5
object
1 property
1 required
NewContent5
object
5 properties
2 required
Content5
object
22 properties
UpdateContent5
object
2 properties
QueryResult5
object
6 properties
BulkDelete5
object
1 property
ErrorResponse5
object
an error response.
5 properties
5 required
Error5
object
an individual error, info or warning message.
10 properties
10 required
NewDefaultContent5
object
3 properties
2 required
DefaultContent5
object
17 properties
UpdateDefaultContent5
object
2 properties
DefaultContentQueryResult5
object
6 properties
ValidationResult5
object
a validation response.
2 properties
CopyBody7
array
The items to copy. The items need to be either ready OR belong to same project. Additional parameters "name", "add" and "remove" can be passed with each item t…
CopyResponse7
object
An acknowledgement of the copy operation request.
3 properties
CopyRecord7
object
a copy operation document.
14 properties
CopyResult7
object
A copy operation result.
9 properties
ErrorResult7
object
an error response.
5 properties
Message7
object
an individual error, info or warning message.
10 properties
NewLayout9
object
A new layout.
12 properties
2 required
NewLayoutMapping9
object
A new layout mapping.
8 properties
3 required
ExistingLayout9
object
An existing layout.
19 properties
3 required
ExistingLayoutMapping9
object
An existing layout mapping.
15 properties
4 required
ResolvedLayout9
object
An existing layout returned from one of the resolution end points.
17 properties
LayoutQueryResult9
object
A query result that returns layouts.
6 properties
ResolvedLayoutQueryResult9
object
A query result that returns resolved layouts.
6 properties
LayoutMappingQueryResult9
object
A query result that returns layout mappings.
6 properties
TypeMapping9
object
The mapped content-type. Must be unique. During create and update operations, the mapped content-type can be referred to by either id or name.
2 properties
LayoutMappingEntry9
object
an individual layout mapping entry. During creates and updates, if there is only one layout specified within the 'layouts' property, then the 'defaultLayout' p…
2 properties
2 required
LayoutReference9
object
an individual layout reference.
2 properties
1 required
ErrorResult9
object
an error response.
5 properties
Message9
object
an individual error, info or warning message.
10 properties
IncomingReferenceMetadata11
object
3 properties
BatchIncomingReferenceMetadata11
array
Classification11
string
Every item in content hub has a classification the classification and id combine to make a unique id across different types of items in content hub.
SearchMetadata11
object
The metadata property is only added if you use include=metadata. Additionally the contents of this object mirrors what is returned by search which is why the s…
OutgoingReferenceMetadata11
object
5 properties
OutgoingReferencesResponse11
object
5 properties
OutgoingReferenceRequest11
object
6 properties
IncomingReferencesResponse11
object
6 properties
ErrorResponse11
object
an error response.
5 properties
5 required
Error11
object
an individual error, info or warning message.
10 properties
10 required
IncomingReferenceRequest11
object
5 properties
DeletedQueryResult11
object
6 properties
4 required
DeletedItem11
object
6 properties
5 required
RenditionParameters12
object
7 properties
1 required
Link12
object
1 property
1 required
QueryResult12
object
6 properties
4 required
ErrorResponse12
object
an error response.
5 properties
5 required
Error12
object
an individual error, info or warning message.
9 properties
9 required
Count13
object
1 property
NewImageProfile13
object
An new image profile.
7 properties
3 required
ExistingImageProfile13
object
An existing image profile.
14 properties
5 required
MultiImageProfile13
object
4 properties
Dimension13
object
A indiviual dimension within an image profile.
5 properties
ImageProfileQueryResult13
object
A query result that returns image profiles.
6 properties
ErrorResult13
object
an error response.
5 properties
Message13
object
an individual error, info or warning message.
10 properties
ErrorResponse14
object
an error response.
5 properties
5 required
Error14
object
an individual error, info or warning message.
10 properties
9 required
QueryResult14
object
6 properties
4 required
ResourceMetadata14
object
2 properties
2 required
NewReview15
object
4 properties
1 required
Review15
object
16 properties
3 required
Approval15
object
3 properties
Rejection15
object
3 properties
UpdateReview15
object
4 properties
2 required
UniqueIDs15
array
Provide the ID of the items that you want to submit for review. The unique ID (uid) is the items classification and the ID combined to create an ID that is uni…
User15
object
A user object with user ID.
1 property
DocumentID15
object
The unique document ID is the items classification and the ID combined to create an ID that is unique across all content hub items.
2 properties
BulkRequest15
object
1 property
1 required
RejectRequest15
object
2 properties
1 required
ErrorResponse15
object
An error response.
5 properties
5 required
Error15
object
an individual error, info or warning message.
10 properties
10 required
Documents16
object
1 property
Document16
object
1 property
1 required
collection16
object
6 properties
ErrorMessage16
object
This JSON object describes an error condition.
3 properties
2 required
Error16
object
This JSON object describes a specific error of an error condition.
8 properties
2 required
SiteCreatedUpdatedResponse17
object
Site Metadata update response
5 properties
SiteMetaData17
object
Site Metadata
9 properties
SiteList17
object
List of available sites
1 property
SiteCreate17
object
Create Site Metadata
5 properties
SiteUpdate17
object
Updating Site Metadata
4 properties
AllPages17
object
List of all pages from all sites
1 property
PageHierarchy17
object
Hierachy of pages in the site
1 property
PageList17
object
A list of pages in the site modified between certain dates
1 property
PageNew17
object
Creation of Page Metadata
10 properties
PageUpdate17
object
Update of Page Metadata
13 properties
Page17
object
Page Metadata
17 properties
HierarchicalPage17
object
Page Metadata of page in hierarchy
14 properties
DeletePagesInBulkRequest17
object
Delete pages
1 property
DeletePagesInBulkResponse17
object
1 property
MoveResult17
object
Target Parent Updated Values After Move
2 properties
DraftPageIds17
object
Publish the list of draft page Ids
1 property
ReadyPagesInBulkRequest17
object
Publish the list of draft pages.
2 properties
ReadyPagesIds17
object
List of pages that needs to be moved to ready state
3 properties
ProjectContext17
object
2 properties
ReadyPagesInBulkResponse17
object
1 property
CreateDraftPagesInBulkRequest17
object
List of draft pages to create.
2 properties
DraftPagesToCreateIds17
object
List of pages to be created as drafts
3 properties
DraftsProjectContext17
object
3 properties
CreateDraftPagesInBulkResponse17
object
3 properties
Error17
object
Error
6 properties
ErrorMessage17
object
ErrorMessage
3 properties
BlankContent18
object
An blank content document.
3 properties
NewType18
object
An new type document.
14 properties
6 required
ExistingType18
object
An existing type document.
25 properties
8 required
ElementDef18
object
An element definition.
12 properties
TypeQueryResult18
object
A query result that returns type documents.
6 properties
ElementDefQueryResult18
object
A query result that returns element definitions.
6 properties
TypeElement18
object
Represents an element within a content type. Only properties common to all elements are currently shown. For examples of each of the supported elements, see th…
10 properties
3 required
DocumentLinks18
object
List of available operations, only shown when optional 'include' query string parameter includes 'links'.
1 property
WorkflowStatus18
string
the workflow status.
TypeClassification18
string
the type document classification.
TypeKind18
array
Identifies the sub-classification of the type document. Valid values include: custom-ui: This type document has a custom user interface defined embedded: This…
TypeIcon18
array
Specifies the type of icon to show for this type document within the Type user interface's element palette Only used when the type document has a kind that inc…
TypeUIExtensions18
object
Specifies any user interface extensions registered on this type document.
1 property
ElementDefClassification18
string
the element definition classification.
Count18
object
1 property
ErrorResult18
object
an error response.
5 properties
Message18
object
an individual error, info or warning message.
10 properties
ValidationResult18
object
a validation response.
4 properties
AllVersions20
object
All versions for the specified item.
4 properties
4 required
Version20
object
A specific version of an item.
8 properties
DraftVersion20
object
a Draft version of the specified item
7 properties
VersionPolicyStatus20
object
Response to indicate if the version policy status is in effect.
1 property
VersionPolicy20
object
Representation of the version policy
2 properties
VersionEvent20
string
Version Event: published - Published, The item was published and the ready item was updated created - Created, The item was created updated - Updated, the item…
ErrorResponse20
object
An error response.
5 properties
5 required
Error20
object
an individual error, info or warning message.
10 properties
10 required
Error21
object
Error
6 properties
ErrorMessage21
object
ErrorMessage
3 properties
BulkRetrievalRequest22
object
2 properties
1 required
Content22
object
14 properties
Error22
object
3 properties
IdsListForBulkRetrieval22
array
An array of ids that should be retrieved by this bulk request.
FieldsListForBulkRetrieval22
array
An array of fields that should be returned by this bulk request.
ContentArray22
array
An array of JSON objects that contain the requested content items.
ConfigObject23
object
Configuration information for a tenant
5 properties
Url23
object
Properties of a URL
12 properties
SiteMetaData23
object
Site Metadata
9 properties
PageMetaData23
object
Page Metadata
19 properties
SearchEntry23
object
1 property
RenderingContext23
object
15 properties
ErrorMessage23
object
This JSON object describes an error condition.
3 properties
2 required
Error23
object
This JSON object describes a specific error of an error condition.
8 properties
2 required
ErrorDefault24
object
3 properties
Error24
object
3 properties
Documents25
object
1 property
Document25
object
1 property
1 required
collection25
object
6 properties
ErrorMessage25
object
This JSON object describes an error condition.
3 properties
2 required
Error25
object
This JSON object describes a specific error of an error condition.
8 properties
2 required
Site26
object
8 properties
Content26
object
14 properties
Page26
object
18 properties
Error26
object
3 properties
MultiPages26
object
1 property
Tenant35
object
32 properties
1 required
TenantAnonymous35
object
5 properties
TenantPut35
object
23 properties
AssetPublishApproval35
object
Can not be set for Base tiers
2 properties
ContentPublishApproval35
object
Can not be set for Base tiers
2 properties
DeliveryAccess35
object
3 properties
Error35
object
3 properties
IbmCommerce35
object
7 properties
TenantInfo37
object
Object containing the tenantId and baseUrl
2 properties
TenantArray37
array
The list of available tenants for the authenticated user
Status37
object
3 properties
Error40
object
This JSON record represents an individual error or warning contained in an error message.
8 properties
2 required
ErrorMessage40
object
This JSON record represents an error condition.
3 properties
2 required
Id40
string
The unique internal identifier of the user
ExternalId40
string
The unique external identifier of the user (e.g. BlueID). Although, this field can store email addresses, other types of unique identifiers may be stored too.…
FirstName40
string
The first name of the user
uid40
string
Acoustic Id of the user, if not present during POST call an Acoustic Id will be created for the user
LastName40
string
The last name of the user
DisplayName40
string
The name of the user that can be displayed in the UI
Email40
string
The email of the user that can be displayed in the UI
Roles40
array
The roles of the user that will be used for access control
RolesRetrieval40
array
The roles of the user that will be used for access control (empty for the anonymous user)
LastLogin40
string
Date when this user logged in for the last time before current session
Created40
string
Date when this item was created
LastModified40
string
Date when this item was modified for the last time
HttpVerb40
string
The supported HTTP methods
Creator40
object
URI pointing to the User who has created the item
1 property
1 required
LastModifier40
object
URI pointing to the User who has modified the item
1 property
1 required
PrivacyNotices40
object
The privacy notices that the user has accepted
2 properties
1 required
PrivacyNoticeHistory40
object
The privacy notice that the user has accepted
3 properties
2 required
PrivacyNotice40
object
The privacy notice that the user has accepted
4 properties
2 required
PrivacyNoticeResponse40
object
The privacy notice that the user has accepted
4 properties
1 required
UriSelf40
object
URI pointing to this document
3 properties
2 required
User40
object
The user object that might be returned.
15 properties
3 required
EnrichedUser40
object
The user object that might be returned.
14 properties
3 required
Approver40
object
The approver object that might be returned.
4 properties
1 required
EditorManagerAdmin40
object
The match object that might be returned.
5 properties
1 required
UserCreation40
object
The user object that might be sent for user creation.
7 properties
2 required
UserUpdate40
object
The user object that might be sent to replace the user. The fields id, externalId, links, created, creator, lastModified, and lastModifier will be ignored.
13 properties
1 required
UserUpdateLogin40
object
The user object that might be sent to replace the user. The fields id, externalId, links, created, creator, lastModified, and lastModifier will be ignored.
14 properties
1 required
UriFirst40
object
URI pointing to the first sublist of items of the complete list
1 property
1 required
UriPrev40
object
URI pointing to the previous sublist of items of the complete list
1 property
1 required
UriNext40
object
URI pointing to the next sublist of items of the complete list
1 property
1 required
ItemList40
object
3 properties
2 required
ApproverList40
object
4 properties
1 required
WebhookProfile44
object
A webhook profile.
8 properties
WebhookDef44
object
An individual webhook.
5 properties
1 required
ErrorResult44
object
an error response.
5 properties
Message44
object
an individual error, info or warning message.
10 properties
error46
object
This JSON record represents an individual error or warning contained in an error message.
8 properties
2 required
error_message46
object
This JSON record represents an error condition.
3 properties
2 required
localizedItem46
object
2 properties
1 required
localizedItemCreation46
object
2 properties
1 required
managedItem46
object
7 properties
6 required
managedItemCreation46
object
6 properties
managedItemUpdate46
object
7 properties
2 required
itemList46
object
4 properties
3 required
unmanagedJobDefinition46
object
2 properties
jobDefinitionCore46
object
2 properties
jobDefinitionCreation46
object
TBD: Give a little help on job definition creation here...
jobDefinitionUpdate46
object
TBD: Give a little help on job definition creation here...
jobDefinitions46
object
Returns a (sub-)list of items from the complete list of jobDefinitions. At most [limit] items are returned.
1 property
1 required
job46
object
3 properties
2 required
jobCreation46
object
created job. When creating a job, you can specify mode that can be used.
1 property
jobs46
object
Returns a (sub-)list of items from the complete list of jobs. At most [limit] items are returned.
1 property
1 required
siteRevisionCore46
object
5 properties
siteRevision46
object
1 required
siteRevisionUpdate46
object
Only properties autoPublishEnabled, name and description will be updated, others will be ignored
siteRevisions46
object
Returns a (sub-)list of items from the complete list of site revisions. At most [limit] items are returned.
1 property
1 required
status46
object
6 properties
6 required
message46
object
4 properties
task46
object
5 properties
profileCore46
object
8 properties
profileCreation46
object
TBD:
profileUpdate46
object
TBD:
profileCreationForJobCreation46
object
TBD:
profiles46
object
Returns a (sub-)list of items from the complete list of profiles. At most [limit] items are returned.
1 property
1 required
sourceCore46
object
1 property
sourceDocs46
object
Map which enumerates the events that shall be published grouped by their classification ('content', 'asset', etc.).
6 properties
docEvents46
object
Map which enumerates the items that shall be published groupd by their event type ('created', 'updated', etc.)
3 properties
sources46
object
Returns a (sub-)list of items from the complete list of sources. At most [limit] items are returned.
1 property
1 required
jobState46
string
Enumeration of publishing job states
created46
string
date when this item was created
lastModified46
string
date when this item was modifed for the last time
rev46
string
a string identifying a specific version of the document
description46
object
an object holding the localized description for multiple languages
title46
object
an object holding the localized title for multiple languages
jobMode46
string
Specifies if the site revision will be updated or rebuilt from scratch. Default is 'UPDATE'
site46
object
tbd
1 property
urlSelf46
object
url pointing to this document
3 properties
2 required
urlFirst46
object
URI pointing to the first sublist of items of the complete list
1 property
1 required
urlPrev46
object
URI pointing to the previous sublist of items of the complete list
1 property
1 required
urlNext46
object
URI pointing to the next sublist of items items of the complete list
1 property
1 required
urlLast46
object
URI pointing to the last sublist of the complete list
1 property
1 required
urlCreator46
object
A reference to the User who has created the item
1 property
1 required
urlLastModifier46
object
A reference to the User who has modified the item
1 property
1 required
profileRef46
object
A reference to a publishing profile
1 property
1 required
siteRevisionRef46
object
A reference to a site revision
1 property
1 required
sourceRef46
object
A reference to a publishing source
1 property
1 required
ErrorResponse
object
This JSON record represents an error condition.
3 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.