getGuidelineDetails

Get full details of a specific guideline by ID.

Examples

GraphQL

query GetGuidelineDetails($id: String!) {
  getGuidelineDetails(id: $id) {
    _id
    oxGuidelineId
    languages
    displayName
    description
    prompt
    promptSections {
      type
      value
      order
    }
    activationCriteria
    activationCriteriaDefinition {
      displayName
      description
      category
    }
    status
    isEditable
    createdBy
    createdAt
    updatedBy
    updatedAt
    category
    isDeleted
    isReady
    examplePrompt
  }
}

Variables

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

{
  "id": "example"
}

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 GetGuidelineDetails($id: String!) { getGuidelineDetails(id: $id) { _id oxGuidelineId languages displayName description prompt promptSections { type value order } activationCriteria activationCriteriaDefinition { displayName description category } status isEditable createdBy createdAt updatedBy updatedAt category isDeleted isReady examplePrompt } }",
 "variables": {
    "id": "example"
  }
}'

Node.js

const query = 'query GetGuidelineDetails($id: String!) { getGuidelineDetails(id: $id) { _id oxGuidelineId languages displayName description prompt promptSections { type value order } activationCriteria activationCriteriaDefinition { displayName description category } status isEditable createdBy createdAt updatedBy updatedAt category isDeleted isReady examplePrompt } }';

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

Python

import requests

query = 'query GetGuidelineDetails($id: String!) { getGuidelineDetails(id: $id) { _id oxGuidelineId languages displayName description prompt promptSections { type value order } activationCriteria activationCriteriaDefinition { displayName description category } status isEditable createdBy createdAt updatedBy updatedAt category isDeleted isReady examplePrompt } }'

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": {
      "id": "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 getGuidelineDetails query.

Argument	Description	Supported fields
id String! required	ID of the guideline to retrieve

Fields

Return type: GuidelineDetails!

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

Field	Description	Supported fields
_id String!	Guideline ID
oxGuidelineId String	OX Guideline ID (if this is an OX guideline)
languages [GuidelineLanguage!]!	Languages this guideline is applicable to
displayName String!	Display name of the guideline
description String	Description of the guideline
prompt String!	Prompt of the guideline as text
promptSections [PromptSectionResponse!]	Prompt of the guidelines as sections (future enhancement)	type PromptSectionType! value String! order Float!
activationCriteria String!	Activation criteria of the guideline
activationCriteriaDefinition ActivationCriteriaDefinitionResponse	Activation criteria definition of the guideline	displayName String! description String! category CategoryId!
status GuidelineStatus!	Status of the guideline (Enabled or Disabled)
isEditable Boolean!	Whether the guideline is editable
createdBy String!	User who created the guideline
createdAt DateTime!	Creation timestamp
updatedBy String!	User who last updated the guideline
updatedAt DateTime!	Last update timestamp
category CategoryId!	Category of the guideline
isDeleted Boolean!	Whether the guideline is deleted
isReady Boolean!	Whether the guideline is ready
examplePrompt String	Example prompt that the guideline should be triggered for