Microsoft Azure DevOps

the microsoft azure devops connector enables integration with azure devops services for managing development workflows and resources microsoft azure devops is a comprehensive suite of development tools and services for managing software projects this connector enables seamless integration with swimlane turbine, allowing users to automate work item management, streamline project tracking, and enhance collaboration by leveraging this integration, swimlane turbine users can efficiently manage work items, queries, and user administration tasks within azure devops, enhancing productivity and reducing manual effort prerequisites before you can use the microsoft azure devops connector for turbine, you'll need access to the azure devops api this requires the following http basic authentication using the following parameters username the username associated with your azure devops account personal access token (pat) a token used to authenticate api requests url the base url for your azure devops organization capabilities this connector provides the following capabilities delete user get organizations list get user entitlements get user get users list list pats revoke pats notes azure devops api documentation https //learn microsoft com/en us/rest/api/azure/devops/account/accounts/list?view=azure devops rest 7 2\&tabs=http configurations http basic authentication authenticates using username and pat configuration parameters parameter description type required url url string required username username string required password personal access token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add work item comment add a plain text comment to a work item in microsoft azure devops using organization, project, workitemid, api version, and text endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems/{{workitemid}}/comments method post input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters workitemid number required id of a work item parameters api version string required version of the api to use this should be set to '7 2 preview\ 4' to use this version of the api text string optional the text of the comment input example {"path parameters" {"organization" "string","project" "string","workitemid" 123},"parameters" {"api version" "7 2 preview\ 4"},"text" "string"} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text workitemid number unique identifier commentid number unique identifier version number output field version text string output field text renderedtext string output field renderedtext format string output field format isdeleted boolean output field isdeleted url string url endpoint for the request createddate string date value modifieddate string date value createdby object output field createdby createdby displayname string name of the resource createdby id string unique identifier createdby uniquename string name of the resource createdby url string url endpoint for the request createdby imageurl string url endpoint for the request createdby descriptor string output field createdby descriptor createdby links object output field createdby links modifiedby object output field modifiedby modifiedby displayname string name of the resource modifiedby id string unique identifier modifiedby uniquename string name of the resource output example {"workitemid" 123,"commentid" 123,"version" 123,"text" "string","renderedtext" "string","format" "string","isdeleted"\ true,"url" "https //example com/api/resource","createddate" "string","modifieddate" "string","createdby" {"displayname" "example name","id" "12345678 1234 1234 1234 123456789abc","uniquename" "example name","url" "https //example com/api/resource","imageurl" "string","descriptor" "string"," links" {}},"modifiedby" {"displayname" "example name","id" "12345678 1234 1234 1234 123456 add work item comment with format add a formatted comment to a work item in microsoft azure devops requires organization, project, workitemid, api version, and text endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems/{{workitemid}}/comments method post input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters workitemid number required id of a work item parameters api version string required version of the api to use this should be set to '7 2 preview\ 4' to use this version of the api parameters format string optional format used for the comment text (markdown or html) text string optional the text of the comment input example {"path parameters" {"organization" "string","project" "string","workitemid" 123},"parameters" {"api version" "7 2 preview\ 4","format" "string"},"text" "string"} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text workitemid number unique identifier commentid number unique identifier version number output field version text string output field text renderedtext string output field renderedtext format string output field format isdeleted boolean output field isdeleted url string url endpoint for the request createddate string date value modifieddate string date value createdby object output field createdby createdby displayname string name of the resource createdby id string unique identifier createdby uniquename string name of the resource createdby url string url endpoint for the request createdby imageurl string url endpoint for the request createdby descriptor string output field createdby descriptor createdby links object output field createdby links modifiedby object output field modifiedby modifiedby displayname string name of the resource modifiedby id string unique identifier modifiedby uniquename string name of the resource output example {"workitemid" 123,"commentid" 123,"version" 123,"text" "string","renderedtext" "string","format" "string","isdeleted"\ true,"url" "https //example com/api/resource","createddate" "string","modifieddate" "string","createdby" {"displayname" "example name","id" "12345678 1234 1234 1234 123456789abc","uniquename" "example name","url" "https //example com/api/resource","imageurl" "string","descriptor" "string"," links" {}},"modifiedby" {"displayname" "example name","id" "12345678 1234 1234 1234 123456 create field create a work item tracking field in microsoft azure devops using organization, project, and api version parameters endpoint url /{{organization}}/{{project}}/ apis/wit/fields method post input argument name type required description parameters api version string required version of the api to use this should be set to '7 2 preview\ 3' to use this version of the api path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name links object optional link references to related rest resources cansortby boolean optional indicates whether the field is sortable in server queries description string optional the description of the field isdeleted boolean optional indicates whether this field is deleted isidentity boolean optional indicates whether this field is an identity field islocked boolean optional indicates whether this field is marked as locked for editing ispicklist boolean optional indicates whether this instance is picklist ispicklistsuggested boolean optional indicates whether this instance is a suggested picklist isqueryable boolean optional indicates whether the field can be queried in the server name string optional the name of the field picklistid string optional if this field is picklist, the identifier of the picklist associated, otherwise null readonly boolean optional indicates whether the field is \[read only] referencename string optional name of the resource supportedoperations array optional the supported operations on this field supportedoperations name string optional friendly name of the operation supportedoperations referencename string optional reference name of the operation type string optional the type of the field url string optional rest url for the resource usage string optional the usage of the field input example {"parameters" {"api version" "7 2 preview\ 3"},"json body" {" links" {},"cansortby"\ false,"description" "test field","isdeleted"\ false,"isidentity"\ false,"islocked"\ false,"ispicklist"\ false,"ispicklistsuggested"\ false,"isqueryable"\ false,"name" "test field","picklistid" "fb1c8e5c 9a3d 4e7b 9f0c 1a2b3c4d5e6f","readonly"\ false,"referencename" "testfield","supportedoperations" \[{"name" "test field","referencename" "testfield"}],"type" "string","url" "https //dev azure com/test org/test project/ apis/wit/fields/testfield","usage" "workitem"},"path parameters" {"organization" "test org","project" "test project"}} output parameter type description status code number http status code of the response reason string response reason phrase links object output field links cansortby boolean output field cansortby description string output field description isdeleted boolean output field isdeleted isidentity boolean unique identifier islocked boolean output field islocked ispicklist boolean output field ispicklist ispicklistsuggested boolean output field ispicklistsuggested isqueryable boolean output field isqueryable name string name of the resource picklistid string unique identifier readonly boolean output field readonly referencename string name of the resource supportedoperations array output field supportedoperations supportedoperations name string name of the resource supportedoperations referencename string name of the resource output example {"status code" 201,"reason" "created","json body" {" links" {},"cansortby"\ false,"description" "test field","isdeleted"\ false,"isidentity"\ false,"islocked"\ false,"ispicklist"\ false,"ispicklistsuggested"\ false,"isqueryable"\ false,"name" "test field","picklistid" "fb1c8e5c 9a3d 4e7b 9f0c 1a2b3c4d5e6f","readonly"\ false,"referencename" "testfield","supportedoperations" \[{}]}} create queries create work item tracking queries in microsoft azure devops using organization, project, and query path parameters along with the api version parameter endpoint url /{{organization}}/{{project}}/ apis/wit/queries/{{query}} method post input argument name type required description parameters api version string required parameters for the create queries action parameters validatewiqlonly boolean optional parameters for the create queries action path parameters organization string required the name of the azure devops organization path parameters project string required the name of the azure devops project path parameters query string required the id of the query to create links object optional link references to related rest resources children array optional the child query items inside a query folder clauses object optional the clauses for a flat query clauses logicaloperator string optional the logical operator for the clauses clauses clauses array optional the clauses for the query clauses clauses field object optional the field for the clause clauses clauses field referencename string optional the reference name of the field clauses clauses field name string optional the name of the field clauses clauses field url string optional the url of the field clauses clauses operator object optional the operator for the clause clauses clauses operator referencename string optional the reference name of the operator clauses clauses operator name string optional the name of the operator clauses clauses value string optional the value for the clause clauses clauses isfieldvalue boolean optional whether the value is a field value columns array optional the columns for the query columns referencename string optional the reference name of the column columns name string optional the name of the column columns url string optional the url of the column createdby object optional the identity who created the query item createdby displayname string optional the display name of the identity input example {"parameters" {"api version" "7 2 preview\ 2","validatewiqlonly"\ false},"path parameters" {"organization" "fabrikam","project" "fabrikam fiber git","query" "shared queries"}} output parameter type description status code number http status code of the response reason string response reason phrase links object output field links children array output field children children file name string name of the resource children file string output field children file clauses object output field clauses columns array output field columns columns file name string name of the resource columns file string output field columns file createdby object output field createdby createdby links object output field createdby links createdby descriptor string output field createdby descriptor createdby directoryalias string output field createdby directoryalias createdby displayname string name of the resource createdby id string unique identifier createdby imageurl string url endpoint for the request createdby inactive string output field createdby inactive createdby isaadidentity string unique identifier createdby iscontainer string output field createdby iscontainer createdby isdeletedinorigin string output field createdby isdeletedinorigin createdby name string name of the resource createdby profileurl string url endpoint for the request createdby uniquename string name of the resource createdby url string url endpoint for the request output example {" links" {},"children" \[{"file name" "example name","file" "string"}],"clauses" {},"columns" \[{"file name" "example name","file" "string"}],"createdby" {" links" {},"descriptor" "string","directoryalias" "string","displayname" "example name","id" "12345678 1234 1234 1234 123456789abc","imageurl" "string","inactive" "string","isaadidentity" "string","iscontainer" "string","isdeletedinorigin" "string","name" "example name","profileurl" "string","uniquename" "example name","url" "https //example c create work item create a work item in microsoft azure devops using json patch operations requires organization, project, and type as path parameters, and api version as a parameter endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems/${{type}} method post input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters type string required the work item type of the work item to create parameters api version string required version of the api to use this should be set to '7 2 preview\ 3' to use this version of the api parameters validateonly boolean optional indicate if you only want to validate the changes without saving the work item parameters bypassrules boolean optional do not enforce the work item type rules on this update parameters suppressnotifications boolean optional do not fire any notifications for this change parameters $expand string optional the expand parameters for work item attributes possible options are { none, relations, fields, links, all } input example {"path parameters" {"organization" "string","project" "string","type" "string"},"parameters" {"api version" "7 2 preview\ 3","validateonly"\ true,"bypassrules"\ true,"suppressnotifications"\ true,"$expand" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text id number unique identifier rev number output field rev fields object output field fields relations array output field relations url string url endpoint for the request links object output field links output example {"id" 123,"rev" 123,"fields" {},"relations" \[],"url" "https //example com/api/resource"," links" {}} create work item attachment upload a work item attachment stream to microsoft azure devops wit api requires organization, project, api version, and file data endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/attachments method post input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name parameters api version string required version of the api to use this should be set to '7 2 preview\ 4' to use this version of the api parameters filename string optional the name of the file parameters uploadtype string optional attachment upload type simple or chunked parameters areapath string optional target project area path file data array required binary file content for application or octet stream upload file data file name string required name of the file being uploaded file data file string required binary file content sent as the request body input example {"path parameters" {"organization" "string","project" "string"},"parameters" {"api version" "7 2 preview\ 4","filename" "example name","uploadtype" "string","areapath" "string"},"file data" \[{"file name" "example name","file" "string"}]} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text id string unique identifier url string url endpoint for the request output example {"id" "12345678 1234 1234 1234 123456789abc","url" "https //example com/api/resource"} delete fields delete work item tracking fields in microsoft azure devops using organization, project, and field name or reference name requires api version endpoint url /{{organization}}/{{project}}/ apis/wit/fields/{{fieldnameorrefname}} method delete input argument name type required description parameters api version string required version of the api to use this should be set to '7 2 preview\ 3' to use this version of the api path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters fieldnameorrefname string required field simple name or reference name input example {"parameters" {"api version" "7 2 preview\ 3"},"path parameters" {"organization" "org123","project" "new test project","fieldnameorrefname" "testfield"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" {}} delete queries delete a query or folder in microsoft azure devops using organization, project, and query path parameters along with the api version parameter endpoint url /{{organization}}/{{project}}/ apis/wit/queries/{{query}} method delete input argument name type required description parameters api version string required the version of the api to use path parameters organization string required parameters for the delete queries action path parameters project string required the name of the azure devops project path parameters query string required the id of the query to delete input example {"parameters" {"api version" "7 2 preview\ 3"},"path parameters" {"organization" "org123","project" "project123","query" "testquery"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" {}} delete user remove a specified user from an azure devops organization using their userid requires organization, userid as path parameters and api version as a parameter endpoint url https //vsaex dev azure com/{{organization}}/ apis/userentitlements/{{userid}} method delete input argument name type required description path parameters organization string required parameters for the delete user action path parameters userid string required parameters for the delete user action parameters api version string required parameters for the delete user action input example {"parameters" {"api version" "7 1 preview\ 3"},"path parameters" {"organization" "swimlane test","userid" "ztlinme5m2mtntyxmc03owqyltg4zmmtntjhzde2zti2nmqw"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text output example {"status code" 200,"response headers" {"cache control" "no cache, no store, must revalidate","pragma" "no cache","expires" " 1","p3p" "cp=\\"cao dsp cor adma dev cono telo cur psa psd tai ivdo our sami bus dem nav sta ","set cookie" "vstssession=%7b%22persistentsessionid%22%3a%2209cd44b8 efd8 4435 ac5f cbfc5411f9 ","x tfs processid" "c031a33a df9e 4fe9 83dd 6d9bb2d000d4","strict transport security" "max age=31536000; includesubdomains","activityid" "0e5a0902 6357 4e49 a012 4b020e217769","x tf delete work item delete or permanently destroy a work item in microsoft azure devops using organization, project, id, and api version parameters endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems/{{id}} method delete input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters id number required id of the work item to be deleted parameters api version string required version of the api to use this should be set to '7 2 preview\ 3' to use this version of the api parameters destroy boolean optional optional parameter, if set to true, the work item is deleted permanently please note the destroy action is permanent and cannot be undone input example {"path parameters" {"organization" "string","project" "string","id" 123},"parameters" {"api version" "7 2 preview\ 3","destroy"\ true}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text id number unique identifier code number output field code name string name of the resource project string output field project url string url endpoint for the request resource object output field resource output example {"id" 123,"code" 123,"name" "example name","project" "string","url" "https //example com/api/resource","resource" {}} delete work item attachment delete a work item attachment in microsoft azure devops using organization, project, id, and api version endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/attachments/{{id}} method delete input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters id string required attachment id parameters api version string required version of the api to use this should be set to '7 2 preview\ 4' to use this version of the api input example {"path parameters" {"organization" "string","project" "string","id" "12345678 1234 1234 1234 123456789abc"},"parameters" {"api version" "7 2 preview\ 4"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text id string unique identifier url string url endpoint for the request links object output field links output example {"id" "12345678 1234 1234 1234 123456789abc","url" "https //example com/api/resource"," links" {}} delete work item comment remove a comment from a work item in microsoft azure devops using the wit api requires organization, project, workitemid, and commentid as path parameters and api version as a parameter endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems/{{workitemid}}/comments/{{commentid}} method delete input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters workitemid number required id of a work item path parameters commentid number required id of the comment to delete parameters api version string required version of the api to use this should be set to '7 2 preview\ 4' to use this version of the api input example {"path parameters" {"organization" "string","project" "string","workitemid" 123,"commentid" 123},"parameters" {"api version" "7 2 preview\ 4"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text workitemid number unique identifier commentid number unique identifier version number output field version text string output field text renderedtext string output field renderedtext format string output field format isdeleted boolean output field isdeleted url string url endpoint for the request createddate string date value modifieddate string date value createdby object output field createdby createdby displayname string name of the resource createdby id string unique identifier createdby uniquename string name of the resource createdby url string url endpoint for the request createdby imageurl string url endpoint for the request createdby descriptor string output field createdby descriptor createdby links object output field createdby links modifiedby object output field modifiedby modifiedby displayname string name of the resource modifiedby id string unique identifier modifiedby uniquename string name of the resource output example {"workitemid" 123,"commentid" 123,"version" 123,"text" "string","renderedtext" "string","format" "string","isdeleted"\ true,"url" "https //example com/api/resource","createddate" "string","modifieddate" "string","createdby" {"displayname" "example name","id" "12345678 1234 1234 1234 123456789abc","uniquename" "example name","url" "https //example com/api/resource","imageurl" "string","descriptor" "string"," links" {}},"modifiedby" {"displayname" "example name","id" "12345678 1234 1234 1234 123456 delete work items delete multiple work items in microsoft azure devops using organization, project, api version, and item ids endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitemsdelete method post input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name parameters api version string required version of the api to use this should be set to '7 2 preview\ 1' to use this version of the api ids array optional the requested work item ids destroy boolean optional optional parameter, if set to true, the work item is deleted permanently please note the destroy action is permanent and cannot be undone skipnotifications boolean optional optional parameter, if set to true, notifications will be disabled input example {"path parameters" {"organization" "string","project" "string"},"parameters" {"api version" "7 2 preview\ 1"},"ids" \[123],"destroy"\ true,"skipnotifications"\ true} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text count number count value value array value for the parameter output example {"count" 123,"value" \[]} get fields retrieve work item tracking fields in microsoft azure devops using organization, project, field name or reference name, and api version endpoint url /{{organization}}/{{project}}/ apis/wit/fields/{{fieldnameorrefname}} method get input argument name type required description parameters api version string required version of the api to use this should be set to '7 2 preview\ 3' to use this version of the api path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters fieldnameorrefname string required field simple name or reference name input example {"parameters" {"api version" "7 2 preview\ 3"},"path parameters" {"organization" "org123","project" "new test project","fieldnameorrefname" "testfield"}} output parameter type description status code number http status code of the response reason string response reason phrase links object output field links cansortby boolean output field cansortby description string output field description isdeleted boolean output field isdeleted isidentity boolean unique identifier islocked boolean output field islocked ispicklist boolean output field ispicklist ispicklistsuggested boolean output field ispicklistsuggested isqueryable boolean output field isqueryable name string name of the resource picklistid string unique identifier readonly boolean output field readonly referencename string name of the resource supportedoperations array output field supportedoperations supportedoperations name string name of the resource supportedoperations referencename string name of the resource type string type of the resource url string url endpoint for the request usage string output field usage output example {"status code" 200,"reason" "ok","json body" {" links" {},"cansortby"\ false,"description" "test field for demonstration purposes","isdeleted"\ false,"isidentity"\ false,"islocked"\ false,"ispicklist"\ false,"ispicklistsuggested"\ false,"isqueryable"\ true,"name" "testfield","picklistid" "fb1c8e5c 9a3d 4e7b 9f0c 1a2b3c4d5e6f","readonly"\ false,"referencename" "testfield","supportedoperations" \[{}],"type" "string"}} get organizations list retrieve a list of organizations in microsoft azure devops using specified organization, api version, and contribution ids endpoint url https //dev azure com/{{organization}}/ apis/contribution/hierarchyquery method post input argument name type required description path parameters organization string required parameters for the get organizations list action parameters api version string required parameters for the get organizations list action contributionids array optional unique identifier dataprovidercontext object optional response data dataprovidercontext properties object optional response data input example {"parameters" {"api version" "7 1 preview\ 1"},"json body" {"contributionids" \["ms vss features my organizations data provider"],"dataprovidercontext" {"properties" {}}},"path parameters" {"organization" "swimlane test"}} output parameter type description status code number http status code of the response reason string response reason phrase dataprovidershareddata object response data dataprovidershareddata featureflags object response data dataprovidershareddata featureflags visualstudio services adminengagement organizationoverview\ editableorganizationavatar boolean response data dataproviders object response data dataproviders ms vss web component data object response data dataproviders ms vss web shared data object response data dataproviders ms vss features my organizations data provider object response data dataproviders ms vss features my organizations data provider organizations array response data dataproviders ms vss features my organizations data provider organizations id string response data dataproviders ms vss features my organizations data provider organizations name string response data dataproviders ms vss features my organizations data provider organizations url string response data dataproviders ms vss features my organizations data provider organizations avatarurl string response data dataproviders ms vss features my organizations data provider mostrecentlyaccessedhosts array response data dataproviders ms vss features my organizations data provider createneworgurl string response data dataproviders ms vss features my organizations data provider isuseraccountmappingrequired boolean response data output example {"status code" 200,"response headers" {"cache control" "no cache, no store, must revalidate","pragma" "no cache","content length" "582","content type" "application/json; charset=utf 8; api version=7 1 preview\ 1","content encoding" "gzip","expires" " 1","vary" "accept encoding","p3p" "cp=\\"cao dsp cor adma dev cono telo cur psa psd tai ivdo our sami bus dem nav sta ","set cookie" "vstssession=%7b%22persistentsessionid%22%3a%22bbd6aa66 fe47 41db 8044 6920e694f3 ","x tfs processid" "183dff5b 2a get queries get work item tracking queries from microsoft azure devops using organization, project, query path parameters, and api version parameter endpoint url /{{organization}}/{{project}}/ apis/wit/queries/{{query}} method get input argument name type required description parameters api version string required the version of the api to use parameters $depth number optional the depth of the query to get parameters $expand string optional the fields to expand parameters $includedeleted boolean optional whether to include deleted queries parameters $useisodateformat boolean optional whether to use iso date format path parameters organization string required the name of the azure devops organization path parameters project string required the name of the azure devops project path parameters query string required the id of the query to get input example {"parameters" {"api version" "7 2 preview\ 3","$depth" 2,"$expand" "wiql","$includedeleted"\ true,"$useisodateformat"\ true},"path parameters" {"organization" "org123","project" "project123","query" "testquery"}} output parameter type description status code number http status code of the response reason string response reason phrase links object output field links children array output field children children file name string name of the resource children file string output field children file clauses object output field clauses columns array output field columns columns file name string name of the resource columns file string output field columns file createdby object output field createdby createdby links object output field createdby links createdby descriptor string output field createdby descriptor createdby directoryalias string output field createdby directoryalias createdby displayname string name of the resource createdby id string unique identifier createdby imageurl string url endpoint for the request createdby inactive string output field createdby inactive createdby isaadidentity string unique identifier createdby iscontainer string output field createdby iscontainer createdby isdeletedinorigin string output field createdby isdeletedinorigin createdby name string name of the resource createdby profileurl string url endpoint for the request createdby uniquename string name of the resource createdby url string url endpoint for the request output example {"status code" 200,"reason" "ok","json body" {" links" {},"children" \[],"clauses" {},"columns" \[],"createdby" {" links" {},"descriptor" "aad ohvjn2e3njytnwjhny03yjgxltlhmmutywjjzgvmz2hpams=","directoryalias" "alice","displayname" "alice developer","id" "12345678 90ab cdef 1234 567890abcdef","imageurl" "https //dev azure com/test org/ api/ common/graphprofile/memberavatars/aad ohvjn ","inactive" "false","isaadidentity" "true","iscontainer" "false","isdeletedinorigin" "false","name" "alice devel get queries batch get a batch of work item tracking queries in microsoft azure devops using organization, project, and api version parameters endpoint url /{{organization}}/{{project}}/ apis/wit/queriesbatch method post input argument name type required description parameters api version string required the version of the api to use path parameters organization string required the name of the azure devops organization path parameters project string required the name of the azure devops project $expand string optional the fields to expand errorpolicy string optional the policy to use when errors occur ids array optional the ids of the queries to get input example {"parameters" {"api version" "7 2 preview\ 3"},"json body" {"$expand" "all","errorpolicy" "fail","ids" \["c6725763 d9ae 487e bb42 00222e2f4d9f","c19eec2d 07a0 4c20 be57 3f7903792ca6","298f94fd 30ea 40f3 8d25 3202c9effa3a"]},"path parameters" {"organization" "string","project" "project123"}} output parameter type description status code number http status code of the response reason string response reason phrase count number count value value array value for the parameter value id string unique identifier value name string name of the resource value path string value for the parameter value createdby object value for the parameter value createdby displayname string name of the resource value createdby url string url endpoint for the request value createdby links object value for the parameter value createdby links avatar object value for the parameter value createdby links avatar href string value for the parameter value createdby id string unique identifier value createdby uniquename string name of the resource value createdby imageurl string url endpoint for the request value createdby descriptor string value for the parameter value createddate string value for the parameter value lastmodifiedby object value for the parameter value lastmodifiedby displayname string name of the resource value lastmodifiedby url string url endpoint for the request value lastmodifiedby links object value for the parameter value lastmodifiedby links avatar object value for the parameter value lastmodifiedby links avatar href string value for the parameter value lastmodifiedby id string unique identifier output example {"status code" 200,"reason" "ok","json body" {"count" 3,"value" \[{},{},{}]}} get user fetch a specific user's details from microsoft azure devops using their descriptor and organization information requires organization, userdescriptor, and api version parameters endpoint url https //vssps dev azure com/{{organization}}/ apis/graph/users/{{userdescriptor}} method get input argument name type required description path parameters organization string required parameters for the get user action path parameters userdescriptor string required parameters for the get user action parameters api version string required parameters for the get user action input example {"parameters" {"api version" "7 1 preview\ 1"},"path parameters" {"organization" "swimlane test","userdescriptor" "msa ztlinme5m2mtntyxmc03owqyltg4zmmtntjhzde2zti2nmqw"}} output parameter type description status code number http status code of the response reason string response reason phrase subjectkind string output field subjectkind domain string output field domain principalname string name of the resource mailaddress string output field mailaddress origin string output field origin originid string unique identifier displayname string name of the resource links object output field links links self object output field links self links self href string output field links self href links memberships object output field links memberships links memberships href string output field links memberships href links membershipstate object output field links membershipstate links membershipstate href string output field links membershipstate href links storagekey object output field links storagekey links storagekey href string output field links storagekey href links avatar object output field links avatar links avatar href string output field links avatar href url string url endpoint for the request descriptor string output field descriptor output example {"subjectkind" "string","domain" "string","principalname" "example name","mailaddress" "string","origin" "string","originid" "string","displayname" "example name"," links" {"self" {"href" "string"},"memberships" {"href" "string"},"membershipstate" {"href" "string"},"storagekey" {"href" "string"},"avatar" {"href" "string"}},"url" "https //example com/api/resource","descriptor" "string"} get user entitlements retrieve entitlement information for a specified user in a microsoft azure devops organization, requiring organization id, user id, and api version endpoint url https //vsaex dev azure com/{{organization}}/ apis/userentitlements/{{userid}} method get input argument name type required description path parameters organization string required parameters for the get user entitlements action path parameters userid string required parameters for the get user entitlements action parameters api version string required parameters for the get user entitlements action input example {"parameters" {"api version" "7 1 preview\ 3"},"path parameters" {"organization" "swimlane test","userid" "ztlinme5m2mtntyxmc03owqyltg4zmmtntjhzde2zti2nmqw"}} output parameter type description id string unique identifier user object output field user user subjectkind string output field user subjectkind user metatype string type of the resource user domain string output field user domain user principalname string name of the resource user mailaddress string output field user mailaddress user origin string output field user origin user originid string unique identifier user displayname string name of the resource user links object output field user links user links self object output field user links self user links self href string output field user links self href user links memberships object output field user links memberships user links memberships href string output field user links memberships href user links membershipstate object output field user links membershipstate user links membershipstate href string output field user links membershipstate href user links storagekey object output field user links storagekey user links storagekey href string output field user links storagekey href user url string url endpoint for the request user descriptor string output field user descriptor accesslevel object output field accesslevel accesslevel licensingsource string output field accesslevel licensingsource accesslevel accountlicensetype string type of the resource accesslevel msdnlicensetype string type of the resource output example {"id" "fe2f1bdb 9779 491a a6f6 c6e9322cfb00","user" {"subjectkind" "user","metatype" "member","domain" "14c5367e ee12 4c94 98b8 b52c1fe3cfb1","principalname" "user1\@fabrikam com","mailaddress" "user1\@fabrikam com","origin" "aad","originid" "00000000 0000 0000 0000 000000000000","displayname" "user 1"," links" {"self" {},"memberships" {},"membershipstate" {},"storagekey" {}},"url" "https //vssps dev azure com/fabrikam/ apis/graph/users/aad wugm3idz1utzzczntktzm ","descriptor" "aad wugm3idz1utzz get users list retrieve a list of all users within the specified organization in microsoft azure devops requires 'organization' as a path parameter and 'api version' as a parameter endpoint url https //vssps dev azure com/{{organization}}/ apis/graph/users method get input argument name type required description path parameters organization string required parameters for the get users list action parameters api version string required parameters for the get users list action parameters continuationtoken string optional parameters for the get users list action parameters scopedescriptor string optional parameters for the get users list action parameters subjecttypes array optional parameters for the get users list action input example {"path parameters" {"organization" "swimlane test"}} output parameter type description status code number http status code of the response reason string response reason phrase count number count value value array value for the parameter value subjectkind string value for the parameter value domain string value for the parameter value principalname string name of the resource value mailaddress string value for the parameter value origin string value for the parameter value originid string unique identifier value displayname string name of the resource value links object value for the parameter value links self object value for the parameter value links self href string value for the parameter value links memberships object value for the parameter value links memberships href string value for the parameter value links membershipstate object value for the parameter value links membershipstate href string value for the parameter value links storagekey object value for the parameter value links storagekey href string value for the parameter value links avatar object value for the parameter value links avatar href string value for the parameter value url string url endpoint for the request value descriptor string value for the parameter output example {"count" 123,"value" \[{"subjectkind" "string","domain" "string","principalname" "example name","mailaddress" "string","origin" "string","originid" "string","displayname" "example name"," links" {},"url" "https //example com/api/resource","descriptor" "string"}]} get work item retrieve a work item from microsoft azure devops using its identifier and optional fields requires organization, project, id, and api version as inputs endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems/{{id}} method get input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters id number required the work item id parameters api version string required version of the api to use this should be set to '7 2 preview\ 3' to use this version of the api parameters fields string optional comma separated list of requested fields parameters asof string optional asof utc date time string parameters $expand string optional the expand parameters for work item attributes possible options are { none, relations, fields, links, all } input example {"path parameters" {"organization" "string","project" "string","id" 123},"parameters" {"api version" "7 2 preview\ 3","fields" "string","asof" "string","$expand" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text id number unique identifier rev number output field rev fields object output field fields relations array output field relations url string url endpoint for the request links object output field links output example {"id" 123,"rev" 123,"fields" {},"relations" \[],"url" "https //example com/api/resource"," links" {}} get work item attachment download work item attachment content from microsoft azure devops wit using organization, project, id, and api version as inputs endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/attachments/{{id}} method get input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters id string required attachment id parameters api version string required version of the api to use this should be set to '7 2 preview\ 4' to use this version of the api parameters filename string optional name of the file parameters download boolean optional if set to true always download attachment input example {"path parameters" {"organization" "string","project" "string","id" "12345678 1234 1234 1234 123456789abc"},"parameters" {"api version" "7 2 preview\ 4","filename" "example name","download"\ true}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text message string response message typekey string type of the resource errorcode number error message if any eventid number unique identifier output example {"message" "string","typekey" "string","errorcode" 123,"eventid" 123} get work item comment retrieve a specific work item comment from microsoft azure devops using organization, project, workitemid, and commentid as path parameters, along with the api version parameter endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems/{{workitemid}}/comments/{{commentid}} method get input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters workitemid number required id of a work item to get the comment path parameters commentid number required id of the comment to return parameters api version string required version of the api to use this should be set to '7 2 preview\ 4' to use this version of the api parameters includedeleted boolean optional specify if the deleted comment should be retrieved parameters $expand string optional specifies the additional data retrieval options for work item comments input example {"path parameters" {"organization" "string","project" "string","workitemid" 123,"commentid" 123},"parameters" {"api version" "7 2 preview\ 4","includedeleted"\ true,"$expand" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text workitemid number unique identifier commentid number unique identifier version number output field version text string output field text renderedtext string output field renderedtext format string output field format isdeleted boolean output field isdeleted url string url endpoint for the request createddate string date value modifieddate string date value createdby object output field createdby createdby displayname string name of the resource createdby id string unique identifier createdby uniquename string name of the resource createdby url string url endpoint for the request createdby imageurl string url endpoint for the request createdby descriptor string output field createdby descriptor createdby links object output field createdby links modifiedby object output field modifiedby modifiedby displayname string name of the resource modifiedby id string unique identifier modifiedby uniquename string name of the resource output example {"workitemid" 123,"commentid" 123,"version" 123,"text" "string","renderedtext" "string","format" "string","isdeleted"\ true,"url" "https //example com/api/resource","createddate" "string","modifieddate" "string","createdby" {"displayname" "example name","id" "12345678 1234 1234 1234 123456789abc","uniquename" "example name","url" "https //example com/api/resource","imageurl" "string","descriptor" "string"," links" {}},"modifiedby" {"displayname" "example name","id" "12345678 1234 1234 1234 123456 get work item comments retrieve a pageable list of comments for a specific work item in microsoft azure devops requires organization, project, workitemid as path parameters and api version as a parameter endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems/{{workitemid}}/comments method get input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters workitemid number required id of a work item to get comments for parameters api version string required version of the api to use this should be set to '7 2 preview\ 4' to use this version of the api parameters $top number optional max number of comments to return parameters continuationtoken string optional used to query for the next page of comments parameters includedeleted boolean optional specify if the deleted comments should be retrieved parameters $expand string optional specifies the additional data retrieval options for work item comments parameters order string optional order in which the comments should be returned input example {"path parameters" {"organization" "string","project" "string","workitemid" 123},"parameters" {"api version" "7 2 preview\ 4","$top" 123,"continuationtoken" "string","includedeleted"\ true,"$expand" "string","order" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text comments array output field comments comments workitemid number unique identifier comments commentid number unique identifier comments version number output field comments version comments text string output field comments text comments renderedtext string output field comments renderedtext comments isdeleted boolean output field comments isdeleted comments url string url endpoint for the request comments createddate string date value comments createdby object output field comments createdby comments createdby displayname string name of the resource comments createdby id string unique identifier comments createdby uniquename string name of the resource comments createdby url string url endpoint for the request count number count value totalcount number count value continuationtoken string output field continuationtoken nextpage string output field nextpage url string url endpoint for the request links object output field links output example {"comments" \[{"workitemid" 123,"commentid" 123,"version" 123,"text" "string","renderedtext" "string","isdeleted"\ true,"url" "https //example com/api/resource","createddate" "string","createdby" {}}],"count" 123,"totalcount" 123,"continuationtoken" "string","nextpage" "string","url" "https //example com/api/resource"," links" {}} get work item comments batch retrieve comments for specified work items in microsoft azure devops using organization, project, workitemid, api version, and ids as inputs endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems/{{workitemid}}/comments method get input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters workitemid number required id of a work item to get comments for parameters api version string required version of the api to use this should be set to '7 2 preview\ 4' to use this version of the api parameters ids string required comma separated list of comment ids to return parameters includedeleted boolean optional specify if the deleted comments should be retrieved parameters $expand string optional specifies the additional data retrieval options for work item comments input example {"path parameters" {"organization" "string","project" "string","workitemid" 123},"parameters" {"api version" "7 2 preview\ 4","ids" "string","includedeleted"\ true,"$expand" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text comments array output field comments comments workitemid number unique identifier comments commentid number unique identifier comments version number output field comments version comments text string output field comments text comments renderedtext string output field comments renderedtext comments isdeleted boolean output field comments isdeleted comments url string url endpoint for the request comments createddate string date value comments createdby object output field comments createdby comments createdby displayname string name of the resource comments createdby id string unique identifier comments createdby uniquename string name of the resource comments createdby url string url endpoint for the request count number count value totalcount number count value continuationtoken string output field continuationtoken nextpage string output field nextpage url string url endpoint for the request links object output field links output example {"comments" \[{"workitemid" 123,"commentid" 123,"version" 123,"text" "string","renderedtext" "string","isdeleted"\ true,"url" "https //example com/api/resource","createddate" "string","createdby" {}}],"count" 123,"totalcount" 123,"continuationtoken" "string","nextpage" "string","url" "https //example com/api/resource"," links" {}} get work item template retrieve a work item template for a specified type in microsoft azure devops requires organization, project, and type as path parameters and api version as a parameter endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems/${{type}} method get input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters type string required the work item type name parameters api version string required version of the api to use this should be set to '7 2 preview\ 3' to use this version of the api parameters fields string optional comma separated list of requested fields parameters asof string optional asof utc date time string parameters $expand string optional the expand parameters for work item attributes possible options are { none, relations, fields, links, all } input example {"path parameters" {"organization" "string","project" "string","type" "string"},"parameters" {"api version" "7 2 preview\ 3","fields" "string","asof" "string","$expand" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text id number unique identifier rev number output field rev fields object output field fields relations array output field relations url string url endpoint for the request links object output field links output example {"id" 123,"rev" 123,"fields" {},"relations" \[],"url" "https //example com/api/resource"," links" {}} get work item type field get a field definition for a work item type in microsoft azure devops using organization, project, type, field, and api version parameters endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitemtypes/{{type}}/fields/{{field}} method get input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters type string required work item type path parameters field string required field reference name of the work item field parameters api version string required version of the api to use this should be set to '7 2 preview\ 3' to use this version of the api parameters $expand string optional expand level for the api response properties to include allowedvalues, default value, isrequired etc as a part of response; none to skip these properties input example {"path parameters" {"organization" "string","project" "string","type" "string","field" "string"},"parameters" {"api version" "7 2 preview\ 3","$expand" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text alwaysrequired boolean output field alwaysrequired allowedvalues array value for the parameter dependentfields array output field dependentfields helptext string output field helptext name string name of the resource referencename string name of the resource type string type of the resource url string url endpoint for the request links object output field links output example {"alwaysrequired"\ true,"allowedvalues" \["string"],"dependentfields" \[],"helptext" "string","name" "example name","referencename" "example name","type" "string","url" "https //example com/api/resource"," links" {}} get work items batch retrieve multiple work items in microsoft azure devops using a batch request requires organization, project, api version, and ids endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitemsbatch method post input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name parameters api version string required version of the api to use this should be set to '7 2 preview\ 1' to use this version of the api ids array optional the requested work item ids fields array optional the requested fields asof string optional asof utc date time string $expand string optional the expand parameters for work item attributes possible options are { none, relations, fields, links, all } errorpolicy string optional the flag to control error policy in a bulk get work items request possible options are {fail, omit} input example {"path parameters" {"organization" "string","project" "string"},"parameters" {"api version" "7 2 preview\ 1"},"ids" \[123],"fields" \["string"],"asof" "string","$expand" "string","errorpolicy" "string"} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text output example \[] list fields retrieve a list of work item tracking fields in microsoft azure devops using organization, project, and api version parameters endpoint url /{{organization}}/{{project}}/ apis/wit/fields method get input argument name type required description parameters api version string required version of the api to use this should be set to '7 2 preview\ 3' to use this version of the api parameters $expand string optional use extensionfields to include extension fields, otherwise exclude them path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name input example {"parameters" {"api version" "7 2 preview\ 3","$expand" "extensionfields"},"path parameters" {"organization" "org123","project" "new test project"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" \[{" links" {},"cansortby"\ false,"description" "test field for demonstration purposes","isdeleted"\ false,"isidentity"\ false,"islocked"\ false,"ispicklist"\ false,"ispicklistsuggested"\ false,"isqueryable"\ true,"name" "testfield","picklistid" "fb1c8e5c 9a3d 4e7b 9f0c 1a2b3c4d5e6f","readonly"\ false,"referencename" "testfield","supportedoperations" \[],"type" "string"}]} list pats retrieve a list of personal access tokens (pats) for a specified user within a microsoft azure devops organization requires organization, user descriptor, and api version endpoint url https //vssps dev azure com/{{organization}}/ apis/tokenadmin/personalaccesstokens/{{userdescriptor}} method get input argument name type required description path parameters organization string required parameters for the list pats action path parameters userdescriptor string required parameters for the list pats action parameters api version string required parameters for the list pats action parameters continuationtoken string optional parameters for the list pats action parameters ispublic boolean optional parameters for the list pats action parameters pagesize number optional parameters for the list pats action input example {"path parameters" {"organization" "swimlane test","userdescriptor" "msa ztlinme5m2mtntyxmc03owqyltg4zmmtntjhzde2zti2nmqw"}} output parameter type description status code number http status code of the response reason string response reason phrase value array value for the parameter value clientid string unique identifier value accessid string unique identifier value authorizationid string unique identifier value hostauthorizationid string unique identifier value userid string unique identifier value validfrom string unique identifier value validto string unique identifier value displayname string name of the resource value scope string value for the parameter value targetaccounts array value for the parameter value token object value for the parameter value alternatetoken object value for the parameter value isvalid boolean unique identifier value ispublic boolean value for the parameter value publicdata object response data value source object value for the parameter value claims object value for the parameter continuationtoken object output field continuationtoken output example {"value" \[{"clientid" "string","accessid" "string","authorizationid" "string","hostauthorizationid" "string","userid" "string","validfrom" "string","validto" "string","displayname" "example name","scope" "string","targetaccounts" \[],"token" {},"alternatetoken" {},"isvalid"\ true,"ispublic"\ true,"publicdata" {}}],"continuationtoken" {}} list queries retrieve a list of work item tracking queries in microsoft azure devops using organization, project, and api version parameters endpoint url /{{organization}}/{{project}}/ apis/wit/queries method get input argument name type required description parameters api version string required the version of the api to use parameters $depth number optional the depth of the queries to list parameters $expand string optional the fields to expand parameters $includedeleted boolean optional whether to include deleted queries path parameters organization string required the name of the azure devops organization path parameters project string required the name of the azure devops project input example {"parameters" {"api version" "7 2 preview\ 3"},"path parameters" {"organization" "org123","project" "project123","$depth" 3,"$expand" "all","$includedeleted"\ true}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" \[{" links" {},"children" \[],"clauses" {},"columns" \[],"createdby" {},"createddate" "2014 03 18t17 18 36 06z","filteroptions" \[],"haschildren"\ false,"id" "342f0f44 4069 46b1 a940 3d0468979ceb","isdeleted"\ false,"isfolder"\ false,"isinvalidsyntax"\ false,"ispublic"\ true,"lastexecutedby" {},"lastexecuteddate" "2014 03 18t17 18 36 06z"}]} list work item type fields list field definitions for a work item type in microsoft azure devops requires organization, project, and type as path parameters, and api version as a parameter endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitemtypes/{{type}}/fields method get input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters type string required work item type parameters api version string required version of the api to use this should be set to '7 2 preview\ 3' to use this version of the api parameters $expand string optional expand level for the api response properties to include allowedvalues, default value, isrequired etc as a part of response; none to skip these properties input example {"path parameters" {"organization" "string","project" "string","type" "string"},"parameters" {"api version" "7 2 preview\ 3","$expand" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text count number count value value array value for the parameter value alwaysrequired boolean value for the parameter value allowedvalues array value for the parameter value helptext string value for the parameter value name string name of the resource value referencename string name of the resource value type string type of the resource value url string url endpoint for the request output example {"count" 123,"value" \[{"alwaysrequired"\ true,"allowedvalues" \[],"helptext" "string","name" "example name","referencename" "example name","type" "string","url" "https //example com/api/resource"}]} list work items retrieve work items from microsoft azure devops using organization, project, api version, and comma separated identifiers endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems method get input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name parameters api version string required version of the api to use this should be set to '7 2 preview\ 3' to use this version of the api parameters ids string required the comma separated list of requested work item ids (maximum 200 ids allowed) parameters fields string optional comma separated list of requested fields parameters asof string optional asof utc date time string parameters $expand string optional the expand parameters for work item attributes possible options are { none, relations, fields, links, all } parameters errorpolicy string optional the flag to control error policy in a bulk get work items request possible options are {fail, omit} input example {"path parameters" {"organization" "string","project" "string"},"parameters" {"api version" "7 2 preview\ 3","ids" "string","fields" "string","asof" "string","$expand" "string","errorpolicy" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text count number count value value array value for the parameter value id number unique identifier value rev number value for the parameter value fields object value for the parameter value relations array value for the parameter value url string url endpoint for the request output example {"count" 123,"value" \[{"id" 123,"rev" 123,"fields" {},"relations" \[],"url" "https //example com/api/resource"}]} revoke pats revoke personal access tokens in microsoft azure devops for a specified organization requires 'organization' as a path parameter and 'api version' as a parameter endpoint url https //vssps dev azure com/{{organization}}/ apis/tokenadmin/revocations method post input argument name type required description path parameters organization string required parameters for the revoke pats action parameters api version string required parameters for the revoke pats action parameters ispublic boolean optional parameters for the revoke pats action input example {"parameters" {"api version" "7 1 preview\ 1","ispublic"\ false},"json body" \[{"authorizationid" "532c7fe6 74f8 408b 8051 4abb73dca491"}],"path parameters" {"organization" "swimlane test"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text output example {"response text" "string"} search queries search for work item tracking queries in microsoft azure devops using organization, project, and api version parameters endpoint url /{{organization}}/{{project}}/ apis/wit/queries method get input argument name type required description parameters $api version string optional parameters for the search queries action parameters $filter string optional parameters for the search queries action parameters $top number optional parameters for the search queries action parameters $expand string optional parameters for the search queries action parameters $includedeleted boolean optional parameters for the search queries action path parameters organization string required the name of the azure devops organization path parameters project string required the name of the azure devops project input example {"parameters" {"$api version" "7 2 preview\ 3","$filter" "test","$top" 3,"$expand" "all","$includedeleted"\ true},"path parameters" {"organization" "org123","project" "project123"}} output parameter type description status code number http status code of the response reason string response reason phrase count number count value hasmore boolean output field hasmore value array value for the parameter value id string unique identifier value name string name of the resource value path string value for the parameter value createdby object value for the parameter value createdby displayname string name of the resource value createdby url string url endpoint for the request value createdby links object value for the parameter value createdby links avatar object value for the parameter value createdby links avatar href string value for the parameter value createdby id string unique identifier value createdby uniquename string name of the resource value createdby imageurl string url endpoint for the request value createdby descriptor string value for the parameter value createddate string value for the parameter value lastmodifiedby object value for the parameter value lastmodifiedby displayname string name of the resource value lastmodifiedby url string url endpoint for the request value lastmodifiedby links object value for the parameter value lastmodifiedby links avatar object value for the parameter value lastmodifiedby links avatar href string value for the parameter output example {"status code" 200,"reason" "ok","json body" {"count" 3,"hasmore"\ false,"value" \[{},{},{}]}} update fields update work item tracking fields in microsoft azure devops using organization, project, field name or reference name, and api version endpoint url /{{organization}}/{{project}}/ apis/wit/fields/{{fieldnameorrefname}} method patch input argument name type required description parameters api version string required version of the api to use this should be set to '7 2 preview\ 3' to use this version of the api path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters fieldnameorrefname string required name/reference name of the field to be updated isdeleted boolean optional indicates whether the user wants to restore the field islocked boolean optional indicates whether the user wants to lock the field input example {"parameters" {"api version" "7 2 preview\ 3"},"json body" {"isdeleted"\ false,"islocked"\ false},"path parameters" {"organization" "org123","project" "new test project","fieldnameorrefname" "testfield"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","json body" \[{" links" {},"cansortby"\ false,"description" "test field for demonstration purposes","isdeleted"\ false,"isidentity"\ false,"islocked"\ false,"ispicklist"\ false,"ispicklistsuggested"\ false,"isqueryable"\ true,"name" "testfield","picklistid" "fb1c8e5c 9a3d 4e7b 9f0c 1a2b3c4d5e6f","readonly"\ false,"referencename" "testfield","supportedoperations" \[],"type" "string"}]} update queries update work item tracking queries in microsoft azure devops using organization, project, and query path parameters along with the required api version endpoint url /{{organization}}/{{project}}/ apis/wit/queries/{{query}} method patch input argument name type required description parameters api version string required the version of the api to use parameters $undeletedescendants boolean optional whether to undelete descendants of the query path parameters organization string required the name of the azure devops organization path parameters project string required the name of the azure devops project path parameters query string required the id of the query to update links object optional link references to related rest resources children array optional the child query items inside a query folder clauses object optional the clauses for a flat query clauses logicaloperator string optional the logical operator for the clauses clauses clauses array optional the clauses for the query clauses clauses field object optional the field for the clause clauses clauses field referencename string optional the reference name of the field clauses clauses field name string optional the name of the field clauses clauses field url string optional the url of the field clauses clauses operator object optional the operator for the clause clauses clauses operator referencename string optional the reference name of the operator clauses clauses operator name string optional the name of the operator clauses clauses value string optional the value for the clause columns array optional the columns for the query columns referencename string optional the reference name of the column columns name string optional the name of the column columns url string optional the url of the column createdby object optional the identity who created the query item createdby displayname string optional the display name of the identity createdby url string optional the url of the identity input example {"parameters" {"api version" "7 2 preview\ 3","$undeletedescendants"\ true},"path parameters" {"organization" "org123","project" "project123","query" "testquery"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier name string name of the resource path string output field path createddate string date value lastmodifiedby object output field lastmodifiedby lastmodifiedby displayname string name of the resource lastmodifiedby url string url endpoint for the request lastmodifiedby links object link references to related rest resources lastmodifiedby id string unique identifier lastmodifiedby uniquename string name of the resource lastmodifiedby imageurl string url endpoint for the request lastmodifiedby descriptor string output field lastmodifiedby descriptor lastmodifieddate string date value querytype string type of the resource columns array output field columns columns referencename string name of the resource columns name string name of the resource columns url string url endpoint for the request sortcolumns array output field sortcolumns sortcolumns field object output field sortcolumns field sortcolumns field referencename string name of the resource sortcolumns field name string name of the resource sortcolumns field url string url endpoint for the request output example {"id" "12345678 1234 1234 1234 123456789abc","name" "example name","path" "string","createddate" "string","lastmodifiedby" {"displayname" "example name","url" "https //example com/api/resource"," links" {},"id" "12345678 1234 1234 1234 123456789abc","uniquename" "example name","imageurl" "string","descriptor" "string"},"lastmodifieddate" "string","querytype" "string","columns" \[{"referencename" "example name","name" "example name","url" "https //example com/api/resource"}],"sortcolumns" \[{"field update work item update a work item in microsoft azure devops using json patch operations requires organization, project, id as path parameters and api version as a parameter endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems/{{id}} method patch input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters id number required the id of the work item to update parameters api version string required version of the api to use this should be set to '7 2 preview\ 3' to use this version of the api parameters validateonly boolean optional indicate if you only want to validate the changes without saving the work item parameters bypassrules boolean optional do not enforce the work item type rules on this update parameters suppressnotifications boolean optional do not fire any notifications for this change parameters $expand string optional the expand parameters for work item attributes possible options are { none, relations, fields, links, all } input example {"path parameters" {"organization" "string","project" "string","id" 123},"parameters" {"api version" "7 2 preview\ 3","validateonly"\ true,"bypassrules"\ true,"suppressnotifications"\ true,"$expand" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text id number unique identifier rev number output field rev fields object output field fields relations array output field relations url string url endpoint for the request links object output field links output example {"id" 123,"rev" 123,"fields" {},"relations" \[],"url" "https //example com/api/resource"," links" {}} update work item comment update the text of an existing work item comment in microsoft azure devops using organization, project, workitemid, commentid, api version, and text endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems/{{workitemid}}/comments/{{commentid}} method patch input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters workitemid number required id of a work item path parameters commentid number required id of the comment to update parameters api version string required version of the api to use this should be set to '7 2 preview\ 4' to use this version of the api text string optional the updated text of the comment input example {"path parameters" {"organization" "string","project" "string","workitemid" 123,"commentid" 123},"parameters" {"api version" "7 2 preview\ 4"},"text" "string"} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text workitemid number unique identifier commentid number unique identifier version number output field version text string output field text renderedtext string output field renderedtext format string output field format isdeleted boolean output field isdeleted url string url endpoint for the request createddate string date value modifieddate string date value createdby object output field createdby createdby displayname string name of the resource createdby id string unique identifier createdby uniquename string name of the resource createdby url string url endpoint for the request createdby imageurl string url endpoint for the request createdby descriptor string output field createdby descriptor createdby links object output field createdby links modifiedby object output field modifiedby modifiedby displayname string name of the resource modifiedby id string unique identifier modifiedby uniquename string name of the resource output example {"workitemid" 123,"commentid" 123,"version" 123,"text" "string","renderedtext" "string","format" "string","isdeleted"\ true,"url" "https //example com/api/resource","createddate" "string","modifieddate" "string","createdby" {"displayname" "example name","id" "12345678 1234 1234 1234 123456789abc","uniquename" "example name","url" "https //example com/api/resource","imageurl" "string","descriptor" "string"," links" {}},"modifiedby" {"displayname" "example name","id" "12345678 1234 1234 1234 123456 update work item comment with format update a work item comment in microsoft azure devops with optional format requires organization, project, workitemid, commentid, api version, and text endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/workitems/{{workitemid}}/comments/{{commentid}} method patch input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters workitemid number required id of a work item path parameters commentid number required id of the comment to update parameters api version string required version of the api to use this should be set to '7 2 preview\ 4' to use this version of the api parameters format string optional format used for the comment text (markdown or html) text string optional the updated text of the comment input example {"path parameters" {"organization" "string","project" "string","workitemid" 123,"commentid" 123},"parameters" {"api version" "7 2 preview\ 4","format" "string"},"text" "string"} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text workitemid number unique identifier commentid number unique identifier version number output field version text string output field text renderedtext string output field renderedtext format string output field format isdeleted boolean output field isdeleted url string url endpoint for the request createddate string date value modifieddate string date value createdby object output field createdby createdby displayname string name of the resource createdby id string unique identifier createdby uniquename string name of the resource createdby url string url endpoint for the request createdby imageurl string url endpoint for the request createdby descriptor string output field createdby descriptor createdby links object output field createdby links modifiedby object output field modifiedby modifiedby displayname string name of the resource modifiedby id string unique identifier modifiedby uniquename string name of the resource output example {"workitemid" 123,"commentid" 123,"version" 123,"text" "string","renderedtext" "string","format" "string","isdeleted"\ true,"url" "https //example com/api/resource","createddate" "string","modifieddate" "string","createdby" {"displayname" "example name","id" "12345678 1234 1234 1234 123456789abc","uniquename" "example name","url" "https //example com/api/resource","imageurl" "string","descriptor" "string"," links" {}},"modifiedby" {"displayname" "example name","id" "12345678 1234 1234 1234 123456 upload work item attachment chunk upload a chunked attachment byte range to microsoft azure devops work item tracking requires organization, project, id, api version, headers, and file data endpoint url https //dev azure com/{{organization}}/{{project}}/ apis/wit/attachments/{{id}} method put input argument name type required description path parameters organization string required the name of the azure devops organization path parameters project string required project id or project name path parameters id string required the id of the attachment parameters api version string required version of the api to use this should be set to '7 2 preview\ 4' to use this version of the api parameters filename string optional name to associate with the uploaded attachment file headers object required request headers for the chunked octet stream upload headers content range string required starting and ending byte positions for chunked upload, format is "bytes 0 10000/50000" file data array required binary chunk content matching the content range header span file data file name string required name of the file being uploaded file data file string required binary file content sent as the request body input example {"path parameters" {"organization" "string","project" "string","id" "12345678 1234 1234 1234 123456789abc"},"parameters" {"api version" "7 2 preview\ 4","filename" "example name"},"headers" {"content range" "string"},"file data" \[{"file name" "example name","file" "string"}]} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text id string unique identifier url string url endpoint for the request output example {"id" "12345678 1234 1234 1234 123456789abc","url" "https //example com/api/resource"} response headers header description example access control expose headers http response header access control expose headers request context activityid http response header activityid 11d652c5 3fd5 4db7 a716 be5e3c4129f5 cache control directives for caching mechanisms no cache, no store, must revalidate content disposition http response header content disposition attachment; filename=image png content encoding http response header content encoding gzip content length the length of the response body in bytes 256 content type the media type of the resource application/json; charset=utf 8; api version=7 1 preview\ 1 date the date and time at which the message was originated wed, 08 nov 2023 06 53 28 gmt expires the date/time after which the response is considered stale 1 p3p http response header p3p cp="cao dsp cor adma dev cono telo cur psa psd tai ivdo our sami bus dem nav sta uni com int phy onl fin pur loc cnt" pragma http response header pragma no cache request context http response header request context appid=cid v1 \ ba8cca98 f9cc 4f08 a334 706ff8d04ac6 set cookie http response header set cookie vstssession=%7b%22persistentsessionid%22%3a%2209cd44b8 efd8 4435 ac5f cbfc5411f9a7%22%2c%22pendingauthenticationsessionid%22%3a%2200000000 0000 0000 0000 000000000000%22%2c%22currentauthenticationsessionid%22%3a%2200000000 0000 0000 0000 000000000000%22%2c%22signinstate%22%3a%7b%7d%7d;samesite=none; domain= dev azure com; expires=thu, 07 nov 2024 07 59 03 gmt; path=/; secure; httponly strict transport security http response header strict transport security max age=31536000; includesubdomains vary http response header vary accept encoding x cache http response header x cache config nocache x content type options http response header x content type options nosniff x frame options http response header x frame options sameorigin x msedge ref http response header x msedge ref ref a 369cd54872d04777a17806aafbac6605 ref b bom02edge0511 ref c 2023 11 08t07 19 33z x tfs processid http response header x tfs processid c031a33a df9e 4fe9 83dd 6d9bb2d000d4 x tfs session http response header x tfs session 11d652c5 3fd5 4db7 a716 be5e3c4129f5 x vss e2eid http response header x vss e2eid 11d652c5 3fd5 4db7 a716 be5e3c4129f5 x vss senderdeploymentid http response header x vss senderdeploymentid 0444d719 954b 4970 8216 09ea10adddc8 x vss userdata http response header x vss userdata e9b6a93c 5610 69d2 88fc 52ad16e266d0 \ nick allen\@swimlane com mailto allen\@swimlane com