Azure DevOps data contract | PatchOps Knowledge

Provenance

PublisherAzure DevOps

API basehttps://dev.azure.com/

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (API key)

Methods (67)

getProjects

read

List all projects in the organization.

Required paramsorganization

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "top": {
      "type": "number"
    },
    "skip": {
      "type": "number"
    },
    "stateFilter": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization"
  ]
}

getProject

read

Get project details.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "includeCapabilities": {
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getTeams

read

List teams in a project (Azure DevOps).

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "top": {
      "type": "number"
    },
    "skip": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getTeamMembers

read

List members of a team.

Required paramsorganizationprojectteam

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "team": {
      "type": "string"
    },
    "top": {
      "type": "number"
    },
    "skip": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "team"
  ]
}

getWorkItem

read

Get a single work item by ID.

Required paramsorganizationprojectid

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "id": {
      "type": "number"
    },
    "expand": {
      "type": "string"
    },
    "fields": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "id"
  ]
}

batchGetWorkItems

read

Get multiple work items by IDs.

Required paramsorganizationids

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "fields": {
      "type": "string"
    },
    "expand": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "ids"
  ]
}

createWorkItem

write

Create a new work item (Bug, Task, User Story, etc).

Required paramsorganizationprojecttypefields

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "fields": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "type",
    "fields"
  ]
}

updateWorkItem

write

Update work item fields.

Required paramsorganizationprojectidfields

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "id": {
      "type": "number"
    },
    "fields": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "id",
    "fields"
  ]
}

deleteWorkItem

write

Delete or recycle a work item.

Required paramsorganizationprojectid

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "id": {
      "type": "number"
    },
    "destroy": {
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "id"
  ]
}

queryWorkItems

read

Run a WIQL query to find work items.

Required paramsorganizationprojectquery

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "query": {
      "type": "string"
    },
    "top": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "query"
  ]
}

getWorkItemTypes

read

List available work item types (Bug, Task, etc).

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getWorkItemComments

read

Get comments on a work item.

Required paramsorganizationprojectworkItemId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "workItemId": {
      "type": "number"
    },
    "top": {
      "type": "number"
    },
    "skip": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "workItemId"
  ]
}

addWorkItemComment

write

Add a comment to a work item.

Required paramsorganizationprojectworkItemIdtext

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "workItemId": {
      "type": "number"
    },
    "text": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "workItemId",
    "text"
  ]
}

getWorkItemUpdates

read

Get change history for a work item.

Required paramsorganizationprojectid

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "id": {
      "type": "number"
    },
    "top": {
      "type": "number"
    },
    "skip": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "id"
  ]
}

getWorkItemRevisions

read

Get all revisions of a work item.

Required paramsorganizationprojectid

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "id": {
      "type": "number"
    },
    "top": {
      "type": "number"
    },
    "skip": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "id"
  ]
}

getQueries

read

List saved WIQL queries in a project.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "depth": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getQuery

read

Get a saved query by ID.

Required paramsorganizationprojectqueryId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "queryId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "queryId"
  ]
}

getIterations

read

List sprints/iterations for a team.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "team": {
      "type": "string"
    },
    "timeframe": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getIteration

read

Get sprint details by ID (Azure DevOps).

Required paramsorganizationprojectiterationId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "iterationId": {
      "type": "string"
    },
    "team": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "iterationId"
  ]
}

getIterationWorkItems

read

Get work items in a sprint.

Required paramsorganizationprojectiterationId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "iterationId": {
      "type": "string"
    },
    "team": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "iterationId"
  ]
}

getBoards

read

List boards for a team.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "team": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getBoard

read

Get board details.

Required paramsorganizationprojectboardId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "boardId": {
      "type": "string"
    },
    "team": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "boardId"
  ]
}

getBoardColumns

read

Get columns/lanes for a board.

Required paramsorganizationprojectboardId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "boardId": {
      "type": "string"
    },
    "team": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "boardId"
  ]
}

getBacklogItems

read

Get items on a team backlog.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "team": {
      "type": "string"
    },
    "backlogId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getTeamSettings

read

Get team settings (working days, backlog config).

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "team": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getCapacity

read

Get team capacity for a sprint.

Required paramsorganizationprojectiterationId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "iterationId": {
      "type": "string"
    },
    "team": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "iterationId"
  ]
}

getRepositories

read

List Git repositories in a project.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getRepository

read

Get repository details.

Required paramsorganizationprojectrepositoryId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "repositoryId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "repositoryId"
  ]
}

getBranches

read

List branches in a repository.

Required paramsorganizationprojectrepositoryId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "repositoryId": {
      "type": "string"
    },
    "filter": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "repositoryId"
  ]
}

getCommits

read

List commits with optional filters (branch, author, date).

Required paramsorganizationprojectrepositoryId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "repositoryId": {
      "type": "string"
    },
    "top": {
      "type": "number"
    },
    "skip": {
      "type": "number"
    },
    "branch": {
      "type": "string"
    },
    "author": {
      "type": "string"
    },
    "fromDate": {
      "type": "string"
    },
    "toDate": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "repositoryId"
  ]
}

getCommit

read

Get a single commit by SHA.

Required paramsorganizationprojectrepositoryIdcommitId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "repositoryId": {
      "type": "string"
    },
    "commitId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "repositoryId",
    "commitId"
  ]
}

getPullRequests

read

List pull requests with status/author/branch filters.

Required paramsorganizationprojectrepositoryId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "repositoryId": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "creatorId": {
      "type": "string"
    },
    "reviewerId": {
      "type": "string"
    },
    "sourceRefName": {
      "type": "string"
    },
    "targetRefName": {
      "type": "string"
    },
    "top": {
      "type": "number"
    },
    "skip": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "repositoryId"
  ]
}

getPullRequest

read

Get pull request details.

Required paramsorganizationprojectrepositoryIdpullRequestId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "repositoryId": {
      "type": "string"
    },
    "pullRequestId": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "repositoryId",
    "pullRequestId"
  ]
}

createPullRequest

write

Create a new pull request.

Required paramsorganizationprojectrepositoryIdsourceRefNametargetRefNametitle

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "repositoryId": {
      "type": "string"
    },
    "sourceRefName": {
      "type": "string"
    },
    "targetRefName": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "reviewers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        },
        "required": [
          "id"
        ],
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "repositoryId",
    "sourceRefName",
    "targetRefName",
    "title"
  ]
}

updatePullRequest

write

Update PR title, description, or status.

Required paramsorganizationprojectrepositoryIdpullRequestId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "repositoryId": {
      "type": "string"
    },
    "pullRequestId": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "repositoryId",
    "pullRequestId"
  ]
}

getPullRequestComments

read

Get comment threads on a PR.

Required paramsorganizationprojectrepositoryIdpullRequestId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "repositoryId": {
      "type": "string"
    },
    "pullRequestId": {
      "type": "number"
    },
    "threadId": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "repositoryId",
    "pullRequestId"
  ]
}

addPullRequestComment

write

Add a comment to a PR (Azure DevOps).

Required paramsorganizationprojectrepositoryIdpullRequestIdcontent

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "repositoryId": {
      "type": "string"
    },
    "pullRequestId": {
      "type": "number"
    },
    "content": {
      "type": "string"
    },
    "parentCommentId": {
      "type": "number"
    },
    "threadId": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "repositoryId",
    "pullRequestId",
    "content"
  ]
}

getItems

read

Browse repository file/folder tree.

Required paramsorganizationprojectrepositoryId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "repositoryId": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "recursionLevel": {
      "type": "string"
    },
    "versionDescriptor": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "repositoryId"
  ]
}

getPipelines

read

List pipelines in a project.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "top": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getPipeline

read

Get pipeline details.

Required paramsorganizationprojectpipelineId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "pipelineId": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "pipelineId"
  ]
}

getPipelineRuns

read

List runs for a pipeline.

Required paramsorganizationprojectpipelineId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "pipelineId": {
      "type": "number"
    },
    "top": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "pipelineId"
  ]
}

runPipeline

write

Trigger a pipeline run.

Required paramsorganizationprojectpipelineId

Entitiespipeline

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "pipelineId": {
      "type": "number"
    },
    "branch": {
      "type": "string"
    },
    "variables": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "templateParameters": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "pipelineId"
  ]
}

getBuilds

read

List builds with status/result/branch filters.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "top": {
      "type": "number"
    },
    "statusFilter": {
      "type": "string"
    },
    "resultFilter": {
      "type": "string"
    },
    "definitions": {
      "type": "string"
    },
    "branchName": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getBuild

read

Get build details.

Required paramsorganizationprojectbuildId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "buildId": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "buildId"
  ]
}

getBuildLog

read

Get build logs.

Required paramsorganizationprojectbuildId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "buildId": {
      "type": "number"
    },
    "logId": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "buildId"
  ]
}

getBuildTimeline

read

Get build timeline (stages/jobs/tasks).

Required paramsorganizationprojectbuildId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "buildId": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "buildId"
  ]
}

getBuildDefinitions

read

List build definitions/pipelines.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "top": {
      "type": "number"
    },
    "name": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getReleases

read

List releases (Azure DevOps).

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "top": {
      "type": "number"
    },
    "definitionId": {
      "type": "number"
    },
    "statusFilter": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getRelease

read

Get release details (Azure DevOps).

Required paramsorganizationprojectreleaseId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "releaseId": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "releaseId"
  ]
}

getReleaseDefinitions

read

List release definitions.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "top": {
      "type": "number"
    },
    "searchText": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getDeployments

read

List deployments with status filter.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "definitionId": {
      "type": "number"
    },
    "top": {
      "type": "number"
    },
    "deploymentStatus": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getFeeds

read

List artifact feeds.

Required paramsorganization

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization"
  ]
}

getFeed

read

Get feed details.

Required paramsorganizationfeedId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "feedId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "feedId"
  ]
}

getPackages

read

List packages in a feed.

Required paramsorganizationfeedId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "feedId": {
      "type": "string"
    },
    "top": {
      "type": "number"
    },
    "skip": {
      "type": "number"
    },
    "packageNameQuery": {
      "type": "string"
    },
    "protocolType": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "feedId"
  ]
}

getPackageVersions

read

List versions of a package.

Required paramsorganizationfeedIdpackageId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "feedId": {
      "type": "string"
    },
    "packageId": {
      "type": "string"
    },
    "top": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "feedId",
    "packageId"
  ]
}

getTestPlans

read

List test plans.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getTestPlan

read

Get test plan details.

Required paramsorganizationprojectplanId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "planId": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "planId"
  ]
}

getTestSuites

read

List test suites in a plan.

Required paramsorganizationprojectplanId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "planId": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "planId"
  ]
}

getTestCases

read

List test cases in a suite.

Required paramsorganizationprojectplanIdsuiteId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "planId": {
      "type": "number"
    },
    "suiteId": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "planId",
    "suiteId"
  ]
}

getTestRuns

read

List test runs.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "top": {
      "type": "number"
    },
    "buildUri": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getTestRun

read

Get test run details.

Required paramsorganizationprojectrunId

Entitiestest run

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "runId": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "runId"
  ]
}

getTestResults

read

Get test results for a run.

Required paramsorganizationprojectrunId

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "runId": {
      "type": "number"
    },
    "top": {
      "type": "number"
    },
    "outcomes": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "runId"
  ]
}

getWikis

read

List wikis in a project.

Required paramsorganizationproject

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project"
  ]
}

getWikiPage

read

Get wiki page content.

Required paramsorganizationprojectwikiIdentifierpath

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "wikiIdentifier": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "recursionLevel": {
      "type": "string"
    },
    "includeContent": {
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "wikiIdentifier",
    "path"
  ]
}

getWikiPages

read

List wiki pages (browse).

Required paramsorganizationprojectwikiIdentifier

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "wikiIdentifier": {
      "type": "string"
    },
    "path": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "wikiIdentifier"
  ]
}

createWikiPage

write

Create a new wiki page.

Required paramsorganizationprojectwikiIdentifierpathcontent

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "wikiIdentifier": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "content": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "wikiIdentifier",
    "path",
    "content"
  ]
}

updateWikiPage

write

Update wiki page content (requires eTag).

Required paramsorganizationprojectwikiIdentifierpathcontenteTag

Input schema

{
  "type": "object",
  "properties": {
    "organization": {
      "type": "string"
    },
    "project": {
      "type": "string"
    },
    "wikiIdentifier": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "content": {
      "type": "string"
    },
    "eTag": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "organization",
    "project",
    "wikiIdentifier",
    "path",
    "content",
    "eTag"
  ]
}