openapi: 3.2.0
info:
  contact: {}
  title: Infoworks Rest API V3 User Notification Subscribe API
  version: '1.0'
  description: Infoworks Rest API V3
servers:
- url: '{protocol}://{host}:{port}/v3'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    host:
      default: localhost
    port:
      default: '3001'
tags:
- name: User Notification Subscribe
paths:
  /notification/{entity_type}/{entity_id}/subscribers:
    parameters:
    - name: entity_type
      in: path
      description: entity_type
      required: true
      schema:
        type: string
    - name: entity_id
      in: path
      description: entity_id
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      summary: Get Entity Subscriber
      description: Get Entity Subscriber
      operationId: list Entity Subscriber
      tags:
      - User Notification Subscribe
      parameters:
      - name: offset
        in: query
        description: The number of items to skip before starting to collect the result set
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: The numbers of items to return
        schema:
          type: integer
          default: 10
      - name: sort_by
        in: query
        description: Sort result on field
        schema:
          type: string
      - name: order_by
        in: query
        description: order  ascending | descending
        schema:
          type: string
          default: asc
          enum:
          - asc
          - desc
      - name: filter
        in: query
        description: Filter results query
        schema:
          type: string
      responses:
        '200':
          description: List of User Notification Subscribe.
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: successfully posted
                    result:
                      type: object
                      properties:
                        status:
                          type: number
                        result:
                          type: object
                          properties:
                            entity_id:
                              example: da2zd253f7417a1g274e6e01
                            entity_type:
                              type: string
                              example: source
                            users:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: 6707acc7d292612e3dd9c129
                                  type:
                                    type: string
                                    example: external
                                  notify_events:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        event_job_type:
                                          type: string
                                          example: fetch_metadata
                                        notify_on:
                                          type: array
                                          items:
                                            type: string
                                            example: SUCCESS
                                  notify_via:
                                    type: array
                                    items:
                                      type: string
                                      example: EMAIL
                                  updated_by:
                                    type: string
                                    example: qmekmfrt
                                  updated_at:
                                    type: number
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
    post:
      security:
      - BearerAuth: []
      summary: Update Entity Subscriber
      description: Update Entity Subscriber
      operationId: Update Entity Subscriber
      tags:
      - User Notification Subscribe
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - type: object
                properties:
                  entity_id:
                    type: string
                    example: da2zd253f7417a1g274e6e01
                  entity_type:
                    type: string
                    example: source
                  users:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 6707acc7d292612e3dd9c129
                        type:
                          type: string
                          example: external
                        notify_via:
                          type: array
                          items:
                            type: string
                            example: EMAIL
                        notify_events:
                          type: array
                          items:
                            type: object
                            properties:
                              event_job_type:
                                type: string
                                example: fetch_metadata
                              notify_on:
                                type: array
                                items:
                                  type: string
                                  example: SUCCESS
      responses:
        '200':
          description: List of User Notification Subscribe.
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: successfully posted
                    result:
                      type: object
                      properties:
                        status:
                          type: number
                        result:
                          type: object
                          properties:
                            entity_id:
                              example: da2zd253f7417a1g274e6e01
                            entity_type:
                              type: string
                              example: source
                            users:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: 6707acc7d292612e3dd9c129
                                  type:
                                    type: string
                                    example: external
                                  notify_events:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        event_job_type:
                                          type: string
                                          example: fetch_metadata
                                        notify_on:
                                          type: array
                                          items:
                                            type: string
                                            example: SUCCESS
                                  notify_via:
                                    type: array
                                    items:
                                      type: string
                                      example: EMAIL
                                  updated_by:
                                    type: string
                                    example: qmekmfrt
                                  updated_at:
                                    type: number
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
  /notification/subscribe:
    post:
      security:
      - BearerAuth: []
      summary: Subscribe Notification
      description: Subscribe Notification
      operationId: Subscribe Notification
      tags:
      - User Notification Subscribe
      parameters:
      - name: offset
        in: query
        description: The number of items to skip before starting to collect the result set
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: The numbers of items to return
        schema:
          type: integer
          default: 10
      - name: sort_by
        in: query
        description: Sort result on field
        schema:
          type: string
      - name: order_by
        in: query
        description: order  ascending | descending
        schema:
          type: string
          default: asc
          enum:
          - asc
          - desc
      - name: filter
        in: query
        description: Filter results query
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - type: object
                properties:
                  entity_id:
                    type: string
                    example: da2zd253f7417a1g274e6e01
                  entity_type:
                    type: string
                    example: source
                  users:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 6707acc7d292612e3dd9c129
                        type:
                          type: string
                          example: external
                        notify_via:
                          type: array
                          items:
                            type: string
                            example: EMAIL
                        notify_events:
                          type: array
                          items:
                            type: object
                            properties:
                              event_job_type:
                                type: string
                                example: fetch_metadata
                              notify_on:
                                type: array
                                items:
                                  type: string
                                  example: SUCCESS
      responses:
        '200':
          description: List of User Aggregate.
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  properties:
                    message:
                      type: string
                    result:
                      type: object
                      properties:
                        status:
                          type: number
                        result:
                          type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
  /notification/unsubscribe:
    put:
      security:
      - BearerAuth: []
      summary: Unsubscribe Notification
      description: Unsubscribe Notification
      operationId: Unsubscribe Notification
      tags:
      - User Notification Subscribe
      parameters:
      - name: offset
        in: query
        description: The number of items to skip before starting to collect the result set
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: The numbers of items to return
        schema:
          type: integer
          default: 10
      - name: sort_by
        in: query
        description: Sort result on field
        schema:
          type: string
      - name: order_by
        in: query
        description: order  ascending | descending
        schema:
          type: string
          default: asc
          enum:
          - asc
          - desc
      - name: filter
        in: query
        description: Filter results query
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - type: object
                properties:
                  entity_id:
                    type: string
                  entity_type:
                    type: string
                  user:
                    type: object
                    properties:
                      id:
                        type: string
                      type:
                        type: string
      responses:
        '200':
          description: List of Job Status Response.
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  properties:
                    message:
                      type: string
                    result:
                      type: object
                      properties:
                        status:
                          type: number
                        result:
                          type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    BasicAuth:
      type: http
      scheme: basic