ODS.VirtuosoOdsControllersBriefcase

ODS Briefcase Controllers

ControllerSort in ascending order Demo Links Description

briefcase.list (
  path varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Get Items List(XML)

briefcase.resource.info (
  path varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Get Resource Details (XML)

briefcase.resource.get (
  path varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Get Resource Content

briefcase.resource.store (
  path varchar,
  content varchar,
  type varchar default null,
  permissions varchar default '110100100RM'
)
  *  Using OAuth Tool Example
  *  cURL Example
Create New Resource

briefcase.resource.delete (
  path varchar)
  *  Using OAuth Tool Example
  *  cURL Example
Delete Resource

briefcase.resource.vc.set (
  path varchar,
  state varchar := 'on')
  *  Using OAuth Tool Example
  *  cURL Example
Set Resource Under Version Control. State can be 'on' or 'off'.

briefcase.resource.vc.info (
  path varchar)
  *  Using OAuth Tool Example
  *  cURL Example
Get Resource Version Control Details

briefcase.resource.vc.checkout (
  path varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Check-Out Resource

briefcase.resource.vc.checkin (
  path varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Check-In Resource

briefcase.resource.vc.lock (
  path varchar,
  state varchar := 'on'
)
  *  Using OAuth Tool Example
  *  cURL Example
Lock Resource. State can be 'on' (lock) or 'off' (unlock).

briefcase.resource.vc.get (
  path varchar,
  version varchar := 'last'
)
  *  Using OAuth Tool Example
  *  cURL Example
Get Resource Version Content

briefcase.resource.vc.versions (
  path varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Get Resource Versions Details

briefcase.collection.create (
  path varchar,
  permissions varchar := '110100100RM'
)
  *  Using OAuth Tool Example
  *  cURL Example
Create New Collection

briefcase.collection.info (
  path varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Get Collection Details

briefcase.collection.delete (
  path varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Delete Collection

briefcase.copy (
  from_path varchar,
  to_path varchar,
  overwrite int := 0,
  permissions varchar := '110100000RR'
)
  *  Using OAuth Tool Example
  *  cURL Example
Copy Resource(s)

briefcase.move (
  from_path varchar,
  to_path varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Move Resource(s)

briefcase.property.set (
  path varchar,
  name varchar,
  value varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Create New Property / Update Existing Property

briefcase.property.list (
  path varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Get Resource / Collection Properties Details

briefcase.property.get (
  path varchar,
  name varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Get Property Value

briefcase.property.remove (
  path varchar,
  name varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Remove Property

briefcase.share.add (
  path varchar,
  user varchar,
  inheritance varchar := 'all',
  allow varchar := 'rw-',
  deny varchar := '---'
)
  *  Using OAuth Tool Example
  *  cURL Example
Share Resource Or Collection To User. The inheritance is one of the following: 'object', 'all', 'children'.

briefcase.share.list (
  path varchar
)
  *  Using OAuth Tool Example
  *  cURL Example
Get Resource Or Collection Shares Details

briefcase.share.remove (
  path varchar,
  user varchar,
  inheritance varchar := 'all'
)
  *  Using OAuth Tool Example
  *  cURL Example
Remove Share

briefcase.options.set (
  inst_id integer,
  options any
)
  *  Using OAuth Tool Example
  *  cURL Example
Set ODS Briefcase Instance Options.
Options parameters names can be:
  - chars
  - rows
  - tbLabels
  - hiddens
  - atomVersion

briefcase.options.get (
  inst_id integer
)
  *  Using OAuth Tool Example
  *  cURL Example
Get ODS Briefcase Instance Options Details

Examples

References