Skip to content

Commit 09d9d5f

Browse files
committed
Merge remote-tracking branch 'origin/master'
2 parents df152a1 + ea4bc1d commit 09d9d5f

File tree

1 file changed

+28
-23
lines changed

1 file changed

+28
-23
lines changed

REST_API_InternalDoc.md

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Subscription: `connectUpdate`
7979
system user information
8080
```json
8181
{
82-
"SystemUsers": [
82+
"systemUsers": [
8383
{"Name": "Dan", "Group": "Yellow", "Token": "", "Password": "", "Certs": "a.zip", "Uid": ""},
8484
{"Name": "Joe", "Group": "Yellow", "Token": "", "Password": "", "Certs": "b.zip", "Uid": ""},
8585
{"Name": "Bill", "Group": "Yellow", "Token": "", "Password": "", "Certs": "c.zip", "Uid": ""}
@@ -98,7 +98,7 @@ Subscription: `connectUpdate`
9898
### parameters
9999
```json
100100
{
101-
"SystemUsers": [
101+
"systemUsers": [
102102
{"Name": "Dan", "Group": "Yellow", "Token": "", "Password": "", "Certs": "true"},
103103
{"Name": "Joe", "Group": "Blue", "Token": "", "Password": "", "Certs": "true"},
104104
{"Name": "Bill", "Group": "Red", "Token": "", "Password": "", "Certs": "true"}
@@ -107,16 +107,17 @@ Subscription: `connectUpdate`
107107
```
108108
## removeSystemUser
109109
### description
110-
remove a system user from the server
110+
remove a system user from the server<br />
111+
Event: `removeSystemUser`
111112
### returns
112113
None
113114
### parameters
114115
```json
115116
{
116-
"SystemUsers": [
117-
{"Uid": "[uid of system user to be deleted]"},
118-
{"Uid": "[uid of system user to be deleted]"},
119-
{"Uid": "[uid of system user to be deleted]"}
117+
"systemUsers": [
118+
{"uid": "[uid of system user to be deleted]"},
119+
{"uid": "[uid of system user to be deleted]"},
120+
{"uid": "[uid of system user to be deleted]"}
120121
]
121122
}
122123
```
@@ -533,29 +534,33 @@ endpoint used to access federation objects
533534
return JSON data containing the following information regarding current checklists and templates present on the server
534535
```json
535536
{
536-
"Name": "federation 1",
537-
"Address": "127.0.0.1",
538-
"Port": "11111",
539-
"FallBack": "federation 2",
540-
"Status": "Disabled",
541-
"ReconnectInterval": "32",
542-
"MaxRetries": "15",
543-
"LastError": "Timeout"
537+
"outgoingFederations":
538+
[{
539+
"Name": "federation 1",
540+
"Address": "127.0.0.1",
541+
"Port": "11111",
542+
"FallBack": "federation 2",
543+
"Status": "Disabled",
544+
"ReconnectInterval": "32",
545+
"MaxRetries": "15",
546+
"LastError": "Timeout"
547+
}]
544548
}
545549
```
546550

547551
### POST
548552
create a new outgoing federation
549553
```json
550554
{
551-
"Name": "federation 1",
552-
"Address": "127.0.0.1",
553-
"Port": "11111",
554-
"FallBack": "federation 2",
555-
"Status": "Disabled",
556-
"ReconnectInterval": "32",
557-
"MaxRetries": "15",
558-
"LastError": "Timeout"
555+
"outgoingFederations":[{
556+
"Name": "federation 1",
557+
"Address": "127.0.0.1",
558+
"Port": "11111",
559+
"FallBack": "federation 2",
560+
"Status": "Disabled",
561+
"ReconnectInterval": "32",
562+
"MaxRetries": "15",
563+
}]
559564
}
560565
```
561566

0 commit comments

Comments
 (0)