BuildHttpClient2_2

Important

Disclaimer: This API is in private preview and subject to change. This API is in private preview and subject to change.

Module path: TFS/Build/RestClient

Initialization sample

  import RestClient = require("TFS/Build/RestClient");

  // Get an instance of the client
  var client = RestClient.getClient();
    
  // Call a method on the client
  // e.g. client.getResource(...).then(...);

Methods

• addBuildTag()
• addBuildTags()
• createArtifact()
• createDefinition()
• createQueue()
• deleteBuild()
• deleteBuildTag()
• deleteDefinition()
• deleteQueue()
• deleteTemplate()
• getAgentPoolQueue()
• getArtifact()
• getArtifactContentZip()
• getArtifacts()
• getBadge()
• getBuild()
• getBuildBadge()
• getBuildBadgeData()
• getBuildChanges()
• getBuildController()
• getBuildControllers()
• getBuildDeployments()
• getBuildLog()
• getBuildLogs()
• getBuildLogsZip()
• getBuildOptionDefinitions()
• getBuilds()
• getBuildSettings()
• getBuildTags()
• getBuildTimeline()
• getBuildWorkItemsRefs()
• getBuildWorkItemsRefsFromCommits()
• getChangesBetweenBuilds()
• getDefinition()
• getDefinitionRevisions()
• getDefinitions()
• getQueues()
• getResourceUsage()
• getTags()
• getTemplate()
• getTemplates()
• getWorkItemsBetweenBuilds()
• queueBuild()
• saveTemplate()
• updateBuild()
• updateBuildSettings()
• updateDefinition()

addBuildTag()

Adds a tag to a build

Syntax

 IPromise<string[]> addBuildTag(project, buildId, tag)

Parameters

• project: string. Project ID or project name
• buildId: number.
• tag: string.

Returns

• IPromise<string[]>

addBuildTags()

Adds tag to a build

Syntax

 IPromise<string[]> addBuildTags(tags, project, buildId)

Parameters

• tags: string[].
• project: string.
• buildId: number.

Returns

• IPromise<string[]>

createArtifact()

Associates an artifact with a build

Syntax

 IPromise<Contracts.BuildArtifact> createArtifact(artifact, buildId, project)

Parameters

• artifact: Contracts.BuildArtifact.
• buildId: number.
• project: string. Optional.

Returns

• IPromise<Contracts.BuildArtifact>

createDefinition()

Creates a new definition

Syntax

 IPromise<Contracts.BuildDefinition> createDefinition(definition, project, definitionToCloneId, definitionToCloneRevision)

Parameters

• definition: Contracts.BuildDefinition.
• project: string. Optional.
• definitionToCloneId: number. Optional.
• definitionToCloneRevision: number. Optional.

Returns

• IPromise<Contracts.BuildDefinition>

createQueue()

Creates a build queue

Syntax

 IPromise<Contracts.AgentPoolQueue> createQueue(queue)

Parameters

• queue: Contracts.AgentPoolQueue.

Returns

• IPromise<Contracts.AgentPoolQueue>

deleteBuild()

Deletes a build

Syntax

 IPromise<void> deleteBuild(buildId, project)

Parameters

• buildId: number.
• project: string. Optional.

Returns

• IPromise<void>

deleteBuildTag()

Deletes a tag from a build

Syntax

 IPromise<string[]> deleteBuildTag(project, buildId, tag)

Parameters

• project: string. Project ID or project name
• buildId: number.
• tag: string.

Returns

• IPromise<string[]>

deleteDefinition()

Deletes a definition and all associated builds

Syntax

 IPromise<void> deleteDefinition(definitionId, project)

Parameters

• definitionId: number.
• project: string. Optional.

Returns

• IPromise<void>

deleteQueue()

Deletes a build queue

Syntax

 IPromise<void> deleteQueue(id)

Parameters

• id: number.

Returns

• IPromise<void>

deleteTemplate()

Deletes a definition template

Syntax

 IPromise<void> deleteTemplate(project, templateId)

Parameters

• project: string. Project ID or project name
• templateId: string.

Returns

• IPromise<void>

getAgentPoolQueue()

Gets a queue

Syntax

 IPromise<Contracts.AgentPoolQueue> getAgentPoolQueue(controllerId)

Parameters

• controllerId: number.

Returns

• IPromise<Contracts.AgentPoolQueue>

getArtifact()

Gets a specific artifact for a build

Syntax

 IPromise<Contracts.BuildArtifact> getArtifact(buildId, artifactName, project)

Parameters

• buildId: number.
• artifactName: string.
• project: string. Optional.

Returns

• IPromise<Contracts.BuildArtifact>

getArtifactContentZip()

Gets a specific artifact for a build

Syntax

 IPromise<ArrayBuffer> getArtifactContentZip(buildId, artifactName, project)

Parameters

• buildId: number.
• artifactName: string.
• project: string. Optional.

Returns

• IPromise<ArrayBuffer>

getArtifacts()

Gets all artifacts for a build

Syntax

 IPromise<Contracts.BuildArtifact[]> getArtifacts(buildId, project)

Parameters

• buildId: number.
• project: string. Optional.

Returns

• IPromise<Contracts.BuildArtifact[]>

getBadge()

Syntax

 IPromise<string> getBadge(project, definitionId, branchName)

Parameters

• project: string.
• definitionId: number.
• branchName: string. Optional.

Returns

• IPromise<string>

getBuild()

Gets a build

Syntax

 IPromise<Contracts.Build> getBuild(buildId, project, propertyFilters)

Parameters

• buildId: number.
• project: string. Optional.
• propertyFilters: string. Optional.

Returns

• IPromise<Contracts.Build>

getBuildBadge()

Syntax

 IPromise<Contracts.BuildBadge> getBuildBadge(project, repoType, repoId, branchName)

Parameters

• project: string. Project ID or project name
• repoType: string.
• repoId: string. Optional.
• branchName: string. Optional.

Returns

• IPromise<Contracts.BuildBadge>

getBuildBadgeData()

Syntax

 IPromise<string> getBuildBadgeData(project, repoType, repoId, branchName)

Parameters

• project: string. Project ID or project name
• repoType: string.
• repoId: string. Optional.
• branchName: string. Optional.

Returns

• IPromise<string>

getBuildChanges()

Gets the changes associated with a build

Syntax

 IPromise<Contracts.Change[]> getBuildChanges(project, buildId, continuationToken, top)

Parameters

• project: string. Project ID or project name
• buildId: number.
• continuationToken: string. Optional.
• top: number. Optional.

Returns

• IPromise<Contracts.Change[]>

getBuildController()

Gets a controller

Syntax

 IPromise<Contracts.BuildController> getBuildController(controllerId)

Parameters

• controllerId: number.

Returns

• IPromise<Contracts.BuildController>

getBuildControllers()

Gets controller, optionally filtered by name

Syntax

 IPromise<Contracts.BuildController[]> getBuildControllers(name)

Parameters

• name: string. Optional.

Returns

• IPromise<Contracts.BuildController[]>

getBuildDeployments()

Gets the deployment information associated with a build

Syntax

 IPromise<Contracts.Deployment[]> getBuildDeployments(project, buildId)

Parameters

• project: string. Project ID or project name
• buildId: number.

Returns

• IPromise<Contracts.Deployment[]>

getBuildLog()

Gets a log

Syntax

 IPromise<ArrayBuffer> getBuildLog(project, buildId, logId, startLine, endLine)

Parameters

• project: string. Project ID or project name
• buildId: number.
• logId: number.
• startLine: number. Optional.
• endLine: number. Optional.

Returns

• IPromise<ArrayBuffer>

getBuildLogs()

Gets logs for a build

Syntax

 IPromise<Contracts.BuildLog[]> getBuildLogs(project, buildId)

Parameters

• project: string. Project ID or project name
• buildId: number.

Returns

• IPromise<Contracts.BuildLog[]>

getBuildLogsZip()

Gets logs for a build

Syntax

 IPromise<ArrayBuffer> getBuildLogsZip(project, buildId)

Parameters

• project: string. Project ID or project name
• buildId: number.

Returns

• IPromise<ArrayBuffer>

getBuildOptionDefinitions()

Syntax

 IPromise<Contracts.BuildOptionDefinition[]> getBuildOptionDefinitions(project)

Parameters

• project: string. Optional. Project ID or project name

Returns

• IPromise<Contracts.BuildOptionDefinition[]>

getBuilds()

Gets builds

Syntax

 IPromise<Contracts.Build[]> getBuilds(project, definitions, queues, buildNumber, minFinishTime, maxFinishTime, requestedFor, reasonFilter, statusFilter, resultFilter, tagFilters, properties, type, top, continuationToken, maxBuildsPerDefinition, deletedFilter, queryOrder, branchName)

Parameters

• project: string. Optional. Project ID or project name
• definitions: number[]. Optional. A comma-delimited list of definition IDs
• queues: number[]. Optional. A comma-delimited list of queue IDs
• buildNumber: string. Optional.
• minFinishTime: Date. Optional.
• maxFinishTime: Date. Optional.
• requestedFor: string. Optional.
• reasonFilter: Contracts.BuildReason. Optional.
• statusFilter: Contracts.BuildStatus. Optional.
• resultFilter: Contracts.BuildResult. Optional.
• tagFilters: string[]. Optional.
• properties: string[]. Optional.
• type: Contracts.DefinitionType. Optional.
• top: number. Optional.
• continuationToken: string. Optional.
• maxBuildsPerDefinition: number. Optional.
• deletedFilter: Contracts.QueryDeletedOption. Optional.
• queryOrder: Contracts.BuildQueryOrder. Optional.
• branchName: string. Optional.

Returns

• IPromise<Contracts.Build[]>

getBuildSettings()

Syntax

 IPromise<Contracts.BuildSettings> getBuildSettings()

Parameters

Returns

• IPromise<Contracts.BuildSettings>

getBuildTags()

Gets the tags for a build

Syntax

 IPromise<string[]> getBuildTags(project, buildId)

Parameters

• project: string. Project ID or project name
• buildId: number.

Returns

• IPromise<string[]>

getBuildTimeline()

Gets details for a build

Syntax

 IPromise<Contracts.Timeline> getBuildTimeline(project, buildId, timelineId, changeId)

Parameters

• project: string. Project ID or project name
• buildId: number.
• timelineId: string. Optional.
• changeId: number. Optional.

Returns

• IPromise<Contracts.Timeline>

getBuildWorkItemsRefs()

Gets the work item IDs associated with a build

Syntax

 IPromise<VSS_Common_Contracts.ResourceRef[]> getBuildWorkItemsRefs(project, buildId, top)

Parameters

• project: string. Project ID or project name
• buildId: number.
• top: number. Optional.

Returns

• IPromise<VSS_Common_Contracts.ResourceRef[]>

getBuildWorkItemsRefsFromCommits()

Gets the work item IDs associated with build commits

Syntax

 IPromise<VSS_Common_Contracts.ResourceRef[]> getBuildWorkItemsRefsFromCommits(commitIds, project, buildId, top)

Parameters

• commitIds: string[].
• project: string.
• buildId: number.
• top: number. Optional.

Returns

• IPromise<VSS_Common_Contracts.ResourceRef[]>

getChangesBetweenBuilds()

Gets the changes associated between given builds

Syntax

 IPromise<Contracts.Change[]> getChangesBetweenBuilds(project, fromBuildId, toBuildId, top)

Parameters

• project: string. Project ID or project name
• fromBuildId: number. Optional.
• toBuildId: number. Optional.
• top: number. Optional.

Returns

• IPromise<Contracts.Change[]>

getDefinition()

Gets a definition, optionally at a specific revision

Syntax

 IPromise<Contracts.DefinitionReference> getDefinition(definitionId, project, revision, propertyFilters)

Parameters

• definitionId: number.
• project: string. Optional.
• revision: number. Optional.
• propertyFilters: string[]. Optional.

Returns

• IPromise<Contracts.DefinitionReference>

getDefinitionRevisions()

Gets revisions of a definition

Syntax

 IPromise<Contracts.BuildDefinitionRevision[]> getDefinitionRevisions(project, definitionId)

Parameters

• project: string. Project ID or project name
• definitionId: number.

Returns

• IPromise<Contracts.BuildDefinitionRevision[]>

getDefinitions()

Gets definitions, optionally filtered by name

Syntax

 IPromise<Contracts.DefinitionReference[]> getDefinitions(project, name, type, repositoryId, repositoryType, queryOrder, top)

Parameters

• project: string. Optional. Project ID or project name
• name: string. Optional.
• type: Contracts.DefinitionType. Optional.
• repositoryId: string. Optional.
• repositoryType: string. Optional.
• queryOrder: Contracts.DefinitionQueryOrder. Optional.
• top: number. Optional.

Returns

• IPromise<Contracts.DefinitionReference[]>

getQueues()

Gets queues, optionally filtered by name

Syntax

 IPromise<Contracts.AgentPoolQueue[]> getQueues(name)

Parameters

• name: string. Optional.

Returns

• IPromise<Contracts.AgentPoolQueue[]>

getResourceUsage()

Syntax

 IPromise<Contracts.BuildResourceUsage> getResourceUsage()

Parameters

Returns

• IPromise<Contracts.BuildResourceUsage>

getTags()

Syntax

 IPromise<string[]> getTags(project)

Parameters

• project: string. Project ID or project name

Returns

• IPromise<string[]>

getTemplate()

Gets definition template filtered by id

Syntax

 IPromise<Contracts.BuildDefinitionTemplate> getTemplate(project, templateId)

Parameters

• project: string. Project ID or project name
• templateId: string.

Returns

• IPromise<Contracts.BuildDefinitionTemplate>

getTemplates()

Syntax

 IPromise<Contracts.BuildDefinitionTemplate[]> getTemplates(project)

Parameters

• project: string. Project ID or project name

Returns

• IPromise<Contracts.BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds()

Gets all the work item IDs in-between fromBuildId to toBuildId

Syntax

 IPromise<VSS_Common_Contracts.ResourceRef[]> getWorkItemsBetweenBuilds(project, fromBuildId, toBuildId, top)

Parameters

• project: string. Project ID or project name
• fromBuildId: number.
• toBuildId: number.
• top: number. Optional.

Returns

• IPromise<VSS_Common_Contracts.ResourceRef[]>

queueBuild()

Queues a build

Syntax

 IPromise<Contracts.Build> queueBuild(build, project, ignoreWarnings)

Parameters

• build: Contracts.Build.
• project: string. Optional.
• ignoreWarnings: boolean. Optional.

Returns

• IPromise<Contracts.Build>

saveTemplate()

Saves a definition template

Syntax

 IPromise<Contracts.BuildDefinitionTemplate> saveTemplate(template, project, templateId)

Parameters

• template: Contracts.BuildDefinitionTemplate.
• project: string.
• templateId: string.

Returns

• IPromise<Contracts.BuildDefinitionTemplate>

updateBuild()

Updates a build

Syntax

 IPromise<Contracts.Build> updateBuild(build, buildId, project)

Parameters

• build: Contracts.Build.
• buildId: number.
• project: string. Optional.

Returns

• IPromise<Contracts.Build>

updateBuildSettings()

Updates the build settings

Syntax

 IPromise<Contracts.BuildSettings> updateBuildSettings(settings)

Parameters

• settings: Contracts.BuildSettings.

Returns

• IPromise<Contracts.BuildSettings>

updateDefinition()

Updates an existing definition

Syntax

 IPromise<Contracts.BuildDefinition> updateDefinition(definition, definitionId, project, secretsSourceDefinitionId, secretsSourceDefinitionRevision)

Parameters

• definition: Contracts.BuildDefinition.
• definitionId: number.
• project: string. Optional.
• secretsSourceDefinitionId: number. Optional.
• secretsSourceDefinitionRevision: number. Optional.

Returns

• IPromise<Contracts.BuildDefinition>