Tenable Security Center API: Report Definition

/reportDefinition

Methods
GET

Gets the list of Report Definitions.

Fields Parameter
Expand

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

*id
**name
**description
**status
creator
owner
ownerGroup
type
dataSourceID
attributeSet
styleFamily
definition
xmldefinition
encryptionPassword
shareUsers
emailUsers
emailTargets
emailBCCTargets
createdTime
modifiedTime
pubSites
schedule
sources
scanResult
canManage
canUse
components
iterators
queryStatus 

Legend

* = always comes back
** = comes back if fields list not specified on GET all
red = field is a JSON object ( e.g. "SCI" : {"id" : "2", "name" : "SCI Name", "description" : "Description"} )

Request Query Parameters

None

Filter Parameters

usable - The response will be an object containing an array of usable Report Definitions. By default, both usable and manageable objects are returned.
manageable - The response will be an object containing all manageable Report Definitions. By default, both usable and manageable objects are returned. 

Example Response
Expand
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
{
    "type" : "regular",
    "response" : {
        "usable" : [
            {
                "id" : "3",
                "name" : "Test",
                "description" : "test",
                "type" : "lasr",
                "styleFamily" : "-1",
                "definition" : {
                    "columns" : [
                        {
                            "name" : "all"                      }
                    ],
                    "dataSource" : {
                        "queryID" : 2,
                        "querySourceType" : "cumulative",
                        "querySourceID" : null,
                        "querySourceView" : "all",
                        "sortColumn" : null,
                        "sortDirection" : null
                    },
                    "dataPoints" : 1.7976931348623e+308,
                    "lasrInfo" : {
                        "benchmarks" : [
                            "Faked Data Benchmark"                      ]
                    }
                },
                "xmldefinition" : "a:4:{s:7:\"columns\";a:1:{i:0;a:1:{s:4:\"name\";s:3:\"all\";}}s:10:\"dataSource\";a:6:{s:7:\"queryID\";i:2;s:15:\"querySourceType\";s:10:\"cumulative\";s:13:\"querySourceID\";N;s:15:\"querySourceView\";s:3:\"all\";s:10:\"sortColumn\";N;s:13:\"sortDirection\";N;}s:10:\"dataPoints\";d:1.7976931348623157E+308;s:8:\"lasrInfo\";a:1:{s:10:\"benchmarks\";a:1:{i:0;s:20:\"Faked Data Benchmark\";}}}",
                "encryptionPassword" : "",
                "status" : "0",
                "shareUsers" : [],
                "emailUsers" : [],
                "emailTargets" : "",
                "emailBCCTargets" : "",
                "createdTime" : "1410369405",
                "modifiedTime" : "1410369421",
                "pubSites" : [],
                "sources" : [
                    {
                        "id" : "3",
                        "queryID" : "2",
                        "querySourceType" : "cumulative",
                        "querySourceID" : null,
                        "querySourceView" : "all",
                        "sortColumn" : null,
                        "sortDirection" : null,
                        "iteratorID" : "-1",
                        "resultStyle" : "list",
                        "dataPoints" : 1.7976931348623e+308
                    }
                ],
                "scanResult" : [],
                "components" : [
                    {
                        "componentType" : "lasr",
                        "dataPoints" : 1.7976931348623e+308,
                        "columns" : "all"                   }
                ],
                "iterators" : [],
                "schedule" : {
                    "id" : "7",
                    "type" : "template",
                    "start" : "",
                    "repeatRule" : "",
                    "nextRun" : 0
                },
                "creator" : {
                    "id" : "1",
                    "username" : "head",
                    "firstname" : "Security Manager",
                    "lastname" : "",
                    "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"             },
                "owner" : {
                    "id" : "1",
                    "username" : "head",
                    "firstname" : "Security Manager",
                    "lastname" : "",
                    "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"             },
                "ownerGroup" : {
                    "id" : "0",
                    "name" : "Full Access",
                    "description" : "Full Access group"             },
                "attributeSet" : {
                    "id" : "5",
                    "name" : "test",
                    "description" : ""              }
            },
            {
                "id" : "4",
                "name" : "Test2",
                "description" : "",
                "type" : "lasr",
                "styleFamily" : "-1",
                "definition" : {
                    "columns" : [
                        {
                            "name" : "all"                      }
                    ],
                    "dataSource" : {
                        "queryID" : 12,
                        "querySourceType" : "cumulative",
                        "querySourceID" : null,
                        "querySourceView" : "all",
                        "sortColumn" : null,
                        "sortDirection" : null
                    },
                    "dataPoints" : 1.7976931348623e+308,
                    "lasrInfo" : {
                        "benchmarks" : [
                            "Faked Data Benchmark"                      ]
                    }
                },
                "xmldefinition" : "a:4:{s:7:\"columns\";a:1:{i:0;a:1:{s:4:\"name\";s:3:\"all\";}}s:10:\"dataSource\";a:6:{s:7:\"queryID\";i:2;s:15:\"querySourceType\";s:10:\"cumulative\";s:13:\"querySourceID\";N;s:15:\"querySourceView\";s:3:\"all\";s:10:\"sortColumn\";N;s:13:\"sortDirection\";N;}s:10:\"dataPoints\";d:1.7976931348623157E+308;s:8:\"lasrInfo\";a:1:{s:10:\"benchmarks\";a:1:{i:0;s:20:\"Faked Data Benchmark\";}}}",
                "encryptionPassword" : "",
                "status" : "0",
                "shareUsers" : [],
                "emailUsers" : [],
                "emailTargets" : "",
                "emailTargetType" : "1",
                "createdTime" : "1410369657",
                "modifiedTime" : "1410369657",
                "pubSites" : [],
                "sources" : [
                    {
                        "id" : "4",
                        "queryID" : "12",
                        "querySourceType" : "cumulative",
                        "querySourceID" : null,
                        "querySourceView" : "all",
                        "sortColumn" : null,
                        "sortDirection" : null,
                        "iteratorID" : "-1",
                        "resultStyle" : "list",
                        "dataPoints" : 1.7976931348623e+308
                    }
                ],
                "scanResult" : [],
                "components" : [
                    {
                        "componentType" : "lasr",
                        "dataPoints" : 1.7976931348623e+308,
                        "columns" : "all"                   }
                ],
                "iterators" : [],
                "schedule" : {
                    "id" : "8",
                    "type" : "template",
                    "start" : "",
                    "repeatRule" : "",
                    "nextRun" : 0
                },
                "creator" : {
                    "id" : "1",
                    "username" : "head",
                    "firstname" : "Security Manager",
                    "lastname" : "",
                    "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"             },
                "owner" : {
                    "id" : "1",
                    "username" : "head",
                    "firstname" : "Security Manager",
                    "lastname" : "",
                    "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"             },
                "ownerGroup" : {
                    "id" : "0",
                    "name" : "Full Access",
                    "description" : "Full Access group"             },
                "attributeSet" : {
                    "id" : "5",
                    "name" : "test",
                    "description" : ""              }
            }
        ],
        "manageable" : [
            {
                "id" : "3",
                "name" : "Test",
                "description" : "test",
                "type" : "lasr",
                "styleFamily" : "-1",
                "definition" : {
                    "columns" : [
                        {
                            "name" : "all"                      }
                    ],
                    "dataSource" : {
                        "queryID" : 2,
                        "querySourceType" : "cumulative",
                        "querySourceID" : null,
                        "querySourceView" : "all",
                        "sortColumn" : null,
                        "sortDirection" : null
                    },
                    "dataPoints" : 1.7976931348623e+308,
                    "lasrInfo" : {
                        "benchmarks" : [
                            "Faked Data Benchmark"                      ]
                    }
                },
                "xmldefinition" : "a:4:{s:7:\"columns\";a:1:{i:0;a:1:{s:4:\"name\";s:3:\"all\";}}s:10:\"dataSource\";a:6:{s:7:\"queryID\";i:2;s:15:\"querySourceType\";s:10:\"cumulative\";s:13:\"querySourceID\";N;s:15:\"querySourceView\";s:3:\"all\";s:10:\"sortColumn\";N;s:13:\"sortDirection\";N;}s:10:\"dataPoints\";d:1.7976931348623157E+308;s:8:\"lasrInfo\";a:1:{s:10:\"benchmarks\";a:1:{i:0;s:20:\"Faked Data Benchmark\";}}}",
                "encryptionPassword" : "",
                "status" : "0",
                "shareUsers" : [],
                "emailUsers" : [],
                "emailTargets" : "",
                "emailTargetType" : "1",
                "createdTime" : "1410369405",
                "modifiedTime" : "1410369421",
                "pubSites" : [],
                "sources" : [
                    {
                        "id" : "3",
                        "queryID" : "2",
                        "querySourceType" : "cumulative",
                        "querySourceID" : null,
                        "querySourceView" : "all",
                        "sortColumn" : null,
                        "sortDirection" : null,
                        "iteratorID" : "-1",
                        "resultStyle" : "list",
                        "dataPoints" : 1.7976931348623e+308
                    }
                ],
                "scanResult" : [],
                "components" : [
                    {
                        "componentType" : "lasr",
                        "dataPoints" : 1.7976931348623e+308,
                        "columns" : "all"                   }
                ],
                "iterators" : [],
                "schedule" : {
                    "id" : "7",
                    "type" : "template",
                    "start" : "",
                    "repeatRule" : "",
                    "nextRun" : 0
                },
                "creator" : {
                    "id" : "1",
                    "username" : "head",
                    "firstname" : "Security Manager",
                    "lastname" : "",
                    "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"             },
                "owner" : {
                    "id" : "1",
                    "username" : "head",
                    "firstname" : "Security Manager",
                    "lastname" : "",
                    "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"             },
                "ownerGroup" : {
                    "id" : "0",
                    "name" : "Full Access",
                    "description" : "Full Access group"             },
                "attributeSet" : {
                    "id" : "5",
                    "name" : "test",
                    "description" : ""              }
            },
            {
                "id" : "4",
                "name" : "Test2",
                "description" : "",
                "type" : "lasr",
                "styleFamily" : "-1",
                "definition" : {
                    "columns" : [
                        {
                            "name" : "all"                      }
                    ],
                    "dataSource" : {
                        "queryID" : 12,
                        "querySourceType" : "cumulative",
                        "querySourceID" : null,
                        "querySourceView" : "all",
                        "sortColumn" : null,
                        "sortDirection" : null
                    },
                    "dataPoints" : 1.7976931348623e+308,
                    "lasrInfo" : {
                        "benchmarks" : [
                            "Faked Data Benchmark"                      ]
                    }
                },
                "xmldefinition" : "a:4:{s:7:\"columns\";a:1:{i:0;a:1:{s:4:\"name\";s:3:\"all\";}}s:10:\"dataSource\";a:6:{s:7:\"queryID\";i:2;s:15:\"querySourceType\";s:10:\"cumulative\";s:13:\"querySourceID\";N;s:15:\"querySourceView\";s:3:\"all\";s:10:\"sortColumn\";N;s:13:\"sortDirection\";N;}s:10:\"dataPoints\";d:1.7976931348623157E+308;s:8:\"lasrInfo\";a:1:{s:10:\"benchmarks\";a:1:{i:0;s:20:\"Faked Data Benchmark\";}}}",
                "encryptionPassword" : "",
                "status" : "0",
                "shareUsers" : [],
                "emailUsers" : [],
                "emailTargets" : "",
                "emailTargetType" : "1",
                "createdTime" : "1410369657",
                "modifiedTime" : "1410369657",
                "pubSites" : [],
                "sources" : [
                    {
                        "id" : "4",
                        "queryID" : "12",
                        "querySourceType" : "cumulative",
                        "querySourceID" : null,
                        "querySourceView" : "all",
                        "sortColumn" : null,
                        "sortDirection" : null,
                        "iteratorID" : "-1",
                        "resultStyle" : "list",
                        "dataPoints" : 1.7976931348623e+308
                    }
                ],
                "scanResult" : [],
                "components" : [
                    {
                        "componentType" : "lasr",
                        "dataPoints" : 1.7976931348623e+308,
                        "columns" : "all"                   }
                ],
                "iterators" : [],
                "schedule" : {
                    "id" : "8",
                    "type" : "template",
                    "start" : "",
                    "repeatRule" : "",
                    "nextRun" : 0
                },
                "creator" : {
                    "id" : "1",
                    "username" : "head",
                    "firstname" : "Security Manager",
                    "lastname" : "",
                    "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"             },
                "owner" : {
                    "id" : "1",
                    "username" : "head",
                    "firstname" : "Security Manager",
                    "lastname" : "",
                    "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"             },
                "ownerGroup" : {
                    "id" : "0",
                    "name" : "Full Access",
                    "description" : "Full Access group"             },
                "attributeSet" : {
                    "id" : "5",
                    "name" : "test",
                    "description" : ""              }
            }
        ]
    },
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1413401160
}
POST

Adds a Report Definition

NOTE #1: For notes on the query object, see parameters for /query::POST.

NOTE #2: If a template ID is provided

  • The template associated with the provided ID will be retrieved and used as the default values for the Report Definition.
  • All Report Definition types are 'pdf'. These values can be overwritten.
  • The 'name' will be handled by the back-end, and would default to the template name. If the template name already exists, it would default the name to the name plus the highest value used i.e. "templateName(2)"
  • Templates do not include a schedule. A schedule must still be provided.
  • Reports scheduled for a single occurrence are considered one-time reports. They run immediately and then are deleted. This includes schedules of type "now" or schedules of type "ical" and an empty "repeatRule" value

WARNING: If field attributeSetID is not numeric, it will pass validation. This check should be made more like the check for field styleFamily.

Request Parameters
Expand
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
{
    "name" : <string>,
    "template" : {
        "id" : <number>   } OPTIONAL,
    "description" : <string> DEFAULT "",
    "type" : <string> "arf" | "asr" | "csv" | "lasr" | "pdf" | "rtf",
    "encryptionPassword" : <string> DEFAULT "",
    "pubSites" : [
        {
            "id" : <number>       }...
    ] DEFAULT [],
    "schedule" : {
        "type" : <string> "ical" | "never" | "now" | "rollover" | "template"  },
    "shareUsers" : [
        {
            "id" : <number>       }...
    ] DEFAULT [],
    "emailUsers" : [
        {
            "id" : <number>       }...
    ] DEFAULT [],
    "emailTargets" : <string> DEFAULT "" (comma-separated list of email addresses),
    "emailBCCTargets" : <string> DEFAULT "" (comma-separated list of email addresses),
...
}

schedule["type"] is "ical"

1
2
3
4
5
6
...
    "schedule" : {
        "start" : <string> (This value takes the iCal format),
        "repeatRule" : <string> (This value takes the repeat rule format)
    },
...

Report definitions have many variations of structure and complexity. This information is intended to be used as a basic guideline and may not include every use-case.

type "csv",

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
...
    "definition" : {
        "dataSource" : {
            "queryID" : <number> OPTIONAL
            "querySourceType" : <string> "archive" | "cumulative" | "individual" | "lce" | "mobile"| "patched",
            "querySourceID" : <number>,
            "querySourceView" : <string> "" | "new" | "all" | "patched",
            "sortColumn" : <string>,
            "sortDirection" : <string>,
            "iteratorID" : <number> DEFAULT "-1" (not set)
             
            queryID is not provided
            -----------------------
             "query" : <query object>,
        }
    }
...

type "pdf" | "rtf",
NOTE: ARC Objects may not be passed. ARCs must be created separately before added to a Report.

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
...
    "styleFamily" : <number>,
    "definition" : {
        "chapters" : [
            {
                "tag" : <string> "section" | "group" | "iterator" | "component",
                "name" : <string>,
                "styleID" : <number> DEFAULT "-1" (not set),
                "elements" : [
                    {
                        "tag" : <string> "arc" | "section" | "group" | "iterator" | "component"                      tag "arc"                       ---------
                        "id" : <number> DEFAULT -1,
                         
                        tag "section" | "group"                     -------------
                        "elements" : (see parent 'elements' parameter)
                         
                        tag "iterator"                      -----------
                        "elements" : (see parent 'elements' parameter)
                         
                            elements parameter is provided
                            ------------------------------
                            "styleID" : <number> DEFAULT "-1" (not set),
                            "displayDataPoints" : <number>,
                            "columns" : [
                                {
                                    "name" : <string>                             }
                            ] OPTIONAL?,
                             
                            "definition" : {
                                "dataSource" : {
                                    "queryID" : <number> OPTIONAL,
                                    "querySourceType" : <string> "archive" | "cumulative" | "individual" | "lce" | "mobile"| "patched",
                                    "querySourceID" : <number>,
                                    "querySourceView" : <string> "" | "new" | "all" | "patched",
                                    "sortColumn" : <string>,
                                    "sortDirection" : <string>,
                                    "iteratorID" : <number> DEFAULT "-1" (not set)
                                     
                                    queryID is not provided
                                    -----------------------
                                    "query" : <query object>,
                                }
                            }
                            "dataPoints" : <string> "all" (php int max 9223372036854775807) | <number>,
                         
                        tag "component"                     ----------------
                        **see/dashboard/component::POST for additional variables**
                    }...
                ]
            }...
        ],
    }
...

type "asr"

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
...
    "definition" : {
        "asrInfo" : {
            "includeARF" : <string> "false" | "true" (required)
            "content" : <string> "benchmark" | ???? (required)
             
            content "benchmark"         --------------------
            "benchmarks" : []
        },
        "dataSource" : {
            "queryID" : <number> OPTIONAL (if provided, must be associated with a vuln query),
            "querySourceType" : <string> "archive" | "cumulative" | "individual" | "lce" | "mobile"| "patched",
            "querySourceID" : <number>,
            "querySourceView" : <string>,
            "sortColumn" : <string>,
            "sortDirection" : <string>,
            "iteratorID" : <number> DEFAULT "-1" (not set)
             
            queryID is not provided
            -----------------------
             "query" : <query object>,
        }
    },
    definition[asrInfo][includeARF] not "false" -----------------
    "attributeSetID" : <number>...

type "arf" | "lasr"

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
...
    "attributeSetID" : <number>,
    "definition" : {
        "dataSource" : {
            "queryID" : <number> OPTIONAL (if provided, must be associated with a vuln query),
            "querySourceType" : <string> "archive" | "cumulative" | "individual" | "lce" | "mobile"| "patched",
            "querySourceID" : <number>,
            "querySourceView" : <string>,
            "sortColumn" : <string>,
            "sortDirection" : <string>,
            "iteratorID" : <number> DEFAULT "-1" (not set)
             
            queryID is not provided
            -----------------------
             "query" : <query object>,
            },
        },
        "attributeSetID" : <number>   }
...
Example Response
Expand
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
{
    "type" : "regular",
    "response" : {
        "id" : "3",
        "name" : "Test",
        "description" : "test",
        "type" : "lasr",
        "styleFamily" : "-1",
        "definition" : {
            "columns" : [
                {
                    "name" : "all"              }
            ],
            "dataSource" : {
                "queryID" : 2,
                "querySourceType" : "cumulative",
                "querySourceID" : null,
                "querySourceView" : "all",
                "sortColumn" : null,
                "sortDirection" : null
            },
            "dataPoints" : 1.7976931348623e+308,
            "lasrInfo" : {
                "benchmarks" : ["Faked Data Benchmark"]
            }
        },
        "xmldefinition" : "a:4:{s:7:\"columns\";a:1:{i:0;a:1:{s:4:\"name\";s:3:\"all\";}}s:10:\"dataSource\";a:6:{s:7:\"queryID\";i:2;s:15:\"querySourceType\";s:10:\"cumulative\";s:13:\"querySourceID\";N;s:15:\"querySourceView\";s:3:\"all\";s:10:\"sortColumn\";N;s:13:\"sortDirection\";N;}s:10:\"dataPoints\";d:1.7976931348623157E+308;s:8:\"lasrInfo\";a:1:{s:10:\"benchmarks\";a:1:{i:0;s:20:\"Faked Data Benchmark\";}}}",
        "encryptionPassword" : "",
        "status" : "0",
        "shareUsers" : [],
        "emailUsers" : [],
        "emailTargets" : "",
        "emailBCCTargets" : "",
        "createdTime" : "1410369405",
        "modifiedTime" : "1410369421",
        "pubSites" : [],
        "sources" : [
            {
                "id" : "3",
                "queryID" : "2",
                "querySourceType" : "cumulative",
                "querySourceID" : null,
                "querySourceView" : "all",
                "sortColumn" : null,
                "sortDirection" : null,
                "iteratorID" : "-1",
                "resultStyle" : "list",
                "dataPoints" : 1.7976931348623e+308
            }
        ],
        "scanResult" : [],
        "components" : [
            {
                "componentType" : "lasr",
                "dataPoints" : 1.7976931348623e+308,
                "columns" : "all"           }
        ],
        "iterators" : [],
        "schedule" : {
            "id" : "7",
            "type" : "template",
            "start" : "",
            "repeatRule" : "",
            "nextRun" : 0
        },
        "creator" : {
            "id" : "1",
            "username" : "head",
            "firstname" : "Security Manager",
            "lastname" : "",
            "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"     },
        "owner" : {
            "id" : "1",
            "username" : "head",
            "firstname" : "Security Manager",
            "lastname" : "",
            "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"     },
        "ownerGroup" : {
            "id" : "0",
            "name" : "Full Access",
            "description" : "Full Access group"     },
        "attributeSet" : {
            "id" : "5",
            "name" : "test",
            "description" : ""      }
    },
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1413401138
}

/reportDefinition/{id}

Methods
GET

Gets the Report Definition associated with {id}.

Fields Parameter
Expand

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

*id
**name
**description
**status
creator
owner
ownerGroup
type
 dataSourceID
attributeSet
styleFamily
definition
xmldefinition
encryptionPassword
shareUsers
emailUsers
emailTargets
emailBCCTargets
createdTime
modifiedTime
pubSites
schedule
sources
scanResult
canManage
canUse
components
iterators
queryStatus

Legend

* = always comes back
** = comes back if fields list not specified on GET all
red = field is a JSON object ( e.g. "SCI" : {"id" : "2", "name" : "SCI Name", "description" : "Description"} )

Request Query Parameters

None

Example Response
Expand
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
{
    "type" : "regular",
    "response" : {
        "id" : "3",
        "name" : "Test",
        "description" : "test",
        "type" : "lasr",
        "styleFamily" : "-1",
        "definition" : {
            "columns" : [
                {
                    "name" : "all"              }
            ],
            "dataSource" : {
                "queryID" : 2,
                "querySourceType" : "cumulative",
                "querySourceID" : null,
                "querySourceView" : "all",
                "sortColumn" : null,
                "sortDirection" : null
            },
            "dataPoints" : 1.7976931348623e+308,
            "lasrInfo" : {
                "benchmarks" : ["Faked Data Benchmark"]
            }
        },
        "xmldefinition" : "a:4:{s:7:\"columns\";a:1:{i:0;a:1:{s:4:\"name\";s:3:\"all\";}}s:10:\"dataSource\";a:6:{s:7:\"queryID\";i:2;s:15:\"querySourceType\";s:10:\"cumulative\";s:13:\"querySourceID\";N;s:15:\"querySourceView\";s:3:\"all\";s:10:\"sortColumn\";N;s:13:\"sortDirection\";N;}s:10:\"dataPoints\";d:1.7976931348623157E+308;s:8:\"lasrInfo\";a:1:{s:10:\"benchmarks\";a:1:{i:0;s:20:\"Faked Data Benchmark\";}}}",
        "encryptionPassword" : "",
        "status" : "0",
        "shareUsers" : [],
        "emailUsers" : [],
        "emailTargets" : "",
        "emailBCCTargets" : "",
        "createdTime" : "1410369405",
        "modifiedTime" : "1410369421",
        "pubSites" : [],
        "sources" : [
            {
                "id" : "3",
                "queryID" : "2",
                "querySourceType" : "cumulative",
                "querySourceID" : null,
                "querySourceView" : "all",
                "sortColumn" : null,
                "sortDirection" : null,
                "iteratorID" : "-1",
                "resultStyle" : "list",
                "dataPoints" : 1.7976931348623e+308
            }
        ],
        "scanResult" : [],
        "components" : [
            {
                "componentType" : "lasr",
                "dataPoints" : 1.7976931348623e+308,
                "columns" : "all"           }
        ],
        "iterators" : [],
        "schedule" : {
            "id" : "7",
            "type" : "template",
            "start" : "",
            "repeatRule" : "",
            "nextRun" : 0
        },
        "creator" : {
            "id" : "1",
            "username" : "head",
            "firstname" : "Security Manager",
            "lastname" : "",
            "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"     },
        "owner" : {
            "id" : "1",
            "username" : "head",
            "firstname" : "Security Manager",
            "lastname" : "",
            "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"     },
        "ownerGroup" : {
            "id" : "0",
            "name" : "Full Access",
            "description" : "Full Access group"     },
        "attributeSet" : {
            "id" : "5",
            "name" : "test",
            "description" : ""      },
        "queryStatus" : [
            {
                "id" : "1",
                "name" : "",
                "description" : """,
                "status" : "0"          }
        ]
    },
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1413401138
}
PATCH

Edits the Report Definition associated with {id}, changing only the passed in fields.

Request Parameters

(All fields are optional)

See /reportDefinition::POST for parameters.

Example Response
See /reportDefinition/{id}::GET
DELETE

Deletes Reports associated with Report Definition {id}.

Request Parameters

None

Example Response
Expand
1
2
3
4
5
6
7
8
{
    "type" : "regular",
    "response" : "",
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1405715741
}

/reportDefinition/{id}/launch

Methods
POST

Launches a Report Job specified from the Report Definition associated with {id}. To get the status of the Report Job, see API call /report::GET.

Request Query Parameters

None

Example Response
Expand
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
{
    "type" : "regular",
    "response" : {
        "reportDefinitionID" : "7",
        "reportResult" : {
            "creatorID" : "2",
            "ownerID" : "2",
            "ownerGID" : "1",
            "reportDefinitionID" : "7",
            "jobID" : "113868",
            "name" : "CS-4700 Iterator",
            "description" : "",
            "type" : "pdf",
            "status" : "Queued",
            "errorDetails" : "",
            "totalSteps" : -1,
            "completedSteps" : 0,
            "startTime" : -1,
            "finishTime" : 0,
            "pubSites" : [],
            "id" : "3"      }
    },
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1434567869
}

/reportDefinition/{id}/copy

POST

 Copies the Report Definition associated with {id}.

Request Query Parameters
Expand
1
2
3
4
{
    "name" : <string>,
    "targetUserID" : <number> DEFAULT (Session User's ID)
}
Example Response
Expand
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
{
    "type" : "regular",
    "response" : {
        "id" : "3",
        "name" : "Test",
        "description" : "test",
        "type" : "lasr",
        "styleFamily" : "-1",
        "definition" : {
            "columns" : [
                {
                    "name" : "all"              }
            ],
            "dataSource" : {
                "queryID" : 2,
                "querySourceType" : "cumulative",
                "querySourceID" : null,
                "querySourceView" : "all",
                "sortColumn" : null,
                "sortDirection" : null
            },
            "dataPoints" : 1.7976931348623e+308,
            "lasrInfo" : {
                "benchmarks" : ["Faked Data Benchmark"]
            }
        },
        "xmldefinition" : "a:4:{s:7:\"columns\";a:1:{i:0;a:1:{s:4:\"name\";s:3:\"all\";}}s:10:\"dataSource\";a:6:{s:7:\"queryID\";i:2;s:15:\"querySourceType\";s:10:\"cumulative\";s:13:\"querySourceID\";N;s:15:\"querySourceView\";s:3:\"all\";s:10:\"sortColumn\";N;s:13:\"sortDirection\";N;}s:10:\"dataPoints\";d:1.7976931348623157E+308;s:8:\"lasrInfo\";a:1:{s:10:\"benchmarks\";a:1:{i:0;s:20:\"Faked Data Benchmark\";}}}",
        "encryptionPassword" : "",
        "status" : "0",
        "shareUsers" : [],
        "emailUsers" : [],
        "emailTargets" : "",
        "emailBCCTargets" : "",
        "createdTime" : "1410369405",
        "modifiedTime" : "1410369421",
        "pubSites" : [],
        "sources" : [
            {
                "id" : "3",
                "queryID" : "2",
                "querySourceType" : "cumulative",
                "querySourceID" : null,
                "querySourceView" : "all",
                "sortColumn" : null,
                "sortDirection" : null,
                "iteratorID" : "-1",
                "resultStyle" : "list",
                "dataPoints" : 1.7976931348623e+308
            }
        ],
        "scanResult" : [],
        "components" : [
            {
                "componentType" : "lasr",
                "dataPoints" : 1.7976931348623e+308,
                "columns" : "all"           }
        ],
        "iterators" : [],
        "schedule" : {
            "id" : "7",
            "type" : "template",
            "start" : "",
            "repeatRule" : "",
            "nextRun" : 0
        },
        "creator" : {
            "id" : "1",
            "username" : "head",
            "firstname" : "Security Manager",
            "lastname" : "",
            "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"     },
        "owner" : {
            "id" : "1",
            "username" : "head",
            "firstname" : "Security Manager",
            "lastname" : "",
            "uuid" : "96F2AD1B-1B83-462E-908A-84E6054F6B64"     },
        "ownerGroup" : {
            "id" : "0",
            "name" : "Full Access",
            "description" : "Full Access group"     },
        "attributeSet" : {
            "id" : "5",
            "name" : "test",
            "description" : ""      }
    },
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1413401138
}

/reportDefinition/{id}/export

POST

 Exports the Report Definition associated with {id}.

Request Query Parameters
Expand


1
2
{
    "exportType" : <string> "cleansed" | "full" | "placeholders"}
Example Response

None given. The response will be an xml file containing the Report Definition.

/reportDefinition/import

POST

Imports the report definition provided.

Request Query Parameters
Expand
1
2
3
4
 {
    "name" : <string>,
    "filename" : <string> (associated with valid reportDefinition file)
}
Example Response
Expand
1
2
3
4
5
6
7
8
 {
    "type" : "regular",
    "response" : "",
    "error_code" : 0,
    "error_msg" : "",
    "warnings" : [],
    "timestamp" : 1407248107
}