Box Shield Information Barrier Reports API

openapi: 3.1.0
info:
  title: Box Shield Information Barrier Reports API
  description: Needs a description.
paths:
  /shield_information_barrier_reports:
    get:
      operationId: get_shield_information_barrier_reports
      summary: Box List shield information barrier reports
      tags:
        - Shield Information Barrier Reports
      x-box-tag: shield_information_barrier_reports
      description: Lists shield information barrier reports.
      parameters:
        - name: shield_information_barrier_id
          description: The ID of the shield information barrier.
          example: '1910967'
          in: query
          required: true
          schema:
            type: string
        - name: marker
          description: >-
            Defines the position marker at which to begin returning results.
            This is

            used when paginating using marker-based pagination.


            This requires `usemarker` to be set to `true`.
          in: query
          required: false
          example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
          schema:
            type: string
        - name: limit
          description: The maximum number of items to return per page.
          in: query
          required: false
          example: 1000
          schema:
            type: integer
            format: int64
            maximum: 1000
      responses:
        '200':
          description: >-
            Returns a paginated list of shield information barrier report
            objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierReports'
        '404':
          description: >-
            Returns a `not_found` error if the Shield Information Barrier could
            not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
    post:
      operationId: post_shield_information_barrier_reports
      summary: Box Create shield information barrier report
      tags:
        - Shield Information Barrier Reports
      x-box-tag: shield_information_barrier_reports
      description: Creates a shield information barrier report for a given barrier.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShieldInformationBarrierReference'
      responses:
        '201':
          description: Returns the shield information barrier report information object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierReport'
        '404':
          description: |-
            Returns a `not_found` error if
            the shield information barrier report was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '409':
          description: |-
            Returns a `conflict` error if a
            shield information barrier report is currently being created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
  /shield_information_barrier_reports/{shield_information_barrier_report_id}:
    get:
      operationId: get_shield_information_barrier_reports_id
      summary: Box Get shield information barrier report by ID
      tags:
        - Shield Information Barrier Reports
      x-box-tag: shield_information_barrier_reports
      description: Retrieves a shield information barrier report by its ID.
      parameters:
        - name: shield_information_barrier_report_id
          description: The ID of the shield information barrier Report.
          example: '3423'
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Returns the  shield information barrier report object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShieldInformationBarrierReport'
        '404':
          description: |-
            Returns a `not_found` error if the
            shield information barrier Report was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
components:
  schemas:
    ShieldInformationBarrierReports:
      title: List of Shield Information Barrier Reports
      type: object
      x-box-resource-id: shield_information_barrier_reports
      x-box-tag: shield_information_barrier_reports
      description: A list of shield barrier reports.
      allOf:
        - type: object
          description: |-
            The part of an API response that describes marker
            based pagination
          properties:
            limit:
              description: >-
                The limit that was used for these entries. This will be the same
                as the

                `limit` query parameter unless that value exceeded the maximum
                value

                allowed. The maximum value varies by API.
              example: 1000
              type: integer
              format: int64
            next_marker:
              description: The marker for the start of the next page of results.
              example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
              type: string
              nullable: true
        - properties:
            entries:
              type: array
              description: |-
                A list of shield information
                barrier reports.
              items:
                $ref: '#/components/schemas/ShieldInformationBarrierReport'
    ClientError:
      title: Client error
      type: object
      x-box-resource-id: client_error
      description: A generic error
      properties:
        type:
          description: error
          example: error
          type: string
          enum:
            - error
          nullable: false
        status:
          description: The HTTP status of the response.
          example: 400
          type: integer
          format: int32
          nullable: false
        code:
          description: A Box-specific error code
          example: item_name_invalid
          type: string
          enum:
            - created
            - accepted
            - no_content
            - redirect
            - not_modified
            - bad_request
            - unauthorized
            - forbidden
            - not_found
            - method_not_allowed
            - conflict
            - precondition_failed
            - too_many_requests
            - internal_server_error
            - unavailable
            - item_name_invalid
            - insufficient_scope
        message:
          description: A short message describing the error.
          example: Method Not Allowed
          type: string
          nullable: false
        context_info:
          description: |-
            A free-form object that contains additional context
            about the error. The possible fields are defined on
            a per-endpoint basis. `message` is only one example.
          type: object
          nullable: true
          properties:
            message:
              type: string
              description: More details on the error.
              example: Something went wrong.
        help_url:
          description: A URL that links to more information about why this error occurred.
          example: >-
            https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
          type: string
          nullable: false
        request_id:
          description: |-
            A unique identifier for this response, which can be used
            when contacting Box support.
          type: string
          example: abcdef123456
          nullable: false
    ShieldInformationBarrierReport:
      title: Shield information barrier report
      type: object
      x-box-resource-id: shield_information_barrier_report
      x-box-tag: shield_information_barrier_reports
      x-box-variants:
        - base
        - standard
      x-box-variant: standard
      description: |-
        A standard representation
        of a shield information barrier report object
      allOf:
        - $ref: '#/components/schemas/ShieldInformationBarrierReport--Base'
        - properties:
            shield_information_barrier:
              allOf:
                - $ref: '#/components/schemas/ShieldInformationBarrierReference'
            status:
              type: string
              enum:
                - pending
                - error
                - done
                - cancelled
              description: Status of the shield information report
              example: pending
            details:
              allOf:
                - $ref: '#/components/schemas/ShieldInformationBarrierReportDetails'
            created_at:
              type: string
              format: date-time
              example: '2020-06-26T18:44:45.869Z'
              description: |-
                ISO date time string when this
                shield information barrier report object was created.
            created_by:
              allOf:
                - $ref: '#/components/schemas/User--Base'
                - description: The user who created this shield information barrier report.
            updated_at:
              type: string
              format: date-time
              example: '2020-07-26T18:44:45.869Z'
              description: |-
                ISO date time string when this
                shield information barrier report was updated.
tags:
  - name: Shield Information Barrier Reports