SpiraTeam: REST Web Service (v5.0)

See all operations

POST: projects/{project_id}/requirements/{requirement_id}/steps?existing_requirement_step_id={existing_requirement_step_id}&creator_id={creator_id}

Description

Adds a requirement step to a requirement

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):

http://api.inflectra.com/Spira/Services/v5_0/RestService.svc/projects/{project_id}/requirements/{requirement_id}/steps?existing_requirement_step_id={existing_requirement_step_id}&creator_id={creator_id}

Request Parameters

Name Description
project_id The id of the project
requirement_id The id of the requirement
existing_requirement_step_id The id of the existing step to insert before (null = end of the list)
creator_id The id of the user adding the step (null = use authenticated user)

Request Body

Property Description
RequirementStepId The id of the step
RequirementId The id of the requirement the step belongs to
Position The position of the step in the requirement
Description The description of this step
LastUpdateDate The date the step was last updated
ConcurrencyDate The date the step was edited
CreationDate The date the step was created

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
RequirementStepId The id of the step
RequirementId The id of the requirement the step belongs to
Position The position of the step in the requirement
Description The description of this step
LastUpdateDate The date the step was last updated
ConcurrencyDate The date the step was edited
CreationDate The date the step was created