This endpoint allows users to create a new project within the system. It requires a JSON payload containing details about the project to be created.
\nMethod: POST
Endpoint: https://test-management.testsigma.com/api/v1/projects
Request Body:\nThe request body must be a JSON object with the following parameters:
\nname (string, required): The name of the project.description (string, required): A brief description of the project.human_id_prefix (string, required): A prefix for the project's human-readable identifier.Example Request Body:
\n{\n \"name\": \"Demo project\",\n \"description\": \"test4 description\",\n \"human_id_prefix\": \"DEMO\"\n}\nUpon successful creation of the project, the API will return a response with a status code of 200. The response body will be in JSON format and will contain the following structure:
message (string): A message indicating the status of the request (can be empty).data (object): Contains the details of the created project.project (object): The project object with the following fields:id (string): The unique identifier of the project.created_at (integer): Timestamp of when the project was created.updated_at (integer): Timestamp of the last update made to the project.name (string): The name of the project.description (string): The description of the project.human_id_prefix (string): The prefix for the project's human-readable identifier.Example Response:
\n{\n \"message\": \"\",\n \"data\": {\n \"project\": {\n \"id\": \"\",\n \"created_at\": 0,\n \"updated_at\": 0,\n \"name\": \"\",\n \"description\": \"\",\n \"human_id_prefix\": \"\"\n }\n }\n}\nThis endpoint is essential for managing projects within the application, allowing users to define and store necessary project details efficiently.
\n","urlObject":{"path":["api","v1","projects"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f5b4b726-36b2-4726-af3e-ba2502a62926"},{"name":"Get project by id","id":"26e492ca-0c59-4dcc-b9a5-97af207a4df0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5","description":"Method: GET
Endpoint: https://test-management.testsigma.com/api/v1/projects/{project_id}
This endpoint retrieves the details of a specific project identified by its unique project_id.
18c50239-946d-428e-aa0c-260329f5c151.Upon a successful request, the API will return a JSON response with the following structure:
\nStatus Code: 200
\nContent-Type: application/json
\nResponse Body:
\nmessage (string): A message that may provide additional context (empty in this case).
\ndata (object): Contains the details of the requested project.
\nproject (object): An object representing the project with the following properties:
\nid (string): The unique identifier of the project.
\ncreated_at (integer): The timestamp indicating when the project was created.
\nupdated_at (integer): The timestamp indicating when the project was last updated.
\nname (string): The name of the project.
\ndescription (string): A brief description of the project.
\nhuman_id_prefix (string): A prefix used for human-readable project IDs.
\nThis endpoint is useful for obtaining essential information about a project, which can be utilized for further processing or display in user interfaces.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"26e492ca-0c59-4dcc-b9a5-97af207a4df0"},{"name":"List projects","id":"be0ec8fd-0aed-4e71-8092-b79eae63728a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/projects?name__NEQ=Demo project","description":"This endpoint retrieves a list of projects based on the specified query parameters.
\nGET
https://test-management.testsigma.com/api/v1/projects
page_size (integer): Specifies the number of projects to be returned in the response. In this case, it is set to 1.
name__NEQ (string): Filters out projects with the name \"Demo project\". This allows you to exclude specific projects from the results.
\nThe response will be in JSON format and includes the following structure:
\nmessage (string): A message field that may contain additional information.
\ndata (object): Contains the main data returned by the API.
\nprojects (array): An array of project objects, each containing:
\nid (string): The unique identifier for the project.
\ncreated_at (integer): The timestamp when the project was created.
\nupdated_at (integer): The timestamp when the project was last updated.
\nname (string): The name of the project.
\ndescription (string): A brief description of the project.
\nhuman_id_prefix (string): A prefix used for human-readable identifiers.
\npage_info (object): Provides pagination details.
\npage_size (integer): The number of items returned per page.
\ntotal_count (integer): The total number of projects available.
\nnext (string): URL to the next page of results, if applicable.
\nprev (string): URL to the previous page of results, if applicable.
\n{\n \"message\": \"\",\n \"data\": {\n \"projects\": [\n {\n \"id\": \"\",\n \"created_at\": 0,\n \"updated_at\": 0,\n \"name\": \"\",\n \"description\": \"\",\n \"human_id_prefix\": \"\"\n }\n ]\n },\n \"page_info\": {\n \"page_size\": 0,\n \"total_count\": 0,\n \"next\": \"\",\n \"prev\": \"\"\n }\n}\n\nThis endpoint allows you to update the details of an existing project in the system. You can modify the project's name and description by sending a PUT request to the specified project URL.
\nMethod: PUT
\nURL: https://test-management.testsigma.com/api/v1/projects/{project_id}
The request body must be a JSON object containing the following parameters:
\nname (string): The new name of the project.
\ndescription (string): A brief description of the project.
\nExample Request Body:
\n{\n \"name\": \"Demo project Test\",\n \"description\": \"test description\"\n}\n\nUpon a successful update, the response will return a status code of 200 and a JSON object containing the following structure:
\nmessage (string): A message indicating the result of the operation (may be empty).
\ndata (object): Contains the updated project information.
\nproject (object): The updated project details.
\nid (string): The unique identifier of the project.
\ncreated_at (integer): Timestamp of when the project was created.
\nupdated_at (integer): Timestamp of when the project was last updated.
\nname (string): The updated name of the project.
\ndescription (string): The updated description of the project.
\nhuman_id_prefix (string): A prefix used for human-readable project IDs.
\nExample Response:
\n{\n \"message\": \"\",\n \"data\": {\n \"project\": {\n \"id\": \"\",\n \"created_at\": 0,\n \"updated_at\": 0,\n \"name\": \"\",\n \"description\": \"\",\n \"human_id_prefix\": \"\"\n }\n }\n}\n\nEnsure that the project ID in the URL corresponds to an existing project. If the project does not exist, the server may return an error response.
\n","urlObject":{"path":["api","v1","projects","18c50239-946d-428e-aa0c-260329f5c151"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5e75885a-885a-43b6-8161-f68bbd7b3f4a"},{"name":"Delete project by id","id":"8161c4a4-738a-45e5-bad0-10b997e3b870","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://test-management.testsigma.com/api/v1/projects/18c50239-946d-428e-aa0c-260329f5c151","description":"This endpoint allows you to delete a specific project identified by its unique project ID.
\nMethod: DELETE
\nURL: https://test-management.testsigma.com/api/v1/projects/{projectId}
Path Parameter:
\nprojectId (string): The unique identifier of the project you wish to delete (e.g., 18c50239-946d-428e-aa0c-260329f5c151).Status Code: 200 OK
\nContent-Type: application/json
\nResponse Body:
\nmessage (string): A confirmation message indicating the successful deletion of the project. The message field may be empty.Ensure that the project ID provided in the request path is valid and corresponds to an existing project.
\nDeleting a project is irreversible; once deleted, the project cannot be recovered.
\nThis action may require appropriate permissions; ensure that your user account has the necessary rights to perform this operation.
\nThis endpoint allows you to create a new folder within a specified project.
\nMethod: POST
\nEndpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/folders
Request Body: The request must include a JSON payload with the following parameters:
\nname (string): The name of the folder to be created.
order (integer): The order in which the folder should be displayed.
Example Request Body:
\n{\n \"name\": \"Child folder folder\",\n \"order\": 1\n}\n\nStatus Code: 201 Created
\nContent-Type: application/json
\nResponse Body: On successful creation, the response will return a JSON object containing:
\nmessage (string): A message indicating the result of the operation (may be empty).
data (object): Contains details about the created folder:
folder (object):
id (string): The unique identifier of the folder.
name (string): The name of the created folder.
project_id (string): The ID of the project to which the folder belongs.
children (array): An array of child folders (if any).
parent_folder_id (string): The ID of the parent folder (if applicable).
order (integer): The order of the folder.
Example Response:
\n{\n \"message\": \"\",\n \"data\": {\n \"folder\": {\n \"id\": \"\",\n \"name\": \"\",\n \"project_id\": \"\",\n \"children\": [],\n \"parent_folder_id\": \"\",\n \"order\": 0\n }\n }\n}\n\nThis endpoint is essential for organizing projects by allowing users to create a hierarchical structure of folders.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","folders"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3050c49-efd4-4a1d-96ad-90289c0d52b5"},{"name":"Get Folder By Id","id":"88071b3b-f5f2-4598-ba59-70c774f9fe8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/folders/e8db64d3-9291-44d9-9e30-69438c272f05","description":"This endpoint retrieves the details of a specific folder within a project in the TMS (Task Management System).
\nMethod: GET
\nEndpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/folders/{{Folder_ID}}
Path Parameters:
\nProject_ID: The unique identifier of the project that contains the folder.
Folder_ID: The unique identifier of the folder whose details are being requested.
Status Code: 200 OK
\nContent-Type: application/json
\nThe response will contain a JSON object with the following structure:
\n{\n \"message\": \"\",\n \"data\": {\n \"folder\": {\n \"id\": \"\", // Unique identifier of the folder\n \"name\": \"\", // Name of the folder\n \"project_id\": \"\", // ID of the project to which the folder belongs\n \"children\": [], // Array of child folders (if any)\n \"parent_folder_id\": \"\", // ID of the parent folder (if applicable)\n \"order\": 0 // Order index for the folder\n }\n }\n}\n\nEnsure that the Project_ID and Folder_ID are valid to receive the correct folder details.
The children array will be empty if there are no subfolders within the requested folder.
This endpoint is used to delete a specific folder within a project in the Task Management System (TMS). The folder is identified by its unique ID, which is included in the URL.
\nMethod: DELETE
\nURL: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/folders/{{Folder_ID}}
Project_ID: The unique identifier of the project containing the folder.
Folder_ID: The unique identifier of the folder to be deleted.
Status Code: 200 OK
\nContent-Type: application/json
\n{ \"message\": \"\"}
\nThe response indicates successful deletion of the folder. The message field is present but does not contain any additional information.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","folders","e8db64d3-9291-44d9-9e30-69438c272f05"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9cf1a360-4cbb-4ae8-b704-89a6bbb47ef9"},{"name":"Update Folder By Id","id":"5ad36b37-81d1-449f-b972-a3d386e62c4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\":\"folder Updated\",\n \"order\": -1\n}","options":{"raw":{"language":"json"}}},"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/folders/c69216e0-e2a9-401f-9e08-77176abce8c4","description":"This endpoint allows you to update the details of a specific folder within a project in the TMS (Task Management System).
\nMethod: PUT
Endpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/folders/c69216e0-e2a9-401f-9e08-77176abce8c4
The request body should be in JSON format and includes the following parameters:
\nname (string): The new name of the folder.
\norder (integer): The order in which the folder should be displayed. A value of -1 indicates that the order is not set.
Example Request Body:
\n{\n \"name\": \"folder Updated\",\n \"order\": -1\n}\n\nUpon a successful update, the API will return a 200 OK status with the following JSON structure:
message (string): A message indicating the result of the operation (can be empty).
\ndata (object): Contains the updated folder information.
\nfolder (object): The folder details.
\nid (string): The unique identifier of the folder.
\nname (string): The updated name of the folder.
\nproject_id (string): The identifier of the project the folder belongs to.
\nchildren (array): An array of child folders (if any).
\nparent_folder_id (string): The identifier of the parent folder (if applicable).
\norder (integer): The updated order of the folder.
\nExample Response:
\n{\n \"message\": \"\",\n \"data\": {\n \"folder\": {\n \"id\": \"\",\n \"name\": \"\",\n \"project_id\": \"\",\n \"children\": [],\n \"parent_folder_id\": \"\",\n \"order\": 0\n }\n }\n}\n\nEnsure that the Project_ID and folder ID in the endpoint are correctly specified to update the intended folder.
The response will include the updated folder details, allowing you to confirm the changes made.
\nThis endpoint allows you to move a folder within a project to a new parent folder.
\nPOST
https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/folders/c7db032b-d7ca-413b-8bff-74073e9618c4/move
The request body must be in JSON format and include the following parameter:
\n{\n \"parent_folder_id\": \"c69216e0-e2a9-401f-9e08-77176a ...\"\n}\n\nOn a successful request, the response will have a status code of 200 and will return a JSON object with the following structure:
message (string): A message related to the request, which may be empty.
\ndata (object): Contains details about the moved folder:
\nfolder (object):
\nid (string): The ID of the moved folder.
\nname (string): The name of the moved folder.
\nproject_id (string): The ID of the project to which the folder belongs.
\nchildren (array): An array containing any child folders (empty if none).
\nparent_folder_id (string): The ID of the new parent folder.
\norder (integer): The order of the folder in the parent folder.
\n{\n \"message\": \"\",\n \"data\": {\n \"folder\": {\n \"id\": \"\",\n \"name\": \"\",\n \"project_id\": \"\",\n \"children\": [],\n \"parent_folder_id\": \"\",\n \"order\": 0\n }\n }\n}\n\nThis endpoint retrieves a list of folders associated with a specific project.
\nMethod: GET
Endpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/folders
Query Parameters:
\npage_size (integer): The number of folders to return in the response. In this example, it is set to 3.Upon a successful request, the server responds with a 200 OK status and a JSON object containing the following structure:
message: A string that may contain additional information about the request (typically empty).
\ndata: An object containing:
\nfolders: An array of folder objects, each with the following properties:
\nid: The unique identifier of the folder.
name: The name of the folder.
project_id: The identifier of the project to which the folder belongs.
children: An array containing child folders (if any).
parent_folder_id: The identifier of the parent folder (if applicable).
order: An integer indicating the order of the folder.
page_info: An object providing pagination details:
\npage_size: The number of items returned in this response.
total_count: The total number of folders available.
next: A URL for the next page of results (if available).
prev: A URL for the previous page of results (if available).
This structure allows clients to understand the folder hierarchy and navigate through the project folders efficiently.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","folders"],"host":["https://test-management.testsigma.com"],"query":[{"key":"page_size","value":"3"},{"disabled":true,"key":"after","value":"MnVaR2pzaHRMV0wyRXBVbW8wSWJNSEZ5SE9z"}],"variable":[]}},"response":[],"_postman_id":"2e7dab63-f886-494b-8ea3-e7eff555af6b"}],"id":"bd8b895e-a32d-4bb6-aaad-59bbb3fa4f63","_postman_id":"bd8b895e-a32d-4bb6-aaad-59bbb3fa4f63","description":""},{"name":"Test Case","item":[{"name":"Create Test Case","id":"f801f41c-f17e-4a4d-8369-993a90f093af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Attempt to book a flight with missing required fields\",\n \"description\": \"Attempt to book a flight with missing required fields\",\n \"template_type\": \"TCD\",\n \"preconditions\": \"User has selected a flight from the search results. User is on the booking page.\",\n \"steps\": \"Leave one or more required fields (e.g., First Name, Last Name, Email) blank. Click the 'Book Now' button.\",\n \"expected_results\": \"An error message is displayed indicating that the required fields are missing. The user is prompted to fill in the missing fields.\",\n \"type_id\": \"75a816d1-8909-47b5-b85b-fbf60a973587\",\n \"status_id\": \"bafd7f8d-832a-42ea-91df-9a1e5e02a2d9\",\n \"automation_type_id\": \"3cee45b5-4335-4564-bbdf-4ea9b0306ed3\",\n \"project_id\": \"c47ade67-0543-4582-a4a5-b7de447c94f5\",\n \"priority_id\": \"1d810f8f-7be0-41e4-9971-67ee1f55612e\",\n \"owner_id\": \"cbbc40a5-26e9-4b88-8c27-3626c9fbdaa4\",\n \"reviewer_id\": \"cbbc40a5-26e9-4b88-8c27-3626c9fbdaa4\",\n \"folder_id\": \"580e3972-7f4a-4748-87e6-9b74873e2b93\",\n \"label_ids\": [\"Flight_testcase\"],\n \"individual_steps\": [\n \n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_cases","description":"This endpoint allows users to create a new test case within a specified project. It is designed to facilitate the addition of detailed test scenarios that can be executed during the testing phase of a project.
\nMethod: POST
\nURL: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_cases
The request body must be in JSON format and include the following parameters:
\nUpon successful creation of a test case, the API will return a response with the following structure:
\nStatus Code: 201
\nContent-Type: application/json
\nThis endpoint is essential for maintaining a structured and organized testing process within a project, enabling teams to track and manage test cases effectively.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","test_cases"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[{"id":"4d3f3e15-5b5f-4110-9f3d-736f93cf02de","name":"Create Test Case","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Attempt to book a flight with missing required fields\",\n \"description\": \"Attempt to book a flight with missing required fields\",\n \"template_type\": \"TCD\",\n \"preconditions\": \"User has selected a flight from the search results. User is on the booking page.\",\n \"steps\": \"Leave one or more required fields (e.g., First Name, Last Name, Email) blank. Click the 'Book Now' button.\",\n \"expected_results\": \"An error message is displayed indicating that the required fields are missing. The user is prompted to fill in the missing fields.\",\n \"type_id\": \"75a816d1-8909-47b5-b85b-fbf60a973587\",\n \"status_id\": \"bafd7f8d-832a-42ea-91df-9a1e5e02a2d9\",\n \"automation_type_id\": \"3cee45b5-4335-4564-bbdf-4ea9b0306ed3\",\n \"project_id\": \"c47ade67-0543-4582-a4a5-b7de447c94f5\",\n \"priority_id\": \"1d810f8f-7be0-41e4-9971-67ee1f55612e\",\n \"owner_id\": \"cbbc40a5-26e9-4b88-8c27-3626c9fbdaa4\",\n \"reviewer_id\": \"cbbc40a5-26e9-4b88-8c27-3626c9fbdaa4\",\n \"folder_id\": \"580e3972-7f4a-4748-87e6-9b74873e2b93\",\n \"label_ids\": [\"Flight_testcase\"],\n \"individual_steps\": [\n \n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_cases"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f801f41c-f17e-4a4d-8369-993a90f093af"},{"name":"Get Test Case By Id","id":"9c09349f-5c16-4d29-9f8e-194576b6b841","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_cases/DEMO-2","description":"This endpoint retrieves the details of a specific test case within a project.
\nHTTP Method: GET
Endpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_cases/DEMO-2
Project_ID (path parameter): The unique identifier of the project that contains the test case.Status Code: 200 OK
Content-Type: application/json
Response Body:
\nmessage: A string that may contain additional information about the request (usually empty).
data: An object containing details of the test case.
test_case: An object with the following properties:
id: The unique identifier of the test case.
title: The title of the test case.
description: A detailed description of the test case.
template_type: The type of template used for the test case.
preconditions: Any preconditions that must be met before executing the test case.
steps: The steps to execute the test case.
expected_results: The expected results from executing the test case.
human_id: A human-readable identifier for the test case.
owner_id: The identifier of the user who owns the test case.
type_id: The type identifier of the test case.
status_id: The current status of the test case.
automation_type_id: The identifier for the automation type of the test case.
priority_id: The priority level of the test case.
reviewer_id: The identifier of the reviewer for the test case.
folder_id: The identifier of the folder containing the test case.
project_id: The identifier of the project associated with the test case.
created_at: Timestamp indicating when the test case was created.
updated_at: Timestamp indicating when the test case was last updated.
This endpoint allows you to update an existing test case within a specified project in the Test Management System (TMS).
\nMethod: PUT
Endpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_cases/DEMO-2
The request body must be in JSON format and includes the following parameters:
\ntitle (string): The title of the test case.
\ndescription (string): A detailed description of the test case.
\ntemplate_type (string): The type of template used for the test case (e.g., STEPS).
\npreconditions (string): Preconditions that must be met before executing the test case.
\nsteps (string): The steps to execute the test case.
\nexpected_results (string): The expected results after executing the test case.
\ntype_id (string): The ID representing the type of the test case.
\nstatus_id (string): The ID representing the current status of the test case.
\nautomation_type_id (string): The ID for the automation type associated with the test case.
\nproject_id (string): The ID of the project to which the test case belongs.
\npriority_id (string): The ID representing the priority of the test case.
\nowner_id (string): The ID of the user who owns the test case.
\nreviewer_id (string): The ID of the user who will review the test case.
\nfolder_id (string): The ID of the folder where the test case is stored.
\nlabel_ids (array of strings): An array of labels associated with the test case.
\nindividual_steps (array of objects): An array of individual steps for the test case, where each step includes:
\nstep_description (string): Description of the individual step.
\nexpected_results (string): Expected results for the individual step.
\norder (integer): The order of the step in the test case.
\nstep_type (string): The type of the individual step.
\nstep_group_id (string, optional): The ID of the group this step belongs to (if applicable).
\nOn a successful update, the response will return a status code of 200 and a JSON object containing:
message (string): A message indicating the result of the operation (empty if successful).
\ndata (object): Contains the updated test case details:
\ntest_case (object): Includes the properties of the test case such as:
\nid (string): The unique identifier of the test case.
\ntitle (string): The title of the test case.
\ndescription (string): The description of the test case.
\ntemplate_type (string): The type of template used.
\npreconditions (string): Preconditions for the test case.
\nsteps (string): Steps for the test case.
\nexpected_results (string): Expected results for the test case.
\nowner_id (string): ID of the owner.
\ntype_id (string): Type ID of the test case.
\nstatus_id (string): Current status ID.
\nautomation_type_id (string): Automation type ID.
\npriority_id (string): Priority ID.
\nreviewer_id (string): Reviewer ID.
\nfolder_id (string): Folder ID.
\nproject_id (string): Project ID.
\nindividual_steps (array of objects): Contains the individual steps of the test case with their details.
\ncreated_at (timestamp): Timestamp of when the test case was created.
\nupdated_at (timestamp): Timestamp of the last update to the test case.
\nEnsure that all required fields are provided in the request body to successfully update the test case.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","test_cases","DEMO-2"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[{"id":"204861e1-b9fe-4b81-ba25-c2a7d94afc08","name":"Update Test Case By Id","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Attempt to book a flight with missing required fields\",\n \"description\": \"Attempt to book a flight with missing required fields\",\n \"template_type\": \"STEPS\",\n \"preconditions\": \"User has selected a flight from the search results. User is on the booking page.\",\n \"steps\": \"Leave one or more required fields (e.g., First Name, Last Name, Email) blank. Click the 'Book Now' button.\",\n \"expected_results\": \"An error message is displayed indicating that the required fields are missing. The user is prompted to fill in the missing fields.\",\n \"type_id\": \"75a816d1-8909-47b5-b85b-fbf60a973587\",\n \"status_id\": \"bafd7f8d-832a-42ea-91df-9a1e5e02a2d9\",\n \"automation_type_id\": \"3cee45b5-4335-4564-bbdf-4ea9b0306ed3\",\n \"project_id\": \"c47ade67-0543-4582-a4a5-b7de447c94f5\",\n \"priority_id\": \"1d810f8f-7be0-41e4-9971-67ee1f55612e\",\n \"owner_id\": \"cbbc40a5-26e9-4b88-8c27-3626c9fbdaa4\",\n \"reviewer_id\": \"cbbc40a5-26e9-4b88-8c27-3626c9fbdaa4\",\n \"folder_id\": \"580e3972-7f4a-4748-87e6-9b74873e2b93\",\n \"label_ids\": [\"Flight_testcase\"],\n \"individual_steps\": [\n {\n \"step_description\": \"Enter username updated\",\n \"expected_results\": \"Username is entered successfully\",\n \"order\": 1.0,\n \"step_type\": \"DEFAULT\",\n \"step_group_id\": null\n },\n {\n \"step_description\": \"Enter password updated\",\n \"expected_results\": \"Password is entered successfully\",\n \"order\": 2.0,\n \"step_type\": \"DEFAULT\",\n \"step_group_id\": null\n },\n {\n \"step_description\": \"Click login\",\n \"expected_results\": \"User is redirected to the dashboard\",\n \"order\": 3.0,\n \"step_type\": \"DEFAULT\",\n \"step_group_id\": null\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_cases/DEMO-2"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9baff961-9f1d-491a-a666-5e77ae7e4913"},{"name":"Delete Test Case By Id","id":"c761c139-3db0-4537-a5fa-a45e632f1541","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_cases/DEMO-2","description":"This endpoint is used to delete a specific test case identified by its unique ID from a project.
\nMethod: DELETE
\nURL: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_cases/DEMO-2
Project_ID: The unique identifier of the project from which the test case will be deleted.Upon a successful deletion, the API responds with a status code of 200 and a JSON object containing a message.
Status: 200 OK
Content-Type: application/json
{ \"message\": \"\"}
\nThis indicates that the test case has been successfully deleted, and the message field may contain additional information in future responses.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","test_cases","DEMO-2"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[{"id":"9c707d4e-23ff-48db-bbc4-90be081dd84b","name":"Delete Test Case By Id","originalRequest":{"method":"DELETE","header":[],"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_cases/DEMO-2"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c761c139-3db0-4537-a5fa-a45e632f1541"},{"name":"List Test Cases","id":"d07c9975-afd5-4874-93e2-2186ec3efa47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_cases","description":"This endpoint retrieves a list of test cases associated with a specific project. It allows users to access detailed information about each test case, including its attributes and related steps.
\nMethod: GET
\nURL: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_cases
Project_ID (string): The unique identifier for the project whose test cases are being requested.The response will return a JSON object containing the following structure:
\nStatus: 200 OK
\nContent-Type: application/json
\nmessage: A string that may contain additional information regarding the response (empty if no message).
\ndata: An object containing:
\ntest_cases: An array of test case objects, each with the following properties:
\nid: The unique identifier for the test case.
\ntitle: The title of the test case.
\ndescription: A detailed description of the test case.
\ntemplate_type: The type of template used for the test case.
\nhuman_id: A human-readable identifier for the test case.
\nowner_id: The identifier of the user who owns the test case.
\ntype_id: The type identifier of the test case.
\nstatus_id: The current status identifier of the test case.
\nautomation_type_id: The identifier for the type of automation applied.
\npriority_id: The priority level identifier of the test case.
\nfolder_id: The identifier of the folder containing the test case.
\nproject_id: The identifier of the project to which the test case belongs.
\nindividual_steps: An array of step objects related to the test case, each containing:
\nid: The unique identifier for the step.
\nstep_description: A description of the step.
\nexpected_results: The expected outcome of the step.
\norder: The order in which the step should be executed.
\nstep_type: The type of the step.
\ntest_case_id: The identifier of the test case this step belongs to.
\ncreated_at: The timestamp when the step was created.
\nupdated_at: The timestamp when the step was last updated.
\npage_info: An object providing pagination information:
\npage_size: The number of test cases returned in the response.
\ntotal_count: The total number of test cases available for the project.
\nnext: A link to the next page of results, if applicable.
\nprev: A link to the previous page of results, if applicable.
\nThis endpoint is essential for users who need to manage and review test cases within a specific project.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","test_cases"],"host":["https://test-management.testsigma.com"],"query":[{"disabled":true,"key":"page_size","value":"1"}],"variable":[]}},"response":[{"id":"623f6155-c40b-4adb-bda8-17c28ce434a9","name":"List Test Cases","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_cases","host":["https://test-management.testsigma.com"],"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","test_cases"],"query":[{"key":"page_size","value":"1","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d07c9975-afd5-4874-93e2-2186ec3efa47"}],"id":"2aa42c7d-34cd-4975-88f9-ce737583380a","_postman_id":"2aa42c7d-34cd-4975-88f9-ce737583380a","description":""},{"name":"Step Group","item":[{"name":"Create Step Group","id":"29c69813-2e9e-44b1-83ea-3539c3f48077","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Regression Test Step Group - 5\",\n \"description\": \"Step group for regression test cases\",\n \"label_ids\": [\"3ebf1ec4-f994-4f41-822a-01305e1f78c1\"],\n \"steps\": [\n {\n \"step_description\": \"Open the application and navigate to the login page\",\n \"expected_result\": \"Login page should be displayed\",\n \"order\": 1\n },\n {\n \"step_description\": \"Enter valid credentials and click login\",\n \"expected_result\": \"User should be redirected to the dashboard\",\n \"order\": 2\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/step_groups","description":"This endpoint allows you to create a new step group for a specific project in the Test Management System (TMS). A step group is a collection of steps that can be used to outline a testing process.
\nMethod: POST
Endpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/step_groups
title (string): The title of the step group. This should be a descriptive name that indicates the purpose of the step group.
\ndescription (string): A detailed description of the step group, providing context for its use.
\nlabel_ids (array of strings): An array of label IDs associated with the step group. These labels can help categorize the step group.
\nsteps (array of objects): An array of steps that belong to the step group. Each step object contains:
\nstep_description (string): A description of the step to be executed.
\nexpected_result (string): The expected outcome of executing the step.
\norder (integer): The order in which the step should be executed within the step group.
\n{\n \"title\": \"Regression Test Step Group - 5\",\n \"description\": \"Step group for regression test ...\",\n \"label_ids\": [\"3ebf1ec4-f994-4f41-822a-01305e ...\"],\n \"steps\": [\n {\n \"step_description\": \"Open the application and navig ...\",\n \"expected_result\": \"Login page should be displayed\",\n \"order\": 1\n }\n ]\n}\n\nStatus Code: 200
Content-Type: application/json
The response will contain a message and a data object that includes the created step group details.
\nmessage (string): A message indicating the result of the request (may be empty).
\ndata (object): Contains the details of the created step group.
\nstep_group (object): The step group that was created.
\nid (string): The unique identifier of the step group.
\ntitle (string): The title of the step group.
\ndescription (string): The description of the step group.
\nhuman_id (string): A human-readable identifier for the step group.
\nsteps (array of objects): The steps included in the step group, each with:
\nid (string): The unique identifier for the step.
\nstep_description (string): The description of the step.
\nexpected_results (string): The expected results of the step.
\norder (integer): The order of the step.
\nstep_group_id (string): The ID of the step group to which the step belongs.
\ncreated_at (integer): Timestamp of when the step was created.
\nupdated_at (integer): Timestamp of the last update to the step.
\nproject_id (string): The ID of the project to which the step group belongs.
\ncreated_at (integer): Timestamp of when the step group was created.
\nupdated_at (integer): Timestamp of the last update to the step group.
\nThis endpoint is essential for organizing and managing test steps effectively within a project.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","step_groups"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"29c69813-2e9e-44b1-83ea-3539c3f48077"},{"name":"Get Step Group By ID","id":"0baad7ba-19e7-4e9b-a07b-3b939269a354","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/step_groups/DEMO-SG-1","description":"This endpoint retrieves detailed information about a specific step group within a project in the system. The request is made using the HTTP GET method and requires the project ID and the specific step group identifier.
\nMethod: GET
\nURL: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/step_groups/DEMO-SG-1
Project_ID: The unique identifier for the project from which the step group information is being requested.Upon a successful request, the server responds with a status code of 200 and returns a JSON object containing the following structure:
message: A string that may contain additional information or status about the request (usually empty).
\ndata: An object that includes:
\nstep_group: An object representing the step group with the following properties:
\nid: The unique identifier of the step group.
\ntitle: The title of the step group.
\ndescription: A brief description of the step group.
\nhuman_id: A human-readable identifier for the step group.
\nsteps: An array of step objects, each containing:
\nid: The unique identifier of the step.
\nstep_description: A description of the step.
\nexpected_results: The expected results after executing the step.
\norder: The order in which the step appears within the step group.
\nstep_group_id: The identifier of the step group to which the step belongs.
\ncreated_at: A timestamp indicating when the step was created.
\nupdated_at: A timestamp indicating when the step was last updated.
\nproject_id: The identifier of the project to which the step group belongs.
\ncreated_at: A timestamp indicating when the step group was created.
\nupdated_at: A timestamp indicating when the step group was last updated.
\n{\n \"message\": \"\",\n \"data\": {\n \"step_group\": {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"human_id\": \"\",\n \"steps\": [\n {\n \"id\": \"\",\n \"step_description\": \"\",\n \"expected_results\": \"\",\n \"order\": 0,\n \"step_group_id\": \"\",\n \"created_at\": 0,\n \"updated_at\": 0\n }\n ],\n \"project_id\": \"\",\n \"created_at\": 0,\n \"updated_at\": 0\n }\n }\n}\n\nThis endpoint is useful for obtaining the details of a specific step group, including its associated steps and metadata, which can be leveraged for project management and execution tracking.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","step_groups","DEMO-SG-1"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0baad7ba-19e7-4e9b-a07b-3b939269a354"},{"name":"Update Step Group By ID","id":"1d471dae-3b85-441d-9b0d-48c4980ef335","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Regression Test Step Group - 6\",\n \"description\": \"Step group for regression test cases\",\n \"label_ids\": [\"3ebf1ec4-f994-4f41-822a-01305e1f78c1\"],\n \"steps\": [\n {\n \"step_description\": \"Open the application and navigate to the login page\",\n \"expected_result\": \"Login page should be displayed\",\n \"order\": 1\n },\n {\n \"step_description\": \"Enter valid credentials and click login updated\",\n \"expected_result\": \"User should be redirected to the dashboard\",\n \"order\": 2\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/step_groups/DEMO-SG-1","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","step_groups","DEMO-SG-1"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1d471dae-3b85-441d-9b0d-48c4980ef335"},{"name":"Delete Step Group By ID","id":"bf68d792-4feb-43cc-bc52-617c6b3c97c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/step_groups/DEMO-SG-1","description":"This endpoint allows users to delete a specific step group from a project in the Task Management System (TMS).
\nMethod: DELETE
\nURL: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/step_groups/DEMO-SG-1
Project_ID (string): The unique identifier of the project from which the step group will be deleted.
DEMO-SG-1 (string): The identifier of the step group that is to be deleted.
Upon successful deletion, the API will return a response indicating the result of the operation. The response typically includes:
\nA success message confirming that the step group has been deleted.
\nHTTP Status Code: 204 No Content if the deletion is successful, indicating that the request was processed successfully with no content to return.
Ensure that the Project_ID and step group identifier are correct before making the request, as this action cannot be undone.
Users should have the necessary permissions to delete step groups within the specified project.
\nThis endpoint retrieves a list of step groups associated with a specific project. It allows users to paginate through the results by specifying the page_size parameter.
Method: GET
Endpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/step_groups?page_size=1
page_size (integer, required): Specifies the number of step groups to return in the response. In this case, it is set to 1.The response will be a JSON object containing the list of step groups for the specified project. The structure of the response typically includes:
\nstep_groups (array): An array of step group objects, each containing details about the step group.
total_count (integer): The total number of step groups available for the project.
page (integer): The current page number of the results returned.
page_size (integer): The number of items returned per page.
{\n \"step_groups\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n ...\n }\n ],\n \"total_count\": 0,\n \"page\": 1,\n \"page_size\": 1\n}\n\nThis endpoint is useful for clients needing to display or process step groups in a project, enabling efficient data retrieval with pagination support.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","step_groups"],"host":["https://test-management.testsigma.com"],"query":[{"key":"page_size","value":"1"},{"disabled":true,"key":"after","value":"MnVxT0RFTXZvRVVvVERYSUdpVU1oOGNnc0Vr"}],"variable":[]}},"response":[],"_postman_id":"6e88c2e0-e3b2-4294-b9a9-60d396a13211"}],"id":"f3576f1b-07bc-46cc-9f3e-a93bd129493e","_postman_id":"f3576f1b-07bc-46cc-9f3e-a93bd129493e","description":""},{"name":"Test Run","item":[{"name":"Junit report Import","item":[{"name":"Junit Report Import","id":"cfad67fa-6f46-4ab9-961b-97225539e231","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiJkNDFjMmQwMS02M2NjLTRkNWMtYTE4My0xOTc3MWZhM2NjOTgiLCJuYmYiOjE3NTAxMjg0NzUsImlhdCI6MTc1MDEyODQ3NSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.5yTDybaptbqG7mPa3rkhme4IEvYL-CyD04EiH8-GFsQ"}],"body":{"mode":"formdata","formdata":[{"type":"file","key":"junit_xml","src":"/Users/saikrishna.javvadi/Downloads/9838 (1).xml"}]},"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/junit-import/test-run/DEMO-R-4","description":"This endpoint allows you to import JUnit test results into a specific project.
\nHTTP Method: POST
Endpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/junit-import/test-run/DEMO-R-4
Authorization: Required. Bearer token for authentication.
\nForm Data:
\nThe response will typically contain information about the success or failure of the import operation. It may include:
\nA success message indicating that the test results have been imported successfully.
\nError messages if the import fails, detailing what went wrong.
\nEnsure that the JUnit XML file is correctly formatted to avoid import errors.
\nThe Project_ID in the URL must correspond to an existing project in the system.
This endpoint is intended for use with valid authorization tokens only.
\nThis endpoint retrieves the status of a specific JUnit import for a given project in the system.
\nThe primary purpose of this request is to check the status of a JUnit import process identified by a unique import ID. This can be useful for monitoring the progress or outcome of the import operation.
\nProject_ID (path parameter): The unique identifier of the project for which the JUnit import status is being queried.
\nImport_ID (path parameter): The unique identifier of the JUnit import whose status is being retrieved.
\nAuthorization: A Bearer token that grants access to the API. It is required for authentication.
\nContent-Type: Specifies the media type of the resource. For this request, it should be set to application/json.
The response will typically include:
\nstatus: A string indicating the current status of the JUnit import (e.g., \"pending\", \"in_progress\", \"completed\", \"failed\").
\ndetails: An object containing additional information about the import process, which may include error messages or logs if the import has failed.
\nMake sure to replace https://test-management.testsigma.com and c47ade67-0543-4582-a4a5-b7de447c94f5 with the appropriate values before making the request.
This endpoint allows you to create a new test run for a specific project. A test run is a collection of test cases that are executed together, and it is essential for tracking the progress and results of testing activities.
\nMethod: POST
\nEndpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_runs
The request body must be in JSON format and should include the following parameters:
\ntitle (string): The title of the test run.
\ndescription (string): A brief description of the test run.
\nstatus (string): The status of the test run (e.g., ACTIVE).
\nproject_id (string): The ID of the project to which the test run belongs.
\nhuman_id (string): A human-readable identifier for the test run.
\nselection_type (string): The type of selection for the test cases (e.g., STATIC).
\nstatic_selection_filters (array): An array of filters to select specific test cases. Each filter object contains:
\nfield (string): The field to filter on (e.g., \"id\").
\noperator (string): The operator to use for filtering (e.g., \"IN\").
\nvalues (array): An array of values to match against the field.
\nstart_date (integer): The start date of the test run in Unix timestamp format.
\nend_date (integer): The end date of the test run in Unix timestamp format.
\nassignee_id (string): The ID of the user assigned to the test run.
\nlabel_names (array): An array of labels associated with the test run.
\nenvironment_ids (array): An array of environment IDs where the test run will be executed.
\nUpon successful creation of the test run, the response will typically include the details of the created test run, including its unique identifier and the parameters you provided in the request. The exact structure of the response may vary, but it generally confirms the successful creation and may include additional metadata related to the test run.
\nEnsure that all required fields are provided in the request body to avoid errors during the creation process.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","test_runs"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"617e16fd-0c19-42f3-b47e-81838151a45d"},{"name":"Get Test Run By Id","id":"e9a40e8e-8940-4b03-a257-821b656ffc33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"{{TMS_LOCAL}}/api/v1/projects/bd57bbc6-e83e-4f09-927d-fc48b3509cdf/test_runs/123-R-21","description":"This endpoint retrieves detailed information about a specific test run associated with a project in the Test Management System (TMS).
\nMethod: GET
URL: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_runs/DEMO-R-1
Project_ID: The unique identifier of the project to which the test run belongs.The response will contain the details of the specified test run. The structure of the response typically includes the following fields:
\nid: The unique identifier for the test run.
\nname: The name of the test run.
\nstatus: The current status of the test run (e.g., passed, failed, in progress).
\ncreated_at: The timestamp when the test run was created.
\nupdated_at: The timestamp when the test run was last updated.
\nresults: An array of results associated with the test run, which may include individual test case results.
\nThis endpoint is useful for retrieving the current state and details of a test run, allowing users to monitor progress and outcomes.
\n","urlObject":{"path":["api","v1","projects","bd57bbc6-e83e-4f09-927d-fc48b3509cdf","test_runs","123-R-21"],"host":["{{TMS_LOCAL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9a40e8e-8940-4b03-a257-821b656ffc33"},{"name":"Get Test Run Cases By Id","id":"c0833e36-3960-4efa-be08-eec7097f2b58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_runs/DEMO-R-1/test_cases","description":"This endpoint retrieves a list of test cases associated with a specific test run within a project.
\nGET
https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_runs/DEMO-R-1/test_cases
The response will contain a JSON object that includes details about the test cases linked to the specified test run. The structure of the response will typically include:
\nEnsure that you have the necessary permissions to access the test cases for the specified project and test run.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","test_runs","DEMO-R-1","test_cases"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0833e36-3960-4efa-be08-eec7097f2b58"},{"name":"Assign user to test run case","id":"0cdf08d7-1793-4f2d-bdc7-f5c63aea5b38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\":\"cbbc40a5-26e9-4b88-8c27-3626c9fbdaa4\",\n \"test_case_id\":\"9ac271b6-4e89-4c93-8c75-2d625efa0b2d\"\n}","options":{"raw":{"language":"json"}}},"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_runs/DEMO-R-1/assign_user","description":"This endpoint allows you to assign a user to a specific test run within a project. The request updates the user assignment for the specified test run identified by DEMO-R-1.
The request requires a JSON payload with the following parameters:
\nuser_id (string): The unique identifier of the user you want to assign to the test run.
\ntest_case_id (string): The unique identifier of the test case that is associated with the test run.
\n{\n \"user_id\": \"cbbc40a5-26e9-4b88-8c27-3626c9...\",\n \"test_case_id\": \"9ac271b6-4e89-4c93-8c75-2d625e...\"\n}\n\nUpon successful assignment, the API will return a confirmation response indicating that the user has been successfully assigned to the test run. The specific structure of the response may vary based on the implementation.
\nEnsure that the user_id corresponds to an existing user in the system.
The test_case_id should relate to a test case that exists within the context of the specified test run.
This operation is idempotent; calling it multiple times with the same parameters will not change the outcome after the first successful call.
\nThis endpoint allows updating the status of test cases within a specific test run for a project.
\nPUThttps://test-management.testsigma.com/api/v1/projects/{Project_ID}/test_runs/{Test_Run_ID}/test_casesProject_ID (String, Required): Unique identifier of the projectTest_Run_ID (String, Required): Identifier of the specific test run (e.g., RMILM-R-4)The request uses multipart/form-data with a JSON payload containing an array of test case updates.
{\n \"test_run_cases\": [\n {\n \"test_case_id\": \"string\",\n \"test_run_status_id\": \"string\",\n \"user_id\": \"string\",\n \"description\": \"string\"\n }\n ]\n}\ntest_run_cases (Array, Required): Collection of test case updatestest_case_id (String, Required): Unique identifier of the test casetest_run_status_id (String, Required): Status identifier for the test runuser_id (String, Required): Identifier of the user executing the test casedescription (String, Optional): Additional details about the test case executionAuthorization: Bearer <token>{\n \"test_run_cases\": [\n {\n \"test_case_id\": \"1c4a6347-dec5-4f8e-8b6c-cda33c37c9ce\",\n \"test_run_status_id\": \"0ba381b5-c018-40c6-b6fa-10d6e556ef9d\",\n \"user_id\": \"05782b39-...\",\n \"description\": \"Test case completed successfully\"\n }\n ]\n}\nThis endpoint allows you to update an existing test run within a specified project. The test run is identified by the DEMO-R-3 identifier in the URL, and the request modifies its attributes such as title, description, status, and other relevant details.
HTTP Method: PUT
Endpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_runs/DEMO-R-3
The request body should be in JSON format and include the following parameters:
\ntitle (string): The title of the test run.
\ndescription (string): A detailed description of the test run.
\nstatus (string): The current status of the test run (e.g., ACTIVE).
\nproject_id (string): The ID of the project to which the test run belongs.
\nhuman_id (string): A human-readable identifier for the test run.
\nselection_type (string): The type of selection for the test run (e.g., STATIC).
\nstart_date (integer): The start date of the test run in Unix timestamp format.
\nend_date (integer): The end date of the test run in Unix timestamp format.
\nassignee_id (string): The ID of the user assigned to the test run.
\nlabel_names (array of strings): An array of labels associated with the test run.
\nenvironment_ids (array of strings): An array of environment IDs where the test run will be executed.
\nUpon a successful update, the response will typically include the updated test run details. The structure of the response may include:
\nid (string): The unique identifier of the test run.
\ntitle (string): The updated title of the test run.
\ndescription (string): The updated description of the test run.
\nstatus (string): The updated status of the test run.
\nproject_id (string): The ID of the project.
\nhuman_id (string): The updated human-readable identifier.
\nselection_type (string): The type of selection for the test run.
\nstart_date (integer): The updated start date in Unix timestamp format.
\nend_date (integer): The updated end date in Unix timestamp format.
\nassignee_id (string): The ID of the user assigned to the test run.
\nlabel_names (array of strings): The updated labels associated with the test run.
\nenvironment_ids (array of strings): The updated environment IDs.
\nEnsure that the request body adheres to the specified format to avoid errors and to successfully update the test run details.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","test_runs","DEMO-R-3"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"95b9cf04-634c-469d-886b-fa94cb9395d1"},{"name":"Delete Test Run By Id","id":"bcd8a713-e3a6-4fb3-afb8-068205f969c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{TMS_LOCAL}}/api/v1/projects/bd57bbc6-e83e-4f09-927d-fc48b3509cdf/test_runs/123-R-21","description":"This endpoint is used to delete a specific test run associated with a project in the Test Management System (TMS). By sending a DELETE request to this endpoint, users can remove a test run identified by its unique identifier.
\nMethod: DELETE
\nEndpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_runs/{{Test_Run_ID}}
Project_ID: The unique identifier of the project from which the test run will be deleted.
Test_Run_ID: The unique identifier of the test run that needs to be deleted. In the example provided, this is represented as DEMO-R-3.
Upon successful deletion, the response will typically include a status code indicating the result of the operation. A successful deletion will return a 204 No Content status, indicating that the request was processed successfully and there is no content to return.
If the specified test run exists and is successfully deleted, the API will respond with a 204 No Content status.
If the test run does not exist or if there is an error in the request, an appropriate error message and status code will be returned.
\nThis endpoint is essential for maintaining the integrity of test runs within a project, allowing users to manage their test data effectively.
\n","urlObject":{"path":["api","v1","projects","bd57bbc6-e83e-4f09-927d-fc48b3509cdf","test_runs","123-R-21"],"host":["{{TMS_LOCAL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bcd8a713-e3a6-4fb3-afb8-068205f969c6"},{"name":"List Test Runs","id":"581fbbb8-ccfd-492c-90a8-e0037d46378e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_runs","description":"This endpoint retrieves a list of test runs associated with a specific project identified by Project_ID. It is useful for obtaining detailed information about the test executions that have been conducted within the project.
Method: GET
\nEndpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_runs
The response will contain a JSON object that includes the following fields:
\ntest_runs: An array of objects, where each object represents a test run. Each test run object typically includes:
\nid: Unique identifier for the test run.
name: The name of the test run.
status: The current status of the test run (e.g., passed, failed).
created_at: Timestamp indicating when the test run was created.
updated_at: Timestamp indicating when the test run was last updated.
The response will provide a comprehensive overview of all test runs related to the specified project, allowing users to analyze and track testing progress effectively.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","test_runs"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"581fbbb8-ccfd-492c-90a8-e0037d46378e"},{"name":"New Request","id":"c004f343-d8c3-4bda-9db0-82fbf394bee3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"c004f343-d8c3-4bda-9db0-82fbf394bee3"}],"id":"eb060d69-6d09-4ab9-9816-c758050c3ddf","_postman_id":"eb060d69-6d09-4ab9-9816-c758050c3ddf","description":""},{"name":"Test Plan","item":[{"name":"Create Test Plan","id":"29505382-8d48-4b5a-9cf0-b48d728bd389","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Sample Test Plan\",\n \"description\": \"This is a test plan description.\",\n \"start_date\": 1710374400,\n \"end_date\": 1712966400,\n \"label_ids\": [\"3ebf1ec4-f994-4f41-822a-01305e1f78c1\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{TMS_LOCAL}}/api/v1/projects/bd57bbc6-e83e-4f09-927d-fc48b3509cdf/test_plans","description":"This endpoint allows you to create a new test plan within a specific project.
\nPOST
https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_plans
The request body must be in JSON format and should include the following parameters:
\ntitle (string): The title of the test plan.
\ndescription (string): A detailed description of the test plan.
\nstart_date (integer): The start date of the test plan represented as a Unix timestamp.
\nend_date (integer): The end date of the test plan represented as a Unix timestamp.
\nlabel_ids (array of strings): An array of label IDs associated with the test plan.
\nOn successful creation of the test plan, the API will return a response indicating the success of the operation, typically including the details of the created test plan such as its ID and any other relevant information.
\nEnsure that all required fields are provided in the request to avoid errors.
\n","urlObject":{"path":["api","v1","projects","bd57bbc6-e83e-4f09-927d-fc48b3509cdf","test_plans"],"host":["{{TMS_LOCAL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"29505382-8d48-4b5a-9cf0-b48d728bd389"},{"name":"Get Test Plan By Id","id":"973a8e43-85ab-4f8c-8255-6acb6a641df3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_plans/DEMO-P-1","description":"This endpoint retrieves the details of a specific test plan identified by the provided test plan ID within a project.
\nMethod: GET
\nURL: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_plans/DEMO-P-1
Project_ID: The unique identifier for the project that contains the test plan.The response will contain the details of the test plan, including various attributes that describe the test plan's configuration and status. The structure of the response may include:
\nid: The unique identifier of the test plan.
name: The name of the test plan.
description: A brief description of the test plan.
status: The current status of the test plan (e.g., active, inactive).
created_at: The timestamp when the test plan was created.
updated_at: The timestamp when the test plan was last updated.
This endpoint is useful for retrieving specific information about a test plan to facilitate further actions or assessments related to testing within the project.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","test_plans","DEMO-P-1"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"973a8e43-85ab-4f8c-8255-6acb6a641df3"},{"name":"Complete Test Plan By ID","id":"1c44f889-4efa-43d9-8e7c-851dffd11d78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"POST","header":[],"url":"https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_plans/DEMO-P-1/complete","description":"This endpoint is used to mark a specific test plan as complete within a project. It allows users to finalize the testing phase for a designated test plan identified by its unique ID.
\nMethod: POST
\nEndpoint: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_plans/DEMO-P-1/complete
The request body should be sent in application/x-www-form-urlencoded format and can include the following parameters:
parameter1 (text): Description of the first parameter.
parameter2 (text): Description of the second parameter.
parameter3 (text): Description of the third parameter.
(Note: Replace _parameter1_, _parameter2_, and _parameter3_ with actual parameter names and descriptions as applicable.)
Upon successful completion of the request, the API will return a response indicating the status of the operation. The response will typically include:
\nstatus: A string indicating the success or failure of the operation.
message: A descriptive message providing additional context about the operation's outcome.
data: An object containing any relevant data related to the completed test plan.
This structure helps users understand the result of their request and any further actions that may be required.
\n","urlObject":{"path":["api","v1","projects","c47ade67-0543-4582-a4a5-b7de447c94f5","test_plans","DEMO-P-1","complete"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1c44f889-4efa-43d9-8e7c-851dffd11d78"},{"name":"List Test Run For Test Plan","id":"72278cd3-6f9c-4463-9d95-b89e784a8276","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"{{TMS_LOCAL}}/api/v1/projects/bd57bbc6-e83e-4f09-927d-fc48b3509cdf/test_plans/8756d172-0c4f-4e37-9493-30a67d321863/test_runs","description":"This endpoint allows users to retrieve the test runs associated with a specific test plan within a project. It is particularly useful for tracking the execution status and results of tests defined in a test plan.
\nMethod: GET
\nURL: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_plans/DEMO-P-2/test_runs
This endpoint does not require any request body. The request is made using the URL parameters, specifically:
\nc47ade67-0543-4582-a4a5-b7de447c94f5: The unique identifier for the project.The response will contain a list of test runs associated with the specified test plan. The structure of the response typically includes:
\ntest_runs: An array of objects, each representing a test run with the following fields:
id: The unique identifier for the test run.
status: The current status of the test run (e.g., Passed, Failed).
started_at: Timestamp indicating when the test run started.
ended_at: Timestamp indicating when the test run ended.
duration: The total time taken for the test run.
results: Detailed results of the test execution.
This information is crucial for understanding the performance and outcomes of the tests conducted under the specified test plan.
\n","urlObject":{"path":["api","v1","projects","bd57bbc6-e83e-4f09-927d-fc48b3509cdf","test_plans","8756d172-0c4f-4e37-9493-30a67d321863","test_runs"],"host":["{{TMS_LOCAL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"72278cd3-6f9c-4463-9d95-b89e784a8276"},{"name":"Delete Test Plan By Id","id":"f19e054c-efe1-4dac-87a5-f53de498ba54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{TMS_LOCAL}}/api/v1/projects/bd57bbc6-e83e-4f09-927d-fc48b3509cdf/test_plans/123-P-4","description":"This endpoint allows users to delete a specific test plan associated with a project.
\nMethod: DELETE
\nURL: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_plans/DEMO-P-1
Project_ID: The unique identifier for the project from which the test plan will be deleted.
DEMO-P-1: The identifier of the test plan that you wish to delete.
Upon successful deletion of the test plan, the API will return a response indicating the status of the operation. The response will typically include:
\nA confirmation message indicating that the test plan has been successfully deleted.
\nAn appropriate HTTP status code (e.g., 204 No Content) to signify that the request was successful.
\nEnsure that the Project_ID and test plan identifier are correct before making the request, as this action is irreversible.
Only authorized users with the necessary permissions can perform this operation.
\nThis endpoint allows you to update an existing test plan within a specific project in the Test Management System (TMS).
\nPUT
https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_plans/DEMO-P-2
The request body must be in JSON format and should contain the following parameters:
\n{\n \"title\": \"Sample Test Plan - 3 updated\"\n}\n\nUpon a successful update, the API will return a response indicating the status of the operation. The response will typically include details about the updated test plan, confirming the changes made.
\nEnsure that the Project_ID and the test plan identifier (DEMO-P-2) are correctly specified in the endpoint to successfully update the desired test plan.
Method: GET
URL: https://test-management.testsigma.com/api/v1/projects/c47ade67-0543-4582-a4a5-b7de447c94f5/test_plans
This endpoint retrieves a list of test plans associated with a specific project identified by Project_ID. It allows users to view all test plans that have been created under the specified project, facilitating better management and tracking of testing activities.
This endpoint does not require a request body. The Project_ID must be specified in the URL to identify the project for which the test plans are being requested.
The response will be in JSON format and typically includes the following fields:
\ntest_plans: An array of test plan objects, each containing:
id: Unique identifier for the test plan.
name: The name of the test plan.
description: A brief description of the test plan.
created_at: Timestamp indicating when the test plan was created.
updated_at: Timestamp indicating when the test plan was last updated.
The response will provide the necessary information for users to understand the test plans available for the specified project.
\n","urlObject":{"path":["api","v1","projects","bd57bbc6-e83e-4f09-927d-fc48b3509cdf","test_plans"],"host":["{{TMS_LOCAL}}"],"query":[{"disabled":true,"key":"page_size","value":"2"},{"disabled":true,"key":"sort","value":"-created_at"},{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[],"_postman_id":"773d2a3a-6c20-4f75-9baf-ace8d607fe7c"}],"id":"36e8706c-5b17-4e04-9a73-19410f5eefe0","_postman_id":"36e8706c-5b17-4e04-9a73-19410f5eefe0","description":""},{"name":"Settings","item":[{"name":"Get Automation Types","id":"896fa889-808c-4dde-b0fa-14c4fa1ccbdc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/test_cases/automation_types","description":"This endpoint retrieves a list of automation types available in the system.
\nMethod: GET
Endpoint: https://test-management.testsigma.com/api/v1/test_cases/automation_types
Status Code: 200 OK
Content-Type: application/json
The response will contain the following structure:
\nmessage: A string that may contain additional information (currently empty).
\ndata: An object containing:
\nautomation_types: An array of objects, each representing an automation type with the following properties:
\nid: A unique identifier for the automation type.
\nname: The name of the automation type.
\norder: A numerical value indicating the order of the automation type.
\nalias: An alternative name or identifier for the automation type.
\nicon_url: A URL pointing to an icon representing the automation type.
\npage_info: An object providing pagination details:
\npage_size: The number of items per page (currently 0).
\ntotal_count: Total number of automation types available (currently 0).
\nnext: URL for the next page of results (currently empty).
\nprev: URL for the previous page of results (currently empty).
\nThis endpoint is useful for fetching all automation types, which can be utilized for further operations in the test case management system.
\n","urlObject":{"path":["api","v1","test_cases","automation_types"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[{"id":"03aef980-b758-4987-987b-bd7a5c5d2335","name":"Get Automation Types","originalRequest":{"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/test_cases/automation_types"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"896fa889-808c-4dde-b0fa-14c4fa1ccbdc"},{"name":"Get Test Case Types","id":"3a6a72ba-b345-46af-b10b-25806b971809","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/test_cases/types","description":"This endpoint retrieves the available types of test cases from the Test Management System (TMS). It is useful for obtaining a list of test case types that can be utilized in test planning and execution.
\nMethod: GET
\nURL: https://test-management.testsigma.com/api/v1/test_cases/types
Upon a successful request, the server responds with a JSON object containing the following structure:
\nmessage: A string that may contain additional information about the request (usually empty).
\ndata: An object containing:
\ntypes: An array of objects, each representing a test case type with the following properties:
\nid: A unique identifier for the test case type (string).
\nname: The name of the test case type (string).
\norder: The order in which the test case type appears (integer).
\nalias: An alternative name or identifier for the test case type (string).
\nicon_url: A URL pointing to an icon representing the test case type (string).
\npage_info: An object providing pagination details:
\npage_size: The number of items returned per page (integer).
\ntotal_count: The total number of test case types available (integer).
\nnext: A URL for the next page of results, if applicable (string).
\nprev: A URL for the previous page of results, if applicable (string).
\n{\n \"message\": \"\",\n \"data\": {\n \"types\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"order\": 0,\n \"alias\": \"\",\n \"icon_url\": \"\"\n }\n ]\n },\n \"page_info\": {\n \"page_size\": 0,\n \"total_count\": 0,\n \"next\": \"\",\n \"prev\": \"\"\n }\n}\n\nThis endpoint does not require any request body as it is a GET request.
\n","urlObject":{"path":["api","v1","test_cases","types"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[{"id":"03bac0d1-8a71-4534-8cc3-213c73cb46dd","name":"Get Test Case Types","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true}],"url":"https://test-management.testsigma.com/api/v1/test_cases/types"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3a6a72ba-b345-46af-b10b-25806b971809"},{"name":"Get Test Case Status","id":"2189a1cb-c3d4-4049-b657-c37b26becb21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/test_cases/statuses","description":"This endpoint retrieves the statuses of test cases from the Test Management System (TMS). It is useful for obtaining a list of all available test case statuses that can be used in the test management workflow.
\nMethod: GET
\nURL: https://test-management.testsigma.com/api/v1/test_cases/statuses
Request Body:
\nUpon a successful request, the API responds with a status code of 200 and returns a JSON object containing the following structure:
message: A string that may contain additional information (typically empty).
\ndata: An object containing:
\nstatuses: An array of status objects, each with the following properties:
\nid: A unique identifier for the status.
\nname: The name of the status.
\norder: An integer representing the order of the status in the list.
\nalias: An alternative name or identifier for the status.
\nicon_url: A URL pointing to an icon representing the status.
\npage_info: An object providing pagination details:
\npage_size: The number of items returned in the current response.
\ntotal_count: The total number of statuses available.
\nnext: A URL for the next page of results (if applicable).
\nprev: A URL for the previous page of results (if applicable).
\nThis structure allows clients to easily understand the available statuses and manage them effectively within their testing processes.
\n","urlObject":{"path":["api","v1","test_cases","statuses"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[{"id":"127893fa-a205-4c85-9ed6-437bb8aad220","name":"Get Test Case Status","originalRequest":{"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/test_cases/statuses"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"2189a1cb-c3d4-4049-b657-c37b26becb21"},{"name":"Get Test Case Priorities","id":"d2c613c9-a510-44f9-8996-3704b52deace","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/test_cases/priorities","description":"This endpoint retrieves a list of test case priorities from the system. It provides essential information regarding the different priority levels that can be assigned to test cases, which can help in organizing and managing testing efforts effectively.
\nMethod: GET
\nEndpoint: https://test-management.testsigma.com/api/v1/test_cases/priorities
Request Body: This endpoint does not require a request body.
\nUpon a successful request, the server responds with a 200 OK status and a JSON object containing the following structure:
message: A string that may contain additional information or context (typically empty).
\ndata: An object containing:
\npriorities: An array of priority objects, where each object includes:
\nid: A unique identifier for the priority.
\nname: The name of the priority.
\norder: A numerical value indicating the order of the priority in relation to others.
\nalias: An alternate name or shorthand for the priority.
\nicon_url: A URL pointing to an icon representing the priority.
\npage_info: An object providing pagination details:
\npage_size: The number of items per page (0 if no items).
\ntotal_count: The total number of priority items available.
\nnext: A URL for the next page of results (if applicable).
\nprev: A URL for the previous page of results (if applicable).
\nThis endpoint is useful for clients that need to display or utilize the test case priorities in their applications.
\n","urlObject":{"path":["api","v1","test_cases","priorities"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[{"id":"257df36f-5805-4721-a49d-272ed7fb4e88","name":"Get Test Case Priorities","originalRequest":{"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/test_cases/priorities"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d2c613c9-a510-44f9-8996-3704b52deace"},{"name":"Get Test Run Status","id":"eb9ce751-39c6-4f32-8945-3775f16ab50d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"}]},"isInherited":false},"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/test_runs/statuses","description":"This endpoint retrieves the status of test runs from the Test Management System (TMS). It provides a comprehensive list of available statuses that can be associated with test runs, allowing users to understand the current state of their testing processes.
\nMethod: GET
\nURL: https://test-management.testsigma.com/api/v1/test_runs/statuses
Upon a successful request, the API returns a JSON object with the following structure:
\nmessage: A string that may contain additional information (currently empty).
\ndata: An object containing:
\nstatuses: An array of status objects, each with the following properties:
\nid: A unique identifier for the status.
\nname: The name of the status.
\norder: The order in which the status appears.
\nicon_url: A URL pointing to an icon representing the status.
\nalias: An alternative name or identifier for the status.
\npage_info: An object providing pagination information:
\npage_size: The number of statuses returned in the current response.
\ntotal_count: The total number of statuses available.
\nnext: A URL to the next page of results, if applicable.
\nprev: A URL to the previous page of results, if applicable.
\nThe response will always include an empty message and the structure of the data will depend on the available statuses in the system.
\nThe page_info section is useful for pagination when the number of statuses exceeds the page size limit.
This endpoint retrieves a list of users from the system. It is designed to provide information about all registered users, including their basic details.
\nThis endpoint does not require any input parameters. It can be called directly to fetch the user data.
\nOn a successful request, the server responds with a status code of 200 and a JSON object containing the following structure:
message: A string that may contain additional information about the request (typically empty).
\ndata: An array of user objects, each containing:
\nid: A unique identifier for the user.
\nemail: The user's email address.
\nfirst_name: The user's first name.
\nlast_name: The user's last name.
\ncreated_at: A timestamp indicating when the user was created.
\nupdated_at: A timestamp indicating when the user was last updated.
\nstatus: The current status of the user (e.g., active, inactive).
\npage_info: An object providing pagination details:
\npage_size: The number of users returned in this response.
\ntotal_count: The total number of users available.
\nnext: A URL for the next page of results (if applicable).
\nprev: A URL for the previous page of results (if applicable).
\nThis endpoint is useful for applications that need to display or manage user information in a consistent manner.
\n","urlObject":{"path":["api","v1","users"],"host":["https://test-management.testsigma.com"],"query":[],"variable":[]}},"response":[{"id":"667cc395-1b4d-4814-8464-7fa5721a02c3","name":"Get users","originalRequest":{"method":"GET","header":[],"url":"https://test-management.testsigma.com/api/v1/test_runs/statuses"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d4c24ee5-da10-4f8e-9afa-93c4c0cd4084"}],"id":"36004939-7fb1-4351-a37d-e7f0af560475","_postman_id":"36004939-7fb1-4351-a37d-e7f0af560475","description":""}],"event":[{"listen":"prerequest","script":{"id":"c1078b0f-c77e-424d-90dd-5222da2cf43d","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"159c382f-56ba-4d39-878b-e66f211c0a4c","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"TMS_API_KEY","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJUTVMiLCJzdWIiOiIyNTQxOGY3ZS01YTVhLTQ5NTAtODA1Zi1hZTRlOGY3M2JhYmQiLCJuYmYiOjE3NjAzNDUyMzksImlhdCI6MTc2MDM0NTIzOSwiaWRfc2Vzc2lvbl9yZV92YWxpZGF0ZSI6MH0.DrhD4owPPvH8DUnQ6-QZhbGRB6MidXPOCRFiOWfHWSE"},{"key":"Project_ID","value":"c47ade67-0543-4582-a4a5-b7de447c94f5"},{"key":"TMS","value":"https://test-management.testsigma.com"}]}