Obtener estructura/esquema de un Objeto en Cliente

Para obtener la estructura/esquema de un Objeto en Cliente particular, se debe enviar un GET como el que se especifica a continuación.

GET https://api.persat.com.ar/v1/clientobj/obj_id

Path Parameters

Name
Type
Description

obj_id*

Number

Identificador del objeto en cliente

Headers

Name
Type
Description

Authorization*

String

Bearer API_KEY

{
    "success": true,
    "data": {
        "obj_id": 1,
        "name": "Contactos",        
        "fields": [
            {
                "id": 1,
                "name": "Nombre y Apellido",
                "type": "TEXT"
            },
            {
                "id": 2,
                "name": "Puesto",
                "type": "TEXT"
            },
            {
                "id": 3,
                "name": "Telefono",
                "type": "TELEPHONE"
            },
            {
                "id": 4,
                "name": "Email",
                "type": "EMAIL"
            }
        ]
    }
}

Analizando la Respuesta

En caso que no haya ningun error, obtenemos

obj_id: Identificador del Objeto en Cliente

name: Nombre del Objeto en Cliente. Por ej: "Contactos"

fields: Objeto JSON que describe la estructura del Objeto en Cliente. Esas propiedades serian como las columnas de la tabla. Por ejemplo el field "4" sería el email del contacto

circle-info

Los types disponibles para los fields son:

TEXT

NUMBER

TELEPHONE

EMAIL

LINK

Last updated