Share via

Test Suite Entry - Reorder Suite Entries

Service:
Test Plan
API Version:
7.1

Reorder test suite entries in the test suite.

PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/suiteentry/{suiteId}?api-version=7.1

URI Parameters

Name In Required Type Description
organization
 path True

string

The name of the Azure DevOps organization.
project
 path True

string

Project ID or project name
suiteId
 path True

integer (int32)

Id of the parent test suite.
api-version
 query True

string

Version of the API to use. This should be set to '7.1' to use this version of the api.

Request Body

Name Type Description
body

SuiteEntryUpdateParams[]

List of SuiteEntry to reorder.

Responses

Name Type Description
200 OK

SuiteEntry[]

successful operation

Security

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

Name Description
vso.test_write Grants the ability to read, create, and update test plans, cases, results and other test management related artifacts.

Examples

Reorder both test cases and child suites
Reorder child suites in a suite
Reorder test cases in a suite
Reorder test cases with conflicting sequence Number
Reorder test cases with ovrflowing sequence number

Reorder both test cases and child suites

Sample request

PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/suiteentry/{suiteId}?api-version=7.1

[
  {
    "sequenceNumber": 4,
    "id": 11,
    "suiteEntryType": "testCase"
  },
  {
    "sequenceNumber": 0,
    "id": 3,
    "suiteEntryType": "suite"
  }
]

Sample response

Status code:
200 
{
  "count": 8,
  "value": [
    {
      "suiteId": 2,
      "sequenceNumber": 0,
      "id": 3,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 1,
      "id": 4,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 2,
      "id": 7,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 3,
      "id": 6,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 4,
      "id": 8,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 5,
      "id": 11,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 6,
      "id": 10,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 7,
      "id": 9,
      "suiteEntryType": "testCase"
    }
  ]
}

Reorder child suites in a suite

Sample request

PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/suiteentry/{suiteId}?api-version=7.1

[
  {
    "sequenceNumber": 2,
    "id": 7,
    "suiteEntryType": "suite"
  },
  {
    "sequenceNumber": 3,
    "id": 6,
    "suiteEntryType": "suite"
  }
]

Sample response

Status code:
200 
{
  "count": 8,
  "value": [
    {
      "suiteId": 2,
      "sequenceNumber": 0,
      "id": 4,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 1,
      "id": 7,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 2,
      "id": 3,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 3,
      "id": 6,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 4,
      "id": 8,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 5,
      "id": 10,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 6,
      "id": 9,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 7,
      "id": 11,
      "suiteEntryType": "testCase"
    }
  ]
}

Reorder test cases in a suite

Sample request

PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/suiteentry/{suiteId}?api-version=7.1

[
  {
    "sequenceNumber": 6,
    "id": 8,
    "suiteEntryType": "testCase"
  },
  {
    "sequenceNumber": 7,
    "id": 9,
    "suiteEntryType": "testCase"
  }
]

Sample response

Status code:
200 
{
  "count": 8,
  "value": [
    {
      "suiteId": 2,
      "sequenceNumber": 0,
      "id": 7,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 1,
      "id": 6,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 2,
      "id": 4,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 3,
      "id": 3,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 4,
      "id": 8,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 5,
      "id": 10,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 6,
      "id": 9,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 7,
      "id": 11,
      "suiteEntryType": "testCase"
    }
  ]
}

Reorder test cases with conflicting sequence Number

Sample request

PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/suiteentry/{suiteId}?api-version=7.1

[
  {
    "sequenceNumber": 4,
    "id": 10,
    "suiteEntryType": "testCase"
  },
  {
    "sequenceNumber": 4,
    "id": 9,
    "suiteEntryType": "testCase"
  }
]

Sample response

Status code:
200 
{
  "count": 8,
  "value": [
    {
      "suiteId": 2,
      "sequenceNumber": 0,
      "id": 3,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 1,
      "id": 4,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 2,
      "id": 7,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 3,
      "id": 6,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 4,
      "id": 8,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 5,
      "id": 9,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 6,
      "id": 10,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 7,
      "id": 11,
      "suiteEntryType": "testCase"
    }
  ]
}

Reorder test cases with ovrflowing sequence number

Sample request

PATCH https://dev.azure.com/{organization}/{project}/_apis/testplan/suiteentry/{suiteId}?api-version=7.1

[
  {
    "sequenceNumber": 29,
    "id": 11,
    "suiteEntryType": "testCase"
  }
]

Sample response

Status code:
200 
{
  "count": 8,
  "value": [
    {
      "suiteId": 2,
      "sequenceNumber": 0,
      "id": 3,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 1,
      "id": 4,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 2,
      "id": 7,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 3,
      "id": 6,
      "suiteEntryType": "suite"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 4,
      "id": 8,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 5,
      "id": 9,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 6,
      "id": 10,
      "suiteEntryType": "testCase"
    },
    {
      "suiteId": 2,
      "sequenceNumber": 7,
      "id": 11,
      "suiteEntryType": "testCase"
    }
  ]
}

Definitions

Name Description
SuiteEntry

A suite entry defines properties for a test suite.
SuiteEntryTypes

Defines whether the entry is of type test case or suite.
SuiteEntryUpdateParams

A suite entry defines properties for a test suite.

SuiteEntry

Object

A suite entry defines properties for a test suite.

Name Type Description
id

integer (int32)

Id of the suite entry in the test suite: either a test case id or child suite id.
sequenceNumber

integer (int32)

Sequence number for the suite entry object in the test suite.
suiteEntryType

SuiteEntryTypes

Defines whether the entry is of type test case or suite.
suiteId

integer (int32)

Id for the test suite.

SuiteEntryTypes

Enumeration

Defines whether the entry is of type test case or suite.

Value Description
suite

Child Suite
testCase

Test Case

SuiteEntryUpdateParams

Object

A suite entry defines properties for a test suite.

Name Type Description
id

integer (int32)

Id of the suite entry in the test suite: either a test case id or child suite id.
sequenceNumber

integer (int32)

Sequence number for the suite entry object in the test suite.
suiteEntryType

SuiteEntryTypes

Defines whether the entry is of type test case or suite.