new Workflow()
Workflow REST resource for retrieving workflows.
Properties:
Name | Type | Description |
---|---|---|
connector |
IConnector | the jira connector instance |
- Source:
Methods
createProperty(options, callbackopt) → {Promise.<any>}
Add a new property to a transition. Trying to add a property that already exists will fail.the name of the property to add.the name of the workflow to use.the type of workflow to use. Can either be "live" or "draft".
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
deleteProperty(options, callbackopt) → {Promise.<any>}
Delete a property from the passed transition on the passed workflow. It is not an error to delete a property that does not exist.the name of the property to add.the name of the workflow to use.the type of workflow to use. Can either be "live" or "draft".
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
find(options, callbackopt) → {Promise.<any>}
Returns all workflows.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
getProperties(options, callbackopt) → {Promise.<any>}
Return the property or properties associated with a transition.some keys under the "jira." prefix are editable, some are not. Set this to true in order to include the non-editable keys in the response.the name of the property key to query. Can be left off the query to return all properties.the name of the workflow to use.the type of workflow to use. Can either be "live" or "draft".
Parameters:
Name | Type | Attributes | Description | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
||||||||||||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
updateProperty(options, callbackopt) → {Promise.<any>}
Update/add new property to a transition. Trying to update a property that does not exist will result in a new property being added.the name of the property to add.the name of the workflow to use.the type of workflow to use. Can either be "live" or "draft".
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>