# 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.

<mark style="color:blue;">`GET`</mark> `https://api.persat.com.ar/v1/clientobj/obj_id`

#### Path Parameters

| Name                                      | Type   | Description                         |
| ----------------------------------------- | ------ | ----------------------------------- |
| obj\_id<mark style="color:red;">\*</mark> | Number | Identificador del objeto en cliente |

#### Headers

| Name                                            | Type   | Description     |
| ----------------------------------------------- | ------ | --------------- |
| Authorization<mark style="color:red;">\*</mark> | String | Bearer API\_KEY |

{% tabs %}
{% tab title="200: OK La consulta se ejecutó con éxito" %}

```json
{
    "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"
            }
        ]
    }
}
```

{% endtab %}

{% tab title="404: Not Found no existe la Master Db con ese identificador" %}

```json
{
    "success": false,
    "error": {
        "status": 404,
        "type": "NOT_FOUND",
        "userMessage": "No existe el obj_id: 456464646546"
    }
}
```

{% endtab %}

{% tab title="400: Bad Request mdb\_id no es un número" %}

```javascript
{
    "success": false,
    "error": {
        "status": 400,
        "type": "BAD_REQUEST",
        "userMessage": "'obj_id' debe ser un number (entero) obligatorio"
    }
}
```

{% endtab %}
{% endtabs %}

### Analizando la Respuesta

En caso que no haya ningun error, obtenemos

```json
{
    "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"
            }
        ]
    }
}
```

**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

{% hint style="info" %}
Los types disponibles para los fields son:

TEXT

NUMBER

TELEPHONE

EMAIL

LINK
{% endhint %}