Project resources

Project resource description -- explain what it's for and how it's used.

List project resources

get/objects/projects/project-resource

Returns a collection with a key, ID, and link for each project resource.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "12345",
      • "id": "12345",
      • "href": "/objects/projects/project-resource/12345"
      },
    • {
      • "key": "85",
      • "id": "EXP-00002",
      • "href": "/objects/projects/employee-expense/85"
      },
    • {
      • "key": "60",
      • "id": "EXP-00003",
      • "href": "/objects/projects/employee-expense/60"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 5,
    • "next": 0,
    • "previous": 0
    }
}
Create a project resource
post/objects/projects/project-resource
Creates a new project resource.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
object
 
key
string
Project key.


 
 Example:  "23"
id
string
Project ID.


 
 Example:  "P-0045"
description
string or null
Description of the project resource.


 
 Example:  "Hourly resource"
startDate
string or null <date> 
Start date of the resource on the project.


 
 Example:  "2023-04-01"
object
The employee resource assigned to the project.


 
key
string or null
Employee key.


 
 Example:  "244"
id
string or null
Employee ID.


 
 Example:  "jsmith"
object
 
key
string or null
Item key.


 
 Example:  "23"
id
string or null
Item ID.


 
 Example:  "B002"
object
 
laborRate
number or null
Labor rate for this resource on this project.


 
 Example:  10
expenseRate
number or null
Expense rate.


 
 Example:  120
apPurchasingRate
number or null
AP and PO.


 
 Example:  100
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "description": "Hourly resource",
  • "startDate": "2023-04-01",
  • "employee": {
    • "key": "244"
    },
  • "item": {
    • "key": "23"
    },
  • "pricing": {
    • "laborRate": 100,
    • "expenseRate": 110,
    • "apPurchasingRate": 120
    },
  • "project": {
    • "key": "23"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12345",
    • "id": "12345",
    • "href": "/objects/projects/project-resource/12345"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a project resource
get/objects/projects/project-resource/{key}
Returns detailed information for a particular project resource.


SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the project resource.


 
 Example:  181
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "23",
    • "id": "23",
    • "href": "/objects/projects/project-resource/23",
    • "description": "Hourly resource",
    • "startDate": "2023-04-01",
    • "employee": {
      • "href": "/objects/company-config/employee/23",
      • "key": "244",
      • "id": "jsmith",
      • "startDate": "2022-01-01",
      • "endDate": "2023-01-01"
      },
    • "employeeContact": {
      • "key": "977",
      • "id": "John Smith",
      • "firstName": "John",
      • "lastName": "Smith",
      • "href": "/objects/company-config/contact/977"
      },
    • "item": {
      • "href": "/objects/inventory-control/item/23",
      • "key": "23",
      • "id": "B002",
      • "name": "Monitor-Acer"
      },
    • "pricing": {
      • "laborPricingMethod": "billingRate",
      • "laborRate": 100,
      • "expensePricingMethod": "billingRate",
      • "expenseRate": 100,
      • "apPurchasingPricingMethod": "costPlusFee",
      • "apPurchasingRate": 120
      },
    • "project": {
      • "href": "/objects/projects/project/23",
      • "key": "23",
      • "id": "P-0045",
      • "name": "Implementation Project"
      },
    • "audit": {
      • "createdDateTime": "2022-04-20T16:20:00Z",
      • "modifiedDateTime": "2022-04-20T16:20:00Z",
      • "createdBy": "1",
      • "modifiedBy": "95"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a project resource
patch/objects/projects/project-resource/{key}
Updates an existing project resource by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the project resource.


 
 Example:  181
Request Body schema: application/json
description
string or null
Description of the project resource.


 
 Example:  "Hourly resource"
startDate
string or null <date> 
Start date of the resource on the project.


 
 Example:  "2023-04-01"
object
The employee resource assigned to the project.


 
key
string or null
Employee key.


 
 Example:  "244"
id
string or null
Employee ID.


 
 Example:  "jsmith"
object
 
key
string or null
Item key.


 
 Example:  "23"
id
string or null
Item ID.


 
 Example:  "B002"
object
 
laborRate
number or null
Labor rate for this resource on this project.


 
 Example:  10
expenseRate
number or null
Expense rate.


 
 Example:  120
apPurchasingRate
number or null
AP and PO.


 
 Example:  100
object
 
key
string
Project key.


 
 Example:  "23"
id
string
Project ID.


 
 Example:  "P-0045"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "Project resource"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12345",
    • "id": "ID123",
    • "href": "/objects/projects/project-resource/12345"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}
Delete a project resource
delete/objects/projects/project-resource/{key}
Deletes a project resource.


SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the project resource.


 
 Example:  181
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query project resources
post/services/core/query
Use the query service to find project resources that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples