Connectors Reference
Azure DevOps 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: Production |
Tier: Premium |
Version: 1.3 |
|
Name |
Summary |
|
When a build completes |
|
|
When a build completes (webhook) |
|
|
OnGitPush (string account, string project, string repository, [advanced][Optional]string refName) |
When code is pushed (Git) |
|
When a pull request is created (Git) |
|
|
When a pull request is closed (Git) |
|
|
OnTfvcCheckIn (string account, string project, [Optional]string team, [Optional]string author) |
When code is checked in (TFVC) |
|
When a work item is assigned |
|
|
When a work item is assigned |
|
|
When a work item is updated |
|
|
When a work item is updated |
|
|
When a work item is created |
|
|
When a work item is created |
|
|
When a work item is closed |
|
|
When a work item is closed |
|
|
When a work item is updated (webhook) |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List Organizations
Description: Retrieves the list of Organizations the user is a member of.
Syntax:
AzureDevOps.ListAccounts ()
Returns:
Type:VstsList[Account]
Description: A list of VSTS models.
Summary: List iterations
Description: Retrieves the list of iterations for a project.
Syntax:
AzureDevOps.ListIterations (string account, string project, string team)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
team |
string (Team Name) |
The name of the team within the project. |
True |
Returns:
Type:VstsList[TeamSettingsIteration]
Description: A list of VSTS models.
Summary: List build definitions
Description: Retrieves the list of build defintions in a project.
Syntax:
AzureDevOps.ListBuildDefinitions (string account, string project)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
Returns:
Type:VstsList[BuildDefinition]
Description: A list of VSTS models.
Summary: Queue a new build
Description: Create a build, based on an existing build definition, and add it to the build queue.
Syntax:
AzureDevOps.QueueNewBuild (string account, string project, string buildDefId, [Optional]QueueBuildRequest buildDetails)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
buildDefId |
string (Build Definition Id) |
The identifier of the build definition to use. |
True |
|
|
buildDetails |
|
Queue Build Request |
False |
Returns:
Type:BuildResult
Description: Build Result
Summary: List Git repositories
Description: Retrieves the list of Git repositories in a project.
Syntax:
AzureDevOps.ListGitRepositories (string account, string project)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
Returns:
Description: A list of VSTS models.
Summary: List Git refs
Description: Retrieves the list of references (branches, tags, etc.) in a Git repo.
Syntax:
AzureDevOps.ListGitRefs (string account, string project, string repository)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
repository |
string (Repository Name) |
The name of the repository within the specified project. |
True |
Returns:
Type:VstsList[GitRef]
Description: A list of VSTS models.
Summary: List projects
Description: Retrieves the list of projects in an Organization.
Syntax:
AzureDevOps.ListProjects (string account)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
True |
Returns:
Type:VstsList[Project]
Description: A list of VSTS models.
Summary: List the teams in a project
Description: Retrieves the list of teams in a project.
Syntax:
AzureDevOps.ListTeams (string account, string project)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
Returns:
Type:VstsList[Team]
Description: A list of VSTS models.
Summary: List the users in a team
Description: Retrieves the list of users in a specific team.
Syntax:
AzureDevOps.ListTeamMembers (string account, string project, string team)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
team |
string (Team Name) |
The name of the team within the project. |
True |
Returns:
Type:VstsList[TeamMember]
Description: A list of VSTS models.
Summary: List release definitions
Description: Retrieves the list of release definitions associated with a project.
Syntax:
AzureDevOps.ListReleaseDefinitions (string account, string project)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
Returns:
Type:VstsList[ReleaseDefinition]
Description: A list of VSTS models.
Summary: Create a new release
Description: Create a release, based on an existing release definition.
Syntax:
AzureDevOps.CreateRelease (string account, string project, string releaseDefId, ReleaseStartMetadata releaseStartMetadata)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
releaseDefId |
string (Release Definition Id) |
The identifier of the release definition to use. |
True |
|
|
releaseStartMetadata |
|
Metadata VSTS REST API uses to start a release |
True |
Returns:
Type:Release
Description: Release
Summary: Get a dynamic schema to create a webhook subscription
Description: Get a dynamic schema to create a webhook subscription.
Syntax:
AzureDevOps.GetSubscriptionSchema (string account, string project, string subscriptionKind)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
True |
|
|
project |
string (The Id of the project within the specified Organization) |
The Id of the project within the specified Organization. |
True |
|
|
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
Summary: Get a dynamic schema to create a webhook subscription
Description: Get a dynamic schema to create a webhook subscription.
Syntax:
AzureDevOps.GetWorkItemsSubscriptionSchema (string account, string project, string workItemType, string subscriptionKind)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
True |
|
|
project |
string (The Id of the project within the specified Organization) |
The Id of the project within the specified Organization. |
True |
|
|
workItemType |
string (Work Item Type) |
The work item type to generate schema for. |
True |
|
|
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
Summary: Delete a subscription
Description: This operation deletes a subscription.
Syntax:
AzureDevOps.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 Organization.) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
True |
|
|
options |
string (Subscription options) |
Subscription options. |
True |
Returns:
Summary: Send an HTTP request to Azure DevOps
Description: Construct an Azure DevOps REST API request to invoke. Please refer to the following link for all available endpoints: https://docs.microsoft.com/rest/api/azure/devops
Syntax:
AzureDevOps.HttpRequest (string account, VstsHttpRequestBodyParameters parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
True |
|
|
parameters |
|
Body parameters for VSTS HttpRequest operation. |
True |
Returns:
Type:ObjectWithoutType
Summary: List work item types
Description: Retrieves the list of Work Item Types accessible in a given Azure DevOps project.
Syntax:
AzureDevOps.ListWorkItemTypes (string account, string project)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
Returns:
Description: A list of VSTS models.
Summary: Get work item details
Description: Get the details of a single work item.
Syntax:
AzureDevOps.GetWorkItemDetails (string account, string project, string typeName, string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
typeName |
string (Work Item Type) |
The work item type of the work item. |
True |
|
|
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:
Description: Work Item Response
Summary: Update a work item
Description: Update an existing work item by id.
Syntax:
AzureDevOps.UpdateWorkItem (string account, string id, [Optional]string project, [Optional]string type, UpdateWorkItemRequest workItem)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
True |
|
|
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 Organization. |
False |
|
|
type |
string (Work Item Type) |
The work item type to generate schema for. |
False |
|
|
workItem |
|
Update Work Item Request |
True |
Returns:
Description: Work Item Response
Summary: Get work item children
Description: Get a list of children (max size 1000) of a single work item.
Syntax:
AzureDevOps.GetWorkItemChildren (string account, string project, string id, [Optional]string workItemType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
id |
string (Work Item Id) |
The unique id of the work item to get the children for. |
True |
|
|
workItemType |
string (Children Work Item Type) |
The type of the children work item(s) |
False |
Returns:
Type:VstsList[ListWorkItemResponse]
Summary: Create a work item
Description: Create a new work item with the provided attributes.
Syntax:
AzureDevOps.CreateWorkItem (string account, string project, string type, CreateWorkItemRequest workItem)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
type |
string (Work Item Type) |
Type of this work item |
True |
|
|
workItem |
|
Create Work Item Request |
True |
Returns:
Description: Work Item Response
Summary: Get query results
Description: Retrieves the result of a work item query.
Syntax:
AzureDevOps.GetQueryResults (string account, string project, string queryId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
queryId |
string (Query Id) |
The Id of the stored query to run. |
True |
Returns:
Type:VstsList[JObject]
Description: A list of VSTS models.
Summary: Get query results
Description: Retrieves the result of a work item query.
Syntax:
AzureDevOps.GetQueryResultsV2 (string account, string project, string queryId, [advanced][Optional]integer workItemsCount, [advanced][Optional]boolean throwIfQueryChanged, [internal][Optional]integer queryHash, [internal][Optional]integer skip)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
queryId |
string (Query Id) |
The Id of the stored query to run. |
True |
|
|
workItemsCount |
integer(int32) (Number of work items to return) |
Max work items count to retrieve (1 - 20000) |
False |
|
|
throwIfQueryChanged |
boolean (Fail if query results change) |
If query results change during flow execution then flow run should fail to avoid inconsistencies. |
False |
|
|
queryHash |
integer(int32) (Hash) |
Hash value to detect changes in the query results. |
False |
|
|
skip |
integer(int32) (Skip) |
Number of items to skip to get next work items. |
False |
Returns:
Type:VstsList[QueryResultWorkItemResponse]
Summary: List root level queries
Description: Retrieves the list of root-level work item queries in a project.
Syntax:
AzureDevOps.ListRootQueryFolders (string account, string project)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
Returns:
Type:VstsList[QueryHierarchyItem]
Description: A list of VSTS models.
Summary: List queries within folder
Description: Retrieves the list of work item queries within a folder for a given project.
Syntax:
AzureDevOps.ListQueriesInFolder (string account, string project, string folderPath)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
folderPath |
string (Folder Path) |
The folder path under which to look for queries. |
True |
Returns:
Type:VstsList[QueryHierarchyItem]
Description: A list of VSTS models.
Summary: List work items
Description: Returns a list of work items.
Syntax:
AzureDevOps.ListWorkItems (string account, string project, string workItemIds, [Optional]string workItemType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
workItemIds |
string (Work Item IDs) |
The comma-separated list of requested work item IDs. |
True |
|
|
workItemType |
string (Work Item Type) |
The work item type to generate schema for. |
False |
Returns:
Type:VstsList[ListWorkItemResponse]
Summary: Get work item schema
Description: Get the schema for a work item type.
Syntax:
AzureDevOps.GetWorkItemSchema (string account, string project, string typeName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
typeName |
string (Work Item Type) |
The work item type to generate schema for. |
True |
Returns:
Type:Object
Summary: Get work item schema for create work item operation
Description: Get work item schema for create work item operation.
Syntax:
AzureDevOps.GetWorkItemSchemaForCreate (string account, string project, string typeName, [Optional]boolean onlyRequiredFields)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
typeName |
string (Work Item Type) |
The work item type to generate schema for. |
True |
|
|
onlyRequiredFields |
boolean (Only required fields should be returned) |
Only required fields should be returned. |
False |
Returns:
Type:Object
Summary: Get work item schema for update work item operation
Description: Get work item schema for update work item operation.
Syntax:
AzureDevOps.GetWorkItemSchemaForUpdate (string account, string project, string typeName, [Optional]boolean onlyRequiredFields)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
typeName |
string (Work Item Type) |
The work item type to generate schema for. |
True |
|
|
onlyRequiredFields |
boolean (Only required fields should be returned) |
Only required fields should be returned. |
False |
Returns:
Type:Object
Summary: Get work item schema for the response of other operations
Description: Get work item schema for the response of other operations.
Syntax:
AzureDevOps.GetResponseWorkItemSchema ([Optional]string account, [Optional]string project, [Optional]string typeName, [Optional]boolean convertReferenceName, [Optional]boolean handlePredefinedSchema)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
False |
|
|
project |
string (Project Name) |
The name of the project within the specified Organization. |
False |
|
|
typeName |
string (Work Item Type) |
The work item type to generate schema for. |
False |
|
|
convertReferenceName |
boolean
|
|
False |
|
|
handlePredefinedSchema |
boolean
|
|
False |
Returns:
Type:Object
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:
AzureDevOps.GetQueryResultWorkItemSchema ([Optional]string account, [Optional]string project, [Optional]string queryId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
False |
|
|
project |
string (Project Name) |
The name of the project within the specified Organization. |
False |
|
|
queryId |
string
|
|
False |
Returns:
Type:Object
Summary: Run WIQL query
Description: Run WIQL query.
Syntax:
AzureDevOps.RunWiqlQuery (string account, string project, WiqlQuery query)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
query |
|
WIQL (Work item query language) query |
True |
Returns:
Type:Object
Summary: Callback action for webhooks working with builds operations
Description: Callback action for webhooks working with builds operations.
Syntax:
AzureDevOps.WebhookBuildsCallback (string state)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
state |
string (Callback state) |
Callback state. |
True |
Returns:
Summary: Callback action for webhooks working with work items operations
Description: Callback action for webhooks working with work items operations.
Syntax:
AzureDevOps.WebhookWorkItemsCallback (string state)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
state |
string (Callback state) |
Callback state. |
True |
Returns:
Summary: When a build completes
Description: Triggers a flow when a build completes.
Syntax:
AzureDevOps.OnBuildCompleted (string account, string project, [Optional]string resultFilter, [advanced][Optional]string definitions)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
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:
Description: A list of VSTS models.
Summary: When a build completes (webhook)
Description: Triggers a flow when a build completes.
Syntax:
AzureDevOps.CreateOnBuildCompletedSubscription (ClientSubscription subscription, string account, string project, [internal][Optional]string subscriptionKind)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscription |
|
Describes the subscription information |
True |
|
|
account |
string (Organization) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
True |
|
|
project |
string (Project) |
The name of the project within the specified Organization. |
True |
|
|
subscriptionKind |
string
|
|
False |
Returns:
Type:SubscriptionResponse
Description: Model for webhook subscription response
Summary: When code is pushed (Git)
Description: Triggers a flow when code is pushed to a Git repository.
Syntax:
AzureDevOps.OnGitPush (string account, string project, string repository, [advanced][Optional]string refName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
repository |
string (Repository Name) |
The name of the repository within the specified project. |
True |
|
|
refName |
string (Ref Name) |
The name of the Git ref, such as a branch or tag. |
False |
Returns:
Type:VstsList[GitPush]
Description: A list of VSTS models.
Summary: When a pull request is created (Git)
Description: Triggers a flow when a pull request which matches provided criteria is created.
Syntax:
AzureDevOps.OnGitPullCreated (string account, string project, string repository, [advanced][Optional]string sourceRefName, [advanced][Optional]string targetRefName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
repository |
string (Repository Name) |
The name of the repository within the specified project. |
True |
|
|
sourceRefName |
string (Source Ref Name) |
The name of the Git ref, such as a branch or tag. |
False |
|
|
targetRefName |
string (Target Ref Name) |
The name of the Git ref, such as a branch or tag. |
False |
Returns:
Description: A list of VSTS models.
Summary: When a pull request is closed (Git)
Description: Triggers a flow when a pull request which matches provided criteria is closed.
Syntax:
AzureDevOps.OnGitPullClosed (string account, string project, string repository, [advanced][Optional]string sourceRefName, [advanced][Optional]string targetRefName)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
repository |
string (Repository Name) |
The name of the repository within the specified project. |
True |
|
|
sourceRefName |
string (Source Ref Name) |
The name of the Git ref, such as a branch or tag. |
False |
|
|
targetRefName |
string (Target Ref Name) |
The name of the Git ref, such as a branch or tag. |
False |
Returns:
Description: A list of VSTS models.
Summary: When code is checked in (TFVC)
Description: Triggers a flow when code is checked in to a Team Foundation Version Control project.
Syntax:
AzureDevOps.OnTfvcCheckIn (string account, string project, [Optional]string team, [Optional]string author)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
team |
string (Team Name) |
The name of the team which to select an author. |
False |
|
|
author |
string (Team Member) |
The unique name of the team member who authored the check in. |
False |
Returns:
Description: A list of VSTS models.
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:
AzureDevOps.OnWorkItemAssigned (string account, string project, string wiql__System_AssignedTo, [Optional]string team, [Optional]string wiql__System_WorkItemType, [advanced][Optional]string wiql__System_AreaPath, [advanced][Optional]string areaPathComparison, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string iterationPathComparison, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_TeamProject, [advanced][Optional]string wiql__System_CreatedBy)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
wiql__System_AssignedTo |
string (Assigned To) |
The name of the team member who currently owns the work item. |
True |
|
|
team |
string (Team Name (to pick Assigned To)) |
The name of the team from which to select a member. |
False |
|
|
wiql__System_WorkItemType |
string (Type) |
The name of the work item type. |
False |
|
|
wiql__System_AreaPath |
string (Area Path) |
The product feature or team area the work item is in. |
False |
|
|
areaPathComparison |
string (Area Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Area Path field. |
False |
|
|
wiql__System_IterationPath |
string (Iteration Path) |
The named sprint or time period the work item is in. |
False |
|
|
iterationPathComparison |
string (Iteration Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Iteration Path field. |
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__System_CreatedBy |
string (Created By) |
The name of the team member who created the work item. |
False |
Returns:
Type:VstsList[TriggerWorkItemResponse]
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:
AzureDevOps.OnWorkItemAssignedV2 (string account, string project, string team, string wiql__System_AssignedTo, [Optional]string wiql__System_WorkItemType, [advanced][Optional]string wiql__System_AreaPath, [advanced][Optional]string areaPathComparison, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string iterationPathComparison, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_CreatedBy)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
team |
string (Team Name (to pick Assigned To)) |
The name of the team from which to select a member. |
True |
|
|
wiql__System_AssignedTo |
string (Assigned To) |
The name of the team member who currently owns the work item. |
True |
|
|
wiql__System_WorkItemType |
string (Type) |
The name of the work item type. |
False |
|
|
wiql__System_AreaPath |
string (Area Path) |
The product feature or team area the work item is in. |
False |
|
|
areaPathComparison |
string (Area Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Area Path field. |
False |
|
|
wiql__System_IterationPath |
string (Iteration Path) |
The named sprint or time period the work item is in. |
False |
|
|
iterationPathComparison |
string (Iteration Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Iteration Path field. |
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_CreatedBy |
string (Created By) |
The name of the team member who created the work item. |
False |
Returns:
Type:VstsList[TriggerWorkItemResponse]
Summary: When a work item is updated
Description: Triggers a flow when a work item which matches provided criteria is updated.
Syntax:
AzureDevOps.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 areaPathComparison, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string iterationPathComparison, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_TeamProject, [advanced][Optional]string wiql__System_CreatedBy)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
team |
string (Team Name (to pick Assigned To)) |
The name of the team from which to select an assignee. |
False |
|
|
wiql__System_AssignedTo |
string (Assigned To) |
The name of the team member who currently owns the work item. |
False |
|
|
wiql__System_WorkItemType |
string (Type) |
The name of the work item type. |
False |
|
|
wiql__System_AreaPath |
string (Area Path) |
The product feature or team area the work item is in. |
False |
|
|
areaPathComparison |
string (Area Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Area Path field. |
False |
|
|
wiql__System_IterationPath |
string (Iteration Path) |
The named sprint or time period the work item is in. |
False |
|
|
iterationPathComparison |
string (Iteration Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Iteration Path field. |
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__System_CreatedBy |
string (Created By) |
The name of the team member who created the work item. |
False |
Returns:
Type:VstsList[TriggerWorkItemResponse]
Summary: When a work item is updated
Description: Triggers a flow when a work item which matches provided criteria is updated.
Syntax:
AzureDevOps.OnWorkItemUpdatedV2 (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 areaPathComparison, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string iterationPathComparison, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_CreatedBy)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
team |
string (Team Name (to pick Assigned To)) |
The name of the team from which to select an assignee. |
False |
|
|
wiql__System_AssignedTo |
string (Assigned To) |
The name of the team member who currently owns the work item. |
False |
|
|
wiql__System_WorkItemType |
string (Type) |
The name of the work item type. |
False |
|
|
wiql__System_AreaPath |
string (Area Path) |
The product feature or team area the work item is in. |
False |
|
|
areaPathComparison |
string (Area Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Area Path field. |
False |
|
|
wiql__System_IterationPath |
string (Iteration Path) |
The named sprint or time period the work item is in. |
False |
|
|
iterationPathComparison |
string (Iteration Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Iteration Path field. |
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_CreatedBy |
string (Created By) |
The name of the team member who created the work item. |
False |
Returns:
Type:VstsList[TriggerWorkItemResponse]
Summary: When a work item is created
Description: Triggers a flow when a work item which matches provided criteria is created.
Syntax:
AzureDevOps.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 areaPathComparison, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string iterationPathComparison, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_TeamProject, [advanced][Optional]string wiql__System_CreatedBy)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
team |
string (Team Name (to pick Assigned To)) |
The name of the team from which to select an assignee. |
False |
|
|
wiql__System_AssignedTo |
string (Assigned To) |
The name of the team member who currently owns the work item. |
False |
|
|
wiql__System_WorkItemType |
string (Type) |
The name of the work item type. |
False |
|
|
wiql__System_AreaPath |
string (Area Path) |
The product feature or team area the work item is in. |
False |
|
|
areaPathComparison |
string (Area Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Area Path field. |
False |
|
|
wiql__System_IterationPath |
string (Iteration Path) |
The named sprint or time period the work item is in. |
False |
|
|
iterationPathComparison |
string (Iteration Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Iteration Path field. |
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__System_CreatedBy |
string (Created By) |
The name of the team member who created the work item. |
False |
Returns:
Type:VstsList[TriggerWorkItemResponse]
Summary: When a work item is created
Description: Triggers a flow when a work item which matches provided criteria is created.
Syntax:
AzureDevOps.OnWorkItemCreatedV2 (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 areaPathComparison, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string iterationPathComparison, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_CreatedBy)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
team |
string (Team Name (to pick Assigned To)) |
The name of the team from which to select an assignee. |
False |
|
|
wiql__System_AssignedTo |
string (Assigned To) |
The name of the team member who currently owns the work item. |
False |
|
|
wiql__System_WorkItemType |
string (Type) |
The name of the work item type. |
False |
|
|
wiql__System_AreaPath |
string (Area Path) |
The product feature or team area the work item is in. |
False |
|
|
areaPathComparison |
string (Area Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Area Path field. |
False |
|
|
wiql__System_IterationPath |
string (Iteration Path) |
The named sprint or time period the work item is in. |
False |
|
|
iterationPathComparison |
string (Iteration Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Iteration Path field. |
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_CreatedBy |
string (Created By) |
The name of the team member who created the work item. |
False |
Returns:
Type:VstsList[TriggerWorkItemResponse]
Summary: When a work item is closed
Description: Triggers a flow when a work item which matches provided criteria is closed.
Syntax:
AzureDevOps.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 areaPathComparison, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string iterationPathComparison, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_TeamProject, [advanced][Optional]string wiql__System_CreatedBy, [internal][Optional]string closedState)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
team |
string (Team Name (to pick Assigned To)) |
The name of the team from which to select an assignee. |
False |
|
|
wiql__System_AssignedTo |
string (Assigned To) |
The name of the team member who currently owns the work item. |
False |
|
|
wiql__System_WorkItemType |
string (Type) |
The name of the work item type. |
False |
|
|
wiql__System_AreaPath |
string (Area Path) |
The product feature or team area the work item is in. |
False |
|
|
areaPathComparison |
string (Area Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Area Path field. |
False |
|
|
wiql__System_IterationPath |
string (Iteration Path) |
The named sprint or time period the work item is in. |
False |
|
|
iterationPathComparison |
string (Iteration Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Iteration Path field. |
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__System_CreatedBy |
string (Created By) |
The name of the team member who created the work item. |
False |
|
|
closedState |
string (Closed State) |
The comma-separated list of values of the State field indicating how the work item was closed (Done, Closed, Completed, Inactive). |
False |
Returns:
Type:VstsList[TriggerWorkItemResponse]
Summary: When a work item is closed
Description: Triggers a flow when a work item which matches provided criteria is closed.
Syntax:
AzureDevOps.OnWorkItemClosedV2 (string account, string project, [Optional]string team, [Optional]string wiql__System_AssignedTo, [Optional]string wiql__System_WorkItemType, [Optional]string closedState, [advanced][Optional]string wiql__System_AreaPath, [advanced][Optional]string areaPathComparison, [advanced][Optional]string wiql__System_IterationPath, [advanced][Optional]string iterationPathComparison, [advanced][Optional]string wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string wiql__System_CreatedBy)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
account |
string (Organization Name) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization 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 Organization. |
True |
|
|
team |
string (Team Name (to pick Assigned To)) |
The name of the team from which to select an assignee. |
False |
|
|
wiql__System_AssignedTo |
string (Assigned To) |
The name of the team member who currently owns the work item. |
False |
|
|
wiql__System_WorkItemType |
string (Type) |
The name of the work item type. |
False |
|
|
closedState |
string (Closed State) |
The comma-separated list of values of the State field indicating how the work item was closed (Done, Closed, Completed, Inactive). |
False |
|
|
wiql__System_AreaPath |
string (Area Path) |
The product feature or team area the work item is in. |
False |
|
|
areaPathComparison |
string (Area Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Area Path field. |
False |
|
|
wiql__System_IterationPath |
string (Iteration Path) |
The named sprint or time period the work item is in. |
False |
|
|
iterationPathComparison |
string (Iteration Path Comparison)Values: [Equals, Under] |
The rule to be used while comparing Iteration Path field. |
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_CreatedBy |
string (Created By) |
The name of the team member who created the work item. |
False |
Returns:
Type:VstsList[TriggerWorkItemResponse]
Summary: When a work item is updated (webhook)
Description: Triggers a flow when a work item which matches provided criteria is updated.
Syntax:
AzureDevOps.CreateOnWorkItemUpdatedSubscription (WorkItemsClientSubscription subscription, string account, string project, string workItemType, [internal][Optional]string subscriptionKind)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
subscription |
|
Describes the subscription information |
True |
|
|
account |
string (Organization) |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
True |
|
|
project |
string (Project) |
The Id of the project within the specified Organization. |
True |
|
|
workItemType |
string (Work Item Type) |
The name of the work item type. |
True |
|
|
subscriptionKind |
string
|
|
False |
Returns:
Type:SubscriptionResponse
Description: Model for webhook subscription response
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. |
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 |
Summary:
Description: Build Request User
Properties:
|
Name |
Type |
Summary |
|
uniqueName |
string Requested For |
The unique name of the user the build was requested for. |
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 |
|
Build Request User |
|
parameters |
string Parameters |
Parameters passed to the build, if any. |
|
definition |
|
Build Result Definition |
|
_links |
|
Links |
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. |
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. |
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. |
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 |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Commit Git User Date
Properties:
|
Name |
Type |
Summary |
|
date |
string Commit User Date |
Date of the Git operation. |
|
|
string Commit User Email |
Email address of the user performing the Git operation. |
|
imageUrl |
string Commit Image Url |
Url for the user's avatar. |
|
name |
string Commit User Name |
Name of the user performing the Git operation. |
Summary:
Description: Configuration variable
Properties:
|
Name |
Type |
Summary |
|
Name |
string Name |
The name of the configuration variable. |
|
Value |
string Value |
The value of the configuration variable. |
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 |
|
|
|
userEnteredFields |
Other Fields |
Other work item fields, including custom fields. 'Key' is field name and 'Value' is field value. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: Other Fields
Description: Other work item fields, including custom fields. 'Key' is field name and 'Value' is field value.
Properties:
|
Name |
Type |
Summary |
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 |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
System_Id |
integer(int32) Id |
The unique id of the work item. |
|
System_AreaPath |
string Area Path |
The area path of the work item. |
|
System_TeamProject |
string Team Project |
The team project to which the work item belongs. |
|
System_IterationPath |
string Iteration Path |
The iteration path of the work item. |
|
System_WorkItemType |
string Work Item Type |
The type of the work item. |
|
System_State |
string State |
The state of the work item. |
|
System_Reason |
string Reason |
The reason entered for the work item. |
|
System_CreatedDate |
string Created Date |
The datetime the work item was created. |
|
System_CreatedBy |
string Created By |
The name of the team member who created the work item. |
|
System_ChangedDate |
string Changed Date |
The datetime the work item was changed. |
|
System_ChangedBy |
string Changed By |
The name of the team member who changed the work item. |
|
System_Title |
string Title |
The title of the work item. |
|
System_Description |
string Description |
The description of the work item. |
|
System_Tags |
string Tags |
The tags of the work item. |
|
System_AssignedTo |
string Assigned To |
The name of the team member who currently owns the work item. |
Summary:
Description: Git Commit Ref
Properties:
|
Name |
Type |
Summary |
|
author |
|
Commit Git User Date |
|
comment |
string Commit Comment |
Comment or message of the commit. |
|
commentTruncated |
string Commit Comment Truncated |
Indicates if the comment is truncated from the full Git commit comment message. |
|
commitId |
string Commit Id |
Id of the commit. |
|
committer |
|
Commit Git User Date |
|
parents |
array of (string) Parents |
An enumeration of the parent commit IDs for this commit. |
|
remoteUrl |
string Commit Remote Url |
Remote URL path to the commit. |
|
url |
string Commit Url |
REST URL for this resource. |
Summary:
Description: Git Pull Request
Properties:
|
Name |
Type |
Summary |
|
repository |
|
Git Repository |
|
pullRequestId |
integer(int32) Pull Request Id |
The unique id of the pull request. |
|
createdBy |
|
Pull Request Created By |
|
creationDate |
string(date-time) Creation Date |
The date the pull request was created |
|
closedDate |
string(date-time) Closed Date |
The date when the pull request was closed (completed, abandoned, or merged externally) |
|
title |
string Title |
The title of the pull request |
|
description |
string Description |
The description of the pull request |
|
sourceRefName |
string Source Ref Name |
The name of the source branch of the pull request |
|
targetRefName |
string Target Ref Name |
The name of the target branch of the pull request |
|
isDraft |
boolean Is Draft |
Draft / WIP pull request |
|
reviewers |
array of (PullRequestReviewer) Reviewers |
Groups or teams that that this reviewer contributed to. |
|
reviewerList |
string Reviewer List |
A semicolon separated list of reviewer unique names which are valid email addresses |
|
requiredReviewerList |
string Required Reviewer List |
A semicolon separated list of required reviewer unique names which are valid email addresses |
|
commits |
array of (GitCommitRef) Commits |
The commits contained in the pull request. |
|
completionOptions |
|
Pull Request Completion Options |
|
mergeOptions |
|
Pull Request Merge Options |
|
mergeFailureMessage |
string Merge Failure Message |
If set, pull request merge failed for this reason. |
|
closedBy |
|
Pull Request Closed By |
|
autoCompleteSetBy |
|
Pull Request Auto Complete Set By |
|
url |
string Url |
The url of the pull request. |
|
remoteUrl |
string Remote Url |
The remote url to the pull request. |
|
artifactId |
string Artifact Id |
A string which uniquely identifies this pull request. |
|
mergeId |
string Merge Id |
The merge id of the pull request. |
|
codeReviewId |
integer Code Review Id |
The code review id of the pull request. |
|
completionQueueTime |
string Completion Queue Time |
The most recent date at which the pull request entered the queue to be completed. |
|
supportsIterations |
boolean Supports Iterations |
If true, this pull request supports multiple iterations. |
Summary:
Description: Git Push
Properties:
|
Name |
Type |
Summary |
|
repository |
|
Git Repository |
|
pushedBy |
|
Git Push User |
|
refUpdates |
array of (GitRefUpdate) Ref Updates |
The Refs that were updated as part of this push. |
|
pushId |
integer(int32) Push Id |
The unique id of the push. |
|
date |
string(date-time) Date |
The date the push was created. |
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. |
|
imageUrl |
string Pusher Image Url |
The url to the image for this user. |
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. |
Summary:
Description: Git Ref Update
Properties:
|
Name |
Type |
Summary |
|
name |
string Ref Name |
The name of the Git Ref that was updated. |
|
repositoryId |
string Repository Id |
The unique id of the repository. |
|
oldObjectId |
string Old Commit Id |
The id of the previous commit this Ref pointed to before the update. |
|
newObjectId |
string New Commit Id |
The id of the new commit this Ref pointed to before the update. |
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. |
|
url |
string Repository Browser URL |
The URL is the API endpoint for the repository. |
|
remoteUrl |
string Repository Remote URL |
The URL via which git can sync with this repository. |
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. |
|
Id |
string Id |
The Id of the identity reference. |
Summary:
Description: Links
Properties:
|
Name |
Type |
Summary |
|
web |
|
Web Links |
Summary:
Description: Work Item Response for the List Work Items operation
Properties:
|
Name |
Type |
Summary |
|
System.Id |
integer(int32) Id |
The unique id of the work item. |
|
System.AreaPath |
string Area Path |
The area path of the work item. |
|
System.TeamProject |
string Team Project |
The team project to which the work item belongs. |
|
System.IterationPath |
string Iteration Path |
The iteration path of the work item. |
|
System.WorkItemType |
string Work Item Type |
The type of the work item. |
|
System.State |
string State |
The state of the work item. |
|
System.Reason |
string Reason |
The reason entered for the work item. |
|
System.CreatedDate |
string Created Date |
The datetime the work item was created. |
|
System.CreatedBy |
string Created By |
The name of the team member who created the work item. |
|
System.ChangedDate |
string Changed Date |
The datetime the work item was changed. |
|
System.ChangedBy |
string Changed By |
The name of the team member who changed the work item. |
|
System.Title |
string Title |
The title of the work item. |
|
System.Description |
string Description |
The description of the work item. |
|
System.Tags |
string Tags |
The tags of the work item. |
|
System.AssignedTo |
string Assigned To |
The name of the team member who currently owns the work item. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
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 |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
System_Id |
integer(int32) Id |
The unique id of the work item. |
|
System_AreaPath |
string Area Path |
The area path of the work item. |
|
System_TeamProject |
string Team Project |
The team project to which the work item belongs. |
|
System_IterationPath |
string Iteration Path |
The iteration path of the work item. |
|
System_WorkItemType |
string Work Item Type |
The type of the work item. |
|
System_State |
string State |
The state of the work item. |
|
System_Reason |
string Reason |
The reason entered for the work item. |
|
System_CreatedDate |
string Created Date |
The datetime the work item was created. |
|
System_CreatedBy |
string Created By |
The name of the team member who created the work item. |
|
System_ChangedDate |
string Changed Date |
The datetime the work item was changed. |
|
System_ChangedBy |
string Changed By |
The name of the team member who changed the work item. |
|
System_Title |
string Title |
The title of the work item. |
|
System_Description |
string Description |
The description of the work item. |
|
System_Tags |
string Tags |
The tags of the work item. |
|
System_AssignedTo |
string Assigned To |
The name of the team member who currently owns the work item. |
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. |
Summary:
Description: Pull Request Auto Complete Set By
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Auto Complete Set By Display Name |
The display name of the user who enabled auto complete. |
|
uniqueName |
string Auto Complete Set By Unique Name |
The unique name of the user who enabled auto complete. |
|
id |
string Auto Complete Set By Id |
The Id of the user who enabled auto complete. |
|
imageUrl |
string Auto Complete Set By Image Url |
The url to the image of the user who enabled auto complete. |
|
url |
string Auto Complete Set By Url |
The url of the user who enabled auto complete. |
Summary:
Description: Pull Request Closed By
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Closed By Display Name |
The display name of the pull request closer. |
|
uniqueName |
string Closed By Unique Name |
The unique name of the pull request closer. |
|
id |
string Closed By Id |
The Id of the pull request closer. |
|
imageUrl |
string Closed By Image Url |
The url to the image of the pull request closer. |
|
url |
string Closed By Url |
The url of the pull request closer. |
Summary:
Description: Pull Request Completion Options
Properties:
|
Name |
Type |
Summary |
|
autoCompleteIgnoreConfigIds |
array of (integer) Auto Complete Ignore Config Ids |
List of any policy configuration Id's which auto-complete should not wait for |
|
bypassPolicy |
boolean Bypass Policy |
If true, policies will be explicitly bypassed while the pull request is completed. |
|
bypassReason |
string Bypass Reason |
If policies are bypassed, this reason is stored as to why bypass was used. |
|
deleteSourceBranch |
boolean Delete Source Branch |
If true, the source branch of the pull request will be deleted after completion. |
|
mergeCommitMessage |
string Merge Commit Message |
If set, this will be used as the commit message of the merge commit. |
|
mergeStrategy |
|
Pull Request Merge Strategy |
|
squashMerge |
boolean Squash Merge |
If MergeStrategy is not set, the merge strategy will be no-fast-forward if this flag is false, or squash if true. |
|
transitionWorkItems |
boolean Transition Work Items |
If true, we will attempt to transition any work items linked to the pull request into the next logical state (i.e. Active -> Resolved). |
Summary:
Description: Pull Request Created By
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Created By Display Name |
The display name of the pull request creator. |
|
uniqueName |
string Created By Unique Name |
The unique name of the pull request creator. |
|
id |
string Created By Id |
The Id of the pull request creator. |
|
imageUrl |
string Created By Image Url |
The url to the image of the pull request creator. |
|
url |
string Created By Url |
The url of the pull request creator. |
Summary:
Description: Pull Request Merge Options
Properties:
|
Name |
Type |
Summary |
|
noFastForward |
string No Fast Forward |
A two-parent, no-fast-forward merge. The source branch is unchanged. This is the default behavior. |
|
rebase |
string Rebase |
Rebase the source branch on top of the target branch HEAD commit, and fast-forward the target branch. |
|
rebaseMerge |
string Rebase Merge |
Rebase the source branch on top of the target branch HEAD commit, and create a two-parent, no-fast-forward merge. |
|
squash |
string Squash |
Put all changes from the pull request into a single-parent commit. |
Summary:
Description: Pull Request Merge Strategy
Properties:
|
Name |
Type |
Summary |
|
conflictAuthorshipCommits |
boolean Conflict Authorship Commits |
If true, conflict resolutions applied during the merge will be put in separate commits to preserve authorship info for git blame. |
|
detectRenameFalsePositives |
boolean Detect Rename False Positives |
If true, detects rename false positives. |
|
disableRenames |
boolean Disable Renames |
If true, rename detection will not be performed during the merge. |
Summary:
Description: Pull Request Reviewer
Properties:
|
Name |
Type |
Summary |
|
displayName |
string Reviewer Display Name |
The display name of the pull request reviewer. |
|
uniqueName |
string Reviewer Unique Name |
The unique name of the pull request reviewer. |
|
id |
string Reviewer Id |
The Id of the pull request reviewer. |
|
url |
string Reviewer Url |
The url of the pull request reviewer. |
|
hasDeclined |
boolean Has Declined |
Indicates if this reviewer has declined to review this pull request. |
|
isFlagged |
boolean Is Flagged |
Indicates if this reviewer is flagged for attention on this pull request. |
|
isRequired |
boolean Is Required |
Indicates if this is a required reviewer for this pull request. |
|
vote |
integer(int32) Vote |
Vote on a pull request: approved(10), approved with suggestions(5), no vote(0), waiting for author(-5), rejected(-10). |
|
votedFor |
array of (PullRequestReviewer) Voted For |
Groups or teams that that this reviewer contributed to. |
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 |
|
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 |
|
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 |
|
Work Item Query Clause |
|
TargetClauses |
|
Work Item Query Clause |
|
Wiql |
string Wiql |
The WIQL of the query hierarchy item. |
|
_links |
Links |
The collection of links relevant to the query hierarchy item. |
|
Url |
string URL |
The full HTTP link to the query hierarchy item. |
Summary: Links
Description: The collection of links relevant to the query hierarchy item.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Query Result Work Item Response
Properties:
|
Name |
Type |
Summary |
|
System.Id |
integer(int32) Id |
The unique id of the work item. |
|
System.AreaPath |
string Area Path |
The area path of the work item. |
|
System.TeamProject |
string Team Project |
The team project to which the work item belongs. |
|
System.IterationPath |
string Iteration Path |
The iteration path of the work item. |
|
System.WorkItemType |
string Work Item Type |
The type of the work item. |
|
System.State |
string State |
The state of the work item. |
|
System.Reason |
string Reason |
The reason entered for the work item. |
|
System.CreatedDate |
string Created Date |
The datetime the work item was created. |
|
System.CreatedBy |
string Created By |
The name of the team member who created the work item. |
|
System.ChangedDate |
string Changed Date |
The datetime the work item was changed. |
|
System.ChangedBy |
string Changed By |
The name of the team member who changed the work item. |
|
System.Title |
string Title |
The title of the work item. |
|
System.Description |
string Description |
The description of the work item. |
|
System.Tags |
string Tags |
The tags of the work item. |
|
System.AssignedTo |
string Assigned To |
The name of the team member who currently owns the work item. |
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. |
Summary:
Description: Release
Properties:
|
Name |
Type |
Summary |
|
Comment |
string Comment |
The comment of the release. |
|
CreatedBy |
|
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 |
|
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. |
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 |
|
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. |
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. |
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] |
|
Variables |
array of (ConfigurationVariable) Release variables |
Release variables. |
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. |
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. |
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. |
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. |
Summary:
Description: Work (Agile) Iteration
Properties:
|
Name |
Type |
Summary |
|
Attributes |
|
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 |
Collection of links relevant to resource. |
|
Url |
string URL |
Full HTTP link to the resource. |
Summary: Links
Description: Collection of links relevant to resource.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Team Foundation Version Control Changeset
Properties:
|
Name |
Type |
Summary |
|
changesetId |
integer(int32) Changeset Id |
The unique id of the changeset. |
|
author |
|
Changeset Author |
|
checkedInBy |
|
Changeset Checked In By |
|
createdDate |
string(date-time) Created Date |
The datetime the changeset was created. |
|
comment |
string Comment |
The comment describing the changeset. |
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 |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
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 |
|
|
|
userEnteredFields |
Other Fields |
Other work item fields, including custom fields. 'Key' is field name and 'Value' is field value. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary: Other Fields
Description: Other work item fields, including custom fields. 'Key' is field name and 'Value' is field value.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Body parameters for VSTS HttpRequest operation.
Properties:
|
Name |
Type |
Summary |
|
Method |
string Method |
The HTTP method. Values: [GET, POST, PUT, PATCH, DELETE] |
|
Uri |
string Relative URI |
The relative URI. Example: {project}/{team}/_apis/wit/templates?api-version=5.0-preview.1. |
|
Headers |
Headers |
The request headers. |
|
Body |
string Body |
The request content. Can be JSON object or binary data encoded as Base64 string. |
|
IsBase64 |
boolean Body is Base64 |
Must be true if request content is encoded as Base64 string. |
Summary: Headers
Description: The request headers.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (Account) Value |
The VSTS Models |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (BuildDefinition) Value |
The VSTS Models |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (BuildResult) Value |
The VSTS Models |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (GitPullRequest) Value |
The VSTS Models |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (GitPush) Value |
The VSTS Models |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (GitRef) Value |
The VSTS Models |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (GitRepository) Value |
The VSTS Models |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (Object) Value |
The VSTS Models |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ListWorkItemResponse)
|
|
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (Project) Value |
The VSTS Models |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (QueryHierarchyItem) Value |
The VSTS Models |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (QueryResultWorkItemResponse)
|
|
|
@odata.nextLink |
string
|
Next page link |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ReleaseDefinition) Value |
The VSTS Models |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (TeamMember) Value |
The VSTS Models |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (TeamSettingsIteration) Value |
The VSTS Models |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (Team) Value |
The VSTS Models |
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (TfvcChangeset) Value |
The VSTS Models |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (TriggerWorkItemResponse)
|
|
Summary:
Description: A list of VSTS models.
Properties:
|
Name |
Type |
Summary |
|
value |
array of (WorkItemType) Value |
The VSTS Models. |
Summary:
Description: Web Links
Properties:
|
Name |
Type |
Summary |
|
href |
string HTML Link |
The web URL of build details |
Summary:
Description: WIQL (Work item query language) query
Properties:
|
Name |
Type |
Summary |
|
Query |
string
|
WIQL (Work item query language) query to run. |
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. |
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. |
Summary:
Description: Work Item Query Clause
Properties:
|
Name |
Type |
Summary |
|
Clauses |
|
Work Item Query Clause |
|
Field |
|
Work Item Field Reference |
|
FieldValue |
|
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 |
|
Work Item Field Operation |
|
Value |
string Value |
The value of the work item query clause. |
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 |
|
Work Item Field Reference |
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 |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
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. |
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. |