Developer Portal for YouTrack and Hub Help

Operations with Specific WorkItemType

This resource lets you configure work item types of the project.

Resource

/api/admin/projects/{projectID}/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.

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

Read the attributes of the specific work item type in the project.

Required permissions

Requires permissions: Read Work Item, Update Work Item, or Create Work Item

Request syntax

GET /api/admin/projects/{projectID}/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/projects/0-0/timeTrackingSettings/workItemTypes/65-2?fields=id,name,autoAttached

Sample response body

{ "name": "Documentation", "autoAttached": false, "id": "65-2", "$type": "WorkItemType" }

Delete a Specific WorkItemType

Detach the work item type from the project.

Request syntax

DELETE /api/admin/projects/{projectID}/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/projects/0-0/timeTrackingSettings/workItemTypes/65-3
Last modified: 7 November 2024