API examples
Update examples
Sample PATCH requests for projects, tasks, time entries and Workflow Apps.
Project
Updating the name of the project whose id is 1240.
curl -g -X PATCH \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer YourTokenHere' \
-d '{"id":"1240","name":"API Project 2"}' \
'https://app.celoxis.com/psa/api/v2/projects'Response
{
data: {
id: "1240",
url: "https://app.celoxis.com/psa/projects/1240",
name: "API Project 2",
description: "",
code: "",
created: "2019-09-09",
lastModified: "2019-09-13",
plannedStart: "2019-08-12",
plannedStartWeek: "33-2019",
plannedStartMonth: "2019-08",
plannedStartQuarter: "Q3 2019",
plannedStartYear: "2019",
plannedStartFiscalYear: "2019",
deadline: "2019-09-13",
deadlineWeek: "37-2019",
deadlineMonth: "2019-09",
deadlineQuarter: "Q3 2019",
deadlineYear: "2019",
deadlineFiscalYear: "2019",
plannedFinish: "2019-09-09",
projectedFinish: "2019-09-09",
actualFinish: "",
priority: "NORMAL",
actualPercentComplete: "73",
state: "Active",
baselineStart: "",
baselineStartVariance: "",
baselineDeadline: "",
baselineDeadlineVariance: "",
baselineFinish: "",
baselineFinishVariance: "",
baselineCost: "",
baselineBudget: "",
baselinePercentComplete: "0",
baselineEffort: "",
baselineEffortVariance: "60",
scheduleHealth: "Off Track",
budgetHealth: "Off Track",
type: "Implementation",
workCalendar: "Default",
budget: "10000",
billingType: "TNM",
plannedRevenue: "14400",
plannedLaborRevenue: "14400",
fixedPrice: "0",
plannedEffort: "60",
actualLaborHours: "101.5",
actualBillableLaborHours: "68",
actualNonBillableLaborHours: "33.5",
remainingEffort: "0",
plannedCost: "8400",
actualCost: "10200",
invoicedLaborHours: "14",
invoicedRevenue: "3600",
invoicedLaborAmount: "3600",
invoicedExpense: "0",
plannedLaborCost: "8400",
actualLaborCost: "10200",
plannedNonLaborCost: "0",
actualNonLaborCost: "0",
plannedFixedCost: "0",
actualFixedCost: "0",
plannedProfit: "6000",
plannedMargin: "41.667",
actualProfit: "6800",
actualMargin: "40",
projectedCost: "10300",
projectedLaborHours: "93",
actualRevenue: "17000",
actualNonBillableLaborAmount: "8350",
actualNonBillableExpense: "0",
alignment: "20",
benefit: "20",
risk: "NORMAL",
cpi: "",
spi: "",
costVariance: "",
scheduleVariance: "",
plannedPercentComplete: "100",
bcwp: "",
bcws: "",
acwp: "10200",
team: "Team Member, Tony Stark",
custom_country: "",
manager: "https://app.celoxis.com/psa//api/v2/projects/1240/manager",
clients: "https://app.celoxis.com/psa//api/v2/projects/1240/clients",
},
}Task
Updating the budget of the task whose id is 12350.
curl -g -X PATCH \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer YourTokenHere' \
-d '{"id":"12350","budget":"10000"}' \
'https://app.celoxis.com/psa/api/v2/tasks'Response
{
data: {
id: "12350",
url: "https://app.celoxis.com/psa/tasks/12350",
name: "Marketing & Promotion",
description: "",
hierarchy: "",
topmostTask: "Marketing & Promotion",
sN: "11",
wbs: "4",
color: "BROWN",
plannedStart: "2019-09-09",
plannedStartWeek: "37-2019",
plannedStartMonth: "2019-09",
plannedStartQuarter: "Q3 2019",
plannedStartYear: "2019",
plannedStartFiscalYear: "2019",
plannedFinish: "2019-09-13",
plannedFinishWeek: "37-2019",
plannedFinishMonth: "2019-09",
plannedFinishQuarter: "Q3 2019",
plannedFinishYear: "2019",
plannedFinishFiscalYear: "2019",
actualStart: "2019-09-09",
actualStartWeek: "37-2019",
actualStartMonth: "2019-09",
actualStartQuarter: "Q3 2019",
actualStartYear: "2019",
actualStartFiscalYear: "2019",
actualFinish: "",
actualFinishWeek: "",
actualFinishMonth: "",
actualFinishQuarter: "",
actualFinishYear: "",
actualFinishFiscalYear: "",
projectedStart: "2019-09-09",
projectedStartWeek: "37-2019",
projectedStartMonth: "2019-09",
projectedStartQuarter: "Q3 2019",
projectedStartYear: "2019",
projectedStartFiscalYear: "2019",
projectedFinish: "2019-09-13",
projectedFinishWeek: "37-2019",
projectedFinishMonth: "2019-09",
projectedFinishQuarter: "Q3 2019",
projectedFinishYear: "2019",
projectedFinishFiscalYear: "2019",
projectedCost: "7000",
actualRevenue: "10700",
plannedEffort: "20.8",
scheduleType: "FIXED_DURATION",
duration: "5d",
predecessors: "10",
successors: "22",
constraintType: "ASAP",
constraintDate: "",
priority: "NORMAL",
actualPercentComplete: "93",
remainingEffort: "10.4",
created: "2019-09-09",
lastModified: "2019-09-13",
lastUpdate: "Tony Stark \u2022 4 days ago\r\n",
allUpdates: "Tony Stark \u2022 4 days ago\r\n",
lastUpdated: "2019-09-09",
resources: "",
scheduleHealth: "On Track",
budgetHealth: "Off Track",
plannedRevenue: "5200",
plannedLaborRevenue: "5200",
budget: "0",
fixedPrice: "0",
billingType: "TNM",
plannedCost: "3120",
actualCost: "6300",
actualLaborHours: "44",
myEstHours: "0",
myActHours: "0",
invoicedLaborHours: "8",
invoicedRevenue: "2400",
invoicedLaborAmount: "2400",
invoicedExpense: "0",
actualBillableLaborHours: "44",
actualNonBillableLaborHours: "0",
plannedFixedCost: "0",
plannedNonLaborCost: "0",
plannedLaborCost: "3120",
actualNonBillableLaborAmount: "0",
actualBillableLaborAmount: "10700",
actualBillableExpense: "0",
actualNonBillableExpense: "0",
actualLaborCost: "6300",
actualNonLaborCost: "0",
actualFixedCost: "0",
projectedLaborHours: "48.89",
attachments: "",
milestone: "No",
isManuallyScheduled: "No",
isTimeAllowed: "Yes",
critical: "No",
cpi: "",
spi: "",
costVariance: "",
scheduleVariance: "",
plannedPercentComplete: "97",
bcwp: "",
bcws: "",
acwp: "6300",
baselineStart: "",
baselineStartVariance: "",
baselineFinish: "",
baselineFinishVariance: "",
baselineCost: "",
baselineBudget: "",
baselinePercentComplete: "0",
baselineEffort: "",
baselineEffortVariance: "",
showInTimeline: "No",
externalKey: "",
custom_kanban_state: "In Progress",
project: "https://app.celoxis.com/psa//api/v2/tasks/12350/project",
parent: "https://app.celoxis.com/psa//api/v2/tasks/12350/parent",
assignments: "https://app.celoxis.com/psa//api/v2/tasks/12350/assignments",
},
}Time
Updating the hours, state and date of the time entry whose id is 123460.
curl -g -X PATCH \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer YourTokenHere' \
-d '{"id":"123460","hours":"6","date":"2019-09-13","state":"1"}' \
'https://app.celoxis.com/psa/api/v2/timeEntries'Response
{
data: {
id: "123460",
url: "https://app.celoxis.com/psa/ap/aHR0cHM6Ly9hcHAuY2Vsb3hpcy5jb20vcHNhL3RlLkVkaXQud20iscF90c19pZD0yMTI3OTQzNAieie",
accountingCode: "",
created: "2019-09-09",
date: "2019-09-13",
dateWeek: "37-2019",
dateMonth: "2019-09",
dateQuarter: "Q3 2019",
dateYear: "2019",
dateFiscalYear: "2019",
lastModified: "2019-09-13",
hours: 6.0,
comments: "",
timeCode: "Default",
state: "Pending Approval",
workItem: "https://app.celoxis.com/psa//api/v2/timeEntries/123460/workItem",
yearWeek: "2019-37",
approvedOn: "",
invoicedOn: "",
approvals: "",
isBillable: "Yes",
billRate: "200",
revenue: "1200",
isCostable: "Yes",
costRate: "100",
cost: "600",
user: "https://app.celoxis.com/psa//api/v2/timeEntries/123460/user",
approver: "https://app.celoxis.com/psa//api/v2/timeEntries/123460/approver",
project: "https://app.celoxis.com/psa//api/v2/timeEntries/123460/project",
},
}App
Updating the budget indicator, priority and risk mitigation cost of the app whose id is 54321.
curl -g -X PATCH \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer YourTokenHere' \
-d '{"id":"54321","custom_risk_probability":"Likely", "priority":"2","custom_risk_mitigation_cost":"1000"}' \
'https://app.celoxis.com/psa/api/v2/apps'Response
{
data: {
id: "54321",
url: "https://app.celoxis.com/psa/apps/54321",
name: "Risk 1",
description: "",
app: "Risk",
state: "Not Occurred",
age: "4d",
requestor: "",
dueDate: "",
created: "2019-09-09",
createdWeek: "37-2019",
createdMonth: "2019-09",
createdQuarter: "Q3 2019",
createdYear: "2019",
createdFiscalYear: "2019",
timeout: "",
completed: "",
priority: "HIGH",
lastUpdate: "Not Occurred \u2022 Tony Stark - 13-Sep-2019 4:40 PM\r\n",
lastUpdatedOn: "2019-09-13",
allUpdates:
"Not Occurred \u2022 Tony Stark - 13-Sep-2019 4:40 PM\r\n\r\n--------------------\r\rCreated \u2022 Tony Stark - 9-Sep-2019 6:47 PM\r\n",
delayed: "No",
requestorVisible: "No",
open: "Yes",
stateManager: "Tony Stark",
actualRevenue: "0",
actualCost: "0",
actualEffort: "0",
actualBillableLaborHours: "0",
actualNonBillableLaborHours: "0",
invoicedLaborHours: "0",
invoicedRevenue: "0",
custom_risk_impact: "Low",
custom_risk_probability: "Likely",
custom_risk_potential_cost: "",
custom_risk_mitigation_cost: 1000.0,
custom_mitigation_plan: "",
custom_risk_rating: "Low",
custom_bug_type: "",
custom_bug_severity: "",
custom_bug_component: "",
custom_bug_resolution: "",
custom_bug_affects_version: "",
custom_bug_fix_version: "",
custom_status_schedule: "",
custom_status_budget: "",
custom_status_scope: "",
custom_status_quality: "",
custom_status_team: "",
custom_status_risk: "",
custom_status_issue: "",
custom_status_overall: "",
custom_status_date: "",
custom_status_dateWeek: "",
custom_status_dateMonth: "",
custom_status_dateQuarter: "",
custom_status_dateYear: "",
custom_status_dateFiscalYear: "",
project: "https://app.celoxis.com/psa//api/v2/apps/54321/project",
assignee: {
data: {
id: "430778",
url: "https://app.celoxis.com/psa/users/430778",
name: "Tony Stark",
email: "tony.stark@celoxis.com",
phone: "",
login: "tony.stark",
lastAccessed: "2019-09-13T16:40:00",
workCalendar: "Default",
admin: "Yes",
virtual: "No",
reportingManager: "",
billRate: "300",
costRate: "200",
roles: "Staff",
jobRolePrimary: "",
},
},
},
}