APIs.io Engineering Platform Collection Items API

The **Collection Items** endpoints enable you to manage a collection's items, such as folders and requests.

Documentation

Specifications

Other Resources

🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1ab188a6-cc1f-490d-9413-9c6da20918d0?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-0e94f581-cbc1-48e0-b594-1f6b3d07a328?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4517d93a-e7f7-4dc2-b572-06762bbe14de?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-88f9ddbb-3115-47dc-b6e5-7fc6f1d2a190?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-3a12caae-4945-4df4-8ab9-bb6219ba7a9f?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-863b18f0-c2f2-4e32-a5fa-0d1e6ccf77a9?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-189876d1-f207-49a2-a4bc-5c67ae78cd19?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c1e74fd9-3f84-4d95-943d-d645d6cb82f7?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b002164d-6e8a-4b6d-b409-4929476e7818?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-508660fd-30b8-4c9c-aede-8edbac8a514d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-da35e0ba-f1a9-42fe-a77a-56ff0a47e341?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-1d4df7d0-9c92-4fa8-946f-2110c2b3b48d?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-2af6f54f-d259-46c0-8f86-78856f5885cd?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-cc203f31-e7f6-42ec-ad34-c5c4cde58904?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-f19285da-48dd-4691-bbdf-f7d6bec157a3?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa69cacc-4bbf-4724-a1d4-78cdad57fee8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-a5858f86-04d3-4e15-ae11-b42c7516688b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-c2052341-766c-43c7-b1dc-ed4985e4606b?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-aa777c90-8271-4809-8eac-3ec39a9a899c?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-4d5957dc-df05-4216-a5fc-d46b3ba811d8?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-28d97617-fdba-46a5-ac3e-40f3d2e0fa57?action=share&creator=35240
🔗
PostmanCollection
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-7429b451-d812-4abc-b497-b763372cf5c5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-b0eafdd0-adaa-48a2-a855-6a31beb86d83?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-209f34ef-13c1-400c-bca8-fcddb304aff5?action=share&creator=35240
🔗
PostmanCapability
https://api-evangelist.postman.co/workspace/APIs.io-Engineering-Platform/fe320942-e505-4ee8-8b7c-d72eae00d93f/collection/35240-fb2bbbb8-d4cc-48b1-a660-c8e158bfbbea?action=share&creator=35240

OpenAPI Specification

engineering-platform-collection-items-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Collection Items API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Collection Items
  description: The **Collection Items** endpoints enable you to manage a collection's items, such as folders and requests.
paths:
  /collections/{collectionId}/folders:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    post:
      summary: APIs.io Engineering Platform Create a folder
      description: 'Creates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        You can use this endpoint to to import requests and responses into a newly-created folder. To do this, include the `requests` field and the list of request objects in the request body. For more information, see the provided example.


        **Note:**


        It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a folder with a blank name.

        '
      operationId: createCollectionFolder
      tags:
      - Collection Items
      requestBody:
        $ref: '#/components/requestBodies/createCollectionFolder'
      responses:
        '200':
          $ref: '#/components/responses/createCollectionFolder'
        '400':
          $ref: '#/components/responses/collectionFolder400Error'
        '401':
          $ref: '#/components/responses/collectionFolder401Error'
        '500':
          $ref: '#/components/responses/common500Error'
  /collections/{collectionId}/requests:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    post:
      summary: APIs.io Engineering Platform Create a request
      description: 'Creates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a request with a blank name.

        '
      operationId: createCollectionRequest
      tags:
      - Collection Items
      requestBody:
        $ref: '#/components/requestBodies/createCollectionRequest'
      responses:
        '200':
          $ref: '#/components/responses/createCollectionRequest'
        '400':
          $ref: '#/components/responses/collectionRequest400Error'
        '401':
          $ref: '#/components/responses/collectionRequest401Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/collectionRequestFolderIdQuery'
  /collections/{collectionId}/responses:
    parameters:
    - $ref: '#/components/parameters/collectionId'
    post:
      summary: APIs.io Engineering Platform Create a response
      description: 'Creates a request response in a collection. For a complete list of request body properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a response with a blank name.

        '
      operationId: createCollectionResponse
      tags:
      - Collection Items
      requestBody:
        $ref: '#/components/requestBodies/createCollectionResponse'
      responses:
        '200':
          $ref: '#/components/responses/createCollectionResponse'
        '400':
          $ref: '#/components/responses/collectionResponse400Error'
        '401':
          $ref: '#/components/responses/collectionResponse401Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/collectionResponseParentRequestId'
  /collections/{collectionId}/folders/{folderId}:
    parameters:
    - $ref: '#/components/parameters/collectionFolderId'
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get a folder
      description: Gets information about a folder in a collection.
      operationId: getCollectionFolder
      tags:
      - Collection Items
      responses:
        '200':
          $ref: '#/components/responses/getCollectionFolder'
        '401':
          $ref: '#/components/responses/collectionFolder401Error'
        '404':
          $ref: '#/components/responses/collectionFolder404Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/collectionItemsIdQuery'
      - $ref: '#/components/parameters/collectionItemsUidFormatQuery'
      - $ref: '#/components/parameters/collectionItemsPopulateQuery'
    put:
      summary: APIs.io Engineering Platform Update a folder
      description: 'Updates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the `name` property). The endpoint does not update the entire resource.

        '
      operationId: updateCollectionFolder
      tags:
      - Collection Items
      requestBody:
        $ref: '#/components/requestBodies/updateCollectionFolder'
      responses:
        '200':
          $ref: '#/components/responses/updateCollectionFolder'
        '400':
          $ref: '#/components/responses/collectionFolder400Error'
        '401':
          $ref: '#/components/responses/collectionFolder401Error'
        '404':
          $ref: '#/components/responses/collectionFolder404Error'
        '500':
          $ref: '#/components/responses/common500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a folder
      description: Deletes a folder in a collection.
      operationId: deleteCollectionFolder
      tags:
      - Collection Items
      responses:
        '200':
          $ref: '#/components/responses/deleteCollectionFolder'
        '401':
          $ref: '#/components/responses/collectionFolder401Error'
        '404':
          $ref: '#/components/responses/collectionFolder404Error'
        '500':
          $ref: '#/components/responses/common500Error'
  /collections/{collectionId}/requests/{requestId}:
    parameters:
    - $ref: '#/components/parameters/collectionRequestId'
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get a request
      description: Gets information about a request in a collection.
      operationId: getCollectionRequest
      tags:
      - Collection Items
      responses:
        '200':
          $ref: '#/components/responses/getCollectionRequest'
        '401':
          $ref: '#/components/responses/collectionRequest401Error'
        '404':
          $ref: '#/components/responses/collectionRequest404Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/collectionItemsIdQuery'
      - $ref: '#/components/parameters/collectionItemsUidFormatQuery'
      - $ref: '#/components/parameters/collectionItemsPopulateQuery'
    put:
      summary: APIs.io Engineering Platform Update a request
      description: 'Updates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        - You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a collection(`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint.

        - This endpoint does not support changing the folder of a request.

        '
      operationId: updateCollectionRequest
      tags:
      - Collection Items
      requestBody:
        $ref: '#/components/requestBodies/updateCollectionRequest'
      responses:
        '200':
          $ref: '#/components/responses/updateCollectionRequest'
        '400':
          $ref: '#/components/responses/collectionRequest400Error'
        '401':
          $ref: '#/components/responses/collectionRequest401Error'
        '404':
          $ref: '#/components/responses/collectionRequest404Error'
        '500':
          $ref: '#/components/responses/common500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a request
      description: Deletes a request in a collection.
      operationId: deleteCollectionRequest
      tags:
      - Collection Items
      responses:
        '200':
          $ref: '#/components/responses/deleteCollectionRequest'
        '401':
          $ref: '#/components/responses/collectionRequest401Error'
        '404':
          $ref: '#/components/responses/collectionRequest404Error'
        '500':
          $ref: '#/components/responses/common500Error'
  /collections/{collectionId}/responses/{responseId}:
    parameters:
    - $ref: '#/components/parameters/collectionResponseId'
    - $ref: '#/components/parameters/collectionId'
    get:
      summary: APIs.io Engineering Platform Get a response
      description: Gets information about a response in a collection.
      operationId: getCollectionResponse
      tags:
      - Collection Items
      responses:
        '200':
          $ref: '#/components/responses/getCollectionResponse'
        '401':
          $ref: '#/components/responses/collectionResponse401Error'
        '404':
          $ref: '#/components/responses/collectionResponse404Error'
        '500':
          $ref: '#/components/responses/common500Error'
      parameters:
      - $ref: '#/components/parameters/collectionItemsIdQuery'
      - $ref: '#/components/parameters/collectionItemsUidFormatQuery'
      - $ref: '#/components/parameters/collectionItemsPopulateQuery'
    put:
      summary: APIs.io Engineering Platform Update a response
      description: 'Updates a response in a collection. For a complete list of properties, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        - You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a collection UID (`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint.

        - This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the `name` property). The endpoint does not update the entire resource.

        '
      operationId: updateCollectionResponse
      tags:
      - Collection Items
      requestBody:
        $ref: '#/components/requestBodies/updateCollectionResponse'
      responses:
        '200':
          $ref: '#/components/responses/updateCollectionResponse'
        '400':
          $ref: '#/components/responses/collectionResponse400Error'
        '401':
          $ref: '#/components/responses/collectionResponse401Error'
        '404':
          $ref: '#/components/responses/collectionResponse404Error'
        '500':
          $ref: '#/components/responses/common500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a response
      description: Deletes a response in a collection.
      operationId: deleteCollectionResponse
      tags:
      - Collection Items
      responses:
        '200':
          $ref: '#/components/responses/deleteCollectionResponse'
        '401':
          $ref: '#/components/responses/collectionResponse401Error'
        '404':
          $ref: '#/components/responses/collectionResponse404Error'
        '500':
          $ref: '#/components/responses/common500Error'
components:
  parameters:
    collectionFolderId:
      name: folderId
      in: path
      required: true
      description: The folder's ID.
      schema:
        $ref: '#/components/schemas/collectionFolderId'
    collectionId:
      name: collectionId
      in: path
      required: true
      description: The collection's ID.
      schema:
        type: string
        example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
    collectionItemsUidFormatQuery:
      name: uid
      in: query
      description: If true, returns all IDs in UID format (`userId`-`id`).
      schema:
        $ref: '#/components/schemas/booleanQuery'
    collectionResponseParentRequestId:
      name: requestId
      in: query
      required: true
      description: The parent request's ID.
      schema:
        $ref: '#/components/schemas/collectionRequestId'
    collectionResponseId:
      name: responseId
      in: path
      required: true
      description: The response's ID.
      schema:
        type: string
        example: cc364734-7dfd-4bfc-897d-be763dcdbb07
    collectionRequestId:
      name: requestId
      in: path
      required: true
      description: The request's ID.
      schema:
        $ref: '#/components/schemas/collectionRequestId'
    collectionItemsIdQuery:
      name: ids
      in: query
      description: If true, returns only properties that contain ID values in the response.
      schema:
        $ref: '#/components/schemas/booleanQuery'
    collectionRequestFolderIdQuery:
      name: folderId
      in: query
      description: The folder ID in which to create the request. By default, the system will create the request at the collection level.
      schema:
        $ref: '#/components/schemas/collectionFolderId'
    collectionItemsPopulateQuery:
      name: populate
      in: query
      description: If true, returns all of the collection item's contents.
      schema:
        $ref: '#/components/schemas/booleanQuery'
  schemas:
    collectionRequestId:
      type: string
      example: c82dd02c-4870-4907-8fcb-593a876cf05b
    collectionFolderId:
      type: string
      example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
    booleanQuery:
      type: boolean
      example: true
  responses:
    deleteCollectionResponse:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              model_id:
                type: string
                description: The response's ID.
                example: cc364734-7dfd-4bfc-897d-be763dcdbb07
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              data:
                type: object
                description: The response's information.
                properties:
                  id:
                    type: string
                    description: The response's ID.
                    example: cc364734-7dfd-4bfc-897d-be763dcdbb07
                  owner:
                    type: string
                    description: The user ID of the request's owner.
                    example: '12345678'
              revision:
                type: number
                description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.
                example: 24997417224
          example:
            model_id: cc364734-7dfd-4bfc-897d-be763dcdbb07
            meta:
              model: response
              action: destroy
            data:
              id: cc364734-7dfd-4bfc-897d-be763dcdbb07
              owner: '12345678'
            revision: 24997417224
    collectionResponse401Error:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: Unauthorized
                  details:
                    type: object
                    description: Information about the error.
                    properties:
                      model:
                        type: string
                        description: The resource name.
                        example: response
                      owner:
                        type: string
                        description: The user ID of the response's owner.
                        example: '12345678'
                      model_id:
                        type: string
                        description: The response's ID.
                        example: 7978bfb8-fb89-42ac-8d48-cd547d96463e
                  message:
                    type: string
                    description: The error message.
                    example: Unauthorized
          example:
            error:
              name: Unauthorized
              details:
                model: response
                owner: '12345678'
                model_id: 7978bfb8-fb89-42ac-8d48-cd547d96463e
              message: Unauthorized
    collectionRequest404Error:
      description: Not Found
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: instanceNotFoundError
                  details:
                    type: object
                    description: Information about the error.
                    properties:
                      model:
                        type: string
                        description: The resource name.
                        example: request
                      owner:
                        type: string
                        description: The user ID of the request's owner.
                        example: '12345678'
                      model_id:
                        type: string
                        description: The request's ID.
                        example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  message:
                    type: string
                    description: The error message.
                    example: We could not find the request you are looking for
          example:
            error:
              name: instanceFoundError
              details:
                model: request
                owner: '12345678'
                model_id: c82dd02c-4870-4907-8fcb-593a876cf05b
              message: We could not find the request you are looking for
    collectionResponse400Error:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: instanceFoundError
                  details:
                    type: object
                    description: Information about the error.
                    additionalProperties: true
                    properties:
                      model:
                        type: string
                        description: The resource name.
                        example: response
                      owner:
                        type: string
                        description: The user ID of the response's owner.
                        example: '12345678'
                      model_id:
                        type: string
                        description: The response's ID.
                        example: 7978bfb8-fb89-42ac-8d48-cd547d96463e
                  message:
                    type: string
                    description: The error message.
                    example: This response already exists in the database.
          example:
            error:
              name: instanceFoundError
              message: This response already exists in the database.
              details:
                model: response
                model_id: 7978bfb8-fb89-42ac-8d48-cd547d96463e
                owner: '12345678'
    common500Error:
      description: Internal Server Error
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/internal-server-error
              title:
                type: string
                description: A short summary of the problem.
                example: Internal Server Error
              detail:
                type: string
                description: Information about the error.
                example: Internal Server Error
          example:
            type: https://api.postman.com/problems/internal-server-error
            title: Internal Server Error
            detail: Internal Server Error
    updateCollectionFolder:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                additionalProperties: true
                description: The folder's updated information, including the updated properties. For a complete list of properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).
                properties:
                  id:
                    type: string
                    description: The folder's ID.
                    example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
                  name:
                    type: string
                    description: The folder's name.
                    example: Test Folder
                  description:
                    type: string
                    description: The folder's description.
                    example: This is a test collection folder.
                  createdAt:
                    type: string
                    format: date-time
                    description: The folder's creation date and time.
                    example: '2022-08-29T16:49:19.964Z'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the folder was last updated.
                    example: '2022-08-29T16:49:19.964Z'
                  owner:
                    type: string
                    description: The user ID of the folder's owner.
                    example: '12345678'
                  lastUpdatedBy:
                    type: string
                    description: The user ID of the user that last updated the folder.
                    example: '12345678'
                  lastRevision:
                    type: integer
                    format: int64
                    description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.
                    example: 24977100955
                  collection:
                    type: string
                    description: The collection ID that the folder belongs to.
                    example: 12ece9e1-2abf-4edc-8e34-de66e74114d2
                  folder:
                    type: string
                    nullable: true
                    description: Information about the folder.
                    example: null
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              model_id:
                type: string
                description: The folder's ID.
                example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              revision:
                type: number
                description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.
                example: 24994132707
          example:
            data:
              id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              auth: null
              name: Test Folder
              order: []
              owner: '12345678'
              events: null
              folder: null
              createdAt: '2022-08-29T16:49:19.964Z'
              updatedAt: '2022-08-29T16:49:19.964Z'
              variables: null
              collection: 12ece9e1-2abf-4edc-8e34-de66e74114d2
              description: This is a test folder.
              lastRevision: 24977100955
              folders_order: []
              lastUpdatedBy: '12345678'
            meta:
              model: folder
              action: update
            model_id: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
            revision: 24977103385
    createCollectionResponse:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                additionalProperties: true
                description: Information about the response. For a complete list of properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
                properties:
                  id:
                    type: string
                    description: The response's ID.
                    example: 43e1277f-6079-4feb-9316-c8ec24605092
                  owner:
                    type: string
                    description: The user ID of the response's owner.
                    example: '12345678'
                  request:
                    type: string
                    description: The request ID of the response's associated request.
                    example: c82dd02c-4870-4907-8fcb-593a876cf05b
                  createdAt:
                    type: string
                    format: date-time
                    description: The date and time at which the response was created.
                    example: '2022-08-19T15:06:18.940Z'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time at which the response was last updated.
                    example: '2022-08-19T15:06:18.940Z'
                  lastUpdatedBy:
                    type: string
                    description: The user ID of the user who last updated the response.
                    example: '12345678'
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              model_id:
                type: string
                description: The response's ID.
                example: 43e1277f-6079-4feb-9316-c8ec24605092
              revision:
                type: number
                description: An internal revision ID. Its value increments each time the resource changes. You can use this ID to track whether there were changes since the last time you fetched the resource.
                example: 26532286083
          example:
            data:
              id: 43e1277f-6079-4feb-9316-c8ec24605092
              owner: '12345678'
              request: c82dd02c-4870-4907-8fcb-593a876cf05b
              createdAt: '2022-08-29T16:58:15.523Z'
              updatedAt: '2022-08-29T16:58:15.523Z'
              lastUpdatedBy: '12345678'
            meta:
              model: response
              action: create
            model_id: 43e1277f-6079-4feb-9316-c8ec24605092
            revision: 26532286083
    getCollectionRequest:
      description: Successful Response
      content:
        application/json:
          schema:
            type: object
            properties:
              model_id:
                type: string
                description: The request's ID.
                example: 65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
              meta:
                type: object
                description: A Postman-specific response that contains information about the internal performed operation.
                additionalProperties: true
              data:
                type: object
                additionalProperties: true
                description: Information about the request. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format do

# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/openapi/engineering-platform-collection-items-api-openapi.yml