-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtrees.json
More file actions
238 lines (238 loc) · 9.7 KB
/
trees.json
File metadata and controls
238 lines (238 loc) · 9.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
{
"title": "Tree",
"category": "derived",
"docpath": "trees",
"introduction": [
"Trees present the entire chart of <a class=\"link\" href=\"/documentation/accounts\">Accounts</a> of an <a class=\"link\" href=\"\\documentation\\entities\">Entity</a>. in a single hierarchical object. ",
"Each Account is nested under its parent, and in turn lists all its children, all providing <a class=\"link\" href=\"/documentation/accounts/balance\">Balances</a> and <a class=\"link\" href=\"/documentation/accounts/recursive_balance\">Recursive Balances</a>.",
"Trees are trimmed for permissions. If the user requesting the tree only has read access to a subset of Accounts, they will only receive a tree containing those accounts, with placeholder objects filling the place of Accounts they are not permitted to read.",
"Each Account in the Tree is presented as a <a class=\"link\" href=\"/documentation/trees/node\">Tree Node</a>."
],
"object": {
"name": "Tree",
"exposition": "Tree objects are returned with the following structure",
"form": {
"root": "object",
"components": [
{
"key": {
"value": "\"entity_id\"",
"mono": true
},
"type": {
"value": "JSON String",
"mono": false
},
"description": {
"value": "The identifer of the <a class=\"link\" href=\"\\documentation\\entities\">Entity</a> this Tree describes",
"mono": false
},
"example": {
"value": "\"oB3cjSNKXklkJ4Tb\"",
"mono": true
}
},
{
"key": {
"value": "\"balance_time\"",
"mono": true
},
"type": {
"value": "JSON String",
"mono": false
},
"description": {
"value": "Time of the Tree balance, in the format YYYY-MM-DD_HH24:MI:SS.US, in UTC.",
"mono": false
},
"example": {
"value": "\"2017-01-01_17:22:16.40288\"",
"mono": true
}
},
{
"key": {
"value": "\"generated_time\"",
"mono": true
},
"type": {
"value": "JSON String",
"mono": false
},
"description": {
"value": "Time that this Balance was computed, in the format YYYY-MM-DD_HH24:MI:SS.US, in UTC",
"mono": false
},
"example": {
"value": "\"2018-05-02_05:01:54.72941\"",
"mono": true
}
},
{
"key": {
"value": "\"global_unit_denomination\"",
"mono": true
},
"description": {
"value": "The id of the global unit in which this Tree Balance is denominated, if applicable",
"mono": false
},
"type": {
"value": "JSON Number or JSON Null",
"mono": false
},
"example": {
"value": "5",
"mono": true
}
},
{
"key": {
"value": "\"custom_unit_denomination\"",
"mono": true
},
"description": {
"value": "The id of the custom unit in which this Tree is denominated, if applicable.",
"mono": false
},
"type": {
"value": "JSON Number or JSON Null",
"mono": false
},
"example": {
"value": "null",
"mono": true
}
},
{
"key" :{
"value": "\"tree\"",
"mono": true
},
"description": {
"value": "A list of <a class=\"link\" href=\"/documentation/trees/node\">Tree Node</a> objects",
"mono": false
},
"type": {
"value": "JSON Array",
"mono": false
},
"list objects": {
"value": "Tree Node",
"mono": false,
"link": "/documentation/trees/node"
},
"example": {
"value": "See <a href=\"/documentation/trees/node\" class=\"link\">Tree Nodes</a>",
"mono": false
}
}
]
}
},
"actions": [
{
"name": "Retrieve",
"method": "GET",
"path": "/trees",
"description": "Retrieve a Tree",
"return_root_type": "JSON Object",
"required_json_data": {
"root": "object",
"components": [
{
"key": {
"value": "\"balance_time\"",
"mono": true
},
"type": {
"value": "JSON String or JSON Null",
"mono": false
},
"description": {
"value": "Time of the Tree balance, in the format YYYY-MM-DD_HH24:MI:SS.US, in UTC. Specify null for balance at request time.",
"mono": false
},
"example": {
"value": "\"2017-01-01_17:22:16.40288\"",
"mono": true
}
},
{
"key": {
"value": "\"global_unit_denomination\"",
"mono": true
},
"description": {
"value": "The id of the global unit denomination in which you would like to view the Tree. Specify either global or custom unit denomination.",
"mono": false
},
"type": {
"value": "JSON Number or JSON Null",
"mono": false
},
"example": {
"value": "5",
"mono": true
},
"source": {
"value": "/units/list",
"mono": false,
"link": "/documentation/unit_list"
}
},
{
"key": {
"value": "\"custom_unit_denomination\"",
"mono": true
},
"description": {
"value": "The id of the custom unit in which you would like to view the Ledger, if desired. Specify either global or custom unit denomination",
"mono": false
},
"type": {
"value": "JSON Number or JSON Null",
"mono": false
},
"example": {
"value": "null",
"mono": true
},
"source": {
"value": "/custom_units/list",
"mono": false,
"link": "/documentation/custom_unit_list"
}
}
]
},
"required_headers": [
{
"key": "X-Signature",
"content": "Your <a class=\"link\" href=\"/documentation/sessions\">Session</a> signature",
"example": "\"yxATCPRKAAXHNiPctNQPHEGGVJF\"..."
},
{
"key": "X-Session-ID",
"content": "An an integer <a class=\"link\" href=\"/documentation/sessions\">Session</a> ID",
"example": 7449059267091272858
}
],
"required_url_parameters": [
{
"key": "entity_id",
"type": "string",
"description": "The entity id of the Entity for which you wish to retrieve a Tree",
"example": "oB3cjSNKXklkJ4Tb",
"repeatable": false
}
],
"returns": {
"root": "object",
"components": {
"object": "tree"
}
}
}
]
}