Contexts
Record Types
List
GET /rest/contexts/list.json
Retrieve a list of object contexts with IDs, names, custom fields and fieldsets. This includes object contexts contributed by plugins.
Example:
$out = $cerb->get($base_url . 'contexts/list.json');
Activity Log
List Events
GET /rest/contexts/activity/events.json
Retrieve a list of activity log event IDs and names, including those contributed by plugins.
Example:
$out = $cerb->get($base_url . 'contexts/activity/events.json');
Create
POST /rest/contexts/activity/create.json
Create an activity log entry.
Field | Type |
---|---|
on |
string |
activity_point |
string |
variables |
JSON array |
urls |
JSON array |
-
The
on
field should be a target record incontext:context_id
format. -
The
activity_point
field contains an activity ID from List Events request above. You can implement new Activity Log events in the<activity_points>
section of a plugin.xml manifest. -
The
variables
field should be a JSON encoded array, where the key is a placeholder in the activity log message and the value is the text to substitute. -
The
urls
field is an option JSON encoded array, where the key is a placeholder in the activity log message and the value is the URL to use for hyperlinking the text.
You do not need to provide a value for {{actor}} in variables or urls since this is handled automatically by Cerb.
Example:
$postfields = array(
array('on','cerberusweb.contexts.worker:2'),
array('activity_point','example.worker_high_five'),
array('variables', json_encode(array(
'target' => 'Dan Hildebrandt',
))),
array('urls', json_encode(array(
'target' => 'ctx://cerberusweb.contexts.worker:2'
))),
);
$out = $cerb->post($base_url . 'contexts/activity/create.json', $postfields);
Links
Link
POST /rest/contexts/link.json
Add any number of links to one context record.
Field | Type |
---|---|
on |
string |
targets |
JSON array string |
Example:
$postfields = array(
array('on','cerberusweb.contexts.ticket:1148'),
array('targets', json_encode(array(
'cerberusweb.contexts.org:17581',
'cerberusweb.contexts.address:5447',
))),
);
$out = $cerb->post($base_url . 'contexts/link.json', $postfields);
Unlink
POST /rest/contexts/unlink.json
Remove any number of links from one context record.
Field | Type |
---|---|
on |
string |
targets |
JSON array string |
Example:
$postfields = array(
array('on','cerberusweb.contexts.ticket:1148'),
array('targets', json_encode(array(
'cerberusweb.contexts.org:17581',
))),
);
$out = $cerb->post($base_url . 'contexts/unlink.json', $postfields);