Capacities - Get

Get a team member's capacity

GET https://{accountName}.visualstudio.com/{project}/{team}/_apis/work/teamsettings/iterations/{iterationId}/capacities/{teamMemberId}?api-version=4.1

URI Parameters

Name In Required Type Description
accountName
path True
  • string

The name of the Visual Studio Team Services account.

project
path True
  • string

Project ID or project name

team
path
  • string

Team ID or team name

iterationId
path True
  • string
uuid

ID of the iteration

teamMemberId
path True
  • string
uuid

ID of the team member

api-version
query True
  • string

Version of the API to use. This should be set to '4.1' to use this version of the api.

Responses

Name Type Description
200 OK

successful operation

Examples

Get a team member's capacity

Sample Request

GET https://fabrikam.visualstudio.com/Fabrikam-Fiber/_apis/work/teamsettings/iterations/2ec76bfe-ba74-4060-970d-4567a3e997ee/capacities/{teamMemberId}?api-version=4.1

Sample Response

{
  "teamMember": {
    "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "url": "https://fabrikam.vssps.visualstudio.com/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "imageUrl": "https://fabrikam.visualstudio.com/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
  },
  "activities": [
    {
      "capacityPerDay": 0,
      "name": null
    }
  ],
  "daysOff": [],
  "url": "https://fabrikam.visualstudio.com/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/iterations/2ec76bfe-ba74-4060-970d-4567a3e997ee/capacities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
  "_links": {
    "self": {
      "href": "https://fabrikam.visualstudio.com/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/iterations/2ec76bfe-ba74-4060-970d-4567a3e997ee/capacities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
    },
    "project": {
      "href": "https://fabrikam.visualstudio.com/_apis/projects/6d823a47-2d51-4f31-acff-74927f88ee1e"
    },
    "team": {
      "href": "https://fabrikam.visualstudio.com/_apis/projects/6d823a47-2d51-4f31-acff-74927f88ee1e/teams/748b18b6-4b3c-425a-bcae-ff9b3e703012"
    },
    "teamSettings": {
      "href": "https://fabrikam.visualstudio.com/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings"
    },
    "teamIterations": {
      "href": "https://fabrikam.visualstudio.com/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/iterations"
    },
    "teamIteration": {
      "href": "https://fabrikam.visualstudio.com/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/iterations/2ec76bfe-ba74-4060-970d-4567a3e997ee"
    },
    "capacity": {
      "href": "https://fabrikam.visualstudio.com/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/iterations/2ec76bfe-ba74-4060-970d-4567a3e997ee/capacities"
    }
  }
}

Definitions

Activity
DateRange
Member
ReferenceLinks

The class to represent a collection of REST reference links.

TeamMemberCapacity

Represents capacity for a specific team member

Activity

Name Type Description
capacityPerDay
  • string
name
  • string

DateRange

Name Type Description
end
  • string

End of the date range.

start
  • string

Start of the date range.

Member

Name Type Description
displayName
  • string
id
  • string
imageUrl
  • string
uniqueName
  • string
url
  • string

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.

TeamMemberCapacity

Represents capacity for a specific team member

Name Type Description
_links

Collection of links relevant to resource

activities

Collection of capacities associated with the team member

daysOff

The days off associated with the team member

teamMember

Shallow Ref to the associated team member

url
  • string

Full http link to the resource