openapi: 3.0.0
info:
  title: VisibilityIQ Application Health
  version: 1.0.1
servers:
- url: https://api.zebra.com/v3/data/visibility/application
  description: For US
- url: https://api.zebra.com/v3/eu/data/visibility/application
  description: For EU
security:
- BearerAuth: []
- ApiKeyAuth: []
paths:
  /missing:
    get:
      tags:
      - Application Health
      summary: Retrieves missing applications whose type is Business
      description: Retrieves <i>missing</i> applications for a company-partner combination
        within a given date and time range. <i>Missing</i> application represent that
        missing apps are the apps that are not available on the device and the appCategory
        is of Business.
      operationId: Retrieve Missing Applications
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: startDatetime
        in: header
        description: ISO timestamp for the start of the time period in which data
          is retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDatetime
        in: header
        description: ISO timestamp for the end of the time period in which data is
          fetched. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 20000. Values higher
          than 20000 will be replaced with 20000. Values less than 1 will be replaced
          with 250. '
        required: false
        schema:
          type: integer
          default: 250
      - name: sort
        in: header
        description: |-
          Sort order for the results.  Specified as a JSON object. Currently, only one sort order is supported in the criteria even though it is an array.  Elements other than the first one will be ignored currently. In the object, a stands for attribute and o for order.
            {
              "criteria": [
                {
                  "a": "appName",
                  "o": "asc"
                }
              ]
            }
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MissingAppSortCriteria'
      - name: filter
        in: header
        description: |-
          Filter based on column values. Numeric value will be filtered by an exact match and also by using relational operators such as <,>,==,<=,>= . Strings will be filtered by partial matches and exact matches by using == relational operator and are case insensitive matches. Filter opeartor and filter values are sepearted by "|".  The filter criteria are ANDed together. Example
          {
            "serialNum":"==|A5XXX1",
            "appName":"Bluetooth Pairing Utility"
          }
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MissingAppFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MissingAppApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
  /updates:
    get:
      tags:
      - Application Health
      summary: Retrieves applications/devices information that requires version update
      description: Retrieves applications/devices information provided by Application
        Versions Insight
      operationId: Retrieves applications/devices information
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: startDatetime
        in: header
        description: ISO timestamp for the start of the time period in which data
          is retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDatetime
        in: header
        description: ISO timestamp for the end of the time period in which data is
          fetched. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 20000. Values higher
          than 20000 will be replaced with 20000. Values less than 1 will be replaced
          with 250. '
        required: false
        schema:
          type: integer
          default: 250
      - name: sort
        in: header
        description: |-
          Sort order for the results.  Specified as a JSON object. Currently, only one sort order is supported in the criteria even though it is an array.  Elements other than the first one will be ignored currently. In the object, a stands for attribute and o for order.
            {
              "criteria": [
                {
                  "a": "appName",
                  "o": "asc"
                }
              ]
            }
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppVersionSortCriteria'
      - name: filter
        in: header
        description: |-
          Filter based on column values. Numeric value will be filtered by an exact match and also by using relational operators such as <,>,==,<=,>= . Strings will be filtered by partial matches and exact matches by using == relational operator and are case insensitive matches. Filter opeartor and filter values are sepearted by "|".  The filter criteria are ANDed together. Example
          {
            "serialNum":"==|A5XXX1",
            "appName":"Bluetooth Pairing Utility"
          }
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppVersionFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationVersionApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
  /anr:
    get:
      tags:
      - Application Health
      summary: Retrieves information of applications not responding
      description: Retrieves <i>ANR</i> information for a company-partner combination
        within a given date and time range. <i>ANR</i> represent that the apps that
        are not responding on the device.
      operationId: Retrieves ANRs Information
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: startDatetime
        in: header
        description: ISO timestamp for the start of the time period in which data
          is retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDatetime
        in: header
        description: ISO timestamp for the end of the time period in which data is
          fetched. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 20000. Values higher
          than 20000 will be replaced with 20000. Values less than 1 will be replaced
          with 250. '
        required: false
        schema:
          type: integer
          default: 250
      - name: sort
        in: header
        description: |-
          Sort order for the results.  Specified as a JSON object. Currently, only one sort order is supported in the criteria even though it is an array.  Elements other than the first one will be ignored currently. In the object, a stands for attribute and o for order.
            {
              "criteria": [
                {
                  "a": "appName",
                  "o": "asc"
                }
              ]
            }
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ANRSortCriteria'
      - name: filter
        in: header
        description: |-
          Filter based on column values. Numeric value will be filtered by an exact match and also by using relational operators such as <,>,==,<=,>= . Strings will be filtered by exact matches by using == relational operator and are case insensitive matches. Filter opeartor and filter values are sepearted by "|".  The filter criteria are ANDed together. Example
           {
             "appName": "Application 1",
             "serialNum": "==|SN-DEMO-0001",
             "anrCount": "<|4",
             "anrThreshold": ">=|2.0"
           }
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ANRFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ANRAppApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
  /extra:
    get:
      tags:
      - Application Health
      summary: Retrieves extra applications whose type is NonBusiness
      description: Retrieves <i>extra</i> applications for a company-partner combination
        within a given date and time range. <i>Extra</i> application represent that
        extra apps are the apps that are available on the device and the appType is
        of Non Business.
      operationId: Retrieve Extra Applications
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: startDatetime
        in: header
        description: ISO timestamp for the start of the time period in which data
          is retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDatetime
        in: header
        description: ISO timestamp for the end of the time period in which data is
          fetched. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 20000. Values higher
          than 20000 will be replaced with 20000. Values less than 1 will be replaced
          with 250. '
        required: false
        schema:
          type: integer
          default: 250
      - name: sort
        in: header
        description: |-
          Sort order for the results.  Specified as a JSON object. Currently, only one sort order is supported in the criteria even though it is an array.  Elements other than the first one will be ignored currently. In the object, a stands for attribute and o for order.
            {
              "criteria": [
                {
                  "a": "appName",
                  "o": "asc"
                }
              ]
            }
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtraAppSortCriteria'
      - name: filter
        in: header
        description: |-
          Filter based on column values. Numeric value will be filtered by an exact match and also by using relational operators such as <,>,==,<=,>= . Strings will be filtered by partial matches and exact matches by using == relational operator and are case insensitive matches. Filter opeartor and filter values are sepearted by "|".  The filter criteria are ANDed together. Example
          {
            "serialNum":"==|A5XXX1",
            "appName":"Bluetooth Pairing Utility"
          }
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtraAppFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtraAppApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
components:
  schemas:
    ApplicationVersionApiResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
        data:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/ApplicationVersion'
        links:
          $ref: '#/components/schemas/ApiResponseLinks'
    MissingAppApiResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
        data:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/MissingApp'
        links:
          $ref: '#/components/schemas/ApiResponseLinks'
    ANRAppApiResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
        data:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/ANRApp'
        links:
          $ref: '#/components/schemas/ApiResponseLinks'
    ExtraAppApiResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
        data:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/ExtraApp'
        links:
          $ref: '#/components/schemas/ApiResponseLinks'
    ApiResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
        data:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/MissingApp'
            - $ref: '#/components/schemas/ApplicationVersion'
            - $ref: '#/components/schemas/ANRApp'
            - $ref: '#/components/schemas/ExtraApp'
        links:
          $ref: '#/components/schemas/ApiResponseLinks'
    ApiError:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for this particular occurrence of the problem
        links:
          type: object
          properties:
            about:
              type: string
              description: A link that leads to further details about this particular
                occurrence of the problem
          description: Links providing information related to this error
        status:
          type: integer
          description: The HTTP status code applicable to this problem
          format: int32
        code:
          type: string
          description: An application-specific error code, expressed as a string value
        title:
          type: string
          description: A short, human-readable summary of the problem that SHOULD
            NOT change from occurrence to occurrence of the problem, except for purposes
            of localization
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of
            the problem. Like title, this field’s value can be localized
        source:
          type: object
          properties:
            pointer:
              type: string
              description: A JSON Pointer [RFC6901] to the associated entity in the
                request document [e.g. "/data" for a primary data object, or "/data/attributes/title"
                for a specific attribute]
            parameter:
              type: string
              description: A string indicating which URI query parameter caused the
                error
          description: An object containing references to the source of the error
        meta:
          type: object
          description: A meta object containing non-standard meta-information about
            the error
    MissingAppSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - appVersion
                - siteName
                - model
                - appCategory
                - appName
                - serialNum
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    MissingAppFilterCriteria:
      type: object
      properties:
        appVersion:
          type: string
        siteName:
          type: string
        model:
          type: string
        appCategory:
          type: string
        appName:
          type: string
        serialNum:
          type: string
    MissingApp:
      type: object
      properties:
        appVersion:
          type: string
        siteName:
          type: string
        model:
          type: string
        appCategory:
          type: string
        appName:
          type: string
        serialNum:
          type: string
      example:
        appVersion: "3.26"
        siteName: 123 Store
        model: TXXXXX
        appCategory: Business
        appName: Bluetooth Pairing Utility
        serialNum: "12312312312381"
    ApplicationVersion:
      type: object
      properties:
        mostInstalledVersion:
          type: string
        siteName:
          type: string
        model:
          type: string
          example: PS20J
        appName:
          type: string
        serialNum:
          type: string
        currentVersion:
          type: string
      example:
        mostInstalledVersion: 1.1.0
        siteName: 2268 0185 WILLYS AVESTA DALAHÄSTEN
        model: PS20J
        appName: Bakgrundsväljare
        currentVersion: "9"
        serialNum: "20143521400071"
    AppVersionSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - mostInstalledVersion
                - siteName
                - model
                - appName
                - currentVersion
                - serialNum
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    AppVersionFilterCriteria:
      type: object
      properties:
        mostInstalledVersion:
          type: string
        siteName:
          type: string
        model:
          type: string
        appName:
          type: string
        currentVersion:
          type: string
        serialNum:
          type: string
    ANRSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - appName
                - siteName
                - serialNum
                - appVersion
                - model
                - anrCount
                - anrThreshold
                - deviation
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    ANRFilterCriteria:
      type: object
      properties:
        appVersion:
          type: string
        siteName:
          type: string
        model:
          type: string
        appName:
          type: string
        serialNum:
          type: string
        anrCount:
          type: string
        anrThreshold:
          type: string
        deviation:
          type: string
    ANRApp:
      type: object
      properties:
        appVersion:
          type: string
        siteName:
          type: string
        model:
          type: string
        appName:
          type: string
        serialNum:
          type: string
        anrCount:
          type: integer
        anrThreshold:
          type: number
          format: float
        deviation:
          type: number
          format: float
      example:
        appVersion: "1.01"
        siteName: 123 Store
        model: TXXXXX
        appName: Bluetooth Pairing Utility
        serialNum: "12312312312381"
        anrCount: 1
        anrThreshold: 1.5
        deviation: 1.25
    ExtraAppSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - siteName
                - appName
                - serialNum
                - appVersion
                - model
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    ExtraAppFilterCriteria:
      type: object
      properties:
        appVersion:
          type: string
        siteName:
          type: string
        model:
          type: string
        appName:
          type: string
        serialNum:
          type: string
    ExtraApp:
      type: object
      properties:
        appVersion:
          type: string
        siteName:
          type: string
        model:
          type: string
        appName:
          type: string
        serialNum:
          type: string
      example:
        appVersion: "1.01"
        siteName: 123 Store
        model: TXXXXX
        appName: Bluetooth Pairing Utility
        serialNum: "12312312312381"
    ApiResponseStatus:
      type: integer
      description: The HTTP status code
      format: int32
    ApiResponseMeta:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for this request
        total:
          type: integer
          description: The total number of results
        offset:
          type: integer
          description: The offset used in this request
        limit:
          type: integer
          description: The effective limit used in this request
    ApiResponseLinks:
      type: object
      properties:
        self:
          type: string
          description: URL to this page
        first:
          type: string
          description: URL to the first page
        last:
          type: string
          description: URL to the last page
        prev:
          type: string
          description: URL to the previous page
        next:
          type: string
          description: URL to the next page
      description: Links for navigation. Only the applicable links are required to
        be present.
    DateTime:
      type: string
      format: date-time
  responses:
    Response200:
      description: Successful operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiResponse'
    Response400:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Response401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Response403:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Response500:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  parameters:
    companyName:
      name: companyName
      in: header
      description: Company name
      required: true
      schema:
        type: string
    partnerName:
      name: partnerName
      in: header
      description: Partner name
      required: true
      schema:
        type: string
    startDatetime:
      name: startDatetime
      in: header
      description: ISO timestamp for the start of the time period in which data is
        retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
      required: true
      schema:
        $ref: '#/components/schemas/DateTime'
    endDatetime:
      name: endDatetime
      in: header
      description: ISO timestamp for the end of the time period in which data is fetched.
        Example=2020-04-13T00:00:00Z
      required: true
      schema:
        $ref: '#/components/schemas/DateTime'
    offset:
      name: offset
      in: query
      description: 'Pagination parameter indicating the starting record position for
        returning the results from the result set.  Any positive value is acceptable.
        An offset bigger than the number of available results will result in an error.
        A negative value will be replaced with 0. Normally, value should be 0 or a
        positive multiple of limit. '
      required: false
      schema:
        type: integer
        default: 0
    limit:
      name: limit
      in: query
      description: 'Pagination size indicating the maximum number of results to be
        returned in the response. Valid values are 1 to 20000. Values higher than
        20000 will be replaced with 20000. Values less than 1 will be replaced with
        250. '
      required: false
      schema:
        type: integer
        default: 250
  requestBodies: {}
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
    ApiKeyAuth:
      type: apiKey
      name: X-APIKey
      in: header
  links: {}
  callbacks: {}
