| Anchor |
|---|
| _Toc341972561 |
|---|
| _Toc341972561 |
|---|
|
Attributes
Attribute | type | values | default | mandate | comment |
category | string |
|
| true |
|
name | string |
|
| true |
|
description | string |
|
| false |
|
options | string |
|
|
|
|
| Anchor |
|---|
| _Toc341972562 |
|---|
| _Toc341972562 |
|---|
|
/ configuration / create
Method:/configuration /create
| Code Block |
|---|
| language | js |
|---|
| title | Parameters |
|---|
|
{
"attrs":
{
"category":"DGS",
"name":"SMS",
"description":"description",
"options":
"{
\"provider\":\"clickatell\",
\"username\":\"john.smith\",
\"password\":\"secret\"
}"
}
} |
| Anchor |
|---|
| _Toc341972563 |
|---|
| _Toc341972563 |
|---|
|
/ configuration / get
| Code Block |
|---|
| language | js |
|---|
| title | Parameters |
|---|
|
{
"match":
[
["category", "=", "DGS"],
["name", "=", "SMS"]
],
"return":["*"]
} |
| Code Block |
|---|
|
{
"error":0
"result":
{
"id": "id",
"category": "DGS",
"name":"SMS",
"description":"description",
"options":
"{
\"provider\":\"clickatell\",
\"username\":\"john.smith\",
\"password\":\"secret\"
}"
}
} |
| Anchor |
|---|
| _Toc341972564 |
|---|
| _Toc341972564 |
|---|
|
/ configuration / search
| Code Block |
|---|
| language | js |
|---|
| title | Parameters |
|---|
|
{
"match":
[
["category", "=", "DGS"],
["name", "=", "SMS"]
],
"return":["*"]
} |
| Code Block |
|---|
|
{
"error":0
"result":
{
"total": 1,
"rows":
[
{
"id": "id",
"category": "DGS",
"name":"SMS",
"description":"description",
"options":
"{
\"provider\":\"clickatell\",
\"username\":\"john.smith\",
\"password\":\"secret\"
}"
}
]
}
} |
| Anchor |
|---|
| _Toc341972565 |
|---|
| _Toc341972565 |
|---|
|
/ configuration / delete
Method:/configuration /delete
| Code Block |
|---|
| language | js |
|---|
| title | Parameters |
|---|
|
{
"id": "configuration object id"
} |
| Anchor |
|---|
| _Toc341972566 |
|---|
| _Toc341972566 |
|---|
|
/ configuration / set
Method:/configuration /set
| Code Block |
|---|
| language | js |
|---|
| title | Parameters |
|---|
|
{
"id": "configuration object id",
"attrs":
{
"category":"DGS",
"name":"SMS",
"description":"description",
"options":
"{
\"provider\":\"clickatell\",
\"username\":\"john.smith\",
\"password\":\"secret\"
}"
}
} |
| Anchor |
|---|
| _Toc341972567 |
|---|
| _Toc341972567 |
|---|
|
/ 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.
| Code Block |
|---|
| language | js |
|---|
| title | Parameters |
|---|
|
{
"attrs":
{
"category":"DGS",
"name":"SMS",
"description":"description",
"options":
"{
\"provider\":\"clickatell\",
\"username\":\"john.smith\",
\"password\":\"secret\"
}"
}
} |