Schemas

Project Management API schemas

Project

A developer project

Properties

propertyrequiredtypedescriptiondetailsexample
id stringidentifier of the project. autogenerated during create project operation  
nameYstringidentifying name of the project  
includeContentTypes booleanwhether 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 stringdescription of the project  
state ProjectState   
items ProjectItems   
system ProjectSystem   

ProjectState

State of the project

Properties

propertyrequiredtypedescriptiondetailsexample
status enumProject 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 stringstatus message  
errors ProjectErrors   
availableActions array[] of stringsavailable actions for the current state. REBASE_PROJECT value is included if the project can be rebased  

ProjectItems

Items added to the project

Properties

propertyrequiredtypedescriptiondetailsexample
channels array[] of ProjectChannelchannels added to the project  
contentTypes array[] of ProjectContentTypecontent types added to the project  
documents array[] of ProjectDocumentdocuments added to the project  
pages array[] of ProjectPagepages added to the project  
resourceBundles array[] of ProjectResourceBundleresource bundles added to the project  

ProjectErrors

Merge or rebase errors of the items

Properties

propertyrequiredtypedescriptiondetailsexample
channels array[] of ProjectErrorchannels with merge or rebase errors  
contentTypes array[] of ProjectErrorcontent types with merge or rebase errors  
documents array[] of ProjectErrordocuments with merge or rebase errors  
pages array[] of ProjectErrorpages with merge or rebase errors  
resourceBundles array[] of ProjectErrorresource bundles with merge or rebase errors  

ProjectSystem

System properties

Properties

propertyrequiredtypedescriptiondetailsexample
createdBy stringthe name of the user who created the project  
createdAt date-timedate of create  
updatedBy stringthe name of the user who updated the project  
updatedAt date-timedate of update  
mergedBy stringthe name of the user who merged the project  
mergedAt date-timedate of merge  

ProjectChannel

Channel properties

Properties

propertyrequiredtypedescriptiondetailsexample
id stringidentifier of the channel  
displayName stringdisplay name of the channel  

ProjectContentType

Content type properties

Properties

propertyrequiredtypedescriptiondetailsexample
name stringname of the content type  
displayName stringdisplay name of the content type  

ProjectDocument

Document properties

Properties

propertyrequiredtypedescriptiondetailsexample
path stringcontent path of the document  
displayName stringdisplay name of the document  

ProjectPage

Page properties

Properties

propertyrequiredtypedescriptiondetailsexample
path stringcontent path of the page  
displayName stringdisplay name of the page  

ProjectResourceBundle

Resource bundle properties

Properties

propertyrequiredtypedescriptiondetailsexample
path stringcontent path of the resource bundle  
displayName stringdisplay name of the resource bundle  

ProjectError

Merge error properties

Properties

propertyrequiredtypedescriptiondetailsexample
target stringthe project item  
message stringerror message for the project item  

ProjectMerge

Merge operation properties

Properties

propertyrequiredtypedescriptiondetailsexample
approveAllChanges booleanwhether to review and approve the project automatically