Attributes
Attribute | type | values | default | mandate | comment |
category | string | true | |||
name | string | true | |||
description | string | false | |||
options | string |
/ configuration / create
Method:/configuration /create
Parameters
{ "attrs": { "category":"DGS", "name":"SMS", "description":"description", "options": "{ \"provider\":\"clickatell\", \"username\":\"john.smith\", \"password\":\"secret\" }" } }
Response
{ "error":0 }
/ configuration / get
Parameters
{ "match": [ ["category", "=", "DGS"], ["name", "=", "SMS"] ], "return":["*"] }
Response
{ "error":0 "result": { "id": "id", "category": "DGS", "name":"SMS", "description":"description", "options": "{ \"provider\":\"clickatell\", \"username\":\"john.smith\", \"password\":\"secret\" }" } }
/ configuration / search
Parameters
{ "match": [ ["category", "=", "DGS"], ["name", "=", "SMS"] ], "return":["*"] }
Response
{ "error":0 "result": { "total": 1, "rows": [ { "id": "id", "category": "DGS", "name":"SMS", "description":"description", "options": "{ \"provider\":\"clickatell\", \"username\":\"john.smith\", \"password\":\"secret\" }" } ] } }
/ configuration / delete
Method:/configuration /delete
Parameters
{ "id": "configuration object id" }
Response
{ "error":0 }
/ configuration / set
Method:/configuration /set
Parameters
{ "id": "configuration object id", "attrs": { "category":"DGS", "name":"SMS", "description":"description", "options": "{ \"provider\":\"clickatell\", \"username\":\"john.smith\", \"password\":\"secret\" }" } }
Response
{ "error":0 }
/ configuration / update
Method:/configuration /update
This API will create the configuration if it doesn't exist. Or it will update it, if it already exists.
Parameters
{ "attrs": { "category":"DGS", "name":"SMS", "description":"description", "options": "{ \"provider\":\"clickatell\", \"username\":\"john.smith\", \"password\":\"secret\" }" } }
Response
{ "error":0 }