Condividi tramite


Fields - Get

Ottiene informazioni su un campo specifico.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1-preview.3

Parametri dell'URI

Nome In Necessario Tipo Descrizione
fieldNameOrRefName
path True

string

Nome semplice campo o nome di riferimento

organization
path True

string

Nome dell'organizzazione di Azure DevOps.

project
path

string

ID progetto o nome progetto

api-version
query True

string

Versione dell'API da usare. Questa opzione deve essere impostata su '7.1-preview.3' per usare questa versione dell'API.

Risposte

Nome Tipo Descrizione
200 OK

WorkItemField2

operazione riuscita

Sicurezza

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

Nome Descrizione
vso.work Concede la possibilità di leggere elementi di lavoro, query, schede, aree e percorsi iterazioni e altri metadati correlati al rilevamento degli elementi di lavoro. Concede inoltre la possibilità di eseguire query, cercare elementi di lavoro e ricevere notifiche sugli eventi dell'elemento di lavoro tramite hook del servizio.

Esempio

Gets information on a specific field

Sample Request

GET https://dev.azure.com/fabrikam/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1-preview.3

Sample Response

{
  "name": "Iteration Path",
  "referenceName": "System.IterationPath",
  "type": "treePath",
  "readOnly": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Under",
      "name": "Under"
    },
    {
      "referenceName": "SupportedOperations.NotUnder",
      "name": "Not Under"
    },
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath"
}

Definizioni

Nome Descrizione
FieldType

Tipo del campo.

FieldUsage

Utilizzo del campo.

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

WorkItemField2

Descrive un campo in un elemento di lavoro e le proprietà sono specifiche del tipo di elemento di lavoro.

WorkItemFieldOperation

Descrive un'operazione di campo dell'elemento di lavoro.

FieldType

Tipo del campo.

Nome Tipo Descrizione
boolean

string

Tipo di campo booleano.

dateTime

string

Tipo di campo Datetime.

double

string

Tipo di campo doppio.

guid

string

Tipo di campo Guid.

history

string

Tipo di campo Cronologia.

html

string

Tipo di campo HTML (Multiline).

identity

string

Tipo di campo Identity.

integer

string

Tipo di campo Integer.

picklistDouble

string

Tipo di campo selezione doppia. Quando si crea un campo selezione doppia dall'API REST, usare "Double" FieldType.

picklistInteger

string

Tipo di campo elenco di numeri interi. Quando si crea un campo picklist intero dall'API REST, usare FieldType "Integer".

picklistString

string

Tipo di campo selezione stringa. Quando si crea un campo picklist stringa dall'API REST, usare FieldType "String".

plainText

string

Tipo di campo testo normale.

string

string

Tipo di campo Stringa.

treePath

string

Tipo di campo Treepath.

FieldUsage

Utilizzo del campo.

Nome Tipo Descrizione
none

string

Utilizzo vuoto.

tree

string

Utilizzo del campo Treenode.

workItem

string

Utilizzo del campo elemento di lavoro.

workItemLink

string

Utilizzo del campo del collegamento dell'elemento di lavoro.

workItemTypeExtension

string

Utilizzo dell'estensione del tipo di elemento di lavoro.

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

Nome Tipo Descrizione
links

object

Visualizzazione di lettura dei collegamenti. Poiché i collegamenti di riferimento sono in sola lettura, si vuole esporre solo i collegamenti di riferimento come sola lettura.

WorkItemField2

Descrive un campo in un elemento di lavoro e le proprietà sono specifiche del tipo di elemento di lavoro.

Nome Tipo Descrizione
_links

ReferenceLinks

Riferimenti ai collegamenti alle risorse REST correlate.

canSortBy

boolean

Indica se il campo è ordinabile nelle query del server.

description

string

Descrizione del campo.

isDeleted

boolean

Indica se questo campo viene eliminato.

isIdentity

boolean

Indica se questo campo è un campo identity.

isLocked

boolean

Indica se questo campo è contrassegnato come bloccato per la modifica.

isPicklist

boolean

Indica se questa istanza è picklist.

isPicklistSuggested

boolean

Indica se questa istanza è un elenco di selezione suggerito.

isQueryable

boolean

Indica se il campo può essere sottoposto a query nel server.

name

string

Nome del campo.

picklistId

string

Se questo campo è picklist, l'identificatore dell'elenco di selezione associato, in caso contrario null

readOnly

boolean

Indica se il campo è [sola lettura].

referenceName

string

Nome di riferimento del campo.

supportedOperations

WorkItemFieldOperation[]

Operazioni supportate in questo campo.

type

FieldType

Tipo del campo.

url

string

usage

FieldUsage

Utilizzo del campo.

WorkItemFieldOperation

Descrive un'operazione di campo dell'elemento di lavoro.

Nome Tipo Descrizione
name

string

Nome descrittivo dell'operazione.

referenceName

string

Nome di riferimento dell'operazione.