Ctrlk
Jetzt loslegen
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Reports

List all reports in a table

get

Retrieves all reports for a table

Autorisierungen
AuthorizationstringErforderlich

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Pfadparameter
moduleNamestring · min: 1 · max: 100Erforderlich

Module name

Example: crmPattern: ^[a-z0-9_]+$
tableNamestring · min: 1 · max: 100Erforderlich

Table name

Example: contactsPattern: ^[a-z0-9_]+$
workspaceIdstring · min: 12 · max: 12Erforderlich

Workspace ID

Example: 5rdco4s18swuPattern: ^[a-z0-9]+$
Antworten
200

Reports retrieved successfully

application/json
get/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/reports
GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/reports HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "fontFamily": "text",
      "fontSize": 1,
      "footHeight": 1,
      "headHeight": 1,
      "id": "text",
      "inlineStyle": "text",
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "marginB": 1,
      "marginL": 1,
      "marginR": 1,
      "marginT": 1,
      "moduleName": "text",
      "name": "text",
      "objects": [
        {
          "backgroundColor": "text",
          "base": "html",
          "borderColor": "text",
          "borderRadius": 1,
          "borderStyle": "text",
          "borderWidth": 1,
          "expression": "text",
          "fid": "text",
          "file": "text",
          "fn": "text",
          "fontFamily": "text",
          "fontSize": 1,
          "fontStyle": "italic",
          "fontWeight": "bold",
          "h": 1,
          "isAutoHeight": true,
          "lineHeight": 1,
          "paddingB": 1,
          "paddingL": 1,
          "paddingR": 1,
          "paddingT": 1,
          "position": "foot",
          "showFoot": true,
          "showHead": true,
          "tableBorderStyle": 0,
          "text": "text",
          "textAlign": "center",
          "textColor": "text",
          "textDecoration": "underline",
          "verticalAlign": "text",
          "viewConfig": {
            "columns": [
              {
                "agg": "text",
                "conditionalStyling": [
                  {
                    "background": "text",
                    "cell": "text",
                    "color": "text",
                    "icon": "text",
                    "operand": "text",
                    "value": "text"
                  }
                ],
                "field": "text",
                "hidden": true,
                "labels": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "order": 1,
                "role": "text",
                "width": 1
              }
            ],
            "conditionalFormatting": [
              {
                "backgroundColor": "text",
                "bold": true,
                "comparator": "contains",
                "expression": "text",
                "fieldName": "text",
                "highlightColor": "text",
                "icon": {
                  "color": "text",
                  "filling": 0,
                  "icon": "text"
                },
                "id": "text",
                "italic": true,
                "order": 1,
                "strikethrough": true,
                "target": "cell",
                "textColor": "text",
                "value": null
              }
            ],
            "filter": [
              {
                "field": "text",
                "id": "text",
                "operator": "text",
                "value": "text"
              }
            ],
            "groupBy": [
              {
                "direction": "asc",
                "fieldName": "text"
              }
            ],
            "search": "text",
            "sort": {
              "direction": "asc",
              "fieldName": "text"
            },
            "viewType": "Calendar"
          },
          "w": 1,
          "x": 1,
          "y": 1
        }
      ],
      "paperHeight": 1,
      "paperWidth": 1,
      "printAttachments": true,
      "tableName": "text"
    }
  ]
}

Create a report

post

Creates a report (print layout) for a table. Omit objects to auto-generate a layout from the table's current fields, matching the report designer's automatic layout option.

Autorisierungen
AuthorizationstringErforderlich

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Pfadparameter
moduleNamestring · min: 1 · max: 100Erforderlich

Module name

Example: crmPattern: ^[a-z0-9_]+$
tableNamestring · min: 1 · max: 100Erforderlich

Table name

Example: contactsPattern: ^[a-z0-9_]+$
workspaceIdstring · min: 12 · max: 12Erforderlich

Workspace ID

Example: 5rdco4s18swuPattern: ^[a-z0-9]+$
Body
fontFamilystringOptional

Default font family

fontSizenumberOptional

Default font size

footHeightnumberOptional

Footer height

Default: 20
headHeightnumberOptional

Header height

Default: 20
inlineStylestringOptional

Inline CSS applied to the report

marginBnumberOptional

Bottom page margin

Default: 20
marginLnumberOptional

Left page margin

Default: 20
marginRnumberOptional

Right page margin

Default: 20
marginTnumberOptional

Top page margin

Default: 20
namestring · min: 1 · max: 100Erforderlich

Report name

paperHeightnumberOptional

Paper height

Default: 297
paperWidthnumberOptional

Paper width

Default: 210
printAttachmentsbooleanOptional

Include row attachments when printing

Antworten
201

Report created successfully

application/json
post/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/reports
POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/reports HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1589

{
  "fontFamily": "text",
  "fontSize": 1,
  "footHeight": 20,
  "headHeight": 20,
  "inlineStyle": "text",
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "marginB": 20,
  "marginL": 20,
  "marginR": 20,
  "marginT": 20,
  "name": "text",
  "objects": [
    {
      "backgroundColor": "text",
      "base": "html",
      "borderColor": "text",
      "borderRadius": 1,
      "borderStyle": "text",
      "borderWidth": 1,
      "expression": "text",
      "fid": "text",
      "file": "text",
      "fn": "text",
      "fontFamily": "text",
      "fontSize": 1,
      "fontStyle": "italic",
      "fontWeight": "bold",
      "h": 1,
      "isAutoHeight": true,
      "lineHeight": 1,
      "paddingB": 1,
      "paddingL": 1,
      "paddingR": 1,
      "paddingT": 1,
      "position": "foot",
      "showFoot": true,
      "showHead": true,
      "tableBorderStyle": 0,
      "text": "text",
      "textAlign": "center",
      "textColor": "text",
      "textDecoration": "underline",
      "verticalAlign": "text",
      "viewConfig": {
        "columns": [
          {
            "agg": "text",
            "conditionalStyling": [
              {
                "background": "text",
                "cell": "text",
                "color": "text",
                "icon": "text",
                "operand": "text",
                "value": "text"
              }
            ],
            "field": "text",
            "hidden": true,
            "labels": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "order": 1,
            "role": "text",
            "width": 1
          }
        ],
        "conditionalFormatting": [
          {
            "backgroundColor": "text",
            "bold": true,
            "comparator": "contains",
            "expression": "text",
            "fieldName": "text",
            "highlightColor": "text",
            "icon": {
              "color": "text",
              "filling": 0,
              "icon": "text"
            },
            "id": "text",
            "italic": true,
            "order": 1,
            "strikethrough": true,
            "target": "cell",
            "textColor": "text",
            "value": null
          }
        ],
        "filter": [
          {
            "field": "text",
            "id": "text",
            "operator": "text",
            "value": "text"
          }
        ],
        "groupBy": [
          {
            "direction": "asc",
            "fieldName": "text"
          }
        ],
        "search": "text",
        "sort": {
          "direction": "asc",
          "fieldName": "text"
        },
        "viewType": "Calendar"
      },
      "w": 1,
      "x": 1,
      "y": 1
    }
  ],
  "paperHeight": 297,
  "paperWidth": 210,
  "printAttachments": true
}
{
  "data": {
    "fontFamily": "text",
    "fontSize": 1,
    "footHeight": 1,
    "headHeight": 1,
    "id": "text",
    "inlineStyle": "text",
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "marginB": 1,
    "marginL": 1,
    "marginR": 1,
    "marginT": 1,
    "moduleName": "text",
    "name": "text",
    "objects": [
      {
        "backgroundColor": "text",
        "base": "html",
        "borderColor": "text",
        "borderRadius": 1,
        "borderStyle": "text",
        "borderWidth": 1,
        "expression": "text",
        "fid": "text",
        "file": "text",
        "fn": "text",
        "fontFamily": "text",
        "fontSize": 1,
        "fontStyle": "italic",
        "fontWeight": "bold",
        "h": 1,
        "isAutoHeight": true,
        "lineHeight": 1,
        "paddingB": 1,
        "paddingL": 1,
        "paddingR": 1,
        "paddingT": 1,
        "position": "foot",
        "showFoot": true,
        "showHead": true,
        "tableBorderStyle": 0,
        "text": "text",
        "textAlign": "center",
        "textColor": "text",
        "textDecoration": "underline",
        "verticalAlign": "text",
        "viewConfig": {
          "columns": [
            {
              "agg": "text",
              "conditionalStyling": [
                {
                  "background": "text",
                  "cell": "text",
                  "color": "text",
                  "icon": "text",
                  "operand": "text",
                  "value": "text"
                }
              ],
              "field": "text",
              "hidden": true,
              "labels": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "order": 1,
              "role": "text",
              "width": 1
            }
          ],
          "conditionalFormatting": [
            {
              "backgroundColor": "text",
              "bold": true,
              "comparator": "contains",
              "expression": "text",
              "fieldName": "text",
              "highlightColor": "text",
              "icon": {
                "color": "text",
                "filling": 0,
                "icon": "text"
              },
              "id": "text",
              "italic": true,
              "order": 1,
              "strikethrough": true,
              "target": "cell",
              "textColor": "text",
              "value": null
            }
          ],
          "filter": [
            {
              "field": "text",
              "id": "text",
              "operator": "text",
              "value": "text"
            }
          ],
          "groupBy": [
            {
              "direction": "asc",
              "fieldName": "text"
            }
          ],
          "search": "text",
          "sort": {
            "direction": "asc",
            "fieldName": "text"
          },
          "viewType": "Calendar"
        },
        "w": 1,
        "x": 1,
        "y": 1
      }
    ],
    "paperHeight": 1,
    "paperWidth": 1,
    "printAttachments": true,
    "tableName": "text"
  }
}

Get a specific report

get

Retrieves a specific report by id

Autorisierungen
AuthorizationstringErforderlich

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Pfadparameter
reportIdstring · min: 12 · max: 12Erforderlich

Report ID

Example: a1b2c3d4e5f6Pattern: ^[a-z0-9]+$
workspaceIdstring · min: 12 · max: 12Erforderlich

Workspace ID

Example: 5rdco4s18swuPattern: ^[a-z0-9]+$
Antworten
200

Report details retrieved successfully

application/json
get/api/v1/workspace/{workspaceId}/reports/{reportId}
GET /api/v1/workspace/{workspaceId}/reports/{reportId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "fontFamily": "text",
    "fontSize": 1,
    "footHeight": 1,
    "headHeight": 1,
    "id": "text",
    "inlineStyle": "text",
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "marginB": 1,
    "marginL": 1,
    "marginR": 1,
    "marginT": 1,
    "moduleName": "text",
    "name": "text",
    "objects": [
      {
        "backgroundColor": "text",
        "base": "html",
        "borderColor": "text",
        "borderRadius": 1,
        "borderStyle": "text",
        "borderWidth": 1,
        "expression": "text",
        "fid": "text",
        "file": "text",
        "fn": "text",
        "fontFamily": "text",
        "fontSize": 1,
        "fontStyle": "italic",
        "fontWeight": "bold",
        "h": 1,
        "isAutoHeight": true,
        "lineHeight": 1,
        "paddingB": 1,
        "paddingL": 1,
        "paddingR": 1,
        "paddingT": 1,
        "position": "foot",
        "showFoot": true,
        "showHead": true,
        "tableBorderStyle": 0,
        "text": "text",
        "textAlign": "center",
        "textColor": "text",
        "textDecoration": "underline",
        "verticalAlign": "text",
        "viewConfig": {
          "columns": [
            {
              "agg": "text",
              "conditionalStyling": [
                {
                  "background": "text",
                  "cell": "text",
                  "color": "text",
                  "icon": "text",
                  "operand": "text",
                  "value": "text"
                }
              ],
              "field": "text",
              "hidden": true,
              "labels": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "order": 1,
              "role": "text",
              "width": 1
            }
          ],
          "conditionalFormatting": [
            {
              "backgroundColor": "text",
              "bold": true,
              "comparator": "contains",
              "expression": "text",
              "fieldName": "text",
              "highlightColor": "text",
              "icon": {
                "color": "text",
                "filling": 0,
                "icon": "text"
              },
              "id": "text",
              "italic": true,
              "order": 1,
              "strikethrough": true,
              "target": "cell",
              "textColor": "text",
              "value": null
            }
          ],
          "filter": [
            {
              "field": "text",
              "id": "text",
              "operator": "text",
              "value": "text"
            }
          ],
          "groupBy": [
            {
              "direction": "asc",
              "fieldName": "text"
            }
          ],
          "search": "text",
          "sort": {
            "direction": "asc",
            "fieldName": "text"
          },
          "viewType": "Calendar"
        },
        "w": 1,
        "x": 1,
        "y": 1
      }
    ],
    "paperHeight": 1,
    "paperWidth": 1,
    "printAttachments": true,
    "tableName": "text"
  }
}

Print a report

post

Renders a report for a record (or a merged run across several) as a PDF

Autorisierungen
AuthorizationstringErforderlich

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Pfadparameter
reportIdstring · min: 12 · max: 12Erforderlich

Report ID

Example: a1b2c3d4e5f6Pattern: ^[a-z0-9]+$
workspaceIdstring · min: 12 · max: 12Erforderlich

Workspace ID

Example: 5rdco4s18swuPattern: ^[a-z0-9]+$
Body
rowIdinteger · min: 1 · max: 9007199254740991Erforderlich

Record to render the report for

rowIdsinteger[] · max: 249Optional

Additional records to render into the same document (a merged print run). rowId is always included alongside these, so rowId plus rowIds together may not exceed 250 records.

Antworten
200

Report rendered successfully

application/json
post/api/v1/workspace/{workspaceId}/reports/{reportId}/print
POST /api/v1/workspace/{workspaceId}/reports/{reportId}/print HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "rowId": 1,
  "rowIds": [
    1
  ]
}
{
  "data": {
    "fileName": "text",
    "mimeType": "text",
    "url": "text"
  }
}
VorherigeGlobal Functions
NächsteRecords

Zuletzt aktualisiert

War das hilfreich?