IXON Page API

The Page API from IXON — 1 operation(s) for page.

OpenAPI Specification

ixon-page-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  contact:
    name: IXON B.V.
    url: https://www.ixon.cloud/
    email: support@ixon.cloud
  description: API for the IXON Cloud Platform
  license:
    name: All Rights Reserved
    url: https://www.ixon.cloud/
  title: IXON AccessRecoverList Page API
  version: 0.1.294
servers:
- description: IXON Cloud platform server
  url: https://portal.ixon.cloud:443/api/
tags:
- name: Page
paths:
  /pages/{publicId}:
    get:
      tags:
      - Page
      summary: Page
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - type
                - data
                properties:
                  status:
                    type: string
                    default: success
                    nullable: false
                  type:
                    type: string
                    nullable: false
                  data:
                    nullable: false
                    type: object
                    properties:
                      publicId:
                        maxLength: 12
                        minLength: 12
                        nullable: false
                        type: string
                      name:
                        maxLength: 255
                        minLength: 1
                        nullable: false
                        type: string
                      applicationType:
                        enum:
                        - sheet
                        - card
                        - report
                        nullable: false
                        type: string
                      company:
                        nullable: false
                        type: object
                        properties:
                          publicId:
                            nullable: false
                            type: string
                      group:
                        nullable: true
                        type: object
                        properties:
                          publicId:
                            nullable: false
                            type: string
                      draft:
                        nullable: false
                        type: object
                        properties:
                          publicId:
                            maxLength: 12
                            minLength: 12
                            nullable: false
                            type: string
                          page:
                            nullable: false
                            type: object
                            properties:
                              publicId:
                                nullable: false
                                type: string
                          title:
                            maxLength: 255
                            minLength: 1
                            nullable: true
                            type: string
                          components:
                            type: array
                            items:
                              nullable: false
                              type: object
                              properties:
                                publicId:
                                  maxLength: 12
                                  minLength: 12
                                  nullable: false
                                  type: string
                                pageVersion:
                                  nullable: false
                                  type: object
                                  properties:
                                    publicId:
                                      nullable: false
                                      type: string
                                template:
                                  nullable: false
                                  type: object
                                  properties:
                                    publicId:
                                      nullable: false
                                      type: string
                                boundVersion:
                                  nullable: true
                                  type: object
                                  properties:
                                    template:
                                      nullable: false
                                      type: object
                                      properties:
                                        publicId:
                                          nullable: false
                                          type: string
                                    publicId:
                                      maxLength: 12
                                      minLength: 12
                                      nullable: false
                                      type: string
                                    number:
                                      maxLength: 64
                                      minLength: 1
                                      nullable: false
                                      pattern: \d+
                                      type: string
                                    mainPath:
                                      maxLength: 255
                                      minLength: 4
                                      nullable: false
                                      type: string
                                    notes:
                                      maxLength: 65535
                                      minLength: 0
                                      nullable: true
                                      type: string
                                    publishedOn:
                                      nullable: true
                                      type: string
                                      format: date-time
                                    createdOn:
                                      nullable: false
                                      type: string
                                      format: date-time
                                    createdBy:
                                      nullable: false
                                      type: object
                                      properties:
                                        publicId:
                                          maxLength: 12
                                          minLength: 12
                                          nullable: false
                                          type: string
                                        name:
                                          maxLength: 255
                                          minLength: 1
                                          nullable: false
                                          type: string
                                dimensions:
                                  oneOf:
                                  - type: object
                                    properties:
                                      type:
                                        enum:
                                        - sheet
                                        nullable: false
                                        type: string
                                      left:
                                        maximum: 11
                                        nullable: false
                                        type: integer
                                        format: int32
                                      top:
                                        maximum: 71
                                        nullable: false
                                        type: integer
                                        format: int32
                                      cols:
                                        maximum: 12
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                      rows:
                                        maximum: 72
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                      mobileHeight:
                                        maximum: 65535
                                        nullable: true
                                        type: integer
                                        format: int32
                                      mobileOrder:
                                        maximum: 65535
                                        nullable: true
                                        type: integer
                                        format: int32
                                      mobileLeft:
                                        maximum: 11
                                        nullable: true
                                        type: integer
                                        format: int32
                                      mobileCols:
                                        maximum: 12
                                        minimum: 1
                                        nullable: true
                                        type: integer
                                        format: int32
                                    required:
                                    - type
                                    - left
                                    - top
                                    - cols
                                    - rows
                                  - type: object
                                    properties:
                                      type:
                                        enum:
                                        - card
                                        nullable: false
                                        type: string
                                      height:
                                        maximum: 65535
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                      order:
                                        maximum: 65535
                                        nullable: false
                                        type: integer
                                        format: int32
                                    required:
                                    - type
                                    - height
                                    - order
                                  - type: object
                                    properties:
                                      type:
                                        enum:
                                        - report
                                        nullable: false
                                        type: string
                                      left:
                                        maximum: 7
                                        nullable: false
                                        type: integer
                                        format: int32
                                      top:
                                        maximum: 15
                                        nullable: false
                                        type: integer
                                        format: int32
                                      cols:
                                        maximum: 8
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                      rows:
                                        maximum: 16
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                    required:
                                    - type
                                    - left
                                    - top
                                    - cols
                                    - rows
                                  - type: object
                                    properties:
                                      type:
                                        enum:
                                        - report-portrait
                                        nullable: false
                                        type: string
                                      left:
                                        maximum: 5
                                        nullable: false
                                        type: integer
                                        format: int32
                                      top:
                                        maximum: 15
                                        nullable: false
                                        type: integer
                                        format: int32
                                      cols:
                                        maximum: 6
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                      rows:
                                        maximum: 16
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                    required:
                                    - type
                                    - left
                                    - top
                                    - cols
                                    - rows
                                  - type: object
                                    properties:
                                      type:
                                        enum:
                                        - report-landscape
                                        nullable: false
                                        type: string
                                      left:
                                        maximum: 7
                                        nullable: false
                                        type: integer
                                        format: int32
                                      top:
                                        maximum: 10
                                        nullable: false
                                        type: integer
                                        format: int32
                                      cols:
                                        maximum: 8
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                      rows:
                                        maximum: 11
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                    required:
                                    - type
                                    - left
                                    - top
                                    - cols
                                    - rows
                                inputs:
                                  maxLength: 16777215
                                  minLength: 0
                                  nullable: false
                                  type: string
                                pagePage:
                                  nullable: true
                                  type: object
                                  properties:
                                    publicId:
                                      maxLength: 12
                                      minLength: 12
                                      nullable: false
                                      type: string
                                    pageVersion:
                                      nullable: false
                                      type: object
                                      properties:
                                        publicId:
                                          nullable: false
                                          type: string
                                    order:
                                      maximum: 65535
                                      nullable: false
                                      type: integer
                                      format: int32
                          previewAgent:
                            nullable: true
                            type: object
                            properties:
                              publicId:
                                nullable: false
                                type: string
                          previewAsset:
                            nullable: true
                            type: object
                            properties:
                              publicId:
                                nullable: false
                                type: string
                          periodSpec:
                            maxLength: 255
                            minLength: 1
                            nullable: true
                            type: string
                          periodSelectorEnabled:
                            nullable: false
                            type: boolean
                          defaultRefreshRate:
                            maximum: 65535
                            nullable: true
                            type: integer
                            format: int32
                          createdOn:
                            nullable: false
                            type: string
                            format: date-time
                          createdBy:
                            nullable: true
                            type: object
                            properties:
                              publicId:
                                maxLength: 12
                                minLength: 12
                                nullable: false
                                type: string
                              name:
                                maxLength: 255
                                minLength: 1
                                nullable: false
                                type: string
                          updatedOn:
                            nullable: true
                            type: string
                            format: date-time
                          updatedBy:
                            nullable: true
                            type: object
                            properties:
                              publicId:
                                maxLength: 12
                                minLength: 12
                                nullable: false
                                type: string
                              name:
                                maxLength: 255
                                minLength: 1
                                nullable: false
                                type: string
                          pagePages:
                            type: array
                            items:
                              nullable: false
                              type: object
                              properties:
                                publicId:
                                  maxLength: 12
                                  minLength: 12
                                  nullable: false
                                  type: string
                                pageVersion:
                                  nullable: false
                                  type: object
                                  properties:
                                    publicId:
                                      nullable: false
                                      type: string
                                order:
                                  maximum: 65535
                                  nullable: false
                                  type: integer
                                  format: int32
                          custom:
                            nullable: false
                            type: object
                      published:
                        nullable: false
                        type: object
                        properties:
                          publicId:
                            maxLength: 12
                            minLength: 12
                            nullable: false
                            type: string
                          page:
                            nullable: false
                            type: object
                            properties:
                              publicId:
                                nullable: false
                                type: string
                          title:
                            maxLength: 255
                            minLength: 1
                            nullable: true
                            type: string
                          components:
                            type: array
                            items:
                              nullable: false
                              type: object
                              properties:
                                publicId:
                                  maxLength: 12
                                  minLength: 12
                                  nullable: false
                                  type: string
                                pageVersion:
                                  nullable: false
                                  type: object
                                  properties:
                                    publicId:
                                      nullable: false
                                      type: string
                                template:
                                  nullable: false
                                  type: object
                                  properties:
                                    publicId:
                                      nullable: false
                                      type: string
                                boundVersion:
                                  nullable: true
                                  type: object
                                  properties:
                                    template:
                                      nullable: false
                                      type: object
                                      properties:
                                        publicId:
                                          nullable: false
                                          type: string
                                    publicId:
                                      maxLength: 12
                                      minLength: 12
                                      nullable: false
                                      type: string
                                    number:
                                      maxLength: 64
                                      minLength: 1
                                      nullable: false
                                      pattern: \d+
                                      type: string
                                    mainPath:
                                      maxLength: 255
                                      minLength: 4
                                      nullable: false
                                      type: string
                                    notes:
                                      maxLength: 65535
                                      minLength: 0
                                      nullable: true
                                      type: string
                                    publishedOn:
                                      nullable: true
                                      type: string
                                      format: date-time
                                    createdOn:
                                      nullable: false
                                      type: string
                                      format: date-time
                                    createdBy:
                                      nullable: false
                                      type: object
                                      properties:
                                        publicId:
                                          maxLength: 12
                                          minLength: 12
                                          nullable: false
                                          type: string
                                        name:
                                          maxLength: 255
                                          minLength: 1
                                          nullable: false
                                          type: string
                                dimensions:
                                  oneOf:
                                  - type: object
                                    properties:
                                      type:
                                        enum:
                                        - sheet
                                        nullable: false
                                        type: string
                                      left:
                                        maximum: 11
                                        nullable: false
                                        type: integer
                                        format: int32
                                      top:
                                        maximum: 71
                                        nullable: false
                                        type: integer
                                        format: int32
                                      cols:
                                        maximum: 12
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                      rows:
                                        maximum: 72
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                      mobileHeight:
                                        maximum: 65535
                                        nullable: true
                                        type: integer
                                        format: int32
                                      mobileOrder:
                                        maximum: 65535
                                        nullable: true
                                        type: integer
                                        format: int32
                                      mobileLeft:
                                        maximum: 11
                                        nullable: true
                                        type: integer
                                        format: int32
                                      mobileCols:
                                        maximum: 12
                                        minimum: 1
                                        nullable: true
                                        type: integer
                                        format: int32
                                    required:
                                    - type
                                    - left
                                    - top
                                    - cols
                                    - rows
                                  - type: object
                                    properties:
                                      type:
                                        enum:
                                        - card
                                        nullable: false
                                        type: string
                                      height:
                                        maximum: 65535
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                      order:
                                        maximum: 65535
                                        nullable: false
                                        type: integer
                                        format: int32
                                    required:
                                    - type
                                    - height
                                    - order
                                  - type: object
                                    properties:
                                      type:
                                        enum:
                                        - report
                                        nullable: false
                                        type: string
                                      left:
                                        maximum: 7
                                        nullable: false
                                        type: integer
                                        format: int32
                                      top:
                                        maximum: 15
                                        nullable: false
                                        type: integer
                                        format: int32
                                      cols:
                                        maximum: 8
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                      rows:
                                        maximum: 16
                                        minimum: 1
                                        nullable: false
                                        type: integer
                                        format: int32
                                    required:
                                    - type
                                    - left
                                    - top
                                    - cols
                                    - rows
                                  - type: object
                                    properties:
                                      type:
                                        enum:
                                        - report-portrait
                                        nullable: false
                                        type: string
                                      left:
                                        maximum: 5
                                        nullable: false
                                        type: integer
                                        format: int32
                                      top:
                     

# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ixon/refs/heads/main/openapi/ixon-page-api-openapi.yml