Add Collection

APIs.ioEngineeringPlatform

Properties

Name Type Description
collection object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-pancreatecollection-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/panCreateCollection",
  "title": "Add Collection",
  "type": "object",
  "properties": {
    "collection": {
      "type": "object",
      "required": [
        "id",
        "parentFolderId"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The collection's ID.",
          "example": "5360b75f-447e-467c-9299-12fd6c92450d"
        },
        "parentFolderId": {
          "type": "integer",
          "description": "The collection's parent folder ID.",
          "example": 1
        },
        "environments": {
          "type": "array",
          "description": "A list of environment UIDs (`userId`-`environmentId``) to add to the collection.",
          "items": {
            "type": "string",
            "format": "uid",
            "description": "An environment's UID.",
            "example": "12345678-622c084d-4f48-470b-826e-18af3c65c775"
          }
        }
      }
    }
  }
}