Article
The Article object
Example
Get articles
Get all articles
Query Parameters
inactive | If supplied, inactive articles will be included | ||
limit | Limit the number of returned objects | Integer | |
offset | Skip the first N objects | Integer | |
modified | Include only objects modified since this date/timestamp | Timestamp | 2015-10-05 |
- Method
- GET
- URL
- /article
- Authentication
- Token
- Response
- List of Article
Search articles
Search articles. Please note that the search representation contains only a subset of the detail and list representations.
Query Parameters
q |
Search query. Required.
The default search behavior is an ElasticSearch query, each search term ORed, with some fields boosted.
|
||
inactive | If supplied, inactive articles will be included |
Example
GET /article/search?q=service Content-type: application/json
- Method
- GET
- URL
- /article/search
- Authentication
- Token
- Response
- ArticleSearchEntry object
Get an article
Create an article
Update or create an article
Update an existing article or create it (if it doesn't exist and :id is a UUID).
Example
PUT /article/0847ed17-b060-4599-a38c-be9a8b9cbb34
{ "articleNo": "123", "description": "Large flowerpot" }
Response
The updated article object.
- Method
- PUT
- URL
- /article/:id
- Authentication
- Token
- Request
- Article object
- Response
- Article object
Delete an article
Delete an article.
Example
DELETE /article/0847ed17-b060-4599-a38c-be9a8b9cbb34
- Method
- DELETE
- URL
- /article/:id
- Authentication
- Token
- Response
- Status code only