Update Collection

APIs.ioEngineeringPlatform

Properties

Name Type Description
collection object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-updatepancollection-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/updatePanCollection",
  "title": "Update Collection",
  "type": "object",
  "properties": {
    "collection": {
      "type": "object",
      "properties": {
        "parentFolderId": {
          "type": "integer",
          "description": "The collection's new parent folder ID.",
          "example": 1
        },
        "environments": {
          "type": "object",
          "description": "The collection's updated environments.",
          "properties": {
            "$add": {
              "type": "array",
              "items": {
                "type": "string",
                "description": "The ID of environment to add to the collection.",
                "example": "92133-622c084d-4f48-470b-826e-18af3c65c775"
              }
            },
            "$remove": {
              "type": "array",
              "items": {
                "type": "string",
                "description": "The ID of environment to remove from the collection.",
                "example": "92637-612c7311-4557-470b-826e-18af35682568"
              }
            }
          }
        }
      }
    }
  }
}