The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.
| name | path | methods | description |
|---|---|---|---|
| ContentWorkflowResources |
|
|
Content workflows information and operations as:
IMPORTANT NOTICEAll paths defined here must be preceded by the app's REST endpoint base path: |
| type | description |
|---|---|
| AbstractExpanderResponse | Base class for expandable responses |
| AllowedAssignerGroupCondition | The groups that can assign an approval. Condition type: exclude |
| AllowedAssignerUserCondition | The users that can assign an approval. Condition type: exclude |
| Approval | State Approvals |
| ApprovalAction | Approval action with related information about the approval itself |
| ApprovalEvent | Approval related event names that activate a trigger:
Event type: approval |
| Approver | Approval user information |
| Approvers | Information about the default approvers of the approval |
| Assignee | |
| ChangeAction | Action to change to a different state |
| Condition | Workflow Conditions. Check existing conditions here. |
| ContentAction | Information related to the different actions that can be taken in current state. See ParametersAction, ChangeAction or ApprovalAction subtypes |
| ContentApproval | Approval information |
| ContentState | Information related to a state in a workflow |
| ContentTask | Info related to the different tasks associated to the current state |
| ContentWorkflowApprovalAssignmentOperation | Wrapper entity with all the info to make an approval assign/unassign operations |
| ContentWorkflowApprovalOperation | Wrapper entity with all the info to make an approval approve/reject operations |
| ContentWorkflowParameterOperation | |
| ContentWorkflowResponse | Response for all requests to content workflow endpoint |
| ContentWorkflowStateExpirationOperation | Wrapper entity with all the info to make state expiry date change operation |
| ContentWorkflowStateOperation | Wrapper entity with all the info to make a state change operation |
| Event | Confluence Related event names that activate a trigger:
Event type: event |
| ExcludeCondition | Users that are excluded from performing the action. Condition type: exclude |
| GroupCondition | The groups that can perform the action. Condition type: group |
| HasApprovalCondition | The page has the given approval approved Condition type: hasapproval | hadapproval |
| HasLabelCondition | The page has/has not any of the given labels | The page´s ancestors has/has not any of the given labels Condition type: haslabel | parenthaslabel |
| InputField | Information related to an input field to get parameter info. See the workflow parameter macro for further information. |
| InputType | Different supported input field's types |
| LabelEvent | Label related event names that activate a trigger:
Event type: label |
| Link | |
| Message | Information or error message indicating the outcome for an operation |
| MetadataCondition | The value reference contains users. Condition type: metadata |
| PageCondition | If the page is descendant of the given page|Title of the page is Condition type: ischildof | title |
| Parameter | |
| Parameter | |
| ParametersAction | Action for parameters input |
| PermissionCondition | User has given permission. Condition type: permission |
| RestRemoteWorkflow | |
| RestRemoteWorkflowCategory | |
| RestRemoteWorkflowsRepository | |
| RestWorkflow | |
| RestWorkflowParam | Intermediate rest model as com.comalatech.confluence.workflow.model.WorkflowParameter is not "restable" with static builders and converters
Such builders and converter handles the internal conversion of Duration values using convention: |
| SpaceCondition | Key of the space is Condition type: spacekey |
| SpaceWorkflowParam | Intermediate rest model as com.comalatech.confluence.workflow.model.WorkflowParameter is not "restable" with static builders and converters
Such builders and converter handles the internal conversion of Duration values using convention: |
| State | Info about a workflow state |
| StateCondition | The state in the current page is the given | The state in the corresponding Draft space as defined through Comala Publishing. Condition type: state | stateindraft |
| StateEvent | State changes related event names for triggers:
Event type: state |
| StateTransition | State transition definition |
| StateTransitions | State transitions defined for each workflow event |
| TaskEvent | Tasks related event names for triggers:
Event type: task |
| Trigger | Workflow Trigger info |
| User | User related information |
| UserCondition | Users that can perform the action. Condition type: user |
| UserSearchResult | |
| UsersQuerySearchResults | |
| Workflow | Information about the current workflow. |
| WorkflowMarkupResponse | Base class for expandable responses |
| WorkflowPageParameterEvent | Workflow Parameters updates at page level related event names that activate a trigger:
Event type: parameter |
| WorkflowParameterType | |
| WorkflowParametersResponse | List of Workflow Parameters |
| type | description |
|---|---|
| user | User related information |
| userSearchResult | |
| usersQuerySearchResults | |
| abstractExpanderResponse | Base class for expandable responses |
| approval | State Approvals |
| approvers | Information about the default approvers of the approval |
| condition | Workflow Conditions. Check existing conditions here. |
| contentAction | Information related to the different actions that can be taken in current state. See ParametersAction, ChangeAction or ApprovalAction subtypes |
| contentApproval | Approval information |
| approver | Approval user information |
| contentState | Information related to a state in a workflow |
| contentTask | Info related to the different tasks associated to the current state |
| contentWorkflowApprovalAssignmentOperation | Wrapper entity with all the info to make an approval assign/unassign operations |
| contentWorkflowApprovalOperation | Wrapper entity with all the info to make an approval approve/reject operations |
| contentWorkflowParameterOperation | |
| contentWorkflowResponse | Response for all requests to content workflow endpoint |
| contentWorkflowStateOperation | Wrapper entity with all the info to make a state change operation |
| link | |
| message | Information or error message indicating the outcome for an operation |
| parameter | |
| restRemoteWorkflow | |
| restRemoteWorkflowCategory | |
| restRemoteWorkflowsRepository | |
| restWorkflow | |
| restWorkflowParam | Intermediate rest model as com.comalatech.confluence.workflow.model.WorkflowParameter is not "restable" with static builders and converters
Such builders and converter handles the internal conversion of Duration values using convention: |
| spaceWorkflowParam | Intermediate rest model as com.comalatech.confluence.workflow.model.WorkflowParameter is not "restable" with static builders and converters
Such builders and converter handles the internal conversion of Duration values using convention: |
| state | Info about a workflow state |
| stateTransition | State transition definition |
| stateTransitions | State transitions defined for each workflow event |
| trigger | Workflow Trigger info |
| event | Confluence Related event names that activate a trigger:
Event type: event |
| workflow | Information about the current workflow. |
| workflowMarkupResponse | Base class for expandable responses |
| workflowParametersResponse | List of Workflow Parameters |
| assignee | |
| inputField | Information related to an input field to get parameter info. See the workflow parameter macro for further information. |
| inputType | Different supported input field's types |
| workflowParameterType |