Project resource description -- explain what it's for and how it's used.
Returns a collection with a key, ID, and link for each project resource.
OK
Bad Request
{- "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
}
}
Creates a new project resource.
required | object | ||||||
| |||||||
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. | |||||||
| |||||||
object | |||||||
| |||||||
object | |||||||
|
Created
Bad Request
{- "description": "Hourly resource",
- "startDate": "2023-04-01",
- "employee": {
- "key": "244"
}, - "item": {
- "key": "23"
}, - "pricing": {
- "laborRate": 100,
- "expenseRate": 110,
- "apPurchasingRate": 120
}, - "project": {
- "key": "23"
}
}
{- "ia::result": {
- "key": "12345",
- "id": "12345",
- "href": "/objects/projects/project-resource/12345"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a particular project resource.
key required | string system-assigned unique key for the project resource. |
OK
Bad Request
{- "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
}
}
Updates an existing project resource by setting field values. Any fields not provided remain unchanged.
key required | string system-assigned unique key for the project resource. |
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. | |||||||
| |||||||
object | |||||||
| |||||||
object | |||||||
| |||||||
object | |||||||
|
OK
Bad Request
{- "description": "Project resource"
}
{- "ia::result": {
- "key": "12345",
- "id": "ID123",
- "href": "/objects/projects/project-resource/12345"
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}
Deletes a project resource.
key required | string system-assigned unique key for the project resource. |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "Payload contains errors",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "errorId": "REST-1064",
- "additionalInfo": {
- "messageId": "IA.PAYLOAD_CONTAINS_ERRORS",
- "placeholders": { },
- "propertySet": { }
}, - "details": [
- {
- "code": "invalidRequest",
- "message": "/testDate is not a valid field",
- "errorId": "REST-1043",
- "target": "/testDate",
- "additionalInfo": {
- "messageId": "IA.NOT_A_VALID_FIELD",
- "placeholders": {
- "FIELD": "/testDate"
}, - "propertySet": { }
}
}
]
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}, - "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "projects/project-resource" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "id": "Vend-00002",
- "name": "Test vendor",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/85"
}, - {
- "id": "VEND-00010",
- "name": "Design Works",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/111"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}