Skip to main content
PUT
/
api
/
data-forms
/
{id}
Update DataForms
curl --request PUT \
  --url https://platform.kodexa.ai/api/data-forms/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "actions": [
      {
        "name": "<string>",
        "properties": {},
        "type": "<string>"
      }
    ],
    "bridge": {
      "apiBaseUrl": "<string>",
      "maxExecutionMs": 123,
      "permissions": [
        "<string>"
      ]
    },
    "cards": [
      {
        "children": "<array>",
        "id": "<string>",
        "properties": {},
        "type": "<string>"
      }
    ],
    "checksum": "<string>",
    "deleteProtection": true,
    "description": "<string>",
    "editable": true,
    "entrypoints": [
      "<string>"
    ],
    "eventTriggers": [
      {
        "debounce": 123,
        "filter": {
          "dataObjectUUID": "<string>",
          "path": "<string>"
        },
        "on": "<string>",
        "script": "<string>"
      }
    ],
    "icon": "<string>",
    "imageUrl": "<string>",
    "nodes": [
      {
        "bindings": {},
        "children": "<array>",
        "class": "<unknown>",
        "component": "<string>",
        "computed": {},
        "events": {},
        "for": {
          "indexAs": "<string>",
          "itemAs": "<string>",
          "key": "<string>",
          "source": "<string>"
        },
        "if": "<string>",
        "key": "<string>",
        "meta": {
          "category": "<string>",
          "description": "<string>",
          "designOnly": true,
          "label": "<string>"
        },
        "props": {},
        "ref": "<string>",
        "show": "<string>",
        "slots": {},
        "style": "<unknown>"
      }
    ],
    "options": [
      {
        "default": "<unknown>",
        "description": "<string>",
        "displayProperties": {},
        "label": "<string>",
        "name": "<string>",
        "possibleValues": [
          "<unknown>"
        ],
        "required": true,
        "type": "<string>"
      }
    ],
    "overviewMarkdown": "<string>",
    "provider": "<string>",
    "providerImageUrl": "<string>",
    "providerUrl": "<string>",
    "scriptModules": {},
    "scriptTriggers": [
      {
        "debounce": 123,
        "script": "<string>",
        "triggerOn": [
          "<string>"
        ]
      }
    ],
    "scripts": {},
    "version": "<string>",
    "views": [
      {
        "name": "<string>",
        "properties": {}
      }
    ]
  },
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "template": true,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<string>"
}
'
import requests

url = "https://platform.kodexa.ai/api/data-forms/{id}"

payload = {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "deleteUserEmail": "<string>",
    "deleteUserId": "<string>",
    "deleted": True,
    "deletedDate": "2023-11-07T05:31:56Z",
    "deprecated": True,
    "extensionPackRef": "<string>",
    "id": "<string>",
    "metadata": {
        "actions": [
            {
                "name": "<string>",
                "properties": {},
                "type": "<string>"
            }
        ],
        "bridge": {
            "apiBaseUrl": "<string>",
            "maxExecutionMs": 123,
            "permissions": ["<string>"]
        },
        "cards": [
            {
                "children": "<array>",
                "id": "<string>",
                "properties": {},
                "type": "<string>"
            }
        ],
        "checksum": "<string>",
        "deleteProtection": True,
        "description": "<string>",
        "editable": True,
        "entrypoints": ["<string>"],
        "eventTriggers": [
            {
                "debounce": 123,
                "filter": {
                    "dataObjectUUID": "<string>",
                    "path": "<string>"
                },
                "on": "<string>",
                "script": "<string>"
            }
        ],
        "icon": "<string>",
        "imageUrl": "<string>",
        "nodes": [
            {
                "bindings": {},
                "children": "<array>",
                "class": "<unknown>",
                "component": "<string>",
                "computed": {},
                "events": {},
                "for": {
                    "indexAs": "<string>",
                    "itemAs": "<string>",
                    "key": "<string>",
                    "source": "<string>"
                },
                "if": "<string>",
                "key": "<string>",
                "meta": {
                    "category": "<string>",
                    "description": "<string>",
                    "designOnly": True,
                    "label": "<string>"
                },
                "props": {},
                "ref": "<string>",
                "show": "<string>",
                "slots": {},
                "style": "<unknown>"
            }
        ],
        "options": [
            {
                "default": "<unknown>",
                "description": "<string>",
                "displayProperties": {},
                "label": "<string>",
                "name": "<string>",
                "possibleValues": ["<unknown>"],
                "required": True,
                "type": "<string>"
            }
        ],
        "overviewMarkdown": "<string>",
        "provider": "<string>",
        "providerImageUrl": "<string>",
        "providerUrl": "<string>",
        "scriptModules": {},
        "scriptTriggers": [
            {
                "debounce": 123,
                "script": "<string>",
                "triggerOn": ["<string>"]
            }
        ],
        "scripts": {},
        "version": "<string>",
        "views": [
            {
                "name": "<string>",
                "properties": {}
            }
        ]
    },
    "name": "<string>",
    "organizationId": "<string>",
    "publicAccess": True,
    "slug": "<string>",
    "template": True,
    "type": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "yamlSource": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    changeSequence: 123,
    createdOn: '2023-11-07T05:31:56Z',
    deleteUserEmail: '<string>',
    deleteUserId: '<string>',
    deleted: true,
    deletedDate: '2023-11-07T05:31:56Z',
    deprecated: true,
    extensionPackRef: '<string>',
    id: '<string>',
    metadata: {
      actions: [{name: '<string>', properties: {}, type: '<string>'}],
      bridge: {apiBaseUrl: '<string>', maxExecutionMs: 123, permissions: ['<string>']},
      cards: [{children: '<array>', id: '<string>', properties: {}, type: '<string>'}],
      checksum: '<string>',
      deleteProtection: true,
      description: '<string>',
      editable: true,
      entrypoints: ['<string>'],
      eventTriggers: [
        {
          debounce: 123,
          filter: {dataObjectUUID: '<string>', path: '<string>'},
          on: '<string>',
          script: '<string>'
        }
      ],
      icon: '<string>',
      imageUrl: '<string>',
      nodes: [
        {
          bindings: {},
          children: '<array>',
          class: '<unknown>',
          component: '<string>',
          computed: {},
          events: {},
          for: {indexAs: '<string>', itemAs: '<string>', key: '<string>', source: '<string>'},
          if: '<string>',
          key: '<string>',
          meta: {
            category: '<string>',
            description: '<string>',
            designOnly: true,
            label: '<string>'
          },
          props: {},
          ref: '<string>',
          show: '<string>',
          slots: {},
          style: '<unknown>'
        }
      ],
      options: [
        {
          default: '<unknown>',
          description: '<string>',
          displayProperties: {},
          label: '<string>',
          name: '<string>',
          possibleValues: ['<unknown>'],
          required: true,
          type: '<string>'
        }
      ],
      overviewMarkdown: '<string>',
      provider: '<string>',
      providerImageUrl: '<string>',
      providerUrl: '<string>',
      scriptModules: {},
      scriptTriggers: [{debounce: 123, script: '<string>', triggerOn: ['<string>']}],
      scripts: {},
      version: '<string>',
      views: [{name: '<string>', properties: {}}]
    },
    name: '<string>',
    organizationId: '<string>',
    publicAccess: true,
    slug: '<string>',
    template: true,
    type: '<string>',
    updatedOn: '2023-11-07T05:31:56Z',
    uuid: '<string>',
    yamlSource: '<string>'
  })
};

fetch('https://platform.kodexa.ai/api/data-forms/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.kodexa.ai/api/data-forms/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'changeSequence' => 123,
    'createdOn' => '2023-11-07T05:31:56Z',
    'deleteUserEmail' => '<string>',
    'deleteUserId' => '<string>',
    'deleted' => true,
    'deletedDate' => '2023-11-07T05:31:56Z',
    'deprecated' => true,
    'extensionPackRef' => '<string>',
    'id' => '<string>',
    'metadata' => [
        'actions' => [
                [
                                'name' => '<string>',
                                'properties' => [
                                                                
                                ],
                                'type' => '<string>'
                ]
        ],
        'bridge' => [
                'apiBaseUrl' => '<string>',
                'maxExecutionMs' => 123,
                'permissions' => [
                                '<string>'
                ]
        ],
        'cards' => [
                [
                                'children' => '<array>',
                                'id' => '<string>',
                                'properties' => [
                                                                
                                ],
                                'type' => '<string>'
                ]
        ],
        'checksum' => '<string>',
        'deleteProtection' => true,
        'description' => '<string>',
        'editable' => true,
        'entrypoints' => [
                '<string>'
        ],
        'eventTriggers' => [
                [
                                'debounce' => 123,
                                'filter' => [
                                                                'dataObjectUUID' => '<string>',
                                                                'path' => '<string>'
                                ],
                                'on' => '<string>',
                                'script' => '<string>'
                ]
        ],
        'icon' => '<string>',
        'imageUrl' => '<string>',
        'nodes' => [
                [
                                'bindings' => [
                                                                
                                ],
                                'children' => '<array>',
                                'class' => '<unknown>',
                                'component' => '<string>',
                                'computed' => [
                                                                
                                ],
                                'events' => [
                                                                
                                ],
                                'for' => [
                                                                'indexAs' => '<string>',
                                                                'itemAs' => '<string>',
                                                                'key' => '<string>',
                                                                'source' => '<string>'
                                ],
                                'if' => '<string>',
                                'key' => '<string>',
                                'meta' => [
                                                                'category' => '<string>',
                                                                'description' => '<string>',
                                                                'designOnly' => true,
                                                                'label' => '<string>'
                                ],
                                'props' => [
                                                                
                                ],
                                'ref' => '<string>',
                                'show' => '<string>',
                                'slots' => [
                                                                
                                ],
                                'style' => '<unknown>'
                ]
        ],
        'options' => [
                [
                                'default' => '<unknown>',
                                'description' => '<string>',
                                'displayProperties' => [
                                                                
                                ],
                                'label' => '<string>',
                                'name' => '<string>',
                                'possibleValues' => [
                                                                '<unknown>'
                                ],
                                'required' => true,
                                'type' => '<string>'
                ]
        ],
        'overviewMarkdown' => '<string>',
        'provider' => '<string>',
        'providerImageUrl' => '<string>',
        'providerUrl' => '<string>',
        'scriptModules' => [
                
        ],
        'scriptTriggers' => [
                [
                                'debounce' => 123,
                                'script' => '<string>',
                                'triggerOn' => [
                                                                '<string>'
                                ]
                ]
        ],
        'scripts' => [
                
        ],
        'version' => '<string>',
        'views' => [
                [
                                'name' => '<string>',
                                'properties' => [
                                                                
                                ]
                ]
        ]
    ],
    'name' => '<string>',
    'organizationId' => '<string>',
    'publicAccess' => true,
    'slug' => '<string>',
    'template' => true,
    'type' => '<string>',
    'updatedOn' => '2023-11-07T05:31:56Z',
    'uuid' => '<string>',
    'yamlSource' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://platform.kodexa.ai/api/data-forms/{id}"

	payload := strings.NewReader("{\n  \"changeSequence\": 123,\n  \"createdOn\": \"2023-11-07T05:31:56Z\",\n  \"deleteUserEmail\": \"<string>\",\n  \"deleteUserId\": \"<string>\",\n  \"deleted\": true,\n  \"deletedDate\": \"2023-11-07T05:31:56Z\",\n  \"deprecated\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"id\": \"<string>\",\n  \"metadata\": {\n    \"actions\": [\n      {\n        \"name\": \"<string>\",\n        \"properties\": {},\n        \"type\": \"<string>\"\n      }\n    ],\n    \"bridge\": {\n      \"apiBaseUrl\": \"<string>\",\n      \"maxExecutionMs\": 123,\n      \"permissions\": [\n        \"<string>\"\n      ]\n    },\n    \"cards\": [\n      {\n        \"children\": \"<array>\",\n        \"id\": \"<string>\",\n        \"properties\": {},\n        \"type\": \"<string>\"\n      }\n    ],\n    \"checksum\": \"<string>\",\n    \"deleteProtection\": true,\n    \"description\": \"<string>\",\n    \"editable\": true,\n    \"entrypoints\": [\n      \"<string>\"\n    ],\n    \"eventTriggers\": [\n      {\n        \"debounce\": 123,\n        \"filter\": {\n          \"dataObjectUUID\": \"<string>\",\n          \"path\": \"<string>\"\n        },\n        \"on\": \"<string>\",\n        \"script\": \"<string>\"\n      }\n    ],\n    \"icon\": \"<string>\",\n    \"imageUrl\": \"<string>\",\n    \"nodes\": [\n      {\n        \"bindings\": {},\n        \"children\": \"<array>\",\n        \"class\": \"<unknown>\",\n        \"component\": \"<string>\",\n        \"computed\": {},\n        \"events\": {},\n        \"for\": {\n          \"indexAs\": \"<string>\",\n          \"itemAs\": \"<string>\",\n          \"key\": \"<string>\",\n          \"source\": \"<string>\"\n        },\n        \"if\": \"<string>\",\n        \"key\": \"<string>\",\n        \"meta\": {\n          \"category\": \"<string>\",\n          \"description\": \"<string>\",\n          \"designOnly\": true,\n          \"label\": \"<string>\"\n        },\n        \"props\": {},\n        \"ref\": \"<string>\",\n        \"show\": \"<string>\",\n        \"slots\": {},\n        \"style\": \"<unknown>\"\n      }\n    ],\n    \"options\": [\n      {\n        \"default\": \"<unknown>\",\n        \"description\": \"<string>\",\n        \"displayProperties\": {},\n        \"label\": \"<string>\",\n        \"name\": \"<string>\",\n        \"possibleValues\": [\n          \"<unknown>\"\n        ],\n        \"required\": true,\n        \"type\": \"<string>\"\n      }\n    ],\n    \"overviewMarkdown\": \"<string>\",\n    \"provider\": \"<string>\",\n    \"providerImageUrl\": \"<string>\",\n    \"providerUrl\": \"<string>\",\n    \"scriptModules\": {},\n    \"scriptTriggers\": [\n      {\n        \"debounce\": 123,\n        \"script\": \"<string>\",\n        \"triggerOn\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"scripts\": {},\n    \"version\": \"<string>\",\n    \"views\": [\n      {\n        \"name\": \"<string>\",\n        \"properties\": {}\n      }\n    ]\n  },\n  \"name\": \"<string>\",\n  \"organizationId\": \"<string>\",\n  \"publicAccess\": true,\n  \"slug\": \"<string>\",\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\",\n  \"yamlSource\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://platform.kodexa.ai/api/data-forms/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"changeSequence\": 123,\n  \"createdOn\": \"2023-11-07T05:31:56Z\",\n  \"deleteUserEmail\": \"<string>\",\n  \"deleteUserId\": \"<string>\",\n  \"deleted\": true,\n  \"deletedDate\": \"2023-11-07T05:31:56Z\",\n  \"deprecated\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"id\": \"<string>\",\n  \"metadata\": {\n    \"actions\": [\n      {\n        \"name\": \"<string>\",\n        \"properties\": {},\n        \"type\": \"<string>\"\n      }\n    ],\n    \"bridge\": {\n      \"apiBaseUrl\": \"<string>\",\n      \"maxExecutionMs\": 123,\n      \"permissions\": [\n        \"<string>\"\n      ]\n    },\n    \"cards\": [\n      {\n        \"children\": \"<array>\",\n        \"id\": \"<string>\",\n        \"properties\": {},\n        \"type\": \"<string>\"\n      }\n    ],\n    \"checksum\": \"<string>\",\n    \"deleteProtection\": true,\n    \"description\": \"<string>\",\n    \"editable\": true,\n    \"entrypoints\": [\n      \"<string>\"\n    ],\n    \"eventTriggers\": [\n      {\n        \"debounce\": 123,\n        \"filter\": {\n          \"dataObjectUUID\": \"<string>\",\n          \"path\": \"<string>\"\n        },\n        \"on\": \"<string>\",\n        \"script\": \"<string>\"\n      }\n    ],\n    \"icon\": \"<string>\",\n    \"imageUrl\": \"<string>\",\n    \"nodes\": [\n      {\n        \"bindings\": {},\n        \"children\": \"<array>\",\n        \"class\": \"<unknown>\",\n        \"component\": \"<string>\",\n        \"computed\": {},\n        \"events\": {},\n        \"for\": {\n          \"indexAs\": \"<string>\",\n          \"itemAs\": \"<string>\",\n          \"key\": \"<string>\",\n          \"source\": \"<string>\"\n        },\n        \"if\": \"<string>\",\n        \"key\": \"<string>\",\n        \"meta\": {\n          \"category\": \"<string>\",\n          \"description\": \"<string>\",\n          \"designOnly\": true,\n          \"label\": \"<string>\"\n        },\n        \"props\": {},\n        \"ref\": \"<string>\",\n        \"show\": \"<string>\",\n        \"slots\": {},\n        \"style\": \"<unknown>\"\n      }\n    ],\n    \"options\": [\n      {\n        \"default\": \"<unknown>\",\n        \"description\": \"<string>\",\n        \"displayProperties\": {},\n        \"label\": \"<string>\",\n        \"name\": \"<string>\",\n        \"possibleValues\": [\n          \"<unknown>\"\n        ],\n        \"required\": true,\n        \"type\": \"<string>\"\n      }\n    ],\n    \"overviewMarkdown\": \"<string>\",\n    \"provider\": \"<string>\",\n    \"providerImageUrl\": \"<string>\",\n    \"providerUrl\": \"<string>\",\n    \"scriptModules\": {},\n    \"scriptTriggers\": [\n      {\n        \"debounce\": 123,\n        \"script\": \"<string>\",\n        \"triggerOn\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"scripts\": {},\n    \"version\": \"<string>\",\n    \"views\": [\n      {\n        \"name\": \"<string>\",\n        \"properties\": {}\n      }\n    ]\n  },\n  \"name\": \"<string>\",\n  \"organizationId\": \"<string>\",\n  \"publicAccess\": true,\n  \"slug\": \"<string>\",\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\",\n  \"yamlSource\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/data-forms/{id}")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"changeSequence\": 123,\n  \"createdOn\": \"2023-11-07T05:31:56Z\",\n  \"deleteUserEmail\": \"<string>\",\n  \"deleteUserId\": \"<string>\",\n  \"deleted\": true,\n  \"deletedDate\": \"2023-11-07T05:31:56Z\",\n  \"deprecated\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"id\": \"<string>\",\n  \"metadata\": {\n    \"actions\": [\n      {\n        \"name\": \"<string>\",\n        \"properties\": {},\n        \"type\": \"<string>\"\n      }\n    ],\n    \"bridge\": {\n      \"apiBaseUrl\": \"<string>\",\n      \"maxExecutionMs\": 123,\n      \"permissions\": [\n        \"<string>\"\n      ]\n    },\n    \"cards\": [\n      {\n        \"children\": \"<array>\",\n        \"id\": \"<string>\",\n        \"properties\": {},\n        \"type\": \"<string>\"\n      }\n    ],\n    \"checksum\": \"<string>\",\n    \"deleteProtection\": true,\n    \"description\": \"<string>\",\n    \"editable\": true,\n    \"entrypoints\": [\n      \"<string>\"\n    ],\n    \"eventTriggers\": [\n      {\n        \"debounce\": 123,\n        \"filter\": {\n          \"dataObjectUUID\": \"<string>\",\n          \"path\": \"<string>\"\n        },\n        \"on\": \"<string>\",\n        \"script\": \"<string>\"\n      }\n    ],\n    \"icon\": \"<string>\",\n    \"imageUrl\": \"<string>\",\n    \"nodes\": [\n      {\n        \"bindings\": {},\n        \"children\": \"<array>\",\n        \"class\": \"<unknown>\",\n        \"component\": \"<string>\",\n        \"computed\": {},\n        \"events\": {},\n        \"for\": {\n          \"indexAs\": \"<string>\",\n          \"itemAs\": \"<string>\",\n          \"key\": \"<string>\",\n          \"source\": \"<string>\"\n        },\n        \"if\": \"<string>\",\n        \"key\": \"<string>\",\n        \"meta\": {\n          \"category\": \"<string>\",\n          \"description\": \"<string>\",\n          \"designOnly\": true,\n          \"label\": \"<string>\"\n        },\n        \"props\": {},\n        \"ref\": \"<string>\",\n        \"show\": \"<string>\",\n        \"slots\": {},\n        \"style\": \"<unknown>\"\n      }\n    ],\n    \"options\": [\n      {\n        \"default\": \"<unknown>\",\n        \"description\": \"<string>\",\n        \"displayProperties\": {},\n        \"label\": \"<string>\",\n        \"name\": \"<string>\",\n        \"possibleValues\": [\n          \"<unknown>\"\n        ],\n        \"required\": true,\n        \"type\": \"<string>\"\n      }\n    ],\n    \"overviewMarkdown\": \"<string>\",\n    \"provider\": \"<string>\",\n    \"providerImageUrl\": \"<string>\",\n    \"providerUrl\": \"<string>\",\n    \"scriptModules\": {},\n    \"scriptTriggers\": [\n      {\n        \"debounce\": 123,\n        \"script\": \"<string>\",\n        \"triggerOn\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"scripts\": {},\n    \"version\": \"<string>\",\n    \"views\": [\n      {\n        \"name\": \"<string>\",\n        \"properties\": {}\n      }\n    ]\n  },\n  \"name\": \"<string>\",\n  \"organizationId\": \"<string>\",\n  \"publicAccess\": true,\n  \"slug\": \"<string>\",\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\",\n  \"yamlSource\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "actions": [
      {
        "name": "<string>",
        "properties": {},
        "type": "<string>"
      }
    ],
    "bridge": {
      "apiBaseUrl": "<string>",
      "maxExecutionMs": 123,
      "permissions": [
        "<string>"
      ]
    },
    "cards": [
      {
        "children": "<array>",
        "id": "<string>",
        "properties": {},
        "type": "<string>"
      }
    ],
    "checksum": "<string>",
    "deleteProtection": true,
    "description": "<string>",
    "editable": true,
    "entrypoints": [
      "<string>"
    ],
    "eventTriggers": [
      {
        "debounce": 123,
        "filter": {
          "dataObjectUUID": "<string>",
          "path": "<string>"
        },
        "on": "<string>",
        "script": "<string>"
      }
    ],
    "icon": "<string>",
    "imageUrl": "<string>",
    "nodes": [
      {
        "bindings": {},
        "children": "<array>",
        "class": "<unknown>",
        "component": "<string>",
        "computed": {},
        "events": {},
        "for": {
          "indexAs": "<string>",
          "itemAs": "<string>",
          "key": "<string>",
          "source": "<string>"
        },
        "if": "<string>",
        "key": "<string>",
        "meta": {
          "category": "<string>",
          "description": "<string>",
          "designOnly": true,
          "label": "<string>"
        },
        "props": {},
        "ref": "<string>",
        "show": "<string>",
        "slots": {},
        "style": "<unknown>"
      }
    ],
    "options": [
      {
        "default": "<unknown>",
        "description": "<string>",
        "displayProperties": {},
        "label": "<string>",
        "name": "<string>",
        "possibleValues": [
          "<unknown>"
        ],
        "required": true,
        "type": "<string>"
      }
    ],
    "overviewMarkdown": "<string>",
    "provider": "<string>",
    "providerImageUrl": "<string>",
    "providerUrl": "<string>",
    "scriptModules": {},
    "scriptTriggers": [
      {
        "debounce": 123,
        "script": "<string>",
        "triggerOn": [
          "<string>"
        ]
      }
    ],
    "scripts": {},
    "version": "<string>",
    "views": [
      {
        "name": "<string>",
        "properties": {}
      }
    ]
  },
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "template": true,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Body

application/json

Data form metadata defines a structured data capture form for documents.

​
changeSequence
integer<int32>

Optimistic locking version number.

​
createdOn
string<date-time>

Timestamp when the data form was created.

​
deleteUserEmail
string | null
​
deleteUserId
string | null
​
deleted
boolean
​
deletedDate
string<date-time> | null
​
deprecated
boolean

Whether this data form is deprecated.

​
extensionPackRef
string
​
id
string

Unique identifier (UUID) for the data form.

​
metadata
object
​
name
string

Display name of the data form.

​
organizationId
string
​
publicAccess
boolean

Whether the data form is publicly accessible.

​
slug
string

URL-friendly identifier for the data form.

​
template
boolean

Whether this data form is a template.

​
type
string
​
updatedOn
string<date-time>

Timestamp when the data form was last updated.

​
uuid
string

Secondary UUID identifier.

​
yamlSource
string | null

Response

Updated DataForms

Data form metadata defines a structured data capture form for documents.

​
changeSequence
integer<int32>

Optimistic locking version number.

​
createdOn
string<date-time>

Timestamp when the data form was created.

​
deleteUserEmail
string | null
​
deleteUserId
string | null
​
deleted
boolean
​
deletedDate
string<date-time> | null
​
deprecated
boolean

Whether this data form is deprecated.

​
extensionPackRef
string
​
id
string

Unique identifier (UUID) for the data form.

​
metadata
object
​
name
string

Display name of the data form.

​
organizationId
string
​
publicAccess
boolean

Whether the data form is publicly accessible.

​
slug
string

URL-friendly identifier for the data form.

​
template
boolean

Whether this data form is a template.

​
type
string
​
updatedOn
string<date-time>

Timestamp when the data form was last updated.

​
uuid
string

Secondary UUID identifier.

​
yamlSource
string | null