Create placeholders

Operation ID: createPlaceholders

Group: PSA › Placeholders

Open in the interactive reference

POST /psa/placeholders

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Creates one or more placeholders. If any placeholder can't be created, none are. The response lists the new placeholders' ids in the order you sent them.

A new placeholder isn't assigned to any project position.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.

Request body

Required, application/json: createPlaceholdersInput.

Field Type Required Description
placeholders array<object> yes The placeholders to create. Send at least one. Either all are created, or none are. Example: [{"name":"Unassigned Backend Engineer","weeklyWorkingHours":"40.00"},{"name":"Unassigned Designer"}].
placeholders[].name string yes The display name of the placeholder. Required, and unique within the tenant. A blank name fails the call with NAME_REQUIRED. A name another placeholder already has fails with DUPLICATE_NAME.
placeholders[].weeklyWorkingHours decimal no The weekly working hours used for planning, as a non-negative number of hours, for example 40.00. Omitted or zero stores no hours. 
{
  "placeholders": [
    {
      "name": "Unassigned Backend Engineer",
      "weeklyWorkingHours": "40.00"
    },
    {
      "name": "Unassigned Designer"
    }
  ]
}

Response

200 Success

Under data (createPlaceholdersOutput):

Field Type Required Description
ids array<string> yes The identifiers of the created placeholders, in the order they were sent. Example: ["3f2a91c7-5d84-4b1e-9c60-8a7e2d4f0b13","b7c40e29-1af6-42d8-8e55-6d3b9c018a74"]. 
{
  "data": {
    "ids": [
      "3f2a91c7-5d84-4b1e-9c60-8a7e2d4f0b13",
      "b7c40e29-1af6-42d8-8e55-6d3b9c018a74"
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NAME_REQUIRED 400
DUPLICATE_NAME 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses