GCXONEDocumentación

Blog

En esta página
  1. POST /blog
  2. Cuerpo de la solicitud
  3. Respuestas
  4. POST /blog/filter
  5. Cuerpo de la solicitud
  6. Respuestas
  7. GET /blog/{id}
  8. Parámetros
  9. Respuestas
  10. PUT /blog/{id}
  11. Parámetros
  12. Cuerpo de la solicitud
  13. Respuestas
  14. PATCH /blog/{id}
  15. Parámetros
  16. Cuerpo de la solicitud
  17. Respuestas
  18. DELETE /blog/{id}
  19. Parámetros
  20. Respuestas

Operaciones sobre recursos de blog. 6 puntos finales, cada uno relativo a https://api.nxgen.cloud/api/v1 y autenticado según lo descrito en Autenticación.

POST /blog

Añadir un nuevo blog a un nivel jerárquico específico

Cuerpo de la solicitud

Añadir Blog

json
{
  "title": "string (required)",
  "description": "string",
  "content": "string",
  "accessLevel": "string (required)",
  "entityId": "string (required)",
  "thumbnail": "string",
  "jsonSchemaResult": "object",
  "isAccessRestricted": "boolean"
}

Respuestas

Estado

Descripción

Cuerpo

200

Éxito

400

Entrada inválida

401

No autorizado

403

Prohibido

Ejemplo 200 respuesta:

json
{
  "_id": "62ea2a8328c7c9",
  "uniqueId": "afd49a39338dc",
  "accessLevel": "site",
  "createdBy": "developer-1@dev.de",
  "createdOn": 1659513475763,
  "title": "new blog",
  "description": "desc",
  "content": "<p>test content</p>",
  "isAccessRestricted": true,
  "jsonSchemaResult": {},
  "thumbnail": "",
  "serviceProviderId": "",
  "customerId": "",
  "siteId": ""
}

POST /blog/filter

Obtiene la lista de blogs con filtrado, ordenación y paginación. Permite búsquedas por nivel jerárquico. Puede filtrarse usando la jerarquía especificada o utiliza la jerarquía del usuario conectado. 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 blogs

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
{
  "dataResult": [
    {
      "_id": "62d76c65104ef771f6a11f0c",
      "uniqueId": "62d76c65104ef771f6a11f0cas1209ji",
      "title": "Blog 1",
      "description": "description 1",
      "accessLevel": "serviceprovider",
      "isPublished": true,
      "publishedOn": 1658285307,
      "createdBy": "developer-1@dev.de",
      "createdOn": 1658285307,
      "modifiedBy": "",
      "modifiedOn": 1658285307
    },
    {
      "_id": "62d76f78104ef771f6a11f0e",
      "uniqueId": "156c67kiokio04ef771f6a11f0cas1209ji",
      "title": "Blog 2",
      "description": "description 2",
      "accessLevel": "serviceprovider",
      "isPublished": true,
      "publishedOn": 1658285307,
      "createdBy": "developer-1@dev.de",
      "createdOn": 1658285307,
      "modifiedBy": "",
      "modifiedOn": 1658285307
    }
  ],
  "totalRecordsCount": 15
}

GET /blog/{id}

Obtener blog por Id

Parámetros

Nombre

En

Tipo

Obligatorio

Descripción

id

ruta

cadena

Respuestas

Estado

Descripción

Cuerpo

200

Éxito

400

Entrada inválida

401

No autorizado

403

Prohibido

404

No Encontrado

Ejemplo 200 respuesta:

json
{
  "_id": "62ea2a8328c7c9",
  "uniqueId": "afd49a39338dc",
  "accessLevel": "site",
  "createdBy": "developer-1@dev.de",
  "createdOn": 1659513475763,
  "modifiedBy": "developer-1@dev.de",
  "modifiedOn": 1659514047995,
  "title": "new blog",
  "description": "desc",
  "content": "<p>test content</p>",
  "isAccessRestricted": true,
  "jsonSchemaResult": {},
  "thumbnail": "",
  "serviceProviderId": "",
  "customerId": "",
  "siteId": ""
}

PUT /blog/{id}

Actualizar un blog existente

Parámetros

Nombre

En

Tipo

Obligatorio

Descripción

id

path

string

Cuerpo de la solicitud

Para actualizar un blog, proporcione el Id existente

json
{
  "title": "string",
  "description": "string",
  "content": "string",
  "thumbnail": "string",
  "jsonSchemaResult": "object",
  "isAccessRestricted": "boolean"
}

Respuestas

Estado

Descripción

Cuerpo

200

Éxito

400

Entrada inválida

401

No autorizado

403

Prohibido

404

No Encontrado

Ejemplo 200 respuesta:

json
{
  "_id": "62ea2a8328c7c9",
  "uniqueId": "afd49a39338dc",
  "accessLevel": "site",
  "createdBy": "developer-1@dev.de",
  "createdOn": 1659513475763,
  "modifiedBy": "developer-1@dev.de",
  "modifiedOn": 1659514047995,
  "title": "new blog",
  "description": "desc",
  "content": "<p>test content</p>",
  "isAccessRestricted": true,
  "jsonSchemaResult": {},
  "thumbnail": "",
  "serviceProviderId": "",
  "customerId": "",
  "siteId": ""
}

PATCH /blog/{id}

Patch para publicar el blog

Parámetros

Nombre

En

Tipo

Obligatorio

Descripción

id

path

string

Cuerpo de la solicitud

Publicar el blog

json
{
  "isPublished": "boolean"
}

Respuestas

Estado

Descripción

Cuerpo

200

Éxito

401

No autorizado

403

Prohibido

404

No Encontrado

Ejemplo 200 respuesta:

json
{
  "isSuccess": true
}

DELETE /blog/{id}

Eliminar un blog por Id

Parámetros

Nombre

En

Tipo

Obligatorio

Descripción

id

path

cadena

Respuestas

Estado

Descripción

Cuerpo

200

Éxito

401

No autorizado

403

Prohibido

404

No Encontrado

Ejemplo 200 respuesta:

json
{
  "isSuccess": true
}
¿Le ha resultado útil esta página?

Gracias — sus comentarios llegan al equipo responsable de esta página.