Operations with Specific WorkItemType
This resource lets you read, update, and delete types of work items.
Resource |
|
---|---|
Returned entity | WorkItemType. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Represents a work type that can be assigned to a work item.
Below you can find the list of resources that let you work with this entity.
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. |
name | String | The name of the work item type. |
autoAttached | Boolean | If true, this work item type is automatically added to a project, when you enable the time tracking for it. |
Read a work item type with a specific ID.
Requires permissions: Read Work Item
GET /api/admin/timeTrackingSettings/workItemTypes/{typeID}?{fields}
{typeID} | Database ID of the work item type. |
---|
Parameter | Type | Description |
---|---|---|
fields | String | A list of WorkItemType attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/timeTrackingSettings/workItemTypes/65-5?fields=name,id,autoAttached
{
"autoAttached": true,
"name": "Investigation",
"id": "65-5",
"$type": "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.
Requires permissions: Low-level Admin Write
POST /api/admin/timeTrackingSettings/workItemTypes/{typeID}?{fields}
{typeID} | Database ID of the work item type. |
---|
Parameter | Type | Description |
---|---|---|
fields | String | A list of WorkItemType attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/timeTrackingSettings/workItemTypes/65-5?fields=name,id,autoAttached
{
"autoAttached": false
}
{
"autoAttached": false,
"name": "Implementation",
"id": "65-5",
"$type": "WorkItemType"
}
Delete a work item type with a specific ID.
Requires permissions: Low-level Admin Write
DELETE /api/admin/timeTrackingSettings/workItemTypes/{typeID}
{typeID} | Database ID of the work item type. |
---|
Parameter | Type | Description |
---|---|---|
fields | String | A list of WorkItemType attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/timeTrackingSettings/workItemTypes/65-5