Entity

Projects

Retrieve and manage projects, including upsert and clone operations.

Endpoints

GET/api/v2/projectsRetrieve a list

GET/api/v2/projects/{id}Retrieve one record

POST/api/v2/projectsCreate records

PATCH/api/v2/projectsUpdate records

DELETE/api/v2/projects/{id}Delete a record

Upsert a project

POST/api/v2/projects/upsertCreate or update by external key

PUT/api/v2/projects/upsertCreate or update by external key

Provide a non-empty externalKey (your system's id) and do not send id. Celoxis finds a project with that externalKey in your company; if found it updates, otherwise it creates. The response includes the usual project JSON plus action (created or updated) and success: true. externalKey should be unique per company. Multiple matches return HTTP 409.

bash

Example

curl -X PUT \
  -H 'Content-Type: application/json' \
  -H 'Authorization: bearer YourTokenHere' \
  -d '{
    "externalKey": "ERP-P-1001",
    "name": "Website Redesign",
    "workspace": 12345
  }' \
  'https://app.celoxis.com/psa/api/v2/projects/upsert'

Clone a project

POST/api/v2/projects/{id}/cloneCreate a project from an existing project

Send a JSON object in the request body with only the properties that should differ from the source project. The response is { data: {created-object} }.

To clone a project whose id is 123, with a different name and a planned start of 1 May 2020:

bash

Example

curl -g -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: bearer YourTokenHere' \
  -d '{
    "name": "Create logo for ABC.com",
    "plannedStart": "2020-05-01"
  }' \
  'https://app.celoxis.com/psa/api/v2/projects/123/clone'