Tricentis Test Management for Jira API

{"openapi":"3.0.3","info":{"title":"TTM for Jira","description":"Tricentis Test Management for Jira","version":"1.0.0","termsOfService":"https://www.tricentis.com/legal-information/general-terms-of-use/"},"externalDocs":{"description":"Documentation","url":"https://documentation.tricentis.com/tricentis_test_management_for_jira/content/cover_web.htm"},"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"TTM4J API Key","name":"Authorization","in":"header"}}},"servers":[{"url":"https://api.ttm4j.tricentis.com"}],"paths":{"/v1/projects/{project-key}/folders":{"get":{"tags":["Folders"],"summary":"Get folder(s).","description":"## Get folders.\r\n            \r\n#### Query parameters to filter by:\r\n            \r\n* **name** : _(optional)_: The folder name.\r\n* **parentId** _(optional)_: The ID of the parent folder where the new folder should be located. (If not provided, only root folders will return).","parameters":[{"name":"name","in":"query","description":"name.","schema":{"type":"string"}},{"name":"parentId","in":"query","description":"parentId.","schema":{"type":"string","format":"uuid"}},{"name":"project-key","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Numeric value that determines that maximum N results will be returned","schema":{"type":"Integer","default":10,"example":10}},{"name":"offset","in":"query","description":"Numeric value that determines that the result list will start from result #N (zero based)","schema":{"type":"Integer","default":0,"example":0}}],"responses":{"200":{"description":"Successfully get folder(s).","content":{"application/json":{"schema":{"type":"object","properties":{"offset":{"type":"integer","description":"Gets or sets offset.","format":"int32","nullable":true},"limit":{"type":"integer","description":"Gets or sets limit.","format":"int32","nullable":true},"totalCount":{"type":"integer","description":"Gets or sets totalCount.","format":"int32"},"items":{"type":"array","items":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string"},"parentId":{"type":"string","format":"uuid","nullable":true},"id":{"type":"string","format":"uuid"},"projectKey":{"type":"string","nullable":true},"created":{"type":"string","format":"date-time","nullable":true},"updated":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true},"index":{"type":"integer","format":"int32"}},"additionalProperties":false},"description":"Gets or sets items.","nullable":true}},"additionalProperties":false,"description":"Page Response Scheme."},"examples":{"Created folders":{"value":{"offset":0,"limit":2,"totalCount":2,"items":[{"id":"bd0376da-2981-46b1-9ffd-3d668e205bfa","projectKey":"TE","created":"2026-08-02T12:59:08.7644143Z","updated":"2026-08-02T12:59:08.7644144Z","createdBy":"User","updatedBy":"User","index":0,"name":"Folder 1"},{"id":"775887d3-18b6-4678-b920-5bf53862f097","projectKey":"TE","created":"2026-08-02T12:59:08.7644163Z","updated":"2026-08-02T12:59:08.7644164Z","createdBy":"User","updatedBy":"User","index":0,"name":"Folder inside another folder"}]}}}}}},"400":{"description":"`Invalid parameters`.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"examples":{"BadDataResponse":{"value":{"message":"bad data"}}}}}},"401":{"description":"`Unauthorized`.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"examples":{"UnauthorizedResponse":{"value":{"message":"unauthorized"}}}}}},"404":{"description":"`Not Found`.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"examples":{"NotFoundResponse":{"value":{"message":"not found"}}}}}}},"security":[{"api_key":[]}]},"post":{"tags":["Folders"],"summary":"Create folder(s).","description":"## Create new folders. The body contains a list of folders to create.\r\n            \r\n#### Body fields:\r\n            \r\n* **name** : The folder name.\r\n* **parentId** _(optional)_ : The ID of the parent folder where the new folder should be located.","parameters":[{"name":"project-key","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"List of folders to create.","content":{"application/json":{"schema":{"minItems":1,"type":"array","items":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string"},"parentId":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false}},"examples":{"Create two folders":{"value":[{"name":"Folder"},{"name":"Folder inside parent folder","parentId":"dbb583c4-4f9d-490f-b62d-1754c1ee442a"}]}}}}},"responses":{"200":{"description":"Successfully created folder(s).","content":{"application/json":{"schema":{"type":"object","properties":{"offset":{"type":"integer","description":"Gets or sets offset.","format":"int32","nullable":true},"limit":{"type":"integer","description":"Gets or sets limit.","format":"int32","nullable":true},"totalCount":{"type":"integer","description":"Gets or sets totalCount.","format":"int32"},"items":{"type":"array","items":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string"},"parentId":{"type":"string","format":"uuid","nullable":true},"id":{"type":"string","format":"uuid"},"projectKey":{"type":"string","nullable":true},"created":{"type":"string","format":"date-time","nullable":true},"updated":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true},"index":{"type":"integer","format":"int32"}},"additionalProperties":false},"description":"Gets or sets items.","nullable":true}},"additionalProperties":false,"description":"Page Response Scheme."},"examples":{"Created folders":{"value":{"offset":0,"limit":2,"totalCount":2,"items":[{"id":"82dc521b-747e-41ca-ae25-db5fa59fb35d","projectKey":"TE","created":"2026-08-02T12:59:08.7669151Z","updated":"2026-08-02T12:59:08.7669152Z","createdBy":"User","updatedBy":"User","index":0,"name":"Folder 1"},{"id":"eff3446a-7b04-413e-a893-d7cf33a10222","projectKey":"TE","created":"2026-08-02T12:59:08.766917Z","updated":"2026-08-02T12:59:08.766917Z","createdBy":"User","updatedBy":"User","index":0,"name":"Folder inside another folder"}]}}}}}},"400":{"description":"`Invalid parameters`.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"examples":{"BadDataResponse":{"value":{"message":"bad data"}}}}}},"401":{"description":"`Unauthorized`.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"examples":{"UnauthorizedResponse":{"value":{"message":"unauthorized"}}}}}},"404":{"description":"`Not Found`.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"examples":{"NotFoundResponse":{"value":{"message":"not found"}}}}}}},"security":[{"api_key":[]}]}},"/v1/projects/{project-key}/folders/{folderId}":{"put":{"tags":["Folders"],"summary":"Update folder.","description":"## Update folder.\r\n            \r\n#### Body fields:\r\n* **name** _(optional)_: The folder name.\r\n* **parentId** _(optional)_: In case parentId equal to 00000000-0000-0000-0000-000000000000, the folder will be moved to root.","parameters":[{"name":"folderId","in":"path","description":"Folder's Id to update.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"project-key","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Folder's detail to update.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true},"parentId":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false},"examples":{"Update folder":{"value":{"name":"Folder inside parent folder","parentId":"76f121f8-6959-44a7-a5db-a7af41b2edff"}}}}}},"responses":{"200":{"description":"Successfully updated folder.","content":{"application/json":{"schema":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string"},"parentId":{"type":"string","format":"uuid","nullable":true},"id":{"type":"string","format":"uuid"},"projectKey":{"type":"string","nullable":true},"created":{"type":"string","format":"date-time","nullable":true},"updated":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true},"index":{"type":"integer","format":"int32"}},"additionalProperties":false},"examples":{"updated folder":{"value":{"id":"eb2057c4-c7b2-46b5-8774-051ed065174a","projectKey":"TE","created":"2026-08-02T12:59:08.771874Z","updated":"2026-08-02T12:59:08.7718741Z","createdBy":"User","updatedBy":"User","index":0,"name":"Folder 1"}}}}}},"400":{"description":"`Invalid parameters`.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"examples":{"BadDataResponse":{"value":{"message":"bad data"}}}}}},"401":{"description":"`Unauthorized`.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"examples":{"UnauthorizedResponse":{"value":{"message":"unauthorized"}}}}}},"404":{"description":"`Not Found`.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"examples":{"NotFoundResponse":{"value":{"message":"not found"}}}}}}},"security":[{"api_key":[]}]}},"/v1/projects/{project-key}/test-cases/requirements":{"post":{"tags":["Requirements"],"summary":"Create Requirements.","description":"## Create Requirements and link to test case.\r\n##### Note: In case issue type won't be provided, default value will be \"Requirement\" issue type.\r\n            \r\n#### Body fields:\r\n* **summary** _(mandatory)_: the requirement summary.\r\n* **description** _(optional)_: the requirement description.\r\n* **issueType** _(optional)_: the requirement issue type (for example: Task, Requirement, Bug, etc..).","parameters":[{"name":"project-key","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"requirements to create.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiDataRequestData":{"value":[{"summary":"Requirement summary","description":"Requirement description","issueType":"Bug"},{"summary":"Requirement summary","description":"Requirement description","issueType":"Task"}]}}},"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiDataRequestData":{"value":[{"summary":"Requirement summary","description":"Requirement description","issueType":"Bug"},{"summary":"Requirement summary","description":"Requirement description","issueType":"Task"}]}}},"text/json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiDataRequestData":{"value":[{"summary":"Requirement summary","description":"Requirement description","issueType":"Bug"},{"summary":"Requirement summary","description":"Requirement description","issueType":"Task"}]}}},"application/*+json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiDataRequestData":{"value":[{"summary":"Requirement summary","description":"Requirement description","issueType":"Bug"},{"summary":"Requirement summary","description":"Requirement description","issueType":"Task"}]}}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true},"notLinkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true},"linkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiResponseData":{"value":{"notLinkedRequirement":["Key-2"],"linkedRequirement":["Key-1"]}}}},"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true},"notLinkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true},"linkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiResponseData":{"value":{"notLinkedRequirement":["Key-2"],"linkedRequirement":["Key-1"]}}}},"text/json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true},"notLinkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true},"linkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiResponseData":{"value":{"notLinkedRequirement":["Key-2"],"linkedRequirement":["Key-1"]}}}}}},"401":{"description":"`Unauthorized."}},"security":[{"api_key":[]}]}},"/v1/projects/{project-key}/test-cases/{key}/requirements":{"post":{"tags":["Requirements"],"summary":"Create Requirements and link to test case.","description":"## Create Requirements and link to test case.\r\n##### Note: In case issue type won't be provided, default value will be \"Requirement\" issue type.\r\n            \r\n#### Body fields:\r\n* **summary** _(mandatory)_: the requirement summary.\r\n* **description** _(optional)_: the requirement description.\r\n* **issueType** _(optional)_: the requirement issue type (for example: Task, Requirement, Bug, etc..).","parameters":[{"name":"key","in":"path","description":"jiraTestKey.","required":true,"schema":{"type":"string"}},{"name":"project-key","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"requirements to create.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiDataRequestData":{"value":[{"summary":"Requirement summary","description":"Requirement description","issueType":"Bug"},{"summary":"Requirement summary","description":"Requirement description","issueType":"Task"}]}}},"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiDataRequestData":{"value":[{"summary":"Requirement summary","description":"Requirement description","issueType":"Bug"},{"summary":"Requirement summary","description":"Requirement description","issueType":"Task"}]}}},"text/json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiDataRequestData":{"value":[{"summary":"Requirement summary","description":"Requirement description","issueType":"Bug"},{"summary":"Requirement summary","description":"Requirement description","issueType":"Task"}]}}},"application/*+json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiDataRequestData":{"value":[{"summary":"Requirement summary","description":"Requirement description","issueType":"Bug"},{"summary":"Requirement summary","description":"Requirement description","issueType":"Task"}]}}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true},"notLinkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true},"linkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiResponseData":{"value":{"notLinkedRequirement":["Key-2"],"linkedRequirement":["Key-1"]}}}},"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true},"notLinkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true},"linkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiResponseData":{"value":{"notLinkedRequirement":["Key-2"],"linkedRequirement":["Key-1"]}}}},"text/json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true},"notLinkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true},"linkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiResponseData":{"value":{"notLinkedRequirement":["Key-2"],"linkedRequirement":["Key-1"]}}}}}},"401":{"description":"`Unauthorized."}},"security":[{"api_key":[]}]}},"/v1/projects/{project-key}/test-cases/{key}/requirement/link":{"post":{"tags":["Requirements"],"summary":"Link Requirements to test case.","description":"## Link Requirements to test case.\r\n            \r\n#### Body fields:\r\n* **issueKey** _(mandatory)_: the issue key.","parameters":[{"name":"key","in":"path","description":"jiraTestKey.","required":true,"schema":{"type":"string"}},{"name":"project-key","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"requirements to link.","content":{"application/json-patch+json":{"schema":{"type":"array","items":{"type":"object","properties":{"issueKey":{"type":"string","nullable":true}},"additionalProperties":false}},"examples":{"LinkRequirementsApiData":{"value":[{"issueKey":"Key-1"},{"issueKey":"Key-2"}]}}},"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"issueKey":{"type":"string","nullable":true}},"additionalProperties":false}},"examples":{"LinkRequirementsApiData":{"value":[{"issueKey":"Key-1"},{"issueKey":"Key-2"}]}}},"text/json":{"schema":{"type":"array","items":{"type":"object","properties":{"issueKey":{"type":"string","nullable":true}},"additionalProperties":false}},"examples":{"LinkRequirementsApiData":{"value":[{"issueKey":"Key-1"},{"issueKey":"Key-2"}]}}},"application/*+json":{"schema":{"type":"array","items":{"type":"object","properties":{"issueKey":{"type":"string","nullable":true}},"additionalProperties":false}},"examples":{"LinkRequirementsApiData":{"value":[{"issueKey":"Key-1"},{"issueKey":"Key-2"}]}}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true},"notLinkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true},"linkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiResponseData":{"value":{"notLinkedRequirement":["Key-2"],"linkedRequirement":["Key-1"]}}}},"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true},"notLinkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true},"linkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiResponseData":{"value":{"notLinkedRequirement":["Key-2"],"linkedRequirement":["Key-1"]}}}},"text/json":{"schema":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"issueType":{"type":"string","nullable":true},"notLinkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true},"linkedRequirement":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}},"examples":{"RequirementsApiResponseData":{"value":{"notLinkedRequirement":["Key-2"],"linkedRequirement":["Key-1"]}}}}}},"401":{"description":"`Unauthorized."}},"security":[{"api_key":[]}]}},"/v1/projects/{project-key}/test-cases":{"get":{"tags":["Test Cases"],"summary":"Read test case(s).","description":"Please note that this endpoint is deprecated and will be removed in the future. Use the /test-cases/bulk endpoint instead.\r\n            \r\n## Get or retrieve information from test case(s).\r\n            \r\n#### Body fields:\r\n* **jiraFields**: a comma-separated list of Jira fields to return for each issue. Use this to retrieve a subset of fields.\r\n* **ttmFields**: a comma-separated list of Jira fields to return for each issue. Use this to retrieve a subset of fields.","parameters":[{"name":"jiraFields","in":"query","description":"A list of Jira fields to return for each issue, use it to retrieve a subset of fields. Provide a comma-separated list.","schema":{"type":"string"}},{"name":"ttmFields","in":"query","description":"A list of TTM fields to return for each issue, use it to retrieve a subset of fields. Provide a comma-separated list.","schema":{"type":"string"}},{"name":"project-key","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Numeric value that determines that maximum N results will be returned","schema":{"type":"Integer","default":10,"example":10}},{"name":"offset","in":"query","description":"Numeric value that determines that the result list will start from result #N (zero based)","schema":{"type":"Integer","default":0,"example":0}}],"responses":{"200":{"description":"Successfully retrieved test cases information.","content":{"application/json":{"schema":{"type":"object","properties":{"offset":{"type":"integer","description":"Gets or sets offset.","format":"int32","nullable":true},"limit":{"type":"integer","description":"Gets or sets limit.","format":"int32","nullable":true},"totalCount":{"type":"integer","description":"Gets or sets totalCount.","format":"int32"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","nullable":true},"key":{"type":"string","nullable":true},"project":{"type":"string","nullable":true},"testCategory":{"type":"string","nullable":true},"testType":{"enum":["Manual","Automated"],"type":"string"},"fields":{"type":"object","properties":{"components":{"type":"array","items":{"type":"string"},"nullable":true},"summary":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"labels":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"customFields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"value":{"nullable":true}},"additionalProperties":false},"nullable":true},"ttmFields":{"type":"object","properties":{"precondition":{"type":"string","nullable":true},"steps":{"type":"array","items":{"type":"object","additionalProperties":false},"nullable":true}},"additionalProperties":false},"requirements":{"type":"array","items":{"type":"string"},"nullable":true},"folder":{"type":"string","nullable":true},"folderId":{"type":"string","format":"uuid","nullable":true},"automation":{"type":"object","properties":{"name":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"content":{"type":"string","nullable":true}},"additionalProperties":false}},"additionalProperties":false},"description":"Gets or sets items.","nullable":true}},"additionalProperties":false,"description":"Page Response Scheme."},"examples":{"Tests results":{"value":{"offset":0,"limit":1,"totalCount":100,"items":[{"id":"acde1582-0cfe-46d2-9561-478a67d43b93","key":"TE-1","project":"TE","testType":"Manual","fields":{"summary":"Test 1 status","description":"Test 1 description","status":"Backlog","priority":"High","labels":["My Label"]},"customFields":[{"key":"customField_10001","name":"A custom field","value":"Some value"}],"ttmFields":{"precondition":"A precondition","steps":[{"testCaseKey":"TE-2","testCaseId":"10000"},{"description":"Login","expectedResult":"Login should work"},{"description":"Logout","expectedResult":"Logout should work"},{"testCaseKey":"TE-5","testCaseId":"10004","deleted":true}]},"requirements":["TE-10","TE-11"],"folder":"parent folder/child folder","folderId":"35ea12e6-f03e-4c20-85c1-da64525a0436"},{"id":"e5dbf10e-ee5c-47d9-9e8c-403ce6c1b34a","key":"TE-2","project":"TE","testType":"Automated","fields":{"summary":"An automated test","description":"Automated test description","status":"Backlog","priority":"High","labels":["My Label"]},"requirements":["TE-12","TE-13"],"folder":"automated tests/feature1","folderId":"13354c28-a3da-4d37-a2e9-d25330e78909"}]}}}}}},"400":{"description":"`Invalid parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"examples":{"BadDataResponse":{"value":{"message":"bad data"}}}}}},"401":{"description":"`Unauthorized`.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"examples":{"UnauthorizedResponse":{"value":{"message":"unauthorized"}}}}}},"404":{"description":"`Not Found`.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"examples":{"NotFoundResponse":{"value":{"message":"not found"}}}}}}},"deprecated":true,"security":[{"api_key":[]}]},"post":{"tags":["Test Cases"],"summary":"Create test case(s).","description":"## Create test case(s).\r\n            \r\n#### Body fields:\r\n            \r\n* **folder** _(optional)_: Specify the folder path where you want to save the test case. A path is a string of concatenated parts separated by a slash \"/\".  If you don't specify a folder path, the test case saves in the \"All tests\" folder. Do not specify both the folder and the folderID, or the request will fail.\r\n* **folderId** _(optional)_: Specify a unique ID associated with the folder in the TTM database, which specifies where the test case should be saved. Do not specify both the folder and the folderID, or the request will fail.\r\n* **callbackUrl** _(optional)_: Specify a URL that will recevie status of the request (The URL will serve as POST endpoint in the user side).\r\n* **tests**: Provide a list of tests with the following values:\r\n    * **fields**: The native Jira fields in a test case. The following fields are available:\r\n        * **summary**: The Summary of the test case in Jira.\r\n        * **description** _(optional)_: The Description of the test case in Jira.\r\n        * **status** _(optional)_: The Status of the test case in Jira.\r\n        * **priority** _(optional)_: The Priority of the test case in Jira.\r\n        * **labels** _(optional)_: The Labels of the test case in Jira.\r\n    * **ttmFields**: These are the Jira fields provided by the Tricentis Test Management for Jira plugin. The following fields are available:\r\n        * **precondition** _(optional)_: The precondition for a test case.\r\n        * **steps** _(optional)_: The list of steps for the test case.\r\n            * **description** _(optional)_: Step description.\r\n            * **expectedResult** _(optional)_: Step expected result.\r\n            * **data** _(optional)_: Step data.\r\n            * **testCaseKey** _(optional)_: test case key, when set the step will call the test case and other step fields will be ignored.\r\n    * **testType**: Can be one of the following: \"Manual\", \"Automated\"\r\n    * **requirements** _(optional)_: List of issues keys (from Jira) that should be linked as requirements.\r\n    * **customFields** _(optional)_: The custom Jira fields in a test case.\r\n    * **folder** _(optional)_: Specify the folder path where you want to save the test case. A path is a string of concatenated parts separated by a slash \"/\".  If you don't specify a folder path, the test case saves in the \"All tests\" folder. Do not specify both the folder and the folderID, or the request will fail. If you do not specify the folder in this field, the request uses the folder specified at the root level.\r\n    

# --- truncated at 32 KB (151 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tricentis/refs/heads/main/openapi/tricentis-ttm4j-openapi.json