Project
| id | string identifier of the project. autogenerated during create project operation | |
| name* | 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. false by default | |
| description | string description of the project | |
| state | state of the project ProjectState | |
| status | string 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] | |
| message | string readOnly: true status message | |
| errors | list of errors occured during rebase and merge operations readOnly: true ProjectErrors (details provided in Table A) | |
| availableActions | readOnly: true available actions for the current state. REBASE_PROJECT value is included if the project can be rebased | |
| items | items added to the project ProjectItem | |
| channels | readOnly:true channels added to the project ProjectChannel (details provided in Table B) | |
| contentTypes | readOnly:true content types added to the project ProjectContentType (details provided in Table C) | |
| documents | readOnly:true documents added to the project ProjectDocument (details provided in Table D) | |
| pages | readOnly:true pages added to the project ProjectPage (details provided in Table E) | |
| resourceBundles | readOnly:true resource bundles added to the project ProjectResourceBundle (details provided in Table F) | |
| system | system properties ProjectSystem | |
| createdBy | string readOnly:true the name of the user that created the project | |
| createdAt | string($date-time) readOnly:true date of create | |
| updatedBy | string readOnly:true the name of the user that updated the project | |
| updatedAt | string($date-time) readOnly:true date of update | |
| mergedBy | string readOnly:true the name of the user that merged the project | |
| mergedAt | string($date-time) readOnly:true date of merge |
Table A
| ProjectErrors | |
|---|---|
| channels | readOnly: true channels with merge or rebase errors ProjectError (details provided in Table G) |
| contentTypes | readOnly: true content types with merge or rebase errors ProjectError (details provided in Table G) |
| documents | readOnly: true documents with merge or rebase errors ProjectError (details provided in Table G) |
| pages | readOnly: true pages with merge or rebase errors ProjectError (details provided in Table G) |
| resourceBundles | readOnly: true resource bundles with merge or rebase errors ProjectError (details provided in Table G) |
Table B
| ProjectChannel | |
|---|---|
| id | string readOnly: true identifier of the channel |
| displayName | string readOnly:true display name of the channel |
Table C
| ProjectContentType | |
|---|---|
| name | string readOnly: true name of the content type |
| displayName | string readOnly: true display name of the content type |
Table D
| ProjectDocument | |
|---|---|
| path | string readOnly: true content path of the document |
| displayName | string readOnly: true display name of the document |
Table E
| ProjectPage | |
|---|---|
| path | string readOnly: true content path of the page |
| displayName | string readOnly: true display name of the page |
Table F
| ProjectResourceBundle | |
|---|---|
| path | string readOnly: true content path of the resource bundle |
| displayName | string readOnly: true display name of the resource bundle |
Table G
| ProjectError | |
|---|---|
| target | string readOnly: true the project item |
| message | string readOnly: true error message for the project item |
ProjectMerge
| approveAllChanges | boolean whether to review and approve the project automatically, false by default |