Work Items - Get Work Items Batch

Referencia

Servicio:: Work Item Tracking

Versión de la API:: 7.1

Obtiene elementos de trabajo para una lista de identificadores de elemento de trabajo (máximo 200)

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitemsbatch?api-version=7.1

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	Nombre de la organización de Azure DevOps.
project	path		string	Id. de proyecto o nombre del proyecto
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.1" para usar esta versión de la API.

Cuerpo de la solicitud

Nombre	Tipo	Description
$expand	WorkItemExpand	Parámetros expand para los atributos del elemento de trabajo. Las opciones posibles son { None, Relations, Fields, Links, All }
asOf	string (date-time)	AsOf UTC date time string
errorPolicy	WorkItemErrorPolicy	Marca para controlar la directiva de error en una solicitud de obtención masiva de elementos de trabajo. Las opciones posibles son {Fail, Omit}.
fields	string[]	Campos solicitados
ids	integer[] (int32)	Identificadores de elemento de trabajo solicitados

Respuestas

Nombre	Tipo	Description
200 OK	WorkItem[]	operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del token: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Ámbitos

Nombre	Description
vso.work	Concede la capacidad de leer elementos de trabajo, consultas, paneles, rutas de acceso de área e iteraciones y otros metadatos relacionados con el seguimiento de elementos de trabajo. También concede la capacidad de ejecutar consultas, buscar elementos de trabajo y recibir notificaciones sobre eventos de elementos de trabajo a través de enlaces de servicio.

Ejemplos

Get list of work items for specific fields

Solicitud de ejemplo

HTTP

POST https://dev.azure.com/fabrikam/_apis/wit/workitemsbatch?api-version=7.1

{
  "ids": [
    297,
    299,
    300
  ],
  "fields": [
    "System.Id",
    "System.Title",
    "System.WorkItemType",
    "Microsoft.VSTS.Scheduling.RemainingWork"
  ]
}

Respuesta de muestra

status code:: 200

{
  "count": 3,
  "value": [
    {
      "id": 297,
      "rev": 1,
      "fields": {
        "System.Id": 297,
        "System.WorkItemType": "Product Backlog Item",
        "System.Title": "Customer can sign in using their Microsoft Account"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
    },
    {
      "id": 299,
      "rev": 7,
      "fields": {
        "System.Id": 299,
        "System.WorkItemType": "Task",
        "System.Title": "JavaScript implementation for Microsoft Account",
        "Microsoft.VSTS.Scheduling.RemainingWork": 4
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299"
    },
    {
      "id": 300,
      "rev": 1,
      "fields": {
        "System.Id": 300,
        "System.WorkItemType": "Task",
        "System.Title": "Unit Testing for MSA login",
        "Microsoft.VSTS.Scheduling.RemainingWork": 3
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/300"
    }
  ]
}

Definiciones

Nombre	Description
ReferenceLinks	Clase que representa una colección de vínculos de referencia rest.
WorkItem	Describe un elemento de trabajo.
WorkItemBatchGetRequest	Describe una solicitud para obtener un conjunto de elementos de trabajo
WorkItemCommentVersionRef	Representa la referencia a una versión específica de un comentario en un elemento de trabajo.
WorkItemErrorPolicy	Marca para controlar la directiva de error en una solicitud de obtención masiva de elementos de trabajo. Las opciones posibles son {Fail, Omit}.
WorkItemExpand	Parámetros expand para los atributos del elemento de trabajo. Las opciones posibles son { None, Relations, Fields, Links, All }
WorkItemRelation

ReferenceLinks

Object

Clase que representa una colección de vínculos de referencia rest.

Nombre	Tipo	Description
links	object	Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

WorkItem

Object

Describe un elemento de trabajo.

Nombre	Tipo	Description
_links	ReferenceLinks	Vincular referencias a recursos REST relacionados.
commentVersionRef	WorkItemCommentVersionRef	Referencia a una versión específica del comentario agregado, editado o eliminado en esta revisión.
fields	object	Asignación de campo y valores para el elemento de trabajo.
id	integer (int32)	Identificador del elemento de trabajo.
relations	WorkItemRelation[]	Relaciones del elemento de trabajo.
rev	integer (int32)	Número de revisión del elemento de trabajo.
url	string

WorkItemBatchGetRequest

Object

Describe una solicitud para obtener un conjunto de elementos de trabajo

Nombre	Tipo	Description
$expand	WorkItemExpand	Parámetros expand para los atributos del elemento de trabajo. Las opciones posibles son { None, Relations, Fields, Links, All }
asOf	string (date-time)	AsOf UTC date time string
errorPolicy	WorkItemErrorPolicy	Marca para controlar la directiva de error en una solicitud de obtención masiva de elementos de trabajo. Las opciones posibles son {Fail, Omit}.
fields	string[]	Campos solicitados
ids	integer[] (int32)	Identificadores de elemento de trabajo solicitados

WorkItemCommentVersionRef

Object

Representa la referencia a una versión específica de un comentario en un elemento de trabajo.

Nombre	Tipo	Description
commentId	integer (int32)	Identificador asignado al comentario.
createdInRevision	integer (int32)	[Interno] Revisión del elemento de trabajo donde se agregó originalmente este comentario.
isDeleted	boolean	[Interno] Especifica si se eliminó el comentario.
text	string	[Interno] Texto del comentario.
url	string
version	integer (int32)	Número de versión.

WorkItemErrorPolicy

Enumeración

Marca para controlar la directiva de error en una solicitud de obtención masiva de elementos de trabajo. Las opciones posibles son {Fail, Omit}.

Valor	Description
fail	Directiva de error de trabajo de error.
omit	Omitir la directiva de error de trabajo.

WorkItemExpand

Enumeración

Parámetros expand para los atributos del elemento de trabajo. Las opciones posibles son { None, Relations, Fields, Links, All }

Valor	Description
all	Expande todo.
fields	Expanda el elemento de trabajo Campos.
links	Expanda el elemento de trabajo Vínculos.
none	Comportamiento predeterminado.
relations	Expanda el elemento de trabajo Relaciones.

WorkItemRelation

Object

Nombre	Tipo	Description
attributes	object	Colección de atributos de vínculo.
rel	string	Tipo de relación.
url	string	Dirección URL del vínculo.

Compartir a través de

Work Items - Get Work Items Batch

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

oauth2

Ámbitos

Ejemplos

Get list of work items for specific fields

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ReferenceLinks

WorkItem

WorkItemBatchGetRequest

WorkItemCommentVersionRef

WorkItemErrorPolicy

WorkItemExpand

WorkItemRelation