CRM-2 Activities API

From Opentaps Wiki
Revision as of 14:56, 19 April 2013 by Oandreyev (talk | contribs) (Protected "CRM-2 Activities API": Sysop page [edit=sysop:move=sysop])
Jump to navigationJump to search

Activities API allows to perform operations on activities.

The API calls should be prefixed with URL http://crm-2-url/activities.

Available operations are:

GET: Retrieve activities

Use pattern /{numberOfActivities}/{startFrom}

  • numberOfActivities - number of activities to return.
  • startFrom(optional) - return activities skipping specified number of items. W/o this attribute service returns all activites.

DELETE: Delete an activity

Use pattern /{activityId}

  • activityId - An activity identifier.

POST: Create or update activity

There is no special pattern. Post request to /activities.

POST: Associate a contact with an activity in a role.

Use pattern /contact/add Required parameters:

=== POST: Remove contact association. Use pattern /contact/remove