Workflow Service Contract Description
- Tom Jones
- Aron Roberts (Unlicensed)
Owned by Tom Jones
Workflow Service
Unable to render {include} The included page could not be found.
| WorkflowService | |
| Dev | Release Notes/History |
| From KSS "Workflow Service" contract. | |
Error rendering macro 'excerpt-include' : No link could be created for 'collectionspace:Workflow Service Description and Assumptions'.
References
Workflow Service Description and Assumptions
Workflow Service Entity Diagram
Workflow Stack Options
Service Basket 3 Operation Sandbox
Workflow Notes
Example Workflow
Workflow Examples
Workflow Discussion
Workflow Rules
Operations
WorkQueue could also be called ActionList; Step could also be called Node- Does A Workqueue really need to exist with an Id, it is really the unique combination of Role & Qualifier
Do we need to add batchId as a parameter to createWork
Unable to render {include} The included page could not be found.
Setup
#findOutputTypes
#findOutputTypesForStep --What output states can be assigned to work at this Step
Read
These operations aren't needed for minimal interface. Only needed to support a more general Workflow interface.
- findStepsForProcess
- fetchRoleForStep
- fetchRoleForWorkQueue
#findProcesses --What are the names, Steps, etc of all the known processes defined
#fetchWork
#findAllWorkInProcess --All work still in a Process
#findAllWorkInStep --All work in a certain step
#findMyWork – All work that is ready for a person
#findMyWorkInQueue --All work that is ready for a person in a particular Queue
#findMyWorkInProcess --All work that is ready for a person in a particular Process
Search
Maintain
Setup
| findOutputTypes | ||
| Retrieves the list of all Output Types (Actions) known by this service. Ex: Approved, Rejected | ||
| None | None | No Parameters |
| outputTypeInfoList | list of Output Types | |
| OPERATION_FAILED | unable to complete request | |
| findOutputTypesForStep | ||
| Retrieves a list of OutputTypes(Actions) that are valid for a Step (node in a Process) | ||
| stepId | stepId | stepId |
| outputTypeInfoList | List of Output Types | |
| DOES_NOT_EXIST | stepId not found | |
| INVALID_PARAMETER | invalid stepId | |
| MISSING_PARAMETER | stepId not specified | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |
Read
| findProcesses | ||
| Retrieves the list of Processes known by this service | ||
| None | None | No Parameters |
| processList | list of Processes | |
| OPERATION_FAILED | unable to complete request | |
| fetchWork | ||
| Retrieves a single instance of Work | ||
| workId | workId | workId |
| work | work | |
| DOES_NOT_EXIST | workId not found | |
| INVALID_PARAMETER | invalid workId | |
| MISSING_PARAMETER | workId not specified | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |
| findAllWorkInProcess | ||
| Retrieves a list of current Work in a Process | ||
| processId | processId | processId |
| workList | List of Work | |
| DOES_NOT_EXIST | processId not found | |
| INVALID_PARAMETER | invalid processId | |
| MISSING_PARAMETER | processId not specified | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |
| findAllWorkInStep | ||
| Retrieves a list of current Work in a Step | ||
| stepId | stepId | stepId |
| workList | List of Work | |
| DOES_NOT_EXIST | stepId not found | |
| INVALID_PARAMETER | invalid stepId | |
| MISSING_PARAMETER | stepId not specified | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |
| findMyWork | ||
| Retrieves a list of current Work for a Person (Principal) | ||
| /wiki/spaces/collectionspace/pages/666274739 | principalId | principalId |
| workList | List of Work | |
| DOES_NOT_EXIST | principalId not found | |
| INVALID_PARAMETER | invalid principalId | |
| MISSING_PARAMETER | principalId not specified | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |
| findMyWorkInQueue | ||
| Retrieves a list of current Work for a Person (Principal) that's in a particular queue | ||
| /wiki/spaces/collectionspace/pages/666274739 | principalId | principalId |
| queueId | queueId | queueId |
| workList | List of Work | |
| DOES_NOT_EXIST | queueId or PrincipalId not found | |
| INVALID_PARAMETER | invalid queueId or PrincipalId | |
| MISSING_PARAMETER | queueId or PrincipalId not specified | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |
| findMyWorkInProcess | ||
| Retrieves a list of current Work for a Person (Principal) that's in a particular process | ||
| /wiki/spaces/collectionspace/pages/666274739 | principalId | principalId |
| processId | processId | processId |
| workList | List of Work | |
| DOES_NOT_EXIST | processId or PrincipalId not found | |
| INVALID_PARAMETER | invalid processId or PrincipalId | |
| MISSING_PARAMETER | processId or PrincipalId not specified | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |
| createWork | ||
| Creates a new instance of work, that will follow a process. | ||
| /wiki/spaces/collectionspace/pages/666274739 | principalId | principalId |
| processId | processId | processId |
| work | work | work |
| work | work | |
| DOES_NOT_EXIST | processId or prinicipal not found | |
| INVALID_PARAMETER | invalid processId or prinicipal or work | |
| MISSING_PARAMETER | processId or prinicipal or work not specified | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |
| deleteWork | ||
| Deletes an instance of work, that was in a process. | ||
| /wiki/spaces/collectionspace/pages/666274739 | principalId | principalId |
| processId | processId | processId |
| workId | workId | workId |
| /wiki/spaces/collectionspace/pages/666275040 | status | |
| DOES_NOT_EXIST | principalId,processId or workId not found | |
| INVALID_PARAMETER | invalid principalId,processId or workId | |
| MISSING_PARAMETER | principalId,processId or workId not specified | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |
| registerState | ||
| Registers that an instance of Work completed a Step with an OutputType. | ||
| /wiki/spaces/collectionspace/pages/666274739 | principalId | principalId |
| processId | processId | processId |
| stepId | stepId | stepId |
| outputTypeKey | outputTypeKey | outputTypeKey |
| workId | workId | workId |
| /wiki/spaces/collectionspace/pages/666274808 | comment | comment |
| /wiki/spaces/collectionspace/pages/666275040 | status | |
| DOES_NOT_EXIST | principalId, processId, stepId, or workId not found | |
| INVALID_PARAMETER | invalid principalId, processId, stepId, or workId | |
| MISSING_PARAMETER | principalId, processId, stepId, or workId not specified | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |