Received Reports
GET/v1/reportsGET /v1/reports
Code samples
cURL
# You can also use wget
curl -X GET /v1/reports \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
GET /v1/reports
Gets reports based on the provided request parameters.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| select | query | string | false | none |
| filter | query | string | false | none |
| include | query | string | false | none |
| sort | query | string | false | none |
| take | query | integer(int32) | false | none |
| skip | query | integer(int32) | false | none |
Example responses
200 Response
{"success":true,"code":0,"message":"string","reports":[{"id":0,"uid":"string","name":"string","version":"string","date":"2019-08-24T14:15:22Z","userKey":"string","machineId":"string","clientId":"string","clientName":"string","contentType":"string","content":"string","address":"string","geoLocation":"string","properties":[{"id":0,"name":"string","value":"string","reportId":0}]}],"totalReportsCount":0}{
"success": true,
"code": 0,
"message": "string",
"reports": [
{
"id": 0,
"uid": "string",
"name": "string",
"version": "string",
"date": "2019-08-24T14:15:22Z",
"userKey": "string",
"machineId": "string",
"clientId": "string",
"clientName": "string",
"contentType": "string",
"content": "string",
"address": "string",
"geoLocation": "string",
"properties": [
{
"id": 0,
"name": "string",
"value": "string",
"reportId": 0
}
]
}
],
"totalReportsCount": 0
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.GetReportResponse |
Authentication: API key (x-api-key).
POST/v1/reports/geolocationPOST /v1/reports/geolocation
Code samples
cURL
# You can also use wget
curl -X POST /v1/reports/geolocation \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
POST /v1/reports/geolocation
Resolves where the named reports’ client addresses are and stores the answers. The counterpart of M:Babel.Licensing.Service.Controllers.V1.ManagementController.ResolveLicenseTraceLocations(Babel.Licensing.Service.Management.ResolveLicenseTraceLocationsRequest), and just as narrow.
Body parameter
{
"reportIds": [
0
],
"limit": 0
}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Management.ResolveReportLocationsRequest | false | Which reports to locate, or how many to take. |
Example responses
200 Response
{"success":true,"code":0,"message":"string","resolvedCount":0,"unresolvedCount":0}{
"success": true,
"code": 0,
"message": "string",
"resolvedCount": 0,
"unresolvedCount": 0
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.ResolveReportLocationsResponse |
Authentication: API key (x-api-key).
DELETE/v1/reports/{reportId}DELETE /v1/reports/{reportId}
Code samples
cURL
# You can also use wget
curl -X DELETE /v1/reports/{reportId} \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
DELETE /v1/reports/\{reportId\}
Deletes a report with the specified ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| reportId | path | integer(int32) | true | The ID of the report to delete. |
Example responses
200 Response
{"success":true,"code":0,"message":"string"}{
"success": true,
"code": 0,
"message": "string"
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.DeleteReportResponse |
Authentication: API key (x-api-key).
Last updated on