Routes

All available routes are shown below. If there is an object or route that you would like added, please contact your Aprimo account representative to submit the request.

In the lists below, PUT routes marked with an ‘*’ support field-level updates, which allows you to specify only the fields you want to update on the request. Note that all items in a collection (within square brackets) still need to be specified in their entirety, because collections are flushed-and-filled during an update operation. The JSON format for updating an EA (outside of a collection) is:

  {
	"extrAttr<eaID>":"<value>"
  }

The JSON format for updating a multi-select EA is:

  {
"multipleValueExtendedAttributes": [
        {
            "parentId": 193003,
            "extAttributeId": 64301,
            "encodedListItemId": 56401
        },
        {
            "parentId": 193003,
            "extAttributeId": 64301,
            "encodedListItemId": 56402
        }
    ]
}

Note: Metadata is available at api/metadata/activity.

Note: Metadata is available at api/metadata/activity-cell.

Note: Metadata is available at api/metadata/activity-cell-treatment.

Request Input Body:   
{
  title: string,
  description: string,
  startDate: DateTime,
  endDate: DateTime,
  activityId: number,
  milestoneEaId?: number
}

The milestoneEaId parameter refers to the Linked Activity Date EA. When this parameter is included in the payload, the provided dates in the request body will be ignored. The Milestone will be saved with the startDate and endDate values copied from the indicated Linked Activity Date EA attribute.

Metadata available at api/metadata/activity-offer

  {
    "activityId":68201, 
    "offerId": 8803
  }

Note: Metadata is available at api/metadata/activity-proposal.

Note: Metadata is available at api/metadata/activity-treatment.

Note: Metadata is available at api/metadata/attachment.

Note: Metadata available at api/metadata/attachmentversion.

There are more detailed instructions on how to upload files when creating new attachment versions on the file upload page.

Note: To retrieve the actual Attachment file, follow the downloadUri attribute from the GET response.

Note: Metadata is available at api/metadata/brand

Note: Metadata is available at api/metadata/client

Note: Metadata is available at api/metadata/commitment and api/metadata/commitment-item

Note: Metadata is available at api/metadata/content-plans

Note: Metadata is available at api/metadata/digital-asset.

Note: Metadata is available at api/metadata/digitalassetversion.

Notes:

• To retrieve the actual digital asset file, follow the ‘downloadUri attribute from the GET response.
• To retrieve the PDF file with annotations, follow the offline-windows or offline-mac link.

Note: Metadata is available at api/metadata/digital-asset-rendition.

There are more detailed instructions on how to upload files when creating new digital asset renditions on the file upload page.

Note: Metadata is available at api/metadata/financial-hierarchy.

Note: Metadata is available at api/metadata/funding-account.

Note: Metadata available at:

• api/metadata/generic-object-alpha
• api/metadata/generic-object-bravo
• api/metadata/generic-object-charlie
• api/metadata/generic-object-delta
• api/metadata/generic-object-echo

Note that Alpha objects are associated with Activities, and Bravo objects with Projects. Therefore, routes for Alpha objects are limited to objects for which the API user has Activity access rights (or the ‘API Integration’ right), and are also goverened by Activity domain rights. Similarly, access to Bravo objects is govererned by Project domain rights.

Note: Metadata is available at api/metadata/group.

Note: To assign users to groups, please use the create/update user endpoints. There is a groups property on users which will accept a comma separated array of group IDs.

Note: Metadata is available at api/metadata/invoice

Note: Metadata is available at api/metadata/journal-voucher

Please click here for a full list of available lookups

Note: Metadata is available at api/metadata/offer.

Note: Metadata is available at api/metadata/program.

Note: Metadata is available at api/metadata/program-proposal.

Note: Metadata is available at api/metadata/project.

Note: Metadata is available at api/metadata/reviewtask.

Note: Metadata is available at api/metadata/user-role.

Note: Metadata is available at api/metadata/supplier
Required Rights:

Supplier, View for GET all suppliers, POST search
Supplier, Edit for POST, GET specific ID.
Supplier, Edit and Supplier, Delete for DELETE

See additional endpoint details on the related article.

Note: Metadata is available at:

• api/metadata/task
• api/metadata/taskwork
• api/metadata/taskassignee
• api/metadata/taskroles

Note: Metadata is available at api/metadata/treatment.

Note: Metadata is available at api/metadata/user.

Tips:

• To make a Full user, set applicationUser=true, portalUser=true, reviewUser=true.
• To make a Contributor user, set applicationUser=false, portalUser=true, reviewUser=true.
• To make a Consumer user, set applicationUser=false, portalUser=true, reviewUser=false.
• The userType field will always be equal to 1 for users.
• To find groups of which a user is a member, examine the ‘groups’ property.
• To find a user’s domain rights, examine the ‘rights’ property. Note that these cannot be set today, however, you can set user groups which can also be used to manage functional rights.
• To find a user’s roles, examine the ‘roles’ property.
• To get a list of Investment Review User Backups, examine the ‘investmentReviewUserBackups’ property.
• To get a list of Investment Review Group Backups, examine the ‘investmentReviewGroupBackups’ property.
• To get a list of Activity Financial User Backups, examine the ‘activityFinancialUserBackups’ property.
• To get a list of Activity Financial Group Backups, examine the ‘activityFinancialGroupBackups’ property.
• To get a list of Concept Review User Backups, examine the ‘conceptReviewUserBackups’ property.
• To get a list of Concept Review Group Backups, examine the ‘conceptReviewGroupBackups’ property.
• To get a list of Workflow User Backups, examine the ‘workflowUserBackups’ property.
• To get a list of Workflow Group Backups, examine the ‘workflowGroupBackups’ property.
• To assign a My Home Page Template, see the ‘My Home Page Templates’ route.