Skip to main content
POST
/
v1
/
entities
Create entity
curl --request POST \
  --url https://api.example.com/v1/entities \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "id": "<string>",
  "description": "<string>",
  "viewPermission": [
    "<string>"
  ],
  "registerUserRoles": true,
  "validations": [
    {}
  ],
  "legalContractId": "<string>",
  "dataProcessing": [
    {
      "id": "<string>",
      "type": "<string>",
      "inputParameters": [
        "<string>"
      ],
      "outputParameters": [
        "<string>"
      ]
    }
  ],
  "sheetData": {
    "sheetApiId": "<string>",
    "id": "<string>",
    "cell": "<string>",
    "inputType": "<string>",
    "parameterId": "<string>",
    "entityId": "<string>",
    "entityParameterId": "<string>",
    "page": "<string>",
    "formula": "<string>"
  },
  "parameters": [
    {
      "label": "<string>",
      "id": "<string>",
      "name": "<string>",
      "type": "ATTACHMENT",
      "isUnique": true,
      "isRequired": true,
      "policyNames": [
        "<string>"
      ],
      "entityRelationAuxParamIds": [
        "<string>"
      ],
      "entityId": "<string>",
      "entityRelationId": "<string>",
      "entityRelation": {},
      "entityRelationParameter": {},
      "entityRelationParameterId": "<string>",
      "computedFormula": [
        "<string>"
      ],
      "optionItems": [
        {
          "value": "<string>",
          "id": "<string>",
          "label": "<string>",
          "color": "<string>",
          "meta": {},
          "parameterId": "<string>",
          "persisted": true,
          "entityParameterId": "<string>",
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "deletedAt": "<string>"
        }
      ],
      "sheetData": {
        "sheetApiId": "<string>",
        "id": "<string>",
        "cell": "<string>",
        "inputType": "<string>",
        "parameterId": "<string>",
        "entityId": "<string>",
        "entityParameterId": "<string>",
        "page": "<string>",
        "formula": "<string>"
      },
      "advancedOptions": {
        "id": "<string>",
        "tooltip": "<string>",
        "description": "<string>",
        "placeholder": "<string>",
        "max": 123,
        "maxLength": 123,
        "min": 123,
        "minLength": 123,
        "decimals": 123,
        "sort": 123,
        "currency": "USD",
        "locale": "pt-BR",
        "isHidden": true,
        "rightFreeze": true,
        "leftFreeze": true,
        "hasCustomColor": true,
        "hasMetadata": true,
        "hiddenFrom": [
          "<string>"
        ],
        "isMultiple": true,
        "insertOnEntity": "<string>",
        "insertOnEntityMetadata": [
          "<string>"
        ],
        "dateFormat": "dd/MM/yyyy",
        "entityOperation": [
          "WRITE"
        ],
        "parameterId": "<string>",
        "entityParameterId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "deletedAt": "<string>"
      },
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>"
    }
  ]
}
'
{
  "name": "<string>",
  "id": "<string>",
  "description": "<string>",
  "viewPermission": [
    "<string>"
  ],
  "registerUserRoles": true,
  "validations": [
    {}
  ],
  "legalContractId": "<string>",
  "dataProcessing": [
    {
      "id": "<string>",
      "type": "<string>",
      "inputParameters": [
        "<string>"
      ],
      "outputParameters": [
        "<string>"
      ]
    }
  ],
  "sheetData": {
    "sheetApiId": "<string>",
    "id": "<string>",
    "cell": "<string>",
    "inputType": "<string>",
    "parameterId": "<string>",
    "entityId": "<string>",
    "entityParameterId": "<string>",
    "page": "<string>",
    "formula": "<string>"
  },
  "parameters": [
    {
      "label": "<string>",
      "id": "<string>",
      "name": "<string>",
      "type": "ATTACHMENT",
      "isUnique": true,
      "isRequired": true,
      "policyNames": [
        "<string>"
      ],
      "entityRelationAuxParamIds": [
        "<string>"
      ],
      "entityId": "<string>",
      "entityRelationId": "<string>",
      "entityRelation": {},
      "entityRelationParameter": {},
      "entityRelationParameterId": "<string>",
      "computedFormula": [
        "<string>"
      ],
      "optionItems": [
        {
          "value": "<string>",
          "id": "<string>",
          "label": "<string>",
          "color": "<string>",
          "meta": {},
          "parameterId": "<string>",
          "persisted": true,
          "entityParameterId": "<string>",
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "deletedAt": "<string>"
        }
      ],
      "sheetData": {
        "sheetApiId": "<string>",
        "id": "<string>",
        "cell": "<string>",
        "inputType": "<string>",
        "parameterId": "<string>",
        "entityId": "<string>",
        "entityParameterId": "<string>",
        "page": "<string>",
        "formula": "<string>"
      },
      "advancedOptions": {
        "id": "<string>",
        "tooltip": "<string>",
        "description": "<string>",
        "placeholder": "<string>",
        "max": 123,
        "maxLength": 123,
        "min": 123,
        "minLength": 123,
        "decimals": 123,
        "sort": 123,
        "currency": "USD",
        "locale": "pt-BR",
        "isHidden": true,
        "rightFreeze": true,
        "leftFreeze": true,
        "hasCustomColor": true,
        "hasMetadata": true,
        "hiddenFrom": [
          "<string>"
        ],
        "isMultiple": true,
        "insertOnEntity": "<string>",
        "insertOnEntityMetadata": [
          "<string>"
        ],
        "dateFormat": "dd/MM/yyyy",
        "entityOperation": [
          "WRITE"
        ],
        "parameterId": "<string>",
        "entityParameterId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "deletedAt": "<string>"
      },
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>"
    }
  ]
}
Schema: 
{
  "type": "object",
  "required": ["name", "parameters"],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the entity"
    },
    "parameters": {
      "type": "array",
      "description": "Array of parameter definitions for the entity",
      "items": {
        "type": "object",
        "required": ["label", "type"],
        "properties": {
          "label": {
            "type": "string",
            "description": "Display label for the parameter"
          },
          "type": {
            "type": "string",
            "enum": [
              "ATTACHMENT",
              "IMAGE",
              "SIGNATURE",
              "CHECKBOX",
              "CPF",
              "TIME",
              "USER",
              "URL",
              "HTML",
              "CEP",
              "CPFCNPJ",
              "CNPJ",
              "DATE",
              "DATETIME",
              "EMAIL",
              "LIST",
              "NUMBER",
              "PHONE",
              "RADIO",
              "SELECT",
              "TEXT",
              "TEXTAREA",
              "TABLE",
              "TOGGLE",
              "CURRENCY",
              "LOCATION",
              "CERTIDOES",
              "PERCENTAGE",
              "ENTITY_RELATION",
              "SECTION",
            ],
            "description": "Type of the parameter"
          },
          "optionItems": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Available options for SELECT, CHECKBOX, TOGGLE & RADIO type parameters"
          },
          "entityRelationId": {
            "type": "string",
            "description": "Target entity and parameter for ENTITY_RELATION (format: 'EntityName.parameterLabel')"
          },
          "entityRelationAuxParamIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Additional parameters to display for ENTITY_RELATION"
          }
        },
        "allOf": [
          {
            "if": {
              "properties": { "type": { "const": "SELECT" | "CHECKBOX" | "TOGGLE" | "RADIO" } }
            },
            "then": {
              "required": ["optionItems"]
            }
          },
          {
            "if": {
              "properties": { "type": { "const": "ENTITY_RELATION" } }
            },
            "then": {
              "required": ["entityRelationId"]
            }
          }
        ]
      }
    }
  }
}
Simple request
{
  "name": "User",
  "parameters": [
    {
      "label": "name",
      "type": "TEXT"
    },
    {
      "label": "age",
      "type": "NUMBER"
    }
  ]
}
Simple request with optionItems: 
{
  "name": "User",
  "parameters": [
    {
      "label": "name",
      "type": "TEXT"
    },
    {
      "label": "age",
      "type": "NUMBER"
    },
    {
      "label": "sex",
      "type": "SELECT",
      "optionItems": ["Male", "Female"]
    }
  ]
}
Relation with another entity: 
{
  "name": "User",
  "parameters": [
    {
      "label": "name",
      "type": "TEXT"
    },
    {
      "label": "age",
      "type": "NUMBER"
    },
    {
      "label": "address",
      "type": "ENTITY_RELATION",
      "entityRelationId": "Address.street"
    }
  ]
}
Relation with another entity with aux params: 
{
  "name": "User",
  "parameters": [
    {
      "label": "name",
      "type": "TEXT"
    },
    {
      "label": "age",
      "type": "NUMBER"
    },
    {
      "label": "address",
      "type": "ENTITY_RELATION",
      "entityRelationId": "Address.street"
      "entityRelationAuxParamIds": ["Address.city","Address.state"]
    }
  ]
}

Body

application/json
​
name
string
required
​
id
string
​
description
string
​
viewPermission
string[]
​
registerUserRoles
boolean
​
validations
object[]
​
legalContractId
string
​
dataProcessing
object[]
​
sheetData
object
​
parameters
object[]

Response

201 - application/json

ok

​
name
string
required
​
id
string
​
description
string
​
viewPermission
string[]
​
registerUserRoles
boolean
​
validations
object[]
​
legalContractId
string
​
dataProcessing
object[]
​
sheetData
object
​
parameters
object[]