Skip to main content
POST
/
v1
/
entities
Create entity
curl --request POST \
  --url https://api.example.com/v1/entities \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "id": "<string>",
  "viewPermission": [
    "<string>"
  ],
  "registerUserRoles": true,
  "validations": [
    {}
  ],
  "legalContractId": "<string>",
  "dataProcessing": [
    {
      "id": "<string>",
      "type": "<string>",
      "inputParameters": [
        "<string>"
      ],
      "outputParameters": [
        "<string>"
      ]
    }
  ],
  "sheetApis": [
    {
      "id": "<string>",
      "name": "<string>",
      "key": "<string>",
      "gSheetKey": "<string>",
      "entityId": "<string>",
      "hasSheetIntegration": true
    }
  ],
  "parameters": [
    {
      "name": "<string>",
      "label": "<string>",
      "id": "<string>",
      "type": "ATTACHMENT",
      "isCalc": true,
      "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": {
        "id": "<string>",
        "cell": "<string>",
        "inputType": "<string>",
        "page": "<string>",
        "sheet": "<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>"
      },
      "parameters": [
        {
          "id": "<string>",
          "name": "<string>",
          "label": "<string>",
          "type": "ATTACHMENT",
          "isCalc": true,
          "isUnique": true,
          "isPermanent": true,
          "columns": 123,
          "stepId": "<string>",
          "isRequired": true,
          "decimals": 123,
          "parameterId": "<string>",
          "computedFormula": [
            "<string>"
          ],
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "optionItems": [
            {
              "value": "<string>",
              "id": "<string>",
              "label": "<string>",
              "color": "<string>",
              "meta": {},
              "parameterId": "<string>",
              "persisted": true,
              "entityParameterId": "<string>",
              "createdAt": "<string>",
              "updatedAt": "<string>",
              "deletedAt": "<string>"
            }
          ],
          "sheetData": {
            "id": "<string>",
            "cell": "<string>",
            "inputType": "<string>",
            "page": "<string>",
            "sheet": "<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>"
          },
          "readFromOtherMeasurementData": {
            "processId": "<string>",
            "stepId": "<string>",
            "id": "<string>",
            "parameterId": "<string>",
            "readParameterId": "<string>",
            "searchFieldId": "<string>",
            "selectedFields": [
              {
                "readParameterId": "<string>",
                "writeParameterId": "<string>"
              }
            ]
          }
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>"
    }
  ]
}
'
{
  "name": "<string>",
  "id": "<string>",
  "viewPermission": [
    "<string>"
  ],
  "registerUserRoles": true,
  "validations": [
    {}
  ],
  "legalContractId": "<string>",
  "dataProcessing": [
    {
      "id": "<string>",
      "type": "<string>",
      "inputParameters": [
        "<string>"
      ],
      "outputParameters": [
        "<string>"
      ]
    }
  ],
  "sheetApis": [
    {
      "id": "<string>",
      "name": "<string>",
      "key": "<string>",
      "gSheetKey": "<string>",
      "entityId": "<string>",
      "hasSheetIntegration": true
    }
  ],
  "parameters": [
    {
      "name": "<string>",
      "label": "<string>",
      "id": "<string>",
      "type": "ATTACHMENT",
      "isCalc": true,
      "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": {
        "id": "<string>",
        "cell": "<string>",
        "inputType": "<string>",
        "page": "<string>",
        "sheet": "<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>"
      },
      "parameters": [
        {
          "id": "<string>",
          "name": "<string>",
          "label": "<string>",
          "type": "ATTACHMENT",
          "isCalc": true,
          "isUnique": true,
          "isPermanent": true,
          "columns": 123,
          "stepId": "<string>",
          "isRequired": true,
          "decimals": 123,
          "parameterId": "<string>",
          "computedFormula": [
            "<string>"
          ],
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "optionItems": [
            {
              "value": "<string>",
              "id": "<string>",
              "label": "<string>",
              "color": "<string>",
              "meta": {},
              "parameterId": "<string>",
              "persisted": true,
              "entityParameterId": "<string>",
              "createdAt": "<string>",
              "updatedAt": "<string>",
              "deletedAt": "<string>"
            }
          ],
          "sheetData": {
            "id": "<string>",
            "cell": "<string>",
            "inputType": "<string>",
            "page": "<string>",
            "sheet": "<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>"
          },
          "readFromOtherMeasurementData": {
            "processId": "<string>",
            "stepId": "<string>",
            "id": "<string>",
            "parameterId": "<string>",
            "readParameterId": "<string>",
            "searchFieldId": "<string>",
            "selectedFields": [
              {
                "readParameterId": "<string>",
                "writeParameterId": "<string>"
              }
            ]
          }
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Body

application/json
name
string
required
id
string
viewPermission
string[]
registerUserRoles
boolean
validations
object[]
dataProcessing
object[]
sheetApis
object[]
parameters
object[]

Response

201 - application/json

ok

name
string
required
id
string
viewPermission
string[]
registerUserRoles
boolean
validations
object[]
dataProcessing
object[]
sheetApis
object[]
parameters
object[]