Constructor
new Workflow(jsXnat)
Constructor
.Constructor
Parameters:
| Name | Type | Description |
|---|---|---|
jsXnat |
JsXnat |
- Source:
Methods
createWorkflow(json, cbopt)
Create A New Workflow Entry With Querystring Parameters
.Create A New Workflow Entry With Querystring Parameters
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
json |
object | a map of workflow fields |
|
cb |
function |
<optional> |
Callback function |
- Source:
Returns:
none
createWorkflowWithRawXml(xml, cbopt)
Create A Workflow Entry From An XML Descriptor File
.Create A Workflow Entry From An XML Descriptor File
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
xml |
string | Workflow Description XML |
|
cb |
function |
<optional> |
Callback function |
- Source:
Returns:
none
getWorkflow(json, format, cb)
Get A Workflow Entry By Querystring Parameters
.Get A Workflow Entry By Querystring Parameters
Parameters:
| Name | Type | Description |
|---|---|---|
json |
object | a map of workflow fields |
format |
string | Optional. Set the format of the response. json by default |
cb |
function | optional callback function |
- Source:
getWorkflowById(workflowId, format, cb)
Get A Workflow Entry By ID
.Get A Workflow Entry By ID
Parameters:
| Name | Type | Description |
|---|---|---|
workflowId |
string | Workflow id |
format |
string | Optional. Set the format of the response. json by default |
cb |
function | optional callback function |
- Source:
updateWorkflowStatus(workflowId, status, cb)
Change the Status Of A Workflow Entry
.Change the Status Of A Workflow Entry
Parameters:
| Name | Type | Description |
|---|---|---|
workflowId |
string | Workflow id |
status |
string | Workflow status |
cb |
function | optional callback function |
- Source:
Returns:
none