SpiraPlan: REST Web Service (v5.0)

See all operations

GET: projects/{project_id}/tasks/{task_id}


Retrieves a single 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
task_id The id of the task

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
TaskId The id of the task
TaskStatusId The id of the status of the task
TaskTypeId The id of the type of the task
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
ComponentId The id of the component that this task belongs to Read-only
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
CompletionPercent The completion percentage (value = 0-100) of the task as calculated in the system from the remaining effort vs. the original estimated effort. Read-Only
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
ProjectedEffort The projected actual effort of the task when it is completed Read-Only
TaskStatusName The display name of the status of the task
TaskTypeName The display name of the type of the task
OwnerName The display name of the user who the task is assigned-to Read-Only
TaskPriorityName The display name of the priority of the task Read-Only
ProjectName The display name of the project the task belongs to Read-Only
ReleaseVersionNumber The version number of the release/iteration the task is scheduled for Read-Only
RequirementName The name of the requirement that the task is associated with Read-Only
ProjectId The id of the project that the artifact belongs to The current project is always used for Insert operations for security reasons
ArtifactTypeId The type of artifact that we have
ConcurrencyDate The datetime used to track optimistic concurrency to prevent edit conflicts
CustomProperties The list of associated custom properties/fields for this artifact
IsAttachments Does this artifact have any attachments?