ES
Español
English
Português
    Búsqueda

    Recupera una lista de registros de Articulos de la CMDB según los criterios de búsqueda agregados en la consulta.

    Detalle de la petición:

    • URI: /api/kb/article/list/
    • Tipo: POST
    • Encabezados requeridos:
      • UrlAsms {host}
      • Content-Type: application/json
      • TokenAsms: Bearer {token}

    Parámetros de identificador URI

    https://{host}/api/kb/article/list/

    Identificador Tipo Obligatorio Descripción
    host string SI Representa el dominio del ambiente en el que se encuentra la API

    Cuerpo de la petición:

    
    {
      "folderId": 0,
      "projectId": 0,
      "search": "string",
      "typeId": 0
    }
    
    

    Donde:

    Nombre Identificador Tipo Descripción
    Category ID folderId integer Categoría
    Type ID typeId integer Tipo de articulo
    Project ID projectId integer Identificador del proyecto
    Search Criteria search string Criterios de búsqueda

    Respuesta:

    
    [
        {
        "attachments": [
            {
            "id": 0,
            "name": ""
            }
        ],
        "classId": 0,
        "content": "",
        "createdDate": "DateTime ISO 8601",
        "description": "",
        "id": 0,
        "identifier": "",
        "keyword": "",
        "lastModifiedDate": "DateTime ISO 8601",
        "title": "",
        "type": {
            "id": 0,
            "name": ""
        },
        "url": ""
        }
    ]
    

    Donde:

    Nombre Identificador Tipo Descripción
    Attachments article attachments array Archivos adjuntos.
    Class id classId integer Representa la clase que pertenece el artículo;
    * Interno(0)
    * Externo(1).
    Content content string Contenido del artículo.
    Created date createdDate date-time Fecha de creación, formato ISO-8601.
    Description description string Descripción del artículo.
    Article id id integer Identificador del sistema para el artículo.
    Article identifier identifier integer Identificador del artículo.
    Article keyword keyword string Palabras claves del artículo.
    Modified date lastModifiedDate date-time Última fecha de modificación, formato ISO-8601.
    Title title string Título del artículo.
    Type type object Objeto que representa al tipo del artículo.