Compartir a través de


WorkItemTrackingRestClient class

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

Constructores

WorkItemTrackingRestClient(IVssRestClientOptions)

Propiedades

RESOURCE_AREA_ID

Métodos

createAttachment(any, string, string, string, string)

Carga datos adjuntos.

createField(WorkItemField, string)

Cree un nuevo campo.

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Cree uno nuevo o actualice un nodo de clasificación existente.

createQuery(QueryHierarchyItem, string, string, boolean)

Crea una consulta o mueve una consulta.

createTemplate(WorkItemTemplate, string, string)

Crea una plantilla

createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)

Crea un único elemento de trabajo.

deleteClassificationNode(string, TreeStructureGroup, string, number)

Elimine un nodo de clasificación existente.

deleteField(string, string)

Elimina el campo. Para recuperar un archivo archivado, consulte api de actualización de campo.

deleteQuery(string, string)

Elimine una consulta o una carpeta. Esto elimina cualquier cambio de permiso en la consulta o carpeta eliminadas y cualquiera de sus descendientes si es una carpeta. Es importante tener en cuenta que los cambios de permisos eliminados no se pueden recuperar al eliminar la consulta o carpeta.

deleteTemplate(string, string, string)

Elimina la plantilla con el identificador especificado.

deleteWorkItem(number, string, boolean)

Elimina el elemento de trabajo especificado y lo envía a la Papelera de reciclaje, de modo que se pueda restaurar de nuevo, si es necesario. Opcionalmente, si el parámetro destroy se ha establecido en true, destruye el elemento de trabajo de forma permanente. ADVERTENCIA: Si el parámetro destroy se establece en true, los elementos de trabajo eliminados por este comando NO irán a la papelera de reciclaje y no hay ninguna manera de restaurarlos o recuperarlos después de la eliminación. Se recomienda NO usar este parámetro. Si lo hace, use este parámetro con extrema precaución.

destroyWorkItem(number, string)

Destruye el elemento de trabajo especificado de forma permanente desde la Papelera de reciclaje. Esta acción no se puede deshacer.

exportWorkItemTypeDefinition(string, string, boolean)

Exportar tipo de elemento de trabajo

getAccountMyWorkData(QueryOption)

SOLO INTERNO: USADO POR LA PÁGINA MI TRABAJO DE LA CUENTA. Esto devuelve los detalles de los elementos de trabajo Doing, Done, Follows y activity.

getAttachmentContent(string, string, string, boolean)

Descarga un archivo adjunto.

getAttachmentZip(string, string, string, boolean)

Descarga un archivo adjunto.

getClassificationNode(string, TreeStructureGroup, string, number)

Obtiene el nodo de clasificación de una ruta de acceso de nodo determinada.

getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)

Obtiene los nodos de clasificación raíz o la lista de nodos de clasificación de una lista determinada de identificadores de nodos para un proyecto determinado. En caso de que se proporcione el parámetro ids, obtendrá una lista de nodos de clasificación para esos identificadores. De lo contrario, obtendrá nodos de clasificación raíz para este proyecto.

getComment(number, number, string)

Obtiene un comentario para un elemento de trabajo en la revisión especificada.

getComments(number, string, number, number, CommentSortOrder)

Obtiene el número especificado de comentarios para un elemento de trabajo de la revisión especificada.

getDeletedWorkItem(number, string)

Obtiene un elemento de trabajo eliminado de la Papelera de reciclaje.

getDeletedWorkItems(number[], string)

Obtiene los elementos de trabajo de la papelera de reciclaje, cuyos identificadores se han especificado en los parámetros.

getDeletedWorkItemShallowReferences(string)

Obtiene una lista de los identificadores y las direcciones URL de los elementos de trabajo eliminados en la Papelera de reciclaje.

getField(string, string)

Obtiene información sobre un campo específico.

getFields(string, GetFieldsExpand)

Devuelve información para todos los campos. El parámetro id. o nombre del proyecto es opcional.

getQueries(string, QueryExpand, number, boolean)

Obtiene las consultas raíz y sus elementos secundarios.

getQueriesBatch(QueryBatchGetRequest, string)

Obtiene una lista de consultas por identificadores (máximo 1000)

getQuery(string, string, QueryExpand, number, boolean, boolean)

Recupera una consulta individual y sus elementos secundarios.

getQueryResultCount(string, string, string, boolean, number)

Obtiene los resultados de la consulta según el identificador de consulta.

getRecentActivityData()

Obtiene las actividades recientes del elemento de trabajo.

getRecentMentions()

SOLO INTERNO: USADO POR LA CUENTA MI PÁGINA DE TRABAJO.

getRelationType(string)

Obtiene la definición del tipo de relación de elemento de trabajo.

getRelationTypes()

Obtiene los tipos de relación del elemento de trabajo.

getReportingLinksByLinkType(string, string[], string[], string, Date)

Obtener un lote de vínculos de elementos de trabajo

getRevision(number, number, string, WorkItemExpand)

Devuelve un elemento de trabajo totalmente hidratado para la revisión solicitada.

getRevisions(number, string, number, number, WorkItemExpand)

Devuelve la lista de revisiones de elementos de trabajo totalmente hidratadas, paginadas.

getRootNodes(string, number)

Obtiene nodos de clasificación raíz en el proyecto.

getTemplate(string, string, string)

Obtiene la plantilla con el identificador especificado.

getTemplates(string, string, string)

Obtiene la plantilla.

getUpdate(number, number, string)

Devuelve una única actualización de un elemento de trabajo.

getUpdates(number, string, number, number)

Devuelve las diferencias entre las revisiones del elemento de trabajo.

getWorkArtifactLinkTypes()

Obtenga la lista de tipos de vínculo de artefacto de salida de seguimiento de elementos de trabajo.

getWorkItem(number, string, string[], Date, WorkItemExpand)

Devuelve un único elemento de trabajo.

getWorkItemIconJson(string, string, number)

Obtenga un icono de elemento de trabajo según el nombre descriptivo y el color del icono.

getWorkItemIcons()

Obtiene una lista de todos los iconos de elementos de trabajo.

getWorkItemIconSvg(string, string, number)

Obtenga un icono de elemento de trabajo según el nombre descriptivo y el color del icono.

getWorkItemIconXaml(string, string, number)

Obtenga un icono de elemento de trabajo según el nombre descriptivo y el color del icono.

getWorkItemNextStatesOnCheckinAction(number[], string)

Devuelve el siguiente estado en los identificadores de elemento de trabajo especificados.

getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)

Devuelve una lista de elementos de trabajo (máximo 200)

getWorkItemsBatch(WorkItemBatchGetRequest, string)

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

getWorkItemStateColors(string[])

SOLO INTERNO: se usará para mi experiencia profesional con mi cuenta. Obtener el color de estado del tipo de elemento de trabajo para varios proyectos

getWorkItemTemplate(string, string, string, Date, WorkItemExpand)

Devuelve un único elemento de trabajo de una plantilla.

getWorkItemType(string, string)

Devuelve una definición de tipo de elemento de trabajo.

getWorkItemTypeCategories(string)

Obtiene todas las categorías de tipo de elemento de trabajo.

getWorkItemTypeCategory(string, string)

Obtiene una categoría de tipo de elemento de trabajo específica por nombre.

getWorkItemTypeColorAndIcons(string[])

SOLO INTERNO: se usa para proveedores de colores e iconos. Obtener el color de tipo wit para varios proyectos

getWorkItemTypeColors(string[])

SOLO INTERNO: se usará para mi experiencia profesional con mi cuenta. Obtener el color de tipo wit para varios proyectos

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

Obtenga una lista de campos para un tipo de elemento de trabajo con referencias detalladas.

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Obtenga un campo para un tipo de elemento de trabajo con referencias detalladas.

getWorkItemTypes(string)

Devuelve la lista de tipos de elementos de trabajo.

getWorkItemTypeStates(string, string)

Devuelve los nombres de estado y los colores de un tipo de elemento de trabajo.

queryById(string, string, string, boolean, number)

Obtiene los resultados de la consulta según el identificador de consulta.

queryByWiql(Wiql, string, string, boolean, number)

Obtiene los resultados de la consulta dada su WIQL.

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

Consulta los elementos de trabajo vinculados a una lista determinada de URI de artefacto.

readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)

Obtener un lote de revisiones de elementos de trabajo con la opción de incluir elementos eliminados

readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)

Obtenga un lote de revisiones de elementos de trabajo. Esta solicitud se puede usar si la lista de campos es lo suficientemente grande que puede ejecutar la dirección URL en el límite de longitud.

replaceTemplate(WorkItemTemplate, string, string, string)

Reemplazar el contenido de la plantilla

restoreWorkItem(WorkItemDeleteUpdate, number, string)

Restaura el elemento de trabajo eliminado de la Papelera de reciclaje.

searchQueries(string, string, number, QueryExpand, boolean)

Busca en todas las consultas a las que el usuario tiene acceso en el proyecto actual.

sendMail(SendMailBody, string)

Método RESTful para enviar correo para los elementos de trabajo seleccionados o consultados.

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Actualice un nodo de clasificación existente.

updateField(UpdateWorkItemField, string, string)

Actualizar un campo.

updateQuery(QueryHierarchyItem, string, string, boolean)

Actualizar una consulta o una carpeta. Esto le permite actualizar, cambiar el nombre y mover consultas y carpetas.

updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)

Novedades un único elemento de trabajo.

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

Agregar o actualizar un tipo de elemento de trabajo

Detalles del constructor

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

Parámetros

Detalles de las propiedades

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de propiedad

string

Detalles del método

createAttachment(any, string, string, string, string)

Carga datos adjuntos.

function createAttachment(content: any, project?: string, fileName?: string, uploadType?: string, areaPath?: string): Promise<AttachmentReference>

Parámetros

content

any

Contenido que se va a cargar

project

string

Id. de proyecto o nombre del proyecto

fileName

string

Nombre del archivo

uploadType

string

Tipo de carga de datos adjuntos: Simple o Fragmentado

areaPath

string

Ruta de acceso del área del proyecto de destino

Devoluciones

createField(WorkItemField, string)

Cree un nuevo campo.

function createField(workItemField: WorkItemField, project?: string): Promise<WorkItemField>

Parámetros

workItemField
WorkItemField

Nueva definición de campo

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Cree uno nuevo o actualice un nodo de clasificación existente.

function createOrUpdateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>

Parámetros

postedNode
WorkItemClassificationNode

Nodo que se va a crear o actualizar.

project

string

Id. de proyecto o nombre del proyecto

structureGroup
TreeStructureGroup

Grupo de estructura del nodo de clasificación, área o iteración.

path

string

Ruta de acceso del nodo de clasificación.

Devoluciones

createQuery(QueryHierarchyItem, string, string, boolean)

Crea una consulta o mueve una consulta.

function createQuery(postedQuery: QueryHierarchyItem, project: string, query: string, validateWiqlOnly?: boolean): Promise<QueryHierarchyItem>

Parámetros

postedQuery
QueryHierarchyItem

Consulta que se va a crear.

project

string

Id. de proyecto o nombre del proyecto

query

string

Identificador primario o ruta de acceso en la que se va a crear la consulta.

validateWiqlOnly

boolean

Si solo desea validar la consulta WIQL sin crear realmente una, establézcala en true. El valor predeterminado es False.

Devoluciones

createTemplate(WorkItemTemplate, string, string)

Crea una plantilla

function createTemplate(template: WorkItemTemplate, project: string, team: string): Promise<WorkItemTemplate>

Parámetros

template
WorkItemTemplate

Contenido de la plantilla

project

string

Id. de proyecto o nombre del proyecto

team

string

Id. de equipo o nombre del equipo

Devoluciones

Promise<WorkItemTemplate>

createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)

Crea un único elemento de trabajo.

function createWorkItem(document: JsonPatchDocument, project: string, type: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>

Parámetros

document
JsonPatchDocument

Documento de revisión JSON que representa el elemento de trabajo

project

string

Id. de proyecto o nombre del proyecto

type

string

Tipo de elemento de trabajo del elemento de trabajo que se va a crear

validateOnly

boolean

Indique si solo desea validar los cambios sin guardar el elemento de trabajo.

bypassRules

boolean

No aplicar las reglas de tipo de elemento de trabajo en esta actualización

suppressNotifications

boolean

No active ninguna notificación para este cambio

expand
WorkItemExpand

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

Devoluciones

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

Elimine un nodo de clasificación existente.

function deleteClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, reclassifyId?: number): Promise<void>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

structureGroup
TreeStructureGroup

Grupo de estructura del nodo de clasificación, área o iteración.

path

string

Ruta de acceso del nodo de clasificación.

reclassifyId

number

Identificador del nodo de clasificación de destino para la reclasificación.

Devoluciones

Promise<void>

deleteField(string, string)

Elimina el campo. Para recuperar un archivo archivado, consulte api de actualización de campo.

function deleteField(fieldNameOrRefName: string, project?: string): Promise<void>

Parámetros

fieldNameOrRefName

string

Nombre simple de campo o nombre de referencia

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

deleteQuery(string, string)

Elimine una consulta o una carpeta. Esto elimina cualquier cambio de permiso en la consulta o carpeta eliminadas y cualquiera de sus descendientes si es una carpeta. Es importante tener en cuenta que los cambios de permisos eliminados no se pueden recuperar al eliminar la consulta o carpeta.

function deleteQuery(project: string, query: string): Promise<void>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

query

string

Identificador o ruta de acceso de la consulta o carpeta que se va a eliminar.

Devoluciones

Promise<void>

deleteTemplate(string, string, string)

Elimina la plantilla con el identificador especificado.

function deleteTemplate(project: string, team: string, templateId: string): Promise<void>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

team

string

Id. de equipo o nombre del equipo

templateId

string

Id. de plantilla

Devoluciones

Promise<void>

deleteWorkItem(number, string, boolean)

Elimina el elemento de trabajo especificado y lo envía a la Papelera de reciclaje, de modo que se pueda restaurar de nuevo, si es necesario. Opcionalmente, si el parámetro destroy se ha establecido en true, destruye el elemento de trabajo de forma permanente. ADVERTENCIA: Si el parámetro destroy se establece en true, los elementos de trabajo eliminados por este comando NO irán a la papelera de reciclaje y no hay ninguna manera de restaurarlos o recuperarlos después de la eliminación. Se recomienda NO usar este parámetro. Si lo hace, use este parámetro con extrema precaución.

function deleteWorkItem(id: number, project?: string, destroy?: boolean): Promise<WorkItemDelete>

Parámetros

id

number

Identificador del elemento de trabajo que se va a eliminar

project

string

Id. de proyecto o nombre del proyecto

destroy

boolean

Parámetro opcional, si se establece en true, el elemento de trabajo se elimina permanentemente. Tenga en cuenta que la acción de destrucción es PERMANENTE y no se puede deshacer.

Devoluciones

Promise<WorkItemDelete>

destroyWorkItem(number, string)

Destruye el elemento de trabajo especificado de forma permanente desde la Papelera de reciclaje. Esta acción no se puede deshacer.

function destroyWorkItem(id: number, project?: string): Promise<void>

Parámetros

id

number

Identificador del elemento de trabajo que se va a destruir permanentemente

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

Exportar tipo de elemento de trabajo

function exportWorkItemTypeDefinition(project?: string, type?: string, exportGlobalLists?: boolean): Promise<WorkItemTypeTemplate>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

type

string

exportGlobalLists

boolean

Devoluciones

getAccountMyWorkData(QueryOption)

SOLO INTERNO: USADO POR LA PÁGINA MI TRABAJO DE LA CUENTA. Esto devuelve los detalles de los elementos de trabajo Doing, Done, Follows y activity.

function getAccountMyWorkData(queryOption?: QueryOption): Promise<AccountMyWorkResult>

Parámetros

queryOption
QueryOption

Devoluciones

getAttachmentContent(string, string, string, boolean)

Descarga un archivo adjunto.

function getAttachmentContent(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>

Parámetros

id

string

Id. de datos adjuntos

project

string

Id. de proyecto o nombre del proyecto

fileName

string

Nombre del archivo.

download

boolean

Si se establece en <c>true</c> , descargue siempre los datos adjuntos.

Devoluciones

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

Descarga un archivo adjunto.

function getAttachmentZip(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>

Parámetros

id

string

Id. de datos adjuntos

project

string

Id. de proyecto o nombre del proyecto

fileName

string

Nombre del archivo.

download

boolean

Si se establece en <c>true</c> , descargue siempre los datos adjuntos.

Devoluciones

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

Obtiene el nodo de clasificación de una ruta de acceso de nodo determinada.

function getClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, depth?: number): Promise<WorkItemClassificationNode>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

structureGroup
TreeStructureGroup

Grupo de estructura del nodo de clasificación, área o iteración.

path

string

Ruta de acceso del nodo de clasificación.

depth

number

Profundidad de elementos secundarios que se van a capturar.

Devoluciones

getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)

Obtiene los nodos de clasificación raíz o la lista de nodos de clasificación de una lista determinada de identificadores de nodos para un proyecto determinado. En caso de que se proporcione el parámetro ids, obtendrá una lista de nodos de clasificación para esos identificadores. De lo contrario, obtendrá nodos de clasificación raíz para este proyecto.

function getClassificationNodes(project: string, ids: number[], depth?: number, errorPolicy?: ClassificationNodesErrorPolicy): Promise<WorkItemClassificationNode[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

ids

number[]

Identificadores de nodos de clasificación de enteros separados por comas. No es necesario, si quiere nodos raíz.

depth

number

Profundidad de elementos secundarios que se van a capturar.

errorPolicy
ClassificationNodesErrorPolicy

Marca para controlar los errores al obtener algunos nodos. Las opciones posibles son Fail y Omit.

Devoluciones

getComment(number, number, string)

Obtiene un comentario para un elemento de trabajo en la revisión especificada.

function getComment(id: number, revision: number, project?: string): Promise<WorkItemComment>

Parámetros

id

number

Id. de elemento de trabajo

revision

number

Revisión para la que se debe capturar el comentario

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<WorkItemComment>

getComments(number, string, number, number, CommentSortOrder)

Obtiene el número especificado de comentarios para un elemento de trabajo de la revisión especificada.

function getComments(id: number, project?: string, fromRevision?: number, top?: number, order?: CommentSortOrder): Promise<WorkItemComments>

Parámetros

id

number

Id. de elemento de trabajo

project

string

Id. de proyecto o nombre del proyecto

fromRevision

number

Revisión de la que se van a capturar los comentarios (el valor predeterminado es 1)

top

number

Número de comentarios que se van a devolver (el valor predeterminado es 200)

order
CommentSortOrder

Ascendente o descendente por identificador de revisión (el valor predeterminado es ascendente)

Devoluciones

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

Obtiene un elemento de trabajo eliminado de la Papelera de reciclaje.

function getDeletedWorkItem(id: number, project?: string): Promise<WorkItemDelete>

Parámetros

id

number

Identificador del elemento de trabajo que se va a devolver

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

Obtiene los elementos de trabajo de la papelera de reciclaje, cuyos identificadores se han especificado en los parámetros.

function getDeletedWorkItems(ids: number[], project?: string): Promise<WorkItemDeleteReference[]>

Parámetros

ids

number[]

Lista separada por comas de identificadores de los elementos de trabajo eliminados que se van a devolver

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

getDeletedWorkItemShallowReferences(string)

Obtiene una lista de los identificadores y las direcciones URL de los elementos de trabajo eliminados en la Papelera de reciclaje.

function getDeletedWorkItemShallowReferences(project?: string): Promise<WorkItemDeleteShallowReference[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

getField(string, string)

Obtiene información sobre un campo específico.

function getField(fieldNameOrRefName: string, project?: string): Promise<WorkItemField>

Parámetros

fieldNameOrRefName

string

Nombre simple de campo o nombre de referencia

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

Devuelve información para todos los campos. El parámetro id. o nombre del proyecto es opcional.

function getFields(project?: string, expand?: GetFieldsExpand): Promise<WorkItemField[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

expand
GetFieldsExpand

Use ExtensionFields para incluir campos de extensión; de lo contrario, excluyalos. A menos que la marca de característica de este parámetro esté habilitada, los campos de extensión siempre se incluyen.

Devoluciones

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

Obtiene las consultas raíz y sus elementos secundarios.

function getQueries(project: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean): Promise<QueryHierarchyItem[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

expand
QueryExpand

Incluya la cadena de consulta (wiql), cláusulas, columnas de resultados de consulta y opciones de ordenación en los resultados.

depth

number

En la carpeta de consultas, devuelva las consultas secundarias y las carpetas a esta profundidad.

includeDeleted

boolean

Incluir consultas y carpetas eliminadas

Devoluciones

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

Obtiene una lista de consultas por identificadores (máximo 1000)

function getQueriesBatch(queryGetRequest: QueryBatchGetRequest, project: string): Promise<QueryHierarchyItem[]>

Parámetros

queryGetRequest
QueryBatchGetRequest
project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<QueryHierarchyItem[]>

getQuery(string, string, QueryExpand, number, boolean, boolean)

Recupera una consulta individual y sus elementos secundarios.

function getQuery(project: string, query: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean, useIsoDateFormat?: boolean): Promise<QueryHierarchyItem>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

query

string

Identificador o ruta de acceso de la consulta.

expand
QueryExpand

Incluya la cadena de consulta (wiql), cláusulas, columnas de resultados de consulta y opciones de ordenación en los resultados.

depth

number

En la carpeta de consultas, devuelva las consultas secundarias y las carpetas a esta profundidad.

includeDeleted

boolean

Incluir consultas y carpetas eliminadas

useIsoDateFormat

boolean

Las cláusulas de consulta DateTime se formatearán con un formato compatible con ISO 8601.

Devoluciones

getQueryResultCount(string, string, string, boolean, number)

Obtiene los resultados de la consulta según el identificador de consulta.

function getQueryResultCount(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<number>

Parámetros

id

string

Identificador de consulta.

project

string

Id. de proyecto o nombre del proyecto

team

string

Id. de equipo o nombre del equipo

timePrecision

boolean

Si se va a usar o no la precisión del tiempo.

top

number

Número máximo de resultados que se van a devolver.

Devoluciones

Promise<number>

getRecentActivityData()

Obtiene las actividades recientes del elemento de trabajo.

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

Devoluciones

getRecentMentions()

SOLO INTERNO: USADO POR LA CUENTA MI PÁGINA DE TRABAJO.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

Devoluciones

getRelationType(string)

Obtiene la definición del tipo de relación de elemento de trabajo.

function getRelationType(relation: string): Promise<WorkItemRelationType>

Parámetros

relation

string

Nombre de la relación

Devoluciones

getRelationTypes()

Obtiene los tipos de relación del elemento de trabajo.

function getRelationTypes(): Promise<WorkItemRelationType[]>

Devoluciones

getReportingLinksByLinkType(string, string[], string[], string, Date)

Obtener un lote de vínculos de elementos de trabajo

function getReportingLinksByLinkType(project?: string, linkTypes?: string[], types?: string[], continuationToken?: string, startDateTime?: Date): Promise<ReportingWorkItemLinksBatch>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

linkTypes

string[]

Lista de tipos para filtrar los resultados a tipos de vínculo específicos. Omita este parámetro para obtener vínculos de elementos de trabajo de todos los tipos de vínculo.

types

string[]

Lista de tipos para filtrar los resultados a tipos de elementos de trabajo específicos. Omita este parámetro para obtener vínculos de elementos de trabajo de todos los tipos de elementos de trabajo.

continuationToken

string

Especifica el valor de continuationToken desde el que se va a iniciar el lote. Omita este parámetro para obtener el primer lote de vínculos.

startDateTime

Date

Fecha y hora que se va a usar como punto de partida para los cambios de vínculo. Solo se devolverán los cambios de vínculo que se produjeron después de esa fecha y hora. No se puede usar junto con el parámetro "watermark".

Devoluciones

getRevision(number, number, string, WorkItemExpand)

Devuelve un elemento de trabajo totalmente hidratado para la revisión solicitada.

function getRevision(id: number, revisionNumber: number, project?: string, expand?: WorkItemExpand): Promise<WorkItem>

Parámetros

id

number

revisionNumber

number

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<WorkItem>

getRevisions(number, string, number, number, WorkItemExpand)

Devuelve la lista de revisiones de elementos de trabajo totalmente hidratadas, paginadas.

function getRevisions(id: number, project?: string, top?: number, skip?: number, expand?: WorkItemExpand): Promise<WorkItem[]>

Parámetros

id

number

project

string

Id. de proyecto o nombre del proyecto

top

number

skip

number

Devoluciones

Promise<WorkItem[]>

getRootNodes(string, number)

Obtiene nodos de clasificación raíz en el proyecto.

function getRootNodes(project: string, depth?: number): Promise<WorkItemClassificationNode[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

depth

number

Profundidad de elementos secundarios que se van a capturar.

Devoluciones

getTemplate(string, string, string)

Obtiene la plantilla con el identificador especificado.

function getTemplate(project: string, team: string, templateId: string): Promise<WorkItemTemplate>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

team

string

Id. de equipo o nombre del equipo

templateId

string

Id. de plantilla

Devoluciones

Promise<WorkItemTemplate>

getTemplates(string, string, string)

Obtiene la plantilla.

function getTemplates(project: string, team: string, workitemtypename?: string): Promise<WorkItemTemplateReference[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

team

string

Id. de equipo o nombre del equipo

workitemtypename

string

Opcional, Cuando se especifican, devuelve plantillas para un tipo de elemento de trabajo determinado.

Devoluciones

getUpdate(number, number, string)

Devuelve una única actualización de un elemento de trabajo.

function getUpdate(id: number, updateNumber: number, project?: string): Promise<WorkItemUpdate>

Parámetros

id

number

updateNumber

number

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

Devuelve las diferencias entre las revisiones del elemento de trabajo.

function getUpdates(id: number, project?: string, top?: number, skip?: number): Promise<WorkItemUpdate[]>

Parámetros

id

number

project

string

Id. de proyecto o nombre del proyecto

top

number

skip

number

Devoluciones

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

Obtenga la lista de tipos de vínculo de artefacto de salida de seguimiento de elementos de trabajo.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

Devoluciones

Promise<WorkArtifactLink[]>

getWorkItem(number, string, string[], Date, WorkItemExpand)

Devuelve un único elemento de trabajo.

function getWorkItem(id: number, project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>

Parámetros

id

number

Identificador del elemento de trabajo

project

string

Id. de proyecto o nombre del proyecto

fields

string[]

Lista separada por comas de campos solicitados

asOf

Date

Cadena de fecha y hora ASOf UTC

expand
WorkItemExpand

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

Devoluciones

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

Obtenga un icono de elemento de trabajo según el nombre descriptivo y el color del icono.

function getWorkItemIconJson(icon: string, color?: string, v?: number): Promise<WorkItemIcon>

Parámetros

icon

string

Nombre del icono

color

string

Color hexadecimal de 6 dígitos para el icono

v

number

La versión del icono (solo se usa para la invalidación de caché)

Devoluciones

Promise<WorkItemIcon>

getWorkItemIcons()

Obtiene una lista de todos los iconos de elementos de trabajo.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

Devoluciones

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

Obtenga un icono de elemento de trabajo según el nombre descriptivo y el color del icono.

function getWorkItemIconSvg(icon: string, color?: string, v?: number): Promise<any>

Parámetros

icon

string

Nombre del icono

color

string

Color hexadecimal de 6 dígitos para el icono

v

number

La versión del icono (solo se usa para la invalidación de caché)

Devoluciones

Promise<any>

getWorkItemIconXaml(string, string, number)

Obtenga un icono de elemento de trabajo según el nombre descriptivo y el color del icono.

function getWorkItemIconXaml(icon: string, color?: string, v?: number): Promise<any>

Parámetros

icon

string

Nombre del icono

color

string

Color hexadecimal de 6 dígitos para el icono

v

number

La versión del icono (solo se usa para la invalidación de caché)

Devoluciones

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

Devuelve el siguiente estado en los identificadores de elemento de trabajo especificados.

function getWorkItemNextStatesOnCheckinAction(ids: number[], action?: string): Promise<WorkItemNextStateOnTransition[]>

Parámetros

ids

number[]

lista de identificadores de elemento de trabajo

action

string

posibles acciones. Actualmente solo admite checkin

Devoluciones

getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)

Devuelve una lista de elementos de trabajo (máximo 200)

function getWorkItems(ids: number[], project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand, errorPolicy?: WorkItemErrorPolicy): Promise<WorkItem[]>

Parámetros

ids

number[]

Lista separada por comas de identificadores de elemento de trabajo solicitados. (Se permiten 200 identificadores como máximo).

project

string

Id. de proyecto o nombre del proyecto

fields

string[]

Lista separada por comas de campos solicitados

asOf

Date

Cadena de fecha y hora ASOf UTC

expand
WorkItemExpand

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

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}.

Devoluciones

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

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

function getWorkItemsBatch(workItemGetRequest: WorkItemBatchGetRequest, project?: string): Promise<WorkItem[]>

Parámetros

workItemGetRequest
WorkItemBatchGetRequest
project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<WorkItem[]>

getWorkItemStateColors(string[])

SOLO INTERNO: se usará para mi experiencia profesional con mi cuenta. Obtener el color de estado del tipo de elemento de trabajo para varios proyectos

function getWorkItemStateColors(projectNames: string[]): Promise<ProjectWorkItemStateColors[]>

Parámetros

projectNames

string[]

Devoluciones

getWorkItemTemplate(string, string, string, Date, WorkItemExpand)

Devuelve un único elemento de trabajo de una plantilla.

function getWorkItemTemplate(project: string, type: string, fields?: string, asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

type

string

Nombre del tipo de elemento de trabajo

fields

string

Lista separada por comas de campos solicitados

asOf

Date

Cadena de fecha y hora ASOf UTC

expand
WorkItemExpand

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

Devoluciones

Promise<WorkItem>

getWorkItemType(string, string)

Devuelve una definición de tipo de elemento de trabajo.

function getWorkItemType(project: string, type: string): Promise<WorkItemType>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

type

string

Nombre del tipo de elemento de trabajo

Devoluciones

Promise<WorkItemType>

getWorkItemTypeCategories(string)

Obtiene todas las categorías de tipo de elemento de trabajo.

function getWorkItemTypeCategories(project: string): Promise<WorkItemTypeCategory[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

getWorkItemTypeCategory(string, string)

Obtiene una categoría de tipo de elemento de trabajo específica por nombre.

function getWorkItemTypeCategory(project: string, category: string): Promise<WorkItemTypeCategory>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

category

string

El nombre de la categoría

Devoluciones

getWorkItemTypeColorAndIcons(string[])

SOLO INTERNO: se usa para proveedores de colores e iconos. Obtener el color de tipo wit para varios proyectos

function getWorkItemTypeColorAndIcons(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>

Parámetros

projectNames

string[]

Devoluciones

Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>

getWorkItemTypeColors(string[])

SOLO INTERNO: se usará para mi experiencia profesional con mi cuenta. Obtener el color de tipo wit para varios proyectos

function getWorkItemTypeColors(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColor[] }[]>

Parámetros

projectNames

string[]

Devoluciones

Promise<{ key: string, value: WorkItemTypeColor[] }[]>

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

Obtenga una lista de campos para un tipo de elemento de trabajo con referencias detalladas.

function getWorkItemTypeFieldsWithReferences(project: string, type: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

type

string

Tipo de elemento de trabajo.

expand
WorkItemTypeFieldsExpandLevel

Expanda el nivel de la respuesta de la API. Propiedades: para incluir valores permitidos, valor predeterminado, isRequired, etc. como parte de la respuesta; Ninguno: para omitir estas propiedades.

Devoluciones

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

Obtenga un campo para un tipo de elemento de trabajo con referencias detalladas.

function getWorkItemTypeFieldWithReferences(project: string, type: string, field: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

type

string

Tipo de elemento de trabajo.

field

string

expand
WorkItemTypeFieldsExpandLevel

Expanda el nivel de la respuesta de la API. Propiedades: para incluir valores permitidos, valor predeterminado, isRequired, etc. como parte de la respuesta; Ninguno: para omitir estas propiedades.

Devoluciones

getWorkItemTypes(string)

Devuelve la lista de tipos de elementos de trabajo.

function getWorkItemTypes(project: string): Promise<WorkItemType[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

Devuelve los nombres de estado y los colores de un tipo de elemento de trabajo.

function getWorkItemTypeStates(project: string, type: string): Promise<WorkItemStateColor[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

type

string

Nombre de estado

Devoluciones

Promise<WorkItemStateColor[]>

queryById(string, string, string, boolean, number)

Obtiene los resultados de la consulta según el identificador de consulta.

function queryById(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>

Parámetros

id

string

Identificador de consulta.

project

string

Id. de proyecto o nombre del proyecto

team

string

Id. de equipo o nombre del equipo

timePrecision

boolean

Si se va a usar o no la precisión del tiempo.

top

number

Número máximo de resultados que se van a devolver.

Devoluciones

queryByWiql(Wiql, string, string, boolean, number)

Obtiene los resultados de la consulta dada su WIQL.

function queryByWiql(wiql: Wiql, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>

Parámetros

wiql
Wiql

Consulta que contiene el WIQL.

project

string

Id. de proyecto o nombre del proyecto

team

string

Id. de equipo o nombre del equipo

timePrecision

boolean

Si se va a usar o no la precisión del tiempo.

top

number

Número máximo de resultados que se van a devolver.

Devoluciones

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

Consulta los elementos de trabajo vinculados a una lista determinada de URI de artefacto.

function queryWorkItemsForArtifactUris(artifactUriQuery: ArtifactUriQuery, project?: string): Promise<ArtifactUriQueryResult>

Parámetros

artifactUriQuery
ArtifactUriQuery

Define una lista de URI de artefacto para consultar elementos de trabajo.

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)

Obtener un lote de revisiones de elementos de trabajo con la opción de incluir elementos eliminados

function readReportingRevisionsGet(project?: string, fields?: string[], types?: string[], continuationToken?: string, startDateTime?: Date, includeIdentityRef?: boolean, includeDeleted?: boolean, includeTagRef?: boolean, includeLatestOnly?: boolean, expand?: ReportingRevisionsExpand, includeDiscussionChangesOnly?: boolean, maxPageSize?: number): Promise<ReportingWorkItemRevisionsBatch>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

fields

string[]

Lista de campos que se van a devolver en las revisiones del elemento de trabajo. Omita este parámetro para obtener todos los campos notificables.

types

string[]

Lista de tipos para filtrar los resultados a tipos de elementos de trabajo específicos. Omita este parámetro para obtener revisiones de elementos de trabajo de todos los tipos de elementos de trabajo.

continuationToken

string

Especifica la marca de agua desde la que se va a iniciar el lote. Omita este parámetro para obtener el primer lote de revisiones.

startDateTime

Date

Fecha y hora que se va a usar como punto de partida para las revisiones, todas las revisiones se producirán después de esta fecha y hora. No se puede usar junto con el parámetro "watermark".

includeIdentityRef

boolean

Devuelve una referencia de identidad en lugar de un valor de cadena para los campos de identidad.

includeDeleted

boolean

Especifique si se debe devolver el elemento eliminado.

includeTagRef

boolean

Especifique si se deben devolver los objetos de etiqueta para el campo System.Tags.

includeLatestOnly

boolean

Devuelve solo las revisiones más recientes de los elementos de trabajo, omitiendo todas las revisiones históricas.

expand
ReportingRevisionsExpand

Devuelve todos los campos de las revisiones del elemento de trabajo, incluidos los campos de texto largos que no se devuelven de forma predeterminada.

includeDiscussionChangesOnly

boolean

Devuelve solo las revisiones de los elementos de trabajo, donde solo se cambió el campo de historial.

maxPageSize

number

Número máximo de resultados que se van a devolver en este lote

Devoluciones

readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)

Obtenga un lote de revisiones de elementos de trabajo. Esta solicitud se puede usar si la lista de campos es lo suficientemente grande que puede ejecutar la dirección URL en el límite de longitud.

function readReportingRevisionsPost(filter: ReportingWorkItemRevisionsFilter, project?: string, continuationToken?: string, startDateTime?: Date, expand?: ReportingRevisionsExpand): Promise<ReportingWorkItemRevisionsBatch>

Parámetros

filter
ReportingWorkItemRevisionsFilter

Objeto que contiene la configuración de la solicitud: filtro de campo, filtro de tipo, formato de identidad

project

string

Id. de proyecto o nombre del proyecto

continuationToken

string

Especifica la marca de agua desde la que se va a iniciar el lote. Omita este parámetro para obtener el primer lote de revisiones.

startDateTime

Date

Fecha y hora que se va a usar como punto de partida para las revisiones, todas las revisiones se producirán después de esta fecha y hora. No se puede usar junto con el parámetro "watermark".

Devoluciones

replaceTemplate(WorkItemTemplate, string, string, string)

Reemplazar el contenido de la plantilla

function replaceTemplate(templateContent: WorkItemTemplate, project: string, team: string, templateId: string): Promise<WorkItemTemplate>

Parámetros

templateContent
WorkItemTemplate

Contenido de la plantilla por el que se va a reemplazar

project

string

Id. de proyecto o nombre del proyecto

team

string

Id. de equipo o nombre del equipo

templateId

string

Id. de plantilla

Devoluciones

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

Restaura el elemento de trabajo eliminado de la Papelera de reciclaje.

function restoreWorkItem(payload: WorkItemDeleteUpdate, id: number, project?: string): Promise<WorkItemDelete>

Parámetros

payload
WorkItemDeleteUpdate

Paylod con instrucciones para actualizar la marca IsDeleted a false

id

number

Identificador del elemento de trabajo que se va a restaurar

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<WorkItemDelete>

searchQueries(string, string, number, QueryExpand, boolean)

Busca en todas las consultas a las que el usuario tiene acceso en el proyecto actual.

function searchQueries(project: string, filter: string, top?: number, expand?: QueryExpand, includeDeleted?: boolean): Promise<QueryHierarchyItemsResult>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

filter

string

Texto con el que filtrar las consultas.

top

number

Número de consultas que se van a devolver (el valor predeterminado es 50 y el máximo es 200).

expand
QueryExpand
includeDeleted

boolean

Incluir consultas y carpetas eliminadas

Devoluciones

sendMail(SendMailBody, string)

Método RESTful para enviar correo para los elementos de trabajo seleccionados o consultados.

function sendMail(body: SendMailBody, project?: string): Promise<void>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

Actualice un nodo de clasificación existente.

function updateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>

Parámetros

postedNode
WorkItemClassificationNode

Nodo que se va a crear o actualizar.

project

string

Id. de proyecto o nombre del proyecto

structureGroup
TreeStructureGroup

Grupo de estructura del nodo de clasificación, área o iteración.

path

string

Ruta de acceso del nodo de clasificación.

Devoluciones

updateField(UpdateWorkItemField, string, string)

Actualizar un campo.

function updateField(payload: UpdateWorkItemField, fieldNameOrRefName: string, project?: string): Promise<WorkItemField>

Parámetros

payload
UpdateWorkItemField

La carga contiene el valor deseado de las propiedades del campo.

fieldNameOrRefName

string

Nombre/nombre de referencia del campo que se va a actualizar

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

Actualizar una consulta o una carpeta. Esto le permite actualizar, cambiar el nombre y mover consultas y carpetas.

function updateQuery(queryUpdate: QueryHierarchyItem, project: string, query: string, undeleteDescendants?: boolean): Promise<QueryHierarchyItem>

Parámetros

queryUpdate
QueryHierarchyItem

Consulta que se va a actualizar.

project

string

Id. de proyecto o nombre del proyecto

query

string

Identificador o ruta de acceso de la consulta que se va a actualizar.

undeleteDescendants

boolean

Recuperar los elementos secundarios de esta carpeta. Es importante tener en cuenta que esto no devolverá los cambios de permisos que se aplicaron anteriormente a los descendientes.

Devoluciones

updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)

Novedades un único elemento de trabajo.

function updateWorkItem(document: JsonPatchDocument, id: number, project?: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>

Parámetros

document
JsonPatchDocument

Documento de revisión JSON que representa la actualización

id

number

Identificador del elemento de trabajo que se va a actualizar

project

string

Id. de proyecto o nombre del proyecto

validateOnly

boolean

Indique si solo desea validar los cambios sin guardar el elemento de trabajo.

bypassRules

boolean

No aplicar las reglas de tipo de elemento de trabajo en esta actualización

suppressNotifications

boolean

No active ninguna notificación para este cambio

expand
WorkItemExpand

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

Devoluciones

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

Agregar o actualizar un tipo de elemento de trabajo

function updateWorkItemTypeDefinition(updateModel: WorkItemTypeTemplateUpdateModel, project?: string): Promise<ProvisioningResult>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

Devoluciones