"Deprecation":  "Fri, 1 Nov 2024 23:59:59 GMT",
"Link":         "New version of API link; rel=\"alternate\"",
"Sunset":       "Mon, 15 Sept 2025 23:59:59 GMT"

"openapi: 3.0.3\ninfo:\n title: Policies\n description: |\n Use the Policies API to create and manage *issue policies*, *component policies* and *test scheduling* policies. \n\n * Issue policies: Use issue policies to automate *actions* when issues with specific properties are detected in a test (including setting fix-by dates, if necessary).\n * Component policies: Use component policies to automate *actions* when a component with specific properties are detected in a test.\n * Test frequency policies: Use test scheduling policies to automate tests of SCM-integrated branches on a weekly or daily basis.\n\n **Base path change and deprecation notice**\n\n The base path for the Policy Management service is changing (from `/api/risk` to `/api/policies`). The `/api/risk/` base path will continue to function until `Mon, 15 Sept 2025 23:59:59 GMT`.\n\n Additionally, several endpoints are being deprecated. Endpoints that are being deprecated include additional properties in response headers:\n\n ```\n \"Deprecation\": \"Fri, 1 Nov 2024 23:59:59 GMT\",\n \"Link\": \"New version of API link; rel=\\\"alternate\\\"\",\n \"Sunset\": \"Mon, 15 Sept 2025 23:59:59 GMT\"\n ```\n\n * `Deprecation`: The date and time when a resource will be deprecated. After this date, the resource may be removed from future versions of the API. \n * `Link`: A link to a supported endpoint that replicates the functionality of a deprecated one.\n * `Sunset`: The date and time when a resource will be removed, and no longer be available.\n\n * `Note`: Media type names used in Polaris APIs were renamed and no longer include “synopsys”. \n Although media types that include “synopsys” were removed from the API specifications, existing endpoints will continue to support them until September 1, 2025. \n Please update your scripts to use the new media types.\n x-logo:\n icon: fa-list-check\n primary: null\n secondary: null\n contact:\n name: Black Duck Software, Inc.\n url: https://polaris.blackduck.com/\n version: 1.0.0\nservers:\n - url: https://polaris.blackduck.com\ntags:\n - name: Policy Actions\n description: Retrieve policy actions and their details.\n - name: Issue Policies\n description: Manage issue policies.\n - name: Component Policies\n description: Manage component policies.\n - name: Policy Assignments\n description: Assign policies to projects.\n - name: Policy Assignments V2\n description: Assign policies to projects.\n - name: Policy Settings\n description: Manage your organization's policy settings.\n - name: Test Scheduling Policies\n description: Manage test scheduling policies.\n - name: Portfolio Policy Configuration\n description: Manage portfolio policies.\n - name: Issue Policy Execution\n description: Issue policy execution endpoints.\n - name: Issue Policy Evaluation\n description: Issue policy evaluation endpoints.\n - name: Policy Evaluations\n description: Policy evaluation endpoints.\n - name: Policy Violations\n description: Policy Violations endpoints.\n - name: Active Violation Counts\n description: Active Violation Counts endpoints.\nsecurity:\n - ApiKeyAuth: []\npaths:\n /api/risk/policies/actions:\n get:\n operationId: getPolicyAction\n tags:\n - Policy Actions\n summary: List supported actions and their IDs\n description: |\n The following actions are supported:\n\n * `SEND_EMAIL` : Send an email notification to Organization Admins when issues with specific properties are found in a test.\n * `BREAK_THE_BUILD`: For project's connected to a repository via an SCM integration, attempt to break a build when issues with specific properties are found in a test.\n * `CREATE_BUNDLE_JIRA_TICKET`: When issues with specific properties are found in a test of a project's default branch, create a Jira ticket.\n parameters:\n - $ref: '#/paths/~1api~1policies~1actions/get/parameters/0'\n - $ref: '#/paths/~1api~1policies~1actions/get/parameters/1'\n - name: _filter\n schema:\n type: string\n in: query\n description: |\n Filters the available actions based on the given criteria. The filter follows the [RSQL](https://github.com/jirutka/rsql-parser) syntax, and supports the following fields and operators:\n\n Below keys and operators are supported.\n\n | Key | Allowed Operators | Available Values |\n |-----------------|-----------------------|----------------------------------|\n | policyUseCase | `==`, `=in=` |`issue_policy`, `component_policy`|\n example: _filter=policyUseCase=in=('issue_policy')\n responses:\n '200':\n description: Success. List of available actions.\n headers:\n DeprecationHeader:\n description: >-\n Indicates that the resource is deprecated and may be removed in the future version of the APIs. <br /> It is way to inform clients that they should migrate to alternative resources\n mentioned in LINK header.\n schema:\n type: string\n example: Nov, 11 Nov 2024 23:59:59 GMT\n LinkHeader:\n description: Provide link to alternative/related resource after the resource has been sunset.\n schema:\n type: string\n example: New version of API link; rel=\"alternate\"\n SunsetHeader:\n description: Specifies the date and time after which the resource will no longer be available.\n schema:\n type: string\n example: Thru, 1 May 2025 23:59:59 GMT\n content:\n application/vnd.polaris.policies.action-1+json:\n schema:\n $ref: '#/components/schemas/ActionsGetResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/ActionsGetResponse'\n application/vnd.polaris.policy.action-1+json:\n schema:\n $ref: '#/components/schemas/ActionsGetResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/actions:\n get:\n operationId: getPoliciesAction\n tags:\n - Policy Actions\n summary: List supported actions and their IDs\n description: |\n The following actions are supported:\n\n * `SEND_EMAIL` : Send an email notification to Organization Admins when issues with specific properties are found in a test.\n * `BREAK_THE_BUILD`: For project's connected to a repository via an SCM integration, attempt to break a build when issues with specific properties are found in a test.\n * `CREATE_BUNDLE_JIRA_TICKET`: When issues with specific properties are found in a test of a project's default branch, create a Jira ticket.\n parameters:\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n default: 100\n example: 10\n - name: _offset\n in: query\n description: >-\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n default: 0\n example: 0\n - name: _filter\n schema:\n type: string\n in: query\n description: |\n The filter follows the RSQL syntax. Filters the available actions based on the given criteria.\n\n Below keys and operators are supported.\n\n\n | Key | Allowed Operators | Available Values |\n |-----------------|------------------------|---------------------------------|\n | `policyUseCase` | `==`, `=in=` | `issue_policy`, `component_policy` |\n example: _filter=policyUseCase=in=('issue_policy')\n responses:\n '200':\n description: Success. List of available actions.\n content:\n application/vnd.polaris.policies.action-1+json:\n schema:\n $ref: '#/components/schemas/PolicyActionsGetResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PolicyActionsGetResponse'\n application/vnd.polaris.policy.action-1+json:\n schema:\n $ref: '#/components/schemas/PolicyActionsGetResponse'\n '400':\n description: |\n Returned when the request could not be processed due to invalid syntax.\n content:\n application/problem+json:\n schema:\n properties:\n type:\n type: string\n description: The type of the error produced. Typically, a uniform resource name (URN).\n example: urn:x-risk-manager-service:Type\n status:\n type: integer\n format: int64\n description: The status code for the error.\n example: 404\n title:\n type: string\n description: The title for the error.\n example: Not Found\n details:\n type: string\n description: A detailed description of the error.\n example: Policy id 8bc855c1-a58c-4ea2-96e2-ac6cd5120824 not available in the system\n locationId:\n type: string\n description: An identifier for this specific occurrence/instance of the problem. Use the `locationId` to identify the error in logs.\n example: '123456789'\n remediation:\n type: string\n description: An action to take to recover from this problem.\n example: Your organization is not subscribed to 'DAST' entitlement.\n example:\n type: urn:x-risk-manager:bad-request\n title: Bad request.\n status: 400\n detail: Request cannot be processed, as the passed request payload is invalid\n locationId: '123456789'\n remediation: Please adjust your search criteria.\n '401':\n description: |\n User is not authorized to access the resource.\n content:\n application/problem+json:\n schema:\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400/content/application~1problem%2Bjson/schema'\n example:\n type: urn:x-risk-manager:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n locationId: '123456789'\n remediation: An action to take to recover from this problem.\n '404':\n description: |\n Returned when a specified resource could not be found.\n content:\n application/problem+json:\n schema:\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400/content/application~1problem%2Bjson/schema'\n example:\n type: urn:x-risk-manager:bad-request\n title: Not Found.\n status: 404\n detail: The specified resource item does not exist.\n locationId: '123456789'\n remediation: An action to take to recover from this problem.\n '406':\n description: |\n Returned when a the request is not acceptable.\n content:\n application/problem+json:\n schema:\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400/content/application~1problem%2Bjson/schema'\n example:\n type: urn:x-risk-manager:about:blank\n title: Not Acceptable\n status: 406\n details: 'Acceptable representations: [application/json].'\n '415':\n description: |\n Returned when an unsupported media-type is passed.\n content:\n application/problem+json:\n schema:\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400/content/application~1problem%2Bjson/schema'\n example:\n type: urn:x-risk-manager:media-type-not-supported\n title: Unsupported Media-Type\n status: 415\n detail: Content type `application/json` or specific content types are supported\n '500':\n description: |\n Returned when the server encounters an unexpected condition that prevents it from fulfilling the request.\n content:\n application/problem+json:\n schema:\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400/content/application~1problem%2Bjson/schema'\n example:\n type: urn:x-risk-manager:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request\n locationId: '123456789'\n remediation: An action to take to recover from this problem.\n /api/risk/policies/actions/{id}:\n get:\n operationId: getPolicyActionById\n tags:\n - Policy Actions\n summary: Get an action by ID\n description: |\n Get an action's properties. You can retrieve a list of all supported actions (that includes each action's ID) with `GET /policies/actions` endpoint.\n parameters:\n - name: id\n in: path\n description: Action ID in UUID format.\n required: true\n schema:\n type: string\n format: uuid\n example: 9a7ef1e2-2a2d-4fa2-86f5-5a7143550e54\n responses:\n '200':\n description: Success. Action details.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.action-1+json:\n schema:\n $ref: '#/components/schemas/PolicyActionsGetResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PolicyActionsGetResponse'\n application/vnd.polaris.policy.action-1+json:\n schema:\n $ref: '#/components/schemas/PolicyActionsGetResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/actions/{id}:\n get:\n operationId: getPoliciesActionById\n tags:\n - Policy Actions\n summary: Get an action by ID\n description: |\n Get an action's properties. You can retrieve a list of all supported actions (that includes each action's ID) with `GET /actions` endpoint.\n parameters:\n - name: id\n in: path\n description: Action ID in UUID format.\n required: true\n schema:\n type: string\n format: uuid\n example: 9cfeeaba-dd52-11ec-9d64-0242ac120002\n responses:\n '200':\n description: Success. Action details.\n content:\n application/vnd.polaris.policies.action-1+json:\n schema:\n $ref: '#/components/schemas/ActionsGetResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/ActionsGetResponse'\n application/vnd.polaris.policy.action-1+json:\n schema:\n $ref: '#/components/schemas/ActionsGetResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/risk/policies/issue-policy:\n post:\n operationId: createIssuePolicy\n tags:\n - Issue Policies\n summary: Create an issue policy\n description: >\n Use this endpoint to create an issue policy.\n\n\n Issue policies create guideline for your organization to follow. Track projects against policies or trigger actions for violations.\n\n\n Creates a name and description so that the user knows which policy to select when onboarding projects in the future. Below policy will be onboarded by default.\n\n * `Issue Policy` - Critical, High Severity notify\n\n You can add up to 5 rules to an issue policy. Each rule must have an action. There are five fixBy rules with active status as false by default. For each fixBy rule there are default days\n values set.\n\n\n All rules are transformed to a query language. For example: <br />\n\n `context:tool-type=in=('sast','sca', 'dast');issueProperties:severity=in=('critical','high')`\n\n\n Meaning - Filter issues from `sast`, `sca`, and `dast` with severity in `critical` and `high`.\n requestBody:\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyPayload'\n application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyPayload'\n responses:\n '201':\n description: Success. Issue Policy successfully created.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePolicyResponse'\n application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n get:\n operationId: getIssuePolicy\n tags:\n - Issue Policies\n summary: List issue policies\n description: |\n Get the issue policies in your organization. Include a `_filter` expression to get policies with specific properties. \n Include an `associationId` to get policies linked to a portfolio subitem, or branch.\n parameters:\n - name: _filter\n in: query\n description: |\n Filters the collection of post Test Scheduling Policies under an organization.\n The filter follows the RSQL syntax. For example, `name=='Notify for Critical, High issues'`.\n For more details, see `https://github.com/jirutka/rsql-parser`.\n example: name=='Notify for Critical, High issues'\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts the collection of issue policies under an organization. The default sorting order is `name` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`.\n example: name|asc\n schema:\n type: string\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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n - name: associationId\n in: query\n example: 61ef159d-8421-4f0a-b15f-a8b5bce75426\n description: ID of the portfolio-related entity. For example, Project ID.\n schema:\n type: string\n responses:\n '200':\n description: Success. Paged list of issue policies under an organization.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyCollectionResponse'\n application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/issue-policies:\n post:\n operationId: createIssuePolicies\n tags:\n - Issue Policies\n summary: Create an issue policy\n description: >\n Use this endpoint to create an issue policy. \n\n\n Issue policies create guideline for your organization to follow. Track projects against policies or trigger actions for violations.\n\n\n Creates a name and description so that the user knows which policy to select when onboarding projects in the future. Below policy will be onboarded by default.\n\n * `Issue Policy` - Critical, High Severity notify\n\n You can add up to 5 rules to an issue policy. Each rule must have an action. There are five fixBy rules with active status as false by default. For each fixBy rule there are default days\n values set.\n\n\n All rules are transformed to a query language. For example: <br />\n\n `context:tool-type=in=('sast','sca', 'dast');issueProperties:severity=in=('critical','high')`\n\n\n Meaning - Filter issues from `sast`, `sca`, `dast` with severity in `critical` and `high`.\n requestBody:\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyPayload'\n application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyPayload'\n responses:\n '201':\n description: Success. Issue Policy successfully created.\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesResponse'\n application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n get:\n operationId: getIssuePolicies\n tags:\n - Issue Policies\n summary: List issue policies\n description: |\n Get the issue policies in your organization. Include a `_filter` expression to get policies with specific properties. \n Include an `associationId` to get policies linked to a portfolio subitem, or branch.\n parameters:\n - name: _filter\n in: query\n description: |\n Filters the collection of post TestSchedulingPolicies under an organization.\n The filter follows the RSQL syntax. For example, `name=='Notify for Critical, High issues'`.\n For more details, see `https://github.com/jirutka/rsql-parser`.\n example: name=='Notify for Critical, High issues'\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts the collection of issue policies under an organization. The default sorting order is `name` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`.\n example: name|asc\n schema:\n type: string\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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n - name: associationId\n in: query\n example: 61ef159d-8421-4f0a-b15f-a8b5bce75426\n description: ID of the portfolio-related entity. For example, Project ID.\n schema:\n type: string\n responses:\n '200':\n description: Success. Paged list of issue policies under an organization.\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPoliciesCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPoliciesCollectionResponse'\n application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPoliciesCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/risk/policies/issue-policy/{id}:\n get:\n operationId: getIssuePolicyById\n tags:\n - Issue Policies\n summary: Get an issue policy’s details\n description: |\n API to fetch the issue policy record by its ID (UUID format).\n parameters:\n - name: id\n in: path\n description: Issue policy ID, a UUID.\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success. Issue Policy by ID.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePolicyResponse'\n application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n put:\n operationId: updateIssuePolicyById\n tags:\n - Issue Policies\n summary: Update an issue policy’s properties\n description: |\n API to update the issue policy details like name, description, policy rules, project assignments etc...\n parameters:\n - name: id\n in: path\n description: Issue policy id, a UUID.\n required: true\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n format: uuid\n requestBody:\n description: Any one of, or all of, the following Issue Policy attributes can be updated.\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyPayload'\n application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyPayload'\n responses:\n '200':\n description: Success. Issue Policy successfully updated.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePolicyResponse'\n application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n delete:\n operationId: deleteIssuePolicyById\n tags:\n - Issue Policies\n summary: Delete an issue policy\n description: |\n Delete an issue policy. Your organization's default issue policy cannot be deleted. Change your organization's default issue policy with the `POST /policies/{policyId}/default` endpoint.\n parameters:\n - name: id\n in: path\n description: Issue Policy ID (UUID).\n required: true\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n format: uuid\n responses:\n '204':\n description: Success. Issue policy is deleted.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/issue-policies/{id}:\n get:\n operationId: getIssuePoliciesById\n tags:\n - Issue Policies\n summary: Get an issue policy’s details\n description: |\n API to fetch the issue policy record by its ID (UUID format).\n parameters:\n - name: id\n in: path\n description: Issue policy ID, a UUID.\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success. Issue policy by ID.\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesResponse'\n application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n put:\n operationId: updateIssuePoliciesById\n tags:\n - Issue Policies\n summary: Update an issue policy’s properties\n description: |\n API to update the issue policy details like name, description, policy rules, project assignments etc...\n parameters:\n - name: id\n in: path\n description: Issue policy id, a UUID.\n required: true\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n format: uuid\n requestBody:\n description: Any one of, or all of, the following Issue Policy attributes can be updated.\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyPayload'\n application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyPolicyPayload'\n responses:\n '200':\n description: Success. Issue Policy successfully updated.\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesResponse'\n application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n delete:\n operationId: deleteIssuePoliciesById\n tags:\n - Issue Policies\n summary: Delete an issue policy\n description: |\n Delete an issue policy. Your organization's default issue policy cannot be deleted. Change your organization's default issue policy with the `POST /policies/{policyId}/default` endpoint.\n parameters:\n - name: id\n in: path\n description: Issue Policy ID (UUID).\n required: true\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n format: uuid\n responses:\n '204':\n description: Success. Issue policy is deleted.\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/risk/policies/{policyId}/assignments/{id}:\n get:\n operationId: getPolicyAssignmentById\n tags:\n - Policy Assignments\n summary: Fetch policy assignment by id\n description: A policy can be assigned to multiple projects. This API is to fetch an association based on the assignment ID (UUID).\n parameters:\n - name: policyId\n in: path\n description: Policy ID (UUID).\n required: true\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n format: uuid\n - name: id\n in: path\n description: Policy assignment ID (UUID). You can get the assignment ID from `/policies/{policyId}/assignment` endpoint.\n required: true\n example: 8630cf4e-1e49-5f04-9c38-f19b62952f45\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success. Policy assignment successfully created.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.policy-assignments-1+json:\n schema:\n $ref: '#/components/schemas/PolicyAssignmentResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PolicyAssignmentResponse'\n application/vnd.polaris.policy.policy-assignments-1+json:\n schema:\n $ref: '#/components/schemas/PolicyAssignmentResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n delete:\n operationId: deletePolicyAssignmentById\n tags:\n - Policy Assignments\n summary: Delete a policy assignment by `assignment id`\n description: |\n API to delete a policy assignment by it's `assignment id`. An assignment ids can be obtained from `/policies/{policyId}/assignment`.\n parameters:\n - name: policyId\n in: path\n description: Policy ID (UUID).\n required: true\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n format: uuid\n - name: id\n in: path\n description: Policy assignment ID.\n required: true\n example: 8630cf4e-1e49-5f04-9c38-f19b62952f45\n schema:\n type: string\n format: uuid\n responses:\n '204':\n description: Success. Policy assignment successfully deleted.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/risk/policies/{policyId}/bulk-assign:\n post:\n operationId: bulkPolicyAssignment\n tags:\n - Policy Assignments\n summary: Associate multiple projects to a policy in bulk\n description: |\n Through this API you can associate multiple projects from different applications to a single policy.\n\n You can assign up to 5 issue policies and one test scheduling policy to a project or branch.\n parameters:\n - name: policyId\n in: path\n description: Policy ID (UUID).\n required: true\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n format: uuid\n requestBody:\n content:\n application/vnd.polaris.policies.policy-bulk-assign-1+json:\n schema:\n $ref: '#/components/schemas/PolicyBulkAssignmentPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/PolicyBulkAssignmentPayload'\n application/vnd.polaris.policy.policy-bulk-assign-1+json:\n schema:\n $ref: '#/components/schemas/PolicyBulkAssignmentPayload'\n responses:\n '204':\n description: Success. Policy assignments successfully created.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/risk/policies/{policyId}/bulk-unassign:\n post:\n operationId: bulkUnassignPolicyAssignment\n tags:\n - Policy Assignments\n summary: Un-Associate multiple projects from a policy\n description: |\n Through this API you can un-associate multiple projects in bulk.\n parameters:\n - name: policyId\n in: path\n description: Policy id (UUID).\n required: true\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n format: uuid\n requestBody:\n content:\n application/vnd.polaris.policies.policy-bulk-unassign-1+json:\n schema:\n $ref: '#/components/schemas/PolicyBulkAssignmentRemovalPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/PolicyBulkAssignmentRemovalPayload'\n application/vnd.polaris.policy.policy-bulk-unassign-1+json:\n schema:\n $ref: '#/components/schemas/PolicyBulkAssignmentRemovalPayload'\n responses:\n '204':\n description: Success. Policy assignments successfully created.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/assignments:\n post:\n operationId: addAssignments\n tags:\n - Policy Assignments V2\n summary: Assign a policy to one or more projects or branches\n description: |\n Through this API you can associate multiple projects as well as single project from different applications to a single or multiple policies at once.\n\n You can assign up to 5 issue policies and one test scheduling policy to a project or branch.\n requestBody:\n content:\n application/vnd.polaris.policies.policy-bulk-assignment-2+json:\n schema:\n $ref: '#/components/schemas/BulkAssignmentsPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/BulkAssignmentsPayload'\n application/vnd.polaris.policy.policy-bulk-assignment-2+json:\n schema:\n $ref: '#/components/schemas/BulkAssignmentsPayload'\n responses:\n '204':\n description: Success. Policy assignments successfully created.\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n delete:\n operationId: deleteAssignments\n tags:\n - Policy Assignments V2\n summary: Delete policy assignments\n description: |\n Through this API you can remove the association of multiple projects as well as single project from different applications to a single or multiple policies at once.\n requestBody:\n content:\n application/vnd.polaris.policies.policy-bulk-unassignment-2+json:\n schema:\n $ref: '#/components/schemas/BulkAssignmentsPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/BulkAssignmentsPayload'\n application/vnd.polaris.policy.policy-bulk-unassignment-2+json:\n schema:\n $ref: '#/components/schemas/BulkAssignmentsPayload'\n responses:\n '204':\n description: Success. Policy assignments successfully deleted.\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n get:\n operationId: getAllPolicyAssignments\n tags:\n - Policy Assignments V2\n summary: Get a policy’s assignments\n description: Each policy can be assigned to multiple projects and branches. This endpoint returns a list of projects and/or branches a policy is assigned to.\n parameters:\n - name: _filter\n in: query\n description: Policy ID (UUID).\n required: true\n example: policyId==7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n - name: _offset\n in: query\n description: >-\n OReturns 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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n responses:\n '200':\n description: Success. Policy assignment fetched successfully.\n content:\n application/vnd.polaris.policies.policy-assignments-1+json:\n schema:\n $ref: '#/components/schemas/PoliciesAssignmentResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PoliciesAssignmentResponse'\n application/vnd.polaris.policy.policy-assignments-1+json:\n schema:\n $ref: '#/components/schemas/PoliciesAssignmentResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/policies/assignments/id:\n get:\n operationId: getAssignmentById\n tags:\n - Policy Assignments V2\n summary: Get policy assignment details\n description: A policy can be assigned to multiple projects. This API is to fetch assignments by their respective Id's.\n parameters:\n - name: assignmentId\n in: query\n description: Assignment ID (UUID).\n required: true\n example: assignmentId=7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n format: UUID\n responses:\n '200':\n description: Success. Policy assignment fetched successfully.\n content:\n application/vnd.polaris.policies.policy-assignments-1+json:\n schema:\n $ref: '#/components/schemas/PoliciesAssignmentResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PoliciesAssignmentResponse'\n application/vnd.polaris.policy.policy-assignments-1+json:\n schema:\n $ref: '#/components/schemas/PoliciesAssignmentResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/policies/policy-settings:\n post:\n operationId: policySettings\n tags:\n - Policy Settings\n summary: Set your organization’s default policies\n description: >\n Manage your organization's policy settings with this endpoint.\n\n\n Currently, you can change your organization's default issue or test scheduling policy.\n\n Whenever you create a new project, the default policies are assigned to it.\n\n When you change a default policy, the new default policy will not be reassigned to projects and branches assigned to the previous default policy. However, new projects will be assigned the new\n default policy.\n\n\n Two out-of-the-box policies are included with Polaris:\n * `Critical, High Severity notify` (issue policy)\n * `Test Weekly` (test scheduling policy)\n requestBody:\n content:\n application/vnd.polaris.policies.policy-default-1+json:\n schema:\n $ref: '#/components/schemas/PolicySettingsPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/PolicySettingsPayload'\n application/vnd.polaris.policy.policy-default-1+json:\n schema:\n $ref: '#/components/schemas/PolicySettingsPayload'\n responses:\n '204':\n description: Success. Policy is set to default successfully.\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/risk/policies/{policyId}/default:\n post:\n operationId: markDefaultPolicy\n tags:\n - Policy Assignments\n summary: Set your organization’s default policies\n description: |\n Marking a policy as default for your organization is important.\n\n All the projects onboarded will be assigned the default policy.\n\n Below are initial default policies.\n * `Issue Policy` : Critical, High Severity notify\n * `TestSchedulingPolicy` : Test Weekly\n\n A `default` policy cannot be deleted.\n parameters:\n - name: policyId\n in: path\n description: Policy ID (UUID).\n required: true\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n format: uuid\n responses:\n '204':\n description: Success. Policy assignments successfully created.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/risk/policies/{policyId}/assignments:\n post:\n operationId: associatePolicyAssignments\n tags:\n - Policy Assignments\n summary: Associate a project with a policy\n description: |\n Currently, only projects can be associated with policies using this API. The project ID is used as the associationId.\n\n Post creation, an ID is generated which can be used to manage the assignment.\n\n If you are assigning multiple policies to test-frequency-policy, the older assignment will be replaced by the newer one.\n parameters:\n - name: policyId\n in: path\n description: Policy ID (UUID).\n required: true\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n format: uuid\n requestBody:\n content:\n application/vnd.polaris.policies.policy-assignments-1+json:\n schema:\n $ref: '#/components/schemas/PolicyAssignmentPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/PolicyAssignmentPayload'\n application/vnd.polaris.policy.policy-assignments-1+json:\n schema:\n $ref: '#/components/schemas/PolicyAssignmentPayload'\n responses:\n '200':\n description: Success. Policy assignment successfully created.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.policy-assignments-1+json:\n schema:\n $ref: '#/components/schemas/PolicyAssignmentResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PolicyAssignmentResponse'\n application/vnd.polaris.policy.policy-assignments-1+json:\n schema:\n $ref: '#/components/schemas/PolicyAssignmentResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n get:\n operationId: getPolicyAssignments\n tags:\n - Policy Assignments\n summary: Find project assignments for a Policy\n description: |\n You can get all the projects assigned to a policy through this API.\n\n Currently, only projects can be associated to a policy.\n parameters:\n - name: policyId\n in: path\n description: Policy ID (UUID).\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n required: true\n schema:\n type: string\n format: uuid\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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n responses:\n '200':\n description: Success. Paged list of policy associations under an organization.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyCollectionResponse'\n application/vnd.polaris.policy.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/risk/policies/test-frequency-policy:\n post:\n operationId: createTestFrequencyPolicy\n tags:\n - Test Scheduling Policies\n summary: Create a test scheduling policy\n description: >\n Through this API you can create a test scheduling policy. You can automatically schedule your tests for projects configured with SCM details. For non-SCM projects, this policy is not\n applicable.\n\n\n Currently, you can schedule tests for `Daily` OR `Weekly`. You can mark any policy as an organization default.\n\n\n Multi-policy support is not available for test-frequency-policy. `Test Weekly` policy will be onboarded by the system.\n\n\n Scheduling of execution:\n\n * `Daily` - When a test is completed, the next will be scheduled. A test will be automatically registered within 24 hours.\n * `Weekly` - When a test is completed, the next will be scheduled. A test will be automatically registered within one week.\n requestBody:\n content:\n application/vnd.polaris.policies.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyPayload'\n application/vnd.polaris.policy.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyPayload'\n responses:\n '201':\n description: Success. Test Scheduling Policy successfully created.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyResponse'\n application/vnd.polaris.policy.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n get:\n operationId: getTestFrequencyPolicy\n tags:\n - Test Scheduling Policies\n summary: List test scheduling policies\n description: |\n You can filter the created test frequency policy through its name using this API.\n parameters:\n - name: _filter\n in: query\n description: |\n Filters the collection of Test Scheduling policies under an organization.\n\n The filter follows the RSQL syntax. For example, `name=='Test Weekly'`.\n\n For more details, see `https://github.com/jirutka/rsql-parser`.\n example: name=='Test Weekly'\n schema:\n type: string\n - name: associationId\n in: query\n example: 61ef159d-8421-4f0a-b15f-a8b5bce75426\n description: ID of the portfolio-related entity. For example, Project ID.\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts the collection of Test Scheduling policies under an organization. The default sorting order is by `name` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`.\n example: name|asc\n schema:\n type: string\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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n responses:\n '200':\n description: Success. Paged list of Test Scheduling policies under an organization.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyCollectionResponse'\n application/vnd.polaris.policy.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/test-scheduling-policies:\n post:\n operationId: createTestSchedulingPolicy\n tags:\n - Test Scheduling Policies\n summary: Create a test scheduling policy\n description: >\n Through this API you can create a test scheduling policy. You can automatically schedule your tests for projects configured with SCM details. For non-SCM projects, this policy is not\n applicable.\n\n\n Currently, you can schedule tests for `Daily` OR `Weekly`. You can mark any policy as an organization default.\n\n\n Multi-policy support is not available for test-frequency-policy. `Test Weekly` policy will be onboarded by the system.\n\n\n Scheduling of execution:\n\n * `Daily` - When a test is completed, the next will be scheduled. A test will be automatically registered within 24 hours.\n * `Weekly` - When a test is completed, the next will be scheduled. A test will be automatically registered within one week.\n requestBody:\n content:\n application/vnd.polaris.policies.test-scheduling-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyPayload'\n application/vnd.polaris.policy.test-scheduling-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyPayload'\n responses:\n '201':\n description: Success. Test Scheduling Policy successfully created.\n content:\n application/vnd.polaris.policies.test-scheduling-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestSchedulingPolicyResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/TestSchedulingPolicyResponse'\n application/vnd.polaris.policy.test-scheduling-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestSchedulingPolicyResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n get:\n operationId: getTestSchedulingPolicy\n tags:\n - Test Scheduling Policies\n summary: List test scheduling policies\n description: |\n You can filter the created test scheduling policy through its name using this API.\n parameters:\n - name: _filter\n in: query\n description: |\n Filters the collection of Test Scheduling Policies under an organization.\n\n The filter follows the RSQL syntax. For example, `name=='Test Weekly'`.\n\n For more details, see `https://github.com/jirutka/rsql-parser`\n example: name=='Test Weekly'\n schema:\n type: string\n - name: associationId\n in: query\n example: 61ef159d-8421-4f0a-b15f-a8b5bce75426\n description: ID of the portfolio-related entity. For example, Project ID.\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts the collection of Test Scheduling policies under an organization. The default sorting order is by `name` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`.\n example: name|asc\n schema:\n type: string\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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n responses:\n '200':\n description: Success. Paged list of Test Scheduling policies under an organization.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.test-scheduling-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestSchedulingPolicyCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/TestSchedulingPolicyCollectionResponse'\n application/vnd.polaris.policy.test-scheduling-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestSchedulingPolicyCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/risk/policies/test-frequency-policy/{id}:\n get:\n operationId: getTestFrequencyPolicyById\n tags:\n - Test Scheduling Policies\n summary: Get a test scheduling policy’s details\n description: |\n Fetch the policy details by UUID. Policy ID can be found by `/policies/test-frequency-policy`.\n parameters:\n - name: id\n in: path\n description: Test Frequency Policy ID.\n example: 61ef159d-8421-4f0a-b15f-a8b5bce75426\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success. Test Frequency Policies by ID.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyResponse'\n application/vnd.polaris.policy.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n put:\n operationId: updateTestFrequencyPolicyById\n tags:\n - Test Scheduling Policies\n summary: Update a test scheduling policy’s properties\n description: |\n Update your test frequency policy details. You can update the name, description, policy rules, project associations, etc.\n\n If you change the rule, all the associated SCM projects will be updated according to the new rule.\n parameters:\n - name: id\n in: path\n description: Test Frequency Policy ID (UUID).\n example: 61ef159d-8421-4f0a-b15f-a8b5bce75426\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Any one of, or all of, the following Test Frequency Policy attributes can be updated.\n content:\n application/vnd.polaris.policies.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyPayload'\n application/vnd.polaris.policy.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyPayload'\n responses:\n '200':\n description: Success. Test Frequency Policy successfully updated.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyResponse'\n application/vnd.polaris.policy.test-frequency-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n delete:\n operationId: deleteTestFrequencyPolicyById\n tags:\n - Test Scheduling Policies\n summary: Delete a test scheduling policy\n description: |\n You can delete a test frequency policy through its ID. The ID can be obtained from `/test-frequency-policy`.\n\n You are not allowed to delete the default policy. All the associations for deleted projects will be reassigned to the default policy and schedules will be updated accordingly.\n\n Make sure you don't delete a policy which is assigned to multiple projects in the organization.\n parameters:\n - name: id\n in: path\n description: Test Frequency Policy ID (UUID).\n required: true\n example: 61ef159d-8421-4f0a-b15f-a8b5bce75426\n schema:\n type: string\n format: uuid\n responses:\n '204':\n description: Success. Test Frequency Policies deleted.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/test-scheduling-policies/{id}:\n get:\n operationId: getTestSchedulingPolicyById\n tags:\n - Test Scheduling Policies\n summary: Get a test scheduling policy’s details\n description: |\n Fetch the policy details by UUID. Policy ID can be found by `/policies/test-scheduling-policies`.\n parameters:\n - name: id\n in: path\n description: Test Scheduling Policy ID.\n example: 61ef159d-8421-4f0a-b15f-a8b5bce75426\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success. Test Scheduling Policies by ID.\n content:\n application/vnd.polaris.policies.test-scheduling-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestSchedulingPolicyResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/TestSchedulingPolicyResponse'\n application/vnd.polaris.policy.test-scheduling-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestSchedulingPolicyResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n put:\n operationId: updateTestSchedulingPolicyById\n tags:\n - Test Scheduling Policies\n summary: Update a test scheduling policy’s properties\n description: |\n Update your test scheduling policy details. You can update the name, description, policy rules, project associations, etc.\n\n If you change the rule, all the associated SCM projects will be updated according to the new rule.\n parameters:\n - name: id\n in: path\n description: Test Scheduling Policy ID (UUID).\n example: 61ef159d-8421-4f0a-b15f-a8b5bce75426\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Any one of, or all of, the following Test Scheduling Policy attributes can be updated.\n content:\n application/vnd.polaris.policies.test-scheduling-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyPayload'\n application/json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyPayload'\n application/vnd.polaris.policy.test-scheduling-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestFrequencyPolicyPayload'\n responses:\n '200':\n description: Success. Test Scheduling Policy successfully updated.\n content:\n application/vnd.polaris.policies.test-scheduling-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestSchedulingPolicyResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/TestSchedulingPolicyResponse'\n application/vnd.polaris.policy.test-scheduling-policy-1+json:\n schema:\n $ref: '#/components/schemas/TestSchedulingPolicyResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n delete:\n operationId: deleteTestSchedulingPolicyById\n tags:\n - Test Scheduling Policies\n summary: Delete a test scheduling policy\n description: |\n You can delete a test scheduling policy through its ID. The ID can be obtained from `/test-scheduling-policies`.\n\n You are not allowed to delete the default policy. All the associations for deleted projects will be reassigned to the default policy and schedules will be updated accordingly.\n\n Make sure you don't delete a policy which is assigned to multiple projects in the organization.\n parameters:\n - name: id\n in: path\n description: Test Scheduling Policy ID (UUID).\n required: true\n example: 61ef159d-8421-4f0a-b15f-a8b5bce75426\n schema:\n type: string\n format: uuid\n responses:\n '204':\n description: Success. Test Scheduling Policies deleted.\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/risk/policies/issue-policy-execution:\n get:\n operationId: getIssuePolicyExecution\n tags:\n - Issue Policy Execution\n summary: Find Issue Policy Execution for the testId\n description: |\n Issue policy executions for all the policies assigned to a project will be triggered once your test is completed.\n This API will provide policy execution status. This can be used by Bridge to `Break the build` if there are any policy violations.\n Based on the policy actions configuration, policy evaluation actions will be triggered.\n API supports only `testId` filter.<br />\n\n The following statuses will be returned, depending on the policy evaluation. <br />\n\n * `PENDING` - Policy evaluation is in queue. <br />\n * `EVALUATED` - Policy evaluated and actions are determined. <br />\n * `ACTIONS_EXECUTING` - Policy evaluation is executing actions like sending `Email notifications` and `Break the build`. <br />\n * `FAILED` - Due to system failure, policy evaluation failed. <br />\n * `COMPLETED` - Policy evaluation completed, including triggering actions. <br />\n parameters:\n - name: _filter\n in: query\n description: |\n Filters the collection of issue policy execution under an organization.\n The filter follows the RSQL syntax. For example, `testId=='f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454'`.\n example: testId=='f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454'\n schema:\n type: string\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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n responses:\n '200':\n description: Success. Paged list of Issue Policy Execution under an organization for the provided test-id.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.issue-policy-execution-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyExecutionCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePolicyExecutionCollectionResponse'\n application/vnd.polaris.policy.issue-policy-execution-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyExecutionCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/issue-policies/execution:\n get:\n operationId: getIssuePoliciesExecution\n tags:\n - Issue Policy Execution\n summary: Find Issue Policy Execution for the testId\n description: |\n Issue policy executions for all the policies assigned to a project will be triggered once your test is completed.\n This API will provide policy execution status. This can be used by Bridge to `Break the build` if there are any policy violations.\n Based on the policy actions configuration, policy evaluation actions will be triggered.\n API supports only `testId` filter.<br />\n\n The following statuses will be returned, depending on the policy evaluation. <br />\n\n * `PENDING` - Policy evaluation is in queue. <br />\n * `EVALUATED` - Policy evaluated and actions are determined. <br />\n * `ACTIONS_EXECUTING` - Policy evaluation is executing actions like sending `Email notifications` and `Break the build`. <br />\n * `FAILED` - Due to system failure, policy evaluation failed. <br />\n * `COMPLETED` - Policy evaluation completed, including triggering actions. <br />\n parameters:\n - name: _filter\n in: query\n description: |\n Filters the collection of issue policy execution under an organization.\n The filter follows the RSQL syntax. For example, `testId=='f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454'`.\n example: testId=='f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454'\n schema:\n type: string\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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n responses:\n '200':\n description: Success. Paged list of Issue Policy Execution under an organization for the provided test-id.\n content:\n application/vnd.polaris.policies.issue-policy-execution-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesExecutionCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesExecutionCollectionResponse'\n application/vnd.polaris.policy.issue-policy-execution-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesExecutionCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/risk/policies/issue-policy-execution/{id}:\n get:\n operationId: getIssuePolicyExecutionById\n tags:\n - Issue Policy Execution\n summary: Fetch Issue Policy execution details by execution id\n description: |\n API to fetch the issue policy execution details by execution ID. Policy executions will be triggered internally whenever you test your code.\n parameters:\n - name: id\n in: path\n description: Issue Policy execution ID (UUID).\n example: c7a7bfbc-5f86-4b5c-9058-cad94fffcd3c\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success. Issue Policies execution details.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.issue-policy-execution-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyExecutionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePolicyExecutionResponse'\n application/vnd.polaris.policy.issue-policy-execution-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyExecutionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/issue-policies/execution/{id}:\n get:\n operationId: getIssuePoliciesExecutionById\n tags:\n - Issue Policy Execution\n summary: Fetch Issue Policy execution details by execution id\n description: |\n API to fetch the issue policy execution details by execution ID. Policy executions will be triggered internally whenever you test your code.\n parameters:\n - name: id\n in: path\n description: Issue Policy execution ID (UUID).\n example: c7a7bfbc-5f86-4b5c-9058-cad94fffcd3c\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success. Issue Policies execution details.\n content:\n application/vnd.polaris.policies.issue-policy-execution-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesExecutionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesExecutionResponse'\n application/vnd.polaris.policy.issue-policy-execution-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesExecutionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/risk/policies/portfolio-policy-configuration:\n get:\n operationId: getPortfolioPolicyConfig\n tags:\n - Portfolio Policy Configuration\n summary: Find Portfolio Policy Configuration for the organization using filter criteria.\n description: |\n You can filter the created portfolio policy configuration using this API.\n parameters:\n - name: _filter\n in: query\n description: |\n Filters the collection of portfolio policy configuration under an organization.\n\n The filter follows the RSQL syntax. \n | Field | Allowed Operation |\n |-----------------|------------------------|\n | associationType | ==, =ik=, =ic= and =ic=|\n | associationId | ==, =ik=, =ic= and =ic=|\n example: associationId=='f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454'\n schema:\n type: string\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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n responses:\n '200':\n description: Success. Paged list of portfolio policy configuration under an organization.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationCollectionResponse'\n application/vnd.polaris.policy.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n post:\n operationId: createUpdatePortfolioPolicyConfig\n tags:\n - Portfolio Policy Configuration\n summary: Create or update Portfolio Policy Configuration for an organization\n description: |\n Through this API you can\n * Create a policy association for a project or branch.\n * Enable or disable policy execution.\n * Allow a policy to be inherited .\n\n Note:\n * Project association cannot be disabled.\n * Project association cannot have inheritFromParentPolicies as true.\n * Default branch association cannot have inheritFromParentPolicies as false.\n * Field inheritFromParentPolicies and assignedPolicies are mutually exclusive.\n requestBody:\n content:\n application/vnd.polaris.policy.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationRequest'\n application/json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationRequest'\n application/vnd.polaris.policies.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationRequest'\n responses:\n '200':\n description: Success. Portfolio Policy Configuration created.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationResponse'\n application/vnd.polaris.policy.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/portfolio-policy-configuration:\n get:\n operationId: getPortfolioPoliciesConfig\n tags:\n - Portfolio Policy Configuration\n summary: Find Portfolio Policy Configuration for the organization using filter criteria.\n description: |\n You can filter the created portfolio policy configuration using this API.\n parameters:\n - name: _filter\n in: query\n description: |\n Filters the collection of portfolio policy configuration under an organization.\n\n The filter follows the RSQL syntax. \n | Field | Allowed Operation |\n |-----------------|------------------------|\n | associationType | ==, =ik=, =ic= and =ic=|\n | associationId | ==, =ik=, =ic= and =ic=|\n example: associationId=='f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454'\n schema:\n type: string\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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n responses:\n '200':\n description: Success. Paged list of portfolio policy configuration under an organization.\n content:\n application/vnd.polaris.policies.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPoliciesConfigurationCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PortfolioPoliciesConfigurationCollectionResponse'\n application/vnd.polaris.policy.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPoliciesConfigurationCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n post:\n operationId: createUpdatePortfolioPoliciesConfig\n tags:\n - Portfolio Policy Configuration\n summary: Create or update Portfolio Policy Configuration for an organization\n description: |\n Through this API you can\n * Create a policy association for a project or branch\n * Enable or disable policy execution\n * Allow a policy to be inherited \n\n Note:\n * Project association cannot be disabled\n * Project association cannot have inheritFromParentPolicies as true\n * Default branch association cannot have inheritFromParentPolicies as false\n * Field inheritFromParentPolicies and assignedPolicies are mutually exclusive\n requestBody:\n content:\n application/vnd.polaris.policies.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationRequest'\n application/json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationRequest'\n application/vnd.polaris.policy.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationRequest'\n responses:\n '200':\n description: Success. Portfolio Policy Configuration created.\n content:\n application/vnd.polaris.policies.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPoliciesConfigurationResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PortfolioPoliciesConfigurationResponse'\n application/vnd.polaris.policy.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPoliciesConfigurationResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/risk/policies/portfolio-policy-configuration/{id}:\n get:\n operationId: getPortfolioPolicyConfigById\n tags:\n - Portfolio Policy Configuration\n summary: Get a portfolio policy configuration’s details.\n description: |\n Fetch the portfolio policy configuration details by id.\n parameters:\n - name: id\n in: path\n description: Portfolio Policy Configuration (UUID).\n required: true\n schema:\n type: string\n example: 4a6daa6a-72eb-492d-acc5-44fbf388f708\n responses:\n '200':\n description: Success. Portfolio Policy Configuration details.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationResponse'\n application/vnd.polaris.policy.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/portfolio-policy-configuration/{id}:\n get:\n operationId: getPortfolioPoliciesConfigById\n tags:\n - Portfolio Policy Configuration\n summary: Fetch Portfolio Policy Configuration by id.\n description: |\n Fetch the portfolio policy configuration details by id.\n parameters:\n - name: id\n in: path\n description: Portfolio Policy Configuration (UUID).\n required: true\n schema:\n type: string\n example: 4a6daa6a-72eb-492d-acc5-44fbf388f708\n responses:\n '200':\n description: Success. Portfolio Policy Configuration details.\n content:\n application/vnd.polaris.policies.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPoliciesConfigurationResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PortfolioPoliciesConfigurationResponse'\n application/vnd.polaris.policy.portfolio-policy-configuration-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioPoliciesConfigurationResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/risk/policies/issue-policy/evaluations:\n get:\n operationId: getIssuePolicyEvaluations\n tags:\n - Issue Policy Evaluation\n summary: Get a list of policy evaluations\n description: |\n Returns a list of policy evaluations that match the specified parameters.\n parameters:\n - name: _filter\n in: query\n description: |\n The filter follows the RSQL syntax. \n\n | Field | Allowed Operation |\n |-----------------|------------------------|\n | triggerId | == |\n | branchId | == |\n | projectId | == |\n | applicationId | == |\n\n * Fields triggerId, branchId, projectId and applicationId are mutually exclusive.\n * Trigger ID is ID of Issue policy evaluation(s) of a test, same as Test ID. A test would have a single evaluation\n example: triggerId=='bef52d71-57be-4f46-9fad-657f7ea4293a'\n schema:\n type: string\n required: true\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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n - name: recent\n in: query\n description: Returns the most recent evaluation for the selected filters.\n schema:\n type: boolean\n default: false\n example: false\n responses:\n '200':\n description: Success. A list of policy evaluations that match the specified parameters.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.issue-policy-evaluations-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyEvaluationCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePolicyEvaluationCollectionResponse'\n application/vnd.polaris.policy.issue-policy-evaluations-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyEvaluationCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/issue-policies/evaluations:\n get:\n operationId: getIssuePoliciesEvaluations\n tags:\n - Issue Policy Evaluation\n summary: Get a list of policy evaluations\n description: |\n Returns a list of policy evaluations that match the specified parameters.\n parameters:\n - name: _filter\n in: query\n description: |\n The filter follows the RSQL syntax. \n\n | Field | Allowed Operation |\n |-----------------|------------------------|\n | triggerId | == |\n | branchId | == |\n | projectId | == |\n | applicationId | == |\n\n * Fields triggerId, branchId, projectId and applicationId are mutually exclusive.\n * Trigger ID is ID of Issue policy evaluation(s) of a test, same as Test ID. A test would have a single evaluation.\n example: triggerId=='bef52d71-57be-4f46-9fad-657f7ea4293a'\n schema:\n type: string\n required: true\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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n - name: recent\n in: query\n description: Returns the most recent evaluation for the selected filters.\n schema:\n type: boolean\n default: false\n example: false\n responses:\n '200':\n description: Success. A list of policy evaluations that match the specified parameters.\n content:\n application/vnd.polaris.policies.issue-policy-evaluations-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesEvaluationCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesEvaluationCollectionResponse'\n application/vnd.polaris.policy.issue-policy-evaluations-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesEvaluationCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/risk/policies/issue-policy/evaluations/{id}:\n get:\n operationId: getIssuePolicyEvaluationById\n tags:\n - Issue Policy Evaluation\n summary: Get a policy evaluation’s details\n description: |\n Returns an issue policy evaluation specified by its ID.\n parameters:\n - name: id\n in: path\n description: Issue policy evaluation ID in the UUID format.\n example: e6d1bc61-68ed-4d0c-8fbe-a3a59168b09d\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success. Issue policy evaluation with the specified ID.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.issue-policy-evaluations-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyEvaluationResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePolicyEvaluationResponse'\n application/vnd.polaris.policy.issue-policy-evaluations-1+json:\n schema:\n $ref: '#/components/schemas/IssuePolicyEvaluationResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/issue-policies/evaluations/{id}:\n get:\n operationId: getIssuePoliciesEvaluationById\n tags:\n - Issue Policy Evaluation\n summary: Get a policy evaluation’s details\n description: |\n Returns an issue policy evaluation specified by its ID.\n parameters:\n - name: id\n in: path\n description: Issue policy evaluation ID in the UUID format.\n example: e6d1bc61-68ed-4d0c-8fbe-a3a59168b09d\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success. Issue policy evaluation with the specified ID.\n content:\n application/vnd.polaris.policies.issue-policy-evaluations-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesEvaluationResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesEvaluationResponse'\n application/vnd.polaris.policy.issue-policy-evaluations-1+json:\n schema:\n $ref: '#/components/schemas/IssuePoliciesEvaluationResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/risk/policies/issue-policy/issues-violating-policies/counts:\n get:\n operationId: getCountOfIssueViolatingPolicy\n tags:\n - Issue Policy Evaluation\n summary: Get the quantity of issues that violate issue policies in applications, projects, or branches\n description: |\n Returns the count of policy violating issues that match the specified parameters.\n parameters:\n - name: _filter\n in: query\n description: |\n The filter follows the RSQL syntax. \n\n | Field | Allowed Operation |\n |-----------------|------------------------|\n | applicationId | == and =in= |\n | projectId | == and =in= |\n | branchId | == and =in= |\n\n * Field applicationId, projectId and branchId are mutually exclusive.\n * =in= operation allows at most 20 values.\n example: applicationId=='f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454'\n schema:\n type: string\n required: true\n - name: _includeEvaluation\n in: query\n description: Includes \"impactingEvaluation\" - refers to the evaluation that caused the current count.\n schema:\n type: boolean\n default: false\n example: false\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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n responses:\n '200':\n description: Success. Returns the count of recent issue violations that match the specified parameters.\n headers:\n DeprecationHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/DeprecationHeader'\n LinkHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/LinkHeader'\n SunsetHeader:\n $ref: '#/paths/~1api~1risk~1policies~1actions/get/responses/200/headers/SunsetHeader'\n content:\n application/vnd.polaris.policies.issues-violating-policies-counts-1+json:\n schema:\n $ref: '#/components/schemas/IssueViolationCountCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssueViolationCountCollectionResponse'\n application/vnd.polaris.policy.issues-violating-policies-counts-1+json:\n schema:\n $ref: '#/components/schemas/IssueViolationCountCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n deprecated: true\n /api/policies/issue-policies/violations/counts:\n get:\n operationId: getCountOfIssueViolatingPolicies\n tags:\n - Issue Policy Evaluation\n summary: Get the quantity of issues that violate issue policies in applications, projects, or branches\n description: |\n Returns the count of policy violating issues that match the specified parameters.\n parameters:\n - name: _filter\n in: query\n description: |\n The filter follows the RSQL syntax. \n\n | Field | Allowed Operation |\n |-----------------|------------------------|\n | applicationId | == and =in= |\n | projectId | == and =in= |\n | branchId | == and =in= |\n\n * Field applicationId, projectId and branchId are mutually exclusive.\n * =in= operation allows at most 20 values.\n example: applicationId=='f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454'\n schema:\n type: string\n required: true\n - name: _includeEvaluation\n in: query\n description: Includes \"impactingEvaluation\" - refers to the evaluation that caused the current count.\n schema:\n type: boolean\n default: false\n example: false\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 example: 0\n - name: _limit\n in: query\n description: 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 Request.\n schema:\n type: integer\n default: 100\n example: 10\n responses:\n '200':\n description: Success. Returns the count of recent issue violations that match the specified parameters.\n content:\n application/vnd.polaris.policies.issues-violating-policies-counts-1+json:\n schema:\n $ref: '#/components/schemas/IssueViolationsCountCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/IssueViolationsCountCollectionResponse'\n application/vnd.polaris.policy.issues-violating-policies-counts-1+json:\n schema:\n $ref: '#/components/schemas/IssueViolationsCountCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/policies/evaluations:\n get:\n tags:\n - Policy Evaluations\n summary: Get all evaluations\n operationId: getEvaluations\n description: >\n Returns a list of policy evaluations that match the specified parameters. The response contains the summary at all levels for the evaluation. If multiple policy use cases were evaluated, this\n returns a collection item for each use case. The `policyUseCase` RSQL parameter can be used to filter the response for a specific policy type. `triggerId` can be specified to filter the\n response for a specific trigger. For example, use `triggerId` (with a test ID) to get the evaluations for a test.\n parameters:\n - $ref: '#/paths/~1api~1policies~1actions/get/parameters/0'\n - $ref: '#/paths/~1api~1policies~1actions/get/parameters/1'\n - name: _filter\n in: query\n description: |\n The filter follows the [RSQL](https://github.com/jirutka/rsql-parser) syntax, and supports the following fields and operators:\n\n | Field | Allowed Operators |\n |-------------------|------------------------|\n | `triggerId` | `==` |\n | `branchId` | `==` |\n | `profileId` | `==` |\n | `projectId` | `==` |\n | `applicationId` | `==` |\n | `policyUseCase` | `==`, `=in=` |\n\n * Fields `branchId`, `profileId`, `projectId`, and `applicationId` are mutually exclusive.\n * Trigger represents the event that triggered an evaluation. `triggerId` is the identifier of a trigger. For example, `test id` is the trigger id for evaluations triggered by tests.\n example: triggerId=='bef52d71-57be-4f46-9fad-657f7ea4293a'\n schema:\n type: string\n responses:\n '200':\n description: Success. Policy evaluation matching specified filters.\n content:\n application/vnd.polaris.policies-policy-evaluations-2+json:\n schema:\n $ref: '#/components/schemas/PolicyEvaluationsCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PolicyEvaluationsCollectionResponse'\n application/vnd.polaris.policy-policy-evaluations-2+json:\n schema:\n $ref: '#/components/schemas/PolicyEvaluationsCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/policies/evaluations/{id}:\n get:\n operationId: fetchEvaluationById\n tags:\n - Policy Evaluations\n summary: Get a policy evaluation's details using its ID\n description: Get evaluation details by ID.\n parameters:\n - name: id\n in: path\n description: A policy evaluation ID in UUID format.\n example: e6d1bc61-68ed-4d0c-8fbe-a3a59168b09d\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success. The policy evaluation with the specified ID.\n content:\n application/vnd.polaris.policies-policy-evaluations-2+json:\n schema:\n $ref: '#/components/schemas/PolicyEvaluationResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/PolicyEvaluationResponse'\n application/vnd.polaris.policy-policy-evaluations-2+json:\n schema:\n $ref: '#/components/schemas/PolicyEvaluationResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/policies/violation-counts:\n get:\n operationId: fetchActiveViolationCounts\n tags:\n - Active Violation Counts\n summary: Fetch policy violation counts\n description: |\n This endpoint can be used to fetch active policy violations in applications, project, branches, or profiles captured by the filter.\n parameters:\n - name: _filter\n in: query\n description: |\n The filter follows the [RSQL](https://github.com/jirutka/rsql-parser) syntax, and supports the following fields and operators: \n\n | Field | Allowed operators |\n |-------------------|----------------------------|\n | `applicationId` | `==` and `=in=` |\n | `projectId` | `==` and `=in=` |\n | `branchId` | `==` and `=in=` |\n | `profileId` | `==` and `=in=` |\n\n * Field `applicationId`, `projectId`, `profileId` and `branchId` are mutually exclusive.\n * The `=in=` operator accepts up to 20 values.\n example: applicationId=='f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454'\n schema:\n type: string\n required: true\n - $ref: '#/paths/~1api~1policies~1actions/get/parameters/0'\n - $ref: '#/paths/~1api~1policies~1actions/get/parameters/1'\n responses:\n '200':\n description: Success. Returns the count of active policy violations in applications, project, branches, or profiles captured by the filter.\n content:\n application/vnd.polaris.policies.violation-counts-2+json:\n schema:\n $ref: '#/components/schemas/ActiveViolationCountCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/ActiveViolationCountCollectionResponse'\n application/vnd.polaris.policy.violation-counts-2+json:\n schema:\n $ref: '#/components/schemas/ActiveViolationCountCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/policies/policy-violations:\n get:\n operationId: fetchPolicyViolations\n tags:\n - Policy Violations\n summary: Fetch policy violations for the supplied filters\n description: |\n Fetchs policy violations for a `branch` or `profile` based on the supplied filters.\n parameters:\n - name: _filter\n in: query\n description: |\n The filter follows the [RSQL](https://github.com/jirutka/rsql-parser) syntax, and supports the following fields and operators:\n\n | Field | Allowed Operators | Description |\n |--------------------|-------------------|-------------------------------------------------------------|\n | `branchId` | `==` | |\n | `profileId` | `==` | | \n | `triggerId` | `==` | |\n | `addedInTrigger` | `==` | boolean parameter |\n | `removedInTrigger` | `==` | boolean parameter |\n | `entityId` | `==`,`=in=` | Filter violations for specific entity ids |\n | `policyId` | `==`,`=in=` | Filter violations matching specific policy ids |\n | `policyUseCase` | `==` | Specify which policy use case violations needs to be listed |\n\n * You must specify `policyUseCase`. Listing violations of different use cases (`issue_policy`, `component_policy`) is not supported in a single request.\n * One of `profileId` or `branchId` must be specified.\n * `profileId` and `branchId` are mutually exclusive.\n * `entityId` refers to a resource that is violating the policy (for example, `issue_family` or `component`).\n * Use `triggerId` to get snapshot of violations at a point in time (when the evaluation associated with the `triggerId` was performed).\n * Use `addedInTrigger` to get violations that were first detected at a point in time (when the evaluation associated with the `triggerId` was performed). \n * Use `removedInTrigger` to get violations that were resolved at a point in time (when the evaluation associated with the `triggerId` was performed). \n * `triggerId` must be specified to use the `addedInTrigger` or `removedInTrigger` parameters.\n example: branchId=='f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454'\n schema:\n type: string\n required: true\n - $ref: '#/paths/~1api~1policies~1actions/get/parameters/0'\n - $ref: '#/paths/~1api~1policies~1actions/get/parameters/1'\n responses:\n '200':\n description: Success. Returns the count of policy violations that match the specified parameters.\n content:\n application/vnd.polaris.policies.violations-1+json:\n schema:\n $ref: '#/components/schemas/ViolatingEntityCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/ViolatingEntityCollectionResponse'\n application/vnd.polaris.policy.violations-1+json:\n schema:\n $ref: '#/components/schemas/ViolatingEntityCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/policies/component-policies:\n post:\n operationId: createComponentPolicy\n tags:\n - Component Policies\n summary: Create a new component policy\n description: |\n Create a component policy.\n Component policies can be defined against properties of SCM component. For example, you can define a policy to flag violation if a component with `GPL` license is found. \n Creates a name and description so that the user knows which policy to select when onboarding projects in the future.\n You can add a maximum of five rules to a policy. Each rule must have one or more actions specified.\n requestBody:\n content:\n application/vnd.polaris.policies.component-policy-1+json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n application/json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n application/vnd.polaris.policy.component-policy-1+json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n responses:\n '201':\n description: Success. Component Policy successfully created.\n content:\n application/vnd.polaris.policies.component-policy-1+json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n application/json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n application/vnd.polaris.policy.component-policy-1+json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n get:\n operationId: getComponentPolicies\n tags:\n - Component Policies\n summary: Find component policies with specific properties\n description: >\n Get the component policies in your organization. Include a `_filter` expression to get policies with specific properties. Include an `associationId` to get policies linked to a project or\n branch.\n parameters:\n - name: _filter\n in: query\n description: |\n Filters the collection of component policies included in the response.\n The filter follows the [RSQL](https://github.com/jirutka/rsql-parser) syntax. For example, `name=='Notify for GPL license components'`.\n example: name=='Notify for AGPL Components'\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Defines the order of the results. The default setting is `name` in `ascending` order. The format of the `_sort` parameter is `{field_name}|{asc|desc},{field_name}|{asc|desc},...`. Right\n now, only the field `name` is supported.\n example: name|asc\n schema:\n type: string\n - $ref: '#/paths/~1api~1policies~1actions/get/parameters/0'\n - $ref: '#/paths/~1api~1policies~1actions/get/parameters/1'\n - name: associationId\n in: query\n example: 61ef159d-8421-4f0a-b15f-a8b5bce75426\n description: ID of a project or a branch.\n schema:\n type: string\n responses:\n '200':\n description: Success. Paged list of component policies under an organization.\n content:\n application/vnd.polaris.policies.component-policy-1+json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyCollectionResponse'\n application/json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyCollectionResponse'\n application/vnd.polaris.policy.component-policy-1+json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyCollectionResponse'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n /api/policies/component-policies/{id}:\n get:\n operationId: getComponentPolicyById\n tags:\n - Component Policies\n summary: Fetch a component policy by ID\n description: |\n API to fetch the component policy record by its ID.\n parameters:\n - name: id\n in: path\n description: Component policy ID in UUID format.\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success. Component policy by ID.\n content:\n application/vnd.polaris.policies.component-policy-1+json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n application/json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n application/vnd.polaris.policy.component-policy-1+json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n put:\n operationId: updateComponentPolicyById\n tags:\n - Component Policies\n summary: Update a component policy's details\n description: |\n Update a component policy's details, including name, description, and rules.\n parameters:\n - name: id\n in: path\n description: Component policy ID in UUID format.\n required: true\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n format: uuid\n requestBody:\n description: Any one of, or all of, the following component policy attributes can be updated.\n content:\n application/vnd.polaris.policies.component-policy-1+json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n application/json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n application/vnd.polaris.policy.component-policy-1+json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n responses:\n '200':\n description: Success. Component Policy successfully updated.\n content:\n application/vnd.polaris.policies.component-policy-1+json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n application/json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n application/vnd.polaris.policy.component-policy-1+json:\n schema:\n $ref: '#/components/schemas/ComponentPolicyItem'\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\n delete:\n operationId: deleteComponentPolicyById\n tags:\n - Component Policies\n summary: Delete an existing component policy by ID\n description: |\n Delete a component policy. The default component policy cannot be deleted. To delete a default component policy, you need to change the default component policy first. \n Any orphaned assignments of projects/branches will be auto assigned to default policy.\n parameters:\n - name: id\n in: path\n description: Component policy ID in UUID format.\n required: true\n example: 7520cf4e-1e49-4e93-9c38-f19b62952e14\n schema:\n type: string\n format: uuid\n responses:\n '204':\n description: Success. Component policy is deleted.\n '400':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/400'\n '401':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/401'\n '404':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/404'\n '406':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/406'\n '415':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/415'\n '500':\n $ref: '#/paths/~1api~1policies~1actions/get/responses/500'\ncomponents:\n securitySchemes:\n ApiKeyAuth:\n type: apiKey\n in: header\n name: Api-Token\n schemas:\n Actions:\n description: Actions.\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: A unique ID for each policy action.\n name:\n type: string\n format: string\n description: Name of the action. Supported names are `SEND_EMAIL`, `BREAK_THE_BUILD`, `CREATE_BUNDLE_JIRA_TICKET`.\n longName:\n type: string\n format: string\n description: Descriptive name of the action.\n example: Send Notification\n _type:\n readOnly: true\n type: string\n format: string\n description: The Type of the resource.\n example:\n id: fe0c852a-0b9f-494e-9e57-c256eb8366d0\n ActionsGetResponse:\n description: Actions Response\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\n $ref: '#/components/schemas/Actions'\n _links:\n $ref: '#/components/schemas/Links'\n _collection:\n $ref: '#/components/schemas/Collections'\n example:\n _items:\n - name: SEND_EMAIL\n longName: Send Notification\n id: 9cfeeaba-dd52-11ec-9d64-0242ac120002\n _type: actions\n _links:\n - href: ${base.path}/policies/actions/9cfeeaba-dd52-11ec-9d64-0242ac120002\n rel: self\n method: GET\n - name: BREAK_THE_BUILD\n longName: Attempt Build Break\n id: 07047b10-f9ba-4e43-bdb7-f9152c9e713c\n _type: actions\n _links:\n - href: ${base.path}/policies/actions/07047b10-f9ba-4e43-bdb7-f9152c9e713c\n rel: self\n method: GET\n - name: CREATE_BUNDLE_JIRA_TICKET\n longName: Create and bundle to 1 JIRA ticket\n id: 68468e8c-b35f-46df-a485-7493c9618b33\n _type: actions\n _links:\n - href: ${base.path}/policies/actions/68468e8c-b35f-46df-a485-7493c9618b33\n rel: self\n method: GET\n _links:\n - href: ${base.path}/policies/actions\n rel: self\n method: GET\n - href: ${base.path}/policies/actions?_offset=0&_limit=100\n rel: first\n method: GET\n - href: ${base.path}/policies/actions?_offset=0&_limit=100\n rel: last\n method: GET\n _collection:\n itemCount: 4\n pageCount: 1\n currentPage: 1\n _type: actions\n PolicyActionsGetResponse:\n description: Actions Response.\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\n $ref: '#/components/schemas/Actions'\n _links:\n $ref: '#/components/schemas/Links'\n _collection:\n $ref: '#/components/schemas/Collections'\n example:\n _items:\n - name: SEND_EMAIL\n longName: Send Notification\n id: 9cfeeaba-dd52-11ec-9d64-0242ac120002\n _type: actions\n _links:\n - href: ${base.path}/actions/9cfeeaba-dd52-11ec-9d64-0242ac120002\n rel: self\n method: GET\n - name: BREAK_THE_BUILD\n longName: Attempt Build Break\n id: 07047b10-f9ba-4e43-bdb7-f9152c9e713c\n _type: actions\n _links:\n - href: ${base.path}/actions/07047b10-f9ba-4e43-bdb7-f9152c9e713c\n rel: self\n method: GET\n - name: CREATE_BUNDLE_JIRA_TICKET\n longName: Create and bundle to 1 JIRA ticket\n id: 68468e8c-b35f-46df-a485-7493c9618b33\n _type: actions\n _links:\n - href: ${base.path}/actions/68468e8c-b35f-46df-a485-7493c9618b33\n rel: self\n method: GET\n _links:\n - href: ${base.path}/actions\n rel: self\n method: GET\n - href: ${base.path}/actions?_offset=0&_limit=100\n rel: first\n method: GET\n - href: ${base.path}/actions?_offset=0&_limit=100\n rel: last\n method: GET\n _collection:\n itemCount: 4\n pageCount: 1\n currentPage: 1\n _type: actions\n IssuePolicyPolicyPayload:\n description: Issue Policy Payload.\n required:\n - name\n type: object\n properties:\n name:\n type: string\n description: Name of the policy.\n description:\n type: string\n description: Description of the policy.\n filterGroups:\n $ref: '#/components/schemas/FilterGroups'\n example:\n name: Notify for Critical, High issues\n description: Send notification for any critical- or high-severity issues.\n filterGroups:\n rules:\n - ruleNumber: 1\n filter:\n powerFilterQuery: context:tool-type=in=('sast','sca');issueProperties:severity=in=('critical','high')\n actions:\n - name: SEND_EMAIL\n disabled: false\n fixByRules:\n - query: issueProperties:severity==critical\n days: 7\n disabled: false\n - query: issueProperties:severity==high\n days: 14\n disabled: false\n - query: issueProperties:severity==medium\n days: 30\n disabled: false\n - query: issueProperties:severity==low\n days: 60\n disabled: false\n - query: issueProperties:severity==informational\n days: 90\n disabled: false\n default: false\n IssuePolicyPolicyCollectionResponse:\n type: object\n properties:\n _items:\n type: array\n description: List of policies.\n items:\n $ref: '#/components/schemas/IssuePolicyResponse'\n _links:\n $ref: '#/components/schemas/Links'\n _collection:\n $ref: '#/components/schemas/Collections'\n IssuePolicyPoliciesCollectionResponse:\n type: object\n required:\n - _items\n properties:\n _items:\n description: List of policies.\n type: array\n items:\n $ref: '#/components/schemas/IssuePoliciesResponse'\n _links:\n $ref: '#/components/schemas/IssuePolicyLinks'\n _collection:\n $ref: '#/components/schemas/Collections'\n IssuePolicyResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier for the policy (UUID).\n _type:\n type: string\n description: Policy type (`issue-policy` or `test-frequency-policy`).\n name:\n type: string\n description: Name of the Policy.\n description:\n type: string\n description: Detailed description of the policy.\n filterGroups:\n $ref: '#/components/schemas/FilterGroups'\n disabled:\n type: boolean\n default: false\n description: Is this Policy disabled.\n usage:\n type: array\n description: Usage of the policy.\n items:\n $ref: '#/components/schemas/Usage'\n _links:\n $ref: '#/components/schemas/Links'\n example:\n name: Notify for Critical and High issues\n description: Notify via email for High- and Critical-severity issues.\n synopsysDefined: false\n filterGroups:\n rules:\n - ruleNumber: 1\n filter:\n powerFilterQuery: context:tool-type=in=('sast','sca');issueProperties:severity=in=('critical','high','medium')\n actions:\n - name: SEND_EMAIL\n longName: Send Notification\n id: 9cfeeaba-dd52-11ec-9d64-0242ac120002\n _type: actions\n _links:\n - href: ${base.path}/policies/actions/9cfeeaba-dd52-11ec-9d64-0242ac120002\n rel: self\n method: GET\n disabled: false\n fixByRules:\n - query: issueProperties:severity==critical\n days: 7\n disabled: false\n - query: issueProperties:severity==high\n days: 14\n disabled: false\n - query: issueProperties:severity==medium\n days: 30\n disabled: false\n - query: issueProperties:severity==low\n days: 60\n disabled: false\n - query: issueProperties:severity==informational\n days: 90\n disabled: false\n usage:\n - type: project\n count: 1\n id: f3ccbc69-faf9-45e5-8def-d5c4c56f6f59\n _type: issue-policy\n _links:\n - href: ${base.path}/policies/issue-policy/f3ccbc69-faf9-45e5-8def-d5c4c56f6f59\n rel: self\n method: GET\n - href: ${base.path}/policies/f3ccbc69-faf9-45e5-8def-d5c4c56f6f59/assignments\n rel: assignments\n method: GET\n default: false\n IssuePoliciesResponse:\n type: object\n required:\n - id\n - name\n - usage\n - synopsysDefined\n - default\n - _links\n properties:\n id:\n type: string\n format: uuid\n description: Unique identifier for the policy (UUID).\n _type:\n type: string\n description: Policy type (`issue-policy` or `test-frequency-policy`).\n name:\n type: string\n description: Name of the Policy.\n synopsysDefined:\n type: boolean\n description: Whether this policy is defined by Black Duck\n default: false\n default:\n type: boolean\n description: Whether this is the default policy\n default: false\n description:\n type: string\n description: Detailed description of the policy.\n filterGroups:\n $ref: '#/components/schemas/FilterGroups'\n usage:\n type: array\n description: Usage of the policy.\n items:\n $ref: '#/components/schemas/Usage'\n _links:\n $ref: '#/components/schemas/IssuePolicyLinks'\n example:\n name: Notify for Critical and High issues\n description: Notify via email for High- and Critical-severity issues.\n synopsysDefined: false\n filterGroups:\n rules:\n - ruleNumber: 1\n filter:\n powerFilterQuery: context:tool-type=in=('sast','sca','dast');issueProperties:severity=in=('critical','high','medium')\n actions:\n - name: SEND_EMAIL\n longName: Send Notification\n id: 9cfeeaba-dd52-11ec-9d64-0242ac120002\n _type: actions\n _links:\n - href: ${base.path}/actions/9cfeeaba-dd52-11ec-9d64-0242ac120002\n rel: self\n method: GET\n disabled: false\n fixByRules:\n - query: issueProperties:severity==critical\n days: 7\n disabled: false\n - query: issueProperties:severity==high\n days: 14\n disabled: false\n - query: issueProperties:severity==medium\n days: 30\n disabled: false\n - query: issueProperties:severity==low\n days: 60\n disabled: false\n - query: issueProperties:severity==informational\n days: 90\n disabled: false\n usage:\n - type: project\n count: 1\n id: f3ccbc69-faf9-45e5-8def-d5c4c56f6f59\n _type: issue-policy\n _links:\n - href: ${base.path}/issue-policies/f3ccbc69-faf9-45e5-8def-d5c4c56f6f59\n rel: self\n method: GET\n - href: ${base.path}/f3ccbc69-faf9-45e5-8def-d5c4c56f6f59/assignments\n rel: assignments\n method: GET\n default: false\n FilterGroups:\n description: |\n Filter groups are a collection of filter rules and fixBy rules.\n properties:\n rules:\n type: array\n description: Array of filter rules.\n items:\n $ref: '#/components/schemas/PowerFilterRule'\n fixByRule:\n type: array\n description: Array of fixBy rules.\n items:\n $ref: '#/components/schemas/FixByRule'\n PowerFilterRule:\n description: |\n Power filter rule is a combination of filter and action.\n properties:\n ruleNumber:\n type: integer\n description: Rule numbers, starts with 1.\n filter:\n $ref: '#/components/schemas/Filter'\n actions:\n type: array\n description: Array of actions.\n items:\n $ref: '#/components/schemas/Actions'\n disabled:\n type: boolean\n default: false\n description: Status of the rule (Active/Inactive).\n example:\n - ruleNumber: 1\n filter:\n powerFilterQuery: context:tool-type=in=('sast','sca');issueProperties:severity=in=('critical','high','medium')\n actions:\n - name: SEND_EMAIL\n longName: Send Notification\n id: 9cfeeaba-dd52-11ec-9d64-0242ac120002\n _type: actions\n _links:\n - href: ${base.path}/policies/actions/9cfeeaba-dd52-11ec-9d64-0242ac120002\n rel: self\n method: GET\n disabled: false\n FixByRule:\n description: |\n FixBy rule is a combination of query and days.\n properties:\n query:\n type: string\n example: issueProperties:severity==critical\n description: As of current one fixBy rule only supports issueProperties:severity filter with == operator and any one value from (critical, high. low, medium, informational).\n days:\n description: Number of days to fix the issue.\n type: integer\n example: 7\n disabled:\n type: boolean\n default: true\n description: Status of the fixBy rule (Active/Inactive).\n Filter:\n description: |\n Filter is a combination of power filter query.\n properties:\n powerFilterQuery:\n type: string\n description: |\n Issue filter query. Query follows [RSQL](https://github.com/jirutka/rsql-parser) format.\n Below are the supported keys, operators and allowed values for the filter query:\n \n | Key | Allowed Operators | Available Values |\n |-------------------------------------|--------------------------------------|---------------------------------------------------------------|\n | `issueProperties:severity` | `=in=` | `critical`, `high`, `medium`, `low`, `informational` |\n | `context:tool-type` | `=in=` | `sast`, `dast`, `sca` |\n | `triageProperties:dismissal-reason` | `=in=` | `other`, `false-positive`, `intentional`, `component-excluded`|\n | `triageProperties:status` | `=in=` | `not-dismissed`, `dismissed`, `to-be-fixed` |\n | `special:delta` | `=in=` | `new`, `common` |\n | `issueType:in-taxon` | `=in=` | Standard taxon IDs and its list of descendant taxa IDs. IDs can be found by `/api/specialization-layer-service/taxonomies/_actions/list?_includeOnlyStandards=true` |\n | `issueProperties:cwe` |`=lt=`, `=gt=`, `=le=`, `=ge=`, `=in=`| Positive integer |\n | `derived:fix-by-status` | `=in=` | `overdue`, `on-track`, `due-soon`, `not-set` |\n example: context:tool-type=in=('sast','sca');issueProperties:severity=in=('critical','high','medium')\n Usage:\n description: |\n Usage is a combination of type and count.\n required:\n - type\n - count\n properties:\n type:\n type: string\n description: Type of the usage.\n example: project\n count:\n type: integer\n description: Count of the usage object.\n PolicyAssignmentPayload:\n required:\n - type\n - associationId\n type: object\n properties:\n type:\n type: string\n description: Portfolio type name. For example, 'project'. Polaris currently supports `project` type only.\n associationId:\n type: string\n description: ID of the portfolio-related entity. For example, Project ID. We currently support `project` type only.\n example:\n type: project\n associationId: f3ccbc69-faf9-45e5-8def-d5c4c56f6f59\n PolicyAssignmentResponse:\n properties:\n id:\n type: string\n format: uuid\n description: Assignment ID. This can be used to manage the assignment or delete an assignment.\n _type:\n type: string\n description: Type of assignment. For example, `policy-assignment`.\n type:\n type: string\n description: Portfolio type name. For example, 'project'. Polaris currently supports project type only.\n associationId:\n type: string\n description: ID of the portfolio-related entity. For example, project ID. Polaris currently supports `project` type only.\n _links:\n $ref: '#/components/schemas/Links'\n example:\n associationId: 68cb5d73-3969-41e4-92d0-38e2554af501\n id: 536fc22f-7cd2-4364-8198-37df89308506\n _type: policy-assignment\n _links:\n - href: ${base.path}/policies/{policyId}/assignments/536fc22f-7cd2-4364-8198-37df89308506\n rel: self\n method: GET\n type: project\n PoliciesAssignmentResponse:\n properties:\n id:\n type: string\n format: uuid\n description: Assignment ID. This can be used to manage the assignment or delete an assignment.\n _type:\n type: string\n description: Type of assignment. For example, `policy-assignment`.\n type:\n type: string\n description: Portfolio type name. For example, 'project'. Polaris currently supports project type only.\n associationId:\n type: string\n description: ID of the portfolio-related entity. For example, project ID. Polaris currently supports `project` type only.\n _links:\n $ref: '#/components/schemas/IssuePolicyLinks'\n example:\n associationId: 68cb5d73-3969-41e4-92d0-38e2554af501\n id: 536fc22f-7cd2-4364-8198-37df89308506\n _type: policy-assignment\n _links:\n - href: ${base.path}/{policyId}/assignments/536fc22f-7cd2-4364-8198-37df89308506\n rel: self\n method: GET\n type: project\n PolicyBulkAssignmentPayload:\n properties:\n assignments:\n type: array\n description: Array of assignment items.\n items:\n $ref: '#/components/schemas/BulkAssignmentItem'\n example:\n assignments:\n - type: project\n associationId: 079d85b4-d2dc-49ba-96c4-8765bf3965df\n - type: project\n associationId: 1bff0403-9de1-406f-851b-b23c83b9b6b3\n BulkAssignmentItem:\n properties:\n type:\n type: string\n description: Type of the assignment. For example, project.\n associationId:\n type: string\n description: Association ID of the specific assignment.\n example:\n type: project\n associationId: 536fc22f-7cd2-4364-8198-37df89308506\n BulkAssignmentsPayload:\n properties:\n assignments:\n type: array\n description: Array of assignment items.\n items:\n $ref: '#/components/schemas/BulkAssignmentsItem'\n example:\n assignments:\n - type: project\n associationId: 079d85b4-d2dc-49ba-96c4-8765bf3965df\n policyId: 021e4bdf-17e5-4294-97c9-c6fe3223da81\n - type: project\n associationId: 1bff0403-9de1-406f-851b-b23c83b9b6b3\n policyId: 021e4bdf-17e5-4294-97c9-c6fe3223da81\n BulkAssignmentsItem:\n properties:\n type:\n type: string\n description: Type of the assignment.\n example: project\n associationId:\n type: string\n description: Association ID of the specific assignment.\n policyId:\n type: string\n description: Policy ID to assign the assignments.\n format: UUID\n example:\n type: project\n associationId: 536fc22f-7cd2-4364-8198-37df89308506\n policyId: 021e4bdf-17e5-4294-97c9-c6fe3223da81\n PolicySettingsPayload:\n properties:\n policyId:\n type: string\n format: UUID\n description: Policy ID to make default.\n defaultPolicyStatus:\n type: boolean\n description: Set it to true to make policy default. False value is not accepted.\n example:\n policyId: 021e4bdf-17e5-4294-97c9-c6fe3223da81\n defaultPolicyStatus: true\n PolicyBulkAssignmentRemovalPayload:\n properties:\n assignments:\n type: array\n description: Array of assignment removal items.\n items:\n $ref: '#/components/schemas/BulkAssignmentRemovalItem'\n example:\n assignments:\n - type: project\n associationId: 079d85b4-d2dc-49ba-96c4-8765bf3965df\n - type: project\n associationId: 1bff0403-9de1-406f-851b-b23c83b9b6b3\n BulkAssignmentRemovalItem:\n properties:\n id:\n type: string\n description: Policy Assignment ID. One of assignment `id` or `associationId` must be specified.\n associationId:\n type: string\n description: Association ID. One of `id` or `associationId` must be specified.\n type:\n type: string\n description: Assignment removal type.\n example: project\n example:\n id: 536fc22f-7cd2-4364-8198-37df89308506\n type: project\n associationId: 536fc22f-7cd2-4364-8198-37df89308506\n Links:\n type: array\n readOnly: true\n description: Array of links.\n items:\n properties:\n href:\n type: string\n description: URL of the link.\n rel:\n type: string\n default: self\n description: Relation of the link.\n method:\n type: string\n default: GET\n description: HTTP method to be used.\n example:\n - href: ${base.path}/policies/issue-policy/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: ${base.path}/policies/issue-policy/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: ${base.path}/policies/issue-policy/?_offset=1000&_limit=10\n rel: last\n method: GET\n IssuePolicyLinks:\n required:\n - href\n - rel\n - method\n type: array\n description: Array of links.\n items:\n properties:\n href:\n type: string\n description: URL of the link.\n rel:\n type: string\n default: self\n description: Relation of the link.\n method:\n type: string\n default: GET\n description: HTTP method to be used.\n example:\n - href: ${base.path}/issue-policies/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: ${base.path}/issue-policies/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: ${base.path}/issue-policies/?_offset=1000&_limit=10\n rel: last\n method: GET\n SchedulingPolicyLinks:\n type: array\n description: Array of links.\n items:\n properties:\n href:\n type: string\n description: URL of the link.\n rel:\n type: string\n default: self\n description: Relation of the link.\n method:\n type: string\n default: GET\n description: HTTP method to be used.\n example:\n - href: ${base.path}/test-scheduling-policies/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: ${base.path}/test-scheduling-policies/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: ${base.path}/test-scheduling-policies/?_offset=1000&_limit=10\n rel: last\n method: GET\n TestPolicyLinks:\n type: array\n description: Array of links.\n items:\n properties:\n href:\n type: string\n description: URL of the link.\n rel:\n type: string\n default: self\n description: Relation of the link.\n method:\n type: string\n default: GET\n description: HTTP method to be used.\n example:\n - href: ${base.path}/policies/test-frequency-policy/?_offset=20&_limit=10\n rel: self\n method: GET\n - href: ${base.path}/policies/test-frequency-policy/?_offset=0&_limit=10\n rel: first\n method: GET\n - href: ${base.path}/policies/test-frequency-policy/?_offset=1000&_limit=10\n rel: last\n method: GET\n Collections:\n type: object\n required:\n - itemCount\n - currentPage\n - pageCount\n description: Collection of items.\n properties:\n itemCount:\n description: Total number of items in the collection.\n type: integer\n format: int32\n currentPage:\n type: integer\n description: Current page number.\n default: 0\n pageCount:\n description: Total number of pages in the collection.\n type: integer\n default: 25\n example:\n itemCount: 0\n currentPage: 0\n pageCount: 0\n TestFrequencyPolicyPayload:\n required:\n - name\n type: object\n properties:\n name:\n type: string\n description: Name of the Policy.\n description:\n type: string\n description: Description of the Policy.\n scheduleGroups:\n $ref: '#/components/schemas/ScheduleGroups'\n example:\n name: Test- Scheduling policy\n description: Test Scheduling policy for daily schedule.\n scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: daily\n TestFrequencyPolicyCollectionResponse:\n type: object\n properties:\n _items:\n type: array\n description: Array of all the test frequency policies.\n items:\n $ref: '#/components/schemas/TestFrequencyPolicyResponse'\n _links:\n $ref: '#/components/schemas/TestPolicyLinks'\n _collection:\n $ref: '#/components/schemas/Collections'\n TestSchedulingPolicyCollectionResponse:\n type: object\n properties:\n _items:\n type: array\n description: Array of all the test frequency policies.\n items:\n $ref: '#/components/schemas/TestSchedulingPolicyResponse'\n _links:\n $ref: '#/components/schemas/SchedulingPolicyLinks'\n _collection:\n $ref: '#/components/schemas/Collections'\n TestFrequencyPolicyResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: ID of the test frequency Policy.\n _type:\n type: string\n description: Type of the Policy.\n example: test-frequency-policy\n name:\n type: string\n description: Name of the Test Scheduling Policy.\n description:\n type: string\n description: Description of Test Scheduling Policy.\n scheduleGroups:\n $ref: '#/components/schemas/ScheduleGroups'\n synopsysDefined:\n type: boolean\n description: Policy defined by Synopsys.\n default: false\n usage:\n type: array\n description: Usage of the policy.\n items:\n $ref: '#/components/schemas/Usage'\n _links:\n $ref: '#/components/schemas/SchedulingPolicyLinks'\n example:\n name: Standard\n scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\n usage:\n - type: project\n count: 37\n id: 9e19d89d-6263-4d0e-945e-e144cc05f4ee\n _type: test-frequency-policy\n _links:\n - href: ${base.path}/policies/scan-policy/9e19d89d-6263-4d0e-945e-e144cc05f4ee\n rel: self\n method: GET\n - href: ${base.path}/policies/9e19d89d-6263-4d0e-945e-e144cc05f4ee/assignments\n rel: assignments\n method: GET\n default: true\n TestSchedulingPolicyResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: ID of the test scheduling Policy.\n _type:\n type: string\n description: Type of the Policy.\n example: test-frequency-policy\n name:\n type: string\n description: Name of the Test Scheduling Policy.\n description:\n type: string\n description: Description of Test Scheduling Policy.\n scheduleGroups:\n $ref: '#/components/schemas/ScheduleGroups'\n synopsysDefined:\n type: boolean\n description: Policy defined by Synopsys.\n default: false\n usage:\n type: array\n description: Usage of the policy.\n items:\n $ref: '#/components/schemas/Usage'\n _links:\n $ref: '#/components/schemas/SchedulingPolicyLinks'\n example:\n name: Standard\n scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\n usage:\n - type: project\n count: 37\n id: 9e19d89d-6263-4d0e-945e-e144cc05f4ee\n _type: test-frequency-policy\n _links:\n - href: ${base.path}/test-scheduling-policies/9e19d89d-6263-4d0e-945e-e144cc05f4ee\n rel: self\n method: GET\n - href: ${base.path}/9e19d89d-6263-4d0e-945e-e144cc05f4ee/assignments\n rel: assignments\n method: GET\n default: true\n ScheduleGroups:\n description: |\n Schedule groups are a collection of test scheduling policies.\n properties:\n rules:\n type: array\n description: Array of test frequency policies. Currently Polaris supports `daily` and `weekly`.\n items:\n $ref: '#/components/schemas/ScheduleRule'\n example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\n ScheduleRule:\n properties:\n ruleNumber:\n type: integer\n description: Sequential number for the rule.\n frequency:\n type: string\n description: Test scheduling type (daily/weekly).\n enum:\n - daily\n - weekly\n example:\n ruleNumber: 1\n frequency: weekly\n IssuePolicyExecutionResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: ID of the Policy execution.\n _type:\n type: string\n description: Type of the Policy Execution. For example, issue-policy-execution.\n testId:\n type: string\n description: Test ID.\n actions:\n type: array\n description: Array of actions executed.\n items:\n $ref: '#/components/schemas/ActivatedActionResponse'\n status:\n type: string\n description: |\n Status of the Policy execution.\n The following statuses can be returned, based on the policy evaluation.\n\n * `PENDING` - Policy evaluation is in queue.\n * `EVALUATED` - Policy evaluated and actions are determined.\n * `ACTIONS_EXECUTING` - Policy evaluation is executing actions such as `Email notifications` and `Break the build`.\n * `FAILED - Due to system failure, policy evaluation failed.\n * `COMPLETED` - Policy evaluation completed, including triggering actions.\n _links:\n $ref: '#/components/schemas/Links'\n example:\n testId: 804c8ad8-d6fe-4572-b110-c4ef821a9138\n status: COMPLETED\n actions:\n - name: SEND_EMAIL\n longName: Send Notification\n id: 9cfeeaba-dd52-11ec-9d64-0242ac120002\n id: 6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n _type: issue-policy-execution\n _links:\n - href: ${base.path}/policies/issue-policies-execution/6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n rel: self\n method: GET\n - href: ${base.path}/policies/issue-policy/e7ffb13a-dd51-11ec-9d64-0242ac120002\n rel: issue-policy\n method: GET\n IssuePoliciesExecutionResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: ID of the Policy execution.\n _type:\n type: string\n description: Type of the Policy Execution. For example, issue-policy-execution.\n testId:\n type: string\n description: Test ID.\n actions:\n type: array\n description: Array of actions executed.\n items:\n $ref: '#/components/schemas/ActivatedActionResponse'\n status:\n type: string\n description: |\n Status of the Policy execution.\n The following statuses can be returned, based on the policy evaluation.\n\n * `PENDING` - Policy evaluation is in queue.\n * `EVALUATED` - Policy evaluated and actions are determined.\n * `ACTIONS_EXECUTING` - Policy evaluation is executing actions such as `Email notifications` and `Break the build`.\n * `FAILED` - Due to system failure, policy evaluation failed.\n * `COMPLETED` - Policy evaluation completed, including triggering actions.\n _links:\n $ref: '#/components/schemas/Links'\n example:\n testId: 804c8ad8-d6fe-4572-b110-c4ef821a9138\n status: COMPLETED\n actions:\n - name: SEND_EMAIL\n longName: Send Notification\n id: 9cfeeaba-dd52-11ec-9d64-0242ac120002\n id: 6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n _type: issue-policy-execution\n _links:\n - href: ${base.path}/issue-policies/execution/6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n rel: self\n method: GET\n - href: ${base.path}/issue-policies/e7ffb13a-dd51-11ec-9d64-0242ac120002\n rel: issue-policy\n method: GET\n ActivatedActionResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: ID of the action.\n name:\n type: string\n description: Name of the action.\n longName:\n type: string\n description: Long name of the action.\n example:\n id: 9cfeeaba-dd52-11ec-9d64-0242ac120002\n name: SEND_EMAIL\n longName: Send Notification\n PortfolioPolicyConfigurationRequest:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: ID of the portfolio policy configuration.\n associationType:\n type: string\n enum:\n - branch\n - project\n description: The type of portfolio item (`project` or `branch`).\n example: project\n associationId:\n type: string\n description: The UUID of the portfolio item (`project` or `branch`).\n example: 07a66418-310c-4c40-aee4-87697c16718b\n inheritParentPolicies:\n type: boolean\n description: >-\n Used to define whether project policies to be inherited for the branch. Setting this to `true' for a `branch` `associationId` implies, inherit policies of project for a given branch. When\n `true` - Branch will inherit Project Policies. When `false` - Branch will not inherit Project Policies.\n example: false\n enable:\n type: boolean\n description: Enable or disable the policies. When `true` - Policies are enabled for the `associationId`. When `false` - Policies are disabled `associationId`.\n example: true\n assignedPolicies:\n type: array\n description: Array of assigned policies.\n items:\n $ref: '#/components/schemas/AssignedPolicyResponse'\n example:\n id: 4a6daa6a-72eb-492d-acc5-44fbf388f708\n associationType: branch\n associationId: 07a66418-310c-4c40-aee4-87697c16718b\n inheritParentPolicies: false\n enable: true\n assignedPolicies:\n - id: 4c8e8fe0-ac50-11ed-afa1-0242ac120002\n type: issue_policy\n - id: 4c8e924c-ac50-11ed-afa1-0242ac120002\n type: test_frequency_policy\n PortfolioPolicyConfigurationResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: ID of the portfolio policy configuration.\n associationType:\n type: string\n enum:\n - branch\n - project\n description: The type of portfolio item (`project` or `branch`).\n example: project\n associationId:\n type: string\n description: The UUID of the portfolio item (`project` or `branch`).\n example: 07a66418-310c-4c40-aee4-87697c16718b\n inheritParentPolicies:\n type: boolean\n description: >-\n Used to define whether project policies to be inherited for the branch. Setting this to `true' for a `branch` `associationId` implies, inherit policies of project for a given branch. When\n `true` - Branch will inherit Project Policies. When `false` - Branch will not inherit Project Policies.\n example: false\n enable:\n type: boolean\n description: Enable or disable the policies. When `true` - Policies are enabled for the `associationId`. When `false` - Policies are disabled `associationId`.\n example: true\n assignedPolicies:\n type: array\n description: Array of assigned policies.\n items:\n $ref: '#/components/schemas/AssignedPolicyResponse'\n example:\n id: 4a6daa6a-72eb-492d-acc5-44fbf388f708\n associationType: branch\n associationId: 07a66418-310c-4c40-aee4-87697c16718b\n inheritParentPolicies: false\n enable: true\n assignedPolicies:\n - id: 4c8e8fe0-ac50-11ed-afa1-0242ac120002\n type: issue_policy\n - id: 4c8e924c-ac50-11ed-afa1-0242ac120002\n type: test_frequency_policy\n _type: portfolio-policy-configuration\n _links:\n - href: ${base.path}/policies/portfolio-policy-configuration/4a6daa6a-72eb-492d-acc5-44fbf388f708\n rel: self\n method: GET\n PortfolioPoliciesConfigurationResponse:\n description: |\n Portfolio policy configuration response is a combination of policy configuration and assigned policies.\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: ID of the portfolio policy configuration.\n associationType:\n type: string\n description: Portfolio type name. For example, 'project'. Polaris currently supports project or branch type only.\n associationId:\n type: string\n description: ID of the portfolio-related entity. For example, project ID. Polaris currently supports `project` type only.\n inheritParentPolicies:\n type: boolean\n description: to inherit parent policies. For example, inherit policies of project for a given branch.\n enable:\n type: boolean\n description: to enable or disable the policies.\n assignedPolicies:\n type: array\n description: Array of assigned policies.\n items:\n $ref: '#/components/schemas/AssignedPolicyResponse'\n example:\n id: 4a6daa6a-72eb-492d-acc5-44fbf388f708\n associationType: branch\n associationId: 07a66418-310c-4c40-aee4-87697c16718b\n inheritParentPolicies: false\n enable: true\n assignedPolicies:\n - id: 4c8e8fe0-ac50-11ed-afa1-0242ac120002\n type: issue_policy\n - id: 4c8e924c-ac50-11ed-afa1-0242ac120002\n type: test_frequency_policy\n _type: portfolio-policy-configuration\n _links:\n - href: ${base.path}/portfolio-policy-configuration/4a6daa6a-72eb-492d-acc5-44fbf388f708\n rel: self\n method: GET\n AssignedPolicyResponse:\n description: |\n Assigned policy response is a combination of policy ID and type.\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: ID of the Policy.\n type:\n type: string\n description: Type of the Policy. (For example, `test_frequency_policy` or `issue_policy`)\n example:\n id: 804c8ad8-d6fe-4572-b110-c4ef821a9138\n type: issue_policy\n IssuePolicyExecutionCollectionResponse:\n description: |\n Issue policy execution collection response is a combination of issue policy execution and links.\n type: object\n properties:\n _items:\n type: array\n description: Array of all the issue policy executions.\n items:\n $ref: '#/components/schemas/IssuePolicyExecutionResponse'\n _links:\n $ref: '#/components/schemas/Links'\n _collection:\n $ref: '#/components/schemas/Collections'\n example:\n _items:\n - testId: 804c8ad8-d6fe-4572-b110-c4ef821a9138\n status: COMPLETED\n actions:\n - name: SEND_EMAIL\n longName: Send Notification\n id: 9cfeeaba-dd52-11ec-9d64-0242ac120002\n id: 6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n _type: issue-policy-execution\n _links:\n - href: ${base.path}/policies/issue-policy-execution/6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n rel: self\n method: GET\n - href: ${base.path}/policies/issue-policy/e7ffb13a-dd51-11ec-9d64-0242ac120002\n rel: issue-policy\n method: GET\n _collection:\n itemCount: 2\n pageCount: 1\n currentPage: 1\n IssuePoliciesExecutionCollectionResponse:\n description: |\n Issue policy execution collection response is a combination of issue policy execution and links.\n type: object\n properties:\n _items:\n type: array\n description: Array of all the issue policy executions.\n items:\n $ref: '#/components/schemas/IssuePoliciesExecutionResponse'\n _links:\n $ref: '#/components/schemas/IssuePolicyLinks'\n _collection:\n $ref: '#/components/schemas/Collections'\n example:\n _items:\n - testId: 804c8ad8-d6fe-4572-b110-c4ef821a9138\n status: COMPLETED\n actions:\n - name: SEND_EMAIL\n longName: Send Notification\n id: 9cfeeaba-dd52-11ec-9d64-0242ac120002\n id: 6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n _type: issue-policy-execution\n _links:\n - href: ${base.path}/issue-policies/execution/6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n rel: self\n method: GET\n - href: ${base.path}/issue-policies/e7ffb13a-dd51-11ec-9d64-0242ac120002\n rel: issue-policy\n method: GET\n _collection:\n itemCount: 2\n pageCount: 1\n currentPage: 1\n PortfolioPolicyConfigurationCollectionResponse:\n type: object\n description: |\n Portfolio policy configuration collection response is a combination of portfolio policy configuration and links.\n properties:\n _items:\n type: array\n description: Array of all the portfolio policy configurations.\n items:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationResponse'\n _links:\n $ref: '#/components/schemas/Links'\n _collection:\n $ref: '#/components/schemas/Collections'\n example:\n _items:\n - id: 4a6daa6a-72eb-492d-acc5-44fbf388f708\n associationType: branch\n associationId: 07a66418-310c-4c40-aee4-87697c16718b\n inheritParentPolicies: false\n enable: true\n assignedPolicies:\n - id: 4c8e8fe0-ac50-11ed-afa1-0242ac120002\n type: issue_policy\n - id: 4c8e924c-ac50-11ed-afa1-0242ac120002\n type: test_frequency_policy\n _type: portfolio-policy-configuration\n _links:\n - href: ${base.path}/policies/portfolio-policy-configuration/4a6daa6a-72eb-492d-acc5-44fbf388f708\n rel: self\n method: GET\n _collection:\n itemCount: 1\n pageCount: 1\n currentPage: 1\n PortfolioPoliciesConfigurationCollectionResponse:\n type: object\n description: |\n Portfolio policy configuration collection response is a combination of portfolio policy configuration and links.\n properties:\n _items:\n type: array\n description: Array of all the portfolio policy configurations.\n items:\n $ref: '#/components/schemas/PortfolioPolicyConfigurationResponse'\n _links:\n $ref: '#/components/schemas/IssuePolicyLinks'\n _collection:\n $ref: '#/components/schemas/Collections'\n example:\n _items:\n - id: 4a6daa6a-72eb-492d-acc5-44fbf388f708\n associationType: branch\n associationId: 07a66418-310c-4c40-aee4-87697c16718b\n inheritParentPolicies: false\n enable: true\n assignedPolicies:\n - id: 4c8e8fe0-ac50-11ed-afa1-0242ac120002\n type: issue_policy\n - id: 4c8e924c-ac50-11ed-afa1-0242ac120002\n type: test_frequency_policy\n _type: portfolio-policy-configuration\n _links:\n - href: ${base.path}/policies/portfolio-policy-configuration/4a6daa6a-72eb-492d-acc5-44fbf388f708\n rel: self\n method: GET\n _collection:\n itemCount: 1\n pageCount: 1\n currentPage: 1\n IssueViolationCountResponse:\n description: |\n Issue violation count response is a combination of issue violation count and links.\n type: object\n properties:\n issuesViolatingPolicy:\n type: integer\n description: number of issues violating policy.\n timestamp:\n type: number\n description: issue evaluation timestamp in unix format.\n context:\n type: object\n description: context that caused issue violation count.\n properties:\n for:\n type: string\n description: application, project or branch.\n id:\n type: string\n description: ID of application, project or branch.\n impactingEvaluation:\n type: object\n description: evaluation that caused the current count.\n properties:\n evaluationId:\n type: string\n format: uuid\n description: Id of the evaluation.\n _links:\n type: array\n description: Array of links.\n items:\n $ref: '#/components/schemas/Links'\n example:\n issuesViolatingPolicy: 8\n timestamp: 528220800\n context:\n for: branch\n id: 53d22704-a781-11ed-afa1-0242ac120002\n impactingEvaluation:\n evaluationId: f1291520-2d0c-4170-95c1-3509189bc831\n IssueViolationCountCollectionResponse:\n type: object\n properties:\n _items:\n type: array\n description: Array of all the issue violation count.\n items:\n $ref: '#/components/schemas/IssueViolationCountResponse'\n _links:\n $ref: '#/components/schemas/Links'\n _collection:\n $ref: '#/components/schemas/Collections'\n IssueViolationsCountCollectionResponse:\n type: object\n description: |\n Issue violation count collection response is a combination of issue violation count and links.\n properties:\n _items:\n type: array\n description: Array of all the issue violation count.\n items:\n $ref: '#/components/schemas/IssueViolationCountResponse'\n _links:\n $ref: '#/components/schemas/IssuePolicyLinks'\n _collection:\n $ref: '#/components/schemas/Collections'\n IssuePolicyEvaluationResponse:\n description: |\n Issue policy evaluation response is a combination of issue policy evaluation and links.\n type: object\n required:\n - id\n - context\n - issuesViolatingPolicies\n - policies\n - status\n - _type\n properties:\n id:\n type: string\n format: uuid\n description: ID of issue policy evaluation.\n _type:\n type: string\n description: Type of issue policy evaluation. For example, issue-policy-evaluations.\n status:\n type: string\n description: Status of issue policy evaluation. For example, `PASS` or `FAIL`.\n context:\n type: object\n description: Context of issue policy evaluation.\n required:\n - applicationId\n - branchId\n - projectId\n - triggerId\n - triggerType\n properties:\n triggerType:\n type: string\n description: Trigger type of policy evaluation. For example, \"TEST\".\n triggerId:\n type: string\n description: Trigger ID of an issue policy evaluation. For example, use `testId` for test triggers.\n branchId:\n type: string\n description: ID of branch.\n projectId:\n type: string\n description: ID of project.\n applicationId:\n type: string\n description: ID of application.\n profileId:\n type: string\n description: ID of the profile.\n issuesViolatingPolicies:\n type: number\n description: Number of issues that violate policies.\n policies:\n type: object\n description: list of policies assigned.\n items:\n $ref: '#/components/schemas/Policies'\n example:\n id: 804c8ad8-d6fe-4572-b110-c4ef821a9138\n _type: issue-policy-evaluation\n status: PASS\n context:\n triggerType: TEST,\n triggerId: b1a9f2b3-c123-4f86-80c1-cace813e08de,\n projectId: 12ce04a0-450b-4592-aeb9-d951fdae1968,\n applicationId: c3a8b417-3784-4f4e-ac49-b84b55a36c28,\n branchId: 53d22704-a781-11ed-afa1-0242ac120002`\n issuesViolatingPolicies: 20\n policies:\n items:\n policy:\n - policyId: 0ba2339e-90ea-4921-a9cc-ef43321c2f97,\n name: policy1,\n issuesViolatingPolicies: 10,\n status: PASS,\n rules:\n - ruleNumber: 1,\n issuesViolatingPolicies: 5,\n issueFilter: context:tool-type=in=('sast','sca');issueProperties:severity=in=('critical','high'),\n status: PASS,\n actions:\n - id: c19d6c51-4b00-4490-8c91-a2b0743aa1f1,\n name: SEND_EMAIL,\n longName: Send Notification\n - policyId: c3a8b417-3784-4f4e-ac49-b84b55a36c28,\n name: policy2,\n issuesViolatingPolicies: 10,\n status: PASS,\n rules:\n - ruleNumber: 2,\n issuesViolatingPolicies: 5,\n issueFilter: context:tool-type=in=('sast','sca');issueProperties:severity=in=('medium'),\n status: PASS,\n actions:\n - id: 9cfeeaba-dd52-11ec-9d64-0242ac120002,\n name: SEND_EMAIL,\n longName: Send Notification\n IssuePoliciesEvaluationResponse:\n description: |\n Issue policy evaluation response is a combination of issue policy evaluation and links.\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: ID of issue policy evaluation.\n _type:\n type: string\n description: Type of issue policy evaluation. For example, issue-policy-evaluations.\n status:\n type: string\n description: Status of issue policy evaluation. For example, `PASS` or `FAIL`.\n context:\n type: object\n description: Context of issue policy evaluation.\n properties:\n triggerType:\n type: string\n description: Trigger type of issue policy evaluation. For example, `TEST`.\n triggerId:\n type: string\n description: Trigger ID of issue policy evaluation, same as Test ID.\n branchId:\n type: string\n description: ID of branch.\n projectId:\n type: string\n description: ID of project.\n applicationId:\n type: string\n description: ID of application.\n issuesViolatingPolicies:\n type: number\n description: Number of issues that violate policies.\n policies:\n type: object\n description: list of policies assigned.\n items:\n $ref: '#/components/schemas/Policies'\n example:\n id: 804c8ad8-d6fe-4572-b110-c4ef821a9138\n _type: issue-policy-evaluation\n status: PASS\n context:\n triggerType: TEST,\n triggerId: b1a9f2b3-c123-4f86-80c1-cace813e08de,\n projectId: 12ce04a0-450b-4592-aeb9-d951fdae1968,\n applicationId: c3a8b417-3784-4f4e-ac49-b84b55a36c28,\n branchId: 53d22704-a781-11ed-afa1-0242ac120002`\n issuesViolatingPolicies: 20\n policies:\n items:\n policy:\n - policyId: 0ba2339e-90ea-4921-a9cc-ef43321c2f97,\n name: policy1,\n issuesViolatingPolicies: 10,\n status: PASS,\n rules:\n - ruleNumber: 1,\n issuesViolatingPolicies: 5,\n issueFilter: context:tool-type=in=('sast','sca');issueProperties:severity=in=('critical','high'),\n status: PASS,\n actions:\n - id: c19d6c51-4b00-4490-8c91-a2b0743aa1f1,\n name: SEND_EMAIL,\n longName: Send Notification\n - policyId: c3a8b417-3784-4f4e-ac49-b84b55a36c28,\n name: policy2,\n issuesViolatingPolicies: 10,\n status: PASS,\n rules:\n - ruleNumber: 2,\n issuesViolatingPolicies: 5,\n issueFilter: context:tool-type=in=('sast','sca');issueProperties:severity=in=('medium'),\n status: PASS,\n actions:\n - id: 9cfeeaba-dd52-11ec-9d64-0242ac120002,\n name: SEND_EMAIL,\n longName: Send Notification\n IssuePolicyEvaluationCollectionResponse:\n type: object\n description: |\n Issue policy evaluation collection response is a combination of issue policy evaluation and links.\n properties:\n _items:\n type: array\n description: Array of issue policy evaluations.\n items:\n $ref: '#/components/schemas/IssuePolicyEvaluationResponse'\n _links:\n $ref: '#/components/schemas/Links'\n _collection:\n $ref: '#/components/schemas/Collections'\n example:\n _items:\n - id: 6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n _type: issue-policy-evaluation\n status: PASS\n context:\n triggerType: TEST,\n triggerId: b1a9f2b3-c123-4f86-80c1-cace813e08de,\n projectId: 12ce04a0-450b-4592-aeb9-d951fdae1968,\n applicationId: c3a8b417-3784-4f4e-ac49-b84b55a36c28,\n branchId: 53d22704-a781-11ed-afa1-0242ac120002`\n issuesViolatingPolicies: 5\n policies:\n items:\n policy:\n - policyId: 0ba2339e-90ea-4921-a9cc-ef43321c2f97,\n name: policy1,\n issuesViolatingPolicies: 5,\n status: PASS,\n rules:\n - ruleNumber: 1,\n issuesViolatingPolicies: 5,\n issueFilter: context:tool-type=in=('sast','sca');issueProperties:severity=in=('critical','high'),\n status: PASS,\n actions:\n - id: c19d6c51-4b00-4490-8c91-a2b0743aa1f1,\n name: SEND_EMAIL,\n longName: Send Notification\n _links:\n - href: ${base.path}/policies/issue-policy/evaluations/6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n rel: self\n method: GET\n _collection:\n itemCount: 1\n pageCount: 1\n currentPage: 1\n IssuePoliciesEvaluationCollectionResponse:\n type: object\n description: |\n Issue policy evaluation collection response is a combination of issue policy evaluation and links.\n required:\n - _items\n - _links\n - _collection\n properties:\n _items:\n type: array\n description: Array of issue policy evaluations.\n items:\n $ref: '#/components/schemas/IssuePolicyEvaluationResponse'\n _links:\n $ref: '#/components/schemas/Links'\n _collection:\n $ref: '#/components/schemas/Collections'\n example:\n _items:\n - id: 6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n _type: issue-policy-evaluation\n status: PASS\n context:\n triggerType: TEST,\n triggerId: b1a9f2b3-c123-4f86-80c1-cace813e08de,\n projectId: 12ce04a0-450b-4592-aeb9-d951fdae1968,\n applicationId: c3a8b417-3784-4f4e-ac49-b84b55a36c28,\n branchId: 53d22704-a781-11ed-afa1-0242ac120002`\n issuesViolatingPolicies: 5\n policies:\n items:\n policy:\n - policyId: 0ba2339e-90ea-4921-a9cc-ef43321c2f97,\n name: policy1,\n issuesViolatingPolicies: 5,\n status: PASS,\n rules:\n - ruleNumber: 1,\n issuesViolatingPolicies: 5,\n issueFilter: context:tool-type=in=('sast','sca');issueProperties:severity=in=('critical','high'),\n status: PASS,\n actions:\n - id: c19d6c51-4b00-4490-8c91-a2b0743aa1f1,\n name: SEND_EMAIL,\n longName: Send Notification\n _links:\n - href: ${base.path}/issue-policies/evaluations/6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n rel: self\n method: GET\n _collection:\n itemCount: 1\n pageCount: 1\n currentPage: 1\n Rules:\n description: |\n Rules are a collection of policy rules.\n properties:\n ruleNumber:\n type: string\n description: Rule numbers, starts with 1.\n issuesViolatingPolicies:\n type: number\n description: Number of issues violating a particular assigned policy.\n issueFilter:\n type: string\n description: Issue filter query.\n example: context:tool-type=in=('sast','sca');issueProperties:severity=in=('critical','high','medium')\n status:\n type: string\n description: Status of the rule.\n actions:\n type: array\n description: Array of actions.\n items:\n $ref: '#/components/schemas/Actions'\n Policy:\n properties:\n policyId:\n type: string\n description: Id of the policy.\n name:\n type: string\n description: Name of the policy.\n issuesViolatingPolicies:\n type: number\n description: Number of issues violating a particular assigned policy.\n status:\n type: string\n description: Status of the policy.\n rules:\n $ref: '#/components/schemas/Rules'\n Policies:\n properties:\n policy:\n type: array\n description: Array of assigned policies.\n items:\n $ref: '#/components/schemas/Policy'\n RuleActivatedAction:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: ID of the action.\n name:\n type: string\n description: Name of the action.\n longName:\n type: string\n description: Long name of the action.\n activated:\n type: boolean\n description: Whether the action is recommended due to this evaluation or not.\n RuleEvaluationSummary:\n type: object\n properties:\n ruleNumber:\n type: string\n description: Rule numbers, starts with 1.\n entitiesViolatingPolicies:\n type: number\n description: Number of entities violating this rule.\n assessmentSpecificCount:\n type: number\n description: Number of entities that were detected to be violating policies in this specific assessment. For example, a SAST assessment's violation count.\n filter:\n type: string\n description: query expressing the rule definition for the rule.\n example: context:tool-type=in=('sast','sca');issueProperties:severity=in=('critical','high','medium')\n status:\n type: string\n description: Status of the rule.\n actions:\n type: array\n description: Array of actions.\n items:\n $ref: '#/components/schemas/RuleActivatedAction'\n PolicyEvaluationSummary:\n type: object\n properties:\n policyId:\n type: string\n format: uuid\n description: ID of the policy.\n name:\n type: string\n description: Name of the policy.\n entitiesViolatingPolicies:\n type: number\n description: Number of entities violating this policy.\n assessmentSpecificCount:\n type: number\n description: Number of entities that were detected to be violating policies in this specific assessment. For example, a SAST assessment's violation count.\n violated:\n type: boolean\n description: Value will be `true` when one or more active violations are detected when this rule is evaluated. `false` when no active violations are detected when this rule is evaluated.\n rules:\n type: array\n description: Summary of each rule result that was part of the evaluation.\n items:\n $ref: '#/components/schemas/RuleEvaluationSummary'\n PolicyEvaluationContext:\n type: object\n properties:\n triggerType:\n type: string\n description: Trigger type of policy evaluation. For example, `TEST`.\n triggerId:\n type: string\n description: Trigger ID of the policy evaluation. As an example, if the trigger type is `TEST`, then the testId should be specified for test triggers.\n branchId:\n type: string\n description: Branch ID of the evaluation if the evaluation is for a branch, else `null`.\n profileId:\n type: string\n description: Profile ID of the evaluation if the evaluation is for a profile, else `null`.\n projectId:\n type: string\n description: Project ID of the evaluation.\n applicationId:\n type: string\n description: Application ID of the evaluation.\n policyUseCase:\n type: string\n description: Policy use case.\n example: issue_policy\n PolicyEvaluationResponse:\n description: |\n Policy evaluation gives a summary of entire evaluation including policy level, and rule level results.\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: ID of the policy evaluation.\n _type:\n type: string\n description: Meta field. This is always `policy-evaluation` for this response.\n state:\n type: string\n description: State of the evaluation. For example `COMPLETED`/`PENDING`.\n entitiesViolatingPolicies:\n type: number\n description: Number of entities that violated policies as of this evaluation.\n assessmentSpecificCount:\n type: number\n description: Number of entities that were detected to be violating policies in this specific assessment. For example, a SAST assessment's violation count.\n violated:\n type: boolean\n description: Value will be `true` when one or more active violations are detected when this policy is evaluated. `false` when no active violations are detected when this policy is evaluated.\n policies:\n type: object\n description: Summary of each policy result that was part of the evaluation.\n items:\n $ref: '#/components/schemas/PolicyEvaluationSummary'\n context:\n type: object\n description: Context of the policy evaluation.\n items:\n $ref: '#/components/schemas/PolicyEvaluationContext'\n PolicyEvaluationsCollectionResponse:\n type: object\n description: |\n Paginated list of policy evaluations constrained by supplied filters.\n properties:\n _items:\n type: array\n description: Array of policy evaluations.\n items:\n $ref: '#/components/schemas/PolicyEvaluationResponse'\n _links:\n $ref: '#/components/schemas/Links'\n _collection:\n $ref: '#/components/schemas/Collections'\n example:\n _items:\n - id: 6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n _type: policy-evaluation\n status: PASS\n context:\n triggerType: TEST,\n triggerId: b1a9f2b3-c123-4f86-80c1-cace813e08de,\n projectId: 12ce04a0-450b-4592-aeb9-d951fdae1968,\n applicationId: c3a8b417-3784-4f4e-ac49-b84b55a36c28,\n branchId: 53d22704-a781-11ed-afa1-0242ac120002`\n entitiesViolatingPolicies: 5\n policies:\n items:\n policy:\n - policyId: 0ba2339e-90ea-4921-a9cc-ef43321c2f97,\n name: policy1,\n entitiesViolatingPolicies: 5,\n assessmentSpecificCount: 5,\n status: PASS,\n rules:\n - ruleNumber: 1,\n entitiesViolatingPolicies: 5,\n assessmentSpecificCount: 5,\n filter: context:tool-type=in=('sast','sca');issueProperties:severity=in=('critical','high'),\n violated: PASS,\n actions:\n - id: c19d6c51-4b00-4490-8c91-a2b0743aa1f1,\n name: SEND_EMAIL,\n longName: Send Notification\n activated: true\n _links:\n - href: ${base.path}/evaluations/6d1ccb42-bc73-43cc-93eb-c4b79aa89728\n rel: self\n method: GET\n _collection:\n itemCount: 1\n pageCount: 1\n currentPage: 1\n UsecaseViolationCount:\n type: object\n properties:\n useCase:\n type: string\n example: component_policy\n description: Policy use case to which the count belongs. For example, component_policy.\n entitiesViolatingPolicies:\n type: number\n example: 5\n description: Active violation count for the specific use case.\n entityType:\n type: string\n description: Type of entity for the use case. For example, the value will be `component` for component_policy.\n example: component\n timestamp:\n type: string\n description: The timestamp at which the active violation count recorded for the use case.\n ActiveViolationCountItem:\n type: object\n properties:\n context:\n type: object\n description: Context describing the association for which the active violation count is recorded.\n properties:\n id:\n type: string\n description: id of the association described with for field.\n for:\n type: string\n description: Resource type of the id described by the id field. For example, project, branch, application etc.\"\n entitiesViolatingPolicies:\n type: number\n description: Active violation count across all policy use cases for a project, a branch, a profile, or an application.\n timestamp:\n type: string\n description: The timestamp at which the active violation count recorded.\n useCases:\n type: array\n description: Active violation count for each policy use case type.\n items:\n $ref: '#/components/schemas/UsecaseViolationCount'\n ActiveViolationCountCollectionResponse:\n type: object\n properties:\n _links:\n $ref: '#/components/schemas/Links'\n _collection:\n $ref: '#/components/schemas/Collections'\n _items:\n type: array\n description: List of active violation counts for the supplied association IDs in filters.\n items:\n $ref: '#/components/schemas/ActiveViolationCountItem'\n ViolatedPolicyOfEntity:\n type: object\n properties:\n useCase:\n type: string\n description: Policy use case. For example, component_policy.\n example: component_policy\n policyId:\n type: string\n description: ID of the policy.\n name:\n type: string\n description: Name of the policy\n ViolatingEntity:\n type: object\n properties:\n entityId:\n type: string\n description: ID of the violating entity.\n entityType:\n type: string\n description: Type of the violating entity. For example, issue, component etc\"\n example: component\n violatedPolicies:\n type: array\n description: An array of policies the entity violates.\n items:\n $ref: '#/components/schemas/ViolatedPolicyOfEntity'\n ViolatingEntityCollectionResponse:\n type: object\n properties:\n _items:\n type: array\n description: Array of all the violating entities.\n items:\n $ref: '#/components/schemas/ViolatingEntity'\n _links:\n $ref: '#/components/schemas/Links'\n _collection:\n $ref: '#/components/schemas/Collections'\n CriteriaFilter:\n type: object\n properties:\n criteriaQuery:\n type: string\n description: The rule's definition, as a query string.\n example: license:family-name=in=('AGPL','RECIPROCAL')\n ComponentPolicyRule:\n type: object\n required:\n - actions\n properties:\n id:\n type: string\n format: uuid\n description: id of the rule\n ruleNumber:\n type: string\n description: Rule numbers, starts with 1.\n filter:\n $ref: '#/components/schemas/CriteriaFilter'\n actions:\n type: array\n description: Array of actions.\n items:\n $ref: '#/components/schemas/Actions'\n disabled:\n type: boolean\n description: whether rule is disabled or not.\n ComponentPolicyItem:\n type: object\n required:\n - name\n properties:\n id:\n type: string\n description: ID of the component policy.\n name:\n type: string\n description: Name of the component policy.\n default:\n type: boolean\n description: Whether the policy is default or not.\n readOnly: true\n description:\n type: string\n description: Description of the component policy.\n rules:\n type: array\n description: Array of rules for the component policy.\n items:\n $ref: '#/components/schemas/ComponentPolicyRule'\n usage:\n type: array\n readOnly: true\n description: Usage of the policy.\n items:\n $ref: '#/components/schemas/Usage'\n _links:\n $ref: '#/components/schemas/Links'\n ComponentPolicyCollectionResponse:\n type: object\n properties:\n _items:\n type: array\n description: Array of all the component policies.\n items:\n $ref: '#/components/schemas/ComponentPolicyItem'\n _links:\n $ref: '#/components/schemas/Links'\n _collection:\n $ref: '#/components/schemas/Collections'\n"

{}