WorkItem

Represents a logical unit of work, such as a user story, task, or bug, used to track the progress of metadata and configuration data changes within a DevOps Center project. A work item moves through multiple development lifecycle stages until all development work is complete and the work item is part of the release pipeline. This object is available in API version 67.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
AssignedToId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the DevOps Center user assigned to this work item. DevOps Center uses this field only to display the user’s name in the UI. This is a relationship field.
This field is a relationship field.
Relationship Name
AssignedTo
Refers To
User
Description
Type
textarea
Properties
Create, Nillable, Update
Description
A detailed description of the work item. DevOps Center uses this field only to display the description in the UI.
DevelopmentApprovedById
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the user who approved the work item for promotion.
This field is a relationship field.
Relationship Name
DevelopmentApprovedBy
Refers To
User
DevelopmentEnvironmentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the development environment where this work item was developed.
This field is a relationship field.
Relationship Name
DevelopmentEnvironment
Refers To
DevopsEnvironment
DevopsPipelineStageId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the current pipeline stage associated with this work item.
This field is a relationship field.
Relationship Name
DevopsPipelineStage
Refers To
DevopsPipelineStage
DevopsProjectId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The ID of the DevOps Center project to which the work item belongs. This is a relationship field.
This field is a polymorphic relationship field.
Relationship Name
DevopsProject
Refers To
DevopsProject
IsDevelopmentApproved
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether a team member has approved the work item for promotion. The default value is false.
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastSyncDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time the work item feature branch was last synced with the source control repository.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
A unique identifier for the work item, typically using a WI- prefix.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the owner of this work item. This is a relationship field.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
ParentWorkItemId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the parent work item, if this work item is a subtask of a larger unit of work
This field is a relationship field.
Relationship Name
ParentWorkItem
Refers To
WorkItem
RebaseBranchId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the branch used for rebase operations to resolve dependencies.
This field is a relationship field.
Relationship Name
RebaseBranch
Refers To
SourceCodeRepositoryBranch
RebaseStatusId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the DevopsRequestInfo record that tracks the rebase operation status.
This field is a relationship field.
Relationship Name
RebaseStatus
Refers To
DevopsRequestInfo
ReviewRemoteReference
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A reference to the change request for this work item in the source control system. In GitHub, a change request is called a pull request (PR) and the ID is the PR number.
SourceCodeRepositoryBranchId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the feature branch in the source control repository where changes for this work item are stored. DevOps Center initially sets this value when the work item moves to IN_PROGRESS. The value persists until the work item becomes part of a pipeline stage.
This field is a relationship field.
Relationship Name
SourceCodeRepositoryBranch
Refers To
SourceCodeRepositoryBranch
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
The current state of the work item in the release cycle. The default value is NEW.
Possible values are:
  • NEW—The initial status upon creation; work hasn't yet started.
  • IN_PROGRESS—Active development in the development environment.
  • IN_REVIEW—Changes are committed and a pull request is created for team review.
  • READY_TO_PROMOTE—The work item is approved and is ready for promotion to the first pipeline stage.
  • PROMOTED—The work item is promoted to a pipeline stage.
  • MERGE_CONFLICT—Indicates that the work item has conflicts that must be resolved before promotion.
  • NEVERED—The work item is inactive and won’t be promoted.
  • COMBINED—The work item was merged into another work item to resolve conflicts or dependencies.
  • CLOSED—Work is complete, fully tested, and promoted through the entire pipeline.
The default value is NEW.
Subject
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
A brief description or title of the work item.

Usage

Use this object to track the progress of a task and the user assigned to it. You can develop and commit changes either within a connected development environment or by using your own external development tools.