Capacities - Get Capacities With Identity Ref And Totals
Get a team's capacity including total capacity and days off
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations/{iterationId}/capacities?api-version=7.2-preview.3URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
iteration
|
path | True |
string (uuid) |
ID of the iteration |
|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
|
project
|
path | True |
string |
Project ID or project name |
|
team
|
path |
string |
Team ID or team name |
|
|
api-version
|
query | True |
string |
Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
successful operation |
Security
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
| Name | Description |
|---|---|
| vso.work | Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks. |
Definitions
| Name | Description |
|---|---|
| Activity | |
|
Date |
|
|
Identity |
|
|
Reference |
The class to represent a collection of REST reference links. |
|
Team |
Represents team member capacity with totals aggregated |
|
Team |
Represents capacity for a specific team member |
Activity
| Name | Type | Description |
|---|---|---|
| capacityPerDay |
number (float) |
|
| name |
string |
DateRange
| Name | Type | Description |
|---|---|---|
| end |
string (date-time) |
End of the date range. |
| start |
string (date-time) |
Start of the date range. |
IdentityRef
| Name | Type | Description |
|---|---|---|
| _links |
This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. |
|
| descriptor |
string |
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. |
| directoryAlias |
string |
Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary |
| displayName |
string |
This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. |
| id |
string |
|
| imageUrl |
string |
Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary |
| inactive |
boolean |
Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary |
| isAadIdentity |
boolean |
Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
| isContainer |
boolean |
Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
Deprecated - not in use in most preexisting implementations of ToIdentityRef |
| uniqueName |
string |
Deprecated - use Domain+PrincipalName instead |
| url |
string |
This url is the full route to the source resource of this graph subject. |
ReferenceLinks
The class to represent a collection of REST reference links.
| Name | Type | Description |
|---|---|---|
| links |
object |
The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. |
TeamCapacity
Represents team member capacity with totals aggregated
| Name | Type | Description |
|---|---|---|
| teamMembers |
Represents capacity for a specific team member |
|
| totalCapacityPerDay |
number (double) |
|
| totalDaysOff |
integer (int32) |
TeamMemberCapacityIdentityRef
Represents capacity for a specific team member
| Name | Type | Description |
|---|---|---|
| _links |
Collection of links relevant to resource |
|
| activities |
Activity[] |
Collection of capacities associated with the team member |
| daysOff |
The days off associated with the team member |
|
| teamMember |
Identity ref of the associated team member |
|
| url |
string |
Full http link to the resource |