Connectors Reference

Visual Studio Team Services

Visual Studio Team Services provides services for teams to share code, track work, and ship software - for any language, all in a single package. It's the perfect complement to your IDE.

 

Status: Preview

Tier: Standard

Version: 1.3

 

Actions:

Name

Summary

ListAccounts ()

List accounts

ListIterations (string account, string project, string team)

List iterations

ListBuildDefinitions (string account, string project)

List build definitions

QueueNewBuild (string account, string project, string buildDefId, [Optional]QueueBuildRequest buildDetails)

Queue a new build

ListGitRepositories (string account, string project)

List Git repositories

ListGitRefs (string account, string project, string repository)

List Git refs

ListProjects (string account)

List projects

ListTeams (string account, string project)

List the teams in a project

ListTeamMembers (string account, string project, string team)

List the users in a team

ListReleaseDefinitions (string account, string project)

List release definitions

CreateRelease (string account, string project, string releaseDefId, ReleaseStartMetadata releaseStartMetadata)

Create a new release

GetSubscriptionSchema (string account, string project, string subscriptionKind)

Get a dynamic schema to create a webhook subscription

DeleteSubscription (string id, string account, string options)

Delete a subscription

ListWorkItemTypes (string account, string project)

List work item types

GetWorkItemDetails (string account, string project, string typeName, string id)

Get work item details

UpdateWorkItem (string account, string id, [Optional]string project, [Optional]string type, UpdateWorkItemRequest workItem)

Update a work item

CreateWorkItem (string account, string project, string type, CreateWorkItemRequest workItem)

Create a work item

GetQueryResults (string account, string project, string queryId)

Get query results

GetQueryResultsV2 (string account, string project, string queryId)

Get query results

ListRootQueryFolders (string account, string project)

List root level queries

ListQueriesInFolder (string account, string project, string folderPath)

List queries within folder

GetWorkItemSchema (string account, string project, string typeName)

Get work item schema

GetWorkItemSchemaForCreate (string account, string project, string typeName, [Optional]boolean onlyRequiredFields)

Get work item schema for create work item operation

GetWorkItemSchemaForUpdate (string account, string project, string typeName, [Optional]boolean onlyRequiredFields)

Get work item schema for update work item operation

GetResponseWorkItemSchema ([Optional]string account, [Optional]string project, [Optional]string typeName)

Get work item schema for the response of other operations

GetQueryResultWorkItemSchema ([Optional]string account, [Optional]string project, [Optional]string queryId)

Get work item schema for the response of Get query result operation

RunWiqlQuery (string account, string project, WiqlQuery query)

Run WIQL query

WebhookBuildsCallback (string state)

Callback action for webhooks working with builds operations

WebhookWorkItemsCallback (string state)

Callback action for webhooks working with work items operations

 

Triggers:

Name

Summary

OnBuildCompleted (string account, string project, [Optional]string resultFilter, [advanced][Optional]string definitions)

When a build completes

CreateOnBuildCompletedSubscription (ClientSubscription subscription, string account, string project, [internal][Optional]string subscriptionKind)

When a build completes (webhook)

OnGitPush (string account, string project, string repository, [advanced][Optional]string refName)

When code is pushed (Git)

OnTfvcCheckIn (string account, string project, [Optional]string team, [Optional]string author)

When code is checked in (TFVC)

OnWorkItemAssigned (string account, string project, [Optional]string team, string wiql__System_AssignedTo, [advanced][Optional]string wiql__System_WorkItemType, [advanced][Optional]string wiql__System_AreaPath, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_TeamProject, [advanced][Optional]string wiql__Microsoft_VSTS_Common_CreatedBy)

When a work item is assigned

OnWorkItemUpdated (string account, string project, [Optional]string team, [Optional]string wiql__System_AssignedTo, [Optional]string wiql__System_WorkItemType, [advanced][Optional]string wiql__System_AreaPath, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_TeamProject, [advanced][Optional]string wiql__Microsoft_VSTS_Common_CreatedBy)

When a work item is updated

OnWorkItemCreated (string account, string project, [Optional]string team, [Optional]string wiql__System_AssignedTo, [Optional]string wiql__System_WorkItemType, [advanced][Optional]string wiql__System_AreaPath, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_TeamProject, [advanced][Optional]string wiql__Microsoft_VSTS_Common_CreatedBy)

When a work item is created

OnWorkItemClosed (string account, string project, [Optional]string team, [Optional]string wiql__System_AssignedTo, [Optional]string wiql__System_WorkItemType, [advanced][Optional]string wiql__System_AreaPath, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_TeamProject, [advanced][Optional]string wiql__Microsoft_VSTS_Common_CreatedBy)

When a work item is closed

CreateOnWorkItemUpdatedSubscription (ClientSubscription subscription, string account, string project, [internal][Optional]string subscriptionKind)

When a work item is updated (webhook)

 

Objects:

Name

Summary

Account

 

BuildDefinition

 

BuildRequestUser

 

BuildResult

 

BuildResultDefinition

 

ChangesetAuthor

 

ChangesetCheckedInBy

 

ClientSubscription

 

CreateWorkItemRequest

 

DynamicWorkItemResponse

 

GitPush

 

GitPushUser

 

GitRef

 

GitRepository

 

IdentityRef

 

Links

 

Object

 

PatchWorkItemResponse

 

Project

 

QueryHierarchyItem

 

QueryResultWorkItemResponse

 

QueueBuildRequest

 

Release

 

ReleaseDefinition

 

ReleaseDefinitionShallowReference

 

ReleaseStartMetadata

 

SubscriptionResponse

 

Team

 

TeamIterationAttributes

 

TeamMember

 

TeamSettingsIteration

 

TfvcChangeset

 

TriggerWorkItemResponse

 

UpdateWorkItemRequest

 

VstsList[Account]

 

VstsList[BuildDefinition]

 

VstsList[BuildResult]

 

VstsList[GitPush]

 

VstsList[GitRef]

 

VstsList[GitRepository]

 

VstsList[JObject]

 

VstsList[Project]

 

VstsList[QueryHierarchyItem]

 

VstsList[QueryResultWorkItemResponse]

 

VstsList[ReleaseDefinition]

 

VstsList[TeamMember]

 

VstsList[TeamSettingsIteration]

 

VstsList[Team]

 

VstsList[TfvcChangeset]

 

VstsList[TriggerWorkItemResponse]

 

VstsList[WorkItemType]

 

WebLinks

 

WiqlQuery

 

WorkItemFieldOperation

 

WorkItemFieldReference

 

WorkItemQueryClause

 

WorkItemQuerySortColumn

 

WorkItemType

 

WorkItemTypeFieldInstance

 

 

Actions:

ListAccounts

Summary: List accounts

Description: Retrieves the list of accounts the user is a member of.

 

Syntax:

VisualStudioTeamServices.ListAccounts ()

 

Returns:

          Type:VstsList[Account]

          Description: A list of VSTS models.

 

ListIterations

Summary: List iterations

Description: Retrieves the list of iterations for a project.

 

Syntax:

VisualStudioTeamServices.ListIterations (string account, string project, string team)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

team

string

(Team Name)

The name of the team within the project.

True

ListTeams

 

Returns:

          Type:VstsList[TeamSettingsIteration]

          Description: A list of VSTS models.

 

ListBuildDefinitions

Summary: List build definitions

Description: Retrieves the list of build defintions in a project.

 

Syntax:

VisualStudioTeamServices.ListBuildDefinitions (string account, string project)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

 

Returns:

          Type:VstsList[BuildDefinition]

          Description: A list of VSTS models.

 

QueueNewBuild

Summary: Queue a new build

Description: Create a build, based on an existing build definition, and add it to the build queue.

 

Syntax:

VisualStudioTeamServices.QueueNewBuild (string account, string project, string buildDefId, [Optional]QueueBuildRequest buildDetails)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

buildDefId

string

(Build Definition Id)

The identifier of the build definition to use.

True

ListBuildDefinitions

buildDetails

QueueBuildRequest

 

Queue Build Request

False

 

Returns:

          Type:BuildResult

          Description: Build Result

 

ListGitRepositories

Summary: List Git repositories

Description: Retrieves the list of Git repositories in a project.

 

Syntax:

VisualStudioTeamServices.ListGitRepositories (string account, string project)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

 

Returns:

          Type:VstsList[GitRepository]

          Description: A list of VSTS models.

 

ListGitRefs

Summary: List Git refs

Description: Retrieves the list of references (branches, tags, etc.) in a Git repo.

 

Syntax:

VisualStudioTeamServices.ListGitRefs (string account, string project, string repository)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

repository

string

(Repository Name)

The name of the repository within the specified project.

True

ListGitRepositories

 

Returns:

          Type:VstsList[GitRef]

          Description: A list of VSTS models.

 

ListProjects

Summary: List projects

Description: Retrieves the list of projects in an account.

 

Syntax:

VisualStudioTeamServices.ListProjects (string account)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

 

Returns:

          Type:VstsList[Project]

          Description: A list of VSTS models.

 

ListTeams

Summary: List the teams in a project

Description: Retrieves the list of teams in a project.

 

Syntax:

VisualStudioTeamServices.ListTeams (string account, string project)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

project

string

(Project Name)

The name of the project within the specified account.

True

 

Returns:

          Type:VstsList[Team]

          Description: A list of VSTS models.

 

ListTeamMembers

Summary: List the users in a team

Description: Retrieves the list of users in a specific team.

 

Syntax:

VisualStudioTeamServices.ListTeamMembers (string account, string project, string team)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

project

string

(Project Name)

The name of the project within the specified account.

True

team

string

(Team Name)

The name of the team within the project.

True

 

Returns:

          Type:VstsList[TeamMember]

          Description: A list of VSTS models.

 

ListReleaseDefinitions

Summary: List release definitions

Description: Retrieves the list of release definitions associated with a project.

 

Syntax:

VisualStudioTeamServices.ListReleaseDefinitions (string account, string project)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

 

Returns:

          Type:VstsList[ReleaseDefinition]

          Description: A list of VSTS models.

 

CreateRelease

Summary: Create a new release

Description: Create a release, based on an existing release definition.

 

Syntax:

VisualStudioTeamServices.CreateRelease (string account, string project, string releaseDefId, ReleaseStartMetadata releaseStartMetadata)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

releaseDefId

string

(Release Definition Id)

The identifier of the release definition to use.

True

ListReleaseDefinitions

releaseStartMetadata

ReleaseStartMetadata

 

Metadata VSTS REST API uses to start a release

True

 

Returns:

          Type:Release

          Description: Release

 

GetSubscriptionSchema

Summary: Get a dynamic schema to create a webhook subscription

Description: Get a dynamic schema to create a webhook subscription.

 

Syntax:

VisualStudioTeamServices.GetSubscriptionSchema (string account, string project, string subscriptionKind)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(The Id of the project within the specified account)

The Id of the project within the specified account.

True

ListProjects

subscriptionKind

string

(The type of the subscription to retrieve the schema for)Values: [BuildCompleted, WorkItemUpdated]

The type of the subscription to retrieve the schema for.

True

 

Returns:

          Type:Object

 

DeleteSubscription

Summary: Delete a subscription

Description: This operation deletes a subscription.

 

Syntax:

VisualStudioTeamServices.DeleteSubscription (string id, string account, string options)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of the subscription to be deleted)

Id of the subscription to be deleted.

True

account

string

(Name of the account)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

options

string

(Subscription options)

Subscription options.

True

 

Returns:

 

ListWorkItemTypes

Summary: List work item types

Description: Retrieves the list of Work Item Types accessible in a given VSTS project.

 

Syntax:

VisualStudioTeamServices.ListWorkItemTypes (string account, string project)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

 

Returns:

          Type:VstsList[WorkItemType]

          Description: A list of VSTS models.

 

GetWorkItemDetails

Summary: Get work item details

Description: Get the details of a single work item.

 

Syntax:

VisualStudioTeamServices.GetWorkItemDetails (string account, string project, string typeName, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

typeName

string

(Work Item Type)

The work item type of the work item.

True

ListWorkItemTypes

id

string

(Work Item Id)

The unique id of the work item to get details for.The work item must be of the type specified in 'Work Item Type'.

True

 

Returns:

          Type:DynamicWorkItemResponse

          Description: Work Item Response

 

UpdateWorkItem

Summary: Update a work item

Description: Update an existing work item by id.

 

Syntax:

VisualStudioTeamServices.UpdateWorkItem (string account, string id, [Optional]string project, [Optional]string type, UpdateWorkItemRequest workItem)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

id

string

(Work Item Id)

The unique id of the work item to update.

True

project

string

(Project Name)

The name of the project within the specified account.

False

ListProjects

type

string

(Work Item Type)

The work item type to generate schema for.

False

ListWorkItemTypes

workItem

UpdateWorkItemRequest

 

Update Work Item Request

True

 

Returns:

          Type:PatchWorkItemResponse

          Description: Work Item Response

 

CreateWorkItem

Summary: Create a work item

Description: Create a new work item with the provided attributes.

 

Syntax:

VisualStudioTeamServices.CreateWorkItem (string account, string project, string type, CreateWorkItemRequest workItem)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

type

string

(Work Item Type)

Type of this work item

True

ListWorkItemTypes

workItem

CreateWorkItemRequest

 

Create Work Item Request

True

 

Returns:

          Type:PatchWorkItemResponse

          Description: Work Item Response

 

GetQueryResults

Summary: Get query results

Description: Retrieves the result of a work item query.

 

Syntax:

VisualStudioTeamServices.GetQueryResults (string account, string project, string queryId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

queryId

string

(Query Id)

The Id of the stored query to run.

True

 

Returns:

          Type:VstsList[JObject]

          Description: A list of VSTS models.

 

GetQueryResultsV2

Summary: Get query results

Description: Retrieves the result of a work item query.

 

Syntax:

VisualStudioTeamServices.GetQueryResultsV2 (string account, string project, string queryId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

queryId

string

(Query Id)

The Id of the stored query to run.

True

 

Returns:

          Type:VstsList[QueryResultWorkItemResponse]

 

ListRootQueryFolders

Summary: List root level queries

Description: Retrieves the list of root-level work item queries in a project.

 

Syntax:

VisualStudioTeamServices.ListRootQueryFolders (string account, string project)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

 

Returns:

          Type:VstsList[QueryHierarchyItem]

          Description: A list of VSTS models.

 

ListQueriesInFolder

Summary: List queries within folder

Description: Retrieves the list of work item queries within a folder for a given project.

 

Syntax:

VisualStudioTeamServices.ListQueriesInFolder (string account, string project, string folderPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

folderPath

string

(Folder Path)

The folder path under which to look for queries.

True

 

Returns:

          Type:VstsList[QueryHierarchyItem]

          Description: A list of VSTS models.

 

GetWorkItemSchema

Summary: Get work item schema

Description: Get the schema for a work item type.

 

Syntax:

VisualStudioTeamServices.GetWorkItemSchema (string account, string project, string typeName)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

typeName

string

(Work Item Type)

The work item type to generate schema for.

True

ListWorkItemTypes

 

Returns:

          Type:Object

 

GetWorkItemSchemaForCreate

Summary: Get work item schema for create work item operation

Description: Get work item schema for create work item operation.

 

Syntax:

VisualStudioTeamServices.GetWorkItemSchemaForCreate (string account, string project, string typeName, [Optional]boolean onlyRequiredFields)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

typeName

string

(Work Item Type)

The work item type to generate schema for.

True

ListWorkItemTypes

onlyRequiredFields

boolean

(Only required fields should be returned)

Only required fields should be returned.

False

 

Returns:

          Type:Object

 

GetWorkItemSchemaForUpdate

Summary: Get work item schema for update work item operation

Description: Get work item schema for update work item operation.

 

Syntax:

VisualStudioTeamServices.GetWorkItemSchemaForUpdate (string account, string project, string typeName, [Optional]boolean onlyRequiredFields)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

typeName

string

(Work Item Type)

The work item type to generate schema for.

True

ListWorkItemTypes

onlyRequiredFields

boolean

(Only required fields should be returned)

Only required fields should be returned.

False

 

Returns:

          Type:Object

 

GetResponseWorkItemSchema

Summary: Get work item schema for the response of other operations

Description: Get work item schema for the response of other operations.

 

Syntax:

VisualStudioTeamServices.GetResponseWorkItemSchema ([Optional]string account, [Optional]string project, [Optional]string typeName)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

False

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

False

ListProjects

typeName

string

(Work Item Type)

The work item type to generate schema for.

False

ListWorkItemTypes

 

Returns:

          Type:Object

 

GetQueryResultWorkItemSchema

Summary: Get work item schema for the response of Get query result operation

Description: Get work item schema for the response of Get query result operation.

 

Syntax:

VisualStudioTeamServices.GetQueryResultWorkItemSchema ([Optional]string account, [Optional]string project, [Optional]string queryId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

False

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

False

ListProjects

queryId

string

 

 

False

 

Returns:

          Type:Object

 

RunWiqlQuery

Summary: Run WIQL query

Description: Run WIQL query.

 

Syntax:

VisualStudioTeamServices.RunWiqlQuery (string account, string project, WiqlQuery query)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

query

WiqlQuery

 

WIQL (Work item query language) query

True

 

Returns:

          Type:Object

 

WebhookBuildsCallback

Summary: Callback action for webhooks working with builds operations

Description: Callback action for webhooks working with builds operations.

 

Syntax:

VisualStudioTeamServices.WebhookBuildsCallback (string state)

 

Parameters:

Name

Type

Summary

Required

Related Action

state

string

(Callback state)

Callback state.

True

 

Returns:

 

WebhookWorkItemsCallback

Summary: Callback action for webhooks working with work items operations

Description: Callback action for webhooks working with work items operations.

 

Syntax:

VisualStudioTeamServices.WebhookWorkItemsCallback (string state)

 

Parameters:

Name

Type

Summary

Required

Related Action

state

string

(Callback state)

Callback state.

True

 

Returns:

 

Triggers:

Trigger OnBuildCompleted

Summary: When a build completes

Description: Triggers a flow when a build completes.

 

Syntax:

VisualStudioTeamServices.OnBuildCompleted (string account, string project, [Optional]string resultFilter, [advanced][Optional]string definitions)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

resultFilter

string

(Filter By Result)Values: [, succeeded, partiallySucceeded, failed, canceled]

An option indicating which build result to trigger on. Valid options include '', 'succeeded', 'partiallySucceeded', 'failed', or 'canceled'.

False

definitions

string

(Filter By Definition Id)

An option indicating which build definition id to trigger on.

False

 

Returns:

          Type:VstsList[BuildResult]

          Description: A list of VSTS models.

 

Trigger CreateOnBuildCompletedSubscription

Summary: When a build completes (webhook)

Description: Triggers a flow when a build completes.

 

Syntax:

VisualStudioTeamServices.CreateOnBuildCompletedSubscription (ClientSubscription subscription, string account, string project, [internal][Optional]string subscriptionKind)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscription

ClientSubscription

 

Describes the subscription information

True

account

string

(Account)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project)

The name of the project within the specified account.

True

ListProjects

subscriptionKind

string

 

 

False

 

Returns:

          Type:SubscriptionResponse

          Description: Model for webhook subscription response

 

Trigger OnGitPush

Summary: When code is pushed (Git)

Description: Triggers a flow when code is pushed to a Git repository.

 

Syntax:

VisualStudioTeamServices.OnGitPush (string account, string project, string repository, [advanced][Optional]string refName)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

repository

string

(Repository Name)

The name of the repository within the specified project.

True

ListGitRepositories

refName

string

(Ref Name)

The name of the Git ref, such as a branch or tag.

False

ListGitRefs

 

Returns:

          Type:VstsList[GitPush]

          Description: A list of VSTS models.

 

Trigger OnTfvcCheckIn

Summary: When code is checked in (TFVC)

Description: Triggers a flow when code is checked in to a Team Foundation Version Control project.

 

Syntax:

VisualStudioTeamServices.OnTfvcCheckIn (string account, string project, [Optional]string team, [Optional]string author)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

team

string

(Team Name)

The name of the team which to select an author.

False

ListTeams

author

string

(Team Member)

The unique name of the team member who authored the check in.

False

ListTeamMembers

 

Returns:

          Type:VstsList[TfvcChangeset]

          Description: A list of VSTS models.

 

Trigger OnWorkItemAssigned

Summary: When a work item is assigned

Description: Triggers a flow when a work item which matches provided criteria is assigned to the given user.

 

Syntax:

VisualStudioTeamServices.OnWorkItemAssigned (string account, string project, [Optional]string team, string wiql__System_AssignedTo, [advanced][Optional]string wiql__System_WorkItemType, [advanced][Optional]string wiql__System_AreaPath, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_TeamProject, [advanced][Optional]string wiql__Microsoft_VSTS_Common_CreatedBy)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

team

string

(Team Name)

The name of the team from which to select a member.

False

ListTeams

wiql__System_AssignedTo

string

(Assigned To)

The name of the team member who currently owns the work item.

True

ListTeamMembers

wiql__System_WorkItemType

string

(Type)Values: [Bug, Epic, Feature, Issue, Task, Test Case, User Story]

The name of the work item type. Valid options include 'Bug, 'Epic', etc.

False

wiql__System_AreaPath

string

(Area Path)

The product feature or team area the work item is in.

False

wiql__System_IterationPath

string

(Iteration Path)

The named sprint or time period the work item is in.

False

wiql__Microsoft_VSTS_Common_Priority

string

(Priority)

A subjective rating of the bug, issue, task, or test case as it relates to the business.

False

wiql__System_TeamProject

string

(Team Project)

The team project to which this work item belongs.

False

wiql__Microsoft_VSTS_Common_CreatedBy

string

(Created By)

The name of the team member who created the work item.

False

 

Returns:

          Type:VstsList[TriggerWorkItemResponse]

 

Trigger OnWorkItemUpdated

Summary: When a work item is updated

Description: Triggers a flow when a work item which matches provided criteria is updated.

 

Syntax:

VisualStudioTeamServices.OnWorkItemUpdated (string account, string project, [Optional]string team, [Optional]string wiql__System_AssignedTo, [Optional]string wiql__System_WorkItemType, [advanced][Optional]string wiql__System_AreaPath, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_TeamProject, [advanced][Optional]string wiql__Microsoft_VSTS_Common_CreatedBy)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

team

string

(Team Name)

The name of the team from which to select an assignee.

False

ListTeams

wiql__System_AssignedTo

string

(Assigned To)

The name of the team member who currently owns the work item.

False

ListTeamMembers

wiql__System_WorkItemType

string

(Type)Values: [Bug, Epic, Feature, Issue, Task, Test Case, User Story]

The name of the work item type. Valid options include 'Bug', 'Epic', etc.

False

wiql__System_AreaPath

string

(Area Path)

The product feature or team area the work item is in.

False

wiql__System_IterationPath

string

(Iteration Path)

The named sprint or time period the work item is in.

False

wiql__Microsoft_VSTS_Common_Priority

string

(Priority)

A subjective rating of the bug, issue, task, or test case as it relates to the business.

False

wiql__System_TeamProject

string

(Team Project)

The team project to which this work item belongs.

False

wiql__Microsoft_VSTS_Common_CreatedBy

string

(Created By)

The name of the team member who created the work item.

False

 

Returns:

          Type:VstsList[TriggerWorkItemResponse]

 

Trigger OnWorkItemCreated

Summary: When a work item is created

Description: Triggers a flow when a work item which matches provided criteria is created.

 

Syntax:

VisualStudioTeamServices.OnWorkItemCreated (string account, string project, [Optional]string team, [Optional]string wiql__System_AssignedTo, [Optional]string wiql__System_WorkItemType, [advanced][Optional]string wiql__System_AreaPath, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_TeamProject, [advanced][Optional]string wiql__Microsoft_VSTS_Common_CreatedBy)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

team

string

(Team Name)

The name of the team from which to select an assignee.

False

ListTeams

wiql__System_AssignedTo

string

(Assigned To)

The name of the team member who currently owns the work item.

False

ListTeamMembers

wiql__System_WorkItemType

string

(Type)Values: [Bug, Epic, Feature, Issue, Task, Test Case, User Story]

The name of the work item type. Valid options include 'Bug', 'Epic', etc.

False

wiql__System_AreaPath

string

(Area Path)

The product feature or team area the work item is in.

False

wiql__System_IterationPath

string

(Iteration Path)

The named sprint or time period the work item is in.

False

wiql__Microsoft_VSTS_Common_Priority

string

(Priority)

A subjective rating of the bug, issue, task, or test case as it relates to the business.

False

wiql__System_TeamProject

string

(Team Project)

The team project to which this work item belongs.

False

wiql__Microsoft_VSTS_Common_CreatedBy

string

(Created By)

The name of the team member who created the work item.

False

 

Returns:

          Type:VstsList[TriggerWorkItemResponse]

 

Trigger OnWorkItemClosed

Summary: When a work item is closed

Description: Triggers a flow when a work item which matches provided criteria is closed.

 

Syntax:

VisualStudioTeamServices.OnWorkItemClosed (string account, string project, [Optional]string team, [Optional]string wiql__System_AssignedTo, [Optional]string wiql__System_WorkItemType, [advanced][Optional]string wiql__System_AreaPath, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_TeamProject, [advanced][Optional]string wiql__Microsoft_VSTS_Common_CreatedBy)

 

Parameters:

Name

Type

Summary

Required

Related Action

account

string

(Account Name)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project Name)

The name of the project within the specified account.

True

ListProjects

team

string

(Team Name)

The name of the team from which to select an assignee.

False

ListTeams

wiql__System_AssignedTo

string

(Assigned To)

The name of the team member who currently owns the work item.

False

ListTeamMembers

wiql__System_WorkItemType

string

(Type)Values: [Bug, Epic, Feature, Issue, Task, Test Case, User Story]

The name of the work item type. Valid options include 'Bug', 'Epic', etc.

False

wiql__System_AreaPath

string

(Area Path)

The product feature or team area the work item is in.

False

wiql__System_IterationPath

string

(Iteration Path)

The named sprint or time period the work item is in.

False

wiql__Microsoft_VSTS_Common_Priority

string

(Priority)

A subjective rating of the bug, issue, task, or test case as it relates to the business.

False

wiql__System_TeamProject

string

(Team Project)

The team project to which this work item belongs.

False

wiql__Microsoft_VSTS_Common_CreatedBy

string

(Created By)

The name of the team member who created the work item.

False

 

Returns:

          Type:VstsList[TriggerWorkItemResponse]

 

Trigger CreateOnWorkItemUpdatedSubscription

Summary: When a work item is updated (webhook)

Description: Triggers a flow when a work item which matches provided criteria is updated.

 

Syntax:

VisualStudioTeamServices.CreateOnWorkItemUpdatedSubscription (ClientSubscription subscription, string account, string project, [internal][Optional]string subscriptionKind)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscription

ClientSubscription

 

Describes the subscription information

True

account

string

(Account)

The name of the account. This can be found in the instance URL i.e. {account}.visualstudio.com. The account should have "Third-party application access via OAuth" enabled to prevent errors in the operation.

True

ListAccounts

project

string

(Project)

The Id of the project within the specified account.

True

ListProjects

subscriptionKind

string

 

 

False

 

Returns:

          Type:SubscriptionResponse

          Description: Model for webhook subscription response

 


 

Account

Summary:

Description: Account

 

          Properties:

Name

Type

Summary

accountId

string

Account Id

The id of the account.

accountUri

string

Account URI

The URI of the account.

accountName

string

Account Name

The name of the account.

accountOwner

string

Account Owner

The set owner of the account.

organizationName

string

Organization Name

The organization name corresponding to the account.

accountType

string

Account Type

The type of the account.


 

BuildDefinition

Summary:

Description: Build Definition

 

          Properties:

Name

Type

Summary

id

integer(int32)

Id

The unique identifier of the build definition.

type

string

Type

The type of the build definition.

revision

integer(int32)

Revision

The revision number of the build definition.

name

string

Name

The name of the build definition.

_links

Links

 

Links


 

BuildRequestUser

Summary:

Description: Build Request User

 

          Properties:

Name

Type

Summary

uniqueName

string

Requested For

The unique name of the user the build was requested for.


 

BuildResult

Summary:

Description: Build Result

 

          Properties:

Name

Type

Summary

id

integer(int32)

Build Id

The unique identifier of the build.

buildNumber

string

Build Number

The build number.

sourceBranch

string

Source Branch

The source control branch the build used.

sourceVersion

string

Source version

The source control version the build used.

status

string

Status

The status of the build.

priority

string

Priority

The priority of the build.

queueTime

string(date-time)

Queue Time

The time the build was queued.

startTime

string(date-time)

Start Time

The time the build started.

finishTime

string(date-time)

Finish Time

The time the build finished.

reason

string

Reason

The reason for the build.

result

string

Result

The result of the build.

requestedFor

BuildRequestUser

 

Build Request User

parameters

string

Parameters

Parameters passed to the build, if any.

definition

BuildResultDefinition

 

Build Result Definition

_links

Links

 

Links


 

BuildResultDefinition

Summary:

Description: Build Result Definition

 

          Properties:

Name

Type

Summary

id

integer(int32)

Build Definition Id

The identifier of the build definiton.

name

string

Build Definition Name

The name of the build definition.


 

ChangesetAuthor

Summary:

Description: Changeset Author

 

          Properties:

Name

Type

Summary

displayName

string

Author Name

The name of the user who created the changeset.

uniqueName

string

Author Unique Name

The unique name of the user who created the changeset.


 

ChangesetCheckedInBy

Summary:

Description: Changeset Checked In By

 

          Properties:

Name

Type

Summary

displayName

string

Checked In By Name

The name of the user who checked in the changeset.

uniqueName

string

Checked In By Unique Name

The unique name of the user who created the changeset.


 

ClientSubscription

Summary:

Description: Describes the subscription information

 

          Properties:

Name

Type

Summary

NotificationUrl

string

 

Callback url to the LA engine. Expected as part of the request and provided by Flow.

DynamicProperties

DynamicProperties

 

 

 

DynamicProperties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

CreateWorkItemRequest

Summary:

Description: Create Work Item Request

 

          Properties:

Name

Type

Summary

title

string

Title

The title of the work item.

description

string

Description

The description of the work item.

priority

integer(int32)

Priority

The priority of the work item.

iteration

string

Iteration Path

The iteration path of the work item.

area

string

Area Path

The area path of the work item.

linkUrl

string

Link URL

The URL of the work item to link with this one.

linkType

string

Link Type

The type of the link to between the work items.  Values: [Dependency-forward, Dependency-reverse, Hierarchy-forward, Hierarchy-reverse, Related]

linkComment

string

Link Comment

The comment for the link.

dynamicFields

DynamicFields

 

 

 

DynamicFields

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

DynamicWorkItemResponse

Summary:

Description: Work Item Response

 

          Properties:

Name

Type

Summary

id

integer(int32)

Id

The unique id of the work item.

rev

integer(int32)

Revision Count

The revision count of the work item.

url

string

URL

The URL of the work item.

fields

Object

 

 


 

GitPush

Summary:

Description: Git Push

 

          Properties:

Name

Type

Summary

repository

GitRepository

 

Git Repository

pushedBy

GitPushUser

 

Git Push User

pushId

integer(int32)

Push Id

The unique id of the push.

date

string(date-time)

Date

The date the push was created.


 

GitPushUser

Summary:

Description: Git Push User

 

          Properties:

Name

Type

Summary

id

string

Pusher Id

The unique identifier of the user who created the push.

displayName

string

Pusher Name

The name of the user who created the push.

uniqueName

string

Pusher Unique Name

The unique name of the user who created the push.


 

GitRef

Summary:

Description: Git Ref

 

          Properties:

Name

Type

Summary

objectId

string

Ref Id

The unique id of the ref.

name

string

Ref Name

The name of the ref.


 

GitRepository

Summary:

Description: Git Repository

 

          Properties:

Name

Type

Summary

id

string

Repository Id

The unique id of the repository.

name

string

Repository Name

The name of the repository.

remoteUrl

string

Repository Remote URL

The URL via which git can sync with this repository.


 

IdentityRef

Summary:

Description: Identity Ref

 

          Properties:

Name

Type

Summary

DirectoryAlias

string

Directory Alias

The directory alias of the identity reference.

DisplayName

string

Display Name

The display name of the identity reference.

UniqueName

string

Unique Name

The unique name of the identity reference.

Url

string

URL

The URL of the identity reference.


 

Links

Summary:

Description: Links

 

          Properties:

Name

Type

Summary

web

WebLinks

 

Web Links


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

PatchWorkItemResponse

Summary:

Description: Work Item Response

 

          Properties:

Name

Type

Summary

id

integer(int32)

Id

The unique id of the work item.

rev

integer(int32)

Revision Count

The revision count of the work item.

url

string

URL

The URL of the work item.

fields

Object

 

 


 

Project

Summary:

Description: Project

 

          Properties:

Name

Type

Summary

id

string

Project Id

The unique identifier of the project.

name

string

Project Name

The name of the project.

url

string

Project URL

The API URL of the project.


 

QueryHierarchyItem

Summary:

Description: Query Hierarchy Item

 

          Properties:

Name

Type

Summary

Children

array of (QueryHierarchyItem)

Children

The list of children items associated with the query hierarchy item.

Clauses

WorkItemQueryClause

 

Work Item Query Clause

Columns

array of (WorkItemFieldReference)

Columns

The list of work item field columns associated with the query hierarchy item.

FilterOptions

string

Filter Options

The filter options of the query hierarchy item.  Values: [WorkItems, LinksOneHopMustContain, LinksOneHopMayContain, LinksOneHopDoesNotContain, LinksRecursiveMustContain, LinksRecursiveMayContain, LinksRecursiveDoesNotContain]

HasChildren

boolean

Has Children

Specifies whether the query hierarchy item has children.

Id

string

Id

The unique identifer of the query hierarchy item.

IsDeleted

boolean

Is Deleted

Specifies whether the query hierarchy item is deleted.

IsFolder

boolean

Is Folder

Specifies whether the query hierarchy item is a folder.

IsInvalidSyntax

boolean

Is Invalid Syntax

Specifies whether the query hierarchy item has invalid syntax.

IsPublic

boolean

Is Public

Specifies whether the query hierarchy item is public.

LinkClauses

WorkItemQueryClause

 

Work Item Query Clause

Name

string

Name

The name of the query hierarchy item.

Path

string

Path

The path of the query hierarchy item.

QueryType

string

Query Type

The query type of the query hierarchy item.  Values: [Flat, Tree, OneHop]

SortColumns

array of (WorkItemQuerySortColumn)

Sort Columns

The list of sort columns of the query hierarchy item.

SourceClauses

WorkItemQueryClause

 

Work Item Query Clause

TargetClauses

WorkItemQueryClause

 

Work Item Query Clause

Wiql

string

Wiql

The WIQL of the query hierarchy item.

_links

_links

Links

The collection of links relevant to the query hierarchy item.

Url

string

URL

The full HTTP link to the query hierarchy item.

 

_links

Summary: Links

Description: The collection of links relevant to the query hierarchy item.

 

          Properties:

Name

Type

Summary

 


 

QueryResultWorkItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

QueueBuildRequest

Summary:

Description: Queue Build Request

 

          Properties:

Name

Type

Summary

sourceBranch

string

Source Branch

The source branch of the build.

parameters

string

Parameters

A JSON dictionary of optional build parameters.


 

Release

Summary:

Description: Release

 

          Properties:

Name

Type

Summary

Comment

string

Comment

The comment of the release.

CreatedBy

IdentityRef

 

Identity Ref

CreatedOn

string(date-time)

Created On

The date on which the release was created.

Description

string

Description

The description of the release.

Id

integer(int32)

Id

The unique Identifier of the release.

KeepForever

boolean

Keep Forever

Whether to exclude the release from retention policies.

LogsContainerUrl

string

Logs Container URL

The logs Container URL of this release.

ModifiedBy

IdentityRef

 

Identity Ref

ModifiedOn

string(date-time)

Modified On

Date on which the release was modified.

Name

string

Name

The name of the release.

Reason

string

Reason

The reason of the release.  Values: [None, Manual, ContinuousIntegration, Schedule, IndividualCI, BatchedCI]

ReleaseDefinition

ReleaseDefinitionShallowReference

 

Release Definition Shallow Reference

Status

string

Status

The status of the release.  Values: [Undefined, Draft, Active, Abandoned]

Url

string

URL

The URL of the release.


 

ReleaseDefinition

Summary:

Description: Release Definition

 

          Properties:

Name

Type

Summary

Comment

string

Comment

The comment of the release definition.

CreatedOn

string(date-time)

Created On

The date on which the release definition was created.

Description

string

Description

The description of the release definition.

Id

integer(int32)

Id

The unique identifier of the release definition.

ModifiedBy

IdentityRef

 

Identity Ref

ModifiedOn

string(date-time)

Modified On

The date on which the release definition was modified.

Name

string

Name

The name of the release definition.

Path

string

Path

The path of the release definition.

ReleaseNameFormat

string

Release Name Format

The release name format of the release definition.

Revision

integer(int32)

Revision

The revision number of the release definition.

Source

string

Source

The source of the release definition.  Values: [Undefined, RestApi, UserInterface, Ibiza, PortalExtensionApi]

Tags

array of (string)

Tags

The list of tags of the release definition.

Url

string

URL

The URL to access the release definition.


 

ReleaseDefinitionShallowReference

Summary:

Description: Release Definition Shallow Reference

 

          Properties:

Name

Type

Summary

Id

integer(int32)

Id

The unique identifier of the release definition.

Name

string

Name

The name of the release definition.

Url

string

URL

The REST API URL to access the release definition.


 

ReleaseStartMetadata

Summary:

Description: Metadata VSTS REST API uses to start a release

 

          Properties:

Name

Type

Summary

Description

string

Description

The description of the release start metadata.

IsDraft

boolean

Is Draft

Specifies whether the release is a draft.

Reason

string

Reason

The reason for the release start metadata.  Values: [None, Manual, ContinuousIntegration, Schedule, IndividualCI, BatchedCI]


 

SubscriptionResponse

Summary:

Description: Model for webhook subscription response

 

          Properties:

Name

Type

Summary

id

string

 

Id of the subscription.

resource

string

 

Resource of the subscription request.

notificationType

string

 

Notification type.

notificationUrl

string

 

Notification Url.


 

Team

Summary:

Description: Team

 

          Properties:

Name

Type

Summary

id

string

Team Id

The unique id of the team.

name

string

Team Name

The name of the team.

url

string

Team URI

The URI of the team.

description

string

Team Description

The description of the team.

identityUrl

string

Identity URI

The URI of the team's identity.


 

TeamIterationAttributes

Summary:

Description: Team Iteration Attributes

 

          Properties:

Name

Type

Summary

FinishDate

string(date-time)

Finish Date

The finish date team iteration attribute.

StartDate

string(date-time)

Start Date

The start date team iteration attribute.


 

TeamMember

Summary:

Description: Team Member

 

          Properties:

Name

Type

Summary

id

string

Team Member Id

The unique id of the team member.

displayName

string

Display Name

The display name of the team member.

uniqueName

string

Unique Name

The username of the team member.

url

string

Member URI

The URI of the team member.

imageUrl

string

Image URI

The image URI of the team member.


 

TeamSettingsIteration

Summary:

Description: Work (Agile) Iteration

 

          Properties:

Name

Type

Summary

Attributes

TeamIterationAttributes

 

Team Iteration Attributes

Id

string

Id

Id of the resource.

Name

string

Name

Name of the resource.

Path

string

Path

Relative path to the iteration.

_links

_links

Links

Collection of links relevant to resource.

Url

string

URL

Full HTTP link to the resource.

 

_links

Summary: Links

Description: Collection of links relevant to resource.

 

          Properties:

Name

Type

Summary

 


 

TfvcChangeset

Summary:

Description: Team Foundation Version Control Changeset

 

          Properties:

Name

Type

Summary

changesetId

integer(int32)

Changeset Id

The unique id of the changeset.

author

ChangesetAuthor

 

Changeset Author

checkedInBy

ChangesetCheckedInBy

 

Changeset Checked In By

createdDate

string(date-time)

Created Date

The datetime the changeset was created.

comment

string

Comment

The comment describing the changeset.


 

TriggerWorkItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Id

The unique id of the work item.

rev

integer(int32)

Revision Count

The revision count of the work item.

url

string

URL

The URL of the work item.

fields

Object

 

 


 

UpdateWorkItemRequest

Summary:

Description: Update Work Item Request

 

          Properties:

Name

Type

Summary

title

string

Title

The title of the work item.

description

string

Description

The description of the work item.

priority

integer(int32)

Priority

The priority of the work item.

iteration

string

Iteration Path

The iteration path of the work item.

area

string

Area Path

The area path of the work item.

linkUrl

string

Link URL

The URL of the work item to link with this one.

linkType

string

Link Type

The type of link to between the work items.  Values: [Dependency-forward, Dependency-reverse, Hierarchy-forward, Hierarchy-reverse, Related]

linkComment

string

Link Comment

The comment for the link.

dynamicFields

DynamicFields

 

 

 

DynamicFields

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

VstsList[Account]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (Account)

Value

The VSTS Models


 

VstsList[BuildDefinition]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (BuildDefinition)

Value

The VSTS Models


 

VstsList[BuildResult]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (BuildResult)

Value

The VSTS Models


 

VstsList[GitPush]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (GitPush)

Value

The VSTS Models


 

VstsList[GitRef]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (GitRef)

Value

The VSTS Models


 

VstsList[GitRepository]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (GitRepository)

Value

The VSTS Models


 

VstsList[JObject]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (Object)

Value

The VSTS Models


 

VstsList[Project]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (Project)

Value

The VSTS Models


 

VstsList[QueryHierarchyItem]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (QueryHierarchyItem)

Value

The VSTS Models


 

VstsList[QueryResultWorkItemResponse]

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (QueryResultWorkItemResponse)

 

 


 

VstsList[ReleaseDefinition]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (ReleaseDefinition)

Value

The VSTS Models


 

VstsList[TeamMember]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (TeamMember)

Value

The VSTS Models


 

VstsList[TeamSettingsIteration]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (TeamSettingsIteration)

Value

The VSTS Models


 

VstsList[Team]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (Team)

Value

The VSTS Models


 

VstsList[TfvcChangeset]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (TfvcChangeset)

Value

The VSTS Models


 

VstsList[TriggerWorkItemResponse]

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (TriggerWorkItemResponse)

 

 


 

VstsList[WorkItemType]

Summary:

Description: A list of VSTS models.

 

          Properties:

Name

Type

Summary

value

array of (WorkItemType)

Value

The VSTS Models.


 

WebLinks

Summary:

Description: Web Links

 

          Properties:

Name

Type

Summary

href

string

HTML Link

The web URL of build details


 

WiqlQuery

Summary:

Description: WIQL (Work item query language) query

 

          Properties:

Name

Type

Summary

Query

string

 

WIQL (Work item query language) query to run.


 

WorkItemFieldOperation

Summary:

Description: Work Item Field Operation

 

          Properties:

Name

Type

Summary

Name

string

Name

The name of the work item field operation.

ReferenceName

string

Reference Name

The reference name of the work item field operation.


 

WorkItemFieldReference

Summary:

Description: Work Item Field Reference

 

          Properties:

Name

Type

Summary

Name

string

Name

The name of the work item field reference.

ReferenceName

string

Reference Name

The reference name of the work item field reference.

Url

string

URL

The URL of the work item field reference.


 

WorkItemQueryClause

Summary:

Description: Work Item Query Clause

 

          Properties:

Name

Type

Summary

Clauses

WorkItemQueryClause

 

Work Item Query Clause

Field

WorkItemFieldReference

 

Work Item Field Reference

FieldValue

WorkItemFieldReference

 

Work Item Field Reference

IsFieldValue

boolean

Is Field Value

Specifies whether the work item query clause is a field value.

LogicalOperator

string

Logical Operator

The logical operator of the work item query clause.  Values: [NONE, AND, OR]

Operator

WorkItemFieldOperation

 

Work Item Field Operation

Value

string

Value

The value of the work item query clause.


 

WorkItemQuerySortColumn

Summary:

Description: Work Item Query Sort Column

 

          Properties:

Name

Type

Summary

Descending

boolean

Descending

Specifies whether the work item query sort column is descending.

Field

WorkItemFieldReference

 

Work Item Field Reference


 

WorkItemType

Summary:

Description: Work Item Type

 

          Properties:

Name

Type

Summary

Description

string

Description

The description of the type.

Name

string

Name

The name of the type.

XmlForm

string

XML Form

An XML representation of the type.

FieldInstances

array of (WorkItemTypeFieldInstance)

Fields

A list of field instances associated with the type.


 

WorkItemTypeFieldInstance

Summary:

Description: Work Item Type Field Instance

 

          Properties:

Name

Type

Summary

AlwaysRequired

boolean

Always Required

Specifies whether the field instance is always required.

ReferenceName

string

Reference Name

The reference name of the field instance.

Name

string

Name

The name of the field instance.

Url

string

URL

A URL pointing to field instance details.