Work Item Types

This resource lets you read, update, and delete types of work items.

Resource	/api/admin/timeTrackingSettings/workItemTypes
Returned entity	WorkItemType. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a List of WorkItemTypes. `POST`: Add a New WorkItemType.

WorkItemType attributes

Represents a work type that can be assigned to a work item.

Related Resources

Below you can find the list of resources that let you work with this entity.

Attributes

This table describes attributes of the WorkItemType entity.

To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.
To update an attribute, provide it in the body of a POST request.

Field	Type	Description
id	String	The ID of the work item type. `Read-only`.
name	String	The name of the work item type. `Can be null`.
autoAttached	Boolean	If true, this work item type is automatically added to a project, when you enable the time tracking for it.

Read a List of WorkItemTypes

Read the list of currently available work item types.

Request syntax

GET /api/admin/timeTrackingSettings/workItemTypes?{fields}&{$top}&{$skip}

Request parameters

Parameter

Type

Description

fields

String

A list of WorkItemType attributes that should be returned in the response. If no field is specified, only the entityID is returned.

$skip

Int

Optional. Lets you set a number of returned entities to skip before returning the first one.

$top

Int

Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries.

The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination.

Sample

Sample request

                https://example.youtrack.cloud/api/admin/timeTrackingSettings/workItemTypes?fields=id,name,url,autoAttached
            

Sample response body

                [
                  {
                    "autoAttached": true,
                    "name": "Development",
                    "id": "65-0",
                    "$type": "WorkItemType"
                  },
                  {
                    "autoAttached": true,
                    "name": "Testing",
                    "id": "65-1",
                    "$type": "WorkItemType"
                  },
                  {
                    "autoAttached": false,
                    "name": "Documentation",
                    "id": "65-2",
                    "$type": "WorkItemType"
                  },
                  {
                    "autoAttached": false,
                    "name": "R-n-D",
                    "id": "65-3",
                    "$type": "WorkItemType"
                  }
                ]
            

Add a New WorkItemType

Create a new work item type.

Required fields: name.

Required permissions

Requires permissions: Low-level Admin Write or Update Project

Request syntax

POST /api/admin/timeTrackingSettings/workItemTypes?{fields}

Request parameters

Parameter	Type	Description
fields	String	A list of WorkItemType attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.

Sample

Sample request

                https://example.youtrack.cloud/api/admin/timeTrackingSettings/workItemTypes?fields=name,id
            

Sample request body

                {
                  "name": "Investigation",
                  "autoAttached": true
                }
            

Sample response body

                {
                  "name": "Investigation",
                  "id": "65-5",
                  "$type": "WorkItemType"
                }
            

Last modified: 7 November 2024