See all operations

PUT: projects/{project_id}/tasks

Description

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

https://api.inflectra.com/spira/services/v7_0/RestService.svc/projects/{project_id}/tasks

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
ProjectGuid	The guid 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
Guid	The unique identifier for the artifact

<RemoteTask xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
  <ArtifactTypeId>0</ArtifactTypeId>
  <ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
  <CustomProperties i:nil="true" />
  <Guid i:nil="true" />
  <IsAttachments>false</IsAttachments>
  <ProjectGuid i:nil="true" />
  <ProjectId>0</ProjectId>
  <Tags i:nil="true" />
  <ActualEffort i:nil="true" />
  <CompletionPercent>0</CompletionPercent>
  <ComponentId i:nil="true" />
  <CreationDate>0001-01-01T00:00:00</CreationDate>
  <CreatorGuid i:nil="true" />
  <CreatorId i:nil="true" />
  <Description i:nil="true" />
  <EndDate i:nil="true" />
  <EstimatedEffort i:nil="true" />
  <LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
  <Name i:nil="true" />
  <OwnerGuid i:nil="true" />
  <OwnerId i:nil="true" />
  <OwnerName i:nil="true" />
  <ProjectName i:nil="true" />
  <ProjectedEffort i:nil="true" />
  <ReleaseGuid i:nil="true" />
  <ReleaseId i:nil="true" />
  <ReleaseVersionNumber i:nil="true" />
  <RemainingEffort i:nil="true" />
  <RequirementId i:nil="true" />
  <RequirementName i:nil="true" />
  <RiskId i:nil="true" />
  <StartDate i:nil="true" />
  <TaskFolderId i:nil="true" />
  <TaskId i:nil="true" />
  <TaskPriorityId i:nil="true" />
  <TaskPriorityName i:nil="true" />
  <TaskStatusId>0</TaskStatusId>
  <TaskStatusName i:nil="true" />
  <TaskTypeId i:nil="true" />
  <TaskTypeName i:nil="true" />
</RemoteTask>

{"TaskId":null,
"TaskStatusId":0,
"TaskTypeId":null,
"TaskFolderId":null,
"RequirementId":null,
"ReleaseId":null,
"ReleaseGuid":null,
"ComponentId":null,
"CreatorId":null,
"OwnerId":null,
"CreatorGuid":null,
"OwnerGuid":null,
"TaskPriorityId":null,
"Name":null,
"Description":null,
"CreationDate":"0001-01-01T00:00:00",
"LastUpdateDate":"0001-01-01T00:00:00",
"StartDate":null,
"EndDate":null,
"CompletionPercent":0,
"EstimatedEffort":null,
"ActualEffort":null,
"RemainingEffort":null,
"ProjectedEffort":null,
"TaskStatusName":null,
"TaskTypeName":null,
"OwnerName":null,
"TaskPriorityName":null,
"ProjectName":null,
"ReleaseVersionNumber":null,
"RequirementName":null,
"RiskId":null,
"ProjectId":0,
"ProjectGuid":null,
"ArtifactTypeId":0,
"ConcurrencyDate":"0001-01-01T00:00:00",
"CustomProperties":null,
"IsAttachments":false,
"Tags":null,
"Guid":null}

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.

Nothing Returned

Nothing Returned