TestPlanRestClient class

Paquet:: azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS

Extends: RestClientBase

Constructeurs

TestPlanRestClient(IVssRestClientOptions)

Méthodes

addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)	Ajouter des cas de test à une suite avec des configurations spécifiées
cloneTestCase(CloneTestCaseParams, string)
cloneTestPlan(CloneTestPlanParams, string, boolean)	Cloner le plan de test
cloneTestSuite(CloneTestSuiteParams, string, boolean)	Cloner la suite de tests
createBulkTestSuites(TestSuiteCreateParams[], string, number, number)	Créez des suites de test basées sur des exigences en bloc.
createTestConfiguration(TestConfigurationCreateUpdateParameters, string)	Créez une configuration de test.
createTestPlan(TestPlanCreateParams, string)	Créez un plan de test.
createTestPlanWithTestCases(TestPlanWithTestCasesCreateParams, string)	Créez un plan de test avec des cas de test en mettant un travail en file d’attente.
createTestSuite(TestSuiteCreateParams, string, number)	Créez une suite de tests.
createTestVariable(TestVariableCreateUpdateParameters, string)	Créez une variable de test.
deleteTestCase(string, number)	Supprimez un cas de test.
deleteTestConfguration(string, number)	Supprimez une configuration de test par son ID.
deleteTestPlan(string, number)	Supprimez un plan de test.
deleteTestSuite(string, number, number)	Supprimez la suite de tests.
deleteTestVariable(string, number)	Supprimez une variable de test par son ID.
exportTestCases(ExportTestCaseParams, string)	Exporte un ensemble de cas de test d’une suite vers un fichier. Formats actuellement pris en charge : xlsx
getCloneInformation(string, number)	Obtenez des informations de clonage.
getDeletedTestPlans(string, string)	Obtenir la liste des plans de test supprimés
getDeletedTestSuitesForPlan(string, number, SuiteExpand, string, boolean)	Obtenir les suites de tests supprimées pour un plan de test.
getDeletedTestSuitesForProject(string, SuiteExpand, string, boolean)	Obtenir les suites de tests supprimées au sein d’un projet.
getPoints(string, number, number, string, boolean, boolean)	Obtenez un point de test particulier à partir d’une suite.
getPointsList(string, number, number, string, string, string, boolean, boolean, boolean)	Obtenir tous les points à l’intérieur d’une suite en fonction de certains filtres
getSuiteCloneInformation(string, number)	Obtenez des informations de clonage.
getSuiteEntries(string, number, SuiteEntryTypes)	Obtenez la liste des entrées de suite de tests dans la suite de tests.
getSuitesByTestCaseId(number)	Recherchez la liste de toutes les suites de tests dans lesquelles un cas de test donné est présent. Cela est utile si vous devez savoir quelles suites de tests utilisent un cas de test, lorsque vous devez apporter des modifications à un cas de test.
getTestCase(string, number, number, string, string, boolean)	Obtenez un cas de test particulier à partir d’une suite.
getTestCaseCloneInformation(string, number)	Obtenez des informations de clonage.
getTestCaseList(string, number, number, string, string, string, string, boolean, boolean, ExcludeFlags, boolean)	Obtenir la liste des cas de test retourne les cas de test qui ont tous les ID de configuration, comme indiqué dans le paramètre facultatif. Si les ID de configuration sont null, il retourne tous les cas de test
getTestConfigurationById(string, number)	Obtenir une configuration de test
getTestConfigurations(string, string)	Obtenez la liste des configurations de test.
getTestEntityCountByPlanId(string, number, string, UserFriendlyTestOutcome, string, string, string, TestEntityTypes)
getTestPlanById(string, number)	Obtenez un plan de test par ID.
getTestPlans(string, string, string, boolean, boolean)	Obtenir la liste des plans de test
getTestSuiteById(string, number, number, SuiteExpand)	Obtenir la suite de tests par ID de suite.
getTestSuitesForPlan(string, number, SuiteExpand, string, boolean)	Obtenez des suites de test pour le plan.
getTestVariableById(string, number)	Obtenez une variable de test par son ID.
getTestVariables(string, string)	Obtenir la liste des variables de test.
removeTestCasesFromSuite(string, number, number, string)	Supprime les cas de test d’une suite en fonction de la liste des ID de cas de test fournis.
removeTestCasesListFromSuite(string, number, number, string)	Supprime les cas de test d’une suite en fonction de la liste des ID de cas de test fournis. Cette API peut être utilisée pour supprimer un plus grand nombre de cas de test.
reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)	Réorganiser les entrées de suite de test dans la suite de tests.
restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)	Restaure le plan de test supprimé
restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)	Restaure la suite de tests supprimée
updateSuiteTestCases(SuiteTestCaseCreateUpdateParameters[], string, number, number)	Mettre à jour les configurations pour les cas de test
updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)	Mettez à jour une configuration de test par son ID.
updateTestPlan(TestPlanUpdateParams, string, number)	Mettez à jour un plan de test.
updateTestPoints(TestPointUpdateParams[], string, number, number, boolean, boolean)	Mettre à jour les points de test. Il est utilisé pour réinitialiser le point de test sur actif, mettre à jour le résultat d’un point de test ou mettre à jour le testeur d’un point de test
updateTestSuite(TestSuiteUpdateParams, string, number, number)	Mettre à jour la suite de tests.
updateTestVariable(TestVariableCreateUpdateParameters, string, number)	Mettez à jour une variable de test par son ID.

Détails du constructeur

TestPlanRestClient(IVssRestClientOptions)

new TestPlanRestClient(options: IVssRestClientOptions)

Paramètres

options: IVssRestClientOptions

Détails de la méthode

addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)

Ajouter des cas de test à une suite avec des configurations spécifiées

function addTestCasesToSuite(suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestCase[]>

Paramètres

suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]

Objet SuiteTestCaseCreateUpdateParameters.

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test auquel les cas de test doivent être ajoutés.

suiteId: number

ID de la suite de tests à laquelle les cas de test doivent être ajoutés.

Retours

Promise<TestCase[]>

cloneTestCase(CloneTestCaseParams, string)

function cloneTestCase(cloneRequestBody: CloneTestCaseParams, project: string): Promise<CloneTestCaseOperationInformation>

Paramètres

cloneRequestBody: CloneTestCaseParams

project: string

ID de projet ou nom du projet

Retours

Promise<CloneTestCaseOperationInformation>

cloneTestPlan(CloneTestPlanParams, string, boolean)

Cloner le plan de test

function cloneTestPlan(cloneRequestBody: CloneTestPlanParams, project: string, deepClone?: boolean): Promise<CloneTestPlanOperationInformation>

Paramètres

cloneRequestBody: CloneTestPlanParams

Détail du corps de la demande de clone de plan TestPlanCloneRequest

project: string

ID de projet ou nom du projet

deepClone: boolean

Clone également tous les cas de test associés

Retours

Promise<CloneTestPlanOperationInformation>

cloneTestSuite(CloneTestSuiteParams, string, boolean)

Cloner la suite de tests

function cloneTestSuite(cloneRequestBody: CloneTestSuiteParams, project: string, deepClone?: boolean): Promise<CloneTestSuiteOperationInformation>

Paramètres

cloneRequestBody: CloneTestSuiteParams

Détail du corps de la demande de la suite TestSuiteCloneRequest

project: string

ID de projet ou nom du projet

deepClone: boolean

Clone également tous les cas de test associés

Retours

Promise<CloneTestSuiteOperationInformation>

createBulkTestSuites(TestSuiteCreateParams[], string, number, number)

Créez des suites de test basées sur des exigences en bloc.

function createBulkTestSuites(testSuiteCreateParams: TestSuiteCreateParams[], project: string, planId: number, parentSuiteId: number): Promise<TestSuite[]>

Paramètres

testSuiteCreateParams: TestSuiteCreateParams[]

Paramètres de création de suite

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test où les suites basées sur les exigences doivent être créées.

parentSuiteId: number

ID de la suite parente sous laquelle les suites basées sur les exigences seront créées

Retours

Promise<TestSuite[]>

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

Créez une configuration de test.

function createTestConfiguration(testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters, project: string): Promise<TestConfiguration>

Paramètres

testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project: string

ID de projet ou nom du projet

Retours

Promise<TestConfiguration>

createTestPlan(TestPlanCreateParams, string)

Créez un plan de test.

function createTestPlan(testPlanCreateParams: TestPlanCreateParams, project: string): Promise<TestPlan>

Paramètres

testPlanCreateParams: TestPlanCreateParams

Objet testPlanCreateParams. TestPlanCreateParams

project: string

ID de projet ou nom du projet

Retours

Promise<TestPlan>

createTestPlanWithTestCases(TestPlanWithTestCasesCreateParams, string)

Créez un plan de test avec des cas de test en mettant un travail en file d’attente.

function createTestPlanWithTestCases(creationParams: TestPlanWithTestCasesCreateParams, project: string): Promise<boolean>

Paramètres

creationParams: TestPlanWithTestCasesCreateParams

Paramètres de création du plan de test et des cas de test.

project: string

ID de projet ou nom du projet

Retours

Promise<boolean>

createTestSuite(TestSuiteCreateParams, string, number)

Créez une suite de tests.

function createTestSuite(testSuiteCreateParams: TestSuiteCreateParams, project: string, planId: number): Promise<TestSuite>

Paramètres

testSuiteCreateParams: TestSuiteCreateParams

Paramètres de création de suite

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test qui contient les suites.

Retours

Promise<TestSuite>

createTestVariable(TestVariableCreateUpdateParameters, string)

Créez une variable de test.

function createTestVariable(testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters, project: string): Promise<TestVariable>

Paramètres

testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project: string

ID de projet ou nom du projet

Retours

Promise<TestVariable>

deleteTestCase(string, number)

Supprimez un cas de test.

function deleteTestCase(project: string, testCaseId: number): Promise<void>

Paramètres

project: string

ID de projet ou nom du projet

testCaseId: number

ID du cas de test à supprimer.

Retours

Promise<void>

deleteTestConfguration(string, number)

Supprimez une configuration de test par son ID.

function deleteTestConfguration(project: string, testConfiguartionId: number): Promise<void>

Paramètres

project: string

ID de projet ou nom du projet

testConfiguartionId: number

ID de la configuration de test à supprimer.

Retours

Promise<void>

deleteTestPlan(string, number)

Supprimez un plan de test.

function deleteTestPlan(project: string, planId: number): Promise<void>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test à supprimer.

Retours

Promise<void>

deleteTestSuite(string, number, number)

Supprimez la suite de tests.

function deleteTestSuite(project: string, planId: number, suiteId: number): Promise<void>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test qui contient la suite.

suiteId: number

ID de la suite de tests à supprimer.

Retours

Promise<void>

deleteTestVariable(string, number)

Supprimez une variable de test par son ID.

function deleteTestVariable(project: string, testVariableId: number): Promise<void>

Paramètres

project: string

ID de projet ou nom du projet

testVariableId: number

ID de la variable de test à supprimer.

Retours

Promise<void>

exportTestCases(ExportTestCaseParams, string)

Exporte un ensemble de cas de test d’une suite vers un fichier. Formats actuellement pris en charge : xlsx

function exportTestCases(exportTestCaseRequestBody: ExportTestCaseParams, project: string): Promise<ArrayBuffer>

Paramètres

exportTestCaseRequestBody: ExportTestCaseParams

Objet ExportTestCaseParams. ExportTestCaseParams

project: string

ID de projet ou nom du projet

Retours

Promise<ArrayBuffer>

getCloneInformation(string, number)

Obtenez des informations de clonage.

function getCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestPlanOperationInformation>

Paramètres

project: string

ID de projet ou nom du projet

cloneOperationId: number

ID d’opération retourné lorsque nous mettons en file d’attente une opération clone

Retours

Promise<CloneTestPlanOperationInformation>

getDeletedTestPlans(string, string)

Obtenir la liste des plans de test supprimés

function getDeletedTestPlans(project: string, continuationToken?: string): Promise<PagedList<TestPlan>>

Paramètres

project: string

ID de projet ou nom du projet

continuationToken: string

Si la liste des plans retournés n’est pas terminée, un jeton de continuation pour interroger le lot suivant de plans est inclus dans l’en-tête de réponse « x-ms-continuationtoken ». Omettez ce paramètre pour obtenir le premier lot de plans de test.

Retours

Promise<PagedList<TestPlan>>

getDeletedTestSuitesForPlan(string, number, SuiteExpand, string, boolean)

Obtenir les suites de tests supprimées pour un plan de test.

function getDeletedTestSuitesForPlan(project: string, planId: number, expand?: SuiteExpand, continuationToken?: string, asTreeView?: boolean): Promise<PagedList<TestSuite>>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test pour lequel les suites sont demandées.

expand: SuiteExpand

Incluez les suites enfants et les détails des testeurs.

continuationToken: string

Si la liste des suites retournées n’est pas terminée, un jeton de continuation pour interroger le lot suivant de suites est inclus dans l’en-tête de réponse « x-ms-continuationtoken ». Omettez ce paramètre pour obtenir le premier lot de suites de test.

asTreeView: boolean

Si les suites retournées doivent se trouver dans une arborescence.

Retours

Promise<PagedList<TestSuite>>

getDeletedTestSuitesForProject(string, SuiteExpand, string, boolean)

Obtenir les suites de tests supprimées au sein d’un projet.

function getDeletedTestSuitesForProject(project: string, expand?: SuiteExpand, continuationToken?: string, asTreeView?: boolean): Promise<PagedList<TestSuite>>

Paramètres

project: string

ID de projet ou nom du projet

expand: SuiteExpand

Incluez les suites enfants et les détails des testeurs.

continuationToken: string

asTreeView: boolean

Si les suites retournées doivent se trouver dans une arborescence.

Retours

Promise<PagedList<TestSuite>>

getPoints(string, number, number, string, boolean, boolean)

Obtenez un point de test particulier à partir d’une suite.

function getPoints(project: string, planId: number, suiteId: number, pointId: string, returnIdentityRef?: boolean, includePointDetails?: boolean): Promise<TestPoint[]>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test pour lequel les points de test sont demandés.

suiteId: number

ID de la suite de tests pour laquelle les points de test sont demandés.

pointId: string

ID du point de test à extraire.

returnIdentityRef: boolean

Si la valeur est true, renvoie le champ AssignedTo dans TestCaseReference en tant qu’objet IdentityRef.

includePointDetails: boolean

Si la valeur est false, obtient une charge utile plus petite contenant uniquement des détails de base sur l’objet de point de test

Retours

Promise<TestPoint[]>

getPointsList(string, number, number, string, string, string, boolean, boolean, boolean)

Obtenir tous les points à l’intérieur d’une suite en fonction de certains filtres

function getPointsList(project: string, planId: number, suiteId: number, testPointIds?: string, testCaseId?: string, continuationToken?: string, returnIdentityRef?: boolean, includePointDetails?: boolean, isRecursive?: boolean): Promise<PagedList<TestPoint>>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test pour lequel les points de test sont demandés.

suiteId: number

ID de la suite de tests pour laquelle les points de test sont demandés

testPointIds: string

ID des points de test à extraire.

testCaseId: string

Obtenir des points de test pour des ID de cas de test spécifiques.

continuationToken: string

Si la liste du point de test retourné n’est pas terminée, un jeton de continuation pour interroger le lot suivant de points de test est inclus dans l’en-tête de réponse « x-ms-continuationtoken ». Omettez ce paramètre pour obtenir le premier lot de points de test.

returnIdentityRef: boolean

Si la valeur est true, renvoie le champ AssignedTo dans TestCaseReference en tant qu’objet IdentityRef.

includePointDetails: boolean

Si la valeur est false, obtient une charge utile plus petite contenant uniquement des détails de base sur l’objet de point de test

isRecursive: boolean

Si la valeur est true, récupère également les points de test appartenant aux suites enfants de manière récursive.

Retours

Promise<PagedList<TestPoint>>

getSuiteCloneInformation(string, number)

Obtenez des informations de clonage.

function getSuiteCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestSuiteOperationInformation>

Paramètres

project: string

ID de projet ou nom du projet

cloneOperationId: number

ID d’opération retourné lorsque nous mettons en file d’attente une opération clone

Retours

Promise<CloneTestSuiteOperationInformation>

getSuiteEntries(string, number, SuiteEntryTypes)

Obtenez la liste des entrées de suite de tests dans la suite de tests.

function getSuiteEntries(project: string, suiteId: number, suiteEntryType?: SuiteEntryTypes): Promise<SuiteEntry[]>

Paramètres

project: string

ID de projet ou nom du projet

suiteId: number

ID de la suite parente.

suiteEntryType: SuiteEntryTypes

Retours

Promise<SuiteEntry[]>

getSuitesByTestCaseId(number)

Recherchez la liste de toutes les suites de tests dans lesquelles un cas de test donné est présent. Cela est utile si vous devez savoir quelles suites de tests utilisent un cas de test, lorsque vous devez apporter des modifications à un cas de test.

function getSuitesByTestCaseId(testCaseId: number): Promise<TestSuite[]>

Paramètres

testCaseId: number

ID du cas de test pour lequel les suites doivent être extraites.

Retours

Promise<TestSuite[]>

getTestCase(string, number, number, string, string, boolean)

Obtenez un cas de test particulier à partir d’une suite.

function getTestCase(project: string, planId: number, suiteId: number, testCaseId: string, witFields?: string, returnIdentityRef?: boolean): Promise<TestCase[]>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test pour lequel les cas de test sont demandés.

suiteId: number

ID de la suite de tests pour laquelle les cas de test sont demandés.

testCaseId: string

ID de cas de test à extraire.

witFields: string

Obtenez la liste des witFields.

returnIdentityRef: boolean

Si la valeur est true, retourne tous les champs d’identité, tels que AssignedTo, ActivatedBy, etc., en tant qu’objets IdentityRef. Si la valeur est false, ces champs sont retournés sous forme de noms uniques au format de chaîne. Cette valeur est false par défaut.

Retours

Promise<TestCase[]>

getTestCaseCloneInformation(string, number)

Obtenez des informations de clonage.

function getTestCaseCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestCaseOperationInformation>

Paramètres

project: string

ID de projet ou nom du projet

cloneOperationId: number

ID d’opération retourné lorsque nous mettons en file d’attente une opération clone

Retours

Promise<CloneTestCaseOperationInformation>

getTestCaseList(string, number, number, string, string, string, string, boolean, boolean, ExcludeFlags, boolean)

Obtenir la liste des cas de test retourne les cas de test qui ont tous les ID de configuration, comme indiqué dans le paramètre facultatif. Si les ID de configuration sont null, il retourne tous les cas de test

function getTestCaseList(project: string, planId: number, suiteId: number, testIds?: string, configurationIds?: string, witFields?: string, continuationToken?: string, returnIdentityRef?: boolean, expand?: boolean, excludeFlags?: ExcludeFlags, isRecursive?: boolean): Promise<PagedList<TestCase>>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test pour lequel les cas de test sont demandés.

suiteId: number

ID de la suite de tests pour laquelle les cas de test sont demandés.

testIds: string

ID de cas de test à extraire.

configurationIds: string

Récupérez les cas de test qui contiennent tous les ID de configuration spécifiés.

witFields: string

Obtenez la liste des witFields.

continuationToken: string

Si la liste des cas de test retournés n’est pas terminée, un jeton de continuation pour interroger le lot suivant de cas de test est inclus dans l’en-tête de réponse « x-ms-continuationtoken ». Omettez ce paramètre pour obtenir le premier lot de cas de test.

returnIdentityRef: boolean

expand: boolean

Si la valeur est false, obtient une charge utile plus petite contenant uniquement des détails de base sur l’objet de cas de test de suite

excludeFlags: ExcludeFlags

Indicateur permettant d’exclure différentes valeurs de la charge utile. Par exemple, pour supprimer la passe d’affectations de points, excluez = 1. Pour supprimer des informations supplémentaires (liens, plan de test, suite de tests) passez l’exclusion = 2. Pour supprimer à la fois les informations supplémentaires et le passage des affectations de points, excluez = 3 (1 + 2).

isRecursive: boolean

Retours

Promise<PagedList<TestCase>>

getTestConfigurationById(string, number)

Obtenir une configuration de test

function getTestConfigurationById(project: string, testConfigurationId: number): Promise<TestConfiguration>

Paramètres

project: string

ID de projet ou nom du projet

testConfigurationId: number

ID de la configuration de test à obtenir.

Retours

Promise<TestConfiguration>

getTestConfigurations(string, string)

Obtenez la liste des configurations de test.

function getTestConfigurations(project: string, continuationToken?: string): Promise<PagedList<TestConfiguration>>

Paramètres

project: string

ID de projet ou nom du projet

continuationToken: string

Si la liste des configurations retournées n’est pas terminée, un jeton de continuation pour interroger le lot suivant de configurations est inclus dans l’en-tête de réponse « x-ms-continuationtoken ». Omettez ce paramètre pour obtenir le premier lot de configurations de test.

Retours

Promise<PagedList<TestConfiguration>>

getTestEntityCountByPlanId(string, number, string, UserFriendlyTestOutcome, string, string, string, TestEntityTypes)

function getTestEntityCountByPlanId(project: string, planId: number, states?: string, outcome?: UserFriendlyTestOutcome, configurations?: string, testers?: string, assignedTo?: string, entity?: TestEntityTypes): Promise<TestEntityCount[]>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

states: string

outcome: UserFriendlyTestOutcome

configurations: string

testers: string

assignedTo: string

entity: TestEntityTypes

Retours

Promise<TestEntityCount[]>

getTestPlanById(string, number)

Obtenez un plan de test par ID.

function getTestPlanById(project: string, planId: number): Promise<TestPlan>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test à obtenir.

Retours

Promise<TestPlan>

getTestPlans(string, string, string, boolean, boolean)

Obtenir la liste des plans de test

function getTestPlans(project: string, owner?: string, continuationToken?: string, includePlanDetails?: boolean, filterActivePlans?: boolean): Promise<PagedList<TestPlan>>

Paramètres

project: string

ID de projet ou nom du projet

owner: string

Filtrer le plan de test par ID de propriétaire ou nom

continuationToken: string

includePlanDetails: boolean

Obtenir toutes les propriétés du plan de test

filterActivePlans: boolean

Obtenir uniquement les plans actifs

Retours

Promise<PagedList<TestPlan>>

getTestSuiteById(string, number, number, SuiteExpand)

Obtenir la suite de tests par ID de suite.

function getTestSuiteById(project: string, planId: number, suiteId: number, expand?: SuiteExpand): Promise<TestSuite>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test qui contient les suites.

suiteId: number

ID de la suite à obtenir.

expand: SuiteExpand

Inclure les suites enfants et les détails des testeurs

Retours

Promise<TestSuite>

getTestSuitesForPlan(string, number, SuiteExpand, string, boolean)

Obtenez des suites de test pour le plan.

function getTestSuitesForPlan(project: string, planId: number, expand?: SuiteExpand, continuationToken?: string, asTreeView?: boolean): Promise<PagedList<TestSuite>>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test pour lequel les suites sont demandées.

expand: SuiteExpand

Incluez les suites enfants et les détails des testeurs.

continuationToken: string

asTreeView: boolean

Si les suites retournées doivent se trouver dans une arborescence.

Retours

Promise<PagedList<TestSuite>>

getTestVariableById(string, number)

Obtenez une variable de test par son ID.

function getTestVariableById(project: string, testVariableId: number): Promise<TestVariable>

Paramètres

project: string

ID de projet ou nom du projet

testVariableId: number

ID de la variable de test à obtenir.

Retours

Promise<TestVariable>

getTestVariables(string, string)

Obtenir la liste des variables de test.

function getTestVariables(project: string, continuationToken?: string): Promise<PagedList<TestVariable>>

Paramètres

project: string

ID de projet ou nom du projet

continuationToken: string

Si la liste des variables retournées n’est pas terminée, un jeton de continuation pour interroger le lot suivant de variables est inclus dans l’en-tête de réponse en tant que « x-ms-continuationtoken ». Omettez ce paramètre pour obtenir le premier lot de variables de test.

Retours

Promise<PagedList<TestVariable>>

removeTestCasesFromSuite(string, number, number, string)

Supprime les cas de test d’une suite en fonction de la liste des ID de cas de test fournis.

function removeTestCasesFromSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test dont les cas de test doivent être supprimés.

suiteId: number

ID de la suite de tests à partir de laquelle les cas de test doivent être supprimés.

testCaseIds: string

ID de cas de test à supprimer.

Retours

Promise<void>

removeTestCasesListFromSuite(string, number, number, string)

Supprime les cas de test d’une suite en fonction de la liste des ID de cas de test fournis. Cette API peut être utilisée pour supprimer un plus grand nombre de cas de test.

function removeTestCasesListFromSuite(project: string, planId: number, suiteId: number, testIds: string): Promise<void>

Paramètres

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test dont les cas de test doivent être supprimés.

suiteId: number

ID de la suite de tests à partir de laquelle les cas de test doivent être supprimés.

testIds: string

Chaîne séparée par des virgules des ID de cas de test à supprimer.

Retours

Promise<void>

reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)

Réorganiser les entrées de suite de test dans la suite de tests.

function reorderSuiteEntries(suiteEntries: SuiteEntryUpdateParams[], project: string, suiteId: number): Promise<SuiteEntry[]>

Paramètres

suiteEntries: SuiteEntryUpdateParams[]

Liste de SuiteEntry à réorganiser.

project: string

ID de projet ou nom du projet

suiteId: number

ID de la suite de test parente.

Retours

Promise<SuiteEntry[]>

restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)

Restaure le plan de test supprimé

function restoreDeletedTestPlan(restoreModel: TestPlanAndSuiteRestoreModel, project: string, planId: number): Promise<void>

Paramètres

restoreModel: TestPlanAndSuiteRestoreModel

Modèle contenant les informations de restauration

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test à restaurer

Retours

Promise<void>

restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)

Restaure la suite de tests supprimée

function restoreDeletedTestSuite(payload: TestPlanAndSuiteRestoreModel, project: string, suiteId: number): Promise<void>

Paramètres

payload: TestPlanAndSuiteRestoreModel

Modèle contenant les informations de restauration

project: string

ID de projet ou nom du projet

suiteId: number

ID de la suite de tests à restaurer

Retours

Promise<void>

updateSuiteTestCases(SuiteTestCaseCreateUpdateParameters[], string, number, number)

Mettre à jour les configurations pour les cas de test

function updateSuiteTestCases(suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestCase[]>

Paramètres

suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]

Objet SuiteTestCaseCreateUpdateParameters.

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test auquel les cas de test doivent être mis à jour.

suiteId: number

ID de la suite de tests vers laquelle les cas de test doivent être mis à jour.

Retours

Promise<TestCase[]>

updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)

Mettez à jour une configuration de test par son ID.

function updateTestConfiguration(testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters, project: string, testConfiguartionId: number): Promise<TestConfiguration>

Paramètres

testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project: string

ID de projet ou nom du projet

testConfiguartionId: number

ID de la configuration de test à mettre à jour.

Retours

Promise<TestConfiguration>

updateTestPlan(TestPlanUpdateParams, string, number)

Mettez à jour un plan de test.

function updateTestPlan(testPlanUpdateParams: TestPlanUpdateParams, project: string, planId: number): Promise<TestPlan>

Paramètres

testPlanUpdateParams: TestPlanUpdateParams

Objet testPlanUpdateParams. TestPlanUpdateParams

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test à mettre à jour.

Retours

Promise<TestPlan>

updateTestPoints(TestPointUpdateParams[], string, number, number, boolean, boolean)

Mettre à jour les points de test. Il est utilisé pour réinitialiser le point de test sur actif, mettre à jour le résultat d’un point de test ou mettre à jour le testeur d’un point de test

function updateTestPoints(testPointUpdateParams: TestPointUpdateParams[], project: string, planId: number, suiteId: number, includePointDetails?: boolean, returnIdentityRef?: boolean): Promise<TestPoint[]>

Paramètres

testPointUpdateParams: TestPointUpdateParams[]

Objet TestPointUpdateParams.

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test pour lequel les points de test sont demandés.

suiteId: number

ID de la suite de tests pour laquelle les points de test sont demandés.

includePointDetails: boolean

Si la valeur est false, obtient une charge utile plus petite contenant uniquement des détails de base sur l’objet de point de test

returnIdentityRef: boolean

Si la valeur est true, renvoie le champ AssignedTo dans TestCaseReference en tant qu’objet IdentityRef.

Retours

Promise<TestPoint[]>

updateTestSuite(TestSuiteUpdateParams, string, number, number)

Mettre à jour la suite de tests.

function updateTestSuite(testSuiteUpdateParams: TestSuiteUpdateParams, project: string, planId: number, suiteId: number): Promise<TestSuite>

Paramètres

testSuiteUpdateParams: TestSuiteUpdateParams

Paramètres pour la mise à jour des suites

project: string

ID de projet ou nom du projet

planId: number

ID du plan de test qui contient les suites.

suiteId: number

ID de la suite parente.

Retours

Promise<TestSuite>

updateTestVariable(TestVariableCreateUpdateParameters, string, number)

Mettez à jour une variable de test par son ID.

function updateTestVariable(testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters, project: string, testVariableId: number): Promise<TestVariable>

Paramètres

testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project: string

ID de projet ou nom du projet

testVariableId: number

ID de la variable de test à mettre à jour.

Retours

Promise<TestVariable>

Rétroaction

Cette page vous a-t-elle été utile ?

Partager via

TestPlanRestClient class

Constructeurs

Méthodes

Détails du constructeur

TestPlanRestClient(IVssRestClientOptions)

Paramètres

Détails de la méthode

addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)

Paramètres

Retours

cloneTestCase(CloneTestCaseParams, string)

Paramètres

Retours

cloneTestPlan(CloneTestPlanParams, string, boolean)

Paramètres

Retours

cloneTestSuite(CloneTestSuiteParams, string, boolean)

Paramètres

Retours

createBulkTestSuites(TestSuiteCreateParams[], string, number, number)

Paramètres

Retours

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

Paramètres

Retours

createTestPlan(TestPlanCreateParams, string)

Paramètres

Retours

createTestPlanWithTestCases(TestPlanWithTestCasesCreateParams, string)

Paramètres

Retours

createTestSuite(TestSuiteCreateParams, string, number)

Paramètres

Retours

createTestVariable(TestVariableCreateUpdateParameters, string)

Paramètres

Retours

deleteTestCase(string, number)

Paramètres

Retours

deleteTestConfguration(string, number)

Paramètres

Retours

deleteTestPlan(string, number)

Paramètres

Retours

deleteTestSuite(string, number, number)

Paramètres

Retours

deleteTestVariable(string, number)

Paramètres

Retours

exportTestCases(ExportTestCaseParams, string)

Paramètres

Retours

getCloneInformation(string, number)

Paramètres

Retours

getDeletedTestPlans(string, string)

Paramètres

Retours

getDeletedTestSuitesForPlan(string, number, SuiteExpand, string, boolean)

Paramètres

Retours

getDeletedTestSuitesForProject(string, SuiteExpand, string, boolean)

Paramètres

Retours

getPoints(string, number, number, string, boolean, boolean)

Paramètres

Retours

getPointsList(string, number, number, string, string, string, boolean, boolean, boolean)

Paramètres

Retours

getSuiteCloneInformation(string, number)

Paramètres

Retours

getSuiteEntries(string, number, SuiteEntryTypes)

Paramètres

Retours