Condividi tramite

Test Plan Recycle Bin - List

  • Riferimento
Servizio:
Test Plan
Versione API:
7.2-preview.1

Ottenere un elenco di piani di test eliminati

GET https://dev.azure.com/{organization}/{project}/_apis/testplan/recycleBin/testplan?api-version=7.2-preview.1
Con parametri facoltativi: 
GET https://dev.azure.com/{organization}/{project}/_apis/testplan/recycleBin/testplan?continuationToken={continuationToken}&api-version=7.2-preview.1

Parametri dell'URI

Nome In Necessario Tipo Descrizione
organization
 path True

string

Nome dell'organizzazione di Azure DevOps.
project
 path True

string

ID progetto o nome progetto
api-version
 query True

string

Versione dell'API da usare. Deve essere impostato su '7.2-preview.1' per usare questa versione dell'API.
continuationToken
 query

string

Se l'elenco dei piani restituiti non è completo, un token di continuazione per eseguire una query sul batch successivo di piani viene incluso nell'intestazione della risposta come "x-ms-continuationtoken". Omettere questo parametro per ottenere il primo batch di piani di test.

Risposte

Nome Tipo Descrizione
200 OK

TestPlan[]

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.test Concede la possibilità di leggere piani di test, case, risultati e altri artefatti correlati alla gestione dei test.

Esempio

Get Deleted Test Plans

Esempio di richiesta

GET https://dev.azure.com/fabrikam/{project}/_apis/testplan/recycleBin/testplan?api-version=7.2-preview.1

Risposta di esempio

Codice di stato:
200 
transfer-Encoding: chunked
{
  "value": [
    {
      "id": 5,
      "project": {
        "id": "afb62ab2-bd74-41c2-991e-40bbb9c8ca91",
        "name": "sampleProject",
        "state": "unchanged",
        "visibility": "unchanged",
        "lastUpdateTime": "0001-01-01T00:00:00"
      },
      "updatedDate": "2024-08-14T13:27:55.213Z",
      "updatedBy": {
        "displayName": "Fabrikam Fiber",
        "url": "https://dev.azure.com/A81dd05d6-1ccc-41b7-8c1c-d69d153ecc49/_apis/Identities/9c694866-b1b9-6531-98e8-7a05990c5154",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
          }
        },
        "id": "9c694866-b1b9-6531-98e8-7a05990c5154",
        "uniqueName": "[email protected]",
        "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0",
        "descriptor": "msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
      },
      "rootSuite": {
        "id": 6,
        "name": "Plan 1"
      },
      "_links": {
        "_self": {
          "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/5"
        },
        "clientUrl": {
          "href": "mtms://fabrikam.visualstudio.com:443/p:sampleProject/Testing/testplan/connect?id=5"
        },
        "rootSuite": {
          "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/5/Suites/6"
        },
        "build": {
          "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/build/Builds/3"
        }
      },
      "revision": 0,
      "name": "Plan 1",
      "areaPath": "sampleProject\\Team1",
      "startDate": "2024-08-14T13:01:38.143Z",
      "endDate": "2024-08-21T13:01:38.143Z",
      "iteration": "p1",
      "owner": {
        "displayName": "Fabrikam Fiber",
        "url": "https://dev.azure.com/A81dd05d6-1ccc-41b7-8c1c-d69d153ecc49/_apis/Identities/9c694866-b1b9-6531-98e8-7a05990c5154",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
          }
        },
        "id": "9c694866-b1b9-6531-98e8-7a05990c5154",
        "uniqueName": "[email protected]",
        "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0",
        "descriptor": "msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
      },
      "state": "Active",
      "testOutcomeSettings": {
        "syncOutcomeAcrossSuites": false
      }
    },
    {
      "id": 9,
      "project": {
        "id": "afb62ab2-bd74-41c2-991e-40bbb9c8ca91",
        "name": "sampleProject",
        "state": "unchanged",
        "visibility": "unchanged",
        "lastUpdateTime": "0001-01-01T00:00:00"
      },
      "updatedDate": "2024-08-14T13:27:55.213Z",
      "updatedBy": {
        "displayName": "Fabrikam Fiber",
        "url": "https://dev.azure.com/A81dd05d6-1ccc-41b7-8c1c-d69d153ecc49/_apis/Identities/9c694866-b1b9-6531-98e8-7a05990c5154",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
          }
        },
        "id": "9c694866-b1b9-6531-98e8-7a05990c5154",
        "uniqueName": "[email protected]",
        "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0",
        "descriptor": "msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
      },
      "rootSuite": {
        "id": 10,
        "name": "Plan 2"
      },
      "_links": {
        "_self": {
          "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/9"
        },
        "clientUrl": {
          "href": "mtms://fabrikam.visualstudio.com:443/p:sampleProject/Testing/testplan/connect?id=9"
        },
        "rootSuite": {
          "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/9/Suites/10"
        },
        "build": {
          "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/build/Builds/3"
        }
      },
      "revision": 0,
      "name": "Plan 2",
      "areaPath": "sampleProject\\Team1",
      "startDate": "2024-08-14T13:01:38.143Z",
      "endDate": "2024-08-21T13:01:38.143Z",
      "iteration": "p1",
      "owner": {
        "displayName": "Fabrikam Fiber",
        "url": "https://dev.azure.com/A81dd05d6-1ccc-41b7-8c1c-d69d153ecc49/_apis/Identities/9c694866-b1b9-6531-98e8-7a05990c5154",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
          }
        },
        "id": "9c694866-b1b9-6531-98e8-7a05990c5154",
        "uniqueName": "[email protected]",
        "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0",
        "descriptor": "msa.OWM2OTQ4NjYtYjFiOS03NTMxLTk4ZTgtN2EwNTk5MGM1MTU0"
      },
      "state": "Active",
      "testOutcomeSettings": {
        "syncOutcomeAcrossSuites": false
      }
    }
  ],
  "count": 2
}

Definizioni

Nome Descrizione
BuildDefinitionReference

Risorsa di riferimento per la definizione di compilazione
IdentityRef
ProjectState

Stato del progetto.
ProjectVisibility

Visibilità del progetto.
ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.
ReleaseEnvironmentDefinitionReference

Riferimento alla risorsa dell'ambiente di rilascio.
TeamProjectReference

Rappresenta un riferimento superficiale a un oggetto TeamProject.
TestOutcomeSettings

Impostazioni dei risultati dei test
TestPlan

Risorsa del piano di test.
TestSuiteReference

Risorsa di riferimento del gruppo di test.
YamlReleaseReference

Riferimento alla risorsa di versione yaml.

BuildDefinitionReference

Object

Risorsa di riferimento per la definizione di compilazione

Nome Tipo Descrizione
id

integer (int32)

ID della definizione di compilazione
name

string

Nome della definizione di compilazione

IdentityRef

Object
Nome Tipo Descrizione
_links

ReferenceLinks

Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate sull'oggetto grafico.
descriptor

string

Il descrittore è il modo principale per fare riferimento all'oggetto del grafo mentre il sistema è in esecuzione. Questo campo identificherà in modo univoco lo stesso soggetto del grafico in account e organizzazioni.
directoryAlias

string

Deprecato: può essere recuperato eseguendo una query sull'utente graph a cui si fa riferimento nella voce "self" del dizionario IdentityRef "_links"
displayName

string

Si tratta del nome visualizzato non univoco dell'oggetto del grafico. Per modificare questo campo, è necessario modificarne il valore nel provider di origine.
id

string

imageUrl

string

Deprecato : disponibile nella voce "avatar" del dizionario IdentityRef "_links"
inactive

boolean

Deprecato: può essere recuperato eseguendo una query sullo stato di appartenenza graph a cui si fa riferimento nella voce "membershipState" del dizionario "_links" GraphUser
isAadIdentity

boolean

Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Deprecato: non in uso nella maggior parte delle implementazioni preesistenti di ToIdentityRef
uniqueName

string

Deprecato: usare invece Domain+PrincipalName
url

string

Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

ProjectState

Enumerazione

Stato del progetto.

Valore Descrizione
all

Tutti i progetti indipendentemente dallo stato tranne Deleted.
createPending

Il progetto è stato accodato per la creazione, ma il processo non è ancora stato avviato.
deleted

Il progetto è stato eliminato.
deleting

Il progetto è in corso di eliminazione.
new

Il progetto è in fase di creazione.
unchanged

Il progetto non è stato modificato.
wellFormed

Il progetto è completamente creato e pronto per l'uso.

ProjectVisibility

Enumerazione

Visibilità del progetto.

Valore Descrizione
private

Il progetto è visibile solo agli utenti con accesso esplicito.
public

Il progetto è visibile a tutti.
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.

ReleaseEnvironmentDefinitionReference

Object

Riferimento alla risorsa dell'ambiente di rilascio.

Nome Tipo Descrizione
definitionId

integer (int32)

ID della definizione di versione che contiene la definizione dell'ambiente di rilascio.
environmentDefinitionId

integer (int32)

ID della definizione dell'ambiente di rilascio.

TeamProjectReference

Object

Rappresenta un riferimento superficiale a un oggetto TeamProject.

Nome Tipo Descrizione
abbreviation

string

Abbreviazione del progetto.
defaultTeamImageUrl

string

URL dell'immagine di identità del team predefinita.
description

string

Descrizione del progetto (se presente).
id

string (uuid)

Identificatore del progetto.
lastUpdateTime

string (date-time)

Ora dell'ultimo aggiornamento del progetto.
name

string

Nome progetto.
revision

integer (int64)

Revisione del progetto.
state

ProjectState

Stato del progetto.
url

string

URL della versione completa dell'oggetto.
visibility

ProjectVisibility

Visibilità del progetto.

TestOutcomeSettings

Object

Impostazioni dei risultati dei test

Nome Tipo Descrizione
syncOutcomeAcrossSuites

boolean

Valore per configurare la modalità di visualizzazione dei risultati dei test per gli stessi test tra gruppi

TestPlan

Object

Risorsa del piano di test.

Nome Tipo Descrizione
_links

ReferenceLinks

Collegamenti pertinenti
areaPath

string

Area del piano di test.
buildDefinition

BuildDefinitionReference

Definizione di compilazione che genera una compilazione associata a questo piano di test.
buildId

integer (int32)

Compilazione da testare.
description

string

Descrizione del piano di test.
endDate

string (date-time)

Data di fine per il piano di test.
id

integer (int32)

ID del piano di test.
iteration

string

Percorso di iterazione del piano di test.
name

string

Nome del piano di test.
owner

IdentityRef

Proprietario del piano di test.
previousBuildId

integer (int32)

ID di compilazione precedente associato al piano di test
project

TeamProjectReference

Progetto che contiene il piano di test.
releaseEnvironmentDefinition

ReleaseEnvironmentDefinitionReference

Ambiente di rilascio da usare per distribuire la compilazione ed eseguire test automatizzati da questo piano di test.
revision

integer (int32)

Revisione del piano di test.
rootSuite

TestSuiteReference

Gruppo di test radice del piano di test.
startDate

string (date-time)

Data di inizio per il piano di test.
state

string

Stato del piano di test.
testOutcomeSettings

TestOutcomeSettings

Valore per configurare il comportamento degli stessi test tra gruppi di test in un piano di test
updatedBy

IdentityRef

Riferimento all'identità per l'ultimo aggiornamento del piano di test
updatedDate

string (date-time)

Data aggiornata del piano di test
yamlReleaseReference

YamlReleaseReference

Riferimento alla versione Yaml associato a questo piano di test.

TestSuiteReference

Object

Risorsa di riferimento del gruppo di test.

Nome Tipo Descrizione
id

integer (int32)

ID del gruppo di test.
name

string

Nome del gruppo di test.

YamlReleaseReference

Object

Riferimento alla risorsa di versione yaml.

Nome Tipo Descrizione
definitionId

integer (int32)

ID della definizione di versione yaml
stagesToSkip

string

Fasi da ignorare durante l'accodamento della versione yaml.