getCicdIssuesConditionalFilters

Retrieves conditional filter options for pipeline issues.

Examples

query GetCICDIssuesConditionalFilters($getCICDIssuesInput: CICDIssuesInput) {
  getCICDIssuesConditionalFilters(getCICDIssuesInput: $getCICDIssuesInput) {
    total
    totalFiltered
    filters {
      type
      items {
        id
        filterId
        label
        count
        percent
        changeNumber
        policyId
        extraInfo {
          key
          value
        }
      }
    }
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "getCICDIssuesInput": {
    "search": [
      {
        "fieldName": "example",
        "value": ["example"]
      }
    ],
    "scanID": "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
    "limit": 100,
    "offset": 0,
    "sort": {
      "fields": ["IssueScore"],
      "order": ["ASC"]
    },
    "owners": ["example"],
    "tagIds": ["example"],
    "inventoryFilters": ["New"],
    "conditionalFilters": [
      {
        "condition": "AND",
        "fieldName": "digest",
        "values": ["example"],
        "greaterThan": 13.37,
        "lessThan": 13.37
      }
    ],
    "openItems": ["digest"],
    "dateRange": {
      "from": 1749000000000,
      "to": 1749900000000
    },
    "limitAggItems": 42,
    "offsetAggItems": 42,
    "topOffset": 42,
    "issueId": "30966426-oxPolicy_securityCloudScan_100-example",
    "scrollDirection": "example",
    "topLevelSearch": "example"
  }
}

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "query GetCICDIssuesConditionalFilters($getCICDIssuesInput: CICDIssuesInput) { getCICDIssuesConditionalFilters(getCICDIssuesInput: $getCICDIssuesInput) { total totalFiltered filters { type items { id filterId label count percent changeNumber policyId extraInfo { key value } } } } }",
 "variables": {
    "getCICDIssuesInput": {
      "search": [
        {
          "fieldName": "example",
          "value": ["example"]
        }
      ],
      "scanID": "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
      "limit": 100,
      "offset": 0,
      "sort": {
        "fields": ["IssueScore"],
        "order": ["ASC"]
      },
      "owners": ["example"],
      "tagIds": ["example"],
      "inventoryFilters": ["New"],
      "conditionalFilters": [
        {
          "condition": "AND",
          "fieldName": "digest",
          "values": ["example"],
          "greaterThan": 13.37,
          "lessThan": 13.37
        }
      ],
      "openItems": ["digest"],
      "dateRange": {
        "from": 1749000000000,
        "to": 1749900000000
      },
      "limitAggItems": 42,
      "offsetAggItems": 42,
      "topOffset": 42,
      "issueId": "30966426-oxPolicy_securityCloudScan_100-example",
      "scrollDirection": "example",
      "topLevelSearch": "example"
    }
  }
}'

const query = 'query GetCICDIssuesConditionalFilters($getCICDIssuesInput: CICDIssuesInput) { getCICDIssuesConditionalFilters(getCICDIssuesInput: $getCICDIssuesInput) { total totalFiltered filters { type items { id filterId label count percent changeNumber policyId extraInfo { key value } } } } }';

fetch("https://api.cloud.ox.security/api/apollo-gateway", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
    query: query,
    // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    variables: {
      getCICDIssuesInput: {
        search: [
          {
            fieldName: "example",
            value: ["example"]
          }
        ],
        scanID: "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
        limit: 100,
        offset: 0,
        sort: {
          fields: ["IssueScore"],
          order: ["ASC"]
        },
        owners: ["example"],
        tagIds: ["example"],
        inventoryFilters: ["New"],
        conditionalFilters: [
          {
            condition: "AND",
            fieldName: "digest",
            values: ["example"],
            greaterThan: 13.37,
            lessThan: 13.37
          }
        ],
        openItems: ["digest"],
        dateRange: {
          from: 1749000000000,
          to: 1749900000000
        },
        limitAggItems: 42,
        offsetAggItems: 42,
        topOffset: 42,
        issueId: "30966426-oxPolicy_securityCloudScan_100-example",
        scrollDirection: "example",
        topLevelSearch: "example"
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

import requests

query = 'query GetCICDIssuesConditionalFilters($getCICDIssuesInput: CICDIssuesInput) { getCICDIssuesConditionalFilters(getCICDIssuesInput: $getCICDIssuesInput) { total totalFiltered filters { type items { id filterId label count percent changeNumber policyId extraInfo { key value } } } } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query,
    # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    "variables": {
      "getCICDIssuesInput": {
        "search": [
          {
            "fieldName": "example",
            "value": ["example"]
          }
        ],
        "scanID": "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
        "limit": 100,
        "offset": 0,
        "sort": {
          "fields": ["IssueScore"],
          "order": ["ASC"]
        },
        "owners": ["example"],
        "tagIds": ["example"],
        "inventoryFilters": ["New"],
        "conditionalFilters": [
          {
            "condition": "AND",
            "fieldName": "digest",
            "values": ["example"],
            "greaterThan": 13.37,
            "lessThan": 13.37
          }
        ],
        "openItems": ["digest"],
        "dateRange": {
          "from": 1749000000000,
          "to": 1749900000000
        },
        "limitAggItems": 42,
        "offsetAggItems": 42,
        "topOffset": 42,
        "issueId": "30966426-oxPolicy_securityCloudScan_100-example",
        "scrollDirection": "example",
        "topLevelSearch": "example"
      }
    }
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

Arguments

You can use the following argument(s) to customize your getCICDIssuesConditionalFilters query.

Argument

Description

Supported fields

getCICDIssuesInput CICDIssuesInput

search [AutoCompleteSearch] scanID String limit Int! offset Int! ~~filters~~ CICDIssueFilters ⚠️ sort CICDIssuesSort owners [String] tagIds [String] inventoryFilters [InventoryTypes] conditionalFilters [ConditionalFilters] openItems [FilterTypes] dateRange DateRange limitAggItems Int offsetAggItems Int topOffset Int issueId String scrollDirection String topLevelSearch String

Fields

Return type: FilterLazyResponse

You can use the following field(s) to specify what information your getCICDIssuesConditionalFilters query will return. Please note that some fields may have their own subfields.

Field

Description

Supported fields

total Int

Total number of items available

totalFiltered Int

Total number of items after applying filters

filters [FilterLazy]

List of filter categories with their items

type FilterTypes items [FilterInfo]

Last updated 18 days ago