Schemas

Project

idstring

identifier of the project. autogenerated during create project operation
name*string

identifying name of the project
includeContentTypesboolean

whether to include content types in the project. this allows users to add/edit the content types in the scope of the project. there could be maximum of only one project which includes content types. false by default
descriptionstring

description of the project
statestate of the project

ProjectState
statusstring
readOnly: true

project status

IN_PROGRESS - the project is in progress
ADDING_CHANNEL - a channel is getting added to the project
REBASING - The project is getting rebased
REBASE_ERROR - The previous rebase operation has been failed
IN_REVIEW - the project is in review
APPROVED - the project changes has been approved
MERGING - the project is getting merged
MERGED - the project has been merged successfully
MERGE_ERROR -the previous merge operation has been failed
DELETED - the project has been deleted
DELETING - not supported
RUNNING - not supported
START_RUNNING - not supported
STOP_RUNNING - not supported

Enum:
[IN_PROGRESS, ADDING_CHANNEL, REBASING, REBASE_ERROR, IN_REVIEW, APPROVED, MERGING, MERGED, MERGE_ERROR, DELETED, DELETING, RUNNING, START_RUNNING, STOP_RUNNING]
messagestring
readOnly: true

status message
errorslist of errors occured during rebase and merge operations
readOnly: true

ProjectErrors (details provided in Table A)
availableActionsreadOnly: true

available actions for the current state. REBASE_PROJECT value is included if the project can be rebased
itemsitems added to the project

ProjectItem
channelsreadOnly:true
channels added to the project

ProjectChannel (details provided in Table B)
contentTypesreadOnly:true
content types added to the project

ProjectContentType (details provided in Table C)
documentsreadOnly:true
documents added to the project

ProjectDocument (details provided in Table D)
pagesreadOnly:true
pages added to the project

ProjectPage (details provided in Table E)
resourceBundlesreadOnly:true
resource bundles added to the project

ProjectResourceBundle (details provided in Table F)
systemsystem properties

ProjectSystem
createdBystring
readOnly:true

the name of the user that created the project
createdAtstring($date-time)
readOnly:true

date of create
updatedBystring
readOnly:true

the name of the user that updated the project
updatedAtstring($date-time)
readOnly:true

date of update
mergedBystring
readOnly:true

the name of the user that merged the project
mergedAtstring($date-time)
readOnly:true

date of merge

Table A

ProjectErrors
channelsreadOnly: true
channels with merge or rebase errors

ProjectError (details provided in Table G)
contentTypesreadOnly: true
content types with merge or rebase errors

ProjectError (details provided in Table G)
documentsreadOnly: true
documents with merge or rebase errors

ProjectError (details provided in Table G)
pagesreadOnly: true
pages with merge or rebase errors

ProjectError (details provided in Table G)
resourceBundlesreadOnly: true
resource bundles with merge or rebase errors

ProjectError (details provided in Table G)

Table B

ProjectChannel
idstring
readOnly: true

identifier of the channel
displayNamestring
readOnly:true

display name of the channel

Table C

ProjectContentType
namestring
readOnly: true

name of the content type
displayNamestring
readOnly: true

display name of the content type

Table D

ProjectDocument
pathstring
readOnly: true

content path of the document
displayNamestring
readOnly: true

display name of the document

Table E

ProjectPage
pathstring
readOnly: true

content path of the page
displayNamestring
readOnly: true

display name of the page

Table F

ProjectResourceBundle
pathstring
readOnly: true

content path of the resource bundle
displayNamestring
readOnly: true

display name of the resource bundle

Table G

ProjectError
targetstring
readOnly: true

the project item
messagestring
readOnly: true

error message for the project item

ProjectMerge

approveAllChangesboolean

whether to review and approve the project automatically, false by default