Web Services API

post_object

Usage:post_object(params)
Input:{ path: [{ attr: value, ...}, type_name], ...}
Returns:[path, ...]
Example:Post a new content object

put_object

Usage:put_object(params)
Input:{ path: [{ attr: value, ...}, type_name], ...}
Returns:[path, ...]
Example:Put or update information on a content object

get_object

Usage:get_object(path=[])
Input:None | [path, ...]
Returns:{ path: [{ attr: value, ...}, type_name, {misc_info: value}], ...}
Example:Get a content object

delete_object

Usage:delete_object(path=[])
Input:None | [path, ...]
Returns:None
Example:Delete a content object

query

Usage:query(filtr={})
Returns:{ path: {index_id: value, ...}, ...}
Example:Finding what you’re looking for

get_schema

Usage:get_schema(type_name, path='')
Returns:{ attr: {required: True | False, type: type_string, ...}, ...}
Example:Get a content object’s structure

get_types

Usage:get_types(path='')
Returns:[[type_id, type_title], ...]
Example:Get the available content-types

get_workflow

Usage:get_workflow(path='')
Returns:{ state: current_state, transitions: [transition_name, ...], ...}
Example:Get a content object’s workflow state

set_workflow

Usage:set_workflow(transition, path='')
Returns:None
Example:Transition a content object’s workflow state

get_discussion

Usage:get_discussion(path='')
Returns:
{'id': {'in_reply_to': 'another_id',
        'title': '',
        'text': '',
        'cooked_text': '',
        'created': '2009-11-03 12:12:59',
        'creators': ()
        }, ...
 }
Example:Get a content object’s discussion container