v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Create DIY Template

Create a DIY template

post/api/workspaces/{workspaceID}/dataflows/diy

Path parameters

workspaceIDinteger required

Workspace ID where the template is being created.

Request body

namestring required

Name of the template being created.

blockListstring[] required

Array containing the details of the blocks or processors.

blockNamestring required

Name of the block in the template.

blockTypestring required

Type of process executed by the block corresponds to the name parameter in the response from the GET processor API.

blockOrderstring required

Order in which the block is created. It defines the linking between the blocks.

Response

200

namestring

uuidstring

Example response

{
  "name": "DIYDEMONEO_TESTDOC",
  "uuid": "28bdca6c-0192-1000-ffff-fffff93a616d",
  "blocks": [
    {
      "blockTypeId": 65,
      "name": "Transform-Data",
      "type": "csv_json_neo_transformer",
      "hide": "block-section",
      "fields": [
        {
          "name": "File",
          "displayName": "File Type",
          "htmlType": "select",
          "possibleValues": [
            {
              "label": "csv",
              "value": "5c5b9607-0173-1000-87ad-a0b9ca44885f"
            }
          ],
          "value": "null"
        }
      ],
      "connections": [
        {
          "relationship": "splits",
          "destinationBlockName": "Neo-Transformer",
          "loadBalanceStrategy": "ROUND_ROBIN"
        }
      ],
      "validationErrors": [
        "'Record Reader' is invalid because Record Reader is required"
      ],
      "visible": true,
      "fieldsNotIsAdvanced": [
        {
          "name": "File",
          "displayName": "File Type",
          "htmlType": "select",
          "possibleValues": [
            {
              "label": "csv",
              "value": "5c5b9607-0173-1000-87ad-a0b9ca44885f"
            }
          ],
          "value": "null"
        }
      ]
    }
  ],
  "status": {
    "state": "Draft",
    "runningCount": 1,
    "stoppedCount": 9,
    "invalidCount": 7
  },
  "schedule": {
    "cron": "0 0 12 1 6 ? *",
    "cronFrequencyInSeconds": 31536000
  }
}