Skip to main content

Tips

General Tips

Common Issues and Solutions

IssueCauseSolution
PUT/POST requests failingMissing required properties.1. Retrieve JSON via GET
2. Edit the JSON
3. Use modified JSON as the body for PUT/POST
500 Error on PUT/POST with EAsEA collections are not included.Include empty EA collections: "extendedAttributes": [], "multipleValueExtendedAttributes": [].
Null responseAccessToken expired.Refresh your AccessToken using your RefreshToken (see Authorization section).
Missing required EAs not throwing errorsFunctioning as expected.Validation varies based on DCT or page layout. "Required" EAs may not be enforced in PUT/POST.
EA validation not workingdisable-api-ea-validation flag is set.This flag bypasses validations and is deprecated. Contact Aprimo Support if you believe it's enabled.
Can't update individual EAs on PUTSyntax or conflict with EA collections.Use this syntax: { "extrAttr<eaID>": "<value>" }. Avoid updating EA collections simultaneously.
Date-Only EA returned as DateTimeExpected behavior.Date-Only EAs are stored in DateTime format (2021-02-15T00:00:00.000). Convert as needed in integrations.

Resource-Specific Tips

User Roles

  • Issue: Cannot update laborRateBase.
  • Cause: laborRateBase is derived from laborRateEntered and ExchangeRate.
  • Solution: Update laborRateEntered, as laborRateBase is not directly editable.

Activities

  • Issue: Workflows not starting.

  • Cause: Field names in API differ from UI.

    • UI Begin Date = API beginDate
    • UI Project Anchor Date = API endDate
    • UI End Date = API visualEndDate
    • Project Anchor Date defaults to Activity Begin Date when created via UI.
  • Solution: Set beginDate and endDate to the same value when creating an activity.


Attachments

  • Issue: Finding all attachments related to an activity.
  • Solution: Use POST /api/attachments/search with the following body:
  {
"and": [
{
"equals": {
"fieldName": "objectTypeId",
"fieldValue": "1"
}
},
{
"equals": {
"fieldName": "objectId",
"fieldValue": "62302"
}
}
]
}

This searches for attachments associated with objectType 1 (activities), where the activity ID (objectID) is (in this case, 62302).