Arduino compact_triggers_v1 API

openapi: 3.0.3
info:
  description: Provides a set of endpoints to manage Devices, Things, Properties and Timeseries
  title: Arduino IoT Cloud binaries_v2 compact_triggers_v1 API
  version: '2.0'
tags:
- name: compact_triggers_v1
paths:
  /iot/v1/compact_triggers:
    get:
      description: Returns the list of triggers in a compact format
      operationId: compact_triggers_v1#listCompact
      parameters:
      - description: Filter by deletion date
        in: query
        name: deleted_after
        schema:
          type: string
      - description: Filter only the desired things
        in: query
        name: ids
        schema:
          items:
            type: string
          type: array
      - description: Filter by a string contained in the name
        in: query
        name: name_filter
        schema:
          type: string
      - description: If true, shows the soft deleted things
        in: query
        name: show_deleted
        schema:
          default: false
          type: boolean
      - in: header
        name: X-Organization
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.arduino.compact_trigger+json; type=collection:
              schema:
                $ref: '#/components/schemas/ArduinoCompact_triggerCollection'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/ArduinoCompact_triggerCollection'
          description: OK
        '400':
          content:
            application/vnd.arduino.compact_trigger+json; type=collection:
              schema:
                $ref: '#/components/schemas/error'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Bad Request
        '401':
          content:
            application/vnd.arduino.compact_trigger+json; type=collection:
              schema:
                $ref: '#/components/schemas/error'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized
        '404':
          content:
            application/vnd.arduino.compact_trigger+json; type=collection:
              schema:
                $ref: '#/components/schemas/error'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Not Found
        '500':
          content:
            application/vnd.arduino.compact_trigger+json; type=collection:
              schema:
                $ref: '#/components/schemas/error'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Internal Server Error
      security:
      - oauth2: []
      summary: listCompact compact_triggers_v1
      tags:
      - compact_triggers_v1
components:
  schemas:
    variable:
      properties:
        attribute:
          description: The template expression that extracts the value from the respective entity
          enum:
          - ID
          - NAME
          - VALUE
          - TIMESTAMP
          - USERNAME
          - EMAIL
          - STATUS
          example: PROPERTY
          type: string
        entity:
          description: Type of the entity being referenced
          enum:
          - RECIPIENT
          - USER
          - DEVICE
          - THING
          - PROPERTY
          - TRIGGERING_DEVICE
          example: PROPERTY
          type: string
        id:
          description: The ID of the referenced entity
          format: uuid
          type: string
        placeholder:
          description: Name of the variable as referenced by the expression
          type: string
        property_id:
          description: The ID of the property referenced entity
          type: string
        thing_id:
          description: The ID of the thing referenced entity
          type: string
      required:
      - placeholder
      - entity
      - attribute
      title: variable
      type: object
    ArduinoCompact_trigger:
      description: ArduinoCompact_trigger media type (default view)
      properties:
        actions:
          description: A list of actions associated with the trigger
          items:
            $ref: '#/components/schemas/ArduinoAction'
          type: array
        active:
          description: Is true if the trigger is enabled
          type: boolean
        created_at:
          description: Creation date of the trigger
          format: date-time
          type: string
        deleted_at:
          description: Deletion date of the trigger
          format: date-time
          type: string
        description:
          description: The description of the trigger
          type: string
        device_status_source:
          $ref: '#/components/schemas/device_status_source'
        id:
          description: The id of the trigger
          format: uuid
          type: string
        name:
          description: The name of the trigger
          type: string
        organization_id:
          description: Id of the organization the trigger belongs to
          format: uuid
          type: string
        property_id:
          description: Id of the property the trigger is associated to (mutually exclusive with 'device_status_source')
          format: uuid
          type: string
        updated_at:
          description: Update date of the trigger
          format: date-time
          type: string
        user_id:
          description: Id of the user who created the trigger
          format: uuid
          type: string
      required:
      - name
      title: 'Mediatype identifier: application/vnd.arduino.compact_trigger+json; view=default'
      type: object
    push_delivery_opts:
      properties:
        to:
          description: The recipient of a push notification
          items:
            $ref: '#/components/schemas/user_recipient'
          minItems: 1
          type: array
      required:
      - to
      title: push_delivery_opts
      type: object
    error:
      description: Error response media type (default view)
      properties:
        code:
          description: an application-specific error code, expressed as a string value.
          example: invalid_value
          type: string
        detail:
          description: a human-readable explanation specific to this occurrence of the problem.
          example: Value of ID must be an integer
          type: string
        id:
          description: a unique identifier for this particular occurrence of the problem.
          example: 3F1FKVRR
          type: string
        meta:
          additionalProperties: true
          description: a meta object containing non-standard meta-information about the error.
          example:
            timestamp: 1458609066
          type: object
        status:
          description: the HTTP status code applicable to this problem, expressed as a string value.
          example: '400'
          type: string
      title: 'Mediatype identifier: application/vnd.goa.error+json; view=default'
      type: object
    body_expression:
      properties:
        expression:
          description: Content of the body of a message, variables are allowed
          maxLength: 1000
          type: string
        variables:
          description: Variables used by the expression
          items:
            $ref: '#/components/schemas/variable'
          type: array
      required:
      - expression
      title: body_expression
      type: object
    email_delivery_opts:
      properties:
        bcc:
          description: The "bcc:" field of an e-mail
          items:
            $ref: '#/components/schemas/user_recipient'
          type: array
        cc:
          description: The "cc:" field of an e-mail
          items:
            $ref: '#/components/schemas/user_recipient'
          type: array
        to:
          description: The "to:" field of an e-mail
          items:
            $ref: '#/components/schemas/user_recipient'
          minItems: 1
          type: array
      required:
      - to
      title: email_delivery_opts
      type: object
    ArduinoAction:
      description: ArduinoAction media type (default view)
      properties:
        created_by:
          description: Id of the user who created the action
          format: uuid
          type: string
        description:
          description: The description of the action
          type: string
        email:
          $ref: '#/components/schemas/email_action'
        id:
          description: The id of the action
          format: uuid
          type: string
        kind:
          description: The kind of the action
          enum:
          - NOTIFY-EMAIL
          - NOTIFY-PUSH
          example: NOTIFY-EMAIL
          type: string
        name:
          description: The name of the action
          type: string
        organization_id:
          description: Id of the organization the trigger belongs to
          format: uuid
          type: string
        push_notification:
          $ref: '#/components/schemas/push_action'
        trigger_id:
          description: Id of the trigger the action is associated to
          format: uuid
          type: string
      title: 'Mediatype identifier: application/vnd.arduino.action+json; view=default'
      type: object
    device_status_source:
      properties:
        criteria:
          description: The matching criteria of the trigger, this allows to interpret device_ids as an inclusion or exclusion list
          enum:
          - INCLUDE
          - EXCLUDE
          type: string
        device_ids:
          description: A list of device IDs to be included in or excluded from the trigger (see criteria). Mutually exclusive with property_id.
          items:
            format: uuid
            type: string
          type: array
        grace_period_offline:
          description: Amount of seconds the trigger will wait before the device will be considered disconnected (requires 'device_id')
          maximum: 1209600
          minimum: 0
          type: integer
        grace_period_online:
          description: Amount of seconds the trigger will wait before the device will be considered connected (requires 'device_id')
          maximum: 1209600
          minimum: 0
          type: integer
      required:
      - criteria
      title: device_status_source
      type: object
    user_recipient:
      properties:
        email:
          description: The email address of the user
          type: string
        id:
          description: The id of the user
          format: uuid
          type: string
        username:
          description: The username of the user
          type: string
      required:
      - id
      title: user_recipient
      type: object
    email_action:
      properties:
        body:
          $ref: '#/components/schemas/body_expression'
        delivery:
          $ref: '#/components/schemas/email_delivery_opts'
        subject:
          $ref: '#/components/schemas/title_expression'
      required:
      - delivery
      - subject
      - body
      title: email_action
      type: object
    push_action:
      properties:
        body:
          $ref: '#/components/schemas/body_expression'
        delivery:
          $ref: '#/components/schemas/push_delivery_opts'
        title:
          $ref: '#/components/schemas/title_expression'
      required:
      - delivery
      - title
      - body
      title: push_action
      type: object
    title_expression:
      properties:
        expression:
          description: Content of the title (or subject) of a message, variables are allowed
          maxLength: 100
          type: string
        variables:
          description: Variables used by the expression
          items:
            $ref: '#/components/schemas/variable'
          type: array
      required:
      - expression
      title: title_expression
      type: object
    ArduinoCompact_triggerCollection:
      description: ArduinoCompact_triggerCollection is the media type for an array of ArduinoCompact_trigger (default view)
      items:
        $ref: '#/components/schemas/ArduinoCompact_trigger'
      title: 'Mediatype identifier: application/vnd.arduino.compact_trigger+json; type=collection; view=default'
      type: array
externalDocs:
  description: See docs on Confluence
  url: https://arduino.atlassian.net/wiki/spaces/FTWEB/pages/91160610/Arduino+IoT+Cloud