Skip to main content

Save User Form

Endpoint: POST /api/human/template

Saves a user form in the Conductor server.

Query parameters​

ParameterDescriptionTypeRequired/ Optional
newVersionWhether to save the user form as a new version. Default is false.

Note: If the version number is specified in the request body, it will take precedence even if newVersion is set to false.		stringRequired.

Request body​

Format the request as an object containing the user form JSON schema.

Response​

Returns the updated user form.

Examples​

Save a user form

Request

curl -X 'POST' \
  'https://<YOUR_CLUSTER>/api/human/template' \
  -H 'accept: application/json' \
  -H 'X-Authorization: <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "createTime": 1736938081924,
  "updateTime": 1736938081924,
  "createdBy": "USER:user@example.com",
  "updatedBy": "USER:user@example.com",
  "name": "someForm",
  "jsonSchema": {
    "$schema": "http://json-schema.org/draft-07/schema",
    "properties": {
      "vegetable": {
        "type": "string",
        "enum": [
          "potatoes",
          "carrots",
          "celery"
        ]
      }
    }
  },
  "templateUI": {
    "type": "VerticalLayout",
    "elements": [
      {
        "type": "Control",
        "scope": "#/properties/vegetable",
        "label": "Pick one",
        "options": {}
      }
    ]
  }
}'

Response

{
  "createTime": 1736938081924,
  "updateTime": 1736938081924,
  "createdBy": "USER:user@example.com",
  "updatedBy": "USER:user@example.com",
  "name": "someForm",
  "version": 1,
  "jsonSchema": {
    "$schema": "http://json-schema.org/draft-07/schema",
    "properties": {
      "vegetable": {
        "type": "string",
        "enum": ["potatoes", "carrots", "celery"]
      }
    }
  },
  "templateUI": {
    "type": "VerticalLayout",
    "elements": [
      {
        "type": "Control",
        "scope": "#/properties/vegetable",
        "label": "Pick one",
        "options": {}
      }
    ]
  }
}
Save a user form as a new version

Request

curl -X 'POST' \
  'https://<YOUR_CLUSTER>/api/human/template?newVersion=true' \
  -H 'accept: application/json' \
  -H 'X-Authorization: <TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "createTime": 1736938081924,
  "updateTime": 1736938081924,
  "createdBy": "USER:user@example.com",
  "updatedBy": "USER:user@example.com",
  "name": "someForm",
  "jsonSchema": {
    "$schema": "http://json-schema.org/draft-07/schema",
    "properties": {
      "vegetable": {
        "type": "string",
        "enum": [
          "potatoes",
          "carrots",
          "celery",
          "apple",
          "banana"
        ]
      }
    }
  },
  "templateUI": {
    "type": "VerticalLayout",
    "elements": [
      {
        "type": "Control",
        "scope": "#/properties/vegetable",
        "label": "Pick a vegetable or fruit",
        "options": {}
      }
    ]
  }
}'

Response

{
  "createTime": 1736938081924,
  "updateTime": 1736938081924,
  "createdBy": "USER:user@example.com",
  "updatedBy": "USER:user@example.com",
  "name": "someForm",
  "version": 2,
  "jsonSchema": {
    "$schema": "http://json-schema.org/draft-07/schema",
    "properties": {
      "vegetable": {
        "type": "string",
        "enum": ["potatoes", "carrots", "celery", "apple", "banana"]
      }
    }
  },
  "templateUI": {
    "type": "VerticalLayout",
    "elements": [
      {
        "type": "Control",
        "scope": "#/properties/vegetable",
        "label": "Pick one",
        "options": {}
      }
    ]
  }
}