Work Items - Create

Referencia

Service:: Work Item Tracking

API Version:: 7.1-preview.3

Crea un único elemento de trabajo.

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

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?validateOnly={validateOnly}&bypassRules={bypassRules}&suppressNotifications={suppressNotifications}&$expand={$expand}&api-version=7.1-preview.3

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	El 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-preview.3" para usar esta versión de la API.
$expand	query		WorkItemExpand	Parámetros expand para atributos de 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 activar 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

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: 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

Scopes

Nombre	Description
vso.work_write	Concede la capacidad de leer, crear y actualizar elementos de trabajo y consultas, actualizar metadatos de panel, á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 elementos de trabajo a través de enlaces de servicio.

Ejemplos

Create work item

Sample Request

HTTP

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

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

Sample Response

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 de JSON
Operation	La operación de revisión
ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de 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 atributos de elemento de trabajo. Las opciones posibles son { None, Relations, Fields, Links, All }
WorkItemRelation

JsonPatchDocument

El modelo JSON para las operaciones de revisión de 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

La operación de revisión

Nombre	Tipo	Description
add	string
copy	string
move	string
remove	string
replace	string
test	string

ReferenceLinks

Clase que se va a representar una colección de vínculos de referencia de REST.

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

WorkItem

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 campos y valores para el elemento de trabajo.
id	integer	Identificador del elemento de trabajo.
relations	WorkItemRelation[]	Relaciones del elemento de trabajo.
rev	integer	Número de revisión del elemento de trabajo.
url	string

WorkItemCommentVersionRef

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

Nombre	Tipo	Description
commentId	integer	Identificador asignado al comentario.
createdInRevision	integer	[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	El número de versión.

WorkItemExpand

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

Nombre	Tipo	Description
all	string	Expande todo.
fields	string	Expanda el elemento de trabajo Campos.
links	string	Expanda el elemento de trabajo vínculos.
none	string	Comportamiento predeterminado.
relations	string	Se expande el elemento de trabajo Relaciones.

WorkItemRelation

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.