The format for Process Engine REST Service resource URIs is as follows:
http://host:port/{context}/{servlet}/p8/bpm/v1/
Where:
The REST Service version identification (/v1) enables subsequent updates to the REST Service.
The REST Service resources are as follows:
Refer also to the JSON Representation for Step Elements.
/p8/bpm/v1/rosters/{rosterName}/workclasses/{workclassName}/wob/{wobNum}
The workflow launch step element. This resource is returned in the POE-Links parameter of the Workclass.Get response header when the POE parameter in the request header is 1 (POE:1).
Name | Type | Description |
---|---|---|
rosterName | String | The name of the roster used for the workflow. |
workclassName | String | The name of the workclass (workflow). |
wobNum | String | The GUID identifying the work object (the workflow launch step element). |
Launches the specified workclass (workflow). The client must use the structure retrieved via the WorkClass.GET operation.
For the POST operation to be successful, it must be the first POST for the work object (the workflow launch step element).
The initial POST of the payload, if successful, returns 201 Created
. Subsequent POST operations will return:
405 Not Allowed Allow: Get
A GET operation on this resource will return the JSON representation of the workflow launch step element as it was created by the POST operation.
None.
Required? | Name | Description |
---|---|---|
required | POE | This value must be set to 1. If this value is not present, a 400 Bad Request error will be returned. |
MIME Type: application/json
Refer to the response JSON Schema for Step Elements.
If the launch step element has responses, the selectedResponse
value must be set; otherwise a 400 Bad Request
will be returned.
POST http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/rosters/myRoster/workclasses/myWorkclass/wob/12345
MIME Type: application/json
Refer to the response JSON Schema for Step Elements.
Refer to Step Elements Response Example.
Code | Description |
---|---|
201 Created | Successful completion - workflow is launched. |
400 Bad Request | Missing selectedResponse, or there was no request content. |
404 Not Found | The specified workclass (workflow) was not found. |
405 Not Allowed | A subsequent POST to this resource was attempted. |
500 Internal Server Error | Severe problem, programmer's details provided. |
Gets the JSON representation of the workflow launch step element as it was created by the POST operation on this resource.
None.
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/rosters/myRoster/workclasses/myWorkclass/wob/12345
If the work object (the workflow launch step element) is found and active, a response code of 200 OK
is returned with the JSON representation of the workflow launch step element in its current state in the roster.
MIME Type: application/json
Refer to the response JSON Schema for Step Elements.
Refer to Step Elements Response Example.
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. |
410 Gone | The workclass (workflow) has been terminated or deleted. |
500 Internal Server Error | Severe problem, programmer's details provided. |
/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/?{queryParams}
The set of queue elements in a workbasket.
Name | Type | Description |
---|---|---|
queue | String | The name of the queue with which the workbasket is associated. |
workbasket | String | The name of the workbasket. |
queryParams | n/a | The set of parameters specifying the criteria for the query. Refer to the GET parameters for this resource (below). |
Gets the set of queue elements based on the specified query parameters. If the queryParams value is large, use the POST method. Refer to URL Length Limitation for more information.
Required? | Name | Data Type | Description |
---|---|---|---|
optional | filters | String | A tuple of filter name/value pairs (for example, "[State=CA, City=Costa Mesa]"). |
optional | lastRecord | String | Indicates the last record returned in the previous query. This value is returned in the response content. Used for paging. Whenever the query filters or orderBy values change, the client should reissue the query without the lastRecord parameter. This parameter should not be specified for the initial query. |
optional | pageSize | Integer | The number of items displayed on a page. The server only returns one page at a time. If the page size is not specified it defaults to 50. |
optional | orderBy | String | The column to sort by (such as, "AccountNumber"). Only one column can be specified. |
optional | queryFlags | Integer | The flags that are to be used for the query. Refer to the QUERY_* attributes in the VWQueue Javadocs for the possible values. If a value is not specified, the default is 0 (zero). This will result in only unlocked work items being returned.
Set this value to 1 to specify that both locked and unlocked work items should be returned. |
The following example fetches both locked and unlocked work items from the workbasket(queryFlags=1). The results will be filtered by (the filters value) "State=CA" and "City='Costa Mesa'" and ordered by (the orderby value) "State". A maximum of 50 work items at a time will be returned from the server (the pageSize value).
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements?filters=[State=CA,City=Costa Mesa]&pageSize=50&queryFlags=1&orderBy=State
The client will receive the queue elements in the response from the server. The response also includes a lastRecord value. The following GET retrieves the next 50 work items:
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements?filters=[State=CA,City=Costa Mesa]&pageSize=50&queryFlags=1&orderBy=State&lastRecord=xxxxx
MIME Type: application/json
Note: If there are no queue elements fetched from the server then an empty JSON object ({ }) is returned.
JSON Schema:
{ "type":"object", "properties": { "lastRecord":{"type":"string"}, "stepProcessors": { "type":"object", "description":"Contains a dynamic set of properties. The property names are the step processor identifiers.", "additionalProperties": { "type":"object", "properties":, { "name":{"type":"string"}, "id":{"type":"integer"}, "appType":{"type":"string"}, "processorType":{"type":"string"}, "width":{"type":"integer"}, "height":{"type":"integer"}, "applicationName":{"type":"string"}, "locations": { "type":"object", "description":"Contains a dynamic set of properties. The property names are the Web application identifiers. The value of each property is the step processor location for that Web application.", "additionalProperties":{"type":"string"} } } } } "queueElements": { "type":"array", "items": { "type":"object", "properties": { "stepElement":{"type":"string" ,"format":"uri"}, "Etag":{"type":"string"}, "workObjectNumber":{"type":"string"}, "stepName":{"type":"string"}, "queueName":{"type":"string"}, "lockedBy":{"type":"string"}, "stepProcessorId":{"type":"string", "description":"Use this property to look up the step processor information in the stepProcessors property."}, "columns": { "type":"object", "description":"Contains a dynamic set of properties. The property names are the column names, and the value of each property is the value of that column for the queue element.", "additionalProperties": { type":["string","number","boolean"] } } } } } } }
{ "lastRecord":"xxxxxxxxxxxxxx", "stepProcessors": { "1": { "name":"", "id":1, "appType":"HTML", "processorType":"step", "width":500, "height":500, "applicationName":"", "locations": { "1":"html/ootb/WcmStepProcessor.jsp", "7":"html/ootb/WcmStepProcessor.jsp" ... } }, ... } "queueElements": [ { "stepElement":"queues/{queue}/{wobnum}", "ETag":"xxxx", "workObjectNumber","xxx", "stepName","Review Step", "queueName","ClaimProcessing", "lockedBy":"joe", "stepProcessorId":1, "columns": { "CustomerName":"John Smith", "CustomerAge":35 } } ... ] }
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. |
500 Internal Server Error | Severe problem, programmer's details provided. |
/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/count
The number of queue elements in a workbasket. The count is based on a predefined query for the work basket. Query parameters are not supported on this resource.
Name | Type | Description |
---|---|---|
queue | String | The name of the queue with which the workbasket is associated. |
workbasket | String | The name of the workbasket. |
None.
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/queueelements/count
MIME Type: application/json
JSON Schema:
{ "type":"object", "properties": { "count":{"type":"integer"} } }
{"count":50}
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. |
500 Internal Server Error | Severe problem, programmer's details provided. |
/p8/bpm/v1/appspaces/{appspace}/myroles
The list of roles within an application space.
Name | Type | Description |
---|---|---|
appspace | String | The name of the application space. |
None.
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/appspaces/Autoclaim/myRoles
MIME Type: application/json
JSON Schema:
{ "type":"object", "description":"Contains a dynamic set of properties. The property names are the authored role names.", "additionalProperties": { "type":"object", "properties": { "name":{"type":"string","description":"Translated role name."}, "URI":{"type":"string","format":"uri"} } } }
{ "Agent":{"name":"Agent","URI":"appspaces/Autoclaim/roles/Agent"}, "Manager":{"name":"Manager","URI":"appspaces/Autoclaim/roles/Manager" }
Code | Description |
---|---|
200 | OK. Successful completion - requested data returned. |
500 | Internal Server Error. Severe problem, programmer's details provided. |
/p8/bpm/v1/appspaces/{appspace}/roles/{role}
A specific role.
Name | Type | Description |
---|---|---|
appspace | String | The name of the application space. |
role | String | The name of the role. |
None.
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/appspaces/Autoclaim/roles/Reviewer
MIME Type: application/json
JSON Schema:
{ "type":"object", "properties": { "name":{"type":"string"}, "authoredName":{"type":"string"}, "homePage":{"type":"string"}, "attributes":{"type":"string" ,"format":"uri"}, "workbaskets": { "type":"object", "description":"Contains a dynamic set of properties. The property names are the authored workbasket names.", "additionalProperties": { "type":"object", "properties": { "name":{"type":"string","description":"Translated workbasket name."}, "URI":{"type":"string","format":"uri"} } } } } }
{ "name":"ReviewerTranslated", "authoredName":"Reviewer", "homePage":"AutoClaimReview.html", "attributes":"appspaces/AutoClaim/roles/Reviewer/attributes", "workbaskets": { "Initial":{"name":"Initial","URI":"appspaces/AutoClaim/roles/Reviewer/workbaskets/Initial"}, "Appeal":{"name":"Appeal","URI":"appspaces/AutoClaim/roles/Reviewer/workbaskets/Appeal"} } }
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. |
500 Internal Server Error | Severe problem, programmer's details provided. |
/p8/bpm/v1/appspaces/{appspace}/myroles/{role}/attributes
Identifies the attributes assigned to a role.
Name | Type | Description |
---|---|---|
appspace | String | The name of the application space. |
role | String | The name of the role. |
None.
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/appspaces/Autoclaim/roles/Reviewer/attributes
MIME Type: application/json
JSON Schema:
{ "type":"object", "additionalProperties": { "type":"object", "description":"Contains a dynamic set of properties. The property names are the attribute names.", "properties": { "name":{"type":"string"}, "type":{"type":"integer",, "description":"VWFieldType"}, "isArray":{"type":"boolean"}, "value":{"type":["string","number", "boolean", "array"]} } } }
{ "Color": { "name":"Color", "type":2, "isArray":false, "value":"Red" } "Colors": { "name":"Colors", "type":2, "isArray":true, "value":["Red","Blue","Green"] } }
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. |
500 Internal Server Error | Severe problem, programmer's details provided. |
/p8/bpm/v1/queues/{queueName}/stepelements/{wobNum}
A step element retrieved from a queue.
Name | Type | Description |
---|---|---|
queueName | String | The name of the queue with which the step element is associated. |
wobNum | String | The GUID identifying the work object (the step element). |
Gets the JSON representation of the step element.
None.
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/queues/myqueue/stepelements/12345
Name | Description |
---|---|
ETag | Identifies the version of the step element. Return this value as the HTTP request header If-Match value when performing a PUT on this resource.
|
MIME Type: application/json
Refer to the response JSON Schema for the Step Element.
Refer to Step Element Response Example.
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. |
404 Not Found | Work item not found. |
500 Internal Server Error | Severe problem, programmer's details provided. |
Updates a step element.
Required? | Name | Data Type | Description |
---|---|---|---|
required | action | String | One of the following values:
|
optional | responseContent | integer | This parameter is valid only when the action parameter is "lock" or "overrideLock". It provides a mechanism to allow a client to lock a work item and fetch its representation in a single call.
A value of 1 indicates that the current representation of the step element is to be returned in the response content. The step element representation is not included in the response content (the default) when this parameter is not specified, or when its value is other than "lock" or "overrideLock". |
Required? | Name | Description |
---|---|---|
required | If-Match | Identifies the version of the step element. This must be the ETag value returned in the GET response header. |
For save
, saveAndUnlock
, and dispatch
actions, send an updated version of the representation returned in the GET response. No request content is needed for the other actions.
If responses are required for the step, the step element responses
property will contain an array of possible responses. Set the selectedResponse
property before dispatching the work item.
Set the modified
property to true for any dataField, attachment, or workflow group values that have been modifed. If the modified
property is not set, the updated value will not be saved on the server.
MIME Type: application/json
Refer to the response JSON Schema for Step Elements.
PUT http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/queues/myqueue/stepelements/12345?action=overrideLock?responseContent=1
Required? | Name | Description |
---|---|---|
required | ETag | The new identifying version of the work item. Return this value as the If-Match request header value when updating the step element. |
No content is returned, unless the the action is "lock" or "overrideLock" and the responseContent
parameter is set to 1. In this case, the current representation of the step element will be returned.
MIME Type: application/json
Refer to the response JSON Schema for Step Elements.
Refer to Step Element Response Example.
Code | Description |
---|---|
201 Created | Successful completion - workflow is launched. |
404 Not Found | Work item not found. |
409 Conflict | The If-Match request header value does not match the current ETag response header value for the step element. This indicates the step element was modified since the last time the its representation was retrieved. |
500 Internal Server Error | Severe problem, programmer's details provided. |
/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}
The name of an available work basket for the specified queue.
Name | Type | Description |
---|---|---|
queue | String | The name of the queue with which the workbasket is associated. |
workbasket | String | The name of the workbasket. |
Gets the workbasket. The returned workbasket includes columns defining the workbasket, as well as information for queue query and filtering.
None.
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/queues/myQueue/workbaskets/myWorkbasket
MIME Type: application/json
JSON Schema:
{ "type":"object", "properties": { "name":{"type":"string"}, "authoredName":{"type":"string"}, "columns": { "type":"object", "description":"Contains a dynamic set of properties. The property names are the authored column names.", "additionalProperties": { "type":"object", "properties": { "name":{"type":"string","description":"Translated column name."} "type":{"type":"integer","description":"VWFieldType"}, "prompt":{"type":"string"}, "sortable":{"type":"boolean"}, "ordinal":{"type":"integer"} } } } "filters" : { "type":"object", "additionalProperties": { "type":"object", "properties": { "name":{"type":"string"}, "prompt":{"type":"string"}, "type":{"type":"integer"}, "maxChars":{"type":"integer"}, "width":{"type":"integer"}, "attributes":{"type":"string" ,"format":"uri"}, } } } "attributes":{"type":"string","format":"uri"}, "queueElements":{"type":"string","format":"uri"}, "queueElementsCount":{"type":"string", "format":"uri"} } }
{ "name":"myWorkbasketTranslated", "authoredName":"myWorkbasket", "columns": { "integerCol": { "name":"integerCol", "prompt":"Integer Column", "type":1, "sortable":true }, }, "filters": { "integerCol": { "name":"integerCol", "label":"Integer Column", "type":1, "attributes":"queues/myQueue/workbaskets/Initial/filters/CompanyName/attributes" }, }, "attributes":"queues/myQueue/workbaskets/myWorkbasket/attributes", "queueElements":"queues/myQueue/workbaskets/myWorkbasket/queueelements", "queueElementsCount":"queues/myQueue/workbaskets/myWorkbasket/queueelements/count" }
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. |
500 Internal Server Error | Severe problem, programmer's details provided. |
/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/attributes
The attributes of an available work basket for the specified queue.
Name | Type | Description |
---|---|---|
queue | String | The name of the queue with which the workbasket is associated. |
workbasket | String | The name of the workbasket. |
None.
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/queues/myQueue/workbaskets/myWorkbasket/attributes
MIME Type: application/json
JSON Schema:
{ "type":"object", "description":"Contains a dynamic set of properties. The property names are the attribute names.", "additionalProperties": { "type":"object", "properties": { "name":{"type":"string"}, "type":{"type":"integer"}, "isArray":{"type":"boolean"}, "value":{"type":["string", "number", "boolean", "array"]} } } }
{ "Color": { "name":"Color", "type":2, "isArray":false, "value":"Red" } "Colors": { "name":"Colors", "type":2, "isArray":true, "value":["Red","Blue","Green"] } }
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. |
500 Internal Server Error | Severe problem, programmer's details provided. |
/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/columns
The column definitions for the workbasket. Call this resource when a widget only needs the columns and not the entire workbasket definition (as returned by Workbasket.GET).
Name | Type | Description |
---|---|---|
queue | String | The name of the queue with which the workbasket is associated. |
workbasket | String | The name of the workbasket. |
None.
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/queues/myQueue/workbaskets/myWorkbasket/columns
MIME Type: application/json
JSON Schema:
{ "type":"object", "description":"Contains a dynamic set of properties. The property names are the authored column names.", "additionalProperties": { "type":"object", "properties": { "name":{"type":"string","description":"Translated column name."} "type":{"type":"integer","description":"VWFieldType"}, "prompt":{"type":"string"}, "sortable":{"type":"boolean"}, "ordinal":{"type":"integer"} } } }
{ "integerCol":{"name":"integerCol", "prompt":"Integer Column", "type":1, "sortable":true}, "stringCol":{"name":"stringCol", "prompt":"String Column", "type":2, "sortable":false} }
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. |
500 Internal Server Error | Severe problem, programmer's details provided. |
/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/filters
The filter definitions for the work basket. Call this resource when a widget only needs the filters and not the entire workbasket definition (as returned by Workbasket.GET).
Name | Type | Description |
---|---|---|
queue | String | The name of the queue with which the workbasket it associated. |
workbasket | String | The name of the workbasket. |
None.
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/queues/myQueue/workbaskets/myWorkbasket/filters
MIME Type: application/json
JSON Schema:
{ "type":"object", "description":"Contains a dynamic set of properties. The property names are the authored filter names.", "additionalProperties": { "type":"object", "properties": { "name":{"type":"string","description":"Translated filter name."} "type":{"type":"integer","description":"VWFieldType"}, "prompt":{"type":"string"}, "attributes":{"type":"string","format":"uri"} } } }
{ "integerCol": { "name":"integerCol", "type":1, "prompt":"Integer Column", "attributes":"queues/myQueue/workbaskets/MyWorkbasket/filters/CompanyName/attributes" }, }
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. |
500 Internal Server Error | Severe problem, programmer's details provided. |
/p8/bpm/v1/queues/{queue}/workbaskets/{workbasket}/filters/{filter}/attributes
The attributes of a filter defined for the work basket.
Name | Type | Description |
---|---|---|
queue | String | The name of the queue with which the workbasket is associated. |
workbasket | String | The name of the workbasket. |
filter | String | The name of the filter. |
None.
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/queues/myQueue/workbaskets/myWorkbasket/filters/CompanyName/attributes
MIME Type: application/json
JSON Schema:
{ "type":"object", "description":"Contains a dynamic set of properties. The property names are the attribute names.", "additionalProperties": { "type":"object", "properties": { "name":{"type":"string"}, "type":{"type":"integer"}, "isArray":{"type":"boolean"}, "value":{"type":["string", "number", "boolean", "array"]} } } }
{ "Color": { "name":"Color", "type":2, "isArray":false, "value":"Red" } "Colors": { "name":"Colors", "type":2, "isArray":true, "value":["Red","Blue","Green"] } }
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. |
500 Internal Server Error | Severe problem, programmer's details provided. |
/p8/bpm/v1/workclasses
The collection of work classes (workflows) available.
None.
Gets the list of work classes that can be launched.
None.
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/workclasses
MIME Type: application/json
JSON Schema:
{ "type":"object", "description":"Contains a dynamic set of properties. The property names are the workclass names.", "additionalProperties": { "type":"object", "properties": { "URI":{"type":"string" ,"format":"uri"}, "name":{"type":"string"} } } }
{ "QFieldTestWithResponseAndDeadlines": { "URI":"workclasses/QFieldTestWithResponseAndDeadlines", "name":"QFieldTestWithResponseAndDeadlines" }, "QFieldTest": { "URI":"workclasses/QFieldTest","name":"QFieldTest" } } }
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. |
500 Internal Server Error | Severe problem, programmer's details provided. |
/p8/bpm/v1/workclasses/{workclassName}
The workclass (workflow) representation. This is the collection of workflow properties, parameters, attachments, and workflow groups.
Name | Type | Description |
---|---|---|
workclassName | String | The name of an available workclass (workflow). |
Gets the fields for the work class launch step. When called with the POE parameter set to 1 (POE:1) in the request header, the value of the POE-Links parameter in the response header will be the workclass launch step resource that can be used to launch the workflow. If the POE parameter is set to any value other than 1, this parameter is ignored.
None.
Required? | Name | Description |
---|---|---|
optional | POE | Set this parameter to a value of 1 (POE:1) to retrieve the launch step element information. The launch step element resource is returned in the POE-Links parameter in the response header. |
GET http://restHost:8000/myContext/P8BPMRESTAPI/p8/bpm/v1/workclasses/myWorkclass
Name | Value | Description |
---|---|---|
POE-Links | (The launch step resource. See Launch Step Element. | The identifying work object number for the workclass launch step. This information is returned in the response header if the optional POE parameter is set to a value of one (POE:1). |
MIME Type: application/json
Refer to the response JSON Schema for Step Elements.
Refer to Step Elements Response Example.
Code | Description |
---|---|
200 OK | Successful completion - requested data returned. |
500 Internal Server Error | Severe problem, programmer's details provided. |
The Step Elements and Launch Step Element resources have a common JSON schema for response content:
{ "type":"object", "propeties": { "systemProperties": { "type":"object", "properties": { "workflowName":{"type":"string"}, "subject":{"type":"string"}, "instruction":{"type":"string"}, "stepName":{"type":"string"}, "deadline":{"type":"string"}, "launchDate":{"type":"string","format":"date-time"}, "reminder":{"type":"string","format":"date-time"}, "launchDate":{"type":"string","format":"date-time"}, "overdueStatus":{"type":"integer", "enum":[0,1,2]}, "originator":{"type":"string"}, "sourceDoc":{"type":"string"}, "workObjectNumber":{"type":"string"}, "workflowNumber":{"type":"string"}, "comment":{"type":"string"}, "responses": { "type":"array", "items":{"type":"string"} } "selectedResponse":{"type":"string"}, } } "dataFields": { "type":"object", "description":"Contains a dynamic set of properties. The property names are the authored data field names.", "additionalProperties": { "type":"object", "properties": { "name":{"type":"string","description":"Translated data field name."}, "type":{"type":"integer","description":"VWFieldType"}, "isArray":{"type":"boolean"}, "mode":{"type":"integer","description":"VWModeType"}, "desc":{"type":"string"}, "modified":{"type":boolean","description":"When a client modifies a data field it should set this property to true."}, "value":{"type":["string","number","boolean","array"]} } } } "attachments": { "type":"object", "description":"Contains a dynamic set of properties. The property names are the authored attachment names.", "additionalProperties": { "type":"object", "properties": { "name":{"type":"string","description":"Translated attachment name."}, "type":{"type":"integer","description":"VWFieldType"}, "isArray":{"type":"boolean"}, "mode":{"type":"integer","description":"VWModeType"}, "desc":{"type":"string"}, "modified":{"type":boolean","description":"When a client modifies an attachment it should set this property to true."}, "value": { "type":["object","array"], "properties": { "title":{"type":"string"}, "desc":{"type":"string"}, "libraryName":{"type":"string"}, "libraryType":{"type":"integer"}, "type":{"type":"integer"}, "vsId":{"type":"string"}, "version":{"type":"string"} } } } } } "workflowGroups": { "type":"object", "description":"Contains a dynamic set of properties. The property names are the authored workflow group names.", "additionalProperties": { "type":"object", "properties": { "name":{"type":"string","description":"Translated workflow group name."}, "type":{"type":"integer","description":"VWFieldType"}, "isArray":{"type":"boolean"}, "mode":{"type":"integer""description":"VWModeType"}, "desc":{"type":"string"}, "modified":{"type":boolean","description":"When a client modifies a workflow group it should set this property to true."}, "value": { "type":"array", "items":{"type":"string"} } } } } "stepProcessor": { "type":"object", "properties":, { "name":{"type":"string"}, "id":{"type":"integer"}, "appType":{"type":"string"}, "processorType":{"type":"string"}, "width":{"type":"integer"}, "height":{"type":"integer"}, "applicationName":{"type":"string"}, "locations": { "type":"object", "description":"Contains a dynamic set of properties. The property names are the web application identifiers. The value of each property is the step processor location for that web application.", "additionalProperties":{"type":"string"} } } } } }
"systemProperties": { "workflowName":"QFieldTest", "subject":"QFieldTest", "instruction":"", "stepName":"LaunchStep", "deadline":"2008-01-13T19:49:00Z", "reminder":"2008-02-13T19:49:00Z", "launchDate":"2008-03-13T19:49:00Z", "overdueStatus":1, "originator":"jsmith", "sourceDoc":"", "workObjectNumber":"", "workflowNumber":"", "comment":"This is a cool step", "responses": ["Yes","No"] "selectedResponse":"Yes" }
"attachments": { "supportingDocs": { "name":"supportingDocs", "value": [ { "title":"Credit Report1", "desc":"", "libraryName":"peru", "libraryType":3, "type":3, "vsId":"{F34061E3-ACB4-4223-B7B9-0F173F72DD15}", "version":"-1" }, { "title":"Bank Statement1", "desc":"", "libraryName":"peru", "libraryType":3, "type":2, "vsId":"{70E15871-20AF-4784-9307-797CA0618C5C}", "version":"" } ], "type":32, "isArray":true, "mode":3, "desc":"", "modified":false }, "application": { "name":"application", "value":{}, "type":32, "isArray":false, "mode":1, "desc":"" } }
"dataFields": { "QBool": { "name":"QBool", "value":true, "type":4, "isArray":false, "mode":1, "desc":"" }, "QString": { "name":"QString", "value":"red", "type":2, "isArray":false, "mode":2, "desc":"", "modified":false }, "QFloatArray": { "name":"QFloatArray", "value":[500.0,400.0,300.0,200.0,100.0], "type":8, "isArray":true, "mode":3, "desc":"", "modified":false }, "QFloat": { "name":"QFloat", "value":3.14, "type":8, "isArray":false, "mode":3, "desc":"", "modified":false }, "QTime": { "name":"QTime", "value":"2008-07-24T18:56:10-0700", "type":16, "isArray":false, "mode":3, "desc":"", "modified":false }, "QTimeArray": { "name":"QTimeArray", "value":["2008-07-24T18:56:10-0700","2008-07-24T18:56:10-0700"], "type":16, "isArray":true, "mode":3, "desc":"", "modified":false }, "QBoolArray": { "name":"QBoolArray", "value":[], "type":4, "isArray":true, "mode":3, "desc":"", "modified":false }, "QStringArray": { "name":"QStringArray", "value":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"], "type":2, "isArray":false, "mode":3, "desc":"", "modified":false }, "QInt": { "name":"QInt", "value":100, "type":1, "isArray":false, "mode":3, "desc":"", "modified":false }, "QIntArray": { "name":"QIntArray", "value":[0,1,2,3], "type":1, "isArray":true, "mode":3, "desc":"", "modified":false } }
"workflowGroups": { "QGroup1": { "name":"QGroup1", "value":["QGroup1","QGroup1GParent","QGroup1Parent"], "type":64, "isArray":true, "mode":3, "desc":"", "modified":false } }
"stepProcessor": { "width":800, "processorType":1, "height":600, "applicationName":"", "appType":32, "name":"Approval Launch HTML (FileNet)", "id":6, "locations": { "7":"html/ootb/LaunchApproval.jsp", "1":"html/ootb/LaunchApproval.jsp" } }