"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 `Sun, 1 Dec 2024 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\": \"Sun, 1 Dec 2024 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 - 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 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: Dec , 12 Dec 2024 23:59:59 GMT\n content:\n application/vnd.polaris.policies.action-1+json:\n schema:\n description: Actions Response\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\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 _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 _collection:\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 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 application/json:\n schema:\n description: Actions Response\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\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 _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 _collection:\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 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 application/vnd.polaris.policy.action-1+json:\n schema:\n description: Actions Response\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\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 _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 _collection:\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 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 '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 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: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 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: 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 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: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 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: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 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: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 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 description: Actions Response.\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\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 _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 _collection:\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 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 application/json:\n schema:\n description: Actions Response.\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\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 _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 _collection:\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 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 application/vnd.polaris.policy.action-1+json:\n schema:\n description: Actions Response.\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\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 _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 _collection:\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 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 '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 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: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 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: 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 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: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 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: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 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: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 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: Dec , 12 Dec 2024 23:59:59 GMT\n content:\n application/vnd.polaris.policies.action-1+json:\n schema:\n description: Actions Response.\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\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 _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 _collection:\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 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 application/json:\n schema:\n description: Actions Response.\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\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 _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 _collection:\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 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 application/vnd.polaris.policy.action-1+json:\n schema:\n description: Actions Response.\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\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 _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 _collection:\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 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 '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 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: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 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: 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 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: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 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: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 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: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 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 description: Actions Response\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\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 _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 _collection:\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 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 application/json:\n schema:\n description: Actions Response\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\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 _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 _collection:\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 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 application/vnd.polaris.policy.action-1+json:\n schema:\n description: Actions Response\n type: object\n properties:\n _items:\n type: array\n description: List of actions.\n items:\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 _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 _collection:\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 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 '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 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: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 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: 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 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: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 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: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 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: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/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 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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 application/json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 application/vnd.polaris.policy.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 responses:\n '201':\n description: Success. Issue Policy successfully created.\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: Dec , 12 Dec 2024 23:59:59 GMT\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 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 _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 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 application/json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 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 _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 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 application/vnd.polaris.policy.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 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 _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 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 '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 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: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 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: 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 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: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 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: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 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: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 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 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: Dec , 12 Dec 2024 23:59:59 GMT\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\n type: object\n properties:\n _items:\n type: array\n description: List of policies.\n items:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 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 _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 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 _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 _collection:\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 application/json:\n schema:\n type: object\n properties:\n _items:\n type: array\n description: List of policies.\n items:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 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 _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 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 _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 _collection:\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 application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n type: object\n properties:\n _items:\n type: array\n description: List of policies.\n items:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 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 _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 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 _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 _collection:\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 '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 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: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 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: 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 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: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 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: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 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: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 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 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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 application/json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 application/vnd.polaris.policy.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 responses:\n '201':\n description: Success. Issue Policy successfully created.\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 usage:\n type: array\n description: Usage of the policy.\n items:\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 _links:\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 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 application/json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 usage:\n type: array\n description: Usage of the policy.\n items:\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 _links:\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 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 application/vnd.polaris.policy.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 usage:\n type: array\n description: Usage of the policy.\n items:\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 _links:\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 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 '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 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: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 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: 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 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: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 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: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 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: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 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 type: object\n required:\n - _items\n properties:\n _items:\n description: List of policies.\n type: array\n items:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 usage:\n type: array\n description: Usage of the policy.\n items:\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 _links:\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 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 _links:\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 _collection:\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 application/json:\n schema:\n type: object\n required:\n - _items\n properties:\n _items:\n description: List of policies.\n type: array\n items:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 usage:\n type: array\n description: Usage of the policy.\n items:\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 _links:\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 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 _links:\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 _collection:\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 application/vnd.polaris.policy.issue-policy-1+json:\n schema:\n type: object\n required:\n - _items\n properties:\n _items:\n description: List of policies.\n type: array\n items:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 usage:\n type: array\n description: Usage of the policy.\n items:\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 _links:\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 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 _links:\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 _collection:\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 '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 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: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 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: 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 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: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 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: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 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: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/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 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: Dec , 12 Dec 2024 23:59:59 GMT\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 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 _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 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 application/json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 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 _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 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 application/vnd.polaris.policy.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 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 _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 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 '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 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: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 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: 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 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: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 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: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 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: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 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 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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 application/json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 application/vnd.polaris.policy.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 responses:\n '200':\n description: Success. Issue Policy successfully updated.\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: Dec , 12 Dec 2024 23:59:59 GMT\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 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 _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 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 application/json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 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 _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 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 application/vnd.polaris.policy.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 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 _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 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 '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 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: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 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: 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 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: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 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: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 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: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 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 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: Dec , 12 Dec 2024 23:59:59 GMT\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 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: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 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: 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 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: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 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: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 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: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 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 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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 usage:\n type: array\n description: Usage of the policy.\n items:\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 _links:\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 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 application/json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 usage:\n type: array\n description: Usage of the policy.\n items:\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 _links:\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 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 application/vnd.polaris.policy.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 usage:\n type: array\n description: Usage of the policy.\n items:\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 _links:\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 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 '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 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: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 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: 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 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: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 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: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 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: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 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 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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 application/json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 application/vnd.polaris.policy.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 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 responses:\n '200':\n description: Success. Issue Policy successfully updated.\n content:\n application/vnd.polaris.policies.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 usage:\n type: array\n description: Usage of the policy.\n items:\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 _links:\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 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 application/json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 usage:\n type: array\n description: Usage of the policy.\n items:\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 _links:\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 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 application/vnd.polaris.policy.issue-policy-1+json:\n schema:\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 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 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 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 actions:\n type: array\n description: Array of actions.\n items:\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 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 type: array\n description: Array of fixBy rules.\n items:\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 usage:\n type: array\n description: Usage of the policy.\n items:\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 _links:\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 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 '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 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: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 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: 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 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: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 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: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 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: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 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 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 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: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 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: 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 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: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 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: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 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: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/{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 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: Dec , 12 Dec 2024 23:59:59 GMT\n content:\n application/vnd.polaris.policies.policy-assignments-1+json:\n schema:\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 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 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 application/json:\n schema:\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 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 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 application/vnd.polaris.policy.policy-assignments-1+json:\n schema:\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 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 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 '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 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: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 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: 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 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: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 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: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 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: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 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 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: Dec , 12 Dec 2024 23:59:59 GMT\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 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: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 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: 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 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: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 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: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 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: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 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 properties:\n assignments:\n type: array\n description: Array of assignment items.\n items:\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 example:\n assignments:\n - type: project\n associationId: 079d85b4-d2dc-49ba-96c4-8765bf3965df\n - type: project\n associationId: 1bff0403-9de1-406f-851b-b23c83b9b6b3\n application/json:\n schema:\n properties:\n assignments:\n type: array\n description: Array of assignment items.\n items:\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 example:\n assignments:\n - type: project\n associationId: 079d85b4-d2dc-49ba-96c4-8765bf3965df\n - type: project\n associationId: 1bff0403-9de1-406f-851b-b23c83b9b6b3\n application/vnd.polaris.policy.policy-bulk-assign-1+json:\n schema:\n properties:\n assignments:\n type: array\n description: Array of assignment items.\n items:\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 example:\n assignments:\n - type: project\n associationId: 079d85b4-d2dc-49ba-96c4-8765bf3965df\n - type: project\n associationId: 1bff0403-9de1-406f-851b-b23c83b9b6b3\n responses:\n '204':\n description: Success. Policy assignments successfully created.\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: Dec , 12 Dec 2024 23:59:59 GMT\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 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: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 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: 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 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: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 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: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 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: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 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 properties:\n assignments:\n type: array\n description: Array of assignment removal items.\n items:\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 example:\n assignments:\n - type: project\n associationId: 079d85b4-d2dc-49ba-96c4-8765bf3965df\n - type: project\n associationId: 1bff0403-9de1-406f-851b-b23c83b9b6b3\n application/json:\n schema:\n properties:\n assignments:\n type: array\n description: Array of assignment removal items.\n items:\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 example:\n assignments:\n - type: project\n associationId: 079d85b4-d2dc-49ba-96c4-8765bf3965df\n - type: project\n associationId: 1bff0403-9de1-406f-851b-b23c83b9b6b3\n application/vnd.polaris.policy.policy-bulk-unassign-1+json:\n schema:\n properties:\n assignments:\n type: array\n description: Array of assignment removal items.\n items:\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 example:\n assignments:\n - type: project\n associationId: 079d85b4-d2dc-49ba-96c4-8765bf3965df\n - type: project\n associationId: 1bff0403-9de1-406f-851b-b23c83b9b6b3\n responses:\n '204':\n description: Success. Policy assignments successfully created.\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: Dec , 12 Dec 2024 23:59:59 GMT\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 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: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 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: 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 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: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 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: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 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: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 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 properties:\n assignments:\n type: array\n description: Array of assignment items.\n items:\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 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 application/json:\n schema:\n properties:\n assignments:\n type: array\n description: Array of assignment items.\n items:\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 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 application/vnd.polaris.policy.policy-bulk-assignment-2+json:\n schema:\n properties:\n assignments:\n type: array\n description: Array of assignment items.\n items:\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 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 responses:\n '204':\n description: Success. Policy assignments successfully created.\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 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: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 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: 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 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: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 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: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 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: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 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 properties:\n assignments:\n type: array\n description: Array of assignment items.\n items:\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 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 application/json:\n schema:\n properties:\n assignments:\n type: array\n description: Array of assignment items.\n items:\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 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 application/vnd.polaris.policy.policy-bulk-unassignment-2+json:\n schema:\n properties:\n assignments:\n type: array\n description: Array of assignment items.\n items:\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 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 responses:\n '204':\n description: Success. Policy assignments successfully deleted.\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 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: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 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: 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 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: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 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: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 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: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 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 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 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 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 application/json:\n schema:\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 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 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 application/vnd.polaris.policy.policy-assignments-1+json:\n schema:\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 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 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 '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 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: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 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: 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 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: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 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: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 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: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/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 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 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 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 application/json:\n schema:\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 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 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 application/vnd.polaris.policy.policy-assignments-1+json:\n schema:\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 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 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 '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 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: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 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: 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 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: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 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: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 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: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/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 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 application/json:\n schema:\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 application/vnd.polaris.policy.policy-default-1+json:\n schema:\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 responses:\n '204':\n description: Success. Policy is set to default successfully.\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 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: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 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: 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 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: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 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: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 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: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/{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 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: Dec , 12 Dec 2024 23:59:59 GMT\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 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: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 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: 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 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: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 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: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 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: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 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 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 application/json:\n schema:\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 application/vnd.polaris.policy.policy-assignments-1+json:\n schema:\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 responses:\n '200':\n description: Success. Policy assignment successfully created.\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: Dec , 12 Dec 2024 23:59:59 GMT\n content:\n application/vnd.polaris.policies.policy-assignments-1+json:\n schema:\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 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 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 application/json:\n schema:\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 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 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 application/vnd.polaris.policy.policy-assignments-1+json:\n schema:\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 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 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 '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 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: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 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: 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 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: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 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: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 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: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 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 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: Dec , 12 Dec 2024 23:59:59 GMT\n content:\n application/vnd.polaris.policies.test-frequency-policy-1+json:\n schema:\n type: object\n properties:\n _items:\n type: array\n description: Array of all the test frequency policies.\n items:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 _links:\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 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 _links:\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 _collection:\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 application/json:\n schema:\n type: object\n properties:\n _items:\n type: array\n description: Array of all the test frequency policies.\n items:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 _links:\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 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 _links:\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 _collection:\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 application/vnd.polaris.policy.test-frequency-policy-1+json:\n schema:\n type: object\n properties:\n _items:\n type: array\n description: Array of all the test frequency policies.\n items:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 _links:\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 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 _links:\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 _collection:\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 '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 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: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 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: 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 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: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 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: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 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: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 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 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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 application/json:\n schema:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 application/vnd.polaris.policy.test-frequency-policy-1+json:\n schema:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 responses:\n '201':\n description: Success. Test Scheduling Policy successfully created.\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: Dec , 12 Dec 2024 23:59:59 GMT\n content:\n application/vnd.polaris.policies.test-frequency-policy-1+json:\n schema:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 _links:\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 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 application/json:\n schema:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 _links:\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 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 application/vnd.polaris.policy.test-frequency-policy-1+json:\n schema:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 _links:\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 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 '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 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: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 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: 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 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: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 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: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 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: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 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 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: Dec , 12 Dec 2024 23:59:59 GMT\n content:\n application/vnd.polaris.policies.test-frequency-policy-1+json:\n schema:\n type: object\n properties:\n _items:\n type: array\n description: Array of all the test frequency policies.\n items:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 _links:\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 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 _links:\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 _collection:\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 application/json:\n schema:\n type: object\n properties:\n _items:\n type: array\n description: Array of all the test frequency policies.\n items:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 _links:\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 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 _links:\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 _collection:\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 application/vnd.polaris.policy.test-frequency-policy-1+json:\n schema:\n type: object\n properties:\n _items:\n type: array\n description: Array of all the test frequency policies.\n items:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 _links:\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 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 _links:\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 _collection:\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 '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 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: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 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: 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 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: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 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: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 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: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 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 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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 application/json:\n schema:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 application/vnd.polaris.policy.test-scheduling-policy-1+json:\n schema:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 _links:\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 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 application/json:\n schema:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 _links:\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 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 application/vnd.polaris.policy.test-scheduling-policy-1+json:\n schema:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 _links:\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 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 '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 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: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 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: 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 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: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 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: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 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: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 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 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: Dec , 12 Dec 2024 23:59:59 GMT\n content:\n application/vnd.polaris.policies.test-scheduling-policy-1+json:\n schema:\n type: object\n properties:\n _items:\n type: array\n description: Array of all the test frequency policies.\n items:\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 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 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 example:\n - scheduleGroups:\n rules:\n - ruleNumber: 1\n frequency: weekly\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 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 _links:\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 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 _links:\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 _collection:\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 application/json:\n schema:\n type: object\n properties:\n _items:\n type: array\n description: Array of all the test frequency policies.\n items:\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 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 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 example:\n - scheduleGroups:\n rules:\n