SpiraPlan: REST Web Service (v7.0)
Updates workflow custom property states for a given artifact status + workflow
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}/documents/workflows/{workflow_id}/custom-properties/{document_status_id}
<ArrayOfRemoteWorkflowCustomProperty xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects"> <RemoteWorkflowCustomProperty> <ConcurrencyGuid i:nil="true" /> <Guid i:nil="true" /> <LastUpdateDate i:nil="true" /> <ArtifactStatusId i:nil="true" /> <ArtifactTypeId i:nil="true" /> <CustomPropertyId>0</CustomPropertyId> <FieldCaption i:nil="true" /> <FieldName i:nil="true" /> <FieldStateId>0</FieldStateId> </RemoteWorkflowCustomProperty> </ArrayOfRemoteWorkflowCustomProperty>
[{"FieldCaption":null, "FieldName":null, "CustomPropertyId":0, "FieldStateId":0, "ArtifactTypeId":null, "ArtifactStatusId":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