See all operations
POST: project-templates/{project_template_id}/requirements/workflows/{workflow_id}/transitions
Description
Creates a new workflow transition for a requirement workflow. Does not support NotificationSubject.
How to Execute
To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):
https://api.inflectra.com/spira/services/v7_0/RestService.svc/project-templates/{project_template_id}/requirements/workflows/{workflow_id}/transitions
Request Parameters
|
Name
|
Description
|
|
project_template_id
|
ProjectTemplate the workflow exists within
|
|
workflow_id
|
ID of the relevant workflow to add a transition to
|
Request Body
|
Property
|
Description
|
|
ExecuteByCreator
|
Can this transition be executed by the creator of the artifact
|
|
ExecuteByOwner
|
Can this transition be executed by the owner of the artifact
|
|
StatusId_Input
|
What is the id of the input artifact status
|
|
StatusId_Output
|
What is the id of the output artifact status
|
|
Name
|
What is the name of the transition
|
|
WorkflowId
|
What workflow does this transition belong to
|
|
TransitionId
|
What is the id of this transition
|
|
RequireSignature
|
Does it require an electronic signature
|
|
BlankOwner
|
Does the status this transition transitions to allow the Owner (OwnerId) field to be blank on the artifact being transitioned
|
|
NotifyCreator
|
Does this transition notify the artifact creator
|
|
NotifyOwner
|
Does this transition notify the artifact owner
|
|
NotificationSubject
|
Transition notification email subject line for emails sent to users configured to recieve notifications for this transition. (Incidents only)
|
|
UserRoles
|
UserRoleIds for who can execute this transition
|
|
NotificationRoles
|
UserRoleIds for who is notified when this transition occurrs (Incidents only)
|
|
Guid
|
The unique identifier for the artifact
|
|
ConcurrencyGuid
|
GUID for representing the concurrency state of a given artifact
|
|
LastUpdateDate
|
Last time the artifact was updated
|
<RemoteWorkflowTransition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ConcurrencyGuid i:nil="true" />
<Guid i:nil="true" />
<LastUpdateDate i:nil="true" />
<BlankOwner>false</BlankOwner>
<ExecuteByCreator>false</ExecuteByCreator>
<ExecuteByOwner>false</ExecuteByOwner>
<Name i:nil="true" />
<NotificationRoles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<NotificationSubject i:nil="true" />
<NotifyCreator>false</NotifyCreator>
<NotifyOwner>false</NotifyOwner>
<RequireSignature>false</RequireSignature>
<StatusId_Input>0</StatusId_Input>
<StatusId_Output>0</StatusId_Output>
<StatusName_Input i:nil="true" />
<StatusName_Output i:nil="true" />
<TransitionId>0</TransitionId>
<UserRoles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<WorkflowId>0</WorkflowId>
</RemoteWorkflowTransition>
{"ExecuteByCreator":false,
"ExecuteByOwner":false,
"StatusId_Input":0,
"StatusName_Input":null,
"StatusId_Output":0,
"StatusName_Output":null,
"Name":null,
"WorkflowId":0,
"TransitionId":0,
"RequireSignature":false,
"BlankOwner":false,
"NotifyCreator":false,
"NotifyOwner":false,
"NotificationSubject":null,
"UserRoles":null,
"NotificationRoles":null,
"Guid":null,
"ConcurrencyGuid":null,
"LastUpdateDate":null}
Return Data
The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.
|
Property
|
Description
|
|
ExecuteByCreator
|
Can this transition be executed by the creator of the artifact
|
|
ExecuteByOwner
|
Can this transition be executed by the owner of the artifact
|
|
StatusId_Input
|
What is the id of the input artifact status
|
|
StatusName_Input
|
What is the display name of the input artifact status
|
|
StatusId_Output
|
What is the id of the output artifact status
|
|
StatusName_Output
|
What is the display name of the output artifact status
|
|
Name
|
What is the name of the transition
|
|
WorkflowId
|
What workflow does this transition belong to
|
|
TransitionId
|
What is the id of this transition
|
|
RequireSignature
|
Does it require an electronic signature
|
|
BlankOwner
|
Does the status this transition transitions to allow the Owner (OwnerId) field to be blank on the artifact being transitioned
|
|
NotifyCreator
|
Does this transition notify the artifact creator
|
|
NotifyOwner
|
Does this transition notify the artifact owner
|
|
NotificationSubject
|
Transition notification email subject line for emails sent to users configured to recieve notifications for this transition. (Incidents only)
|
|
UserRoles
|
UserRoleIds for who can execute this transition
|
|
NotificationRoles
|
UserRoleIds for who is notified when this transition occurrs (Incidents only)
|
|
Guid
|
The unique identifier for the artifact
|
|
ConcurrencyGuid
|
GUID for representing the concurrency state of a given artifact
|
|
LastUpdateDate
|
Last time the artifact was updated
|
<RemoteWorkflowTransition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ConcurrencyGuid i:nil="true" />
<Guid i:nil="true" />
<LastUpdateDate i:nil="true" />
<BlankOwner>false</BlankOwner>
<ExecuteByCreator>false</ExecuteByCreator>
<ExecuteByOwner>false</ExecuteByOwner>
<Name i:nil="true" />
<NotificationRoles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<NotificationSubject i:nil="true" />
<NotifyCreator>false</NotifyCreator>
<NotifyOwner>false</NotifyOwner>
<RequireSignature>false</RequireSignature>
<StatusId_Input>0</StatusId_Input>
<StatusId_Output>0</StatusId_Output>
<StatusName_Input i:nil="true" />
<StatusName_Output i:nil="true" />
<TransitionId>0</TransitionId>
<UserRoles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<WorkflowId>0</WorkflowId>
</RemoteWorkflowTransition>
{"ExecuteByCreator":false,
"ExecuteByOwner":false,
"StatusId_Input":0,
"StatusName_Input":null,
"StatusId_Output":0,
"StatusName_Output":null,
"Name":null,
"WorkflowId":0,
"TransitionId":0,
"RequireSignature":false,
"BlankOwner":false,
"NotifyCreator":false,
"NotifyOwner":false,
"NotificationSubject":null,
"UserRoles":null,
"NotificationRoles":null,
"Guid":null,
"ConcurrencyGuid":null,
"LastUpdateDate":null}