Entity

Workflow App Records

Retrieve and manage records from configured Workflow Apps such as Risks, Issues and Approvals.

Endpoints

GET/api/v2/appsRetrieve a list

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

POST/api/v2/appsCreate records

PATCH/api/v2/appsUpdate records

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

Create a record

POST/api/v2/appsCreate a Workflow App record

Use app to identify the configured Workflow App. A record must belong to either a project or a workspace.

bash

curl -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: bearer YourTokenHere' \
  -d '{
    "app": "Risk",
    "name": "Supplier delay",
    "description": "Delivery may slip",
    "project": "Website Redesign"
  }' \
  'https://app.celoxis.com/psa/api/v2/apps'

Upsert a record

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

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

The externalKey must be unique across all Workflow App records in the company. Multiple matches return HTTP 409.

bash

curl -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: bearer YourTokenHere' \
  -d '{
    "externalKey": "ERP-A-1001",
    "app": "Risk",
    "name": "Supplier delay",
    "project": "ERP-P-1001"
  }' \
  'https://app.celoxis.com/psa/api/v2/apps/upsert'