Skip to main content
GET
/
v1
/
entities
/
{id}
/
data
Get entity data
curl --request GET \
  --url https://api.example.com/v1/entities/{id}/data \
  --header 'Authorization: <api-key>'
{
  "data": {
    "label": "<string>",
    "params": [
      {
        "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>"
      }
    ],
    "dataItems": [
      {}
    ],
    "dataProcessing": [
      {
        "id": "<string>",
        "type": "<string>",
        "inputParameters": [
          "<string>"
        ],
        "outputParameters": [
          "<string>"
        ]
      }
    ],
    "validations": {},
    "missingValidations": {},
    "areThereValidations": true,
    "hasGSheetKey": true,
    "actions": [
      {
        "id": "<string>",
        "type": "<string>",
        "role": "<string>",
        "username": "<string>",
        "observation": "<string>",
        "createdAt": "<string>"
      }
    ]
  },
  "meta": {
    "total": 123,
    "lastPage": 123,
    "currentPage": 123,
    "perPage": 123,
    "prev": 123,
    "next": 123
  }
}

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

Query Parameters

page
string
pageLimit
string
parameterId
string
filters
string
hideId
string
hideParams
string
entityDataIds
string
hiddenColumns
string
includeActions
string
doubleCheckPermissions
string
includeIncomingRelations
string

Response

200 - application/json

ok

data
object
meta
object