Project

A developer project

Properties

property	required	type	description
id		string	identifier of the project. autogenerated during create project operation
name	Y	string	identifying name of the project
includeContentTypes		boolean	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
description		string	description of the project
state		ProjectState
items		ProjectItems
system		ProjectSystem

State of the project

property	type	description	details
status	enum	Project Status IN_PROGRESS - The project is in progress ADDINGCHANNEL - A channel is getting added to the project REBASING - The project is getting rebased REBASE_ERROR - The previous rebase operation has been failed INREVIEW - 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	IN_PROGRESS ADDING_CHANNEL REBASING REBASE_ERROR IN_REVIEW APPROVED MERGING MERGED MERGE_ERROR DELETED DELETING RUNNING START_RUNNING STOP_RUNNING
message	string	status message
errors	ProjectErrors
availableActions	array[] of strings	available actions for the current state. REBASE_PROJECT value is included if the project can be rebased

Items added to the project

property	type	description
channels	array[] of ProjectChannel	channels added to the project
contentTypes	array[] of ProjectContentType	content types added to the project
documents	array[] of ProjectDocument	documents added to the project
pages	array[] of ProjectPage	pages added to the project
resourceBundles	array[] of ProjectResourceBundle	resource bundles added to the project

Merge or rebase errors of the items

property	type	description
channels	array[] of ProjectError	channels with merge or rebase errors
contentTypes	array[] of ProjectError	content types with merge or rebase errors
documents	array[] of ProjectError	documents with merge or rebase errors
pages	array[] of ProjectError	pages with merge or rebase errors
resourceBundles	array[] of ProjectError	resource bundles with merge or rebase errors

System properties

property	type	description
createdBy	string	the name of the user who created the project
createdAt	date-time	date of create
updatedBy	string	the name of the user who updated the project
updatedAt	date-time	date of update
mergedBy	string	the name of the user who merged the project
mergedAt	date-time	date of merge

Channel properties

property	required	type	description	details	example
id		string	identifier of the channel
displayName		string	display name of the channel

Content type properties

property	required	type	description	details	example
name		string	name of the content type
displayName		string	display name of the content type

Document properties

property	required	type	description	details	example
path		string	content path of the document
displayName		string	display name of the document

Page properties

property	required	type	description	details	example
path		string	content path of the page
displayName		string	display name of the page

Resource bundle properties

property	required	type	description	details	example
path		string	content path of the resource bundle
displayName		string	display name of the resource bundle

Merge error properties

property	required	type	description	details	example
target		string	the project item
message		string	error message for the project item

Merge operation properties

property	required	type	description	details	example
approveAllChanges		boolean	whether to review and approve the project automatically