---
title: "Sitio"
source: /es/gcxone/api/site
locale: es
updated: 2026-09-04
---
Operaciones sobre recursos de sitio. 19 puntos finales, cada uno relativo a `https://api.nxgen.cloud/api/v1` y autenticado como se describe en [Authentication](/gcxone/api/authentication).

## GET /site/

obtener Sitio por nombre

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| siteName | query | string | yes | SiteName. |

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Success |  |
| 204 | Sin contenido |  |
| 400 | Entrada inválida |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |

## POST /site/

CREAR UN NUEVO Sitio

### Cuerpo de la solicitud

Agregar un Sitio

```json
{
  "payload": {
    "id": "string",
    "name": "string (required)",
    "email": "string",
    "isActive": "boolean",
    "houseBuildingNumber": "string",
    "streetName": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "code": "string",
    "logo": "string",
    "business": [
      "object"
    ],
    "tags": [
      "object"
    ],
    "photos": [
      "object"
    ],
    "followers": [
      "object"
    ],
    "latitude": "string",
    "longitude": "string",
    "plusCode": "string",
    "what3Words": "string",
    "jsonSchema": "object",
    "countryCode": "string",
    "contactEmail": "string",
    "parentAccountId": "string",
    "customerId": "string",
    "serviceProviderId": "string",
    "parent": "string"
  }
}
```

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito |  |
| 204 | Sin contenido |  |
| 400 | Entrada inválida |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |

## GET /site/arming/info/{id}

Obtener detalle de armado del sitio por siteId

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| id | path | string | sí |  |

### Respuestas

| Estado | Descripción | Body |
| --- | --- | --- |
| 200 | Éxito | object |
| 204 | Sin contenido |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |

Ejemplo `200` respuesta:

```json
{
  "siteArmState": "partiallyArmed",
  "devices": [
    {
      "name": "Embedded Net DVR",
      "id": "4e5147ac173b42c3bd98b986eb9a06dc",
      "armState": "disarmed"
    },
    {
      "name": "Embedded Net DVR",
      "id": "dc7adfd8e57c49b4a7709f8f7da06804",
      "armState": "armed"
    },
    {
      "name": "Embedded Net DVR",
      "id": "c7e5012d9b7d4d3c928d98652510f976",
      "armState": "armed"
    }
  ]
}
```

## GET /site/arming/infoByName

Obtener detalles de armado del sitio por nombre del sitio

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| siteName | consulta | cadena | sí |  |

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito |  |
| 204 | Sin contenido |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |
| 404 | No Encontrado |  |

## PUT /site/arming?siteId={siteId}&action={action}

Actualizar armar/desarmar por siteID

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| siteId | consulta | cadena | sí |  |
| action | consulta | booleano | sí |  |

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito | objeto |
| 204 | Sin contenido |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |
| 404 | No Encontrado |  |

Ejemplo `200` respuesta:

```json
{
  "data": [
    {
      "name": "Embedded Net DVR",
      "result": {
        "errorCode": 0,
        "message": "OK"
      }
    },
    {
      "name": "Embedded Net DVR",
      "result": {
        "errorCode": 0,
        "message": "OK"
      }
    },
    {
      "name": "Embedded Net DVR",
      "result": {
        "errorCode": 0,
        "message": "OK"
      }
    }
  ]
}
```

## PUT /site/arming?siteName={siteName}&action={action}

Actualizar Armar/Desarmar por siteName

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| siteName | consulta | cadena | sí |  |
| acción | consulta | booleano | sí |  |

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito |  |
| 204 | Sin contenido |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |
| 404 | No Encontrado |  |

## POST /site/filter

Obtiene la lista de sitios con filtrado, ordenación y paginación. Permite la búsqueda por nivel jerárquico. Puede filtrarse usando la jerarquía especificada o utiliza la jerarquía del usuario autenticado. Esto brinda la opción de obtener campos de entidad adicionales en la respuesta. También proporciona metadatos de configuración sobre la entidad.

### Cuerpo de la Solicitud

Filtrado y ordenación de sitios

```json
{
  "filters": [
    {
      "columnName": "string (required)",
      "type": "distinctList | date | number | StringConditionFilter (required)",
      "filter": "object (required)"
    }
  ],
  "sortOrder": [
    {
      "columnName": "string",
      "isAscending": "boolean"
    }
  ],
  "primaryColumns": [
    "string"
  ],
  "hierarchyLevel": "string",
  "hierarchyId": "string",
  "nPerPage": "number",
  "pageNumber": "number",
  "isConfigDetailRequired": "boolean",
  "getConfig": "boolean",
  "getChildOrParent": "boolean"
}
```

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito | objeto |
| 204 | Sin contenido |  |
| 400 | Entrada inválida |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |

Ejemplo `200` respuesta:

```json
{
  "config": {
    "columns": [
      {
        "visibility": true,
        "columnName": "commercialName",
        "DisplayName": "Site",
        "isFilterable": true,
        "filterType": "stringCondition",
        "sticky": true,
        "isRightBorder": true,
        "isMandatory": true,
        "isNotDraggable": true
      }
    ],
    "defaultNPerPage": 50,
    "defaultFilterCondition": [],
    "defaultSortingOrder": [
      {
        "columnName": "dateTime",
        "isAscending": false
      }
    ],
    "maxVisibleColumnCount": 6,
    "exportLimitNPerPage": 500
  },
  "dataResult": [
    {
      "name": "Site test",
      "dateTime": 1655213317621,
      "uniqueId": "c772ac8dd22f4a9a8849c332afe3f188",
      "parentAccountId": "d76dfac772ac8dcb7db87a6c772ac8d",
      "country": "",
      "streetName": "",
      "state": "",
      "isActive": "true",
      "customerName": "Customer TEST"
    },
    {
      "name": "Site test 2",
      "dateTime": 1648447044408,
      "uniqueId": "a9dc0ac94dfd4297b8241cb7db87a65e",
      "parentAccountId": "d76dfac772ac8dcb7db87a6c772ac8d",
      "country": "",
      "streetName": "",
      "state": "",
      "isActive": "true",
      "customerName": "Customer TEST"
    }
  ],
  "totalRecordsCount": 3552,
  "filteredBy": [],
  "sortedBy": [
    {
      "columnName": "dateTime",
      "isAscending": false
    }
  ],
  "dispatchedAll": false,
  "isDefaultProjectionMutated": false,
  "isDefaultFilterMutated": false,
  "isDefaultSortingMutated": false
}
```

## GET /site/id/{id}/app

Obtiene información del sitio por Id. del sitio para la aplicación

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| id | ruta | cadena | sí |  |

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito | objeto |
| 204 | Sin contenido |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |
| 404 | No Encontrado |  |

Ejemplo `200` respuesta:

```json
{
  "data": {
    "id": "rtyt67457474dfa6c3567567cd94b7aa3ee",
    "name": "Test",
    "address": {
      "location": {
        "latitude": "",
        "longitude": "",
        "plusCode": " ",
        "what3Words": " "
      },
      "contact": {
        "countryCode": "",
        "phoneNumber": ""
      },
      "houseBuildingNumber": "",
      "streetName": "",
      "city": "",
      "state": "",
      "code": "",
      "country": ""
    },
    "deviceCount": 1,
    "totalSensor": 9,
    "cameraCount": 9,
    "alarmCountInLast24hr": 15,
    "alarmCountbetween24to48hr": 18,
    "IOCount": 0,
    "otherSensorCount": 0
  },
  "isSuccess": true
}
```

## PUT /site/isolate?siteId={siteId}&enable={enable}

Obtener lista de usuarios bajo el sitio

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| siteId | consulta | cadena | sí |  |
| enable | consulta | booleano | sí |  |
| isolateStartTime | consulta | número | no |  |
| duración | consulta | número | no |  |

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito |  |
| 204 | Sin contenido |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |
| 404 | No Encontrado |  |

## PUT /site/isolate?siteName={siteName}&enable={enable}

Actualizar aislamiento por sitio

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| siteName | consulta | cadena | sí |  |
| enable | consulta | booleano | sí |  |
| isolateStartTime | consulta | número | no |  |
| duración | consulta | número | no |  |

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito |  |
| 204 | Sin contenido |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |
| 404 | No Encontrado |  |

## GET /site/isolation/infoByName

Obtener detalles de armado del sitio por nombre del sitio

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| siteName | consulta | cadena | sí |  |

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito |  |
| 204 | Sin contenido |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |
| 404 | No Encontrado |  |

## POST /site/listByCustomerIds

Obtener sitios por lista de Identificación del cliente

### Cuerpo de la Solicitud

Obtener sitios

```json
{
  "customerIds": [
    "string"
  ]
}
```

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito | objeto |
| 204 | Sin contenido |  |
| 400 | Entrada inválida |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |

Ejemplo `200` respuesta:

```json
{
  "data": [
    {
      "key": "7f01237864567eba89736f825",
      "label": "site name",
      "customerName": "customer name"
    }
  ]
}
```

## GET /site/presetPTZ

PTZ / Preset basado en Nombre del Sitio

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| siteName | query | string | sí |  |
| action | query | "R" \| "R\_STOP" \| "L" \| "L\_STOP" \| "U" \| "U\_STOP" \| "D" \| "D\_STOP" \| "Z+" \| "Z+\_STOP" \| "1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" | sí | Seleccione cualquier valor del 1 al 10 para preset, los demás para PTZ |
| Tipo de comando | consulta | "ptz" \| "preset" | sí |  |
| PuertoWebSocket | consulta | cadena | no | requerido para el tipo de dispositivo heitel |
| VelocidadMomento | consulta | cadena | no | Velocidad PTZ |

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito |  |
| 204 | Sin contenido |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |
| 404 | No Encontrado |  |

## POST /site/search

Buscar sitios para la aplicación

### Cuerpo de la Solicitud

Buscar sitios

```json
{
  "payload": {
    "skip": "number (required)",
    "limit": "number (required)",
    "siteName": "string"
  }
}
```

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito | objeto |
| 401 | No autorizado |  |

Ejemplo `200` respuesta:

```json
{
  "data": [
    {
      "siteName": "Site A",
      "siteId": "l8c90c0f62c64d16751acc5ea13082y",
      "deviceCount": 0,
      "alarmCount": 0
    },
    {
      "siteName": "Site B",
      "siteId": "u8b51c17cb474c2a6757273d193303cb",
      "deviceCount": 1,
      "alarmCount": 0
    }
  ],
  "isSuccess": true
}
```

## GET /site/{id}

Obtener por Id. del sitio

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| id | path | string | sí |  |

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito |  |
| 204 | Sin contenido |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |
| 404 | No Encontrado |  |

## PUT /site/{id}

Actualizar un sitio existente

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| id | path | string | sí |  |

### Cuerpo de la Solicitud

```json
{
  "payload": {
    "id": "string",
    "uniqueId": "string",
    "name": "string (required)",
    "profile": {
      "logo": "string",
      "business": [
        "object"
      ],
      "photos": [
        "object"
      ],
      "tags": [
        "object"
      ],
      "followers": [
        "object"
      ],
      "s3ImagePath": "string"
    },
    "address": {
      "houseBuildingNumber": "string",
      "streetName": "string",
      "city": "string",
      "state": "string",
      "code": "string",
      "country": "string",
      "location": {
        "latitude": "string",
        "longitude": "string",
        "plusCode": "string",
        "what3Words": "string"
      },
      "contact": {
        "countryCode": "string",
        "phoneNumber": "string"
      }
    },
    "email": "string",
    "parentAccountId": "string",
    "isActive": "boolean",
    "jsonSchema": "object",
    "parentEventProviderId": "string",
    "masterEventProviderId": "string",
    "serviceProviderId": "string",
    "customerId": "string",
    "groupParent": "string",
    "description": "string",
    "syncStatus": "boolean"
  }
}
```

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito |  |
| 204 | Sin contenido |  |
| 400 | Entrada inválida |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |

## DELETE /site/{id}

Eliminar un Sitio por Id

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| id | ruta | cadena | sí |  |

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito |  |
| 204 | Sin contenido |  |
| 400 | Entrada inválida |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |

## GET /site/{id}/devices

Obtener lista de dispositivos bajo el sitio

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| id | ruta | string | sí |  |

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito |  |
| 204 | Sin contenido |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |
| 404 | No Encontrado |  |

## GET /site/{id}/users

Obtener lista de usuarios bajo el sitio

### Parámetros

| Nombre | En | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- | --- |
| id | ruta | cadena | sí |  |

### Respuestas

| Estado | Descripción | Cuerpo |
| --- | --- | --- |
| 200 | Éxito |  |
| 204 | Sin contenido |  |
| 401 | No autorizado |  |
| 403 | Prohibido |  |
| 404 | No Encontrado |  |