Create Work Item

CreateWorkItem creates a work item of a specified type in an Azure Boards project.

It calls POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}, where {organization}, {project} and {type} come from the Organization, Project and Type fields.

The activity has five tabs: Configuration, AddMetadata, Auth, Input, and Output.

Configuration

Field	Required	Description
Name	Optional	Name of the step, should be unique within this workflow.
Description	Optional	Describe the purpose or function of this step.
Api Version	Required	Specify the version of the API to use.
Organization	Required	Enter the name of the organization.
Project	Required	Enter the name of the project.
Type	Required	Specify the type of resource.
Suppress Notifications	Optional	Specify whether to suppress notifications during the operation.
Validate Only	Optional	Specify whether to validate only without making changes.
Expand	Optional	Specify the related entities to include in the response.
Bypass Rules	Optional	Specify whether to bypass certain rules during the operation.

Suppress Notifications, Validate Only and Bypass Rules are checkboxes. Type is a path parameter, so it selects which work item type is created — the remaining three are query parameters on the request.

AddMetadata

The Operations table is mapped to the request body. Each row is one JSON Patch operation against the new work item.

Column	Description
Op	The patch operation. One of add, remove, replace, move, copy, or test.
Path	The target of the operation.
Value	The value to apply.
From	The source location, for move and copy.

Auth

Field	Required	Description
Auth Type	Optional	Select the authentication method for the request. Options: No Auth, Basic, API Key, OAuth 2.
Auth Resource	Optional	OAuth resource containing credentials.
User Name	Optional	Username for Basic Authentication.
Password	Optional	Password for Basic Authentication.

Input

This activity is built on the REST Client, so the Input tab is the generic HTTP request rather than an Azure Boards-shaped payload. The method, host and URI are already set.

Field	Required	Data Type	Description
Target	Required	Object	The HTTP request.

Output

The activity returns an httpResponse object.

Field	Data Type	Description
status.code	Integer	Numeric HTTP status code.
status.message	String	Short message associated with the HTTP status.
headers	Object	HTTP response headers.
body	Object	Parsed body of the response — the created work item.

The response body carries the work item:

Field	Data Type	Description
id	Integer	The work item ID.
rev	Integer	Revision number of the work item.
fields	Object	Map of field and values for the work item.
relations	Array	Relations of the work item.
commentVersionRef	Object	Represents the reference to a specific version of a comment on a Work Item.
multilineFieldsFormat	Object	Dictionary describing the Format for multiline fields selected by the last edit user.