--- title: Create Test Suite Entity by Type and Full Name description: The POST /test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}} operation creates a new test suite entity as a child of the given entity's type and full name, as specified in the request URL. The allowable values for {{testSuiteType}} are TEST_CASE, TEST_SCENARIO, or ASSERTION. Get the entity's full name from the response when you create a root or child test suite entity. The request must provide either a branch ID or a snapshot ID in the request URL to specify where the test suite entity should be created. component: pingauthorize page_id: pingauthorize:pingauthorize:policy-editor/test-suite/create-test-suite-entry-type-fullname canonical_url: https://developer.pingidentity.com/pingauthorize/pingauthorize/policy-editor/test-suite/create-test-suite-entry-type-fullname.html section_ids: prerequisites: Prerequisites test-scenario-request-model: Test scenario request model test-case-request-model: Test case request model assertion-data-model: Assertion data model headers: Headers body: Body example-request: Example Request example-response: Example Response --- # Create Test Suite Entity by Type and Full Name ## ```none POST {{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}} ``` The `POST /test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}` operation creates a new test suite entity as a child of the given entity's type and full name, as specified in the request URL. The allowable values for `{{testSuiteType}}` are `TEST_CASE`, `TEST_SCENARIO`, or `ASSERTION`. Get the entity's full name from the response when you create a [root](create-root-test-suite-entry.html) or [child](create-child-test-suite-entry.html) test suite entity. The request must provide either a branch ID or a snapshot ID in the request URL to specify where the test suite entity should be created. ### Prerequisites * [Create a branch](../version-control/snapshot-management/create-child-branch-from-snapshot.html) to get a branch ID. * [Create a snapshot](../version-control/branch-manager/create-snapshot.html) to get a snapshot ID. > **Collapse: Query parameters** > > | Query parameter | Description | > | --------------- | ----------------- | > | `branch` | Branch ID or name | > | `snapshot` | Snapshot ID | > **Collapse: Request Model** > > For property descriptions, refer to [Test suite data model](../test-suite.html#test-suite-data-model). > > #### Test scenario request model > > | Property | Type | Required | > | ----------------------------------------- | ------- | -------- | > | `name` | String | Required | > | `description` | String | Optional | > | `parentId` | UUID | Optional | > | `permissions.rolePermissions` | JSON\[] | Optional | > | `permissions.inherit` | Boolean | Optional | > | `testScenario.request.domainId` | String | Optional | > | `testScenario.request.serviceId` | String | Optional | > | `testScenario.request.identityProviderId` | String | Optional | > | `testScenario.request.actionId` | String | Optional | > | `testScenario.attributeOverrides` | JSON | Optional | > | `testScenario.serviceOverrides` | JSON | Optional | > > To create an test scenario group rather than an individual test scenario, set the `testScenario` property to `null`. > > #### Test case request model > > | Property | Type | Required | > | -------------------------------------------------- | ----------------------------------------------------------- | -------- | > | `name` | String | Required | > | `description` | String | Optional | > | `parentId` | UUID | Optional | > | `permissions.rolePermissions` | JSON\[] | Optional | > | `permissions.inherit` | Boolean | Optional | > | `testCase.testedEntities` | [Test entity](../test-suite.html#test-entity-data-model)\[] | Required | > | `testCase.testedEntities.assertions` | [Assertion](../test-suite.html#assertion-data-model)\[] | Optional | > | `testCase.testScenarioDefinitionId` | String | Optional | > | `testCase.testScenario.request.domainId` | String | Optional | > | `testCase.testScenario.request.serviceId` | String | Optional | > | `testCase.testScenario.request.identityProviderId` | String | Optional | > | `testCase.testScenario.request.actionId` | String | Optional | > | `testCase.testScenario.attributeOverrides` | JSON | Optional | > | `testCase.testScenario.serviceOverrides` | JSON | Optional | > > To create an test case group rather than an individual test case, set the `testCase` property to `null`. > > #### Assertion data model > > | Property | Type | Required | | > | --------------------------------- | ------- | -------- | ------- | > | `name` | String | Required | | > | `description` | String | Optional | | > | `parentId` | UUID | Optional | Mutable | > | `permissions.rolePermissions` | JSON\[] | Optional | | > | `permissions.inherit` | Boolean | Optional | | > | `assertion.accessor` | String | Required | | > | `assertion.comparator` | String | Optional | | > | `assertion.expectation.valueType` | String | Required | | > | `assertion.expectation.value` | String | Required | | > > To create an assertion group rather than an individual assertion, set the `assertion` property to `null`. ### Headers Content-Type      application/json x-user-id      {{userId}} ### Body raw ( application/json ) ```json { "name": "example-assertion", "description": "", "permissions": { "inherit": true, "rolePermissions": [] }, "assertion": { "type": "json-path", "accessor": "$.value", "comparator": "Equals", "expectation": { "valueType": "STRING", "value": "123" } } } ``` ## ### Example Request * cURL * C# * Go * HTTP * Java * jQuery * NodeJS * Python * PHP * Ruby * Swift ```shell curl --location --globoff '{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}' \ --header 'x-user-id: {{userId}}' \ --header 'Content-Type: application/json' \ --data '{ "name": "example-assertion", "description": "", "permissions": { "inherit": true, "rolePermissions": [] }, "assertion": { "type": "json-path", "accessor": "$.value", "comparator": "Equals", "expectation": { "valueType": "STRING", "value": "123" } } }' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}") { MaxTimeout = -1, }; var client = new RestClient(options); var request = new RestRequest("", Method.Post); request.AddHeader("x-user-id", "{{userId}}"); request.AddHeader("Content-Type", "application/json"); var body = @"" + "\n" + @" {" + "\n" + @" ""name"": ""example-assertion""," + "\n" + @" ""description"": """"," + "\n" + @" ""permissions"": {" + "\n" + @" ""inherit"": true," + "\n" + @" ""rolePermissions"": []" + "\n" + @" }," + "\n" + @" ""assertion"": {" + "\n" + @" ""type"": ""json-path""," + "\n" + @" ""accessor"": ""$.value""," + "\n" + @" ""comparator"": ""Equals""," + "\n" + @" ""expectation"": {" + "\n" + @" ""valueType"": ""STRING""," + "\n" + @" ""value"": ""123""" + "\n" + @" }" + "\n" + @" }" + "\n" + @" }"; request.AddStringBody(body, DataFormat.Json); RestResponse response = await client.ExecuteAsync(request); Console.WriteLine(response.Content); ``` ```golang package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}" method := "POST" payload := strings.NewReader(`{ "name": "example-assertion", "description": "", "permissions": { "inherit": true, "rolePermissions": [] }, "assertion": { "type": "json-path", "accessor": "$.value", "comparator": "Equals", "expectation": { "valueType": "STRING", "value": "123" } } }`) client := &http.Client { } req, err := http.NewRequest(method, url, payload) if err != nil { fmt.Println(err) return } req.Header.Add("x-user-id", "{{userId}}") req.Header.Add("Content-Type", "application/json") res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := io.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) } ``` ```http POST /test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}} HTTP/1.1 Host: {{apiPath}} x-user-id: {{userId}} Content-Type: application/json { "name": "example-assertion", "description": "", "permissions": { "inherit": true, "rolePermissions": [] }, "assertion": { "type": "json-path", "accessor": "$.value", "comparator": "Equals", "expectation": { "valueType": "STRING", "value": "123" } } } ``` ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "\n {\n \"name\": \"example-assertion\",\n \"description\": \"\",\n \"permissions\": {\n \"inherit\": true,\n \"rolePermissions\": []\n },\n \"assertion\": {\n \"type\": \"json-path\",\n \"accessor\": \"$.value\",\n \"comparator\": \"Equals\",\n \"expectation\": {\n \"valueType\": \"STRING\",\n \"value\": \"123\"\n }\n }\n }"); Request request = new Request.Builder() .url("{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}") .method("POST", body) .addHeader("x-user-id", "{{userId}}") .addHeader("Content-Type", "application/json") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}", "method": "POST", "timeout": 0, "headers": { "x-user-id": "{{userId}}", "Content-Type": "application/json" }, "data": JSON.stringify({ "name": "example-assertion", "description": "", "permissions": { "inherit": true, "rolePermissions": [] }, "assertion": { "type": "json-path", "accessor": "$.value", "comparator": "Equals", "expectation": { "valueType": "STRING", "value": "123" } } }), }; $.ajax(settings).done(function (response) { console.log(response); }); ``` ```javascript var request = require('request'); var options = { 'method': 'POST', 'url': '{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}', 'headers': { 'x-user-id': '{{userId}}', 'Content-Type': 'application/json' }, body: JSON.stringify({ "name": "example-assertion", "description": "", "permissions": { "inherit": true, "rolePermissions": [] }, "assertion": { "type": "json-path", "accessor": "$.value", "comparator": "Equals", "expectation": { "valueType": "STRING", "value": "123" } } }) }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` ```python import requests import json url = "{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}" payload = json.dumps({ "name": "example-assertion", "description": "", "permissions": { "inherit": True, "rolePermissions": [] }, "assertion": { "type": "json-path", "accessor": "$.value", "comparator": "Equals", "expectation": { "valueType": "STRING", "value": "123" } } }) headers = { 'x-user-id': '{{userId}}', 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}'); $request->setMethod(HTTP_Request2::METHOD_POST); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( 'x-user-id' => '{{userId}}', 'Content-Type' => 'application/json' )); $request->setBody('{\n "name": "example-assertion",\n "description": "",\n "permissions": {\n "inherit": true,\n "rolePermissions": []\n },\n "assertion": {\n "type": "json-path",\n "accessor": "$.value",\n "comparator": "Equals",\n "expectation": {\n "valueType": "STRING",\n "value": "123"\n }\n }\n }'); try { $response = $request->send(); if ($response->getStatus() == 200) { echo $response->getBody(); } else { echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . $response->getReasonPhrase(); } } catch(HTTP_Request2_Exception $e) { echo 'Error: ' . $e->getMessage(); } ``` ```ruby require "uri" require "json" require "net/http" url = URI("{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Post.new(url) request["x-user-id"] = "{{userId}}" request["Content-Type"] = "application/json" request.body = JSON.dump({ "name": "example-assertion", "description": "", "permissions": { "inherit": true, "rolePermissions": [] }, "assertion": { "type": "json-path", "accessor": "\$.value", "comparator": "Equals", "expectation": { "valueType": "STRING", "value": "123" } } }) response = http.request(request) puts response.read_body ``` ```swift let parameters = "{\n \"name\": \"example-assertion\",\n \"description\": \"\",\n \"permissions\": {\n \"inherit\": true,\n \"rolePermissions\": []\n },\n \"assertion\": {\n \"type\": \"json-path\",\n \"accessor\": \"$.value\",\n \"comparator\": \"Equals\",\n \"expectation\": {\n \"valueType\": \"STRING\",\n \"value\": \"123\"\n }\n }\n }" let postData = parameters.data(using: .utf8) var request = URLRequest(url: URL(string: "{{apiPath}}/test-suite/{{testSuiteType}}/{{testSuiteEntityFullName}}?branch={{branchId}}")!,timeoutInterval: Double.infinity) request.addValue("{{userId}}", forHTTPHeaderField: "x-user-id") request.addValue("application/json", forHTTPHeaderField: "Content-Type") request.httpMethod = "POST" request.httpBody = postData let task = URLSession.shared.dataTask(with: request) { data, response, error in guard let data = data else { print(String(describing: error)) return } print(String(data: data, encoding: .utf8)!) } task.resume() ``` ### Example Response 201 Created ```json { "objectType": "AssertionDefinition", "id": "db142f07-a025-4fa6-a9c3-0dc62d561689", "version": "f53688d0-d6ad-4e6a-a9dc-9d6f7c540bb3", "type": "ASSERTION", "name": "example-assertion", "fullName": "example-assertion-group.example-assertion", "description": "", "parentId": "8621fec6-03f0-4464-b566-5fa5df8eb52b", "numberOfChildren": 0, "permissions": { "inherit": true, "rolePermissions": [] }, "assertion": { "type": "json-path", "name": null, "accessor": "$.value", "comparator": "Equals", "expectation": { "value": "123", "valueType": "STRING" } }, "properties": [] } ```