Playbook Document Assembly

Gets the document assembly rich text content for the specified playbook.

get

Retrieves the document assembly rich text JSON content for the specified playbook.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

typestring · nullableRequired

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get/playbooks/{playbookIdentifier}/document-assembly

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/document-assembly HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": "text",
  "content": [
    {
      "type": "text",
      "text": "text",
      "attrs": {
        "id": "text",
        "label": "text",
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "filterDataTypeId": 1,
        "properties": [
          {
            "type": "text",
            "attrs": {
              "type": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "id": "text",
              "label": "text",
              "renderAs": "text",
              "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
            }
          }
        ],
        "level": 1,
        "href": "text",
        "textAlign": "text"
      },
      "marks": [
        {
          "type": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "filterDataTypeId": 1,
            "properties": [
              {
                "type": "text",
                "attrs": {
                  "type": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "id": "text",
                  "label": "text",
                  "renderAs": "text",
                  "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                }
              }
            ],
            "level": 1,
            "href": "text",
            "textAlign": "text"
          }
        }
      ],
      "content": [
        {
          "type": "text",
          "text": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "filterDataTypeId": 1,
            "properties": [
              {
                "type": "text",
                "attrs": {
                  "type": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "id": "text",
                  "label": "text",
                  "renderAs": "text",
                  "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                }
              }
            ],
            "level": 1,
            "href": "text",
            "textAlign": "text"
          },
          "marks": [
            {
              "type": "text",
              "attrs": {
                "id": "text",
                "label": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "type": "text",
                "filterDataTypeId": 1,
                "properties": [
                  {
                    "type": "text",
                    "attrs": {
                      "type": "text",
                      "uuid": "123e4567-e89b-12d3-a456-426614174000",
                      "id": "text",
                      "label": "text",
                      "renderAs": "text",
                      "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                    }
                  }
                ],
                "level": 1,
                "href": "text",
                "textAlign": "text"
              }
            }
          ],
          "content": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

Saves the document assembly rich text content for the specified playbook.

put

Saves the document assembly rich text JSON content for the specified playbook.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

typestring · nullableRequired

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

put/playbooks/{playbookIdentifier}/document-assembly

HTTPcURLJavaScriptPython

PUT /playbooks/{playbookIdentifier}/document-assembly HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1642

{
  "type": "text",
  "content": [
    {
      "type": "text",
      "text": "text",
      "attrs": {
        "id": "text",
        "label": "text",
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "filterDataTypeId": 1,
        "properties": [
          {
            "type": "text",
            "attrs": {
              "type": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "id": "text",
              "label": "text",
              "renderAs": "text",
              "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
            }
          }
        ],
        "level": 1,
        "href": "text",
        "textAlign": "text"
      },
      "marks": [
        {
          "type": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "filterDataTypeId": 1,
            "properties": [
              {
                "type": "text",
                "attrs": {
                  "type": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "id": "text",
                  "label": "text",
                  "renderAs": "text",
                  "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                }
              }
            ],
            "level": 1,
            "href": "text",
            "textAlign": "text"
          }
        }
      ],
      "content": [
        {
          "type": "text",
          "text": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "filterDataTypeId": 1,
            "properties": [
              {
                "type": "text",
                "attrs": {
                  "type": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "id": "text",
                  "label": "text",
                  "renderAs": "text",
                  "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                }
              }
            ],
            "level": 1,
            "href": "text",
            "textAlign": "text"
          },
          "marks": [
            {
              "type": "text",
              "attrs": {
                "id": "text",
                "label": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "type": "text",
                "filterDataTypeId": 1,
                "properties": [
                  {
                    "type": "text",
                    "attrs": {
                      "type": "text",
                      "uuid": "123e4567-e89b-12d3-a456-426614174000",
                      "id": "text",
                      "label": "text",
                      "renderAs": "text",
                      "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                    }
                  }
                ],
                "level": 1,
                "href": "text",
                "textAlign": "text"
              }
            }
          ],
          "content": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

application/jsontext/jsonapplication/*+json

No content