getGuidelineFilterOptions

Get the distinct filter values (categories, languages, statuses, creators) available across all of the org guidelines.

Examples

GraphQL

query GetGuidelineFilterOptions {
  getGuidelineFilterOptions {
    categories
    languages
    statuses
    createdBy
  }
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "query GetGuidelineFilterOptions { getGuidelineFilterOptions { categories languages statuses createdBy } }"
}'

Node.js

const query = 'query GetGuidelineFilterOptions { getGuidelineFilterOptions { categories languages statuses createdBy } }';

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
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'query GetGuidelineFilterOptions { getGuidelineFilterOptions { categories languages statuses createdBy } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query
  }
)

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

Fields

Return type: GuidelineFilterOptions!

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

Field	Description	Supported fields
categories [CategoryId!]!	Distinct categories present across all guidelines for this org
languages [GuidelineLanguage!]!	Distinct languages present across all guidelines for this org
statuses [GuidelineStatus!]!	Distinct statuses present across all guidelines for this org
createdBy [String!]!	Distinct creators (users + OX) present across all guidelines for this org