EN
Español
English
Português
    List additional fields by case type, status, model, and case ID

    Request Detail:

    • Base URL: {host}/ASMSAPI/
    • URI: api/v9/article/list
    • Type: POST

    • Required headings:

    • Content-Type: application/json
    • X-Authorization: Bearer {token}

    URL Description

    • {host}: It represents the domain of the environment in which the API is located.
    • ASMSAPI/: Fixed API prefix.
    • URI: Specific endpoint for the request.


    ⚐ EXAMPLE URL:

    https://{host}/ASMSAPI/api/v9/article/list


    Parameters:

    Name Guy Obligatory Description
    ConsoleType String Yes Console Type - Specialist = 1, - Client = 2, - Administrator - 3.
    isPublic Boolean No Indicate whether the search is for public or private items.
    Models Object No Object with the types of items to be listed.
    Id Whole No Item type identifier.
    projects Object Yes Object with the projects to be listed.
    Id Whole Yes Project ID.
    categories (Folder) Object No Object with the folders to be listed (Only required for specialist and client console when the model parameter has value).
    Id Whole No Identifier of the folders.
    repository String Yes Indicates whether it searches open or all. - Open = 1 - Closed = 2 - All =3
    search String Yes Search string.
    pageIndex Whole Yes Identifier of the page you list.
    pageSize Whole Yes Number of records in the list.
    orderField String Yes Field by which to order.
    orderType String Yes Ordering: - Desc - Asc
    •Asc.      


    Examples of uri:

    api/v9/article/list

    Body of the petition:

    {
    "consoleType": 1,
    "categories": [
        {
            "id": 1
        }
    ],
    "models": [
        {
            "id": 12
        }
    ],
    "projects": [
        {
            "id": 4
        }
    ],
    "repository": 3,
    "pageIndex": 0,
    "pageSize": 15,
    "orderField": "openedDate",
    "orderType": "Desc",
    "search": "",
    "isPublic": 0
}

    Answer:

    The service will return a Json with the following structure:

    {
    "content": [
        {
            "autorId": null,
            "classId": null,
            "content": "",
            "createdDate": 1696443888080,
            "description": "Nisi eos molestiae est neque assumenda neque nisi.",
            "groupId": null,
            "hitTotal": null,
            "id": 46,
            "identifier": "Quis vero amet.",
            "interfaceId": null,
            "isFavorite": false,
            "isPublic": false,
            "keyword": "",
            "modifiedDate": 1696443888080,
            "modifierId": null,
            "openedDate": 1696443888080,
            "projectId": null,
            "public": 0,
            "ratingTotal": 0,
            "reasonId": null,
            "reasonName": null,
            "responsibleId": 1,
            "stateId": 174,
            "stateName": "Diseño",
            "stringStateColor": "139.78.168",
            "title": "Est exercitationem fuga nobis tempore aut.",
            "typeId": 12,
            "typeName": "Errores Conocidos",
            "url": ""
        },
        {
            "autorId": null,
            "classId": null,
            "content": "",
            "createdDate": 1696439222233,
            "description": "Inventore quasi delectus nulla sed iure nesciunt eaque distinctio.",
            "groupId": null,
            "hitTotal": null,
            "id": 44,
            "identifier": "Et quo ipsum recusandae.",
            "interfaceId": null,
            "isFavorite": false,
            "isPublic": false,
            "keyword": "",
            "modifiedDate": 1696439222233,
            "modifierId": null,
            "openedDate": 1696439222233,
            "projectId": null,
            "public": 0,
            "ratingTotal": 0,
            "reasonId": null,
            "reasonName": null,
            "responsibleId": 1,
            "stateId": 174,
            "stateName": "Diseño",
            "stringStateColor": "139.78.168",
            "title": "Sed iusto nemo quidem sint dolor distinctio cum vitae officiis.",
            "typeId": 12,
            "typeName": "Errores Conocidos",
            "url": ""
        },
        {
            "autorId": null,
            "classId": null,
            "content": "",
            "createdDate": 1695128891753,
            "description": "Consectetur eveniet dolores voluptatem.",
            "groupId": null,
            "hitTotal": null,
            "id": 43,
            "identifier": "Quod sunt vel quibusdam suscipit minima nulla corporis doloribus ea.",
            "interfaceId": null,
            "isFavorite": false,
            "isPublic": false,
            "keyword": "",
            "modifiedDate": 1695128891753,
            "modifierId": null,
            "openedDate": 1695128891753,
            "projectId": null,
            "public": 0,
            "ratingTotal": 0,
            "reasonId": null,
            "reasonName": null,
            "responsibleId": 1,
            "stateId": 174,
            "stateName": "Diseño",
            "stringStateColor": "139.78.168",
            "title": "Eaque quos sequi.",
            "typeId": 12,
            "typeName": "Errores Conocidos",
            "url": ""
        },
        {
            "autorId": null,
            "classId": null,
            "content": "",
            "createdDate": 1695128558867,
            "description": "Voluptate odio provident placeat et omnis saepe.",
            "groupId": null,
            "hitTotal": null,
            "id": 42,
            "identifier": "Qui totam neque esse enim incidunt optio.",
            "interfaceId": null,
            "isFavorite": false,
            "isPublic": false,
            "keyword": "",
            "modifiedDate": 1695128558867,
            "modifierId": null,
            "openedDate": 1695128558867,
            "projectId": null,
            "public": 0,
            "ratingTotal": 0,
            "reasonId": null,
            "reasonName": null,
            "responsibleId": 1,
            "stateId": 174,
            "stateName": "Diseño",
            "stringStateColor": "139.78.168",
            "title": "Sit est qui nam minima.",
            "typeId": 12,
            "typeName": "Errores Conocidos",
            "url": ""
        },
        {
            "autorId": null,
            "classId": null,
            "content": "",
            "createdDate": 1693847348663,
            "description": "Officia ducimus provident sint a.",
            "groupId": null,
            "hitTotal": null,
            "id": 40,
            "identifier": "Dignissimos accusamus magni iste.",
            "interfaceId": null,
            "isFavorite": false,
            "isPublic": false,
            "keyword": "",
            "modifiedDate": 1693847348663,
            "modifierId": null,
            "openedDate": 1693847348663,
            "projectId": null,
            "public": 0,
            "ratingTotal": 0,
            "reasonId": null,
            "reasonName": null,
            "responsibleId": 1,
            "stateId": 174,
            "stateName": "Diseño",
            "stringStateColor": "139.78.168",
            "title": "Voluptates aliquid quisquam sed voluptate ipsam omnis eveniet quia.",
            "typeId": 12,
            "typeName": "Errores Conocidos",
            "url": ""
        },
        {
            "autorId": null,
            "classId": null,
            "content": "",
            "createdDate": 1693845486933,
            "description": "Nulla illum ipsa vel iure tempora vitae cupiditate vel recusandae.",
            "groupId": null,
            "hitTotal": null,
            "id": 37,
            "identifier": "Harum sit rem.",
            "interfaceId": null,
            "isFavorite": false,
            "isPublic": false,
            "keyword": "",
            "modifiedDate": 1693845486933,
            "modifierId": null,
            "openedDate": 1693845486933,
            "projectId": null,
            "public": 0,
            "ratingTotal": 0,
            "reasonId": null,
            "reasonName": null,
            "responsibleId": 1,
            "stateId": 174,
            "stateName": "Diseño",
            "stringStateColor": "139.78.168",
            "title": "Mollitia aliquam nostrum dolor hic qui quo aspernatur.",
            "typeId": 12,
            "typeName": "Errores Conocidos",
            "url": ""
        }
    ],
    "totalItems": 6,
    "totalPage": 6
}

    Error messages:

    Code HTTP status Error Message
    400 BadRequest \r\nParameter name: request
    400 BadRequest \r\nParameter name: consoleType
    400 BadRequest \r\nParameter name: repository
    400 BadRequest CategoryIdIsRequired
    500 InternalServerError FailureGetList