Developer Portal for YouTrack and Hub Help

Operations with Specific WorkItemType

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

Resource

/api/admin/timeTrackingSettings/workItemTypes/{typeID}

Returned entity

WorkItemType. For the description of the entity attributes, see Supported Fields section.

Supported methods

WorkItemType attributes

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

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 Specific WorkItemType

Read a work item type with a specific ID.

Required permissions

Requires permissions: Read Work Item

Request syntax

GET /api/admin/timeTrackingSettings/workItemTypes/{typeID}?{fields}

{typeID}

Database ID of the work item type.

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/65-5?fields=name,id,autoAttached

Sample response body

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

Update a Specific WorkItemType

Update a work item type with a specific ID. In the body of the request, provide the properties that you need to change as JSON.

Required permissions

Requires permissions: Low-level Admin Write

Request syntax

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

{typeID}

Database ID of the work item type.

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/65-5?fields=name,id,autoAttached

Sample request body

{ "autoAttached": false }

Delete a Specific WorkItemType

Delete a work item type with a specific ID.

Required permissions

Requires permissions: Low-level Admin Write

Request syntax

DELETE /api/admin/timeTrackingSettings/workItemTypes/{typeID}

{typeID}

Database ID of the work item type.

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/65-5
Last modified: 30 May 2022