Preview a report definition

Runs a definition without saving it, so a caller can see the result before creating the report.

POST/api/v1/reports/preview

認証

AuthorizationOAuth2 アクセストークン · header必須

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

スコープ:api.access

リクエストボディ

必須application/json

filtersobject[]

最大項目数 10 · デフォルト: []

プロパティを表示

object の配列

fieldstring必須

^[a-z][a-z0-9_]{0,62}$ に一致

valuestring | boolean必須

groupBystring

^[a-z][a-z0-9_]{0,62}$ に一致

limitinteger

最小 1 · 最大 100 · デフォルト: 50

measureobject必須

プロパティを表示

いずれか 1 つ:

object

operationstring必須

object

fieldstring必須

^[a-z][a-z0-9_]{0,62}$ に一致

operationstring必須

許可される値:sumaverageminmax

objectIdstring必須

最小長 1 · 最大長 255

レスポンス

200

The rows the definition produces

ReportResultRow の配列

labelstring | null必須

valuestring | null必須

400

The request body, query or parameters were refused

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

401

The access token is missing, invalid or revoked

errorstring必須

403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

404

No such record, or none the caller may read

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

413

The request exceeds the route's body limit

errorstring必須

500

An unexpected failure

errorstring必須

リクエスト

curl -X POST '/api/v1/api/v1/reports/preview' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "filters": [],
  "groupBy": "string",
  "limit": 50,
  "measure": {
    "operation": "count"
  },
  "objectId": "string"
}'

const response = await fetch("/api/v1/api/v1/reports/preview", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"filters\": [],\n  \"groupBy\": \"string\",\n  \"limit\": 50,\n  \"measure\": {\n    \"operation\": \"count\"\n  },\n  \"objectId\": \"string\"\n}"
});

import requests

response = requests.post(
    "/api/v1/api/v1/reports/preview",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"filters\": [],\n  \"groupBy\": \"string\",\n  \"limit\": 50,\n  \"measure\": {\n    \"operation\": \"count\"\n  },\n  \"objectId\": \"string\"\n}",
)

レスポンス

[
  {
    "label": "string",
    "value": "string"
  }
]

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}