SpiraPlan: REST Web Service (v6.0)

See all operations

PUT: projects/{project_id}/tasks


Updates a task in the system

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


Request Parameters

Name Description
project_id The id of the current project

Request Body

Property Description
TaskId The id of the task
TaskStatusId The id of the status of the task
TaskTypeId The id of the type of the task (null for default)
TaskFolderId The of the folder the task is stored in (null for root)
RequirementId The id of the parent requirement that the task belongs to
ReleaseId The id of the release/iteration that the task is scheduled for
CreatorId The id of the user that originally created the task If no value is provided, the authenticated user is used instead
OwnerId The id of the user that the task is assigned-to
TaskPriorityId The id of the priority of the task
Name The name of the task
Description The detailed description of the task
CreationDate The date/time that the task was originally created
LastUpdateDate The date/time that the task was last modified This field needs to match the values retrieved to ensure data-concurrency
StartDate The scheduled start date for the task
EndDate The scheduled end date for the task
EstimatedEffort The originally estimated effort (in minutes) of the task
ActualEffort The actual effort expended so far (in minutes) for the task
RemainingEffort The effort remaining as reported by the developer
RiskId The risk that the task is associated with
ProjectId The id of the project that the artifact belongs to
ConcurrencyDate The datetime used to track optimistic concurrency to prevent edit conflicts
CustomProperties The list of associated custom properties/fields for this artifact
Tags The list of meta-tags that should be associated with the artifact

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.