Kibo Commerce Views API

openapi: 3.2.0
info:
  title: Kibo Commerce Views API
  version: '1.0'
  description: 'Operations tagged Views across 2 of this provider''s published API definitions: openapi_openapi_content.json, kibo-commerce-content-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Kibo Base URL
  url: '{baseUrl}/api'
  variables:
    baseUrl:
      default: https://t1000000.sb.usc1.gcp.kibocommerce.com
      description: Base URL
security:
- bearerAuth: []
tags:
- name: Views
paths:
  /content/documentlists/{documentListName}/views/{viewName}/documents:
    get:
      description: 'When fullSearch is `true`, performs an exhaustive search to ensure all matching

        documents are returned. May be slower on very large lists. Returns HTTP 400 if the document list exceeds

        the configured maximum size (default 100,000). Defaults to `false`, which performs a faster search

        optimized for recently updated documents.'
      parameters:
      - in: path
        name: documentListName
        required: true
        schema:
          type: string
      - in: path
        name: viewName
        required: true
        schema:
          type: string
      - in: query
        name: filter
        schema:
          type: string
      - in: query
        name: sortBy
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          format: int32
          type: integer
      - in: query
        name: startIndex
        schema:
          format: int32
          type: integer
      - in: query
        name: includeInactive
        schema:
          type: boolean
      - description: 'When `true`, performs an exhaustive search guaranteeing all matching documents are returned.

          Slower than the default on large lists. Returns HTTP 400 if the document list exceeds the configured

          maximum size threshold (default 100,000). Defaults to `false`, optimizing for speed.'
        in: query
        name: fullSearch
        schema:
          default: false
          type: boolean
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentCollection'
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentCollection'
          description: OK
      summary: Get View Documents
      tags:
      - Views
      operationId: getContentDocumentlistsByDocumentListNameViewsByViewNameDocuments
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
components:
  schemas:
    DocumentCollection:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Document'
          type:
          - array
          - 'null'
        pageCount:
          format: int32
          type: integer
        pageSize:
          format: int32
          type: integer
        startIndex:
          format: int32
          type: integer
        subPaths:
          items:
            type: string
          readOnly: true
          type:
          - array
          - 'null'
        totalCount:
          format: int32
          type: integer
      type: object
    ActiveDateRange:
      properties:
        endDate:
          description: The end of the active date range for this document
          format: date-time
          type:
          - string
          - 'null'
        startDate:
          description: The beginning of the active date range of this document
          format: date-time
          type:
          - string
          - 'null'
      type: object
    Document:
      description: 'Container for schema-enforced and schemaless data. A document is primarily used to store content (html, text,

        numbers, dates, JSON, binary data) that is directly or indirectly used for the storefront website experience

        and may be addressed via the Hypr theming engine language. A document belongs to a documentList and has an

        underlying documentType.  The documentType describes any required and optional schema. Additionally, a binary

        object may be stored on the document''s content subresource and edge cached via the Mozu CDN.'
      properties:
        activeDateRange:
          $ref: '#/components/schemas/ActiveDateRange'
        contentLength:
          description: 'The size of the content subresource in decimal number of OCTETs.

            When updating the content subresource, the  contentLength is captured from the

            Content-Length header, if present, or is otherwise computed from the total size of the http body.'
          format: int64
          type:
          - integer
          - 'null'
        contentMimeType:
          description: 'The mime type of the document''s binary content, provided via the Content-Type header when updating the content

            subresource. If no value is provided then "application/octet-stream" is set by default.'
          type:
          - string
          - 'null'
        contentUpdateDate:
          description: 'The date and time the most recent content update was made via the content subresource. UTC date/time.

            System-supplied and read-only.'
          format: date-time
          type:
          - string
          - 'null'
        documentTypeFQN:
          description: 'The full name of the documentType that underlies this document.

            This field must be supplied upon document creation and cannot be updated.'
          type:
          - string
          - 'null'
        extension:
          description: If applicable, the file extension associated with the document content.
          type:
          - string
          - 'null'
        id:
          description: Read-only, system generated 32 digit alpha-numeric string that uniquely identifies the document.
          readOnly: true
          type:
          - string
          - 'null'
        insertDate:
          description: The date and time the document was added to the documentList. This field is system-supplied and read-only.
          format: date-time
          type:
          - string
          - 'null'
        listFQN:
          description: 'The fully qualified name of the documentList to which the document belongs.

            This field is read-only and represents which documentList the document is created in.'
          type:
          - string
          - 'null'
        name:
          description: 'The fully qualified name of the document including path.

            Unique within the documentList. This field is a required field, but it can be updated.'
          type:
          - string
          - 'null'
        path:
          description: ReadOnly, path portion of the Name property.
          readOnly: true
          type:
          - string
          - 'null'
        properties:
          description: 'A JSON object of name/value pairs. Name parts are matched against the underlying documentType properties names. Any

            matching name parts must have a value part that conforms to the matching property schema.

            Any non-matching name/value pairs are considered dynamic schema and may have a value part of valid JSON.

            The properties field can be used for sorting/filtering and can be projected in the documents returned within a

            documentList view.'
        publishSetCode:
          description: The name of the publish set that this document belongs to, if any.
          type:
          - string
          - 'null'
        publishState:
          description: 'The current publish status of the document. If publishing is not supported or is currently disabled in the

            documentList then the value will be "active".

            If publishing is supported and enabled, then the publish state may be "draft" or "active". A document may have both

            an "active" and "draft" version. The publishState

            denotes which version of the document being interacted with. This field is read-only.'
          type:
          - string
          - 'null'
        updateDate:
          description: 'The date and time the most recent document update was made. If publishing is enabled, then this value will

            represent

            the last draft update if the publishState is draft, or the last publish date if the publishState is active.'
          format: date-time
          type:
          - string
          - 'null'
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: JWT Authorization header using the Bearer scheme.
      scheme: bearer
      type: http
x-refined-from:
- openapi_openapi_content.json
- kibo-commerce-content-openapi.yml
x-provenance:
  method: harvested
  publisher: Kibo Commerce
  source: https://docs.kibocommerce.com/openapi/openapi_content.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)