SpiraPlan: REST Web Service (v6.0)

See all operations

GET: project-templates/{project_template_id}/tasks/types/{task_type_id}/workflow/custom-properties?status_id={task_status_id}

Description

Retrieves the list of task custom properties and their workflow state for a given type and status/step.

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/v6_0/RestService.svc/project-templates/{project_template_id}/tasks/types/{task_type_id}/workflow/custom-properties?status_id={task_status_id}

Request Parameters

Name Description
project_template_id The id of the project template
task_type_id The current task type
task_status_id The current task status

Request Body

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