getSbomConditionalFilters

Retrieves conditional filters for SBOM libraries with lazy loading support.

Examples

query GetSbomConditionalFilters($input: GetSbomConditionalFiltersInput) {
  getSbomConditionalFilters(input: $input) {
    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.

{
  "input": {
    "scanId": "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
    "conditionalFilters": [
      {
        "condition": "AND",
        "fieldName": "digest",
        "values": ["example"],
        "greaterThan": 13.37,
        "lessThan": 13.37
      }
    ],
    "search": "example",
    "owners": ["example"],
    "openItems": ["digest"],
    "tagIds": ["example"],
    "sbomSearch": [
      {
        "fieldName": "example",
        "value": ["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 GetSbomConditionalFilters($input: GetSbomConditionalFiltersInput) { getSbomConditionalFilters(input: $input) { total totalFiltered filters { type items { id filterId label count percent changeNumber policyId extraInfo { key value } } } } }",
 "variables": {
    "input": {
      "scanId": "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
      "conditionalFilters": [
        {
          "condition": "AND",
          "fieldName": "digest",
          "values": ["example"],
          "greaterThan": 13.37,
          "lessThan": 13.37
        }
      ],
      "search": "example",
      "owners": ["example"],
      "openItems": ["digest"],
      "tagIds": ["example"],
      "sbomSearch": [
        {
          "fieldName": "example",
          "value": ["example"]
        }
      ]
    }
  }
}'

const query = 'query GetSbomConditionalFilters($input: GetSbomConditionalFiltersInput) { getSbomConditionalFilters(input: $input) { 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: {
      input: {
        scanId: "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
        conditionalFilters: [
          {
            condition: "AND",
            fieldName: "digest",
            values: ["example"],
            greaterThan: 13.37,
            lessThan: 13.37
          }
        ],
        search: "example",
        owners: ["example"],
        openItems: ["digest"],
        tagIds: ["example"],
        sbomSearch: [
          {
            fieldName: "example",
            value: ["example"]
          }
        ]
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

import requests

query = 'query GetSbomConditionalFilters($input: GetSbomConditionalFiltersInput) { getSbomConditionalFilters(input: $input) { 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": {
      "input": {
        "scanId": "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
        "conditionalFilters": [
          {
            "condition": "AND",
            "fieldName": "digest",
            "values": ["example"],
            "greaterThan": 13.37,
            "lessThan": 13.37
          }
        ],
        "search": "example",
        "owners": ["example"],
        "openItems": ["digest"],
        "tagIds": ["example"],
        "sbomSearch": [
          {
            "fieldName": "example",
            "value": ["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 getSbomConditionalFilters query.

Argument

Description

Supported fields

input GetSbomConditionalFiltersInput

Parameters for filtering and paginating the SBOM conditional filters

scanId String conditionalFilters [ConditionalFilters] search String owners [String] openItems [FilterTypes] tagIds [String] sbomSearch [AutoCompleteSearch]

Fields

Return type: FilterLazyResponse

You can use the following field(s) to specify what information your getSbomConditionalFilters 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 3 days ago