Get scheduler configuration for a simulation - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

GET

/simulations/{simulationReference}/schedules

Try it

Get scheduler configuration for a simulation

cURL

curl --request GET \
  --url https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules \
  --header 'Authorization: Bearer <token>'

Python

import requests

url = "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

JavaScript

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "GET",\
  CURLOPT_HTTPHEADER => [\
    "Authorization: Bearer <token>"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

Go

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Java

HttpResponse<String> response = Unirest.get("https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules")
  .header("Authorization", "Bearer <token>")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Response Codes

• 200 - Scheduler retrieved successfully
• 400 - Bad request
• 401 - Unauthorized
• 403 - Forbidden
• 404 - Not found
• 500 - Internal server error

Response

{
  "scheduler": {
    "id": "<string>",
    "simulationReference": "<string>",
    "projectReference": "<string>",
    "organisationReference": "<string>",
    "runConfig": {
      "flowReferenceId": "<string>",
      "localeReferenceId": "<string>",
      "entrypoint": "<string>",
      "largeLanguageModelReferenceId": "<string>",
      "userId": "<string>",
      "finalPing": 123,
      "data": {},
      "enableMocking": true
    },
    "enableSchedule": true,
    "time": "2023-11-07T05:31:56Z",
    "numberOfRuns": 123,
    "nextScheduledRun": "2023-11-07T05:31:56Z",
    "emailNotifications": [
      "<string>"
    ],
    "scenarioName": "<string>",
    "runName": "<string>",
    "endDate": "2023-11-07T05:31:56Z",
    "createdAt": 123,
    "lastChanged": 123,
    "createdBy": "<string>",
    "lastChangedBy": "<string>",
    "cronScheduler": "<string>",
    "timezone": "Europe/Berlin"
  }
}

Error Response

{
  "error": "<string>",
  "field": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}