Getting information about the workflow of the class: getWorkflow¶
The request is made using the path <server URL>/rest/<service name>/getWorkflow/<class name>/<business process name>
, where the class name and business process name are specified with a namespace.
You can specify in the request: doc: additional parameters <meta_query_parameters>:
workflow
namespace
version
Query example:
https://localhost:8888/rest/meta/getWorkflow/workflowBase@develop-and-test/simpleWorkflow@develop-and-test
the workflow object simpleWorkflow``will be requested for the object class ``workflowBase
in the namespace develop-and-test
. A response example:
{ name: 'simpleWorkflow',
caption: 'Simple WF',
wfClass: 'workflowBase@develop-and-test',
startState: 'canStart',
states:
[ { name: 'canStart',
caption: 'Ready to check',
maxPeriod: null,
conditions: [Object],
propertyPermissions: [],
itemPermissions: [],
selectionProviders: [] },
{ name: 'inProcess',
caption: 'In process',
maxPeriod: null,
conditions: null,
itemPermissions: [Array],
propertyPermissions: [],
selectionProviders: [] },
{ name: 'accepted',
caption: 'Accepted',
maxPeriod: null,
conditions: null,
itemPermissions: [],
propertyPermissions: [],
selectionProviders: [] },
{ name: 'returned',
caption: 'Returned',
maxPeriod: null,
conditions: null,
itemPermissions: [Array],
propertyPermissions: [],
selectionProviders: [] },
{ name: 'rejected',
caption: 'Rejected',
maxPeriod: null,
conditions: null,
itemPermissions: [],
propertyPermissions: [],
selectionProviders: [] } ],
transitions:
[ { name: 'startCheck',
caption: 'Start checking',
startState: 'canStart',
finishState: 'inProcess',
signBefore: false,
signAfter: false,
roles: [],
assignments: [Array],
conditions: null,
confirm: false,
confirmMessage: null },
{ name: 'return',
caption: 'Return',
startState: 'inProcess',
finishState: 'returned',
signBefore: false,
signAfter: false,
roles: [],
assignments: [Array],
conditions: null,
confirm: false,
confirmMessage: null },
{ name: 'accept',
caption: 'Accept',
startState: 'inProcess',
finishState: 'accepted',
signBefore: false,
signAfter: false,
roles: [],
assignments: [Array],
conditions: null,
confirm: false,
confirmMessage: null },
{ name: 'reject',
caption: 'Reject',
startState: 'inProcess',
finishState: 'rejected',
signBefore: false,
signAfter: false,
roles: [],
assignments: [Array],
conditions: null,
confirm: false,
confirmMessage: null },
{ name: 'notify',
caption: 'To check',
startState: 'returned',
finishState: 'canStart',
signBefore: false,
signAfter: false,
roles: [],
assignments: [Array],
conditions: [Object],
confirm: false,
confirmMessage: null } ],
metaVersion: '2.0.61.16945',
namespace: 'develop-and-test' }
The example in dnt: test/modules/rest/metadatasrv.spec.js
/checking metadata service/# access information about workflow: getWorkflow