"openapi: 3.0.1\ninfo:\n title: Tests\n description: >\n Test refers to the act of finding security issues in an application. Several types of tests can be performed on the application as per the available Entitlements (SAST, SCA and DAST are currently\n supported). The Test Manager is responsible for managing tests. It provides APIs to create, update, and fetch tests, manage artifacts related to tests.\n \n **Media type change notice**\n \n Media type names used in Polaris APIs were renamed and no longer include “synopsys”. Although media types that include “synopsys” were removed from the API specifications, existing endpoints will continue to support them until September 1, 2025. Please update your scripts to use the new media types.\n version: 1.0.0\n x-logo:\n icon: fa-wave-pulse\n primary: null\n secondary: null\n contact:\n name: Black Duck, Inc.\n url: https://polaris.blackduck.com/\nservers:\n - url: https://polaris.blackduck.com/api/test-manager\ntags:\n - name: Tests\n description: Provides various operations on tests.\n - name: Test-Artifacts\n description: Provides various operations on artifacts related to tests.\n - name: Test-Profile\n description: Provides various operations on profile related to tests.\nsecurity:\n - ApiKeyAuth: []\npaths:\n /tests:\n get:\n operationId: getTests\n tags:\n - Tests\n summary: |\n Returns all tests.\n description: |\n By default, returns all tests (up to 100 entries) created for the organization and accessible to the current user.\n parameters:\n - name: id\n in: query\n description: Filters for tests that match the specified test ID.\n schema:\n type: string\n example: 5796d731-4923-4690-b865-1482ae74403d\n - name: applicationId\n in: query\n description: Filters for tests that match the specified application ID.\n schema:\n type: string\n example: a9561105-2b70-4821-9d48-8f7dcaaacb0d\n - name: projectId\n in: query\n description: Filters for tests that match the specified project ID.\n schema:\n type: string\n example: d17552af-cedd-4839-97bc-37048b204e81\n - name: portfolioItemId\n in: query\n description: Filters for tests that match the specified portfolio-item ID.\n schema:\n type: string\n example: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n - name: portfolioSubItemId\n in: query\n description: Filters for tests that match the specified portfolio-subitem ID.\n schema:\n type: string\n example: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n - name: entitlementId\n in: query\n description: Filters for tests that match the specified entitlement ID.\n schema:\n type: string\n example: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n - name: streamId\n in: query\n description: Filter the tests that match the specified stream id.\n schema:\n type: string\n example: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n - name: startDate\n in: query\n description: Filters for tests that match the specified `startDate`. The date format is expected to be `YYYY-MM-DD`.\n schema:\n type: string\n format: date\n example: '2022-08-24'\n - name: expectedEndDate\n in: query\n description: Filters for tests that match the specified `expectedEndDate`. The date format is expected to be `YYYY-MM-DD`.\n schema:\n type: string\n format: date\n example: '2022-08-25'\n - name: testMode\n in: query\n description: Filters for tests that match the specified test mode.\n schema:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n example: SOURCE_UPLOAD\n - name: scanMode\n in: query\n description: Filters for tests that match the specified scan mode.\n schema:\n type: string\n enum:\n - ANALYSIS_ONLY\n - MATCHING_ONLY\n - CAPTURE_ANALYSIS\n - SCANNING_MATCHING\n - NOT_APPLICABLE\n example: ANALYSIS_ONLY\n - name: toolId\n in: query\n description: Filters for tests that match the specified `toolId`.\n schema:\n type: string\n example: Coverity:Recommended\n - name: shortId\n in: query\n description: Returns short test id\n schema:\n type: string\n example: FFFF000\n - name: branchId\n in: query\n description: Filters for tests that match the specified `branchId`.\n schema:\n type: string\n format: UUID\n example: 31c86a51-dcb3-4161-adbb-777a4ec5a349\n - name: profileId\n in: query\n description: Filters for tests that match the specified `profileId`.\n schema:\n type: string\n format: UUID\n example: 31c86a51-dcb3-4161-adbb-777a4ec5a349\n - name: triage\n in: query\n description: Filters for tests that match the specified triage. Accepted values are REQUIRED, NOT_REQUIRED, NOT_ENTITLED.\n schema:\n type: string\n enum:\n - REQUIRED\n - NOT_REQUIRED\n - NOT_ENTITLED\n example: REQUIRED\n - name: _sort\n in: query\n description: >-\n Sorts the collection on the provided attributes. Default sorting uses `startDate` in `descending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc}[,{field_name}|{asc|desc}[,...]]`. Available values for sorting are `portfolioItemId`,`portfolioSubItemId`,`applicationId`, `projectId`,`entitlementId`, `streamId`,\n `state`, `startDate`, `expectedEndDate`, `toolId`, `branchId`, `testMode`, `scanMode`, `assessmentType`, `triage` and `updatedDate`.\n schema:\n type: string\n example: applicationId|asc, applicationId|desc, state|asc\n - name: _filter\n in: query\n description: >-\n Filters the collection of tests. The filter follows the RSQL syntax. Available values for filtering are `portfolioItemId`,`portfolioSubItemId`,`applicationId`, `projectId`,`entitlementId`,\n `streamId`, `state`, `startDate`, `expectedEndDate`, `toolId`, `branchId`, `testMode`, `scanMode`, `assessmentType`, `triage` and `updatedDate`. Supported operators for attributes- (==,\n !=, =in= and =out=). More details at `https://github.com/jirutka/rsql-parser`\n schema:\n type: string\n example: |\n [ \n applicationId==1d44c6d4-dde4-4c37-b068-9e7eb21c4a19,\n projectId==0a50c9ab-7c75-498e-8b18-0d695ca4ef03 and state==CANCELLED, \n projectId==0a50c9ab-7c75-498e-8b18-0d695ca4ef03 or state==CANCELLED, \n state=in=(CANCELLED,FAILED), \n updatedDate==2023-11-03T17:07:59Z, \n state=out=CANCELLED \n ]\n - name: _limit\n in: query\n description: >-\n Restricts the number of results to the given limit. The default of 100 is used if no value is provided. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad\n Request.\"\n schema:\n type: integer\n default: 100\n - name: _offset\n in: query\n description: >-\n Returns results, starting from a given position within the response. For example, if the offset is set to 5, the first four records are not returned. A default value of 0 is used if no\n value is provided. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n default: 0\n - name: _include\n in: query\n description: >-\n Accepted values for `_include` are `comments`,`artifacts`(or both). If `comments`/`artifacts` are available for the test they are returned in the response if not they will be empty. Note-\n if the include keys are not provided, the attributes are returned back as 'null'.\n schema:\n type: string\n example: _include=comments.\n responses:\n '200':\n description: Successful response\n content:\n application/vnd.tm.tests-1+json:\n schema:\n type: object\n required:\n - _items\n - _links\n - _collection\n properties:\n _items:\n type: array\n items:\n type: object\n required:\n - id\n - shortId\n - state\n - applicationId\n - projectId\n - createdDate\n - startDate\n - testDuration\n - testMode\n properties:\n id:\n type: string\n format: uuid\n description: Unique test identifier.\n applicationId:\n type: string\n format: uuid\n description: The application identifier for the test.\n projectId:\n type: string\n format: uuid\n description: The project identifier for the test.\n entitlementId:\n type: string\n format: uuid\n description: The entitlement identifier for the test.\n shortId:\n type: string\n description: The short identifier for the test.\n state:\n type: object\n required:\n - name\n - progress\n properties:\n name:\n type: string\n enum:\n - New\n - Queuing\n - Pending SNPS\n - In Progress\n - Scanning\n - Scanning & Publishing\n - Cancelled\n - Failed\n - Completed\n - Not Run\n - Pending Review\n description: The name of the test state.\n example: Queuing\n description:\n type: string\n description: The brief summary of the state and details about the state, like operations allowed.\n progress:\n type: integer\n description: Overall progress of the test in percentage.\n error:\n type: boolean\n description: Indicates if there is an error in the test.\n manualInterventionRequired:\n type: boolean\n description: Indicates if there is a manual intervention expected.\n operations:\n type: array\n description: Allowed operations on the test in the current state.\n items:\n type: string\n errorDetail:\n type: string\n description: The details about the error state of the test.\n operationInfo:\n type: string\n description: The details about the reason for states.\n description: The state of the test.\n artifacts:\n type: array\n description: Specify the artifacts to be used while scanning for issues. Optional when `assessmentType` = CI or SCM\n items:\n properties:\n id:\n type: string\n format: uuid\n description: Specify the artifact-id to be used while scanning for issues.\n type:\n type: string\n enum:\n - SOURCE_CODE\n description: Specify the artifact-type to be used while scanning for issues.\n testDuration:\n type: integer\n format: int64\n description: Time for the test to complete, in milliseconds.\n createdDate:\n type: string\n format: date-time\n description: The creation date of the test\n comments:\n type: array\n description: A list of comments associated with the test.\n items:\n type: object\n required:\n - id\n - testId\n - createdBy\n - createdDate\n - commentText\n - stateChange\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier for the comment.\n testId:\n type: string\n format: uuid\n description: Unique identifier for the test.\n createdBy:\n type: string\n format: uuid\n description: Unique identifier for the user who created the comment.\n createdDate:\n type: string\n format: date-time\n description: The date and time when the comment was created.\n updatedBy:\n type: string\n format: uuid\n nullable: true\n description: Unique identifier for the user who last updated the comment.\n updatedDate:\n type: string\n format: date-time\n nullable: true\n description: The date and time when the comment was last updated.\n commentText:\n type: string\n description: The text of the comment.\n maximum: 256\n stateChange:\n type: boolean\n description: Indicates if there was a state change.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef03\n testId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n createdBy: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedBy: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n updatedDate: '2021-07-29T14:30:33.067Z'\n commentText: Assessor comment ...\n stateChange: false\n startDate:\n type: string\n format: date-time\n description: The date the test began.\n expectedEndDate:\n type: string\n format: date-time\n description: The expected end date of the test\n notes:\n type: string\n maximum: 1024\n portfolioItemId:\n type: string\n format: uuid\n portfolioSubItemId:\n type: string\n format: uuid\n streamId:\n type: string\n format: uuid\n testMode:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n scanMode:\n type: string\n assessmentType:\n type: string\n toolId:\n type: string\n prevTestId:\n type: string\n branchId:\n type: string\n format: uuid\n triage:\n type: string\n profileDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef04\n applicationId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n projectId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n entitlementId: adeeebb4-a398-4f31-98d0-0fc811c5fda9\n shortId: ST4E3ZC\n state:\n name: Queuing\n description: Test is in Queuing state\n progress: 25\n error: false\n manualInterventionRequired: false\n operationInfo: This test is yet to be allocated a 'scanner' to begin execution\n operations:\n - Cancel\n errorDetail: Artifact Validation Failed due to invalid file-size, expected range[1byte - 2Gb]\n artifacts:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n type: SOURCE_CODE\n - id: 0ad95df7-2c70-4d91-8233-4df8d70aa812\n type: SOURCE_CODE\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedDate: '2021-07-29T14:30:33.067Z'\n startDate: '2021-07-29T14:30:33.067Z'\n expectedEndDate: '2021-07-29T14:30:33.067Z'\n testDuration: 154000\n notes: Really big notes...\n portfolioItemId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n portfolioSubItemId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n streamId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n testMode: SOURCE_UPLOAD\n scanMode: CAPTURE_ANALYSIS\n assessmentType: SAST\n toolId: Coverity:Recommended\n prevTestId: 0ad95df7-2c70-4d91-8233-4df8d71ab822\n branchId: 31c86a51-dcb3-4161-adbb-777a4ec5a349\n triage: REQUIRED\n _links:\n type: array\n items:\n type: array\n items:\n type: object\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: http://contoso.com/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: http://contoso.com/?_offset=10&_limit=10\n rel: prev\n method: GET\n - href: http://contoso.com/?_offset=30&_limit=10\n rel: next\n method: GET\n - href: http://contoso.com/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: http://contoso.com/?_offset=1000&_limit=10\n rel: last\n method: GET\n _collection:\n required:\n - itemCount\n - pageCount\n - currentPage\n properties:\n itemCount:\n type: integer\n format: int32\n pageCount:\n type: integer\n format: int32\n currentPage:\n type: integer\n format: int32\n _type:\n type: string\n example:\n itemCount: 1\n pageCount: 10\n currentPage: 3\n _type: test\n '400':\n description: Bad request. Note that ID attributes in _filter are not validated for UUID formats.\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n examples:\n Unrecognized:\n value:\n type: urn:x-test-manager:Bad-Request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed queryParameter is not recognized\n Invalid Input:\n value:\n type: urn:x-test-manager:Bad-Request\n title: Bad request\n status: 400\n detail: Request cannot be processed, Invalid Input\n '401':\n description: Unauthorized\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted\n '403':\n description: Forbidden\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource\n '404':\n description: Not found\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found\n '500':\n description: Internal server error\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request\n '503':\n description: Service unavailable\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Unavailable\n title: Service unavailable\n status: 503\n detail: Unexpected error occurred in processing the request\n '504':\n description: Gateway timeout\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Gateway-Timeout\n title: Gateway Timeout\n status: 504\n detail: Error occurred in processing the request within the default timeout\n post:\n operationId: createTests\n tags:\n - Tests\n summary: |\n Creates new tests.\n description: |\n Creates tests in accordance with the available entitlements or assementTypes. If multiple entitlements/assementTypes are provided, a separate test is created for each.\n\n\n **Compatibility matrix for test mode, scan mode, and artifact type:**\n\n | Assessment Type | Test Mode | Scan Mode | Artifact Type |\n |---------------------------|---------------------------|-------------------|-------------------------------------|\n | SAST | SOURCE_UPLOAD | CAPTURE_ANALYSIS | SOURCE_CODE |\n | SAST | SCM | CAPTURE_ANALYSIS | SOURCE_CODE | \n | SAST | CI | ANALYSIS_ONLY | TOOL_CAPTURE, TOOL_ERROR, CLI_ERROR | \n | SCA | SOURCE_UPLOAD | CAPTURE_ANALYSIS | SOURCE_CODE | \n | SCA | SCM | SCANNING_MATCHING | SOURCE_CODE | \n | SCA | CI | MATCHING_ONLY | TOOL_CAPTURE, TOOL_ERROR, CLI_ERROR | \n | SCA | CI | SCA_SIGNATURE | TOOL_CAPTURE, TOOL_ERROR, CLI_ERROR | \n | SCA | CI | SCA_PACKAGE | TOOL_CAPTURE, TOOL_ERROR, CLI_ERROR | \n | DAST | DAST_WEBAPP | DYNAMIC_TEST | PROFILE_SETTING | \n | DAST | DAST_PREFLIGHT | DYNAMIC-PREFLIGHT | PROFILE_SETTING | \n | DAST | DAST_API | DYNAMIC_TEST | PROFILE_SETTING, APP_SPEC | \n | DAST | DAST_API_PREFLIGHT | DYNAMIC-PREFLIGHT | PROFILE_SETTING, APP_SPEC | \n \n \n **Compatibility matrix for bulk test creation:**\n\n | Assessment Type | SAST | SCA | DAST |\n |---------------------------|--------|---------|-------------|\n | SAST | NO | YES | NO |\n | SCA | YES | NO | NO | \n | DAST | NO | NO | YES |\n requestBody:\n required: true\n content:\n application/vnd.tm.tests-bulk-1+json:\n schema:\n type: object\n required:\n - portfolioItemId\n properties:\n applicationId:\n type: string\n format: uuid\n description: Specifies the `applicationId` the test must use.\n projectId:\n type: string\n format: uuid\n description: Specifies the `projectId` the test must use.\n entitlementIds:\n type: array\n description: Specifies one or more `entitlementId`s to use for creating tests. Optional when `assessmentType` is CI or SCM.\n items:\n type: string\n format: uuid\n artifacts:\n type: array\n description: Specifies the artifacts to be used while scanning for issues. Optional when `assessmentType` is CI or SCM.\n items:\n type: string\n format: uuid\n artifactId:\n type: string\n format: uuid\n description: Specify the `artifactId` to be used while scanning for issues. Optional when `assessmentType` is CI or SCM.\n deprecated: true\n notes:\n type: string\n maxLength: 1024\n description: Optionally add any notes or a description for the test.\n portfolioItemId:\n type: string\n format: uuid\n description: Specify the `portfolioItemId` the test must use.\n portfolioSubItemId:\n type: string\n format: uuid\n description: Specify the `portfolioSubItemId` the test must use.\n assessmentTypes:\n type: array\n description: Specify the assessment-types to use for creating tests when `assessmentType` is CI or SCM. Optional when `entitlementId`s are provided.\n items:\n type: string\n enum:\n - SAST\n - SCA\n - DAST\n testMode:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n scanMode:\n type: string\n enum:\n - ANALYSIS_ONLY\n - MATCHING_ONLY\n - CAPTURE_ANALYSIS\n - SCANNING_MATCHING\n - DYNAMIC_TEST\n - DYNAMIC_PREFLIGHT\n - NOT_APPLICABLE\n description: >\n Optional to specify the scanMode, value is deduced based on test mode and assessment type if not provided.\n\n Valid combination with scanMode is : [ANALYSIS_ONLY : [testMode = CI, assessmentType = SAST], CAPTURE_ANALYSIS : [testMode = SOURCE_UPLOAD, assessmentType = SAST], \n CAPTURE_ANALYSIS : [testMode = SCM, assessmentType = SAST], MATCHING_ONLY : [testMode = CI, assessmentType = SCA], SCA_PACKAGE : [testMode = CI, assessmentType = SCA],\n SCANNING_MATCHING : [testMode = SOURCE_UPLOAD, assessmentType = SCA], SCANNING_MATCHING : [testMode = SCM, assessmentType = SCA]]\n branchId:\n type: string\n format: uuid\n description: Optional to specify the `branchId` the test must use, a default value is derived via the portfolioSubItem. Also,if `testMode` is SCM, the branch-source must be SCM.\n triage:\n type: string\n enum:\n - REQUIRED\n - NOT_REQUIRED\n - NOT_ENTITLED\n description: >-\n Optional, Specify a value (NOT_REQUIRED) when 'triage' is not required. Defaults to REQUIRED for an entitlement whose Triage-Mode is 'Always Triage'. For other entitlements the\n default value is NOT_ENTITLED.\n profileDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n content:\n type: string\n format: string\n description: DAST Project Profile contents.\n description: For a DAST-type test, an ID is compulsory for tests with the DAST_WEBAPP mode. However, for the DAST_PREFLIGHT mode, you can provide either an ID or content.\n example:\n applicationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n projectId: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n artifacts:\n - 6cd85f64-5717-4562-b3fc-2c963f66afdb\n notes: This scan is for FooBar project, release 2021.09\n portfolioItemId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n portfolioSubItemId: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n assessmentTypes:\n - SAST\n testMode: SOURCE_UPLOAD\n branchId: 56b00012-286b-4f25-a97c-50dbab82d506\n triage: REQUIRED\n examples:\n SAST:\n description: Example of a create test request for SAST assessment type\n value:\n applicationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n projectId: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n artifacts:\n - 6cd85f64-5717-4562-b3fc-2c963f66afda\n notes: This scan is for FooBar project, release 2021.09\n portfolioItemId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n portfolioSubItemId: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n assessmentTypes:\n - SAST\n testMode: SOURCE_UPLOAD\n branchId: 56b00012-286b-4f25-a97c-50dbab82d506\n triage: REQUIRED\n SCA:\n description: Example of a create test request for SCA assessment type. Signature scans under SCA can only be created for CI test mode.\n value:\n applicationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n projectId: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n artifacts:\n - 6cd85f64-5717-4562-b3fc-2c963f66afdb\n notes: This scan is for FooBar project, release 2021.09\n portfolioItemId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n portfolioSubItemId: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n assessmentTypes:\n - SCA\n testMode: SOURCE_UPLOAD\n branchId: 56b00012-286b-4f25-a97c-50dbab82d506\n triage: REQUIRED\n scanMode: SCANNING_MATCHING\n DAST - Webapp:\n description: Example of a create test request for DAST assessment type\n value:\n applicationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n projectId: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n notes: This scan is for FooBar project, release 2021.09\n portfolioItemId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n portfolioSubItemId: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n assessmentTypes:\n - DAST\n testMode: DAST_WEBAPP\n scanMode: DYNAMIC_TEST\n profileDetails:\n id: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n DAST WebApp - Preflight:\n description: Example of a preflight create test request for DAST assessment type\n value:\n applicationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n notes: This scan is for FooBar project, release 2021.09\n portfolioItemId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n portfolioSubItemId: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n assessmentTypes:\n - DAST\n testMode: DAST_PREFLIGHT\n profileDetails:\n content: >-\n {\"name\":\"test005\",\"description\":\"test\",\"subItemType\":\"DAST\",\"entryPointUrl\":\"http://example.com\",\"profile\":{\"name\":\"123 Main St\",\"allowedHosts\":\"Springfield,\n test\",\"performActiveAttack\":true,\"authentication\":{\"type\":\"v0\",\"mode\":\"SIMPLE_FORM\",\"loginUrl\":\"http://example.com\",\"simpleFormSetting\":{\"fields\":{\"userName\":\"abc\",\"password\":\"password\"}}}}}\n DAST - API:\n description: Example of a create test request for DAST assessment type and DAST_API test mode.\n value:\n applicationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n projectId: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n notes: This scan is for FooBar project, release 2021.09\n portfolioItemId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n portfolioSubItemId: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n assessmentTypes:\n - DAST\n testMode: DAST_API\n profileDetails:\n id: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n type: api\n DAST API - Preflight:\n description: Example of a preflight create test request for DAST assessment type and DAST_API test mode.\n value:\n applicationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n notes: This scan is for FooBar project, release 2021.09\n portfolioItemId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n assessmentTypes:\n - DAST\n testMode: DAST_API_PREFLIGHT\n profileDetails:\n content: >-\n {\"entryPointUrl\":\"https://example.com\",\"profile\":{\"name\":\"test\n preflight\",\"type\":\"API\",\"apiSource\":{\"format\":\"postman\",\"specUrl\":\"https://example.com\"},\"manualEntry\":{\"authentication\":{\"mode\":\"None\"}}}}\n responses:\n '207':\n description: Tests were created successfully. The response contains multiple individual responses, each with its own status, headers, and body within the array.\n content:\n application/vnd.tm.tests-bulk-1+json:\n schema:\n type: object\n description: It is an array of responses, each object within the response array indicating a response all by itself complete with status, headers, and body.\n required:\n - responses\n properties:\n responses:\n type: array\n items:\n type: object\n required:\n - status\n - headers\n properties:\n status:\n type: integer\n format: int32\n description: Status code for the specific test that got created.\n headers:\n type: array\n description: Headers in the response of a test creation request.\n items:\n type: object\n description: Headers corresponding to the created test.\n additionalProperties:\n type: string\n body:\n type: object\n required:\n - id\n - shortId\n - state\n - applicationId\n - projectId\n - createdDate\n - updatedDate\n - startDate\n - testDuration\n - testMode\n properties:\n id:\n type: string\n format: uuid\n description: Unique test identifier.\n applicationId:\n type: string\n format: uuid\n description: The application identifier for the test.\n projectId:\n type: string\n format: uuid\n description: The project identifier for the test.\n entitlementId:\n type: string\n format: uuid\n description: The entitlement identifier for the test.\n shortId:\n type: string\n description: The short identifier for the test.\n state:\n type: object\n required:\n - name\n - progress\n properties:\n name:\n type: string\n enum:\n - New\n - Queuing\n - Pending SNPS\n - In Progress\n - Scanning\n - Scanning & Publishing\n - Cancelled\n - Failed\n - Completed\n - Not Run\n - Pending Review\n description: The name of the test state.\n example: Queuing\n description:\n type: string\n description: The brief summary of the state and details about the state, like operations allowed.\n progress:\n type: integer\n description: Overall progress of the test in percentage.\n error:\n type: boolean\n description: Indicates if there is an error in the test.\n manualInterventionRequired:\n type: boolean\n description: Indicates if there is a manual intervention expected.\n operations:\n type: array\n description: Allowed operations on the test in the current state.\n items:\n type: string\n errorDetail:\n type: string\n description: The details about the error state of the test.\n operationInfo:\n type: string\n description: The details about the reason for states.\n description: The state of the test.\n testDuration:\n type: integer\n format: int64\n description: Time for the test to complete, in milliseconds.\n createdDate:\n type: string\n format: date-time\n description: The creation date of the test\n startDate:\n type: string\n format: date-time\n description: The date the test began.\n expectedEndDate:\n type: string\n format: date-time\n description: The expected end date of the test\n updatedDate:\n type: string\n format: date-time\n description: The updated date of the test\n notes:\n type: string\n maximum: 1024\n description: User entered note or description on the test.\n portfolioItemId:\n type: string\n format: uuid\n description: The portfolio-item identifier for the test.\n portfolioSubItemId:\n type: string\n format: uuid\n description: The portfolio-subitem identifier for the test.\n testMode:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n scanMode:\n type: string\n description: ScanMode is deduced from testMode and type of test(SAST/SCA).\n triage:\n type: string\n description: >-\n Specify if 'Triage' is required while creating the test. If not provided, defaults to REQUIRED for SAST entitlements with triage mode set to 'Always Triage'. For other\n entitlements, defaults to NOT_ENTITLED.\n profileDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n _links:\n type: array\n items:\n type: object\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: http://contoso.com/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: http://contoso.com/?_offset=10&_limit=10\n rel: prev\n method: GET\n - href: http://contoso.com/?_offset=30&_limit=10\n rel: next\n method: GET\n - href: http://contoso.com/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: http://contoso.com/?_offset=1000&_limit=10\n rel: last\n method: GET\n error:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n status: 200\n headers:\n - Content-Type: application/vnd.tm.test-1+json\n body:\n _type: test\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef03\n shortId: ST4E3ZC\n applicationId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n projectId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n entitlementId: adeeebb4-a398-4f31-98d0-0fc811c5fda9\n state:\n name: Queuing\n description: Init state for test\n progress: 0\n error: false\n manualInterventionRequired: false\n operations: []\n errorDetail: ''\n operationInfo: ''\n artifacts:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n type: TOOL_CAPTURE\n - id: 0ad95df7-2c70-4d91-8233-4df8d70aa812\n type: CLI_LOG\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedDate: '2021-07-29T14:30:33.067Z'\n startDate: '2021-07-29T14:30:33.067Z'\n expectedEndDate: '2021-07-29T14:30:33.067Z'\n testDuration: 154000\n notes: Really big notes...\n portfolioItemId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n portfolioSubItemId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n streamId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n testMode: SOURCE_UPLOAD\n scanMode: ANALYSIS_ONLY\n toolId: Coverity:Recommended\n _links:\n - href: http://contoso.com/tests/0a50c9ab-b068-498e-b068-0d695ca4ef03\n rel: self\n method: GET\n branchId: 56b00012-286b-4f25-a97c-50dbab82d506\n triage: REQUIRED\n description: The response array containing the response objects.\n '400':\n description: Bad request\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Bad-Request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the request-body is not valid or one of the ID's specified is not valid or accessible\n '401':\n description: Unauthorized\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted\n '403':\n description: Forbidden\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource\n '415':\n description: Unsupported media-type\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:media-type-not-supported\n title: Forbidden\n status: 415\n detail: Content type 'application/vnd.tm.tests-bulk-1.json' not supported\n '500':\n description: Internal server error\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request\n '503':\n description: Service unavailable\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Unavailable\n title: Service unavailable\n status: 503\n detail: Unexpected error occurred in accepting the request, service is not available\n '504':\n description: Gateway timeout\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Gateway-Timeout\n title: Gateway Timeout\n status: 504\n detail: Error occurred in processing the request within the default timeout\n /tests/{testId}:\n patch:\n operationId: updateTest\n tags:\n - Tests\n summary: |\n Updates a test.\n description: |\n Supported actions are\n\n * RESUME - This action is supported on a test that is in WAITING_FOR_CAPTURE (when assessmentType=SAST or SCA).\n + Artifacts (artifacts) and tool information (toolId) is mandatory in the payload to perform this action on tests that have testMode=CI and assessmentType=SAST or SCA.\n * CANCEL - You can cancel the test if its current state is not one of the following: `COMPLETED`, `FAILED`, `CANCELLED`, or `NOT RUN`.\n * FAILED - This action is supported on a test that is in `WAITING_FOR_CAPTURE` for continuous integration workflows. Artifact information in the payload is not required to perform this action.\n parameters:\n - name: testId\n in: path\n description: test ID\n required: true\n schema:\n type: string\n format: uuid\n example: 0a50c9ab-b068-498e-b068-0d695ca4ef03\n requestBody:\n required: true\n content:\n application/vnd.tm.test-actions-1+json:\n schema:\n type: object\n properties:\n artifacts:\n type: array\n description: specify the artifact-id to be used while scanning for issues\n items:\n type: string\n format: uuid\n action:\n type: string\n toolId:\n type: string\n example:\n action: RESUME\n artifacts:\n - 6cd85f64-5717-4562-b3fc-2c963f66afda\n - 32d85f64-5717-4562-b3fc-2c963f66afda\n toolId: Coverity:Recommended\n responses:\n '200':\n description: Test updated successfully\n content:\n application/vnd.tm.test-actions-1+json:\n schema:\n type: object\n properties:\n body:\n oneOf:\n - type: object\n required:\n - id\n - shortId\n - state\n - applicationId\n - projectId\n - createdDate\n - startDate\n - testDuration\n - testMode\n properties:\n id:\n type: string\n format: uuid\n description: Unique test identifier.\n applicationId:\n type: string\n format: uuid\n description: The application identifier for the test.\n projectId:\n type: string\n format: uuid\n description: The project identifier for the test.\n entitlementId:\n type: string\n format: uuid\n description: The entitlement identifier for the test.\n shortId:\n type: string\n description: The short identifier for the test.\n state:\n type: object\n required:\n - name\n - progress\n properties:\n name:\n type: string\n enum:\n - New\n - Queuing\n - Pending SNPS\n - In Progress\n - Scanning\n - Scanning & Publishing\n - Cancelled\n - Failed\n - Completed\n - Not Run\n - Pending Review\n description: The name of the test state.\n example: Queuing\n description:\n type: string\n description: The brief summary of the state and details about the state, like operations allowed.\n progress:\n type: integer\n description: Overall progress of the test in percentage.\n error:\n type: boolean\n description: Indicates if there is an error in the test.\n manualInterventionRequired:\n type: boolean\n description: Indicates if there is a manual intervention expected.\n operations:\n type: array\n description: Allowed operations on the test in the current state.\n items:\n type: string\n errorDetail:\n type: string\n description: The details about the error state of the test.\n operationInfo:\n type: string\n description: The details about the reason for states.\n description: The state of the test.\n artifacts:\n type: array\n description: Specify the artifacts to be used while scanning for issues. Optional when `assessmentType` = CI or SCM\n items:\n properties:\n id:\n type: string\n format: uuid\n description: Specify the artifact-id to be used while scanning for issues.\n type:\n type: string\n enum:\n - SOURCE_CODE\n description: Specify the artifact-type to be used while scanning for issues.\n testDuration:\n type: integer\n format: int64\n description: Time for the test to complete, in milliseconds.\n createdDate:\n type: string\n format: date-time\n description: The creation date of the test\n comments:\n type: array\n description: A list of comments associated with the test.\n items:\n type: object\n required:\n - id\n - testId\n - createdBy\n - createdDate\n - commentText\n - stateChange\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier for the comment.\n testId:\n type: string\n format: uuid\n description: Unique identifier for the test.\n createdBy:\n type: string\n format: uuid\n description: Unique identifier for the user who created the comment.\n createdDate:\n type: string\n format: date-time\n description: The date and time when the comment was created.\n updatedBy:\n type: string\n format: uuid\n nullable: true\n description: Unique identifier for the user who last updated the comment.\n updatedDate:\n type: string\n format: date-time\n nullable: true\n description: The date and time when the comment was last updated.\n commentText:\n type: string\n description: The text of the comment.\n maximum: 256\n stateChange:\n type: boolean\n description: Indicates if there was a state change.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef03\n testId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n createdBy: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedBy: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n updatedDate: '2021-07-29T14:30:33.067Z'\n commentText: Assessor comment ...\n stateChange: false\n startDate:\n type: string\n format: date-time\n description: The date the test began.\n expectedEndDate:\n type: string\n format: date-time\n description: The expected end date of the test\n notes:\n type: string\n maximum: 1024\n portfolioItemId:\n type: string\n format: uuid\n portfolioSubItemId:\n type: string\n format: uuid\n streamId:\n type: string\n format: uuid\n testMode:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n scanMode:\n type: string\n assessmentType:\n type: string\n toolId:\n type: string\n prevTestId:\n type: string\n branchId:\n type: string\n format: uuid\n triage:\n type: string\n profileDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef04\n applicationId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n projectId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n entitlementId: adeeebb4-a398-4f31-98d0-0fc811c5fda9\n shortId: ST4E3ZC\n state:\n name: Queuing\n description: Test is in Queuing state\n progress: 25\n error: false\n manualInterventionRequired: false\n operationInfo: This test is yet to be allocated a 'scanner' to begin execution\n operations:\n - Cancel\n errorDetail: Artifact Validation Failed due to invalid file-size, expected range[1byte - 2Gb]\n artifacts:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n type: SOURCE_CODE\n - id: 0ad95df7-2c70-4d91-8233-4df8d70aa812\n type: SOURCE_CODE\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedDate: '2021-07-29T14:30:33.067Z'\n startDate: '2021-07-29T14:30:33.067Z'\n expectedEndDate: '2021-07-29T14:30:33.067Z'\n testDuration: 154000\n notes: Really big notes...\n portfolioItemId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n portfolioSubItemId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n streamId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n testMode: SOURCE_UPLOAD\n scanMode: CAPTURE_ANALYSIS\n assessmentType: SAST\n toolId: Coverity:Recommended\n prevTestId: 0ad95df7-2c70-4d91-8233-4df8d71ab822\n branchId: 31c86a51-dcb3-4161-adbb-777a4ec5a349\n triage: REQUIRED\n - properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n _type: test\n id: 5796d731-4923-4690-b865-1482ae74403d\n notes: hello this is notes;\n createdDate: '2021-10-01T07:48:49Z'\n startDate: '2021-10-01T07:48:49Z'\n expectedEndDate: '2021-10-01T07:48:49Z'\n projectId: 4ee75520-121b-4764-8e68-9d17b522d6bf\n applicationId: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n entitlementId: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n triage: REQUIRED\n state:\n name: New\n description: Init state for test\n progress: 0\n error: false\n manualInterventionRequired: false\n operations: []\n errorDetail: null\n operationInfo: null\n testDuration: 154000\n artifacts:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n type: TOOL_CAPTURE\n updatedDate: '2021-10-01T07:49:25Z'\n portfolioItemId: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n portfolioSubItemId: 4ee75520-121b-4764-8e68-9d17b522d6bf\n streamId: 4ee75520-121b-4764-8e68-9d17b522d6bf\n toolId: Coverity:Recommended\n _links:\n - href: http://localhost:8080/api/tests/5796d731-4923-4690-b865-1482ae74403d?_offset=0&_limit=0\n rel: self\n method: GET\n '400':\n description: Bad request\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Bad-Request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the request-body is not valid or one of the ID's specified is not valid or accessible\n '401':\n description: Unauthorized\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted\n '403':\n description: Forbidden\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource\n '404':\n description: Not Found\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Not-Found\n title: Not Found\n status: 404\n detail: Requested resource not found\n '415':\n description: Unsupported media-type\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Unsupported media-type\n title: Forbidden\n status: 415\n detail: Unsupported media-type, please retry the request with `application/vnd.tm.test-actions-1+json`\n '500':\n description: Internal server error\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred while processing the request\n '503':\n description: Service unavailable\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Unavailable\n title: Service unavailable\n status: 503\n detail: Unexpected error occurred in accepting the request. service is not available\n '504':\n description: Gateway timeout\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Gateway-Timeout\n title: Gateway Timeout\n status: 504\n detail: Error occurred in processing the request within the default timeout\n get:\n operationId: getTestById\n tags:\n - Tests\n summary: |\n Fetches details of a specified test.\n description: |\n Fetches the details of a test that matches the specified `testId`.\n parameters:\n - name: testId\n in: path\n description: Test identifier.\n required: true\n schema:\n type: string\n format: uuid\n example: 5796d731-4923-4690-b865-1482ae74403d\n responses:\n '200':\n description: Successful response\n content:\n application/vnd.tm.tests-1+json:\n schema:\n type: object\n properties:\n body:\n oneOf:\n - type: object\n required:\n - id\n - shortId\n - state\n - applicationId\n - projectId\n - createdDate\n - startDate\n - testDuration\n - testMode\n properties:\n id:\n type: string\n format: uuid\n description: Unique test identifier.\n applicationId:\n type: string\n format: uuid\n description: The application identifier for the test.\n projectId:\n type: string\n format: uuid\n description: The project identifier for the test.\n entitlementId:\n type: string\n format: uuid\n description: The entitlement identifier for the test.\n shortId:\n type: string\n description: The short identifier for the test.\n state:\n type: object\n required:\n - name\n - progress\n properties:\n name:\n type: string\n enum:\n - New\n - Queuing\n - Pending SNPS\n - In Progress\n - Scanning\n - Scanning & Publishing\n - Cancelled\n - Failed\n - Completed\n - Not Run\n - Pending Review\n description: The name of the test state.\n example: Queuing\n description:\n type: string\n description: The brief summary of the state and details about the state, like operations allowed.\n progress:\n type: integer\n description: Overall progress of the test in percentage.\n error:\n type: boolean\n description: Indicates if there is an error in the test.\n manualInterventionRequired:\n type: boolean\n description: Indicates if there is a manual intervention expected.\n operations:\n type: array\n description: Allowed operations on the test in the current state.\n items:\n type: string\n errorDetail:\n type: string\n description: The details about the error state of the test.\n operationInfo:\n type: string\n description: The details about the reason for states.\n description: The state of the test.\n artifacts:\n type: array\n description: Specify the artifacts to be used while scanning for issues. Optional when `assessmentType` = CI or SCM\n items:\n properties:\n id:\n type: string\n format: uuid\n description: Specify the artifact-id to be used while scanning for issues.\n type:\n type: string\n enum:\n - SOURCE_CODE\n description: Specify the artifact-type to be used while scanning for issues.\n testDuration:\n type: integer\n format: int64\n description: Time for the test to complete, in milliseconds.\n createdDate:\n type: string\n format: date-time\n description: The creation date of the test\n comments:\n type: array\n description: A list of comments associated with the test.\n items:\n type: object\n required:\n - id\n - testId\n - createdBy\n - createdDate\n - commentText\n - stateChange\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier for the comment.\n testId:\n type: string\n format: uuid\n description: Unique identifier for the test.\n createdBy:\n type: string\n format: uuid\n description: Unique identifier for the user who created the comment.\n createdDate:\n type: string\n format: date-time\n description: The date and time when the comment was created.\n updatedBy:\n type: string\n format: uuid\n nullable: true\n description: Unique identifier for the user who last updated the comment.\n updatedDate:\n type: string\n format: date-time\n nullable: true\n description: The date and time when the comment was last updated.\n commentText:\n type: string\n description: The text of the comment.\n maximum: 256\n stateChange:\n type: boolean\n description: Indicates if there was a state change.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef03\n testId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n createdBy: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedBy: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n updatedDate: '2021-07-29T14:30:33.067Z'\n commentText: Assessor comment ...\n stateChange: false\n startDate:\n type: string\n format: date-time\n description: The date the test began.\n expectedEndDate:\n type: string\n format: date-time\n description: The expected end date of the test\n notes:\n type: string\n maximum: 1024\n portfolioItemId:\n type: string\n format: uuid\n portfolioSubItemId:\n type: string\n format: uuid\n streamId:\n type: string\n format: uuid\n testMode:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n scanMode:\n type: string\n assessmentType:\n type: string\n toolId:\n type: string\n prevTestId:\n type: string\n branchId:\n type: string\n format: uuid\n triage:\n type: string\n profileDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef04\n applicationId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n projectId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n entitlementId: adeeebb4-a398-4f31-98d0-0fc811c5fda9\n shortId: ST4E3ZC\n state:\n name: Queuing\n description: Test is in Queuing state\n progress: 25\n error: false\n manualInterventionRequired: false\n operationInfo: This test is yet to be allocated a 'scanner' to begin execution\n operations:\n - Cancel\n errorDetail: Artifact Validation Failed due to invalid file-size, expected range[1byte - 2Gb]\n artifacts:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n type: SOURCE_CODE\n - id: 0ad95df7-2c70-4d91-8233-4df8d70aa812\n type: SOURCE_CODE\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedDate: '2021-07-29T14:30:33.067Z'\n startDate: '2021-07-29T14:30:33.067Z'\n expectedEndDate: '2021-07-29T14:30:33.067Z'\n testDuration: 154000\n notes: Really big notes...\n portfolioItemId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n portfolioSubItemId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n streamId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n testMode: SOURCE_UPLOAD\n scanMode: CAPTURE_ANALYSIS\n assessmentType: SAST\n toolId: Coverity:Recommended\n prevTestId: 0ad95df7-2c70-4d91-8233-4df8d71ab822\n branchId: 31c86a51-dcb3-4161-adbb-777a4ec5a349\n triage: REQUIRED\n - properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n _type: test\n id: 5796d731-4923-4690-b865-1482ae74403d\n notes: hello this is notes;\n createdDate: '2021-10-01T07:48:49Z'\n startDate: '2021-10-01T07:48:49Z'\n expectedEndDate: '2021-10-01T07:48:49Z'\n projectId: 4ee75520-121b-4764-8e68-9d17b522d6bf\n applicationId: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n entitlementId: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n shortId: FFFF000\n state:\n name: New\n description: Init state for test\n progress: 0\n error: false\n manualInterventionRequired: false\n operations: []\n errorDetail: null\n operationInfo: null\n testDuration: 154000\n artifacts:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n type: TOOL_CAPTURE\n - id: 0ad95df7-2c70-4d91-8233-4df8d70aa812\n type: CLI_LOG\n updatedDate: '2021-10-01T07:49:25Z'\n portfolioItemId: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n portfolioSubItemId: 4ee75520-121b-4764-8e68-9d17b522d6bf\n streamId: 4ee75520-121b-4764-8e68-9d17b522d6bf\n branchId: 31c86a51-dcb3-4161-adbb-777a4ec5a349\n testMode: SOURCE_UPLOAD\n scanMode: CAPTURE_ANALYSIS\n toolId: Coverity:Recommended\n triage: REQUIRED\n assessmentType: SAST\n _links:\n - href: http://localhost:8080/api/tests/5796d731-4923-4690-b865-1482ae74403d\n rel: self\n method: GET\n '400':\n description: Bad request\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Bad-Request\n title: Bad request\n status: 400\n detail: Please provide valid UUID for test Id field\n '401':\n description: Unauthorized\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted\n '403':\n description: Forbidden\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource\n '404':\n description: Not Found\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Not-Found\n title: Not Found\n status: 404\n detail: No matching records found for testId - 5796d731-4923-4690-b865-1482ae74403d\n '500':\n description: Internal server error\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Error\n title: Internal server error\n status: 500\n detail: Not able to get test data\n '503':\n description: Service unavailable\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Unavailable\n title: Service unavailable\n status: 503\n detail: Unexpected error occurred in accepting the request, service is not available\n '504':\n description: Gateway timeout\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Gateway-Timeout\n title: Gateway Timeout\n status: 504\n detail: Error occurred in processing the request within the default timeout\n /tests/{testId}/comments:\n get:\n operationId: getCommentsByTestId\n tags:\n - Tests\n summary: |\n Fetches comments of a test.\n description: Use `testId` to specify one test. A maximum of 500 entries are returned and these entries are sorted by the created date in descending order.\n parameters:\n - name: testId\n in: path\n description: Test identifier\n required: true\n schema:\n type: string\n format: uuid\n example: 5796d731-4923-4690-b865-1482ae74403d\n responses:\n '200':\n description: Successful response\n content:\n application/vnd.tm.test-comments-1+json:\n schema:\n type: object\n properties:\n _items:\n type: array\n items:\n type: object\n required:\n - id\n - testId\n - createdBy\n - createdDate\n - commentText\n - stateChange\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier for the comment.\n testId:\n type: string\n format: uuid\n description: Unique identifier for the test.\n createdBy:\n type: string\n format: uuid\n description: Unique identifier for the user who created the comment.\n createdDate:\n type: string\n format: date-time\n description: The date and time when the comment was created.\n updatedBy:\n type: string\n format: uuid\n nullable: true\n description: Unique identifier for the user who last updated the comment.\n updatedDate:\n type: string\n format: date-time\n nullable: true\n description: The date and time when the comment was last updated.\n commentText:\n type: string\n description: The text of the comment.\n maximum: 256\n stateChange:\n type: boolean\n description: Indicates if there was a state change.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef03\n testId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n createdBy: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedBy: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n updatedDate: '2021-07-29T14:30:33.067Z'\n commentText: Assessor comment ...\n stateChange: false\n _collection:\n properties:\n itemCount:\n type: integer\n format: int32\n pageCount:\n type: integer\n format: int32\n currentPage:\n type: integer\n format: int32\n _type:\n type: string\n example:\n itemCount: 1\n pageCount: 10\n currentPage: 3\n _type: comment\n _links:\n type: array\n items:\n type: array\n items:\n type: object\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: http://contoso.com/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: http://contoso.com/?_offset=10&_limit=10\n rel: prev\n method: GET\n - href: http://contoso.com/?_offset=30&_limit=10\n rel: next\n method: GET\n - href: http://contoso.com/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: http://contoso.com/?_offset=1000&_limit=10\n rel: last\n method: GET\n '400':\n description: Bad request\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n examples:\n Invalid Input:\n value:\n type: urn:x-test-manager:Bad-Request\n title: Bad request\n status: 400\n detail: Please provide valid UUID for test Id field\n '401':\n description: Unauthorized\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted\n '403':\n description: Forbidden\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource\n '404':\n description: Not found\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Not-Found\n title: Not found\n status: 404\n detail: No matching records found for testId - 5796d731-4923-4690-b865-1482ae74403d\n '500':\n description: Internal server error\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request\n '503':\n description: Service unavailable\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Unavailable\n title: Service unavailable\n status: 503\n detail: Unexpected error occurred in processing the request\n '504':\n description: Gateway timeout\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Gateway-Timeout\n title: Gateway Timeout\n status: 504\n detail: Error occurred in processing the request within the default timeout\n /tests/{testId}/test-metrics:\n get:\n operationId: getTestMetricsByTestId\n tags:\n - Tests\n summary: |\n Fetches metrics of a specified test.\n description: >\n Fetches metrics for a test that matches the specified `testId`. Metrics include lines of code, total number of files captured, count of files captured by type, total number of files analyzed\n and duration of the scan.\n\n **Note:** These metrics would be `null` for tests with assessment types other than SAST.\n parameters:\n - name: testId\n in: path\n description: The test identifier.\n required: true\n schema:\n type: string\n format: uuid\n example: 5796d731-4923-4690-b865-1482ae74403d\n responses:\n '200':\n description: Successful response\n content:\n application/vnd.tm.test-metrics-1+json:\n schema:\n type: object\n properties:\n body:\n oneOf:\n - type: object\n properties:\n testId:\n type: string\n format: uuid\n description: Unique identifier of the test.\n linesOfCode:\n type: integer\n format: int32\n description: Total number of lines of code analyzed in the project.\n totalFilesCaptured:\n type: integer\n format: int32\n description: Total number of captured files.\n filesCapturedByType:\n type: object\n additionalProperties:\n type: integer\n description: Set of total number of files captured, by type.\n totalFilesAnalyzed:\n type: integer\n format: int32\n description: Total number of analyzed files.\n analysisDuration:\n type: integer\n format: int64\n description: Time required for analysis to complete, in milliseconds.\n example:\n testId: 5796d731-4923-4690-b865-1482ae74403d\n linesOfCode: 646783\n - properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n _type: metrics\n testId: 5796d731-4923-4690-b865-1482ae74403d\n linesOfCode: 4587487\n totalFilesCaptured: 26\n filesCapturedByType:\n .jar: 21\n .txt: 1\n .xml: 1\n .java: 2\n .properties: 1\n totalFilesAnalyzed: 26\n analysisDuration: 64830\n _links: []\n '400':\n description: Bad request\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n examples:\n Invalid Input:\n value:\n type: urn:x-test-manager:Bad-Request\n title: Bad request\n status: 400\n detail: Please provide valid UUID for Test Id field\n '401':\n description: Unauthorized\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted\n '403':\n description: Forbidden\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource\n '404':\n description: Not found\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Not-Found\n title: Not found\n status: 404\n detail: No matching records found for testId - 5796d731-4923-4690-b865-1482ae74403d\n '500':\n description: Internal server error\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request\n '503':\n description: Service unavailable\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Unavailable\n title: Service unavailable\n status: 503\n detail: Unexpected error occurred in processing the request\n '504':\n description: Gateway timeout\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Gateway-Timeout\n title: Gateway Timeout\n status: 504\n detail: Error occurred in processing the request within the default timeout\n /tests/artifacts:\n post:\n operationId: createArtifact\n tags:\n - Test-Artifacts\n summary: |\n Creates an artifact that can be used for testing.\n description: >\n Use in conjunction with APIs that create tests (POST /tests) or update tests (PATCH /tests​/{testId}). If a test has run into issues and entered a paused state, use the same API to upload a\n new artifact.\n\n **Note:**\n * This API doesn't upload file-contents but returns a URL in `response.signedUrl` that can be used to upload the file-contents.\n \n * Use the **signedUrl** to perform a PUT operation and pass the file contents along.\n Example below :\n ```\n curl -v --upload-file file-on-the-disk.zip \\\n -H \"content-disposition:attachment;filename=file-on-the-disk.zip\" \\\n -H \"content-encoding:zip\" -H \"content-type:application/zip\" \\\n -H \"origin:https://polaris.blackduck.com/api/test-manager/tests\" \\\n -H \"x-goog-content-length-range:100,136840\" \\\n -H \"x-goog-hash:md5=Qubve08nhwspElM4Uf6q1Q==\" \\\n -H \"x-goog-meta-artifact-type:CUSTOMER\" \\\n -H \"x-goog-resumable:start\"\\\n \"<response.signedUrl>\"\n ```\n * The value of **fileHash** should be a Base64-encoded \n * We use `gsutil` to calculate hash. For reference: `https://cloud.google.com/storage/docs/gsutil/commands/hash`\n * Use the value generated in md5 from the response.\n * Example to generate the fileHash using command: \n ``` \n ~/sources/sigug/WebGoat/.github [main] $ gsutil hash -m dependabot.yml\n Hashes [base64] for dependabot.yml:\n Hash (md5): snzADfKbKdkcxc0HDZnAnA==\n Operation completed over 1 objects/352.0 B.\n ```\n requestBody:\n required: true\n content:\n application/vnd.tm.test-artifacts-1+json:\n schema:\n type: object\n properties:\n fileName:\n type: string\n description: This is the name of the file, including extension, that will be uploaded for testing\n fileHash:\n type: string\n description: This is Base64-encoded MD5 hash.\n fileSize:\n type: string\n format: long\n description: This is the size of the file in bytes.\n entitlementId:\n type: string\n format: uuid\n description: The entitlement identifier for the test (not required for CI use case).\n assessmentType:\n type: string\n description: The assessment type for the test (required for CI use case only).\n artifactType:\n type: string\n description: The type of the artifact. It can be SOURCE_CODE, TOOL_CAPTURE, CLI_LOG, CLI_ERROR or THIRD_PARTY_RESULTS.\n createdAt:\n type: string\n format: date-time\n description: Created datetime of the artifact. It is an optional field. Use the ISO 8601 standard for expressing datetime. More details are here `https://en.wikipedia.org/wiki/ISO_8601#Times`\n example:\n fileName: sample.zip\n fileHash: ehdsg8Rx/21ZjOP1DDOwbw==\n fileSize: '1024'\n entitlementId: adeeebb4-a398-4f31-98d0-0fc811c5fda9\n artifactType: SOURCE_CODE\n createdAt: '2017-01-15T01:30:15.010Z'\n responses:\n '200':\n description: Artifact created successfully\n content:\n application/vnd.tm.test-artifacts-1+json:\n schema:\n type: object\n properties:\n artifactId:\n type: string\n format: uuid\n signedUrl:\n type: string\n createdAt:\n type: string\n format: date-time\n _links:\n type: array\n items:\n type: object\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: http://contoso.com/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: http://contoso.com/?_offset=10&_limit=10\n rel: prev\n method: GET\n - href: http://contoso.com/?_offset=30&_limit=10\n rel: next\n method: GET\n - href: http://contoso.com/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: http://contoso.com/?_offset=1000&_limit=10\n rel: last\n method: GET\n example:\n _type: artifact\n artifactId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n signedUrl: https://storage.googleapis.com/example-bucket/12345678910/7ffd3936-0309-4a10-b48c-a924143a0673.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=foo-bar\n createdAt: '2017-01-15T01:30:15.010Z'\n _links:\n - href: https://contoso.com/api/test-manager/tests/artifacts/3fa85f64-5717-4562-b3fc-2c963f66afa6\n rel: self\n method: GET\n '400':\n description: Bad request\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Bad-Request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the request-body is not valid or file metadata is not valid\n '401':\n description: Unauthorized\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted\n '403':\n description: Forbidden\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource\n '415':\n description: Unsupported media-type\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Unsupported media-type\n title: Forbidden\n status: 415\n detail: Unsupported media-type, please retry the request with `application/vnd.tm.test-artifacts-1+json`\n '500':\n description: Internal server error\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request\n '503':\n description: Service unavailable\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Unavailable\n title: Service unavailable\n status: 503\n detail: Unexpected error occurred in accepting the request, service is not available\n '504':\n description: Gateway timeout\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Gateway-Timeout\n title: Gateway Timeout\n status: 504\n detail: Error occurred in processing the request within the default timeout\n /tests/{testId}/artifacts:\n get:\n operationId: getAllArtifactsByTestId\n tags:\n - Test-Artifacts\n summary: |\n Fetches output artifacts for a test that matches the specified `testId`. **Note:** Only SCREENSHOT artifact-type is listed.\n description: Fetches artifacts metadata for a test that matches the specified `testId`.\n parameters:\n - name: testId\n in: path\n description: Test identifier\n required: true\n schema:\n type: string\n format: uuid\n example: 5796d731-4923-4690-b865-1482ae74403d\n responses:\n '200':\n description: Successful response\n content:\n application/vnd.tm.test-list-artifacts-1+json:\n schema:\n type: object\n properties:\n _items:\n type: array\n items:\n type: object\n properties:\n body:\n description: The body containing the list of Artifact metadata fetched.\n oneOf:\n - type: object\n properties:\n _items:\n type: array\n items:\n type: array\n items:\n properties:\n id:\n type: string\n format: uuid\n description: Unique artifact identifier.\n fileName:\n type: string\n description: The fileName for the artifact.\n fileSize:\n type: integer\n description: The file size for the artifact.\n fileHash:\n type: string\n description: The file hash value for the artifact.\n artifactType:\n type: string\n description: The type of the artifact.\n createdAt:\n type: string\n description: The timestamp for the artifact creation.\n - properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n _items:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n fileName: test.zip\n fileSize: 100\n fileHash: abcde\n artifactType: TOOL\n createdAt: '1970-01-01T00:00:00Z'\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920882\n fileName: test1.zip\n fileSize: 200\n fileHash: abcdef\n artifactType: TOOL\n createdAt: '1970-01-01T00:00:00Z'\n _collection:\n properties:\n itemCount:\n type: integer\n format: int32\n pageCount:\n type: integer\n format: int32\n currentPage:\n type: integer\n format: int32\n _type:\n type: string\n example:\n itemCount: 1\n pageCount: 10\n currentPage: 3\n _type: artifact\n _links:\n type: array\n items:\n type: array\n items:\n type: object\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: http://contoso.com/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: http://contoso.com/?_offset=10&_limit=10\n rel: prev\n method: GET\n - href: http://contoso.com/?_offset=30&_limit=10\n rel: next\n method: GET\n - href: http://contoso.com/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: http://contoso.com/?_offset=1000&_limit=10\n rel: last\n method: GET\n '400':\n description: Bad request\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n examples:\n Invalid Input:\n value:\n type: urn:x-test-manager:Bad-Request\n title: Bad request\n status: 400\n detail: Please provide valid UUID for Test Id field\n '401':\n description: Unauthorized\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted\n '403':\n description: Forbidden\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource\n '404':\n description: Not found\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Not-Found\n title: Not found\n status: 404\n detail: No matching records found for testId - 5796d731-4923-4690-b865-1482ae74403d\n '500':\n description: Internal server error\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request\n '503':\n description: Service unavailable\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Unavailable\n title: Service unavailable\n status: 503\n detail: Unexpected error occurred in processing the request\n '504':\n description: Gateway timeout\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Gateway-Timeout\n title: Gateway Timeout\n status: 504\n detail: Error occurred in processing the request within the default timeout\n /tests/{testId}/artifacts/{artifactId}:\n get:\n operationId: getArtifactByTestId\n tags:\n - Test-Artifacts\n summary: |\n Download the artifact content for a specified test-id and artifact-id.\n description: >\n This API enables the file to be downloaded for the specified testId and artifactId. Note: Only SCREENSHOT artifact-type is supported to be downloaded and the artifact-id can be retrieved by\n calling the GET /tests/{id}/artifacts.\n parameters:\n - name: testId\n in: path\n description: The test identifier.\n required: true\n schema:\n type: string\n format: uuid\n example: 0a50c9ab-b068-498e-b068-0d695ca4ef03\n - name: artifactId\n in: path\n description: The artifact identifier.\n required: true\n schema:\n type: string\n format: uuid\n example: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n responses:\n '200':\n description: Successful response\n content:\n application/octet-stream:\n schema:\n type: string\n format: binary\n '400':\n description: Bad request\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n examples:\n Invalid Input:\n value:\n type: urn:x-test-manager:Bad-Request\n title: Bad request\n status: 400\n detail: Please provide valid UUID for Test Id field\n '401':\n description: Unauthorized\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted\n '403':\n description: Forbidden\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource\n '404':\n description: Not found\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Not-Found\n title: Not found\n status: 404\n detail: No matching records found for testId - 5796d731-4923-4690-b865-1482ae74403d\n '500':\n description: Internal server error\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request\n '503':\n description: Service unavailable\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Unavailable\n title: Service unavailable\n status: 503\n detail: Unexpected error occurred in processing the request\n '504':\n description: Gateway timeout\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Gateway-Timeout\n title: Gateway Timeout\n status: 504\n detail: Error occurred in processing the request within the default timeout\n /tests/metrics:\n get:\n operationId: getTestMetrics\n tags:\n - Tests\n summary: |\n Fetches test metrics grouped per subscription. This returns back pages of the data depending on the limit and offset. We also support sorting on the basis of response fields.\n description: This API is used to fetch metrics data for all the subscriptions.\n parameters:\n - name: _filter\n in: query\n description: |\n Filter the metrics on the basis of subscriptionId. Note: Only filter 'key' supported is 'subscriptionId'.\n schema:\n type: string\n example: subscriptionId=='d381106b-6232-4035-ab48-5fcda471f265'\n responses:\n '200':\n description: Successful response\n content:\n application/vnd.tm.metrics-1+json:\n schema:\n type: object\n properties:\n _items:\n type: array\n items:\n type: array\n items:\n type: object\n properties:\n subscriptionId:\n type: string\n format: uuid\n description: The subscriptionId is obtained from the Entitlement Service.\n metrics:\n type: object\n properties:\n average:\n type: object\n properties:\n scanTime:\n type: integer\n format: int64\n description: Average test completion time in seconds over the lifetime of the subscription.\n queuingTime:\n type: integer\n format: int64\n description: Average time the tests stay in 'queuing' state over the lifetime of subscription reported in Seconds.\n testsCount:\n type: integer\n format: int64\n description: Average number of tests created over the lifetime of subscription.\n testsPerApplication:\n type: integer\n format: int64\n description: Average number of tests created per application over the lifetime of subscription.\n example:\n - subscriptionId: e381106b-6232-4035-ab48-5fcda471f265\n metrics:\n average:\n scanTime: 109\n queuingTime: 22\n totalTests: 2\n testsPerApplication: 2\n _collection:\n properties:\n itemCount:\n type: integer\n format: int32\n pageCount:\n type: integer\n format: int32\n currentPage:\n type: integer\n format: int32\n _type:\n type: string\n example:\n itemCount: 1\n pageCount: 10\n currentPage: 3\n _type: metrics\n _links:\n type: array\n items:\n type: array\n items:\n type: object\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: http://contoso.com/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: http://contoso.com/?_offset=10&_limit=10\n rel: prev\n method: GET\n - href: http://contoso.com/?_offset=30&_limit=10\n rel: next\n method: GET\n - href: http://contoso.com/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: http://contoso.com/?_offset=1000&_limit=10\n rel: last\n method: GET\n '400':\n description: Bad request\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n examples:\n Invalid Input:\n value:\n type: urn:x-test-manager:Bad-Request\n title: Bad request\n status: 400\n detail: Please provide valid/sort filter keys\n '401':\n description: Unauthorized\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted\n '403':\n description: Forbidden\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource\n '500':\n description: Internal server error\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request\n '501':\n description: Feature Not supported\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:not-supported\n title: Not Implemented\n status: 501\n detail: Metrics is not supported yet\n '503':\n description: Service unavailable\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Unavailable\n title: Service unavailable\n status: 503\n detail: Unexpected error occurred in processing the request\n '504':\n description: Gateway timeout\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Gateway-Timeout\n title: Gateway Timeout\n status: 504\n detail: Error occurred in processing the request within the default timeout\n /tests/{testId}/profiles:\n get:\n operationId: getProfileByTestId\n tags:\n - Test-Profile\n summary: |\n Fetches profile details of a specified test.\n description: |\n Fetches profile details of the specified DAST type test.\n parameters:\n - name: testId\n in: path\n description: Test identifier.\n required: true\n schema:\n type: string\n format: uuid\n example: 5796d731-4923-4690-b865-1482ae74403d\n responses:\n '200':\n description: Successful response\n content:\n application/vnd.tm.profiles-1+json:\n schema:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n entryPointUrl:\n type: string\n description: Entry point url to be used for the test.\n content:\n type: object\n format: json\n description: |\n Profile content represented in JSON format, captured while creating the specified test.\n example:\n id: 5796d731-4923-4690-b865-1482ae74403f\n entryPointUrl: https://test.com\n content:\n id: 5796d731-4923-4690-b865-1482ae74403e\n name: profile-name\n manualEntry:\n authentication:\n mode: none\n '400':\n description: Bad request\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Bad-Request\n title: Bad request\n status: 400\n detail: Please provide valid UUID for test Id field\n '401':\n description: Unauthorized\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted\n '403':\n description: Forbidden\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource\n '404':\n description: Not Found\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Not-Found\n title: Not Found\n status: 404\n detail: No matching records found for testId - 5796d731-4923-4690-b865-1482ae74403d\n '500':\n description: Internal server error\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Error\n title: Internal server error\n status: 500\n detail: unable to fetch profile data\n '503':\n description: Service unavailable\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Service-Unavailable\n title: Service unavailable\n status: 503\n detail: Unexpected error occurred in accepting the request, service is not available\n '504':\n description: Gateway timeout\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n type: urn:x-test-manager:Gateway-Timeout\n title: Gateway Timeout\n status: 504\n detail: Error occurred in processing the request within the default timeout\ncomponents:\n securitySchemes:\n ApiKeyAuth:\n type: apiKey\n in: header\n name: Api-Token\n schemas:\n tests:\n type: object\n required:\n - id\n - shortId\n - state\n - applicationId\n - projectId\n - createdDate\n - startDate\n - testDuration\n - testMode\n properties:\n id:\n type: string\n format: uuid\n description: Unique test identifier.\n applicationId:\n type: string\n format: uuid\n description: The application identifier for the test.\n projectId:\n type: string\n format: uuid\n description: The project identifier for the test.\n entitlementId:\n type: string\n format: uuid\n description: The entitlement identifier for the test.\n shortId:\n type: string\n description: The short identifier for the test.\n state:\n type: object\n required:\n - name\n - progress\n properties:\n name:\n type: string\n enum:\n - New\n - Queuing\n - Pending SNPS\n - In Progress\n - Scanning\n - Scanning & Publishing\n - Cancelled\n - Failed\n - Completed\n - Not Run\n - Pending Review\n description: The name of the test state.\n example: Queuing\n description:\n type: string\n description: The brief summary of the state and details about the state, like operations allowed.\n progress:\n type: integer\n description: Overall progress of the test in percentage.\n error:\n type: boolean\n description: Indicates if there is an error in the test.\n manualInterventionRequired:\n type: boolean\n description: Indicates if there is a manual intervention expected.\n operations:\n type: array\n description: Allowed operations on the test in the current state.\n items:\n type: string\n errorDetail:\n type: string\n description: The details about the error state of the test.\n operationInfo:\n type: string\n description: The details about the reason for states.\n description: The state of the test.\n artifacts:\n type: array\n description: Specify the artifacts to be used while scanning for issues. Optional when `assessmentType` = CI or SCM\n items:\n properties:\n id:\n type: string\n format: uuid\n description: Specify the artifact-id to be used while scanning for issues.\n type:\n type: string\n enum:\n - SOURCE_CODE\n description: Specify the artifact-type to be used while scanning for issues.\n testDuration:\n type: integer\n format: int64\n description: Time for the test to complete, in milliseconds.\n createdDate:\n type: string\n format: date-time\n description: The creation date of the test\n comments:\n type: array\n description: A list of comments associated with the test.\n items:\n type: object\n required:\n - id\n - testId\n - createdBy\n - createdDate\n - commentText\n - stateChange\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier for the comment.\n testId:\n type: string\n format: uuid\n description: Unique identifier for the test.\n createdBy:\n type: string\n format: uuid\n description: Unique identifier for the user who created the comment.\n createdDate:\n type: string\n format: date-time\n description: The date and time when the comment was created.\n updatedBy:\n type: string\n format: uuid\n nullable: true\n description: Unique identifier for the user who last updated the comment.\n updatedDate:\n type: string\n format: date-time\n nullable: true\n description: The date and time when the comment was last updated.\n commentText:\n type: string\n description: The text of the comment.\n maximum: 256\n stateChange:\n type: boolean\n description: Indicates if there was a state change.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef03\n testId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n createdBy: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedBy: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n updatedDate: '2021-07-29T14:30:33.067Z'\n commentText: Assessor comment ...\n stateChange: false\n startDate:\n type: string\n format: date-time\n description: The date the test began.\n expectedEndDate:\n type: string\n format: date-time\n description: The expected end date of the test\n notes:\n type: string\n maximum: 1024\n portfolioItemId:\n type: string\n format: uuid\n portfolioSubItemId:\n type: string\n format: uuid\n streamId:\n type: string\n format: uuid\n testMode:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n scanMode:\n type: string\n assessmentType:\n type: string\n toolId:\n type: string\n prevTestId:\n type: string\n branchId:\n type: string\n format: uuid\n triage:\n type: string\n profileDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef04\n applicationId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n projectId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n entitlementId: adeeebb4-a398-4f31-98d0-0fc811c5fda9\n shortId: ST4E3ZC\n state:\n name: Queuing\n description: Test is in Queuing state\n progress: 25\n error: false\n manualInterventionRequired: false\n operationInfo: This test is yet to be allocated a 'scanner' to begin execution\n operations:\n - Cancel\n errorDetail: Artifact Validation Failed due to invalid file-size, expected range[1byte - 2Gb]\n artifacts:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n type: SOURCE_CODE\n - id: 0ad95df7-2c70-4d91-8233-4df8d70aa812\n type: SOURCE_CODE\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedDate: '2021-07-29T14:30:33.067Z'\n startDate: '2021-07-29T14:30:33.067Z'\n expectedEndDate: '2021-07-29T14:30:33.067Z'\n testDuration: 154000\n notes: Really big notes...\n portfolioItemId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n portfolioSubItemId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n streamId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n testMode: SOURCE_UPLOAD\n scanMode: CAPTURE_ANALYSIS\n assessmentType: SAST\n toolId: Coverity:Recommended\n prevTestId: 0ad95df7-2c70-4d91-8233-4df8d71ab822\n branchId: 31c86a51-dcb3-4161-adbb-777a4ec5a349\n triage: REQUIRED\n comments:\n type: object\n required:\n - id\n - testId\n - createdBy\n - createdDate\n - commentText\n - stateChange\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier for the comment.\n testId:\n type: string\n format: uuid\n description: Unique identifier for the test.\n createdBy:\n type: string\n format: uuid\n description: Unique identifier for the user who created the comment.\n createdDate:\n type: string\n format: date-time\n description: The date and time when the comment was created.\n updatedBy:\n type: string\n format: uuid\n nullable: true\n description: Unique identifier for the user who last updated the comment.\n updatedDate:\n type: string\n format: date-time\n nullable: true\n description: The date and time when the comment was last updated.\n commentText:\n type: string\n description: The text of the comment.\n maximum: 256\n stateChange:\n type: boolean\n description: Indicates if there was a state change.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef03\n testId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n createdBy: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedBy: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n updatedDate: '2021-07-29T14:30:33.067Z'\n commentText: Assessor comment ...\n stateChange: false\n testMetrics:\n type: array\n items:\n type: object\n properties:\n subscriptionId:\n type: string\n format: uuid\n description: The subscriptionId is obtained from the Entitlement Service.\n metrics:\n type: object\n properties:\n average:\n type: object\n properties:\n scanTime:\n type: integer\n format: int64\n description: Average test completion time in seconds over the lifetime of the subscription.\n queuingTime:\n type: integer\n format: int64\n description: Average time the tests stay in 'queuing' state over the lifetime of subscription reported in Seconds.\n testsCount:\n type: integer\n format: int64\n description: Average number of tests created over the lifetime of subscription.\n testsPerApplication:\n type: integer\n format: int64\n description: Average number of tests created per application over the lifetime of subscription.\n example:\n - subscriptionId: e381106b-6232-4035-ab48-5fcda471f265\n metrics:\n average:\n scanTime: 109\n queuingTime: 22\n totalTests: 2\n testsPerApplication: 2\n test-metrics:\n type: object\n properties:\n testId:\n type: string\n format: uuid\n description: Unique identifier of the test.\n linesOfCode:\n type: integer\n format: int32\n description: Total number of lines of code analyzed in the project.\n totalFilesCaptured:\n type: integer\n format: int32\n description: Total number of captured files.\n filesCapturedByType:\n type: object\n additionalProperties:\n type: integer\n description: Set of total number of files captured, by type.\n totalFilesAnalyzed:\n type: integer\n format: int32\n description: Total number of analyzed files.\n analysisDuration:\n type: integer\n format: int64\n description: Time required for analysis to complete, in milliseconds.\n example:\n testId: 5796d731-4923-4690-b865-1482ae74403d\n linesOfCode: 646783\n testCollection:\n required:\n - itemCount\n - pageCount\n - currentPage\n properties:\n itemCount:\n type: integer\n format: int32\n pageCount:\n type: integer\n format: int32\n currentPage:\n type: integer\n format: int32\n _type:\n type: string\n example:\n itemCount: 1\n pageCount: 10\n currentPage: 3\n _type: test\n commentCollection:\n properties:\n itemCount:\n type: integer\n format: int32\n pageCount:\n type: integer\n format: int32\n currentPage:\n type: integer\n format: int32\n _type:\n type: string\n example:\n itemCount: 1\n pageCount: 10\n currentPage: 3\n _type: comment\n testMetricsCollection:\n properties:\n itemCount:\n type: integer\n format: int32\n pageCount:\n type: integer\n format: int32\n currentPage:\n type: integer\n format: int32\n _type:\n type: string\n example:\n itemCount: 1\n pageCount: 10\n currentPage: 3\n _type: metrics\n getAllArtifactsCollection:\n properties:\n itemCount:\n type: integer\n format: int32\n pageCount:\n type: integer\n format: int32\n currentPage:\n type: integer\n format: int32\n _type:\n type: string\n example:\n itemCount: 1\n pageCount: 10\n currentPage: 3\n _type: artifact\n links:\n type: array\n items:\n type: object\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: http://contoso.com/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: http://contoso.com/?_offset=10&_limit=10\n rel: prev\n method: GET\n - href: http://contoso.com/?_offset=30&_limit=10\n rel: next\n method: GET\n - href: http://contoso.com/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: http://contoso.com/?_offset=1000&_limit=10\n rel: last\n method: GET\n errorBody:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n createTestRequest:\n type: object\n required:\n - portfolioItemId\n properties:\n applicationId:\n type: string\n format: uuid\n description: Specifies the `applicationId` the test must use.\n projectId:\n type: string\n format: uuid\n description: Specifies the `projectId` the test must use.\n entitlementIds:\n type: array\n description: Specifies one or more `entitlementId`s to use for creating tests. Optional when `assessmentType` is CI or SCM.\n items:\n type: string\n format: uuid\n artifacts:\n type: array\n description: Specifies the artifacts to be used while scanning for issues. Optional when `assessmentType` is CI or SCM.\n items:\n type: string\n format: uuid\n artifactId:\n type: string\n format: uuid\n description: Specify the `artifactId` to be used while scanning for issues. Optional when `assessmentType` is CI or SCM.\n deprecated: true\n notes:\n type: string\n maxLength: 1024\n description: Optionally add any notes or a description for the test.\n portfolioItemId:\n type: string\n format: uuid\n description: Specify the `portfolioItemId` the test must use.\n portfolioSubItemId:\n type: string\n format: uuid\n description: Specify the `portfolioSubItemId` the test must use.\n assessmentTypes:\n type: array\n description: Specify the assessment-types to use for creating tests when `assessmentType` is CI or SCM. Optional when `entitlementId`s are provided.\n items:\n type: string\n enum:\n - SAST\n - SCA\n - DAST\n testMode:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n scanMode:\n type: string\n enum:\n - ANALYSIS_ONLY\n - MATCHING_ONLY\n - CAPTURE_ANALYSIS\n - SCANNING_MATCHING\n - DYNAMIC_TEST\n - DYNAMIC_PREFLIGHT\n - NOT_APPLICABLE\n description: >\n Optional to specify the scanMode, value is deduced based on test mode and assessment type if not provided.\n\n Valid combination with scanMode is : [ANALYSIS_ONLY : [testMode = CI, assessmentType = SAST], CAPTURE_ANALYSIS : [testMode = SOURCE_UPLOAD, assessmentType = SAST], CAPTURE_ANALYSIS :\n [testMode = SCM, assessmentType = SAST], MATCHING_ONLY : [testMode = CI, assessmentType = SCA], SCA_PACKAGE : [testMode = CI, assessmentType = SCA], SCANNING_MATCHING : [testMode =\n SOURCE_UPLOAD, assessmentType = SCA], SCANNING_MATCHING : [testMode = SCM, assessmentType = SCA]]\n branchId:\n type: string\n format: uuid\n description: Optional to specify the `branchId` the test must use, a default value is derived via the portfolioSubItem. Also,if `testMode` is SCM, the branch-source must be SCM.\n triage:\n type: string\n enum:\n - REQUIRED\n - NOT_REQUIRED\n - NOT_ENTITLED\n description: >-\n Optional, Specify a value (NOT_REQUIRED) when 'triage' is not required. Defaults to REQUIRED for an entitlement whose Triage-Mode is 'Always Triage'. For other entitlements the default\n value is NOT_ENTITLED.\n profileDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n content:\n type: string\n format: string\n description: DAST Project Profile contents.\n description: For a DAST-type test, an ID is compulsory for tests with the DAST_WEBAPP mode. However, for the DAST_PREFLIGHT mode, you can provide either an ID or content.\n example:\n applicationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n projectId: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n artifacts:\n - 6cd85f64-5717-4562-b3fc-2c963f66afdb\n notes: This scan is for FooBar project, release 2021.09\n portfolioItemId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n portfolioSubItemId: 4ab85f64-5717-4562-b3fc-2c963f66afb7\n assessmentTypes:\n - SAST\n testMode: SOURCE_UPLOAD\n branchId: 56b00012-286b-4f25-a97c-50dbab82d506\n triage: REQUIRED\n createTestResponse:\n type: object\n description: It is an array of responses, each object within the response array indicating a response all by itself complete with status, headers, and body.\n required:\n - responses\n properties:\n responses:\n type: array\n items:\n type: object\n required:\n - status\n - headers\n properties:\n status:\n type: integer\n format: int32\n description: Status code for the specific test that got created.\n headers:\n type: array\n description: Headers in the response of a test creation request.\n items:\n type: object\n description: Headers corresponding to the created test.\n additionalProperties:\n type: string\n body:\n type: object\n required:\n - id\n - shortId\n - state\n - applicationId\n - projectId\n - createdDate\n - updatedDate\n - startDate\n - testDuration\n - testMode\n properties:\n id:\n type: string\n format: uuid\n description: Unique test identifier.\n applicationId:\n type: string\n format: uuid\n description: The application identifier for the test.\n projectId:\n type: string\n format: uuid\n description: The project identifier for the test.\n entitlementId:\n type: string\n format: uuid\n description: The entitlement identifier for the test.\n shortId:\n type: string\n description: The short identifier for the test.\n state:\n type: object\n required:\n - name\n - progress\n properties:\n name:\n type: string\n enum:\n - New\n - Queuing\n - Pending SNPS\n - In Progress\n - Scanning\n - Scanning & Publishing\n - Cancelled\n - Failed\n - Completed\n - Not Run\n - Pending Review\n description: The name of the test state.\n example: Queuing\n description:\n type: string\n description: The brief summary of the state and details about the state, like operations allowed.\n progress:\n type: integer\n description: Overall progress of the test in percentage.\n error:\n type: boolean\n description: Indicates if there is an error in the test.\n manualInterventionRequired:\n type: boolean\n description: Indicates if there is a manual intervention expected.\n operations:\n type: array\n description: Allowed operations on the test in the current state.\n items:\n type: string\n errorDetail:\n type: string\n description: The details about the error state of the test.\n operationInfo:\n type: string\n description: The details about the reason for states.\n description: The state of the test.\n testDuration:\n type: integer\n format: int64\n description: Time for the test to complete, in milliseconds.\n createdDate:\n type: string\n format: date-time\n description: The creation date of the test\n startDate:\n type: string\n format: date-time\n description: The date the test began.\n expectedEndDate:\n type: string\n format: date-time\n description: The expected end date of the test\n updatedDate:\n type: string\n format: date-time\n description: The updated date of the test\n notes:\n type: string\n maximum: 1024\n description: User entered note or description on the test.\n portfolioItemId:\n type: string\n format: uuid\n description: The portfolio-item identifier for the test.\n portfolioSubItemId:\n type: string\n format: uuid\n description: The portfolio-subitem identifier for the test.\n testMode:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n scanMode:\n type: string\n description: ScanMode is deduced from testMode and type of test(SAST/SCA).\n triage:\n type: string\n description: >-\n Specify if 'Triage' is required while creating the test. If not provided, defaults to REQUIRED for SAST entitlements with triage mode set to 'Always Triage'. For other\n entitlements, defaults to NOT_ENTITLED.\n profileDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n _links:\n type: array\n items:\n type: object\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: http://contoso.com/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: http://contoso.com/?_offset=10&_limit=10\n rel: prev\n method: GET\n - href: http://contoso.com/?_offset=30&_limit=10\n rel: next\n method: GET\n - href: http://contoso.com/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: http://contoso.com/?_offset=1000&_limit=10\n rel: last\n method: GET\n error:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n status: 200\n headers:\n - Content-Type: application/vnd.tm.test-1+json\n body:\n _type: test\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef03\n shortId: ST4E3ZC\n applicationId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n projectId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n entitlementId: adeeebb4-a398-4f31-98d0-0fc811c5fda9\n state:\n name: Queuing\n description: Init state for test\n progress: 0\n error: false\n manualInterventionRequired: false\n operations: []\n errorDetail: ''\n operationInfo: ''\n artifacts:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n type: TOOL_CAPTURE\n - id: 0ad95df7-2c70-4d91-8233-4df8d70aa812\n type: CLI_LOG\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedDate: '2021-07-29T14:30:33.067Z'\n startDate: '2021-07-29T14:30:33.067Z'\n expectedEndDate: '2021-07-29T14:30:33.067Z'\n testDuration: 154000\n notes: Really big notes...\n portfolioItemId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n portfolioSubItemId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n streamId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n testMode: SOURCE_UPLOAD\n scanMode: ANALYSIS_ONLY\n toolId: Coverity:Recommended\n _links:\n - href: http://contoso.com/tests/0a50c9ab-b068-498e-b068-0d695ca4ef03\n rel: self\n method: GET\n branchId: 56b00012-286b-4f25-a97c-50dbab82d506\n triage: REQUIRED\n description: The response array containing the response objects.\n createTestResponseObject:\n type: object\n required:\n - status\n - headers\n properties:\n status:\n type: integer\n format: int32\n description: Status code for the specific test that got created.\n headers:\n type: array\n description: Headers in the response of a test creation request.\n items:\n type: object\n description: Headers corresponding to the created test.\n additionalProperties:\n type: string\n body:\n type: object\n required:\n - id\n - shortId\n - state\n - applicationId\n - projectId\n - createdDate\n - updatedDate\n - startDate\n - testDuration\n - testMode\n properties:\n id:\n type: string\n format: uuid\n description: Unique test identifier.\n applicationId:\n type: string\n format: uuid\n description: The application identifier for the test.\n projectId:\n type: string\n format: uuid\n description: The project identifier for the test.\n entitlementId:\n type: string\n format: uuid\n description: The entitlement identifier for the test.\n shortId:\n type: string\n description: The short identifier for the test.\n state:\n type: object\n required:\n - name\n - progress\n properties:\n name:\n type: string\n enum:\n - New\n - Queuing\n - Pending SNPS\n - In Progress\n - Scanning\n - Scanning & Publishing\n - Cancelled\n - Failed\n - Completed\n - Not Run\n - Pending Review\n description: The name of the test state.\n example: Queuing\n description:\n type: string\n description: The brief summary of the state and details about the state, like operations allowed.\n progress:\n type: integer\n description: Overall progress of the test in percentage.\n error:\n type: boolean\n description: Indicates if there is an error in the test.\n manualInterventionRequired:\n type: boolean\n description: Indicates if there is a manual intervention expected.\n operations:\n type: array\n description: Allowed operations on the test in the current state.\n items:\n type: string\n errorDetail:\n type: string\n description: The details about the error state of the test.\n operationInfo:\n type: string\n description: The details about the reason for states.\n description: The state of the test.\n testDuration:\n type: integer\n format: int64\n description: Time for the test to complete, in milliseconds.\n createdDate:\n type: string\n format: date-time\n description: The creation date of the test\n startDate:\n type: string\n format: date-time\n description: The date the test began.\n expectedEndDate:\n type: string\n format: date-time\n description: The expected end date of the test\n updatedDate:\n type: string\n format: date-time\n description: The updated date of the test\n notes:\n type: string\n maximum: 1024\n description: User entered note or description on the test.\n portfolioItemId:\n type: string\n format: uuid\n description: The portfolio-item identifier for the test.\n portfolioSubItemId:\n type: string\n format: uuid\n description: The portfolio-subitem identifier for the test.\n testMode:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n scanMode:\n type: string\n description: ScanMode is deduced from testMode and type of test(SAST/SCA).\n triage:\n type: string\n description: >-\n Specify if 'Triage' is required while creating the test. If not provided, defaults to REQUIRED for SAST entitlements with triage mode set to 'Always Triage'. For other entitlements,\n defaults to NOT_ENTITLED.\n profileDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n _links:\n type: array\n items:\n type: object\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: http://contoso.com/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: http://contoso.com/?_offset=10&_limit=10\n rel: prev\n method: GET\n - href: http://contoso.com/?_offset=30&_limit=10\n rel: next\n method: GET\n - href: http://contoso.com/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: http://contoso.com/?_offset=1000&_limit=10\n rel: last\n method: GET\n error:\n properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n status: 200\n headers:\n - Content-Type: application/vnd.tm.test-1+json\n body:\n _type: test\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef03\n shortId: ST4E3ZC\n applicationId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n projectId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n entitlementId: adeeebb4-a398-4f31-98d0-0fc811c5fda9\n state:\n name: Queuing\n description: Init state for test\n progress: 0\n error: false\n manualInterventionRequired: false\n operations: []\n errorDetail: ''\n operationInfo: ''\n artifacts:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n type: TOOL_CAPTURE\n - id: 0ad95df7-2c70-4d91-8233-4df8d70aa812\n type: CLI_LOG\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedDate: '2021-07-29T14:30:33.067Z'\n startDate: '2021-07-29T14:30:33.067Z'\n expectedEndDate: '2021-07-29T14:30:33.067Z'\n testDuration: 154000\n notes: Really big notes...\n portfolioItemId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n portfolioSubItemId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n streamId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n testMode: SOURCE_UPLOAD\n scanMode: ANALYSIS_ONLY\n toolId: Coverity:Recommended\n _links:\n - href: http://contoso.com/tests/0a50c9ab-b068-498e-b068-0d695ca4ef03\n rel: self\n method: GET\n branchId: 56b00012-286b-4f25-a97c-50dbab82d506\n triage: REQUIRED\n headersArray:\n type: object\n description: Headers corresponding to the created test.\n additionalProperties:\n type: string\n extendedTests:\n type: object\n required:\n - id\n - shortId\n - state\n - applicationId\n - projectId\n - createdDate\n - updatedDate\n - startDate\n - testDuration\n - testMode\n properties:\n id:\n type: string\n format: uuid\n description: Unique test identifier.\n applicationId:\n type: string\n format: uuid\n description: The application identifier for the test.\n projectId:\n type: string\n format: uuid\n description: The project identifier for the test.\n entitlementId:\n type: string\n format: uuid\n description: The entitlement identifier for the test.\n shortId:\n type: string\n description: The short identifier for the test.\n state:\n type: object\n required:\n - name\n - progress\n properties:\n name:\n type: string\n enum:\n - New\n - Queuing\n - Pending SNPS\n - In Progress\n - Scanning\n - Scanning & Publishing\n - Cancelled\n - Failed\n - Completed\n - Not Run\n - Pending Review\n description: The name of the test state.\n example: Queuing\n description:\n type: string\n description: The brief summary of the state and details about the state, like operations allowed.\n progress:\n type: integer\n description: Overall progress of the test in percentage.\n error:\n type: boolean\n description: Indicates if there is an error in the test.\n manualInterventionRequired:\n type: boolean\n description: Indicates if there is a manual intervention expected.\n operations:\n type: array\n description: Allowed operations on the test in the current state.\n items:\n type: string\n errorDetail:\n type: string\n description: The details about the error state of the test.\n operationInfo:\n type: string\n description: The details about the reason for states.\n description: The state of the test.\n testDuration:\n type: integer\n format: int64\n description: Time for the test to complete, in milliseconds.\n createdDate:\n type: string\n format: date-time\n description: The creation date of the test\n startDate:\n type: string\n format: date-time\n description: The date the test began.\n expectedEndDate:\n type: string\n format: date-time\n description: The expected end date of the test\n updatedDate:\n type: string\n format: date-time\n description: The updated date of the test\n notes:\n type: string\n maximum: 1024\n description: User entered note or description on the test.\n portfolioItemId:\n type: string\n format: uuid\n description: The portfolio-item identifier for the test.\n portfolioSubItemId:\n type: string\n format: uuid\n description: The portfolio-subitem identifier for the test.\n testMode:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n scanMode:\n type: string\n description: ScanMode is deduced from testMode and type of test(SAST/SCA).\n triage:\n type: string\n description: >-\n Specify if 'Triage' is required while creating the test. If not provided, defaults to REQUIRED for SAST entitlements with triage mode set to 'Always Triage'. For other entitlements,\n defaults to NOT_ENTITLED.\n profileDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n _links:\n type: array\n items:\n type: object\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: http://contoso.com/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: http://contoso.com/?_offset=10&_limit=10\n rel: prev\n method: GET\n - href: http://contoso.com/?_offset=30&_limit=10\n rel: next\n method: GET\n - href: http://contoso.com/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: http://contoso.com/?_offset=1000&_limit=10\n rel: last\n method: GET\n createArtifact:\n type: object\n properties:\n fileName:\n type: string\n description: This is the name of the file, including extension, that will be uploaded for testing\n fileHash:\n type: string\n description: This is Base64-encoded MD5 hash.\n fileSize:\n type: string\n format: long\n description: This is the size of the file in bytes.\n entitlementId:\n type: string\n format: uuid\n description: The entitlement identifier for the test (not required for CI use case).\n assessmentType:\n type: string\n description: The assessment type for the test (required for CI use case only).\n artifactType:\n type: string\n description: The type of the artifact. It can be SOURCE_CODE, TOOL_CAPTURE, CLI_LOG, CLI_ERROR or THIRD_PARTY_RESULTS.\n createdAt:\n type: string\n format: date-time\n description: Created datetime of the artifact. It is an optional field. Use the ISO 8601 standard for expressing datetime. More details are here `https://en.wikipedia.org/wiki/ISO_8601#Times`\n example:\n fileName: sample.zip\n fileHash: ehdsg8Rx/21ZjOP1DDOwbw==\n fileSize: '1024'\n entitlementId: adeeebb4-a398-4f31-98d0-0fc811c5fda9\n artifactType: SOURCE_CODE\n createdAt: '2017-01-15T01:30:15.010Z'\n ArtifactResponse:\n type: object\n properties:\n artifactId:\n type: string\n format: uuid\n signedUrl:\n type: string\n createdAt:\n type: string\n format: date-time\n _links:\n type: array\n items:\n type: object\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: http://contoso.com/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: http://contoso.com/?_offset=10&_limit=10\n rel: prev\n method: GET\n - href: http://contoso.com/?_offset=30&_limit=10\n rel: next\n method: GET\n - href: http://contoso.com/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: http://contoso.com/?_offset=1000&_limit=10\n rel: last\n method: GET\n example:\n _type: artifact\n artifactId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n signedUrl: https://storage.googleapis.com/example-bucket/12345678910/7ffd3936-0309-4a10-b48c-a924143a0673.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=foo-bar\n createdAt: '2017-01-15T01:30:15.010Z'\n _links:\n - href: https://contoso.com/api/test-manager/tests/artifacts/3fa85f64-5717-4562-b3fc-2c963f66afa6\n rel: self\n method: GET\n updateTestRequestPayload:\n type: object\n properties:\n artifacts:\n type: array\n description: specify the artifact-id to be used while scanning for issues\n items:\n type: string\n format: uuid\n action:\n type: string\n toolId:\n type: string\n example:\n action: RESUME\n artifacts:\n - 6cd85f64-5717-4562-b3fc-2c963f66afda\n - 32d85f64-5717-4562-b3fc-2c963f66afda\n toolId: Coverity:Recommended\n updateTestResponse:\n type: object\n properties:\n body:\n oneOf:\n - type: object\n required:\n - id\n - shortId\n - state\n - applicationId\n - projectId\n - createdDate\n - startDate\n - testDuration\n - testMode\n properties:\n id:\n type: string\n format: uuid\n description: Unique test identifier.\n applicationId:\n type: string\n format: uuid\n description: The application identifier for the test.\n projectId:\n type: string\n format: uuid\n description: The project identifier for the test.\n entitlementId:\n type: string\n format: uuid\n description: The entitlement identifier for the test.\n shortId:\n type: string\n description: The short identifier for the test.\n state:\n type: object\n required:\n - name\n - progress\n properties:\n name:\n type: string\n enum:\n - New\n - Queuing\n - Pending SNPS\n - In Progress\n - Scanning\n - Scanning & Publishing\n - Cancelled\n - Failed\n - Completed\n - Not Run\n - Pending Review\n description: The name of the test state.\n example: Queuing\n description:\n type: string\n description: The brief summary of the state and details about the state, like operations allowed.\n progress:\n type: integer\n description: Overall progress of the test in percentage.\n error:\n type: boolean\n description: Indicates if there is an error in the test.\n manualInterventionRequired:\n type: boolean\n description: Indicates if there is a manual intervention expected.\n operations:\n type: array\n description: Allowed operations on the test in the current state.\n items:\n type: string\n errorDetail:\n type: string\n description: The details about the error state of the test.\n operationInfo:\n type: string\n description: The details about the reason for states.\n description: The state of the test.\n artifacts:\n type: array\n description: Specify the artifacts to be used while scanning for issues. Optional when `assessmentType` = CI or SCM\n items:\n properties:\n id:\n type: string\n format: uuid\n description: Specify the artifact-id to be used while scanning for issues.\n type:\n type: string\n enum:\n - SOURCE_CODE\n description: Specify the artifact-type to be used while scanning for issues.\n testDuration:\n type: integer\n format: int64\n description: Time for the test to complete, in milliseconds.\n createdDate:\n type: string\n format: date-time\n description: The creation date of the test\n comments:\n type: array\n description: A list of comments associated with the test.\n items:\n type: object\n required:\n - id\n - testId\n - createdBy\n - createdDate\n - commentText\n - stateChange\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier for the comment.\n testId:\n type: string\n format: uuid\n description: Unique identifier for the test.\n createdBy:\n type: string\n format: uuid\n description: Unique identifier for the user who created the comment.\n createdDate:\n type: string\n format: date-time\n description: The date and time when the comment was created.\n updatedBy:\n type: string\n format: uuid\n nullable: true\n description: Unique identifier for the user who last updated the comment.\n updatedDate:\n type: string\n format: date-time\n nullable: true\n description: The date and time when the comment was last updated.\n commentText:\n type: string\n description: The text of the comment.\n maximum: 256\n stateChange:\n type: boolean\n description: Indicates if there was a state change.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef03\n testId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n createdBy: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedBy: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n updatedDate: '2021-07-29T14:30:33.067Z'\n commentText: Assessor comment ...\n stateChange: false\n startDate:\n type: string\n format: date-time\n description: The date the test began.\n expectedEndDate:\n type: string\n format: date-time\n description: The expected end date of the test\n notes:\n type: string\n maximum: 1024\n portfolioItemId:\n type: string\n format: uuid\n portfolioSubItemId:\n type: string\n format: uuid\n streamId:\n type: string\n format: uuid\n testMode:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n scanMode:\n type: string\n assessmentType:\n type: string\n toolId:\n type: string\n prevTestId:\n type: string\n branchId:\n type: string\n format: uuid\n triage:\n type: string\n profileDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef04\n applicationId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n projectId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n entitlementId: adeeebb4-a398-4f31-98d0-0fc811c5fda9\n shortId: ST4E3ZC\n state:\n name: Queuing\n description: Test is in Queuing state\n progress: 25\n error: false\n manualInterventionRequired: false\n operationInfo: This test is yet to be allocated a 'scanner' to begin execution\n operations:\n - Cancel\n errorDetail: Artifact Validation Failed due to invalid file-size, expected range[1byte - 2Gb]\n artifacts:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n type: SOURCE_CODE\n - id: 0ad95df7-2c70-4d91-8233-4df8d70aa812\n type: SOURCE_CODE\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedDate: '2021-07-29T14:30:33.067Z'\n startDate: '2021-07-29T14:30:33.067Z'\n expectedEndDate: '2021-07-29T14:30:33.067Z'\n testDuration: 154000\n notes: Really big notes...\n portfolioItemId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n portfolioSubItemId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n streamId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n testMode: SOURCE_UPLOAD\n scanMode: CAPTURE_ANALYSIS\n assessmentType: SAST\n toolId: Coverity:Recommended\n prevTestId: 0ad95df7-2c70-4d91-8233-4df8d71ab822\n branchId: 31c86a51-dcb3-4161-adbb-777a4ec5a349\n triage: REQUIRED\n - properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n _type: test\n id: 5796d731-4923-4690-b865-1482ae74403d\n notes: hello this is notes;\n createdDate: '2021-10-01T07:48:49Z'\n startDate: '2021-10-01T07:48:49Z'\n expectedEndDate: '2021-10-01T07:48:49Z'\n projectId: 4ee75520-121b-4764-8e68-9d17b522d6bf\n applicationId: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n entitlementId: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n triage: REQUIRED\n state:\n name: New\n description: Init state for test\n progress: 0\n error: false\n manualInterventionRequired: false\n operations: []\n errorDetail: null\n operationInfo: null\n testDuration: 154000\n artifacts:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n type: TOOL_CAPTURE\n updatedDate: '2021-10-01T07:49:25Z'\n portfolioItemId: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n portfolioSubItemId: 4ee75520-121b-4764-8e68-9d17b522d6bf\n streamId: 4ee75520-121b-4764-8e68-9d17b522d6bf\n toolId: Coverity:Recommended\n _links:\n - href: http://localhost:8080/api/tests/5796d731-4923-4690-b865-1482ae74403d?_offset=0&_limit=0\n rel: self\n method: GET\n getTestByIdResponse:\n type: object\n properties:\n body:\n oneOf:\n - type: object\n required:\n - id\n - shortId\n - state\n - applicationId\n - projectId\n - createdDate\n - startDate\n - testDuration\n - testMode\n properties:\n id:\n type: string\n format: uuid\n description: Unique test identifier.\n applicationId:\n type: string\n format: uuid\n description: The application identifier for the test.\n projectId:\n type: string\n format: uuid\n description: The project identifier for the test.\n entitlementId:\n type: string\n format: uuid\n description: The entitlement identifier for the test.\n shortId:\n type: string\n description: The short identifier for the test.\n state:\n type: object\n required:\n - name\n - progress\n properties:\n name:\n type: string\n enum:\n - New\n - Queuing\n - Pending SNPS\n - In Progress\n - Scanning\n - Scanning & Publishing\n - Cancelled\n - Failed\n - Completed\n - Not Run\n - Pending Review\n description: The name of the test state.\n example: Queuing\n description:\n type: string\n description: The brief summary of the state and details about the state, like operations allowed.\n progress:\n type: integer\n description: Overall progress of the test in percentage.\n error:\n type: boolean\n description: Indicates if there is an error in the test.\n manualInterventionRequired:\n type: boolean\n description: Indicates if there is a manual intervention expected.\n operations:\n type: array\n description: Allowed operations on the test in the current state.\n items:\n type: string\n errorDetail:\n type: string\n description: The details about the error state of the test.\n operationInfo:\n type: string\n description: The details about the reason for states.\n description: The state of the test.\n artifacts:\n type: array\n description: Specify the artifacts to be used while scanning for issues. Optional when `assessmentType` = CI or SCM\n items:\n properties:\n id:\n type: string\n format: uuid\n description: Specify the artifact-id to be used while scanning for issues.\n type:\n type: string\n enum:\n - SOURCE_CODE\n description: Specify the artifact-type to be used while scanning for issues.\n testDuration:\n type: integer\n format: int64\n description: Time for the test to complete, in milliseconds.\n createdDate:\n type: string\n format: date-time\n description: The creation date of the test\n comments:\n type: array\n description: A list of comments associated with the test.\n items:\n type: object\n required:\n - id\n - testId\n - createdBy\n - createdDate\n - commentText\n - stateChange\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier for the comment.\n testId:\n type: string\n format: uuid\n description: Unique identifier for the test.\n createdBy:\n type: string\n format: uuid\n description: Unique identifier for the user who created the comment.\n createdDate:\n type: string\n format: date-time\n description: The date and time when the comment was created.\n updatedBy:\n type: string\n format: uuid\n nullable: true\n description: Unique identifier for the user who last updated the comment.\n updatedDate:\n type: string\n format: date-time\n nullable: true\n description: The date and time when the comment was last updated.\n commentText:\n type: string\n description: The text of the comment.\n maximum: 256\n stateChange:\n type: boolean\n description: Indicates if there was a state change.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef03\n testId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n createdBy: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedBy: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n updatedDate: '2021-07-29T14:30:33.067Z'\n commentText: Assessor comment ...\n stateChange: false\n startDate:\n type: string\n format: date-time\n description: The date the test began.\n expectedEndDate:\n type: string\n format: date-time\n description: The expected end date of the test\n notes:\n type: string\n maximum: 1024\n portfolioItemId:\n type: string\n format: uuid\n portfolioSubItemId:\n type: string\n format: uuid\n streamId:\n type: string\n format: uuid\n testMode:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n scanMode:\n type: string\n assessmentType:\n type: string\n toolId:\n type: string\n prevTestId:\n type: string\n branchId:\n type: string\n format: uuid\n triage:\n type: string\n profileDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n example:\n id: 0a50c9ab-b068-498e-b068-0d695ca4ef04\n applicationId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n projectId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n entitlementId: adeeebb4-a398-4f31-98d0-0fc811c5fda9\n shortId: ST4E3ZC\n state:\n name: Queuing\n description: Test is in Queuing state\n progress: 25\n error: false\n manualInterventionRequired: false\n operationInfo: This test is yet to be allocated a 'scanner' to begin execution\n operations:\n - Cancel\n errorDetail: Artifact Validation Failed due to invalid file-size, expected range[1byte - 2Gb]\n artifacts:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n type: SOURCE_CODE\n - id: 0ad95df7-2c70-4d91-8233-4df8d70aa812\n type: SOURCE_CODE\n createdDate: '2021-07-29T14:30:33.067Z'\n updatedDate: '2021-07-29T14:30:33.067Z'\n startDate: '2021-07-29T14:30:33.067Z'\n expectedEndDate: '2021-07-29T14:30:33.067Z'\n testDuration: 154000\n notes: Really big notes...\n portfolioItemId: 1d44c6d4-dde4-4c37-b068-9e7eb21c4a19\n portfolioSubItemId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n streamId: 0a50c9ab-7c75-498e-8b18-0d695ca4ef03\n testMode: SOURCE_UPLOAD\n scanMode: CAPTURE_ANALYSIS\n assessmentType: SAST\n toolId: Coverity:Recommended\n prevTestId: 0ad95df7-2c70-4d91-8233-4df8d71ab822\n branchId: 31c86a51-dcb3-4161-adbb-777a4ec5a349\n triage: REQUIRED\n - properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n _type: test\n id: 5796d731-4923-4690-b865-1482ae74403d\n notes: hello this is notes;\n createdDate: '2021-10-01T07:48:49Z'\n startDate: '2021-10-01T07:48:49Z'\n expectedEndDate: '2021-10-01T07:48:49Z'\n projectId: 4ee75520-121b-4764-8e68-9d17b522d6bf\n applicationId: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n entitlementId: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n shortId: FFFF000\n state:\n name: New\n description: Init state for test\n progress: 0\n error: false\n manualInterventionRequired: false\n operations: []\n errorDetail: null\n operationInfo: null\n testDuration: 154000\n artifacts:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n type: TOOL_CAPTURE\n - id: 0ad95df7-2c70-4d91-8233-4df8d70aa812\n type: CLI_LOG\n updatedDate: '2021-10-01T07:49:25Z'\n portfolioItemId: e9561105-2b70-4821-9d48-8f7dcaaacb0d\n portfolioSubItemId: 4ee75520-121b-4764-8e68-9d17b522d6bf\n streamId: 4ee75520-121b-4764-8e68-9d17b522d6bf\n branchId: 31c86a51-dcb3-4161-adbb-777a4ec5a349\n testMode: SOURCE_UPLOAD\n scanMode: CAPTURE_ANALYSIS\n toolId: Coverity:Recommended\n triage: REQUIRED\n assessmentType: SAST\n _links:\n - href: http://localhost:8080/api/tests/5796d731-4923-4690-b865-1482ae74403d\n rel: self\n method: GET\n getTestMetricsByTestIdResponse:\n type: object\n properties:\n body:\n oneOf:\n - type: object\n properties:\n testId:\n type: string\n format: uuid\n description: Unique identifier of the test.\n linesOfCode:\n type: integer\n format: int32\n description: Total number of lines of code analyzed in the project.\n totalFilesCaptured:\n type: integer\n format: int32\n description: Total number of captured files.\n filesCapturedByType:\n type: object\n additionalProperties:\n type: integer\n description: Set of total number of files captured, by type.\n totalFilesAnalyzed:\n type: integer\n format: int32\n description: Total number of analyzed files.\n analysisDuration:\n type: integer\n format: int64\n description: Time required for analysis to complete, in milliseconds.\n example:\n testId: 5796d731-4923-4690-b865-1482ae74403d\n linesOfCode: 646783\n - properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n _type: metrics\n testId: 5796d731-4923-4690-b865-1482ae74403d\n linesOfCode: 4587487\n totalFilesCaptured: 26\n filesCapturedByType:\n .jar: 21\n .txt: 1\n .xml: 1\n .java: 2\n .properties: 1\n totalFilesAnalyzed: 26\n analysisDuration: 64830\n _links: []\n getAllArtifactsBody:\n type: object\n properties:\n _items:\n type: array\n items:\n type: array\n items:\n properties:\n id:\n type: string\n format: uuid\n description: Unique artifact identifier.\n fileName:\n type: string\n description: The fileName for the artifact.\n fileSize:\n type: integer\n description: The file size for the artifact.\n fileHash:\n type: string\n description: The file hash value for the artifact.\n artifactType:\n type: string\n description: The type of the artifact.\n createdAt:\n type: string\n description: The timestamp for the artifact creation.\n getAllArtifactsMetadata:\n type: array\n items:\n properties:\n id:\n type: string\n format: uuid\n description: Unique artifact identifier.\n fileName:\n type: string\n description: The fileName for the artifact.\n fileSize:\n type: integer\n description: The file size for the artifact.\n fileHash:\n type: string\n description: The file hash value for the artifact.\n artifactType:\n type: string\n description: The type of the artifact.\n createdAt:\n type: string\n description: The timestamp for the artifact creation.\n getAllArtifacts:\n type: object\n properties:\n body:\n description: The body containing the list of Artifact metadata fetched.\n oneOf:\n - type: object\n properties:\n _items:\n type: array\n items:\n type: array\n items:\n properties:\n id:\n type: string\n format: uuid\n description: Unique artifact identifier.\n fileName:\n type: string\n description: The fileName for the artifact.\n fileSize:\n type: integer\n description: The file size for the artifact.\n fileHash:\n type: string\n description: The file hash value for the artifact.\n artifactType:\n type: string\n description: The type of the artifact.\n createdAt:\n type: string\n description: The timestamp for the artifact creation.\n - properties:\n type:\n type: string\n description: The type of the error produced, usually a URN. For example, \"URN:x-testmanager:Type.\"\n title:\n type: string\n description: The title for the error. For example, \"NotFound.\"\n status:\n type: number\n description: The status code for the error. For example, 404.\n detail:\n type: string\n description: The detailed description for the cause of the error.\n instance:\n type: string\n description: The details about where the error occurred. For example, TestController.createTest.\n example:\n type: urn:x-test-manager:Server-Error,\n title: Internal Server Error,\n status: 500\n detail: Could not process the request as an error occurred. Retry the request.\n example:\n _items:\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920881\n fileName: test.zip\n fileSize: 100\n fileHash: abcde\n artifactType: TOOL\n createdAt: '1970-01-01T00:00:00Z'\n - id: a1ed9f61-8fa2-48e0-b81b-aaf765920882\n fileName: test1.zip\n fileSize: 200\n fileHash: abcdef\n artifactType: TOOL\n createdAt: '1970-01-01T00:00:00Z'\n testProfile:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier of the project profile.\n entryPointUrl:\n type: string\n description: Entry point url to be used for the test.\n content:\n type: object\n format: json\n description: |\n Profile content represented in JSON format, captured while creating the specified test.\n example:\n id: 5796d731-4923-4690-b865-1482ae74403f\n entryPointUrl: https://test.com\n content:\n id: 5796d731-4923-4690-b865-1482ae74403e\n name: profile-name\n manualEntry:\n authentication:\n mode: none\n testMode:\n type: string\n enum:\n - SOURCE_UPLOAD\n - CI\n - SCM\n - MANUAL\n - DAST_WEBAPP\n - DAST_PREFLIGHT\n - DAST_API\n - DAST_API_PREFLIGHT\n - IDE\n - THIRD_PARTY_RESULT_UPLOAD\n description: Specify the mode of the test.\n example: SOURCE_UPLOAD\n testStateName:\n type: string\n enum:\n - New\n - Queuing\n - Pending SNPS\n - In Progress\n - Scanning\n - Scanning & Publishing\n - Cancelled\n - Failed\n - Completed\n - Not Run\n - Pending Review\n description: The name of the test state.\n example: Queuing\n"

{}