getGuidelineTrainingStatus

Get the current training status of a custom guideline from the prompt service.

Examples

GraphQL

query GetGuidelineTrainingStatus($id: String!) {
  getGuidelineTrainingStatus(id: $id) {
    guidelineId
    trainingStatus
  }
}

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 GetGuidelineTrainingStatus($id: String!) { getGuidelineTrainingStatus(id: $id) { guidelineId trainingStatus } }",
 "variables": {
    "id": "example"
  }
}'

Node.js

const query = 'query GetGuidelineTrainingStatus($id: String!) { getGuidelineTrainingStatus(id: $id) { guidelineId trainingStatus } }';

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 GetGuidelineTrainingStatus($id: String!) { getGuidelineTrainingStatus(id: $id) { guidelineId trainingStatus } }'

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 getGuidelineTrainingStatus query.

Argument	Description	Supported fields
id String! required	ID of the guideline to get the training status for

Fields

Return type: GuidelineTrainingStatusResponse!

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

Field	Description	Supported fields
guidelineId String!	The guideline identifier
trainingStatus GuidelineTrainingStatus!	Training status