ContentBundle

The Content API requests reference an object of type ContentBundle. The configuration of the bundle will vary depending on the provided inputs. The following properties define this object.

ContentBundle Properties

• contentId : Id, The ID of the ContentBundle, corresponding to a specific version/revision of the content.
• originId : Id, The ID of version 1.0 of the content.
• siteName : String, The site name of the content.
• siteId : String, The site Id of the content.
• excludeFromSearch : Boolean, Whether the content will be excluded from search results.
• publishedStartDate : DateTime, The published start date this version/revision of the content.
• originalPublishedStartDate : DateTime, The original published start date of the content.
• publishedEndDate : DateTime, The published end date of the content.
• lockedBy : String, The user who currently has a lock on the content.
• lockedDate : DateTime, The date the content was locked.
• createdBy : String, The user who created the content.
• createdDate : DateTime, The created date of the content.
• lastModifiedBy : String, The user who last modified the content.
• lastModifiedDate : DateTime, The last modified date of the content.
• versionsAndRevisions : List<Version>, Lists of all versions and revisions for this content and status of each version.
• version : Decimal, The version number of the content.
• revision : Decimal, The revision number of the content.
• readonly : Boolean, If this field is set to true, the content is in readonly state. Combination of other content status fields and content permission affect its readonly status.
• published : Boolean, If this field is set to true, the readonly status is set to true.
• sentForApproval : Boolean, If this field is set to true, and the user is not the approver of the content, the readonly status is set to true. If this field is set to true, and the user is the approver, but doesn’t have edit or translate permission, the readonly status is set to true. If this field is set to true, and the user is the approver, and has edit or translate permission, the readonly status is set to false.
• expired : Boolean, If this field is set to true, the content is in readonly state.
• locked : Boolean, Used in conjunction with ‘lockedByMe’ flag. If this field is set to true and ‘lockedByMe’ is set to false, the ‘readonly’ is set to true. If this field is set to true and ‘lockedByMe’ is set to true, the ‘readonly’ is set to false.
• lockedByMe : Boolean, Used in conjunction with the ‘locked’ flag. It indicates if the content is locked by the current running user.
• allowEdit : Boolean, User needs Edit Content permissions. If field is set to true, it indicates that the content is unpublished and lockedByMe is set to true. If multilingual license is enabled for the site, the following properties can be edited: StartDate, EndDate, Add Taxonomy Tags to Content, Add Targets to Content, Add Language to Content, Edit/Add language independent attributes. Translate permissions are required for language specific attributes, see LanguageStatus.canTranslate below. If multilingual license is disabled for the site, all the content properties can be edited including all attributes.
• allowPublish : Boolean, User needs Publish Content permission. If field is set to true, it indicates that the content is unpublished, not sent for approval and either lockedByMe is set to true or the content is unlocked.
• allowSendForApproval : Boolean, User needs Edit Content permission. If this field is set to true, the approval is enabled, the content is unpublished,and lockedByMe is set to true or the content is unlocked. The user has to have ‘override approval process’ on their profile unchecked.
• allowClone : Boolean, User needs Create Content permission. Content can be in any state.
• allowExpire : Boolean, User needs Publish Content permission. If set to true, it indicates that the content is published. In addition to Publish Content permission, if an approval process is enabled for the site, the user also needs the override approval permission. That permission needs to be set by the system or site administrator by selecting, on the user's OrchestraCMS profile, “Allow users with this profile to publish independently of the approval process”.
• allowDelete : Boolean, Content cannot be deleted in any type of org if it is sent for approval. The user needs Edit Content permission. If set to true either lockedByMe is true or the content is unlocked and:
  • If the org is either sandbox or developer edition the content can be deleted in published or unpublished state.
  • If the org is a production org, the content has to be in unpublished state and not sent for approval.
• allowVersioning : Boolean, User needs Edit Content permission. If set to true, content is published.
• allowRevisioning : Boolean, User needs Edit Content permission. If set to true, content is published.
• allowTarget : Boolean, User needs Edit Content permission and targeting license needs to be enabled. If set to true, the content is unpublished. Can be a new version or new revision.
• languageStatuses : Map<String, ContentLanguageStatus>, The key is the Language Code (e.g. 'en_US') to the current content language. It contains list of supported languages and the actions allowed per language in the current site.
• contentType : ContentTypeBundle, Content type affiliated with the content in the content bundle.
• contentAttributes : Map<String, List<AttributeBundle.ContentAttribute>>, The key is the Language Code (e.g. 'en_US') and the value is a list of attributes on content for that language. Note, if a new language is added to this map by the client, the associated ContentLanguageStatus must be updated to set isAddedToContent = true.
• contentMetaAttributes : Map<String, AttributeBundle.ContentMetaAttribute>, The key is the Language Code (e.g. 'en_US') and the value is the content meta attribute for that language. Note, if a new language is added to this map by the client, the associated ContentLanguageStatus must be updated to set isAddedToContent = true.
• contentLayouts : Map<String, ContentLayoutBundle>, The key is the content layout instance Id that is used by the system to associate a layout to a content item and the value contains the associated ContentLayoutBundles. When adding a new layout to the content, the client can provide any unique value as the key, the system will return the new instance Id with the returned ContentBundle (if requested).
• taxonomyTagPaths : List<TaxonomyBundle>, List of taxonomy tag paths associated with the content.
• contentTargets : List<TargetBundle>, List of targets associated with the content.

Version Properties

The ContentBundle object references an object of type Version which lists of all versions and revisions for this content and status of each version. The following properties define this object.

• version : Decimal, The version number of the content.
• revision : Decimal, The revision number of the content.
• publishedStartDate : DateTime, The published start date of the content.
• publishedEndDate : DateTime, The published end date of the content.
• published : Boolean, Whether the content version or revision is published. Will return TRUE if content is published.
• expired : Boolean, Whether the content version or revision is expired. Will return TRUE if content is expired.
• sentForApproval : Boolean, Has the content has been sent for approval? Will return TRUE if content has been sent for approval.

ContentLanguageStatus Properties

The ContentBundle object references an object of type ContentLanguageStatus. The following properties define this object.

• isAddedToContent : Boolean, Has the related language been added to the current content item. If this is false, any attributes provided by the client for this language will be ignored.
• canTranslate : Boolean, Is the current API Client user permitted to translate this language (if content is in read­only state this is always false).
• isTranslated : Boolean, A list of filters. For more information see Filter Properties below.
• isActive : Boolean, True if this language is active.
• languageCode : String, Language code for this language. This is also the Key in the map for this language status.