Work Items - Create

Referencia

Servicio:: Work Item Tracking

Versión de la API:: 7.1

Crea un único elemento de trabajo.

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

Con parámetros opcionales:

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?validateOnly={validateOnly}&bypassRules={bypassRules}&suppressNotifications={suppressNotifications}&$expand={$expand}&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	True	string	Id. de proyecto o nombre del proyecto
type	path	True	string	Tipo de elemento de trabajo del elemento de trabajo que se va a crear
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.
$expand	query		WorkItemExpand	Parámetros expand para los atributos del elemento de trabajo. Las opciones posibles son { None, Relations, Fields, Links, All }.
bypassRules	query		boolean	No aplique las reglas de tipo de elemento de trabajo en esta actualización.
suppressNotifications	query		boolean	No active ninguna notificación para este cambio.
validateOnly	query		boolean	Indique si solo desea validar los cambios sin guardar el elemento de trabajo.

Cuerpo de la solicitud

Media Types: "application/json-patch+json"

Nombre	Tipo	Description
from	string	Ruta de acceso desde la que se va a copiar para la operación Mover o copiar.
op	Operation	La operación de revisión
path	string	Ruta de acceso de la operación. En el caso de una matriz, se puede usar un índice de base cero para especificar la posición de la matriz (por ejemplo, /biscuits/0/name). El carácter "-" se puede usar en lugar de un índice para insertar al final de la matriz (por ejemplo, /biscuits/-).
value	object	Valor de la operación. Se trata de un primitivo o un JToken.

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_write	Concede la capacidad de leer, crear y actualizar elementos de trabajo y consultas, actualizar metadatos del panel de actualización, áreas de lectura e iteraciones rutas de acceso a otros metadatos relacionados con el seguimiento de elementos de trabajo, ejecutar consultas y recibir notificaciones sobre eventos de elemento de trabajo a través de enlaces de servicio.

Ejemplos

Create work item

Solicitud de ejemplo

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/wit/workitems/${type}?api-version=7.1

[
  {
    "op": "add",
    "path": "/fields/System.Title",
    "from": null,
    "value": "Sample task"
  }
]

Respuesta de muestra

status code:: 200

{
  "id": 131489,
  "rev": 1,
  "fields": {
    "System.AreaPath": "CustomProcessPrj",
    "System.TeamProject": "CustomProcessPrj",
    "System.IterationPath": "CustomProcessPrj",
    "System.WorkItemType": "Task",
    "System.State": "New",
    "System.Reason": "New",
    "System.CreatedDate": "2017-10-06T01:04:51.57Z",
    "System.CreatedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.ChangedDate": "2017-10-06T01:04:51.57Z",
    "System.ChangedBy": {
      "displayName": "Jamal Hartnett",
      "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "_links": {
        "avatar": {
          "href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
        }
      },
      "id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
      "descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
    },
    "System.Title": "Sample task",
    "Microsoft.VSTS.Common.StateChangeDate": "2017-10-06T01:04:51.57Z",
    "Microsoft.VSTS.Common.Priority": 2
  },
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489"
    },
    "workItemUpdates": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/updates"
    },
    "workItemRevisions": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/revisions"
    },
    "workItemHistory": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/history"
    },
    "html": {
      "href": "https://dev.azure.com/fabrikam/web/wi.aspx?pcguid=20cda608-32f0-4e6e-9b7c-8def7b38d15a&id=131489"
    },
    "workItemType": {
      "href": "https://dev.azure.com/fabrikam/aaee31d9-14cf-48b9-a92b-3f1446c13f80/_apis/wit/workItemTypes/Task"
    },
    "fields": {
      "href": "https://dev.azure.com/fabrikam/_apis/wit/fields"
    }
  },
  "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489"
}

Definiciones

Nombre	Description
JsonPatchDocument	El modelo JSON para las operaciones de revisión json
Operation	La operación de revisión
ReferenceLinks	Clase que representa una colección de vínculos de referencia rest.
WorkItem	Describe un elemento de trabajo.
WorkItemCommentVersionRef	Representa la referencia a una versión específica de un comentario en un elemento de trabajo.
WorkItemExpand	Parámetros expand para los atributos del elemento de trabajo. Las opciones posibles son { None, Relations, Fields, Links, All }
WorkItemRelation

JsonPatchDocument

Object

El modelo JSON para las operaciones de revisión json

Nombre	Tipo	Description
from	string	Ruta de acceso desde la que se va a copiar para la operación Mover o copiar.
op	Operation	La operación de revisión
path	string	Ruta de acceso de la operación. En el caso de una matriz, se puede usar un índice de base cero para especificar la posición de la matriz (por ejemplo, /biscuits/0/name). El carácter "-" se puede usar en lugar de un índice para insertar al final de la matriz (por ejemplo, /biscuits/-).
value	object	Valor de la operación. Se trata de un primitivo o un JToken.

Operation

Enumeración

La operación de revisión

Valor	Description
add
copy
move
remove
replace
test

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

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.

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 - Create

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

oauth2

Ámbitos

Ejemplos

Create work item

Solicitud de ejemplo

Respuesta de muestra

Definiciones

JsonPatchDocument

Operation

ReferenceLinks

WorkItem

WorkItemCommentVersionRef

WorkItemExpand

WorkItemRelation

Recursos adicionales