Fields - Get

Riferimento

Service:: Work Item Tracking

API Version:: 5.0

Ottiene informazioni su un campo specifico.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
fieldNameOrRefName	path	True	string	Nome semplice del campo o nome di riferimento
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path		string	ID progetto o nome del progetto
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '5.0' per usare questa versione dell'API.

Risposte

Nome	Tipo	Descrizione
200 OK	WorkItemField	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, bacheche, 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

Sample Request

HTTP

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

Sample Response

Status code:: 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.
WorkItemField	Descrive un campo in un elemento di lavoro e le relative proprietà sono specifiche del tipo di elemento di lavoro.
WorkItemFieldOperation	Descrive un'operazione sul 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 Double.
guid	string	Tipo di campo GUID.
history	string	Tipo di campo Cronologia.
html	string	Tipo di campo HTML (multilinea).
identity	string	Tipo di campo Identity.
integer	string	Tipo di campo Integer.
picklistDouble	string	Tipo di campo elenco a discesa doppio.
picklistInteger	string	Tipo di campo elenco a discesa integer.
picklistString	string	Tipo di campo elenco a discesa stringa.
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 dei campi treenode.
workItem	string	Utilizzo del campo dell'elemento di lavoro.
workItemLink	string	Utilizzo del campo di collegamento dell'elemento di lavoro.
workItemTypeExtension	string	Utilizzo dell'estensione del tipo di elemento di lavoro.

ReferenceLinks

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.

WorkItemField

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

Nome	Tipo	Descrizione
_links	ReferenceLinks	Collegare i riferimenti alle risorse REST correlate.
canSortBy	boolean	Indica se il campo è ordinabile nelle query del server.
description	string	Descrizione del campo.
isIdentity	boolean	Indica se questo campo è un campo Identity.
isPicklist	boolean	Indica se questa istanza è a discesa.
isPicklistSuggested	boolean	Indica se questa istanza è un elenco a discesa suggerito.
isQueryable	boolean	Indica se il campo può essere sottoposto a query nel server.
name	string	Nome del campo.
picklistId	string	Se questo campo è elenco a discesa, l'identificatore dell'elenco a discesa associato; in caso contrario, null
readOnly	boolean	Indica se il campo è [di 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 sul campo dell'elemento di lavoro.

Nome	Tipo	Descrizione
name	string	Nome dell'operazione.
referenceName	string	Nome di riferimento dell'operazione.

Condividi tramite