SpiraPlan: REST Web Service (v7.0)
Updates a batch of workflow fields for a given status to fit the desired workflow state for all fields
FieldStateId determines the state of a given field. Here are the potential values 0 = Default (No workflow restrictions) 1 = Disabled 2 = Required 3 = Hidden
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}/test-cases/workflows/{workflow_id}/fields/{test_case_status_id}
<ArrayOfRemoteWorkflowField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects"> <RemoteWorkflowField> <ConcurrencyGuid i:nil="true" /> <Guid i:nil="true" /> <LastUpdateDate i:nil="true" /> <ArtifactStatusId i:nil="true" /> <ArtifactStatusName i:nil="true" /> <ArtifactTypeId i:nil="true" /> <FieldCaption i:nil="true" /> <FieldId>0</FieldId> <FieldName i:nil="true" /> <FieldStateId>0</FieldStateId> <WorkflowId i:nil="true" /> </RemoteWorkflowField> </ArrayOfRemoteWorkflowField>
[{"FieldCaption":null, "FieldName":null, "FieldId":0, "FieldStateId":0, "ArtifactTypeId":null, "ArtifactStatusId":null, "ArtifactStatusName":null, "WorkflowId":null, "Guid":null, "ConcurrencyGuid":null, "LastUpdateDate":null}]
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.
Nothing Returned