Get a Playbook - Cognigy Documentation

GET

v2.0

playbooks

{playbookId}

Get a Playbook

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/playbooks/{playbookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "name": "New Playbook",
  "abortOnError": true,
  "timeout": 2000,
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>",
  "steps": [
    {
      "text": "hello world!",
      "data": {},
      "_id": "<string>",
      "asserts": [
        {
          "text": "hello world!",
          "data": {},
          "_id": "<string>"
        }
      ]
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

api_key

string

query

required

Supply the API Key in the Url-Query

Headers

enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

playbookId

string

required

The Id of the Playbook

Required string length: 24

Response

Returns Playbook Object

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

name

string

The name of the Playbook

Example:

"New Playbook"

abortOnError

boolean

Flag wheter to stop Playbook execution when an assert-error occured

timeout

integer

A time (in ms) after which a playbook step is 'invalid/failed'

Required range: x >= 1

Example:

2000

_id

string

Required string length: 24

createdAt

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

lastChanged

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

createdBy

string

Required string length: 24

lastChangedBy

string

Required string length: 24

steps

object[]

Show child attributes

Delete a PlaybookDelete a [Playbook](doc:playbook) resource in a project.

⌘I

Get a Playbook

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/playbooks/{playbookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "name": "New Playbook",
  "abortOnError": true,
  "timeout": 2000,
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>",
  "steps": [
    {
      "text": "hello world!",
      "data": {},
      "_id": "<string>",
      "asserts": [
        {
          "text": "hello world!",
          "data": {},
          "_id": "<string>"
        }
      ]
    }
  ]
}