Request Detail:
- URI: api/v9/article/{id}/note
- 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/{id}/note
Parameters:
Name | Guy | Obligatory | Description |
---|---|---|---|
Id | Numerical | Yes | Item Identifier. |
Description | String | Yes | Description of the HTML note. |
DescriptionNoHtml | String | Yes | Description of the note. |
ItemType | String | Yes | Item type. |
Visible | Bool | Yes | true = visible note false = non-visible note. |
Examples of uri:
api/v9/article/1764/note
Body of the petition:
{
"description": "<p>Nota de prueba Artículo</p>",
"descriptionNoHtml": "Nota de prueba",
"itemType": 7,
"visible": true
}
Answer:
The service will return a Json with the following structure:
{
"result": true
}
Error messages:
Code | HTTP status | Error Message |
---|---|---|
500 | InternalServerError | FailureAddNote |