Condividi tramite

Fields - Get

  • Riferimento
Servizio:
Work Item Tracking
Versione API:
7.1

Ottiene informazioni su un campo specifico.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
fieldNameOrRefName
 path True

string

Nome semplice campo o nome 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. Deve essere impostato su '7.1' per usare questa versione dell'API.

Risposte

Nome Tipo Descrizione
200 OK

WorkItemField2

operazione riuscita

Sicurezza

oauth2

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

Ambiti

Nome Descrizione
vso.work Concede la possibilità di leggere elementi di lavoro, query, lavagne, percorsi di aree e 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 degli elementi di lavoro tramite hook del servizio.

Esempio

Gets information on a specific field

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
200 
{
  "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 per rappresentare una raccolta di collegamenti di riferimento REST.
WorkItemField2

Descrive un campo in un elemento di lavoro ed è una proprietà specifica del tipo di elemento di lavoro.
WorkItemFieldOperation

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

FieldType

Enumerazione

Tipo del campo.

Valore Descrizione
boolean

Tipo di campo booleano.
dateTime

Tipo di campo Datetime.
double

Tipo di campo Double.
guid

Tipo di campo GUID.
history

Tipo di campo cronologia.
html

Tipo di campo HTML (multilinea).
identity

Tipo di campo Identity.
integer

Tipo di campo Integer.
picklistDouble

Tipo di campo elenco a discesa doppio. Quando si crea un campo a selezione doppia dall'API REST, usare "Double" FieldType.
picklistInteger

Tipo di campo elenco a discesa integer. Quando si crea un campo picklist integer dall'API REST, usare "Integer" FieldType.
picklistString

Tipo di campo elenco a discesa stringa. Quando si crea un campo elenco a discesa di stringhe dall'API REST, usare "String" FieldType.
plainText

Tipo di campo testo normale.
string

Tipo di campo Stringa.
treePath

Tipo di campo Percorso albero.

FieldUsage

Enumerazione

Utilizzo del campo.

Valore Descrizione
none

Utilizzo vuoto.
tree

Utilizzo del campo treenode.
workItem

Utilizzo dei campi dell'elemento di lavoro.
workItemLink

Utilizzo del campo di collegamento dell'elemento di lavoro.
workItemTypeExtension

Utilizzo dell'estensione del tipo di elemento di lavoro.
Object

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome Tipo Descrizione
links

object

Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

WorkItemField2

Object

Descrive un campo in un elemento di lavoro ed è una proprietà specifica del tipo di elemento di lavoro.

Nome Tipo Descrizione
_links

ReferenceLinks

Collegamenti ai riferimenti 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 è un elenco a discesa.
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 (uuid)

Se questo campo è un elenco a discesa, l'identificatore dell'elenco a discesa 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

Object

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

Nome Tipo Descrizione
name

string

Nome descrittivo dell'operazione.
referenceName

string

Nome di riferimento dell'operazione.