Retrieve a Report

GET/lokta-lms/api/v1/reports/{id}

Example Requests:

reports/1

reports/1?template=true

Path parameters

idpath · integer · int64 · required

Responses

200OK

Response fields

coreReportboolean · optional

descriptionstring · optional

idinteger · int64 · optional

reportCategorystring · optional

reportNamestring · optional

reportParametersarray of ReportParameterData · optional

reportSqlstring · optional

reportSubTypestring · optional

reportTypestring · optional

useReportboolean · optional

Every request authenticates with HTTP Basic and carries a Tenant-Identifier header. See the conventions for dates, commands, pagination and errors. Open this operation in the interactive explorer, or read it as Markdown.

import requests response = requests.get( "http://localhost:8080/lokta-lms/api/v1/reports/{id}", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, ) print(response.json())

const response = await fetch("http://localhost:8080/lokta-lms/api/v1/reports/{id}", { method: "GET", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", }, }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("http://localhost:8080/lokta-lms/api/v1/reports/{id}")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

req, _ := http.NewRequest("GET", "http://localhost:8080/lokta-lms/api/v1/reports/{id}", nil) req.SetBasicAuth("{username}", "{password}") req.Header.Set("Tenant-Identifier", "default") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data))

{ "coreReport": true, "description": "Individual Client Report Lists the small number of defined fields on the client table. Would expect to copy this report and add any one to one additional data for specific tenant needs. Can be run for any size MFI but you expect it only to be run within a branch for larger ones. Depending on how many columns are displayed, there is probably is a limit of about 20/50k clients returned for html display (export to excel doesnt have that client browser/memory impact).", "id": 1, "reportCategory": "Client" }