Capacities - Update

Reference

Service:: Work

API Version:: 7.1

Update a team member's capacity

PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations/{iterationId}/capacities/{teamMemberId}?api-version=7.1

URI Parameters

Name	In	Required	Type	Description
iterationId	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
teamMemberId	path	True	string uuid	ID of the team member
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.1' to use this version of the api.

Request Body

Name	Type	Description
activities	Activity[]
daysOff	DateRange[]

Responses

Name	Type	Description
200 OK	TeamMemberCapacityIdentityRef	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_write	Grants the ability to read, create, and update work items and queries, update board metadata, read area and iterations paths other work item tracking related metadata, execute queries, and to receive notifications about work item events via service hooks.

Examples

Update a team member's capacity

Sample request

HTTP

PATCH https://dev.azure.com/{organization}/{project}/_apis/work/teamsettings/iterations/{iterationId}/capacities/{teamMemberId}?api-version=7.1

{
  "activities": [
    {
      "capacityPerDay": 5,
      "name": "Design"
    },
    {
      "capacityPerDay": 5,
      "name": "Development"
    }
  ],
  "daysOff": []
}

Sample response

Status code:: 200

{
  "teamMember": {
    "displayName": "Chuck Reinhart",
    "url": "https://sps1.vssps.vsts.me/Aa8f1b4b1-d4b5-4bc2-a949-cca3e3d3cab4/_apis/Identities/73a2309e-d0b3-6bf5-9500-9af8bcc805ec",
    "_links": {
      "avatar": {
        "href": "https://codedev.ms/fabrikam/_apis/GraphProfile/MemberAvatars/aad.NzNhMjMwOWUtZDBiMy03YmY1LTk1MDAtOWFmOGJjYzgwNWVj"
      }
    },
    "id": "73a2309e-d0b3-6bf5-9500-9af8bcc805ec",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "imageUrl": "https://codedev.ms/fabrikam/_api/_common/identityImage?id=73a2309e-d0b3-6bf5-9500-9af8bcc805ec",
    "descriptor": "aad.NzNhMjMwOWUtZDBiMy03YmY1LTk1MDAtOWFmOGJjYzgwNWVj"
  },
  "activities": [
    {
      "capacityPerDay": 5,
      "name": "Design"
    },
    {
      "capacityPerDay": 5,
      "name": "Development"
    }
  ],
  "daysOff": [],
  "url": "https://codedev.ms/fabrikam/d9bb59ee-cd01-4569-80d1-dce8c2e712f4/1d8e5f76-54bd-4d11-889b-fee63c864ea6/_apis/work/teamsettings/iterations/def498ab-a9cf-41eb-a7c7-9eb67d1852ef/capacities/73a2309e-d0b3-6bf5-9500-9af8bcc805ec",
  "_links": {
    "self": {
      "href": "https://codedev.ms/fabrikam/d9bb59ee-cd01-4569-80d1-dce8c2e712f4/1d8e5f76-54bd-4d11-889b-fee63c864ea6/_apis/work/teamsettings/iterations/def498ab-a9cf-41eb-a7c7-9eb67d1852ef/capacities/73a2309e-d0b3-6bf5-9500-9af8bcc805ec"
    },
    "project": {
      "href": "https://codedev.ms/fabrikam/_apis/projects/d9bb59ee-cd01-4569-80d1-dce8c2e712f4"
    },
    "team": {
      "href": "https://codedev.ms/fabrikam/_apis/projects/d9bb59ee-cd01-4569-80d1-dce8c2e712f4/teams/1d8e5f76-54bd-4d11-889b-fee63c864ea6"
    },
    "teamSettings": {
      "href": "https://codedev.ms/fabrikam/d9bb59ee-cd01-4569-80d1-dce8c2e712f4/1d8e5f76-54bd-4d11-889b-fee63c864ea6/_apis/work/teamsettings"
    },
    "teamIterations": {
      "href": "https://codedev.ms/fabrikam/d9bb59ee-cd01-4569-80d1-dce8c2e712f4/1d8e5f76-54bd-4d11-889b-fee63c864ea6/_apis/work/teamsettings/iterations"
    },
    "teamIteration": {
      "href": "https://codedev.ms/fabrikam/d9bb59ee-cd01-4569-80d1-dce8c2e712f4/1d8e5f76-54bd-4d11-889b-fee63c864ea6/_apis/work/teamsettings/iterations/def498ab-a9cf-41eb-a7c7-9eb67d1852ef"
    },
    "capacity": {
      "href": "https://codedev.ms/fabrikam/d9bb59ee-cd01-4569-80d1-dce8c2e712f4/1d8e5f76-54bd-4d11-889b-fee63c864ea6/_apis/work/teamsettings/iterations/def498ab-a9cf-41eb-a7c7-9eb67d1852ef/capacities"
    },
    "classificationNode": {
      "href": "https://codedev.ms/fabrikam/d9bb59ee-cd01-4569-80d1-dce8c2e712f4/_apis/wit/classificationNodes/Iterations/Iteration%201"
    }
  }
}

Definitions

Name	Description
Activity
CapacityPatch	Expected data from PATCH
DateRange
IdentityRef
ReferenceLinks	The class to represent a collection of REST reference links.
TeamMemberCapacityIdentityRef	Represents capacity for a specific team member

Activity

Name	Type	Description
capacityPerDay	number
name	string

CapacityPatch

Expected data from PATCH

Name	Type	Description
activities	Activity[]
daysOff	DateRange[]

DateRange

Name	Type	Description
end	string	End of the date range.
start	string	Start of the date range.

IdentityRef

Name	Type	Description
_links	ReferenceLinks	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.

TeamMemberCapacityIdentityRef

Represents capacity for a specific team member

Name	Type	Description
_links	ReferenceLinks	Collection of links relevant to resource
activities	Activity[]	Collection of capacities associated with the team member
daysOff	DateRange[]	The days off associated with the team member
teamMember	IdentityRef	Identity ref of the associated team member
url	string	Full http link to the resource

Share via

Capacities - Update

URI Parameters

Request Body

Responses

Security

oauth2

Scopes

Examples

Update a team member's capacity

Sample request

Sample response

Definitions

Activity

CapacityPatch

DateRange

IdentityRef

ReferenceLinks

TeamMemberCapacityIdentityRef

Additional resources