---
updatedAt: 2026-08-21T11:06:34.000Z
agentTools:
  projectIndex: https://developer.bigpicture.one/llms.txt
---

# Create workload plan

Creates a new workload plan.

On-premise availability - BigPicture versions equal to or greater than 8.70.11.3

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "BigPicture Data Center API",
    "version": "latest"
  },
  "servers": [
    {
      "url": "{base_url}/",
      "description": "The production API server",
      "variables": {
        "basePath": {
          "default": "your_server_path"
        }
      }
    }
  ],
  "paths": {
    "/public/ppm/workload-plans": {
      "post": {
        "tags": [
          "Resources"
        ],
        "summary": "Create workload plan",
        "description": "Creates a new workload plan.\n\nOn-premise availability - BigPicture versions equal to or greater than 8.70.11.3",
        "operationId": "createWorkloadPlan",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/com.softwareplant.ppm.resource.publicapi.rest.workloadplans.v1.request.CreateWorkloadPlanRequestDTO"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Workload plan created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/com.softwareplant.ppm.resource.publicapi.rest.workloadplans.v1.response.WorkloadPlanResponseDTO"
                }
              }
            }
          },
          "400": {
            "description": "Workload plan could not be created. Possible reasons:\n\n- request data is invalid\n- workload plan code is already used by another plan",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/com.softwareplant.util.rest.validationhandling.ValidationErrors"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized. API token is missing or invalid."
          },
          "403": {
            "description": "Forbidden. Token has no required permissions."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "com.softwareplant.util.rest.validationhandling.ValidationErrors": {
        "type": "object",
        "properties": {
          "errorMessages": {
            "uniqueItems": true,
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "errors": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "com.softwareplant.ppm.resource.innerapi.workloadplan.dto.DailyWorkloadDTO": {
        "type": "object",
        "properties": {
          "start": {
            "type": "integer",
            "format": "int32"
          },
          "end": {
            "type": "integer",
            "format": "int32"
          },
          "dayOfWeek": {
            "type": "string"
          },
          "empty": {
            "type": "boolean"
          }
        }
      },
      "com.softwareplant.ppm.resource.publicapi.rest.workloadplans.v1.response.WorkloadPlanResponseDTO": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "color": {
            "type": "string",
            "enum": [
              "darkBlue",
              "blue",
              "lightBlue",
              "cyan",
              "lightCyan",
              "purple",
              "lightPurple",
              "green",
              "lightGreen",
              "orange",
              "lightOrange",
              "yellow",
              "lightYellow",
              "red",
              "lightRed",
              "white",
              "lightGray",
              "darkGray",
              "gray",
              "black"
            ]
          },
          "description": {
            "type": "string"
          },
          "weekStartDay": {
            "type": "string"
          },
          "maxWeeklyWorkload": {
            "type": "integer",
            "format": "int32"
          },
          "value": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/com.softwareplant.ppm.resource.innerapi.workloadplan.dto.DailyWorkloadDTO"
            }
          }
        }
      },
      "com.softwareplant.ppm.resource.publicapi.rest.workloadplans.v1.request.CreateWorkloadPlanRequestDTO": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "color": {
            "type": "string",
            "enum": [
              "darkBlue",
              "blue",
              "lightBlue",
              "cyan",
              "lightCyan",
              "purple",
              "lightPurple",
              "green",
              "lightGreen",
              "orange",
              "lightOrange",
              "yellow",
              "lightYellow",
              "red",
              "lightRed",
              "white",
              "lightGray",
              "darkGray",
              "gray",
              "black"
            ]
          },
          "description": {
            "type": "string"
          },
          "weekStartDay": {
            "type": "string"
          },
          "value": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/com.softwareplant.ppm.resource.innerapi.workloadplan.dto.DailyWorkloadDTO"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Authorization",
        "value": "APIToken paste_your_api_token_here"
      }
    ],
    "explorer-enabled": false,
    "samples-languages": [
      "shell",
      "http",
      "java"
    ]
  }
}
```