top of page

Kiwire 3.0 API Documentation      >        Controller  

Kiwire 3.0 API Documentation - Controller

 

Create

Use POST method to create new subordinate resources.

​

Example request URIs

[POST] https://{{kiwire_ip}}/api/controller/

 

Parameters Required

API 19.png

PATCH

Use PATCH method is to make a partial update on a resource. 

​

The differences between PATCH and PUT, PUT method also modify a resource entity but PATCH method is used for partially updating an existing resource. PUT should be used if you are entirety replacing a resource.

 

Example request URIs

[PATCH] https://{{kiwire_ip}}/api/controller/{{id}}/

Parameters Required

API 20.png

delete

​

Use DELETE method as the name applies to delete resources.

​

Example request URIs

[DELETE] https://{{kiwire_ip}}/api/controller/{{id}}/

​

get

Use GET method to retrieve resource information only and not to modify it in any way.

​

Example request URIs

​

[GET] https://{{kiwire_ip}}/api/controller/

[GET] https://{{kiwire_ip}}/api/controller/{{id}}/

[GET] https://{{kiwire_ip}}/api/controller/{{offset}}/{{limit}}/{{column}}/{{order}}/

API 21.png

NOTE:

​

For GET method, if {{offset}}, {{limit}}, {{column}}, and {{order}} not provided then

Kiwire will return default value eg :

​

https://{{kiwire_ip}}/api/controller/0/10/id/desc/

bottom of page