Report Data Type REST Endpoint

Last modified 13 Mar 2024 13:32 +01:00

Description

Here we are describing the Report Data object type in relation to midPoints REST API. The Report Data objects are a part of the REST API web resources.

Endpoint
reportData/

Operations And Examples

The Report Data type endpoint operations and examples.

In our examples we are authenticating with the credentials, name "administrator" and password "y0uR_P455woR*d" on a localhost instance running on port 8080.

For some help regarding the REST examples please see this link:

Get Report Data type Objects

Get operation for fetching a single specific object.

Search for Report Data type Objects

Search operation usable for fetching the full list of objects or a list based on filter.

Search Report Data based on Report Reference
curl --user administrator:y0uR_P455woR*d \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-X POST http://localhost:8080/midpoint/ws/rest/reportData/search \
-v \
--data-binary @./samples/rest/query-report-data.json
Show data source example for "Search Report Data based on Report Reference" | GitHub
{
  "query": {
    "filter": {
      "text": "reportRef/@/name =\"All error audit records in 24h\""
    }
  }
}

The response is an HTTP 200 code in case of success with a response body containing the queried items.

Example Output is a list of objects.
{
  "@ns" : "http://prism.evolveum.com/xml/ns/public/types-3",
  "object" : {
    "@type" : "http://midpoint.evolveum.com/xml/ns/public/common/api-types-3#ObjectListType",
    "object" : [ {
      "@type" : "c:ReportDataType",
      "oid" : "1a1f8226-6b2d-4253-8714-f0a8e61179fb",
      "version" : "1",
      "name" : "All error audit records in 24h-EXPORT 08-03-2024 08-18-46.230 - CSV",
      "description" : "Report made from all audit records. - CSV",
      "metadata" : {},
      "operationExecution" : {},
      "iteration" : 0,
      "iterationToken" : "",
      "filePath" : "./foo/baar/All_error_audit_records_in_24h-EXPORT_08-03-2024_08-18-46.228.csv",
      "reportRef" : {
        "oid" : "579b3765-a2d3-46bc-98e5-3a2414d0accd",
        "relation" : "org:default",
        "type" : "c:ReportType"
      },
      "nodeRef" : {
        "oid" : "3f383096-0da2-42f5-97d5-cdc2da0f61db",
        "relation" : "org:default",
        "type" : "c:NodeType"
      }
    } ]
  }
}

Modify Report Data type Objects

Delete Report Data type Objects

Generate and Validate Operations for Report Data Objects

Operations to generate or validate values.

JSON Example

Example output of information regarding a specific Report Data object. Metadata is usually a part of the output, yet it was removed for the purpose of the example.

Show JSON Example
{
  "reportData" : {
    "oid" : "",
    "version" : "1",
    "name" : "All users-EXPORT",
    "metadata" : {
      "requestTimestamp" : "",
      "requestorRef" : {
        "oid" : "00000000-0000-0000-0000-000000000002",
        "relation" : "org:default",
        "type" : "c:UserType"
      },
      "createTimestamp" : "",
      "creatorRef" : {
        "oid" : "00000000-0000-0000-0000-000000000002",
        "relation" : "org:default",
        "type" : "c:UserType"
      },
      "createTaskRef" : {
        "oid" : "",
        "relation" : "org:default",
        "type" : "c:TaskType"
      }
    },
    "operationExecution" : {},
    "iteration" : 0,
    "iterationToken" : "",
    "filePath" : "",
    "reportRef" : {},
    "nodeRef" : {}
  }
}
Was this page helpful?
YES NO
Thanks for your feedback