Class CoreApi

constructor

• new CoreApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): CoreApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns CoreApi

Static ReadonlyRESOURCE_AREA_ID

createConnectedService

• createConnectedService(
      connectedServiceCreationData: WebApiConnectedServiceDetails,
      projectId: string,
  ): Promise<WebApiConnectedService>

  Parameters

  • connectedServiceCreationData: WebApiConnectedServiceDetails
  • projectId: string

  Returns Promise<WebApiConnectedService>

createIdentityMru

• createIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

  Parameters

  • mruData: IdentityData
  • mruName: string

  Returns Promise<void>

createOrUpdateProxy

• createOrUpdateProxy(proxy: Proxy): Promise<Proxy>

  Parameters

  • proxy: Proxy

  Returns Promise<Proxy>

createTeam

• createTeam(team: WebApiTeam, projectId: string): Promise<WebApiTeam>

  Create a team in a team project.

  Parameters

  • team: WebApiTeam

    The team data used to create the team.
  • projectId: string

    The name or ID (GUID) of the team project in which to create the team.

  Returns Promise<WebApiTeam>

deleteIdentityMru

• deleteIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

  Parameters

  • mruData: IdentityData
  • mruName: string

  Returns Promise<void>

deleteProxy

• deleteProxy(proxyUrl: string, site?: string): Promise<void>

  Parameters

  • proxyUrl: string
  • Optionalsite: string

  Returns Promise<void>

deleteTeam

• deleteTeam(projectId: string, teamId: string): Promise<void>

  Delete a team.

  Parameters

  • projectId: string

    The name or ID (GUID) of the team project containing the team to delete.
  • teamId: string

    The name or ID of the team to delete.

  Returns Promise<void>

getAllTeams

• getAllTeams(
      mine?: boolean,
      top?: number,
      skip?: number,
      expandIdentity?: boolean,
  ): Promise<WebApiTeam[]>

  Get a list of all teams.

  Parameters

  • Optionalmine: boolean

    If true, then return all teams requesting user is member. Otherwise return all teams user has read access.
  • Optionaltop: number

    Maximum number of teams to return.
  • Optionalskip: number

    Number of teams to skip.
  • OptionalexpandIdentity: boolean

    A value indicating whether or not to expand Identity information in the result WebApiTeam object.

  Returns Promise<WebApiTeam[]>

getConnectedServiceDetails

• getConnectedServiceDetails(
      projectId: string,
      name: string,
  ): Promise<WebApiConnectedServiceDetails>

  Parameters

  • projectId: string
  • name: string

  Returns Promise<WebApiConnectedServiceDetails>

getConnectedServices

• getConnectedServices(
      projectId: string,
      kind?: ConnectedServiceKind,
  ): Promise<WebApiConnectedService[]>

  Parameters

  • projectId: string
  • Optionalkind: ConnectedServiceKind

  Returns Promise<WebApiConnectedService[]>

getIdentityMru

• getIdentityMru(mruName: string): Promise<IdentityRef[]>

  Parameters

  • mruName: string

  Returns Promise<IdentityRef[]>

getProcessById

• getProcessById(processId: string): Promise<Process>

  Get a process by ID.

  Parameters

  • processId: string

    ID for a process.

  Returns Promise<Process>

getProcesses

• getProcesses(): Promise<Process[]>

  Get a list of processes.

  Returns Promise<Process[]>

getProject

• getProject(
      projectId: string,
      includeCapabilities?: boolean,
      includeHistory?: boolean,
  ): Promise<TeamProject>

  Get project with the specified id or name, optionally including capabilities.

  Parameters

  • projectId: string
  • OptionalincludeCapabilities: boolean

    Include capabilities (such as source control) in the team project result (default: false).
  • OptionalincludeHistory: boolean

    Search within renamed projects (that had such name in the past).

  Returns Promise<TeamProject>

getProjectCollection

• getProjectCollection(collectionId: string): Promise<TeamProjectCollection>

  Get project collection with the specified id or name.

  Parameters

  • collectionId: string

  Returns Promise<TeamProjectCollection>

getProjectCollections

• getProjectCollections(
      top?: number,
      skip?: number,
  ): Promise<TeamProjectCollectionReference[]>

  Get project collection references for this application.

  Parameters

  • Optionaltop: number
  • Optionalskip: number

  Returns Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries

• getProjectHistoryEntries(minRevision?: number): Promise<ProjectInfo[]>

  Gets the history of changes to the project.

  Parameters

  • OptionalminRevision: number

    The minimum revision number to return in the history.

  Returns Promise<ProjectInfo[]>

getProjectProperties

• getProjectProperties(
      projectId: string,
      keys?: string[],
  ): Promise<ProjectProperty[]>

  Get a collection of team project properties.

  Parameters

  • projectId: string

    The team project ID.
  • Optionalkeys: string[]

    A comma-delimited string of team project property names. Wildcard characters ("?" and "*") are supported. If no key is specified, all properties will be returned.

  Returns Promise<ProjectProperty[]>

getProjects

• getProjects(
      stateFilter?: any,
      top?: number,
      skip?: number,
      continuationToken?: number,
      getDefaultTeamImageUrl?: boolean,
  ): Promise<PagedList<TeamProjectReference>>

  Get all projects in the organization that the authenticated user has access to.

  Parameters

  • OptionalstateFilter: any

    Filter on team projects in a specific team project state (default: WellFormed).
  • Optionaltop: number
  • Optionalskip: number
  • OptionalcontinuationToken: number

    Pointer that shows how many projects already been fetched.
  • OptionalgetDefaultTeamImageUrl: boolean

  Returns Promise<PagedList<TeamProjectReference>>

getProjectsProperties

• getProjectsProperties(
      projectIds: string[],
      properties?: string[],
  ): Promise<ProjectProperties[]>

  Get a collection of team project properties for multiple projects.

  Parameters

  • projectIds: string[]

    A comma-delimited string of team project IDs
  • Optionalproperties: string[]

  Returns Promise<ProjectProperties[]>

getProjectTeamsByCategory

• getProjectTeamsByCategory(
      projectId: string,
      expandIdentity?: boolean,
      top?: number,
      skip?: number,
  ): Promise<CategorizedWebApiTeams>

  Gets list of user readable teams in a project and teams user is member of (excluded from readable list).

  Parameters

  • projectId: string

    The name or ID (GUID) of the team project containing the teams to retrieve.
  • OptionalexpandIdentity: boolean

    A value indicating whether or not to expand Identity information in the result WebApiTeam object.
  • Optionaltop: number

    Maximum number of teams to return.
  • Optionalskip: number

    Number of teams to skip.

  Returns Promise<CategorizedWebApiTeams>

getProxies

• getProxies(proxyUrl?: string): Promise<Proxy[]>

  Parameters

  • OptionalproxyUrl: string

  Returns Promise<Proxy[]>

getTeam

• getTeam(
      projectId: string,
      teamId: string,
      expandIdentity?: boolean,
  ): Promise<WebApiTeam>

  Get a specific team.

  Parameters

  • projectId: string

    The name or ID (GUID) of the team project containing the team.
  • teamId: string

    The name or ID (GUID) of the team.
  • OptionalexpandIdentity: boolean

    A value indicating whether or not to expand Identity information in the result WebApiTeam object.

  Returns Promise<WebApiTeam>

getTeamMembersWithExtendedProperties

• getTeamMembersWithExtendedProperties(
      projectId: string,
      teamId: string,
      top?: number,
      skip?: number,
  ): Promise<TeamMember[]>

  Get a list of members for a specific team.

  Parameters

  • projectId: string

    The name or ID (GUID) of the team project the team belongs to.
  • teamId: string

    The name or ID (GUID) of the team .
  • Optionaltop: number
  • Optionalskip: number

  Returns Promise<TeamMember[]>

getTeams

• getTeams(
      projectId: string,
      mine?: boolean,
      top?: number,
      skip?: number,
      expandIdentity?: boolean,
  ): Promise<WebApiTeam[]>

  Get a list of teams.

  Parameters

  • projectId: string
  • Optionalmine: boolean

    If true return all the teams requesting user is member, otherwise return all the teams user has read access.
  • Optionaltop: number

    Maximum number of teams to return.
  • Optionalskip: number

    Number of teams to skip.
  • OptionalexpandIdentity: boolean

    A value indicating whether or not to expand Identity information in the result WebApiTeam object.

  Returns Promise<WebApiTeam[]>

queueCreateProject

• queueCreateProject(projectToCreate: TeamProject): Promise<OperationReference>

  Queues a project to be created. Use the GetOperation to periodically check for create project status.

  Parameters

  • projectToCreate: TeamProject

    The project to create.

  Returns Promise<OperationReference>

queueDeleteProject

• queueDeleteProject(projectId: string): Promise<OperationReference>

  Queues a project to be deleted. Use the GetOperation to periodically check for delete project status.

  Parameters

  • projectId: string

    The project id of the project to delete.

  Returns Promise<OperationReference>

removeProjectAvatar

• removeProjectAvatar(projectId: string): Promise<void>

  Removes the avatar for the project.

  Parameters

  • projectId: string

    The ID or name of the project.

  Returns Promise<void>

setProjectAvatar

• setProjectAvatar(avatarBlob: ProjectAvatar, projectId: string): Promise<void>

  Sets the avatar for the project.

  Parameters

  • avatarBlob: ProjectAvatar

    The avatar blob data object to upload.
  • projectId: string

    The ID or name of the project.

  Returns Promise<void>

setProjectProperties

• setProjectProperties(
      customHeaders: any,
      projectId: string,
      patchDocument: JsonPatchDocument,
  ): Promise<void>

  Create, update, and delete team project properties.

  Parameters

  • customHeaders: any
  • projectId: string

    The team project ID.
  • patchDocument: JsonPatchDocument

    A JSON Patch document that represents an array of property operations. See RFC 6902 for more details on JSON Patch. The accepted operation verbs are Add and Remove, where Add is used for both creating and updating properties. The path consists of a forward slash and a property name.

  Returns Promise<void>

updateIdentityMru

• updateIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

  Parameters

  • mruData: IdentityData
  • mruName: string

  Returns Promise<void>

updateProject

• updateProject(
      projectUpdate: TeamProject,
      projectId: string,
  ): Promise<OperationReference>

  Update an existing project's name, abbreviation, description, or restore a project.

  Parameters

  • projectUpdate: TeamProject

    The updates for the project. The state must be set to wellFormed to restore the project.
  • projectId: string

    The project id of the project to update.

  Returns Promise<OperationReference>

updateTeam

• updateTeam(
      teamData: WebApiTeam,
      projectId: string,
      teamId: string,
  ): Promise<WebApiTeam>

  Update a team's name and/or description.

  Parameters

  • teamData: WebApiTeam
  • projectId: string

    The name or ID (GUID) of the team project containing the team to update.
  • teamId: string

    The name of ID of the team to update.

  Returns Promise<WebApiTeam>