Request Detail:
- Base URL: {host}/ASMSAPI/
- URI: api/v9/article
- 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
Parameters:
Name | Guy | Obligatory | Description |
---|---|---|---|
ConsoleType | String | Yes | Type of console. |
ListAdditionalField | String | Yes | List additional fields. |
ModelId | Numerical | Yes | Model identifier. |
ModelName | String | Yes | Model name. |
AuthorId | Numerical | Yes | Author’s identifier. |
Content | Content | Yes | Body of the article. |
Created | DateTime | Yes | Date of creation. |
Description | String | Yes | Item description. |
GroupId | Numerical | Yes | Group identifier. |
HitTotal | Numerical | Yes | Total grades. |
TempItemId | Numerical | Yes | Temporary identifier of the article, this must be negative. |
InterfaceId | String | Yes | Interface identifier. |
IsPublic | Boolean | Yes | Access indicator. |
Keyword | String | Yes | Keyword. |
LastModified | DateTime | Yes | Last modified date. |
ModifierId | Numerical | Yes | Modifier identifier. |
ProjectId | Numerical | Yes | Project ID. |
Public | Numerical | Yes | Public. |
RatingTotal | Doublé | Yes | Total rating. |
ReasonId | Numerical | Yes | Identifier of the reason. |
ReasonName | String | Yes | Name of the reason. |
ResponsibleId | Numerical | Yes | Identifier of the person responsible. |
StateId | Numerical | Yes | State identifier. |
StateName | String | Yes | Name of the state. |
StrId | String | Yes | Item identifier. |
StringStateColor | String | Yes | Color of the state. |
Title | String | Yes | Title of the article. |
URL | String | Yes | URL. |
Examples of uri:
api/v9/article
Body of the petition:
{
"autorId": 1,
"classId": 0,
"consoleType": 3,
"content": "Contenido del artículo",
"description": "Descripción artículo",
"groupId": 6,
"hitTotal": 0,
"tempItemId": -1,
"interfaceId": null,
"isPublic": true,
"keyword": "prueba",
"lastModified": null,
"typeId": 12,
"modelId": 12,
"modelName": "",
"modifierId": 1,
"projectId": 4,
"public": 1,
"ratingTotal": 0,
"reasonId": null,
"reasonName": "",
"responsibleId": 1,
"stateId": 174,
"stateName": "",
"strId": "1234",
"stringStatusColor": "",
"title": "Titulo artículo",
"identifier": "Identificador artículo",
"ListAdditionalField": [
{
"BoolValue": null,
"CatalogId": null,
"Description": null,
"Enable": false,
"FieldId": 3604,
"FloatValue": null,
"ItemId": null,
"Identifier": null,
"Mandatory": true,
"Name": "CAMPO 3",
"Order": null,
"Visible": false,
"FieldType": 3,
"StringValue": "Valor 2",
"IntValue": 1089,
"DateValue": null
},
{
"BoolValue": null,
"CatalogId": null,
"Description": null,
"Enable": false,
"FieldId": 3496,
"FloatValue": null,
"ItemId": null,
"Identifier": null,
"Mandatory": false,
"Name": "CAMPO 1",
"Order": null,
"Visible": false,
"FieldType": 1,
"StringValue": "texto 1",
"IntValue": null,
"DateValue": null
},
{
"BoolValue": false,
"CatalogId": null,
"Description": null,
"Enable": false,
"FieldId": 3603,
"FloatValue": null,
"ItemId": null,
"Identifier": null,
"Mandatory": false,
"Name": "CAMPO 2",
"Order": null,
"Visible": false,
"FieldType": 2,
"StringValue": null,
"IntValue": null,
"DateValue": "/Date(1499400000000)/"
},
{
"BoolValue": false,
"CatalogId": null,
"Description": null,
"Enable": false,
"FieldId": 5962,
"FloatValue": null,
"ItemId": null,
"Identifier": null,
"Mandatory": false,
"Name": "ff",
"Order": null,
"Visible": false,
"FieldType": 10,
"StringValue": null,
"IntValue": null,
"DateValue": null
}
]
}
Answer:
The service will return a Json with the following structure:
{
"id": 44
}
Error messages:
Code | HTTP status | Error Message |
---|---|---|
500 | InternalServerError | FailureAddArticle |