Skip to content

Devops-Plan - Process Steps

Create Plan Record
Update Sprint
Update WorkItem
Update Release
Update Any Record
Delete Record

Create Plan Record

Use this step to create a new Plan Record in DevOps Plan. This may represent a Release,Project,Work Item,Sprint.

NameTypeDescriptionRequired
Plan Base UrlStringThe Base Url for Devops Plan Server (Example: https://<plan-server-url>/plan)Yes
API TokenStringAPI Token for the Plan server..Yes
Trust All SSL CertificatesCheckboxIf checked,Trust all SSL certificates.Yes
Teamspace IdStringGo to My Applications → Tenant Management → select your teamspace → Details tab → Enable Show connection properties -> Copy the ID from the Data Base field.Yes
Application NameStringEnter the name of the Application..Yes
Record Type NameStringEnter the type of record to create.Yes
Additional Fields (JSON)StringSupply additional fields or Mandatory Fields as a JSON object.Refer to usage tabYes

Update Sprint

Use this step to update a Sprint record in the DevOps Plan.

NameTypeDescriptionRequired
Plan Base UrlStringThe Base Url for Devops Plan Server (Example: https://<plan-server-url>/plan)Yes
API TokenStringAPI Token for the Plan server..Yes
Trust all SSL certificates.CheckboxIf checked,Trust all SSL certificates.Yes
Teamspace IdStringGo to My Applications → Tenant Management → select your teamspace → Details tab → Enable Show connection properties -> Copy the ID from the Data Base field.Yes
Application NameStringEnter the name of the Application.Yes
Current Sprint NameStringEnter the name of Sprint to update.Yes
NameStringEnter the new Sprint Name.Leave empty to keep current name..No
DescriptionStringEnter the new Description.Leave empty to keep current Description.No
Start DateStringEnter the new Start Date (MANDATORY for Sprint/Release) Format: YYYY-MM-DD.No
End DateStringEnter the new End Date (MANDATORY for Sprint/Release) Format: YYYY-MM-DD.No
Additional Fields (JSON)StringSupply advanced fields or custom fields not listed above.No

Update WorkItem

Use this step to update a WorkItem record in the DevOps Plan.

NameTypeDescriptionRequired
Plan Base UrlStringEnter the Base Url for Devops Plan Server (Example: https://<plan-server-url>/plan)Yes
API TokenStringAPI Token for the Plan server.Yes
Trust all SSL certificates.CheckboxIf checked,Trust all SSL certificates.Yes
Teamspace IdStringTo find the Teamspace ID: Go to My Applications → Tenant Management → select your teamspace → Details → Enable Show connection properties → copy ID.Yes
Application NameStringEnter the name of the Application.Yes
Work Item IdStringEnter the WorkItem ID to update. e.g. AppName00000006Yes
TitleStringThe summary/Headline of the work Item.No
TypeStringEnter the Work Item Type.e.g. Defect, Task, Story, EpicNo
StateStringEnter the State of the Work Item State e.g. Submitted, Active, Resolved, ClosedNo
OwnerStringThe user ID of the owner.No
SeverityStringEnter the Severity of the Work Item.e.g. Critical, High, Medium, LowNo
PriorityStringEnter the Priority value.No
ResolutionStringEnter the Resolution e.g. Fixed, Duplicate, InvalidNo
TagsStringEnter the Comma-separated tags.No
ProjectStringEnter the Project Name.No
ComponentStringEnter the Component name.No
Story PointsStringEnter the Story points value.No
Planned ReleaseStringThe name of the target Release.No
SprintStringThe Name/ID of the assigned Sprint.No
Parent IDStringThe ID of the parent work item.No
DescriptionStringEnter the Description .No
Additional Fields (JSON)StringSupply advanced fields or custom fields not listed above.No

Update Release

Use this step to update a Release record in the DevOps Plan.

NameTypeDescriptionRequired
Plan Base UrlStringEnter the Base Url for Devops Plan Server (Example: https://<plan-server-url>/plan)Yes
API TokenStringAPI Token for the Plan server.Yes
Trust all SSL certificates.CheckboxIf checked,Trust all SSL certificates.Yes
Teamspace IdStringTo find the Teamspace ID: Go to My Applications → Tenant Management → select your teamspace → Details → Enable Show connection properties → copy ID.Yes
Application NameStringEnter the name of the Application.Yes
Current Release NameStringEnter the name of Release to update.Yes
New Release NameStringLeave empty to keep the current name.No
Start DateStringEnter the new Start Date Format: YYYY-MM-DD HH:MM:SSNo
End DateStringEnter the new End Date Format: YYYY-MM-DD HH:MM:SSNo
DeliveredStringSet to 'Yes' or 'No'.No
FrozenStringSet to 'Yes' or 'No'.No
DescriptionStringEnter the Description.No
Additional Fields (JSON)StringSupply advanced fields or custom fields not listed above.No

Update Any Record

Use this step to update any type of record in the DevOps Plan.

NameTypeDescriptionRequired
Record TypeStringEnter the Record Type.Yes
Plan Base UrlStringEnter the Base Url for Devops Plan Server (Example: https://<plan-server-url>/plan)Yes
API TokenStringAPI Token for the Plan server.Yes
Trust all SSL certificates.CheckboxIf checked,Trust all SSL certificates.Yes
Teamspace IdStringTo find the Teamspace ID: Go to My Applications → Tenant Management → select your teamspace → Details → Enable Show connection properties → copy ID.Yes
Application NameStringEnter the name of the Application.Yes
Current Record NameStringEnter the name of Record to update.Yes
New Record NameStringLeave empty to keep current name.No
DescriptionStringLeave empty to keep current description.No
Start DateStringEnter the new Start Date Format: YYYY-MM-DD (e.g. 2025-10-01)No
End DateStringEnter the new End Date Format Format: YYYY-MM-DD (e.g. 2025-10-31)No
Additional Fields (JSON)StringSupply advanced fields or custom fields not listed above.No

Delete Record

Use this step to delete a record in the DevOps Plan.

NameTypeDescriptionRequired
Plan Base UrlStringEnter the Base Url for Devops Plan Server (Example: https://<plan-server-url>/plan)Yes
API TokenStringAPI Token for the Plan server.Yes
Trust all SSL certificates.CheckboxIf checked,Trust all SSL certificates.Yes
Teamspace IdStringTo find the Teamspace ID: Go to My Applications → Tenant Management → select your teamspace → Details → Enable Show connection properties → copy ID.Yes
Application NameStringEnter the name of the Application.Yes
Record TypeStringThe Entity Definition Name (e.g., WorkItem, Sprint, Release).Yes
Record Name/Record IdStringThe Name of the record you want to delete. For WorkItem use the WorkItem IdYes