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

Example

GET /article
Response

List of article objects.

Method
GET
URL
/article
Authentication
Token
Response
List of Article

Get an article

Get a specific article by ID or UUID

Example

GET /article/2039077
Response

An article object.

Method
GET
URL
/article/:id
Authentication
Token
Response
Article object

Create an article

Create an article. The article will be assigned a server-generated ID and UUID.

Example

POST /article
{
	"articleNo": "123",
	"description": "Large flowerpot"
}
Response

The created article object.

Method
POST
URL
/article
Authentication
Token
Request
Article object
Response
Article object

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