{ "swagger" : "2.0", "info" : { "version" : "1.2", "title" : "QMP" }, "host" : "localhost:8080", "tags" : [ { "name" : "Admin" }, { "name" : "Attachment" }, { "name" : "Datagrid" }, { "name" : "Execution" }, { "name" : "Import" }, { "name" : "Integration" }, { "name" : "Issue" }, { "name" : "Login" }, { "name" : "Parameter" }, { "name" : "Reporting" }, { "name" : "Requirement" }, { "name" : "Search" }, { "name" : "TestCase" }, { "name" : "TestSuites" } ], "schemes" : [ "http" ], "paths" : { "/rest/admin/accesslog/list" : { "post" : { "tags" : [ "Admin" ], "summary" : "List Audit Log of the System.", "description" : "", "operationId" : "listAuditTrail", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "fromDate", "description" : "Date from which Audit Log is to be fetched", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "toDate", "description" : "Date till which Audit Log is to be fetched", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Audit Log list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/agent/read" : { "post" : { "tags" : [ "Admin" ], "summary" : "Get Agents", "description" : "API to fetch agents", "operationId" : "readAgentDetails", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "List of agents fetched successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/customlist/add" : { "post" : { "tags" : [ "Admin" ], "summary" : "Add custom list", "description" : "API to add custom list", "operationId" : "addCustomList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "listValue", "description" : "ListValues to add", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/ListValue" } } }, { "in" : "body", "name" : "Listname", "description" : "Name of list", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Customlist added successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/customlist/delete" : { "post" : { "tags" : [ "Admin" ], "summary" : "Delete Custom-list", "description" : "", "operationId" : "deleteCustomList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "listId", "description" : "Unique identifier of Custom-list", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Custom-list successfully deleted", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/customlist/list" : { "post" : { "tags" : [ "Admin" ], "summary" : "List of custom lists and dropdowns", "description" : "API to list custom lists and dropdowns", "operationId" : "getCustomList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "List of system defined and user defined components", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/customlist/listval" : { "post" : { "tags" : [ "Admin" ], "summary" : "List custom list values", "description" : "API to list custom list values", "operationId" : "getCustomListVal", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "qmMasterId", "description" : "ID of custom list whose list values are to be obtained", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "params", "description" : "Parameters", "required" : false, "schema" : { "$ref" : "#/definitions/Param2" } }, { "in" : "body", "name" : "projectID", "description" : "ID of project for which possible list values to be obtained", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "List of all the values of the custom list", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/customlist/update" : { "post" : { "tags" : [ "Admin" ], "summary" : "Update/Add custom list", "description" : "API to update/add custom list", "operationId" : "updateCustomList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "listId", "description" : "Unique identifier of list which is to be updated", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "listValueDeleted", "description" : "Provide listValues to be deleted", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/ListValue" } } }, { "in" : "body", "name" : "listValue", "description" : "ListValues", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/ListValue" } } } ], "responses" : { "200" : { "description" : "Custom list updated", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/cycle" : { "post" : { "tags" : [ "Admin" ], "summary" : "Create cycle", "description" : "API to add cycle", "operationId" : "addCycle", "consumes" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "cycle", "description" : "provide cycle", "required" : true, "schema" : { "$ref" : "#/definitions/CycleParams" } } ], "responses" : { "200" : { "description" : "Cycle created successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } }, "put" : { "tags" : [ "Admin" ], "summary" : "Update Cycle", "description" : "", "operationId" : "editCycle", "consumes" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "cycle", "description" : "check CycleParams", "required" : true, "schema" : { "$ref" : "#/definitions/CycleParams" } } ], "responses" : { "200" : { "description" : "Cycle updated successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/cycle/archive" : { "put" : { "tags" : [ "Admin" ], "summary" : "Archive cycle", "description" : "API to archive cycle of release in the project", "operationId" : "archiveCycle", "consumes" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "buildID", "description" : "Id of cycle to archive", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } }, { "in" : "body", "name" : "releaseID", "description" : "Id of release to which the cycle belongs", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Cycle successfully archived", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/cycle/delete" : { "post" : { "tags" : [ "Admin" ], "summary" : "Delete cycle", "description" : "API to delete cycle", "operationId" : "deleteCycle", "consumes" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "buildID", "description" : "Id of cycle to delete", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "Cycle successfully deleted", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/cycle/list" : { "post" : { "tags" : [ "Admin" ], "summary" : "List of cycles", "description" : "API to list of cycles", "operationId" : "listCycle", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "params", "description" : "Parameters", "required" : true, "schema" : { "$ref" : "#/definitions/Param1" } } ], "responses" : { "200" : { "description" : "List of cycles shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/cycle/unarchive" : { "put" : { "tags" : [ "Admin" ], "summary" : "Unarchive cycle", "description" : "API to unarchive cycle of release in the project", "operationId" : "unarchiveCycle", "consumes" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "buildID", "description" : "Id of cycle to unarchive", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } }, { "in" : "body", "name" : "releaseID", "description" : "Id of Release to which the cycle belongs", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Cycle successfully unarchived", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/drop/archive" : { "put" : { "tags" : [ "Admin" ], "summary" : "Archive Builds", "description" : "", "operationId" : "archiveDrop", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "dropIds", "description" : "Id of builds to archive", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "Builds archived successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/drop/list" : { "post" : { "tags" : [ "Admin" ], "summary" : "List of build", "description" : "List of all builds in the project", "operationId" : "getListDrops", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "showArchive", "description" : "Send 'true' to display archived Builds as well", "required" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "List of build", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/drop/read" : { "post" : { "tags" : [ "Admin" ], "summary" : "Get details of a particular build", "description" : "", "operationId" : "getDropInfo", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "jsonbody", "description" : "Unique identifier of build to get its details", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "id", "description" : "Unique identifier of build to get its details", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Details of build shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/drop/unarchive" : { "put" : { "tags" : [ "Admin" ], "summary" : "Unarchive build", "description" : "", "operationId" : "unarchiveDrop", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "dropIds", "description" : "Id of builds to unarchive", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "Builds unarchived successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/drops" : { "post" : { "tags" : [ "Admin" ], "summary" : "Create build", "description" : "API to create build", "operationId" : "addDrop", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "dropID", "description" : "Send '0' to create drop", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "name", "description" : "Name of Build", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "Description", "description" : "Description of Build", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "grdRelCyc", "description" : "Add Release Cycle to the Build", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/GrdRelCyc" } } } ], "responses" : { "200" : { "description" : "Build created successfully.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/execution/list" : { "post" : { "tags" : [ "Admin" ], "summary" : "List of execution statuses", "description" : "API to list execution statuses", "operationId" : "listStatus", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "roleID", "description" : "Id of role to get execution statuses specific to that role", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "isArchived", "description" : "Send 'true' to show archived platforms (defaulted to false)", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "sort", "description" : "Sort parameters", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Sort" } } } ], "responses" : { "200" : { "description" : "list of execution statuses shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/getAllRights" : { "get" : { "tags" : [ "Admin" ], "summary" : "Rights Structure", "description" : "Rights Structure for Role", "operationId" : "getAllRights", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "usertoken", "in" : "header", "description" : "usertoken", "required" : true, "type" : "string", "default" : "" }, { "name" : "orgCode", "in" : "header", "description" : "orgCode", "required" : true, "type" : "string", "default" : "" }, { "name" : "scope", "in" : "header", "description" : "scope", "required" : true, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "Successful operation.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "500" : { "description" : "Returned if there is an error in server" } } } }, "/rest/admin/managefield/list" : { "post" : { "tags" : [ "Admin" ], "summary" : "List of fields", "description" : "API to give list of fields", "operationId" : "getManageFieldList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "isSystemFieldRequired", "description" : "Send True to get System fields and false to get User fields. Defaulted to false", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "List of fields successfully created", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/platform" : { "post" : { "tags" : [ "Admin" ], "summary" : "Create platform", "description" : "API to create platform", "operationId" : "addPlatform", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "name", "description" : "Name of Platform", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "platformID", "description" : "Send '0' to create a new Platform", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "platformType", "description" : "Send 'single' to add new Platform", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Platform created successfully.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/platform/list" : { "post" : { "tags" : [ "Admin" ], "summary" : "List of platforms", "description" : "API to list platforms", "operationId" : "listPlatform", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sort", "description" : "Sort parameters", "required" : false, "schema" : { "$ref" : "#/definitions/Sort" } } ], "responses" : { "200" : { "description" : "List of platforms shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/project" : { "post" : { "tags" : [ "Admin" ], "summary" : "Create project", "description" : "API to create project", "operationId" : "addProject", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "project", "description" : "Check project parameters", "required" : true, "schema" : { "$ref" : "#/definitions/ProjectParameters" } }, { "in" : "body", "name" : "release", "description" : "Check release parameters", "required" : true, "schema" : { "$ref" : "#/definitions/ReleaseParams" } }, { "in" : "body", "name" : "cycle", "description" : "Check cycle parameters", "required" : true, "schema" : { "$ref" : "#/definitions/Cycle" } }, { "in" : "body", "name" : "addLdapUser", "description" : "Set true to allow addition of LDAP users in the project", "required" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Project successfully added", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/project/archive" : { "put" : { "tags" : [ "Admin" ], "summary" : "Archive project", "description" : "API to archive project", "operationId" : "archiveProject", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "projectID", "description" : "Unique identifier of projects to archive", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } }, { "name" : "apiKey", "in" : "header", "description" : "apiKey", "required" : true, "type" : "string", "default" : "" }, { "name" : "scope", "in" : "header", "description" : "scope", "required" : true, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "Project successfully archived", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/project/clone" : { "post" : { "tags" : [ "Admin" ], "summary" : "Clone project", "description" : "API to clone project", "operationId" : "cloneProject", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "Projectkey", "description" : "The unique project key of new project", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "clone", "description" : "Type of clone:- 0 - to clone only the folder structure, along with any releases and cycles & 1 - to clone Project meta-data, Requirements, Test Cases, Test Suites and Issues", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "name", "description" : "Name of the project to be cloned", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "newProject", "description" : "Name of the new project", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "projectID", "description" : "The unique identifier by which to identify the cloned project", "required" : true, "schema" : { "type" : "string" } }, { "name" : "apiKey", "in" : "header", "description" : "apiKey", "required" : true, "type" : "string", "default" : "" }, { "name" : "scope", "in" : "header", "description" : "scope", "required" : true, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "Project clone initiated", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/project/delete" : { "put" : { "tags" : [ "Admin" ], "summary" : "Delete project", "description" : "API to delete project", "operationId" : "deleteProject", "consumes" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "projectID", "description" : "Unique identifier of project to delete", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "apiKey", "in" : "header", "description" : "apiKey", "required" : true, "type" : "string", "default" : "" }, { "name" : "scope", "in" : "header", "description" : "scope", "required" : true, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "Project deletion has been initialised", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/project/getinfo" : { "get" : { "tags" : [ "Admin" ], "summary" : "Get Info service", "description" : "provides all the basic information of the project like scope, types of -bugs, license details", "operationId" : "getInfo", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "usertoken", "in" : "header", "description" : "usertoken", "required" : true, "type" : "string", "default" : "" }, { "name" : "orgCode", "in" : "header", "description" : "orgCode", "required" : true, "type" : "string", "default" : "" }, { "name" : "scope", "in" : "header", "description" : "scope", "required" : true, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "Successful operation.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Returned if no project exists or project/release/cycle is archived" }, "500" : { "description" : "Returned if there is an error in server" } } } }, "/rest/admin/project/list" : { "post" : { "tags" : [ "Admin" ], "summary" : "list of projects", "description" : "API to list all projects", "operationId" : "listProject", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "params", "description" : "Parameters", "required" : true, "schema" : { "$ref" : "#/definitions/Param2" } } ], "responses" : { "200" : { "description" : "List of projects shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/project/unarchive" : { "put" : { "tags" : [ "Admin" ], "summary" : "Unarchive project", "description" : "API to unarchive project", "operationId" : "unarchiveProject", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "projectID", "description" : "Unique identifier of projects to unarchive", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } }, { "name" : "apiKey", "in" : "header", "description" : "apiKey", "required" : true, "type" : "string", "default" : "" }, { "name" : "scope", "in" : "header", "description" : "scope", "required" : true, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "Project successfully unarchived", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/release" : { "post" : { "tags" : [ "Admin" ], "summary" : "Create Release", "description" : "API to create release", "operationId" : "addRelease", "consumes" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "releaseParams", "description" : "Release Parameters", "required" : true, "schema" : { "$ref" : "#/definitions/Release" } }, { "in" : "body", "name" : "cycle", "description" : "Cycle Parameters", "required" : true, "schema" : { "$ref" : "#/definitions/Cycle" } } ], "responses" : { "200" : { "description" : "Release created successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/release/archive" : { "put" : { "tags" : [ "Admin" ], "summary" : "Archive release", "description" : "API to archive release of the project", "operationId" : "archiveRelease", "consumes" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "releaseID", "description" : "Id of release to archive", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } }, { "in" : "body", "name" : "projectID", "description" : "Id of project to which the release belongs", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Release successfully archived", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/release/delete" : { "post" : { "tags" : [ "Admin" ], "summary" : "Delete release", "description" : "API to delete release of the project", "operationId" : "deleteRelease", "consumes" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "releaseID", "description" : "Id of release to delete", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "Release successfully deleted", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/release/list" : { "post" : { "tags" : [ "Admin" ], "summary" : "List of releases", "description" : "API to list all releases", "operationId" : "listRelease", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "params", "description" : "Parameters", "required" : true, "schema" : { "$ref" : "#/definitions/Param4" } }, { "in" : "body", "name" : "sort", "description" : "Sort Parameters", "required" : true, "schema" : { "$ref" : "#/definitions/Sort" } } ], "responses" : { "200" : { "description" : "List of releases shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/release/unarchive" : { "put" : { "tags" : [ "Admin" ], "summary" : "Unarchive release", "description" : "API to unarchive release of the project", "operationId" : "unarchiveRelease", "consumes" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "releaseID", "description" : "Id of release to unarchive", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } }, { "in" : "body", "name" : "projectID", "description" : "Id of project to which the release belongs", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Release successfully unarchived", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/role/list" : { "post" : { "tags" : [ "Admin" ], "summary" : "List of roles", "description" : "API to show list of roles", "operationId" : "getRole", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "List of roles shown successfully.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/scope/tree" : { "post" : { "tags" : [ "Admin" ], "summary" : "To get list of available Releases and Cycles and their metadata", "description" : "", "operationId" : "scopeTree", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "currentProjectFlag", "description" : "Send true when project whose releases meta-data is to be fetched is same as the project in context", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "showArchive", "description" : "Send false to get only unarchived Releases, defaulted to false", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "qmProjectID", "description" : "Unique identifier of project whose data is to be obtained", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Release meta-data fetched successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/user/deactivate" : { "put" : { "tags" : [ "Admin" ], "summary" : "Deactivate user", "description" : "API to deactivate user", "operationId" : "deActivateUser", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "userID", "description" : "Unique identifier of user to be deactivated", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "isActive", "description" : "Send 'false' to deactivate user", "required" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "User deactivated successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/user/delete" : { "put" : { "tags" : [ "Admin" ], "summary" : "Delete user", "description" : "API to delete user", "operationId" : "deleteUser", "consumes" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "userID", "description" : "Unique identifier of user to delete", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "User deleted successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/user/generateAutomationAPIKey" : { "post" : { "tags" : [ "Admin" ], "summary" : "Generate automation api key", "description" : "API to generate automation api key", "operationId" : "generateAutomationAPIKey", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ResponseEntity" } } } } }, "/rest/admin/user/list" : { "post" : { "tags" : [ "Admin" ], "summary" : "List of users", "description" : "API to show list of users", "operationId" : "getUsers", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "provide start", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "limit", "description" : "provide limit", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "page", "description" : "provide page", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "List of users", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing or export operation failed." }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/user/update/withrole" : { "put" : { "tags" : [ "Admin" ], "summary" : "Update a user", "description" : "API to update existing user", "operationId" : "updateUserWithRole", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "user", "description" : "Object of user to be updated", "required" : true, "schema" : { "$ref" : "#/definitions/UpdateUser" } }, { "in" : "body", "name" : "maprole", "description" : "Object of maprole having details of project roles to be assigned while updating user", "required" : true, "schema" : { "$ref" : "#/definitions/MapRole" } } ], "responses" : { "200" : { "description" : "User updated successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/admin/user/withrole" : { "post" : { "tags" : [ "Admin" ], "summary" : "Create a user", "description" : "API to create new user", "operationId" : "CreateUserWithRole", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "user", "description" : "Object of user to be created", "required" : true, "schema" : { "$ref" : "#/definitions/User" } }, { "in" : "body", "name" : "maprole", "description" : "Object of maprole having details of project roles to be assigned while creating user", "required" : true, "schema" : { "$ref" : "#/definitions/MapRole" } } ], "responses" : { "200" : { "description" : "User created successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/attachments" : { "post" : { "tags" : [ "Attachment" ], "summary" : "Upload attachment", "description" : "API to upload attachment", "operationId" : "addAttachments", "produces" : [ "application/json" ], "parameters" : [ { "name" : "file[]", "in" : "formData", "description" : "file to upload", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "Attachment added successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/attachments/link" : { "post" : { "tags" : [ "Attachment" ], "summary" : "Link attachment to entity", "description" : "API to link attachment to entity", "operationId" : "link", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "Unique Identifier of Entity", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "attachmentIds", "description" : "Id of attachments to upload", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "entityType", "description" : "Abbreviated EntityType", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Attachment(s) linked successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/attachments/list" : { "post" : { "tags" : [ "Attachment" ], "summary" : "List of linked attachments", "description" : "API to list attachments linked with an entity", "operationId" : "listAttachments", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "entity ID", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "entityType", "description" : "entityType", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Linked attachments shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/attachments/reference" : { "post" : { "tags" : [ "Attachment" ], "summary" : "Attach URL", "description" : "API to attach URL", "operationId" : "addAttachmentsReference", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "url", "description" : "provide url", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "description", "description" : "provide description", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "URL attached successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/attachments/testLog" : { "post" : { "tags" : [ "Attachment" ], "summary" : "Upload testlog to tcrun", "description" : "API to upload testlog to tcrun", "operationId" : "addTestLog", "produces" : [ "application/json" ], "parameters" : [ { "name" : "entityId", "in" : "formData", "description" : "entityId", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "type", "in" : "formData", "description" : "type", "required" : true, "type" : "string" }, { "name" : "file[]", "in" : "formData", "description" : "file to upload", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "Testlog upload successfull", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid file type or file size exceeds the limit" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/attachments/unlink" : { "post" : { "tags" : [ "Attachment" ], "summary" : "Unlink Attachment", "description" : "API to unlink attachment", "operationId" : "unlink", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "Unique Identifier of Entity", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "attachmentIds", "description" : "Id of attachments to upload", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "entityType", "description" : "Abbreviated EntityType", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Attachment(s) unlinked successfully.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/attachments/{id}" : { "get" : { "tags" : [ "Attachment" ], "summary" : "Download attachment", "description" : "API to download attachment", "operationId" : "downLoadAttachments", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Attachment downloaded successfully" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/datagrid/archive" : { "put" : { "tags" : [ "Datagrid" ], "summary" : "Archive DataGrid", "description" : "API to Archive DataGrid", "operationId" : "archiveDataGrid", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "dataGridIDs", "description" : "DataGrid Ids for Archive", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "DataGrid archived successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/datagrid/autofill" : { "post" : { "tags" : [ "Datagrid" ], "summary" : "Autofill DataGrid", "description" : "API to Autofill DataGrid", "operationId" : "autofillDataGrid", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "Parameter Ids", "description" : "Parameter Ids to Autofill", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } }, { "name" : "rows", "in" : "query", "description" : "Number of Rows to Autofill", "required" : false, "type" : "integer", "format" : "int64" }, { "name" : "isRandom", "in" : "query", "description" : "Flag to fill Randomly", "required" : false, "type" : "boolean", "default" : false }, { "name" : "isSequential", "in" : "query", "description" : "Flag to fill sequentially", "required" : false, "type" : "boolean", "default" : false } ], "responses" : { "200" : { "description" : "DataGrid Autofilled successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/datagrid/create" : { "post" : { "tags" : [ "Datagrid" ], "summary" : "Create DataGrid", "description" : "API to Create DataGrid", "operationId" : "createDatagrid", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "DataGridModel", "description" : "DataGridModel to Create DataGrid", "required" : true, "schema" : { "$ref" : "#/definitions/DataGridModel" } } ], "responses" : { "200" : { "description" : "DataGrid Created Successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/datagrid/delete" : { "delete" : { "tags" : [ "Datagrid" ], "summary" : "delete DataGrid", "description" : "API to delete DataGrid", "operationId" : "deleteDataGrid", "produces" : [ "application/json" ], "parameters" : [ { "name" : "dataGridID", "in" : "query", "description" : "DataGridID for deletion", "required" : true, "type" : "integer", "format" : "int64" } ], "responses" : { "200" : { "description" : "DataGrid delete successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/datagrid/getById" : { "get" : { "tags" : [ "Datagrid" ], "summary" : "get DataGrid", "description" : "API to get DataGrid", "operationId" : "getDataGridByID", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "dataGridID", "in" : "query", "description" : "DataGridID to get DataGrid", "required" : true, "type" : "integer", "format" : "int64" } ], "responses" : { "200" : { "description" : "DataGrid shown successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/datagrid/getIDList" : { "post" : { "tags" : [ "Datagrid" ], "summary" : "Get Data Grid Ids for bulk opration", "description" : "API to get DataGrid IDs List", "operationId" : "getDataGridIDList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "filters", "description" : "for filtering List of DataGrid Ids", "required" : true, "schema" : { "$ref" : "#/definitions/BaseRequest" } } ], "responses" : { "200" : { "description" : "DataGrids shown successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/datagrid/getList" : { "post" : { "tags" : [ "Datagrid" ], "summary" : "get List Of DataGrid", "description" : "API to get List Of DataGrid", "operationId" : "getDataGridList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "filters", "description" : "Filter the DataGrid List", "required" : true, "schema" : { "$ref" : "#/definitions/BaseRequest" } } ], "responses" : { "200" : { "description" : "DataGrids shown successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/datagrid/save" : { "put" : { "tags" : [ "Datagrid" ], "summary" : "Save DataGrid", "description" : "API to Save DataGrid", "operationId" : "saveDataGrid", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "DataGridUpdateRequest", "description" : "List of DataGridUpdateRequest to Save", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/DatagridUpdateRequest" } } } ], "responses" : { "200" : { "description" : "DataGrid saved successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/datagrid/unarchive" : { "put" : { "tags" : [ "Datagrid" ], "summary" : "UnArchive DataGrid", "description" : "API to UnArchive DataGrid", "operationId" : "unArchiveDataGrid", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "dataGridIds", "description" : "DataGrid Ids for UnArchive", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "DataGrid unarchived successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/datagrid/update" : { "put" : { "tags" : [ "Datagrid" ], "summary" : "Update DataGrid", "description" : "API to Update DataGrid", "operationId" : "updateDataGrid", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "DataGridUpdateRequest", "description" : "Request to update the DataGrid", "required" : true, "schema" : { "$ref" : "#/definitions/DatagridUpdateRequest" } } ], "responses" : { "200" : { "description" : "DataGrid updated successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/getExecutionsForIssue" : { "post" : { "tags" : [ "Execution" ], "summary" : "Fetch Executions List", "description" : "Execution list getting based on particular id of defect.", "operationId" : "getTestCasesUIColumns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Execution list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/issue/list" : { "post" : { "tags" : [ "Execution" ], "summary" : "List of issues linked to a particular execution", "description" : "API to list issues linked to a particular execution", "operationId" : "getLinkedIssues", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "TestcaseRunId or TestcaseStepRunId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "istcsrFlag", "description" : "True for Testcase Step Run, false when otherwise", "required" : true, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "istcrFlag", "description" : "True for Testcase Run, false when otherwise", "required" : true, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Issues of particular execution shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/issue/list/forTCRun" : { "post" : { "tags" : [ "Execution" ], "summary" : "List of issues to a particular execution", "description" : "API to list issues linked to a particular execution", "operationId" : "getIssueListForTestCase", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "TestcaseRunId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "getLinked", "description" : "True for get linked testcase otherwise false", "required" : true, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "getColumns", "description" : "True for get default filtered column list", "required" : true, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Issues of particular execution shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/issue/list/forTCStepRun" : { "post" : { "tags" : [ "Execution" ], "summary" : "List of issues to a particular execution", "description" : "API to list issues linked to a particular execution", "operationId" : "getIssueListForTestCaseSteps", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "TestcaseStepRunId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "getLinked", "description" : "True for get linked testcase otherwise false", "required" : true, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "getColumns", "description" : "True for get default filtered column list", "required" : true, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Issues of particular execution shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/link/issue" : { "put" : { "tags" : [ "Execution" ], "summary" : "Link issues to the testcase being executed", "description" : "API to link issues to the testcase being executed", "operationId" : "linkIssue", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "issueIds", "description" : "ID of issues to be linked to Testcase Run", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "body", "name" : "tcrId", "description" : "ID of Testcase Run to link issues with", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Issues successfully linked to execution", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/link/issueWithTCStepRun" : { "put" : { "tags" : [ "Execution" ], "summary" : "Link issues to the testcase step run being executed", "description" : "API to link issues to the testcase step run being executed", "operationId" : "linkIssueWithTCStepRun", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "issueIds", "description" : "Ids of issues to link", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "body", "name" : "tcsrId", "description" : "Id of Testcase Step to link issues with", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Issues successfully linked to execution", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/list/platformHome" : { "post" : { "tags" : [ "Execution" ], "summary" : "", "description" : "", "operationId" : "getPlatformHome", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tsFolderID", "description" : "Testsuite FolderID", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "tsID", "description" : "ID of Testsuite", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "entityIdsForBulk", "description" : "Send true for getting TsRunID for Bulk Operation", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/list/tcr" : { "post" : { "tags" : [ "Execution" ], "summary" : "Get Testcase Run IDs", "description" : "", "operationId" : "getTestCaseRun", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tsrID", "description" : "ID of Testsuite Run whose Testcase Runs are to be obtained", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "filter", "description" : "Add filter to get filtered Testcase Runs", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } }, { "in" : "body", "name" : "showTcWithDefects", "description" : "True to get only those Testcase Runs which have Defects linked with them", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Successfully fetched Testcase Runs", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/list/tcsr" : { "post" : { "tags" : [ "Execution" ], "summary" : "List Testcase Step Run", "description" : "", "operationId" : "getTestCaseStepRun", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcrID", "description" : "Unique identifier of Testcase Run whose Testcase Step Runs are to be fetched", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "List of Testcase Step Runs fetched successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } }, "deprecated" : true } }, "/rest/execution/resetstatus" : { "put" : { "tags" : [ "Execution" ], "summary" : "Reset execution status", "description" : "API to reset execution status after changing build", "operationId" : "resetstatus", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "qmTsRunId", "description" : "Testsuite Run Id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "dropID", "description" : "buildId on which testcases and testcase steps are to be executed", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "isBulkStausSetNotNotRun", "description" : "send true to reset status to 'Not Run'", "required" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Execution status reset successfully.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/runstatus/bulkupdate" : { "put" : { "tags" : [ "Execution" ], "summary" : "Bulkupdate Run status", "description" : "API to bulkupdate run status", "operationId" : "updateBulkRunStatus", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "runStatusID", "description" : "Id of the execution status to set(Id can be obtained from getInfo service response)", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "dropID", "description" : "Unique identifier of drop on which execution is to be performed", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "qmTsRunId", "description" : "Id of Testsuite Run to execute", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "entityIDs", "description" : "Ids of Testcase Runs to execute", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "entityType", "description" : "Type of Entity('TCR'/'TCSR') to Execute", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Execution performed successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/tcStepRun/list/viewColumns" : { "post" : { "tags" : [ "Execution" ], "summary" : "List Testcase Step Run", "description" : "", "operationId" : "getViewColumnsForTestCaseStep", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcrID", "description" : "Unique identifier of Testcase Run whose Testcase Step Runs are to be fetched", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "viewId", "description" : "View ID of the user for that particular project and Testcase Step Run module", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "List of Testcase Step Runs fetched successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/unlink/issue" : { "post" : { "tags" : [ "Execution" ], "summary" : "Unlink issues from Testcase Run being executed", "description" : "API to unlink issues from the Testcase Run being executed", "operationId" : "unlinkIssue", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "issueIds", "description" : "Ids of Issues to be unlinked", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "body", "name" : "tcrId", "description" : "Id of Testcase Run to unlink issues from", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Issues successfully unlinked from Testcase Run", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/unlink/issueWithTCStepRun" : { "post" : { "tags" : [ "Execution" ], "summary" : "Unlink issues to the testcase step run being executed", "description" : "API to unlink issues to the testcase step run being executed", "operationId" : "unlinkIssueWithTCStepRun", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "issueIds", "description" : "Ids of issues to unlink", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "tcsrId", "description" : "Id of Testcase Step to unlink issues from", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Issues successfully unlinked from execution", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/execution/updaterun" : { "put" : { "tags" : [ "Execution" ], "summary" : "Update Run comment", "description" : "API to update run comment", "operationId" : "updateRun", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "type", "description" : "Abbreviated entity type(Possible Values are TCR,TCSR)", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "fieldVal", "description" : "Value of field", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "isAutoExecuted", "description" : "True if it is to be automatically executed and false if otherwise", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "entityId", "description" : "Unique identifier of Testcase Run(entityId is either of TcRunID or TcsRunID)", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "field", "description" : "Field which is to be updated", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Run Status updated successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/import/createandscheduletestresults/{headerRow}" : { "post" : { "tags" : [ "Import" ], "summary" : "Automation API", "description" : "API to create Test Suites through Automation", "operationId" : "addAttachmentAndImport", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "scope", "in" : "header", "description" : "scope", "required" : true, "type" : "string", "default" : "" }, { "name" : "apikey", "in" : "header", "description" : "Generated Automation API key", "required" : true, "type" : "string", "default" : "" }, { "name" : "headerRow", "in" : "path", "description" : "Default value is 1", "required" : true, "type" : "string" }, { "name" : "file", "in" : "formData", "description" : "Your result file to be uploaded. Supported file extensions: .json, .xml and .zip (zip file must contain files of the format given in the 'entityType' param", "required" : true, "type" : "string" }, { "name" : "entityType", "in" : "formData", "description" : "Format of result file to be imported. Supported formats:TESTNG or CUCUMBER or JUNIT or HPUFT or QAF", "required" : true, "type" : "string" }, { "name" : "cycleID", "in" : "formData", "description" : "Target Cycle Id or Cycle Name. Cycle Id can be fetched using List Cycle API and Cycle Name can be obtained from detail view of target Cycle.", "required" : false, "type" : "string" }, { "name" : "platformID", "in" : "formData", "description" : "Target Platform Id or Platform Name. Platform Id can be fetched using List Platform API and Platform Name can be obtained from detail view of target Platform.", "required" : false, "type" : "string" }, { "name" : "testsuiteId", "in" : "formData", "description" : "Target Test Suite ID or Entity Key. Testsuite id can be fetched using List Testsuite API and the Entity Key can be obtained from detail view of target Test Suite.", "required" : false, "type" : "string" }, { "name" : "projectID", "in" : "formData", "description" : "Target Project ID or project Key or project name. Project id can be fetched using List Poroject API and the Entity Key or name can be obtained from list view of target Project.", "required" : false, "type" : "string" }, { "name" : "releaseID", "in" : "formData", "description" : "Target Release ID or Release name. Release id can be fetched using List Release API from list detail of target Project.", "required" : false, "type" : "string" }, { "name" : "buildID", "in" : "formData", "description" : "Target Build ID or Build name. Build id can be fetched using List Build API from list detail of target Project.", "required" : false, "type" : "string" }, { "name" : "automationHierarchy", "in" : "formData", "description" : "For JUnit & TestNG framework option to select the Hierarchy", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "Test Suites created successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/issues" : { "post" : { "tags" : [ "Issue" ], "summary" : "Create Issue", "description" : "API to create internal Issue", "operationId" : "addIssue", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "issueType", "description" : "Type Id of Issue", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "issuePriority", "description" : "PriorityId of Issue", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "issueOwner", "description" : "OwnerId of Issue", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "summary", "description" : "provide summary", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "component", "description" : "LabelId of Issue", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "release", "description" : "Associated Release(s) Id", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "affectedVersion", "description" : "Release Id of Issue", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "environment", "description" : "Environment", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "description", "description" : "Description", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Issue created successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } }, "put" : { "tags" : [ "Issue" ], "summary" : "Update Issue", "description" : "API to update internal Issue", "operationId" : "editIssue", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "issueType", "description" : "Type Id of Issue", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "issuePriority", "description" : "PriorityId of Issue", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "issueOwner", "description" : "OwnerId of Issue", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "summary", "description" : "provide summary", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "component", "description" : "LabelId of Issue", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "release", "description" : "Associated Release(s) Id", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "affectedVersion", "description" : "Release Id of Issue", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "environment", "description" : "Environment", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "description", "description" : "Description", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "DefectId", "description" : "Id of Issue", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "entityKey", "description" : "EntityKey of Issue", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Issue updated successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/issues/deleteEntity" : { "post" : { "tags" : [ "Issue" ], "summary" : "Delete Issue", "description" : "", "operationId" : "deleteEntity", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityIds", "description" : "Id of issues to delete", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "Issues deleted successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/issues/getForTCRun" : { "post" : { "tags" : [ "Issue" ], "summary" : "Fetch available issues for TC Run.", "description" : "", "operationId" : "getAvailableDfForTCRun", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcRunID", "description" : "Id of Testcase Run", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "List of issues.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } }, "deprecated" : true } }, "/rest/issues/getForTCStepRun" : { "post" : { "tags" : [ "Issue" ], "summary" : "Fetch available issues for TC Step Run.", "description" : "", "operationId" : "getAvailableDfForTCStepRun", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcStepRunID", "description" : "Id of Testcase-Step Run", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "List of issues.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } }, "deprecated" : true } }, "/rest/issues/getIssuesForTestCase" : { "post" : { "tags" : [ "Issue" ], "summary" : "list of issues", "description" : "API to list issues for Test Case.", "operationId" : "getIssuesForTestCase", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "List of issues shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/issues/internallist" : { "post" : { "tags" : [ "Issue" ], "summary" : "To get list of Issues available to link to an execution", "description" : "", "operationId" : "internallist", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "List of issues to link to execution successfully fetched", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } }, "deprecated" : true } }, "/rest/issues/link/requirements" : { "put" : { "tags" : [ "Issue" ], "summary" : "Link requirements to issue", "description" : "", "operationId" : "linkRequirements", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "isID", "description" : "EntityKey of Issue", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "rqIDs", "description" : "ID of Requirements to link with the Issue", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "Requirements successfully linked to issue", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/issues/list" : { "post" : { "tags" : [ "Issue" ], "summary" : "list of issues", "description" : "API to list issues", "operationId" : "listv", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "List of issues shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/issues/list/ForRQ" : { "post" : { "tags" : [ "Issue" ], "summary" : "list of issues", "description" : "API to list issues", "operationId" : "listForRQ", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "getColumns", "description" : "True to get list of all available filters(System + UDF) in 'filterTemplate' field", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "udfFilter", "description" : "Apply filter on user defined fields' values", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/UdfFilter" } } }, { "in" : "body", "name" : "getLinked", "description" : "True to get only those issues that are linked with this Requirement, false to get those issues which are not linked with this Requirement", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "rqID", "description" : "Id of Requirement", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "filter", "description" : "System filters to be applied", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } } ], "responses" : { "200" : { "description" : "List of issues shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/issues/list/viewColumns" : { "post" : { "tags" : [ "Issue" ], "summary" : "Fetch list of Issues", "description" : "Fetch specific data of Issues", "operationId" : "getViewColumns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "viewId", "description" : "View ID of the user for that particular project and Issue module", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Issue list fetched successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/issues/unlink/requirements" : { "put" : { "tags" : [ "Issue" ], "summary" : "To unlink Requirements from Issues", "description" : "", "operationId" : "unLinkRequirements", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "isID", "description" : "EntityKey of Issue to unlink Requirements from", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "rqIDs", "description" : "Unique identifier of Requirements that are to be unlinked from Issue", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "Selected entities unlinked successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/login" : { "post" : { "tags" : [ "Login" ], "summary" : "Login credentials", "description" : "Returns user-token and refresh-token on successful login", "operationId" : "login", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "username", "in" : "path", "description" : "Username of User", "required" : true, "type" : "string" }, { "name" : "password", "in" : "path", "description" : "Password of User", "required" : true, "type" : "string" }, { "name" : "orgCode", "in" : "path", "description" : "Organisation Code", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "Successful operation.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "500" : { "description" : "Returned if there is an error in server" } } } }, "/rest/parameter" : { "post" : { "tags" : [ "Parameter" ], "summary" : "Add New parameters", "description" : "API to Add New Parameters", "operationId" : "addParameter", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "ParameterRequest", "description" : "ParameterRequest for Add parameters", "required" : true, "schema" : { "$ref" : "#/definitions/ParameterRequest" } } ], "responses" : { "200" : { "description" : "New Parameters added successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/parameter/archive" : { "post" : { "tags" : [ "Parameter" ], "summary" : "Archive parameters", "description" : "API to Archive list of Parameters", "operationId" : "archiveParameter", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "Ids", "description" : "parameter Ids list", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "List of Parameters Archived successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/parameter/delete/{paramID}" : { "put" : { "tags" : [ "Parameter" ], "summary" : "Delete values", "description" : "API to delete value", "operationId" : "deleteParam", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "Parameter id", "description" : "parameter Ids as query path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Update parameter values", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/parameter/deleteValue/{parameterValueID}" : { "put" : { "tags" : [ "Parameter" ], "summary" : "Delete values", "description" : "API to delete parameter value", "operationId" : "deleteValue", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "parameterValueID", "description" : "parameterValueID as query path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Update parameter values", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/parameter/list" : { "post" : { "tags" : [ "Parameter" ], "summary" : "List Parameter(s) of given project", "description" : "API to list Parameter(s) of given project", "operationId" : "getParameters", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "ParameterRequest", "description" : "ParameterRequest for getting list of parameters", "required" : true, "schema" : { "$ref" : "#/definitions/ParameterRequest" } } ], "responses" : { "200" : { "description" : "List of Parameters shown successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/parameter/project/modify" : { "get" : { "tags" : [ "Parameter" ], "summary" : "List Projects of modify Test Data Parameterization right", "description" : "API to list Projects of modify Test Data Parameterization right", "operationId" : "getProjectFromRightsModify", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "responses" : { "200" : { "description" : "List of Projects For Specific Rights", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/parameter/project/view" : { "get" : { "tags" : [ "Parameter" ], "summary" : "List Projects of view Test Data Parameterization right", "description" : "API to list Projects of view Test Data Parameterization right", "operationId" : "getProjectFromRightsView", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "responses" : { "200" : { "description" : "List of Projects For Specific Rights", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/parameter/unarchive" : { "post" : { "tags" : [ "Parameter" ], "summary" : "Unarchive parameters", "description" : "API to Unarchive list of Parameters", "operationId" : "unarchiveParameter", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "Ids", "description" : "parameter Ids list", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "List of Parameters Unarchive successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/parameter/update/{paramID}" : { "put" : { "tags" : [ "Parameter" ], "summary" : "Update Parameter/values", "description" : "API to Update parameter and values", "operationId" : "updateParameter", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "Parameter id", "description" : "parameter Ids as query path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "UpdateParameter", "description" : "UpdateParameter for update parameter", "required" : true, "schema" : { "$ref" : "#/definitions/UpdateParameter" } } ], "responses" : { "200" : { "description" : "Update parameter values and parameters", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/parameter/values/{paramID}" : { "post" : { "tags" : [ "Parameter" ], "summary" : "List of parameter Values", "description" : "API to list of Parameter Values", "operationId" : "getParameterValues", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "Parameter id", "description" : "parameter Ids as query path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "Base Request", "description" : "Filter,sort base request", "required" : true, "schema" : { "$ref" : "#/definitions/BaseRequest" } } ], "responses" : { "200" : { "description" : "List of Parameter values fetch successfully", "schema" : { "$ref" : "#/definitions/Response" } }, "400" : { "description" : "Mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Create Requirement", "description" : "", "operationId" : "addRequirement", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "rqFolderId", "description" : "FolderId of Requirement", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "name", "description" : "Summary of the Requirement", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "priority", "description" : "Priority of Requirement", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, { "in" : "body", "name" : "component", "description" : "Label of Requirement", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, { "in" : "body", "name" : "requirementState", "description" : "Status of Requirement", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, { "in" : "body", "name" : "description", "description" : "Description of Requirement", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "owner", "description" : "Owner of Requirement", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "scope", "description" : "Scope of the Requirement, possible values project,release,cycle,build", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Requirement created successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Returned in case of- Invalid json/project/client" }, "500" : { "description" : "Returned when server connection times out" } } }, "put" : { "tags" : [ "Requirement" ], "summary" : "Update Requirement", "description" : "", "operationId" : "editRequirements", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "updateVersionFlag", "description" : "Version number of Requirement(value = 3)", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "updateWithVersion", "description" : "Flag for the requirement update with version or not", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "description", "description" : "Description of the Requirement", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "rqId", "description" : "Id of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "rqVersionId", "description" : "VersionId of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "requirementState", "description" : "Status of Requirement", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, { "in" : "body", "name" : "priority", "description" : "Priority of Requirement", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, { "in" : "body", "name" : "owner", "description" : "Owner of Requirement", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "name", "description" : "Summary of Requirement", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "component", "description" : "Label of Requirement", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, { "in" : "body", "name" : "versionComment", "description" : "Comment about new version while creating it", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Requirement updated successfully", "schema" : { "$ref" : "#/definitions/RequirementRepository" } }, "400" : { "description" : "Returned in case of- Invalid json object or invalid UDF " }, "401" : { "description" : "Unautorised, insufficient privileges or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/archiveEntity" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Archive Requirement", "description" : "API To archive requirement based on specific version or all version", "operationId" : "archiveEntity", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityIds", "description" : "An array of requirementId or requirementVersionId", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, { "in" : "body", "name" : "isArchived", "description" : "True for archive, false for unarchive", "required" : true, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "isEntityVersion", "description" : "True for archive specific version of Requirement otherwise false", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Requirement archive successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/delete" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Delete Requirement(s)", "description" : "", "operationId" : "deleteRequirements", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "rqId", "description" : "Comma-separated values to Id of Requirement", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Requirement(s) deleted sucessfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Tried to delete requirement of another project" }, "401" : { "description" : "Unautorised, insufficient privileges or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/deleteEntity" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Delete Requirement", "description" : "API To Delete Requirement", "operationId" : "deleteEntity", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityIds", "description" : "An array of RequirementId", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } ], "responses" : { "200" : { "description" : "Requirement deleted successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/deleteEntityVersion" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Delete Requirement Version", "description" : "API To Delete Requirement Version", "operationId" : "deleteEntityVersion", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "Id of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "entityVersions", "description" : "An array of version number of the Requirement", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } ], "responses" : { "200" : { "description" : "Requirement version deleted successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/detail/data" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Fetch Requirement", "description" : "To view particular requirement's all fields", "operationId" : "getRequirementDetail", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "version", "description" : "Version number of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "id", "description" : "Id of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Requirement fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/folder/archive" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Archive Requirement Folder.", "description" : "", "operationId" : "archiveFolder", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "Archive Folder Request", "description" : "Archive Folder Inputs", "required" : true, "schema" : { "$ref" : "#/definitions/RqFolderArchiveRequestDetail" } } ], "responses" : { "200" : { "description" : "Folder archived successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Following fields are missing:rqFolderIDs" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/folder/unarchive" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Unarchive Requirement Folder.", "description" : "", "operationId" : "unarchiveFolder", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "Unarchive Folder Request", "description" : "Unarchive Folder Inputs", "required" : true, "schema" : { "$ref" : "#/definitions/RqFolderUnarchiveRequestDetail" } } ], "responses" : { "200" : { "description" : "Folder unarchived successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Following fields are missing:rqFolderIDs" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/folders" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Create Requirement Folder", "description" : "", "operationId" : "addFolder", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "parentId", "description" : "Id of parent folder", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "name", "description" : "Folder Name", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful creation of requirement folder", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Mandatory field(s) is missing." }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned if there is an error in server" } } }, "put" : { "tags" : [ "Requirement" ], "summary" : "Update Requirement Folder", "description" : "", "operationId" : "updateFolder", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "name", "description" : "Updated Folder Name", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "folderId", "description" : "Unique identifier of Requirement Folder to update", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Successful updation of requirement folder", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Mandatory field(s) is missing." }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned if there is an error in server" } } } }, "/rest/requirements/folders/delete" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Delete Requirement Folder", "description" : "", "operationId" : "deleteFolders", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "folderId", "description" : "FolderId of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Requirement folder deleted successfully.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or tried to delete root folder" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/getVersionDetail" : { "post" : { "tags" : [ "Requirement" ], "summary" : "List Requirement version detail.", "description" : "", "operationId" : "getVersionDetail", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "rqID", "description" : "Id of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Requirement version detail list fetch successfully.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/link/issues" : { "put" : { "tags" : [ "Requirement" ], "summary" : "Link issues to requirement", "description" : "", "operationId" : "linkIssues", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "rqID", "description" : "EntityKey of Requirement", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "dfIDs", "description" : "IDs of Issues to be linked with Requirement", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "Issues successfully linked to requirement", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/link/testcases" : { "put" : { "tags" : [ "Requirement" ], "summary" : "Link TestCases to Requirement", "description" : "", "operationId" : "linkTestCases", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "rqID", "description" : "Entitykey of the Requirement", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "rqVersionId", "description" : "VersionId of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "tcVersionIds", "description" : "An array of testcase version's Id", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } ], "responses" : { "200" : { "description" : "Testcase(s) linked successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Returned in case of- Invalid rqVersionId/tcVersionIds or failed operation" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/list" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Fetch Details of specific Requirement", "description" : "Get details of a requirement by providing ID of requirement, requirement version ID.", "operationId" : "getRequirementUIColumns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "id", "description" : "Id of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "filter", "description" : "Filter to be applied", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Requirement details fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/list/forIS" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Fetch Requirement List For Issue", "description" : "Requirement list getting based on particular id of issue", "operationId" : "getRequirementsForIS", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "dfID", "description" : "Id of issue", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "getLinked", "description" : "True to get only those requirements that are linked with this Issue, false to get those requirements which are not linked with this Issue", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "getColumns", "description" : "True to get list of all available filters(System + UDF) in 'filterTemplate' field", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "udfFilter", "description" : "Apply filter on user defined fields' values", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/UdfFilter" } } }, { "in" : "body", "name" : "filter", "description" : "System filters to be applied", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } } ], "responses" : { "200" : { "description" : "Requirement list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/list/forTC" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Fetch Requirement List For Testcase", "description" : "Requirement list getting based on particular id of testcase", "operationId" : "getRequirementsForTC", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcID", "description" : "Id of testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "getLinked", "description" : "True to get only those requirements that are linked with this Testcase, false to get those requirements which are not linked with this Testcase", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "showEntityWithReleaseCycle", "description" : "List only Requirement which have given tcID's release and cycle", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "getColumns", "description" : "True to get list of all available filters(System + UDF) in 'filterTemplate' field", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "udfFilter", "description" : "Apply filter on user defined fields' values", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/UdfFilter" } } }, { "in" : "body", "name" : "filter", "description" : "System filters to be applied", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } } ], "responses" : { "200" : { "description" : "Requirement list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/list/forTS" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Fetch Requirement List For TestSuite", "description" : "Requirement list for TestSuite", "operationId" : "getRequirementsForTS", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "getColumns", "description" : "True to get list of all available filters(System + UDF) in 'filterTemplate' field", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "udfFilter", "description" : "Apply filter on user defined fields' values", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/UdfFilter" } } }, { "in" : "body", "name" : "filter", "description" : "System filters to be applied", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } }, { "in" : "body", "name" : "scope", "description" : "Scope of the Requirement, possible values project,release,cycle,build", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Requirement list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/list/projectUsers" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Get list of users for project", "description" : "", "operationId" : "getUserListForProject", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "projectId", "description" : "ProjectId", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "rqId", "description" : "Id of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "successfully get list of users for project", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/list/viewColumns" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Fetch Requirement List", "description" : "Fetch specific data of Requirements", "operationId" : "getViewColumns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "viewId", "description" : "View ID of the user for that particular project and Requirement module", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "folderPath", "description" : "Path of folder whose Requirements are to be fetched", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Requirement list fetched successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/listForBulkOperation" : { "post" : { "tags" : [ "Requirement" ], "summary" : "List Requirements for Bulk Opeartion.", "description" : "", "operationId" : "getRQListForBulkOperation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "folderPath", "description" : "FolderPath of folder whose requirements are to be listed", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "filter", "description" : "Filters to apply", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } } ], "responses" : { "200" : { "description" : "Requirement list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/scope/add" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Add scope to the requirement", "description" : "", "operationId" : "addToScope", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "Id of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sourceBuildId", "description" : "BuildId of the Cycle associated with Release", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sourceProjectId", "description" : "ProjectId of the Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sourceReleaseId", "description" : "ReleaseId of the Project", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sourceScope", "description" : "Scope for the requirement likes to project, release, build, cycle", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "entityType", "description" : "Entity type for the requirement, the default value is RQ", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "releaseCycleMapping", "description" : "An array of release, cycle & version mapping", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/ReleaseCycleMapping" } } }, { "in" : "body", "name" : "opType", "description" : "Operation types possible value likes otherscope or current", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "withVersion", "description" : "Scope added with the version or not", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "updateFlag", "description" : "This flag for the scope update or not", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "destinationProjectId", "description" : "ProjectId based on operation type, possible value likes current project or another project of the id", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "entityData", "description" : "An array of entityId & version for the Requirement", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/EntityData" } } } ], "responses" : { "200" : { "description" : "Add to scope successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/scope/list" : { "put" : { "tags" : [ "Requirement" ], "summary" : "Fetch Scope List", "description" : "To view list of scope(Release/Cycle) for requirement", "operationId" : "getRequirementScopeList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityID", "description" : "Id of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "limit", "description" : "Number of record per page", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Scope(Release/Cycle) fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/scope/remove" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Remove Scope", "description" : "API to remove scope(release/cycle) from requirement", "operationId" : "removeFromScopeResponse", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "Id of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sourceBuildId", "description" : "BuildId of the Cycle associated with Release", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sourceProjectId", "description" : "ProjectId of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sourceReleaseId", "description" : "ReleaseId of the Project", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "entityType", "description" : "Entity type for the requirement, the default value is RQ", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "opType", "description" : "Operation types possible value likes currentBuild,allBuildsInRelease,allReleases", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Remove scope successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/testcase/list" : { "post" : { "tags" : [ "Requirement" ], "summary" : "Fetch Testcase List", "description" : "API to get list of testcases in requirement", "operationId" : "getTestCaseForTestSuite", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "rqID", "description" : "Id of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "limit", "description" : "Number of record per page", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Testcase list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/tree" : { "get" : { "tags" : [ "Requirement" ], "summary" : "Get Requirement Folder/Sub Folder List", "description" : "Get folder/subfolder data based on folder id or list of folder with requirement", "operationId" : "getRequirementTree", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } } }, { "name" : "rqActiveScope", "in" : "query", "description" : "Scope of Requirement, possible values are btnRqScopeToolCycle,btnRqScopeToolRelease,btnRqScopeToolProject", "required" : false, "type" : "string" }, { "name" : "rqSortTreeColumn", "in" : "query", "description" : "Sort criteria based on which Requirement folders list will be obtained", "required" : false, "type" : "string" }, { "name" : "rqSortTreeDir", "in" : "query", "description" : "Direction of sorting, possible values ASC or DESC", "required" : false, "type" : "string" }, { "name" : "node", "in" : "query", "description" : "Id of parent folder whose sub folders are to be fetched", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "hideFolders", "in" : "query", "description" : "Send to true to hide empty folders", "required" : false, "type" : "boolean" }, { "name" : "showEntity", "in" : "query", "description" : "True for fetch folder data with list of requirement inside folder, false for only folder data", "required" : false, "type" : "boolean" }, { "name" : "scope", "in" : "query", "description" : "Scope of Requirement, possible value likes project,cycle,release", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "Successfully get requirement list", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Mandatory field(s) is missing." }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned if there is an error in server" } }, "deprecated" : true }, "post" : { "tags" : [ "Requirement" ], "summary" : "Get subfolders' information of a particular folder", "description" : "", "operationId" : "getTreeNew", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "rqFolderID", "description" : "Folder ID of Selected Requirement Folder", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "hideFolders", "description" : "Flag to Hide empty Folders", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "sort", "description" : "Sort Folders by date or name", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "filter", "description" : "'isArchived' filter for showing archived/unarchived folder(s) in folder hierarchy", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } } ], "responses" : { "200" : { "description" : "Requirement folders detail list fetch successfully.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/unlink/issues" : { "put" : { "tags" : [ "Requirement" ], "summary" : "Unlink Issue", "description" : "API to unlink issue from requirement", "operationId" : "unLinkIssues", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "dfIDs", "description" : "An array of issue Id", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, { "in" : "body", "name" : "rqID", "description" : "EntityKey of Requirement", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "unlink issue successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/unlink/testcases" : { "put" : { "tags" : [ "Requirement" ], "summary" : "Unlink Testcase", "description" : "API to unlink testcase(s) from requirement", "operationId" : "unLinkTestCases", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "rqID", "description" : "Entitykey of the Requirement", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "rqVersionId", "description" : "VersionId of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "tcVersionIds", "description" : "An array of testcase version's Id", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } ], "responses" : { "200" : { "description" : "Testcase unlink successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/requirements/versions/{id}" : { "post" : { "tags" : [ "Requirement" ], "summary" : "To view particular requirement's version info", "description" : "", "operationId" : "versions", "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of Requirement", "required" : true, "type" : "integer", "format" : "int64" }, { "in" : "body", "name" : "entityId", "description" : "Id of Requirement", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "filter", "description" : "filters", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } } ], "responses" : { "200" : { "description" : "Requirement Version detail fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/search/result" : { "post" : { "tags" : [ "Search" ], "summary" : "Search entities", "description" : "API to search entities", "operationId" : "getSearchResult", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityType", "description" : "Abbreviated EntityType('RQ'/'TC'/'TS'/'IS') whose entities are to be searched", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "scope", "description" : "Level('project'/'release'/'cycle') at which search is to be performed", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "filters", "description" : "filters", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/SearchFilters" } } }, { "in" : "body", "name" : "filter", "description" : "Filters for Testcase search", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "folderPath", "description" : "Path of root folder", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "searchMode", "description" : "Type of search", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "showAllStateEntities", "description" : "True to show all entities regardless of its approved or not", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "visibleUDFNames", "description" : "List of name of all visible UDF's", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Blank search will return all entities", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Create Testcase", "description" : "", "operationId" : "addTestCase", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcFolderID", "description" : "FolderId of Testcase", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "steps", "description" : "An array of Steps", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Steps" } } }, { "in" : "body", "name" : "name", "description" : "Summary of Testcase", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "priority", "description" : "PriorityID of Testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "component", "description" : "Component(Label) Id of Testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "owner", "description" : "OwnerId of Testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "testCaseState", "description" : "StatusId of Testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "testCaseType", "description" : "Id of Test Category", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "executionMinutes", "description" : "Estimated Time (In Minute/s) for Execution", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "testingType", "description" : "Id of TestingType", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "description", "description" : "Description of Testcase", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Testcase added successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } }, "put" : { "tags" : [ "TestCase" ], "summary" : "Update Test case(s)", "description" : "", "operationId" : "editTestCases", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcID", "description" : "ID of Testcase", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "tcFolderID", "description" : "FolderId of Testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "tcVersionID", "description" : "VersionID of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "tcVersion", "description" : "Version number of Testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "name", "description" : "Summary of Testcase", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "description", "description" : "Value of Description", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "testCaseType", "description" : "Id of TestingType", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "executionMinutes", "description" : "Estimated Time (In Minute/s) for Execution", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "priority", "description" : "PriorityID of Testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "owner", "description" : "OwnerId of Testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "testCaseState", "description" : "StatusId of Testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "component", "description" : "Component(Label) Id of Testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "withVersion", "description" : "Flag for the TestCase update with version or not", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "updateVersionFlag", "description" : "Version number of TestCase(value = 3)", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Test case(s) updated successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/archiveEntity" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Archive Testcase", "description" : "API To archive testcase based on specific version or all version", "operationId" : "archiveEntity", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityIds", "description" : "An array of testcaseId or testcaseVersionId", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, { "in" : "body", "name" : "isArchived", "description" : "True for archive, false for unarchive", "required" : true, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "isEntityVersion", "description" : "True for archive specific version of Testcase otherwise false", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Testcase archive successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/comments" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Add Comments in Testcase", "description" : "", "operationId" : "addComments", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "comments", "description" : "Comments of Testcase", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "entityId", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "entityType", "description" : "Entity Type of Testcase, default value is TC", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Comments added successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/comments/delete" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Delete Comments in Testcase", "description" : "", "operationId" : "deleteComments", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "entityType", "description" : "Entity Type of Testcase, default value is TC", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "commentId", "description" : "CommentId of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Comments deleted successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/comments/update" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Update Comments in Testcase", "description" : "", "operationId" : "updateComments", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "comments", "description" : "Comments of Testcase", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "entityId", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "entityType", "description" : "Entity Type of Testcase, default value is TC", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "commentId", "description" : "CommentId of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Comments updated successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/delete" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Bulk Delete testcases", "description" : "API to bulk delete testcases", "operationId" : "bulkDelete", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "id", "description" : "provide id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Testcases deleted successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } }, "deprecated" : true } }, "/rest/testcases/deleteEntity" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Delete Testcase", "description" : "API To Delete Testcase", "operationId" : "deleteEntity", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityIds", "description" : "An array of TestcaseId", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } ], "responses" : { "200" : { "description" : "Testcase deleted successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/deleteEntityVersion" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Delete Testcase Version", "description" : "API To Delete Testcase Version", "operationId" : "deleteEntityVersion", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "entityVersions", "description" : "An array of version number of the Testcase", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } ], "responses" : { "200" : { "description" : "Testcase version deleted successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/execution" : { "post" : { "tags" : [ "TestCase" ], "summary" : "List Test Executions of particular testcase", "description" : "", "operationId" : "execution", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcid", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Successfully fetch Executions of particular testcase", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/folder/archive" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Archive Testcase Folder.", "description" : "", "operationId" : "archiveFolder", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "Archive Folder Request", "description" : "Archive Folder Inputs", "required" : true, "schema" : { "$ref" : "#/definitions/TcFolderArchiveRequestDetail" } } ], "responses" : { "200" : { "description" : "Folder archived successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Following fields are missing:tcFolderIDs" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/folder/unarchive" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Unarchive Testcase Folder.", "description" : "", "operationId" : "unarchiveFolder", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "Unarchive Folder Request", "description" : "Unarchive Folder Inputs", "required" : true, "schema" : { "$ref" : "#/definitions/TcFolderUnarchiveRequestDetail" } } ], "responses" : { "200" : { "description" : "Folder unarchived successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Following fields are missing:tcFolderIDs" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/folders" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Create Testcase Folder", "description" : "", "operationId" : "addFolder", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "parentId", "description" : "Id of parent folder", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "name", "description" : "Folder Name", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Testcase folder created successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } }, "put" : { "tags" : [ "TestCase" ], "summary" : "Update Testcase Folder", "description" : "", "operationId" : "updateFolder", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "name", "description" : "Updated Folder name", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "tcFolderID", "description" : "Unique Identifier of Testcase Folder to update", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Testcase Folder updated successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/folders/delete" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Delete Testcase folder", "description" : "", "operationId" : "deleteFolders", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcFolderId", "description" : "FolderId of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Testcase folder deleted successfully.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/getCommentsData" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Get Comments in Testcase", "description" : "", "operationId" : "getCommentsData", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "entityType", "description" : "Entity Type of Testcase, default value is TC", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "limit", "description" : "Number of record per page", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Comments get successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/getParamDetails" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Get information of parameters associated with the Testcase linked to a Testsuite", "description" : "", "operationId" : "getParamDetails", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tctsID", "description" : "tctsID for fetching linked paramIDs", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Param Details List fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/getVersionDetail" : { "post" : { "tags" : [ "TestCase" ], "summary" : "List version details of TestCase.", "description" : "", "operationId" : "getTCVersionDetail", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcID", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "TestCase Version detail listed successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/link/requirements" : { "put" : { "tags" : [ "TestCase" ], "summary" : "To Link Requirement(s) to Testcase", "description" : "", "operationId" : "linkRequirements", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcID", "description" : "EntityKey of Testcase", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "tcVersionId", "description" : "VersionId of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "rqVersionIds", "description" : "Comma-separated list of versionId to the Requirement", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Requirements successfully linked to testcase", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or entityKey" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/link/testsuites" : { "put" : { "tags" : [ "TestCase" ], "summary" : "Link TestSuites to Testcase", "description" : "", "operationId" : "linkTestSuites", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcID", "description" : "EntityKey of Testcase", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "tsIDs", "description" : "Comma-separated value of Testsuite's EntityKey ", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "tcVersion", "description" : "Version number of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Testsuites successfully linked to testcases", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/list" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Fetch Testcase List", "description" : "Testcase list getting based on particular id of testcase or folder inside all data or particualr version related data", "operationId" : "getTestCasesUIColumns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "id", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "version", "description" : "Version number of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "tcFolderID", "description" : "FolderId of Testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "scope", "description" : "Scope of Testcase, possible values project,release,cycle", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Testcase list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/list/forRQ" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Fetch Testcase List", "description" : "Testcase list getting based on particular id of requirement.", "operationId" : "getTestcasesForRQ", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "rqID", "description" : "Id of Requirement", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "getLinked", "description" : "True to get only those testcases that are linked with this Requirement, false to get those testcases which are not linked with this Requirement", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "showEntityWithReleaseCycle", "description" : "List only Testcase which have given rqID's release and cycle", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "getColumns", "description" : "True to get list of all available filters(System + UDF) in 'filterTemplate' field", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "udfFilter", "description" : "Apply filter on user defined fields' values", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/UdfFilter" } } }, { "in" : "body", "name" : "filter", "description" : "System filters to be applied", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } } ], "responses" : { "200" : { "description" : "Testcase list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/list/forSharedTestcase" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Fetch Testcase List", "description" : "Lists Testcases linked with particular shared testcase.", "operationId" : "getTestcasesForSharedTestcase", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcVersionID", "description" : "VersionID of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "getColumns", "description" : "True to get list of all available filters(System + UDF) in 'filterTemplate' field", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "filter", "description" : "System filters to be applied", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } } ], "responses" : { "200" : { "description" : "Testcase list fetched successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/list/forTS" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Fetch Testcase List", "description" : "Testcase list for testsuite.", "operationId" : "getTestcasesForTS", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "showAllStateEntities", "description" : "True to get testcases of approved state only, false to get testcases of any state", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "getLinked", "description" : "True to get only those testcases that are linked with this defect, false to get all testcases. While using True \"tsID\" is mandatory", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "tsID", "description" : "Id of Test Suite", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "showEntityWithReleaseCycle", "description" : "List only those Testcases which have the same associated releases and cycles as the Testsuite", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "getColumns", "description" : "True to get list of all available filters(System + UDF) in 'filterTemplate' field", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "udfFilter", "description" : "Apply filter on user defined fields' values", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/UdfFilter" } } }, { "in" : "body", "name" : "filter", "description" : "System filters to be applied", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } }, { "in" : "body", "name" : "showUnlinked", "description" : "True to get testcases which are not linked with currently selected testsuite(which means it will Hide already linked test cases)", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "showUnlinkedForReleaseCycle", "description" : "True to get testcases linked with selected release and cycle but not linked with testsuites present in selected release and cycle", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Testcase list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/list/viewColumns" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Fetch Testcase List", "description" : "Fetch specific data of Testcases", "operationId" : "getViewColumns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "viewId", "description" : "View ID of the user for that particular project and Testcase module", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "folderPath", "description" : "Path of folder whose Testcases are to be fetched", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "havingSharedTestcases", "description" : "True value will fetch testcases having shared testcases linked with it", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Testcase list fetched successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/listForBulkOperation" : { "post" : { "tags" : [ "TestCase" ], "summary" : "List TestCase(s) for Bulk Opeartion.", "description" : "", "operationId" : "getRQListForBulkOperation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "folderPath", "description" : "FolderPath of Testcase Folder whose testcases are to be listed", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "TestCase list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/listLinked/forTS" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Fetch Testcase List", "description" : "Testcase list for testsuite.", "operationId" : "getLinkedTestcasesForTS", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "showAllStateEntities", "description" : "True to get testcases of approved state only, false to get testcases of any state", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "getLinked", "description" : "True to get only those testcases that are linked with this defect, false to get all testcases. While using True \"tsID\" is mandatory", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "tsID", "description" : "Id of Test Suite", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "showEntityWithReleaseCycle", "description" : "List only those Testcases which have the same associated releases and cycles as the Testsuite", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "getColumns", "description" : "True to get list of all available filters(System + UDF) in 'filterTemplate' field", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "udfFilter", "description" : "Apply filter on user defined fields' values", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/UdfFilter" } } }, { "in" : "body", "name" : "filter", "description" : "System filters to be applied", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } } ], "responses" : { "200" : { "description" : "Testcase list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/listmanageversions" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Get all the Versions of a Testcase", "description" : "", "operationId" : "listManageVersions", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Successfully get all versions of a Testcase", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Entity not found" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/requirements/list" : { "post" : { "tags" : [ "TestCase" ], "summary" : "To get list of requirements in a testcase", "description" : "", "operationId" : "getRequirementListInTestCases", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcID", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "limit", "description" : "Number of record per page", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Requirement list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/scope/add" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Add scope(Release/Cycle) to testcase", "description" : "", "operationId" : "addToScope", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sourceBuildId", "description" : "BuildId of the Cycle associated with Release", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sourceProjectId", "description" : "ProjectId of the Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sourceReleaseId", "description" : "ReleaseId of the Project", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "releaseCycleMapping", "description" : "An array of release, cycle & version mapping", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/ReleaseCycleMapping" } } }, { "in" : "body", "name" : "opType", "description" : "Operation types possible value likes otherScope or current", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "withVersion", "description" : "Scope added with the version or not", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "updateFlag", "description" : "This flag for the scope update or not", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "destinationProjectId", "description" : "ProjectId based on operation type, possible value likes current project or another project of the id", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "entityData", "description" : "An array of entityId & version for the Testcase", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/EntityData" } } }, { "in" : "body", "name" : "entityType", "description" : "Abbreviated entityType of Testcase - 'TC'", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "sourceScope", "description" : "scope('project'/'release'/'cycle')", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Scope added to testcase successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/scope/list" : { "put" : { "tags" : [ "TestCase" ], "summary" : "Fetch Scope List", "description" : "To view list of scope(Release/Cycle) for testcase", "operationId" : "getTestCaseScopeList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityID", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "limit", "description" : "Number of record per page", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Scope(Release/Cycle) fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/scope/remove" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Remove Scope", "description" : "API to remove scope(release/cycle) from testcase", "operationId" : "RemoveTestCaseFromScopeResponse", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityId", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sourceBuildId", "description" : "BuildId of the Cycle associated with Release", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sourceProjectId", "description" : "ProjectId of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "sourceReleaseId", "description" : "ReleaseId of the Project", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "entityType", "description" : "Entity type for the testcase, the default value is TC", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "opType", "description" : "Operation types possible value likes currentBuild,allBuildsInRelease,allReleases", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Remove scope successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/sharedTCList/forTC" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Fetch Testcase List", "description" : "Shared Testcase list", "operationId" : "getTestcasesForSharedTC", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Testcase list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/steps/list" : { "post" : { "tags" : [ "TestCase" ], "summary" : "List steps of TestCase", "description" : "API to list all steps of a testcase", "operationId" : "getSteps", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "id", "description" : "Id of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "limit", "description" : "Number of record per page", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "version", "description" : "Version number of Testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Test case steps shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/steps/list/forsearch" : { "post" : { "tags" : [ "TestCase" ], "summary" : "List steps of TestCase for Global Search", "description" : "API to list all steps of a testcase particular version", "operationId" : "getStepsForSearch", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcVersionID", "description" : "Id of Testcase's version", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "limit", "description" : "Number of record per page", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Test case steps shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/tree" : { "get" : { "tags" : [ "TestCase" ], "summary" : "Get Testcase Folder/Sub Folder List", "description" : "Get folder/subfolder data based on folder id or list of folder with testcase", "operationId" : "getTree", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } } }, { "name" : "tcActiveScope", "in" : "query", "description" : "Scope of Testcase, possible values are btnTcScopeToolCycle,btnTcScopeToolRelease,btnTcScopeToolProject", "required" : false, "type" : "string" }, { "name" : "tcSortTreeColumn", "in" : "query", "description" : "Sort criteria based on which Testcase folders list will be obtained", "required" : false, "type" : "string" }, { "name" : "tcSortTreeDir", "in" : "query", "description" : "Direction of sorting, possible values ASC or DESC", "required" : false, "type" : "string" }, { "name" : "node", "in" : "query", "description" : "Id of parent folder whose sub folders are to be fetched", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "hideFolders", "in" : "query", "description" : "Send to true to hide empty folders", "required" : false, "type" : "boolean" }, { "name" : "showEntity", "in" : "query", "description" : "True for fetch folder data with list of testcase inside folder, false for only folder data", "required" : false, "type" : "boolean" }, { "name" : "scope", "in" : "query", "description" : "Scope of Testcase, possible value likes project,cycle,release", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "Successfully get testcase list", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Mandatory field(s) is missing." }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned if there is an error in server" } }, "deprecated" : true }, "post" : { "tags" : [ "TestCase" ], "summary" : "Get subfolders' information of a particular folder", "description" : "", "operationId" : "getTreeNew", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcFolderID", "description" : "FolderID for selected folder", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "hideFolders", "description" : "Flag for hide empty folders", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "sort", "description" : "Sort Folders by date or name", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "filter", "description" : "'isArchived' filter for showing archived/unarchived folder(s) in folder hierarchy", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } } ], "responses" : { "200" : { "description" : "TestCase Folder Tree listed successfully.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/tree/data" : { "post" : { "tags" : [ "TestCase" ], "summary" : "Get Testcase Folder Detail", "description" : "API to get particular folder detail of testcase", "operationId" : "getFolderDetailsForEdit", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcFolderId", "description" : "FolderId of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "isInheritFromParent", "description" : "Possible value is true or false", "required" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Testcase folder detail fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/unlink/requirements" : { "put" : { "tags" : [ "TestCase" ], "summary" : "To UnLink Requirement(s) to Testcase", "description" : "", "operationId" : "unLinkRequirements", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcID", "description" : "EntityKey of Testcase", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "tcVersionId", "description" : "VersionId of Testcase", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "rqVersionIds", "description" : "Comma-separated list of versionId to the Requirement", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Requirements successfully unlinked to testcase", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or entityKey" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testcases/versions/{id}" : { "post" : { "tags" : [ "TestCase" ], "summary" : "To view particular testcase's all fields", "description" : "", "operationId" : "versions", "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "description" : "Id of Testcase", "required" : true, "type" : "integer", "format" : "int64" }, { "in" : "body", "name" : "entityId", "description" : "Id of Testcase whose version meta-data is to be obtained", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "filter", "description" : "filters", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } } ], "responses" : { "200" : { "description" : "Testcase detail fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Create TestSuite", "description" : "API to create testsuite", "operationId" : "addTestSuites", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "parentFolderId", "description" : "Parent folderId of Test Suites", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "isAutomatedFlag", "description" : "Default value false", "required" : true, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "name", "description" : "Summary of Test Suites", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "description", "description" : "Description of Test Suites", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "owner", "description" : "Owner of Test Suites", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "testSuiteState", "description" : "Status of Test Suites", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "TestSuite created successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } }, "put" : { "tags" : [ "TestSuites" ], "summary" : "Update TestSuite", "description" : "", "operationId" : "editTestSuites", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "parentFolderId", "description" : "Parent folderId of Test Suites", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "isAutomatedFlag", "description" : "Default value false", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "name", "description" : "Summary of Test Suites", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "description", "description" : "Description of Test Suites", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "owner", "description" : "OwnerId of Test Suites", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "ownUser", "description" : "An array of ownerId of Test Suites", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, { "in" : "body", "name" : "owneralias", "description" : "Owner name of Test Suites", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "testSuiteState", "description" : "StatusId of Test Suites", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "testSuiteStateAlias", "description" : "Status name of Test Suites", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "tsState", "description" : "An array of statusId of Test Suites", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, { "in" : "body", "name" : "entityKey", "description" : "EntityKey of Test Suites", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "folderPath", "description" : "Folder path of Test Suites", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "TsFolderID", "description" : "Folder Id of Test Suites", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "id", "description" : "Id of Test Suites", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Test Suites update successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/archiveEntity" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Archive TestSuite", "description" : "API To archive TestSuite", "operationId" : "archiveEntity", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityIds", "description" : "An array of testSuiteID", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, { "in" : "body", "name" : "isArchived", "description" : "True for archive, false for unarchive", "required" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "TestSuite archive successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/assign/platform" : { "put" : { "tags" : [ "TestSuites" ], "summary" : "Assign owner of platform from Test Suites", "description" : "", "operationId" : "assignPlatformOwner", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "platformowner", "description" : "OwnerId of selected User", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "qmAllowBulkEmail", "description" : "True for send email to selected user otherwise false", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "tsRunIds", "description" : "TestRunId of Test Suites", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Successfully assigned owner of platform from testsuites", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/assign/tester" : { "put" : { "tags" : [ "TestSuites" ], "summary" : "To assign tester to Testcase in execution", "description" : "", "operationId" : "assignTester", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "qmAllowBulkEmail", "description" : "Flag to decide whether an email to the watchers of the Testsuite is to be sent", "required" : true, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "qmTsRunId", "description" : "Unique identifier of the Testsuite Run", "required" : true, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "tcrIDs", "description" : "Id of Testcase Runs to whom a tester is to be assigned", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "userId", "description" : "Id of user which is to be assigned as tester for the specified Testcase Runs", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Tester assigned successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/copy" : { "put" : { "tags" : [ "TestSuites" ], "summary" : "Copy TestSuite", "description" : "Copy TestSuite in same folder or another folder", "operationId" : "copy", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "srcFolderId", "description" : "Source FolderId of Testsuite", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "destFolderId", "description" : "Destination FolderId of Testsuite", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "id", "description" : "Id of Test Suites", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "TestSuite copied successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/createTestExecution" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "To create Test Execution", "description" : "", "operationId" : "createTestExecution", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "qmPlatformId", "description" : "Comma separated unique identifier of platforms to create executions on", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "qmTsId", "description" : "Unique identifier of Testsuite whose execution is to be created", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "data", "description" : "Testsuite and scope to create Test execution", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/TestSuiteReleaseCycleMap" } } } ], "responses" : { "200" : { "description" : "Test execution(s) created successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/delete" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Delete Test Suites", "description" : "", "operationId" : "deleteTestSuites", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "ids", "description" : "Id of Test Suites", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "TestSuites deleted successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/deleteEntity" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "To delete Testsuites in bulk", "description" : "", "operationId" : "deleteEntity", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "entityIds", "description" : "Id of Testsuites that have to be deleted", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "Testsuites deleted successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/detail/data" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "View particular Test Suites detail", "description" : "", "operationId" : "getTsDetailsForEdit", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "id", "description" : "Id of Testsuite", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Test Suites detail fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/doUnlink/TCs" : { "put" : { "tags" : [ "TestSuites" ], "summary" : "UnLink Testcase from Testsuite", "description" : "", "operationId" : "doUnLinkTestCases", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcTsIDs", "description" : "Comma separated string of tcTsIds", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } ], "responses" : { "200" : { "description" : "Testcase successfully unlinked to testsuite", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/dolink/TCs" : { "put" : { "tags" : [ "TestSuites" ], "summary" : "Link Testcases to Test Suites", "description" : "", "operationId" : "doLinkTcToTs", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tsID", "description" : "Unique identifier of Testsuite", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "tcvdIDs", "description" : "tcVersionIDs to link to testsuite", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } }, { "in" : "body", "name" : "fromReqs", "description" : "True for Testcase link from Requirement otherwise false", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "TestCases successfully linked to TestSuite", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/folder/archive" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Archive Test Suite Folder.", "description" : "", "operationId" : "archiveFolder", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "Archive Folder Request", "description" : "Archive Folder Inputs", "required" : true, "schema" : { "$ref" : "#/definitions/TsFolderArchiveRequestDetail" } } ], "responses" : { "200" : { "description" : "Folder archived successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Following fields are missing:tsFolderIDs" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/folder/unarchive" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Unarchive Test Suite Folder.", "description" : "", "operationId" : "unarchiveFolder", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "Unarchive Folder Request", "description" : "Unarchive Folder Inputs", "required" : true, "schema" : { "$ref" : "#/definitions/TsFolderUnarchiveRequestDetail" } } ], "responses" : { "200" : { "description" : "Folder unarchived successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Following fields are missing:tsFolderIDs" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/folders" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Create Testsuite Folder", "description" : "", "operationId" : "addFolder", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "name", "description" : "Folder Name", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "parentId", "description" : "ID of parent folder", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "TestSuite Folder created successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Folder already exists" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } }, "put" : { "tags" : [ "TestSuites" ], "summary" : "Update Testsuite Folder", "description" : "", "operationId" : "updateFolder", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "folderId", "description" : "Unique identifier of Testsuite Folder to update", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "name", "description" : "Update Testsuite Folder name", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Testsuite Folder updated successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/folders/delete" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Delete TestSuite Folder", "description" : "", "operationId" : "deleteFolders", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tsFolderID", "description" : "FolderId of Test Suites", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "TestSuite folder successfully deleted.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing." }, "401" : { "description" : "Unauthorised or session expired." }, "500" : { "description" : "Returned when server connection times out." } } } }, "/rest/testsuites/getReleaseCycleForTestSuite" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "To get all the Release & Cycle of TestSuite", "description" : "", "operationId" : "getReleaseCycleForTestSuite", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tsID", "description" : "Id of Testsuite", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "limit", "description" : "Number of record per page", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Release & Cycle list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/getplatformwithname" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Get list of linked platforms from Testsuite", "description" : "", "operationId" : "getPlatformWithName", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tsID", "description" : "Id of Testsuite", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Successfully get linked platforms from testsuite", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/link/platforms" : { "put" : { "tags" : [ "TestSuites" ], "summary" : "Link Platforms to TestSuites", "description" : "", "operationId" : "linkPlatforms", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "qmTsId", "description" : "Id of Test Suites", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "qmPlatformId", "description" : "Comma-separated value of PlatformId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Selected platforms successfully linked to testsuite", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/link/testcaseWithLatestVersion" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "To update linked Testcase in TestSuite with Latest Available Version", "description" : "", "operationId" : "linkTestCaseWithLatestVersion", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcRunIDs", "description" : "List of unique identifiers of Testcase Run", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } }, { "in" : "body", "name" : "syncAll", "description" : "Flag to Sync all Testcase Run", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "tsRunID", "description" : "Unique identifier of Testsuite Run", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Linked Testcase of the Testsuite successfully updated to latest available version", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/link/testcases" : { "put" : { "tags" : [ "TestSuites" ], "summary" : "Link Testcases to Test Suites", "description" : "", "operationId" : "linkTcToTsByGrid", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tsID", "description" : "Unique identifier of Testsuite", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "tcIDs", "description" : "tcVersionIDs to link to testsuite", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } }, { "in" : "body", "name" : "fromReqs", "description" : "True for Testcase link from Requirement otherwise false", "required" : true, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "linktc", "description" : "True for Testcase link, default value true", "required" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "TestCases successfully linked to TestSuite", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/linkplatform/assignagent/createSchedulerRun" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Create Scheduler Run", "description" : "API to create scheduler run", "operationId" : "createHistorySchedulerRun", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "agentParam", "description" : "provide agentParam", "required" : true, "schema" : { "$ref" : "#/definitions/AgentParam" } } ], "responses" : { "200" : { "description" : " Agent scheduled successfully.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/list" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Fetch Testsuite List", "description" : "", "operationId" : "getTestSuitesUIColumns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "tsFolderID", "description" : "FolderId of Test Suites", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "scope", "description" : "Scope of Testsuite, possible values project,release,cycle", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Testsuite list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/list/forTC" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Fetch Testsuite List", "description" : "", "operationId" : "getTestSuitesForTC", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcID", "description" : "Id of Testcase", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "getColumns", "description" : "True to get list of all available filters(System + UDF) in 'filterTemplate' field", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "udfFilter", "description" : "Apply filter on user defined fields' values", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/UdfFilter" } } }, { "in" : "body", "name" : "filter", "description" : "System filters to be applied", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } } ], "responses" : { "200" : { "description" : "Testsuite list fetch successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/list/viewColumns" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Fetch Testsuite List", "description" : "Fetch specific data of Testsuites", "operationId" : "getViewColumns", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "viewId", "description" : "View ID of the user for that particular project and Testsuite module", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "folderPath", "description" : "Path of folder whose Testsuites are to be fetched", "required" : true, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Testsuite list fetched successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/mapReleaseCycle" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Add scope(Release/Cycle) to testsuite", "description" : "", "operationId" : "mapReleaseCycle", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "data", "description" : "An array of Data", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Data" } } } ], "responses" : { "200" : { "description" : "Scope successfully added to testsuite", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/testcase/list" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "List Testcases linked to a Testsuite", "description" : "", "operationId" : "getTestCaseForTestSuite", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "filter", "description" : "Filter to only show unshared Testcases", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } }, { "in" : "body", "name" : "tsID", "description" : "Id of Testsuite whose linked Testcases are to be obtained", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "start", "description" : "Start index of records", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "limit", "description" : "Number of records per page", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "page", "description" : "Page number to be displayed", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Testcases linked with the Testsuite shown successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/tree" : { "get" : { "tags" : [ "TestSuites" ], "summary" : "Get Testsuite Folders", "description" : "", "operationId" : "getTree", "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } } }, { "name" : "tsSortTreeColumn", "in" : "query", "description" : "Sort criteria based on which Testsuite Folders list will be obtained", "required" : false, "type" : "string" }, { "name" : "tsSortTreeDir", "in" : "query", "description" : "Direction of sorting", "required" : false, "type" : "string" }, { "name" : "node", "in" : "query", "description" : "Id of parent folder whose sub folders are to be fetched", "required" : true, "type" : "integer", "format" : "int64" }, { "name" : "hideFolders", "in" : "query", "description" : "Send to true to hide empty folders", "required" : true, "type" : "boolean" }, { "name" : "viewId", "in" : "query", "description" : "Id of view that can be obtained from latestViews key in getInfo service", "required" : true, "type" : "integer", "format" : "int64" } ], "responses" : { "200" : { "description" : "Testsuite folder data fetched successfully", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } }, "deprecated" : true }, "post" : { "tags" : [ "TestSuites" ], "summary" : "Get subfolders' information of a particular folder", "description" : "", "operationId" : "getTreeNew", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tsFolderID", "description" : "Folder ID of Selected TestSuite Folder", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "in" : "body", "name" : "hideFolders", "description" : "Flag to Hide empty Folders", "required" : false, "schema" : { "type" : "boolean" } }, { "in" : "body", "name" : "sort", "description" : "Sort Folders by date or name", "required" : false, "schema" : { "type" : "string" } }, { "in" : "body", "name" : "filter", "description" : "'isArchived' filter for showing archived/unarchived folder(s) in folder hierarchy", "required" : false, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } } } ], "responses" : { "200" : { "description" : "TestSuite folder tree listed successfully.", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/unMapReleaseCycle" : { "post" : { "tags" : [ "TestSuites" ], "summary" : "Remove scope(Release & Cycle) from Testsuite", "description" : "", "operationId" : "unMapReleaseCycle", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tsReleaseCycleMapID", "description" : "Id of Testsuite's Release Cycle mapping", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Scope successfully deleted to testsuite", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/unlink/platforms" : { "put" : { "tags" : [ "TestSuites" ], "summary" : "UnLink Platforms from Test Suites", "description" : "", "operationId" : "unLinkPlatforms", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "qmTsId", "description" : "Id of Test Suites", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "body", "name" : "platformID", "description" : "Comma-separated value of platformId of Platform", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Platforms successfully unlinked to testsuite", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } }, "/rest/testsuites/unlink/testcases" : { "put" : { "tags" : [ "TestSuites" ], "summary" : "UnLink Testcase from Testsuite", "description" : "", "operationId" : "unLinkTestCases", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "tcIDs", "description" : "Comma separated string of tcVersionIds", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, { "in" : "body", "name" : "tsID", "description" : "EntityKey of Test Suites", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Testcase successfully unlinked to testsuite", "schema" : { "$ref" : "#/definitions/ResponseEntity" } }, "400" : { "description" : "Invalid json object or mandatory fields missing" }, "401" : { "description" : "Unauthorised or session expired" }, "500" : { "description" : "Returned when server connection times out" } } } } }, "definitions" : { "AgentParam" : { "type" : "object", "properties" : { "testSuiteId" : { "type" : "string" }, "pluginAgentId" : { "type" : "string" }, "platformId" : { "type" : "string" }, "tsRunId" : { "type" : "string" }, "dropID" : { "type" : "string" }, "scheduledate" : { "type" : "string" }, "scheduletime" : { "type" : "string" } } }, "AssociatedProjects" : { "type" : "object", "properties" : { "projectID" : { "type" : "integer", "format" : "int64" }, "projectName" : { "type" : "string" } } }, "AttributeObjectObject" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "declaringType" : { "$ref" : "#/definitions/ManagedTypeObject" }, "collection" : { "type" : "boolean", "default" : false }, "association" : { "type" : "boolean", "default" : false }, "javaMember" : { "$ref" : "#/definitions/Member" }, "persistentAttributeType" : { "type" : "string", "enum" : [ "MANY_TO_ONE", "ONE_TO_ONE", "BASIC", "EMBEDDED", "MANY_TO_MANY", "ONE_TO_MANY", "ELEMENT_COLLECTION" ] } } }, "BaseRequest" : { "type" : "object", "properties" : { "filter" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } }, "start" : { "type" : "integer", "format" : "int32" }, "limit" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/definitions/Sort" } }, "showArchive" : { "type" : "boolean", "default" : false }, "showOnlyArchive" : { "type" : "boolean", "default" : false }, "entityIdsForBulk" : { "type" : "boolean", "default" : false }, "isEditable" : { "type" : "boolean", "default" : false } } }, "Cache" : { "type" : "object" }, "CriteriaBuilder" : { "type" : "object" }, "Cycle" : { "type" : "object", "required" : [ "name" ], "properties" : { "name" : { "type" : "string", "position" : 1, "description" : "Name of Cycle" }, "isLocked" : { "type" : "boolean", "position" : 2, "description" : "Defaulted to false", "default" : false }, "isArchived" : { "type" : "boolean", "position" : 3, "description" : "Defaulted to false", "default" : false } } }, "CycleParams" : { "type" : "object", "required" : [ "name", "projectID", "releaseID" ], "properties" : { "name" : { "type" : "string", "description" : "Name of Cycle" }, "startDate" : { "type" : "string", "description" : "To set StartDate of cycle" }, "targetDate" : { "type" : "string", "description" : "To set TargetDate of cycle" }, "projectID" : { "type" : "string", "description" : "Unique identifier of project in which the cycle is to be added" }, "releaseID" : { "type" : "integer", "format" : "int32", "description" : "Unique identifier of release in which the cycle is to be added" } } }, "Data" : { "type" : "object", "required" : [ "buildID", "releaseId", "tsId" ], "properties" : { "tsId" : { "type" : "integer", "format" : "int32", "description" : "Id of Test Suites" }, "buildID" : { "type" : "integer", "format" : "int32", "description" : "Id of Build(Cycle)" }, "releaseId" : { "type" : "integer", "format" : "int32", "description" : "Id of Release" } } }, "DataGridModel" : { "type" : "object", "properties" : { "projectList" : { "type" : "array", "items" : { "$ref" : "#/definitions/Project" } }, "id" : { "type" : "integer", "format" : "int64" }, "archived" : { "type" : "boolean", "default" : false }, "dataGridID" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "createdBy" : { "type" : "string" }, "createdDate" : { "type" : "string" }, "updatedBy" : { "type" : "string" }, "updatedDate" : { "type" : "string" }, "isArchived" : { "type" : "boolean", "default" : false }, "archivedDate" : { "type" : "string" }, "parameters" : { "type" : "array", "items" : { "$ref" : "#/definitions/Parameter" } }, "hasParams" : { "type" : "boolean", "default" : false }, "projectIDs" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "projects" : { "type" : "string" }, "paramIDs" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } }, "DatagridUpdateRequest" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "ids" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "dataGridID" : { "type" : "integer", "format" : "int64" }, "ID" : { "type" : "integer", "format" : "int64" }, "IDs" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "parentID" : { "type" : "integer", "format" : "int64" }, "orderID" : { "type" : "integer", "format" : "int64" }, "field" : { "type" : "string" }, "operation" : { "type" : "string" }, "value" : { "type" : "string" } } }, "EmbeddableTypeObject" : { "type" : "object", "properties" : { "attributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/AttributeObjectObject" } }, "declaredAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/AttributeObjectObject" } }, "declaredPluralAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/PluralAttributeObjectObjectObject" } }, "declaredSingularAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/SingularAttributeObjectObject" } }, "pluralAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/PluralAttributeObjectObjectObject" } }, "singularAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/SingularAttributeObjectObject" } }, "persistenceType" : { "type" : "string", "enum" : [ "ENTITY", "EMBEDDABLE", "MAPPED_SUPERCLASS", "BASIC" ] } } }, "EntityData" : { "type" : "object", "required" : [ "entityId", "version" ], "properties" : { "entityId" : { "type" : "integer", "format" : "int32", "description" : "Id of entity" }, "version" : { "type" : "integer", "format" : "int32", "description" : "entity versionId" } } }, "EntityManager" : { "type" : "object", "properties" : { "properties" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "open" : { "type" : "boolean", "default" : false }, "delegate" : { "type" : "object" }, "flushMode" : { "type" : "string", "enum" : [ "COMMIT", "AUTO" ] }, "metamodel" : { "$ref" : "#/definitions/Metamodel" }, "transaction" : { "$ref" : "#/definitions/EntityTransaction" }, "joinedToTransaction" : { "type" : "boolean", "default" : false }, "criteriaBuilder" : { "$ref" : "#/definitions/CriteriaBuilder" }, "entityManagerFactory" : { "$ref" : "#/definitions/EntityManagerFactory" } } }, "EntityManagerFactory" : { "type" : "object", "properties" : { "properties" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "cache" : { "$ref" : "#/definitions/Cache" }, "open" : { "type" : "boolean", "default" : false }, "metamodel" : { "$ref" : "#/definitions/Metamodel" }, "criteriaBuilder" : { "$ref" : "#/definitions/CriteriaBuilder" }, "persistenceUnitUtil" : { "$ref" : "#/definitions/PersistenceUnitUtil" } } }, "EntityTransaction" : { "type" : "object", "properties" : { "active" : { "type" : "boolean", "default" : false }, "rollbackOnly" : { "type" : "boolean", "default" : false } } }, "EntityTypeObject" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "supertype" : { "$ref" : "#/definitions/IdentifiableTypeObject" }, "idType" : { "$ref" : "#/definitions/TypeObject" }, "idClassAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/SingularAttributeObjectObject" } }, "attributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/AttributeObjectObject" } }, "declaredAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/AttributeObjectObject" } }, "declaredPluralAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/PluralAttributeObjectObjectObject" } }, "declaredSingularAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/SingularAttributeObjectObject" } }, "pluralAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/PluralAttributeObjectObjectObject" } }, "singularAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/SingularAttributeObjectObject" } }, "persistenceType" : { "type" : "string", "enum" : [ "ENTITY", "EMBEDDABLE", "MAPPED_SUPERCLASS", "BASIC" ] }, "bindableType" : { "type" : "string", "enum" : [ "SINGULAR_ATTRIBUTE", "PLURAL_ATTRIBUTE", "ENTITY_TYPE" ] } } }, "Filter" : { "type" : "object", "required" : [ "comparison", "field", "type", "value" ], "properties" : { "value" : { "type" : "object", "description" : "Value to search based on type of filter" }, "comparison" : { "type" : "string", "description" : "The comparision operator 'lt' or 'gt' for Date type filter" }, "type" : { "type" : "string", "description" : "Type of Filter" }, "field" : { "type" : "string", "description" : "Field name on which filter is to be applied" } } }, "Filters" : { "type" : "object", "required" : [ "name", "op", "value" ], "properties" : { "name" : { "type" : "string", "description" : "Name of Filter" }, "op" : { "type" : "string", "description" : "Operator" }, "value" : { "type" : "string", "description" : "value to search" } } }, "GrdRelCyc" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "scope" : { "type" : "string" }, "cyclID" : { "type" : "integer", "format" : "int32" }, "relID" : { "type" : "integer", "format" : "int32" }, "default" : { "type" : "string" } } }, "IdentifiableTypeObject" : { "type" : "object", "properties" : { "supertype" : { "$ref" : "#/definitions/IdentifiableTypeObject" }, "idType" : { "$ref" : "#/definitions/TypeObject" }, "idClassAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/SingularAttributeObjectObject" } }, "attributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/AttributeObjectObject" } }, "declaredAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/AttributeObjectObject" } }, "declaredPluralAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/PluralAttributeObjectObjectObject" } }, "declaredSingularAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/SingularAttributeObjectObject" } }, "pluralAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/PluralAttributeObjectObjectObject" } }, "singularAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/SingularAttributeObjectObject" } }, "persistenceType" : { "type" : "string", "enum" : [ "ENTITY", "EMBEDDABLE", "MAPPED_SUPERCLASS", "BASIC" ] } } }, "ListValue" : { "type" : "object", "required" : [ "alias", "createdDate", "id", "name", "value" ], "properties" : { "name" : { "type" : "string", "description" : "Name of list value" }, "alias" : { "type" : "string", "description" : "Alias of list value" }, "createdDate" : { "type" : "string", "description" : "Created date of the list value" }, "value" : { "type" : "string", "description" : "weightage of the list value" }, "id" : { "type" : "integer", "format" : "int64", "description" : "ID of list value to update/delete, '0' when list value is to be added" } } }, "ManagedTypeObject" : { "type" : "object", "properties" : { "attributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/AttributeObjectObject" } }, "declaredAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/AttributeObjectObject" } }, "declaredPluralAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/PluralAttributeObjectObjectObject" } }, "declaredSingularAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/SingularAttributeObjectObject" } }, "pluralAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/PluralAttributeObjectObjectObject" } }, "singularAttributes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/SingularAttributeObjectObject" } }, "persistenceType" : { "type" : "string", "enum" : [ "ENTITY", "EMBEDDABLE", "MAPPED_SUPERCLASS", "BASIC" ] } } }, "MapRole" : { "type" : "object", "required" : [ "userRoles" ], "properties" : { "userRoles" : { "type" : "array", "description" : "List of mapping for which project with what role is to be assigned", "items" : { "$ref" : "#/definitions/UserRoles" } } } }, "Member" : { "type" : "object", "properties" : { "modifiers" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "synthetic" : { "type" : "boolean", "default" : false } } }, "Metamodel" : { "type" : "object", "properties" : { "entities" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/EntityTypeObject" } }, "managedTypes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/ManagedTypeObject" } }, "embeddables" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/EmbeddableTypeObject" } } } }, "Param1" : { "type" : "object", "properties" : { "releaseID" : { "type" : "integer", "format" : "int32" }, "showArchive" : { "type" : "boolean", "default" : false } } }, "Param2" : { "type" : "object", "required" : [ "showArchive" ], "properties" : { "showArchive" : { "type" : "boolean", "description" : "Send 'true' to show archived entities", "default" : false } } }, "Param4" : { "type" : "object", "required" : [ "projectID" ], "properties" : { "projectID" : { "type" : "string", "description" : "Unique identifier of project" } } }, "Parameter" : { "type" : "object", "properties" : { "paramID" : { "type" : "integer" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "isArchived" : { "type" : "boolean", "default" : false }, "createdDate" : { "type" : "string" }, "updatedDate" : { "type" : "string" }, "associatedProjects" : { "type" : "array", "items" : { "$ref" : "#/definitions/AssociatedProjects" } }, "projects" : { "type" : "string" }, "OrignalParamID" : { "type" : "integer" }, "parameterValues" : { "type" : "array", "items" : { "$ref" : "#/definitions/ParameterValue" } }, "orderID" : { "type" : "integer" }, "testCaseRefered" : { "type" : "integer", "format" : "int64" } } }, "ParameterRequest" : { "type" : "object", "properties" : { "filter" : { "type" : "array", "items" : { "$ref" : "#/definitions/Filter" } }, "start" : { "type" : "integer", "format" : "int32" }, "limit" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/definitions/Sort" } }, "showArchive" : { "type" : "boolean", "default" : false }, "showOnlyArchive" : { "type" : "boolean", "default" : false }, "entityIdsForBulk" : { "type" : "boolean", "default" : false }, "isEditable" : { "type" : "boolean", "default" : false }, "paramName" : { "type" : "string" }, "paramDes" : { "type" : "string" }, "projectID" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "values" : { "type" : "array", "items" : { "type" : "string" } }, "projectIDs" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } }, "ParameterValue" : { "type" : "object", "properties" : { "parameterValueID" : { "type" : "integer", "format" : "int64" }, "value" : { "type" : "string" }, "orderID" : { "type" : "integer", "format" : "int64" } } }, "PersistenceUnitUtil" : { "type" : "object" }, "PluralAttributeObjectObjectObject" : { "type" : "object", "properties" : { "elementType" : { "$ref" : "#/definitions/TypeObject" }, "collectionType" : { "type" : "string", "enum" : [ "COLLECTION", "SET", "LIST", "MAP" ] }, "name" : { "type" : "string" }, "declaringType" : { "$ref" : "#/definitions/ManagedTypeObject" }, "collection" : { "type" : "boolean", "default" : false }, "association" : { "type" : "boolean", "default" : false }, "javaMember" : { "$ref" : "#/definitions/Member" }, "persistentAttributeType" : { "type" : "string", "enum" : [ "MANY_TO_ONE", "ONE_TO_ONE", "BASIC", "EMBEDDED", "MANY_TO_MANY", "ONE_TO_MANY", "ELEMENT_COLLECTION" ] }, "bindableType" : { "type" : "string", "enum" : [ "SINGULAR_ATTRIBUTE", "PLURAL_ATTRIBUTE", "ENTITY_TYPE" ] } } }, "Project" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" } } }, "ProjectParameters" : { "type" : "object", "required" : [ "name", "projectKey" ], "properties" : { "isAutoAddValue" : { "type" : "boolean", "position" : 1, "description" : "Defaulted to true", "default" : false }, "approvalWorkflow" : { "type" : "boolean", "position" : 2, "description" : "Defaulted to true. Set true to enable eSignature in the project", "default" : false }, "name" : { "type" : "string", "position" : 3, "description" : "Name of the new project" }, "projectKey" : { "type" : "string", "position" : 4, "description" : "Unique key to identify the new project" }, "addLdapUser" : { "type" : "boolean", "position" : 5, "description" : "Set true to allow addition of LDAP users in the project", "default" : false } } }, "Release" : { "type" : "object", "required" : [ "name", "projectID", "startDate", "targetDate" ], "properties" : { "name" : { "type" : "string", "description" : "Name of Release" }, "startDate" : { "type" : "string", "description" : "Start date of the Release" }, "targetDate" : { "type" : "string", "description" : "Target date of the Release" }, "projectID" : { "type" : "string", "description" : "ID of project in which the Release resides" } } }, "ReleaseCycleMapping" : { "type" : "object", "required" : [ "cycle", "release", "version" ], "properties" : { "release" : { "type" : "integer", "format" : "int32", "description" : "Id of Release" }, "cycle" : { "type" : "array", "description" : "An array of cycle's Id", "items" : { "type" : "integer", "format" : "int32" } }, "version" : { "type" : "integer", "format" : "int32", "description" : "Number of the version" } } }, "ReleaseParams" : { "type" : "object", "required" : [ "name" ], "properties" : { "name" : { "type" : "string", "position" : 1, "description" : "Name of Release" }, "description" : { "type" : "string", "position" : 2, "description" : "An explanation for the release." } } }, "RequirementRepository" : { "type" : "object", "properties" : { "manager" : { "$ref" : "#/definitions/EntityManager" }, "fieldMapForViewColumns" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "joinExistsListForTS" : { "type" : "array", "items" : { "type" : "string" } } } }, "Response" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "default" : false }, "data" : { "type" : "object" }, "errorMessage" : { "type" : "string" }, "total" : { "type" : "integer", "format" : "int64" } } }, "ResponseEntity" : { "type" : "object", "properties" : { "headers" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "body" : { "type" : "object" }, "statusCode" : { "type" : "string", "enum" : [ "CONTINUE", "SWITCHING_PROTOCOLS", "PROCESSING", "CHECKPOINT", "OK", "CREATED", "ACCEPTED", "NON_AUTHORITATIVE_INFORMATION", "NO_CONTENT", "RESET_CONTENT", "PARTIAL_CONTENT", "MULTI_STATUS", "ALREADY_REPORTED", "IM_USED", "MULTIPLE_CHOICES", "MOVED_PERMANENTLY", "FOUND", "MOVED_TEMPORARILY", "SEE_OTHER", "NOT_MODIFIED", "USE_PROXY", "TEMPORARY_REDIRECT", "RESUME_INCOMPLETE", "BAD_REQUEST", "UNAUTHORIZED", "PAYMENT_REQUIRED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "NOT_ACCEPTABLE", "PROXY_AUTHENTICATION_REQUIRED", "REQUEST_TIMEOUT", "CONFLICT", "GONE", "LENGTH_REQUIRED", "PRECONDITION_FAILED", "REQUEST_ENTITY_TOO_LARGE", "REQUEST_URI_TOO_LONG", "UNSUPPORTED_MEDIA_TYPE", "REQUESTED_RANGE_NOT_SATISFIABLE", "EXPECTATION_FAILED", "I_AM_A_TEAPOT", "INSUFFICIENT_SPACE_ON_RESOURCE", "METHOD_FAILURE", "DESTINATION_LOCKED", "UNPROCESSABLE_ENTITY", "LOCKED", "FAILED_DEPENDENCY", "UPGRADE_REQUIRED", "PRECONDITION_REQUIRED", "TOO_MANY_REQUESTS", "REQUEST_HEADER_FIELDS_TOO_LARGE", "INTERNAL_SERVER_ERROR", "NOT_IMPLEMENTED", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "GATEWAY_TIMEOUT", "HTTP_VERSION_NOT_SUPPORTED", "VARIANT_ALSO_NEGOTIATES", "INSUFFICIENT_STORAGE", "LOOP_DETECTED", "BANDWIDTH_LIMIT_EXCEEDED", "NOT_EXTENDED", "NETWORK_AUTHENTICATION_REQUIRED" ] } } }, "RqFolderArchiveRequestDetail" : { "type" : "object", "required" : [ "rqFolderIDs" ], "properties" : { "rqFolderIDs" : { "type" : "array", "position" : 1, "description" : "Array of Requirement Folder Ids", "items" : { "type" : "integer", "format" : "int64" } }, "isBulkOperation" : { "type" : "boolean", "position" : 2, "description" : "Is from BulkOperation flag", "default" : false }, "isSingleOperation" : { "type" : "boolean", "position" : 3, "description" : "Is single operation", "default" : false } } }, "RqFolderUnarchiveRequestDetail" : { "type" : "object", "required" : [ "rqFolderIDs" ], "properties" : { "rqFolderIDs" : { "type" : "array", "position" : 1, "description" : "Array of Requirement Folder Ids", "items" : { "type" : "integer", "format" : "int64" } }, "isBulkOperation" : { "type" : "boolean", "position" : 2, "description" : "Is from BulkOperation flag", "default" : false }, "isSingleOperation" : { "type" : "boolean", "position" : 3, "description" : "Is single operation", "default" : false } } }, "SearchFilters" : { "type" : "object", "required" : [ "filters", "name", "rawValue", "value" ], "properties" : { "name" : { "type" : "string", "description" : "Name of Filter, send 'Match' to search" }, "value" : { "type" : "string", "description" : "value to search, send 'OR' as the condition" }, "rawValue" : { "type" : "string", "description" : "raw value to search, send 'All'" }, "filters" : { "type" : "array", "description" : "Filter for entityKeyId,entityKey,name,description", "items" : { "$ref" : "#/definitions/Filters" } } } }, "SingularAttributeObjectObject" : { "type" : "object", "properties" : { "type" : { "$ref" : "#/definitions/TypeObject" }, "version" : { "type" : "boolean", "default" : false }, "optional" : { "type" : "boolean", "default" : false }, "id" : { "type" : "boolean", "default" : false }, "name" : { "type" : "string" }, "declaringType" : { "$ref" : "#/definitions/ManagedTypeObject" }, "collection" : { "type" : "boolean", "default" : false }, "association" : { "type" : "boolean", "default" : false }, "javaMember" : { "$ref" : "#/definitions/Member" }, "persistentAttributeType" : { "type" : "string", "enum" : [ "MANY_TO_ONE", "ONE_TO_ONE", "BASIC", "EMBEDDED", "MANY_TO_MANY", "ONE_TO_MANY", "ELEMENT_COLLECTION" ] }, "bindableType" : { "type" : "string", "enum" : [ "SINGULAR_ATTRIBUTE", "PLURAL_ATTRIBUTE", "ENTITY_TYPE" ] } } }, "Sort" : { "type" : "object", "properties" : { "property" : { "type" : "string" }, "direction" : { "type" : "string" } } }, "Steps" : { "type" : "object", "required" : [ "description", "expectedOutcome", "inputData", "orderId" ], "properties" : { "orderId" : { "type" : "integer", "format" : "int32", "description" : "Number of Order" }, "description" : { "type" : "string", "description" : "Value of Description" }, "inputData" : { "type" : "string", "description" : "Value of InputData" }, "expectedOutcome" : { "type" : "string", "description" : "Value of ExpectedOutcome" }, "tcRunID" : { "type" : "string", "description" : "Id of Test Run" } } }, "TcFolderArchiveRequestDetail" : { "type" : "object", "required" : [ "tcFolderIDs" ], "properties" : { "tcFolderIDs" : { "type" : "array", "position" : 1, "description" : "Array of Test Case Folder Ids", "items" : { "type" : "integer", "format" : "int64" } }, "isBulkOperation" : { "type" : "boolean", "position" : 2, "description" : "Is BulkOperation flag", "default" : false } } }, "TcFolderUnarchiveRequestDetail" : { "type" : "object", "required" : [ "tcFolderIDs" ], "properties" : { "tcFolderIDs" : { "type" : "array", "position" : 1, "description" : "Array of Test Case Folder Ids", "items" : { "type" : "integer", "format" : "int64" } }, "isBulkOperation" : { "type" : "boolean", "position" : 2, "description" : "Is BulkOperation flag", "default" : false } } }, "TestSuiteReleaseCycleMap" : { "type" : "object", "required" : [ "cycleId", "releaseId", "tsId" ], "properties" : { "tsId" : { "type" : "integer", "format" : "int64", "description" : "Unique identifier of Testsuite whose execution is to be created" }, "releaseId" : { "type" : "integer", "format" : "int64", "description" : "Id of release to create Test execution in" }, "cycleId" : { "type" : "integer", "format" : "int64", "description" : "Id of cycle to create Test execution in" } } }, "TsFolderArchiveRequestDetail" : { "type" : "object", "required" : [ "tsFolderIDs" ], "properties" : { "tsFolderIDs" : { "type" : "array", "position" : 1, "description" : "Array of Test Suite Folder Ids", "items" : { "type" : "integer", "format" : "int64" } }, "isBulkOperation" : { "type" : "boolean", "position" : 2, "description" : "IsBulkOpeartion Flag", "default" : false } } }, "TsFolderUnarchiveRequestDetail" : { "type" : "object", "required" : [ "tsFolderIDs" ], "properties" : { "tsFolderIDs" : { "type" : "array", "position" : 1, "description" : "Array of Test Suite Folder Ids", "items" : { "type" : "integer", "format" : "int64" } }, "isBulkOperation" : { "type" : "boolean", "position" : 2, "description" : "IsBulkOpeartion flag", "default" : false } } }, "TypeObject" : { "type" : "object", "properties" : { "persistenceType" : { "type" : "string", "enum" : [ "ENTITY", "EMBEDDABLE", "MAPPED_SUPERCLASS", "BASIC" ] } } }, "UdfFilter" : { "type" : "object", "required" : [ "field", "type", "udfmID", "value" ], "properties" : { "type" : { "type" : "string", "description" : "Type of Filter" }, "value" : { "type" : "string", "description" : "Value to search based on type of UDF" }, "udfmID" : { "type" : "integer", "format" : "int64", "description" : "Unique Identifier based on project-module-udf-user" }, "field" : { "type" : "string", "description" : "Name of User Defined Field" } } }, "UpdateParameter" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "addProject" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "removeProject" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "addValue" : { "type" : "array", "items" : { "type" : "string" } }, "editValue" : { "type" : "array", "items" : { "$ref" : "#/definitions/Value" } }, "deleteValue" : { "type" : "array", "items" : { "$ref" : "#/definitions/Value" } } } }, "UpdateUser" : { "type" : "object", "required" : [ "email", "firstName", "lastName", "loginId", "userAlias", "userID", "userType" ], "properties" : { "userID" : { "type" : "integer", "format" : "int64", "description" : "Id of user" }, "userType" : { "type" : "integer", "format" : "int64", "description" : "Type of user" }, "loginId" : { "type" : "string", "description" : "Login id of user" }, "userAlias" : { "type" : "string", "description" : "Alias of user" }, "firstName" : { "type" : "string", "description" : "Firstname of user" }, "lastName" : { "type" : "string", "description" : "Lastname of user" }, "email" : { "type" : "string", "description" : "Email of user" } } }, "User" : { "type" : "object", "required" : [ "email", "firstName", "lastName", "loginId", "userAlias", "userType" ], "properties" : { "isActive" : { "type" : "boolean", "description" : "True is user is active, else false", "default" : false }, "userType" : { "type" : "integer", "format" : "int64", "description" : "Type of user" }, "isLabel" : { "type" : "boolean", "description" : "True if its a label", "default" : false }, "loginId" : { "type" : "string", "description" : "Login id of user" }, "userAlias" : { "type" : "string", "description" : "Alias of user" }, "firstName" : { "type" : "string", "description" : "Firstname of user" }, "lastName" : { "type" : "string", "description" : "Lastname of user" }, "email" : { "type" : "string", "description" : "Email of user" }, "dateTimeFormatID" : { "type" : "integer", "format" : "int64", "description" : "Type of Date Time format" }, "timeZoneID" : { "type" : "integer", "format" : "int64", "description" : "Time zone of user" }, "localeID" : { "type" : "integer", "format" : "int64", "description" : "Locale of user" }, "authType" : { "type" : "string", "description" : "Type of authentication to be used to login by user" } } }, "UserRoles" : { "type" : "object", "required" : [ "projectID", "roleID" ], "properties" : { "projectID" : { "type" : "integer", "format" : "int64", "description" : "ID of the project" }, "roleID" : { "type" : "integer", "format" : "int64", "description" : "ID of the role" } } }, "Value" : { "type" : "object", "properties" : { "parameterValueID" : { "type" : "integer", "format" : "int64" }, "value" : { "type" : "string" } } } } }