IXON AgentDataAlarmOccurrence API

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 AgentDataAlarmOccurrence API
  version: 0.1.294
servers:
- description: IXON Cloud platform server
  url: https://portal.ixon.cloud:443/api/
tags:
- name: AgentDataAlarmOccurrence
paths:
  /agents/{agentId}/alarm-occurrences/{publicId}:
    get:
      tags:
      - AgentDataAlarmOccurrence
      summary: AgentDataAlarmOccurrence
      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
                      alarm:
                        nullable: false
                        type: object
                        properties:
                          publicId:
                            maxLength: 12
                            minLength: 12
                            nullable: false
                            type: string
                          agent:
                            nullable: false
                            type: object
                            properties:
                              publicId:
                                nullable: false
                                type: string
                          device:
                            nullable: true
                            type: object
                            properties:
                              publicId:
                                nullable: false
                                type: string
                          source:
                            nullable: true
                            type: object
                            properties:
                              publicId:
                                nullable: false
                                type: string
                          audience:
                            nullable: false
                            type: object
                            properties:
                              publicId:
                                nullable: false
                                type: string
                          type:
                            enum:
                            - unary
                            - boolean
                            - error_bits
                            - threshold
                            - rate_of_change
                            - bit_pattern
                            nullable: false
                            type: string
                          name:
                            maxLength: 255
                            minLength: 1
                            nullable: false
                            type: string
                          autoAcknowledge:
                            nullable: false
                            type: boolean
                          booleanNormalValue:
                            nullable: false
                            type: boolean
                          formula:
                            maxLength: 255
                            minLength: 2
                            nullable: false
                            type: string
                          offDelay:
                            maximum: 4294967295
                            nullable: false
                            type: integer
                            format: int32
                          offResetDelay:
                            maximum: 4294967295
                            nullable: false
                            type: integer
                            format: int32
                          onDelay:
                            maximum: 4294967295
                            nullable: false
                            type: integer
                            format: int32
                          onResetDelay:
                            maximum: 4294967295
                            nullable: false
                            type: integer
                            format: int32
                          operatorInstructionRtn:
                            maxLength: 65535
                            minLength: 0
                            nullable: true
                            type: string
                          outOfService:
                            nullable: false
                            type: boolean
                          severity:
                            enum:
                            - low
                            - medium
                            - high
                            nullable: false
                            type: string
                      acknowledged:
                        nullable: false
                        type: boolean
                      acknowledgedBy:
                        nullable: true
                        type: object
                        properties:
                          publicId:
                            nullable: false
                            type: string
                      acknowledgedOn:
                        nullable: true
                        type: string
                        format: date-time
                      comment:
                        maxLength: 255
                        minLength: 0
                        nullable: true
                        type: string
                      occurredOn:
                        nullable: false
                        type: string
                        format: date-time
                      rateLimitTill:
                        nullable: true
                        type: string
                        format: date-time
                      rtnOn:
                        nullable: true
                        type: string
                        format: date-time
                      silenced:
                        nullable: false
                        type: boolean
                      stillActiveOn:
                        nullable: true
                        type: string
                        format: date-time
        4XX:
          $ref: '#/components/responses/4XXErrorResponse'
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      - $ref: '#/components/parameters/apiApplication'
      - $ref: '#/components/parameters/apiCompany'
      - $ref: '#/components/parameters/apiBrandingOptional'
      - $ref: '#/components/parameters/filtersParameter'
      - $ref: '#/components/parameters/fieldsParameter'
      - required: true
        name: agentId
        in: path
        schema:
          type: string
      - required: true
        name: publicId
        in: path
        schema:
          type: string
      security:
      - bearerToken: []
    patch:
      tags:
      - AgentDataAlarmOccurrence
      summary: AgentDataAlarmOccurrence
      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:
                    type: object
                    nullable: true
        4XX:
          $ref: '#/components/responses/4XXErrorResponse'
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      - $ref: '#/components/parameters/apiApplication'
      - $ref: '#/components/parameters/apiCompany'
      - $ref: '#/components/parameters/apiBrandingOptional'
      - required: true
        name: agentId
        in: path
        schema:
          type: string
      - required: true
        name: publicId
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                acknowledged:
                  nullable: false
                  type: boolean
                comment:
                  maxLength: 255
                  minLength: 0
                  nullable: true
                  type: string
                silenced:
                  nullable: false
                  type: boolean
      security:
      - bearerToken: []
components:
  parameters:
    apiApplication:
      required: true
      description: Get your Application ID via support@ixon.cloud
      name: Api-Application
      in: header
      schema:
        type: string
        pattern: ^[0-9a-zA-Z]{12}$
    apiVersion:
      required: true
      description: Version of the API to use
      name: Api-Version
      in: header
      schema:
        type: integer
        format: int32
        enum:
        - 2
    apiBrandingOptional:
      required: false
      description: Domain that provides the branding
      name: Api-Branding
      in: header
      schema:
        type: string
        pattern: .+(\..[^.]+)
    fieldsParameter:
      required: false
      description: 'Fields to select. Use "*" for all the top-level fields. Or check the "Success response" below for other fields.


        To get the fields of a subresource do subresource.field or for multiple fields of one subresource do subresource(field,field)'
      name: fields
      in: query
      schema:
        type: array
        items:
          type: string
    filtersParameter:
      required: false
      description: 'Filter the returned item(s). Format: operator(column,val)


        Possible operators are: lt, less, lte, lessorequal, eq, equals, ne, differs, gt, greater, gte, greaterorequal, in, ni, isnull, isnotnull, between, contains.


        Example: eq(publicId,"publicId_val")'
      name: filters
      in: query
      schema:
        type: array
        items:
          type: string
    apiCompany:
      required: true
      description: PublicId of the company
      name: Api-Company
      in: header
      schema:
        type: string
        pattern: ^(\d{4}-){4}\d{4}$
  responses:
    4XXErrorResponse:
      description: 4XX error response
      content:
        application/json:
          schema:
            type: object
            required:
            - status
            - type
            - data
            properties:
              status:
                type: string
                default: error
                nullable: false
              type:
                type: string
                default: Error
                nullable: false
              data:
                nullable: false
                type: array
                items:
                  $ref: '#/components/schemas/4XXErrorSchema'
  schemas:
    4XXErrorSchema:
      type: object
      properties:
        message:
          nullable: false
          type: string
        propertyName:
          nullable: true
          type: string
        listIndex:
          nullable: true
          type: integer
          format: int32
      required:
      - message
  securitySchemes:
    bearerToken:
      type: http
      description: Bearer token created by the endpoint "POST AccessTokenList"
      scheme: bearer
x-samples-languages:
- curl
- ruby
- javascript
- python
- powershell