Sign in

v1

latestOpenAPI 3.0.02026-07-14202153.0 KB
Data Entities

Get data entity structure

Returns the data entity structure with its respective fields and data type.

Response status code

  1. Status Code 403: Access not allowed
  2. Status Code 200: Retrieves data entity structure

All headers listed below are required.

get/api/dataentities/{acronym}

Path parameters

acronymstring required

Identifies the kind of data

Headers

Content-Typestring required

Type of the content being sent

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand

Response

acronymstring required
allowGetAllboolean required
namestring required
primaryKeyTypestring required

Example response

{
  "acronym": "SP",
  "allowGetAll": false,
  "fields": [
    {
      "displayName": "Atualizado em",
      "isFilter": true,
      "isInternal": true,
      "isNullable": true,
      "isSearchable": false,
      "name": "updatedIn",
      "type": "Date and Time"
    },
    {
      "displayName": "Atualizado por",
      "isFilter": true,
      "isInternal": true,
      "isNullable": true,
      "isSearchable": false,
      "name": "updatedBy",
      "type": "User Login"
    },
    {
      "displayName": "Auto increment",
      "isFilter": false,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "Auto_Increment",
      "type": "Auto Increment"
    },
    {
      "displayName": "Boolean",
      "isFilter": true,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "Boolean",
      "type": "Boolean"
    },
    {
      "displayName": "Criado em",
      "isFilter": true,
      "isInternal": true,
      "isNullable": true,
      "isSearchable": false,
      "name": "createdIn",
      "type": "Date and Time"
    },
    {
      "displayName": "Criado por",
      "isFilter": true,
      "isInternal": true,
      "isNullable": true,
      "isSearchable": false,
      "name": "createdBy",
      "type": "User Login"
    },
    {
      "displayName": "Currency",
      "isFilter": true,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "Currency",
      "type": "Currency"
    },
    {
      "displayName": "Date",
      "isFilter": true,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "Date",
      "type": "Date"
    },
    {
      "displayName": "Date and Time",
      "isFilter": true,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "Date_Time",
      "type": "Date and Time"
    },
    {
      "displayName": "Decimal",
      "isFilter": true,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "Decimal",
      "type": "Decimal"
    },
    {
      "displayName": "Email",
      "isFilter": false,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": true,
      "name": "Email",
      "type": "Email"
    },
    {
      "displayName": "Entidade de dados",
      "isFilter": false,
      "isInternal": true,
      "isNullable": false,
      "isSearchable": true,
      "name": "dataEntityId",
      "type": "Varchar 10"
    },
    {
      "displayName": "File",
      "isFilter": false,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "File",
      "type": "File"
    },
    {
      "displayName": "Filtro automático",
      "isFilter": false,
      "isInternal": true,
      "isNullable": true,
      "isSearchable": false,
      "name": "auto_filter",
      "type": "Text"
    },
    {
      "displayName": "ID da loja",
      "isFilter": false,
      "isInternal": true,
      "isNullable": false,
      "isSearchable": false,
      "name": "accountId",
      "type": "Varchar 50"
    },
    {
      "displayName": "Id do documento",
      "isFilter": false,
      "isInternal": true,
      "isNullable": false,
      "isSearchable": true,
      "name": "id",
      "type": "Varchar 100"
    },
    {
      "displayName": "Integer",
      "isFilter": true,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "Integer",
      "type": "Integer"
    },
    {
      "displayName": "Long",
      "isFilter": true,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "Long",
      "type": "Long"
    },
    {
      "displayName": "Nome da loja",
      "isFilter": false,
      "isInternal": true,
      "isNullable": false,
      "isSearchable": true,
      "name": "accountName",
      "type": "Varchar 100"
    },
    {
      "displayName": "Percent",
      "isFilter": true,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "Percent",
      "type": "Percent"
    },
    {
      "displayName": "Relationship",
      "isFilter": false,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": true,
      "name": "Relationship",
      "type": "Relationship"
    },
    {
      "displayName": "Score2",
      "isFilter": true,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "Score2",
      "type": "Score2"
    },
    {
      "displayName": "Seguidores",
      "isFilter": false,
      "isInternal": true,
      "isNullable": true,
      "isSearchable": true,
      "name": "followers",
      "type": "Text"
    },
    {
      "displayName": "Tags",
      "isFilter": false,
      "isInternal": true,
      "isNullable": true,
      "isSearchable": true,
      "name": "tags",
      "type": "Text"
    },
    {
      "displayName": "Text",
      "isFilter": false,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "Text",
      "type": "Text"
    },
    {
      "displayName": "Time",
      "isFilter": false,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "Time",
      "type": "Time"
    },
    {
      "displayName": "Ultima interação em",
      "isFilter": true,
      "isInternal": true,
      "isNullable": true,
      "isSearchable": false,
      "name": "lastInteractionIn",
      "type": "Date and Time"
    },
    {
      "displayName": "Ultima interação por",
      "isFilter": true,
      "isInternal": true,
      "isNullable": true,
      "isSearchable": false,
      "name": "lastInteractionBy",
      "type": "User Login"
    },
    {
      "displayName": "URL",
      "isFilter": true,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": false,
      "name": "URL",
      "type": "URL"
    },
    {
      "displayName": "User Login",
      "isFilter": false,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": true,
      "name": "User_Login",
      "type": "User Login"
    },
    {
      "displayName": "Varchar 10",
      "isFilter": false,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": true,
      "name": "Varchar10",
      "type": "Varchar 10"
    },
    {
      "displayName": "Varchar 100",
      "isFilter": false,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": true,
      "name": "Varchar100",
      "type": "Varchar 100"
    },
    {
      "displayName": "Varchar 50",
      "isFilter": false,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": true,
      "name": "Varchar50",
      "type": "Varchar 50"
    },
    {
      "displayName": "Varchar 750",
      "isFilter": false,
      "isInternal": false,
      "isNullable": true,
      "isSearchable": true,
      "name": "Varchar750",
      "type": "Varchar 750"
    }
  ],
  "name": "Sample",
  "primaryKeyType": "GUID"
}