---++ODS Briefcase Controllers
|*Controller*|*Demo Links*|*Description*|
|
briefcase.list (
path varchar
)
| * [[VirtuosoOdsControllersBriefcaseEx0][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx0a][cURL Example]]|Get Items List(XML)|
|
briefcase.resource.info (
path varchar
)
| * [[VirtuosoOdsControllersBriefcaseEx1][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx1a][cURL Example]]|Get Resource Details (XML)|
|
briefcase.resource.get (
path varchar
)
| * [[VirtuosoOdsControllersBriefcaseEx2][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx2a][cURL Example]]|Get Resource Content|
|
briefcase.resource.store (
path varchar,
content varchar,
type varchar default null,
permissions varchar default '110100100RM'
)
| * [[VirtuosoOdsControllersBriefcaseEx3][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx33][cURL Example]]|Create New Resource|
|
briefcase.resource.delete (
path varchar)
| * [[VirtuosoOdsControllersBriefcaseEx4][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx44][cURL Example]]|Delete Resource|
|
briefcase.resource.vc.set (
path varchar,
state varchar := 'on')
| * [[VirtuosoOdsControllersBriefcaseEx5][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx55][cURL Example]]|Set Resource Under Version Control. State can be 'on' or 'off'.|
|
briefcase.resource.vc.info (
path varchar)
| * [[VirtuosoOdsControllersBriefcaseEx6][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx66][cURL Example]]|Get Resource Version Control Details |
|
briefcase.resource.vc.checkout (
path varchar
)| * [[VirtuosoOdsControllersBriefcaseEx7][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx77][cURL Example]]|Check-Out Resource|
|
briefcase.resource.vc.checkin (
path varchar
)| * [[VirtuosoOdsControllersBriefcaseEx8][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx88][cURL Example]]|Check-In Resource |
|
briefcase.resource.vc.lock (
path varchar,
state varchar := 'on'
)| * [[VirtuosoOdsControllersBriefcaseEx9][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx99][cURL Example]]|Lock Resource. State can be 'on' (lock) or 'off' (unlock). |
|
briefcase.resource.vc.get (
path varchar,
version varchar := 'last'
)| * [[VirtuosoOdsControllersBriefcaseEx10][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx1010][cURL Example]]|Get Resource Version Content|
|
briefcase.resource.vc.versions (
path varchar
)| * [[VirtuosoOdsControllersBriefcaseEx11][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx1111][cURL Example]]|Get Resource Versions Details|
|
briefcase.collection.create (
path varchar,
permissions varchar := '110100100RM'
)| * [[VirtuosoOdsControllersBriefcaseEx12][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx1212][cURL Example]]|Create New Collection|
|
briefcase.collection.info (
path varchar
)| * [[VirtuosoOdsControllersBriefcaseEx13][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx1313][cURL Example]]|Get Collection Details|
|
briefcase.collection.delete (
path varchar
)| * [[VirtuosoOdsControllersBriefcaseEx14][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx1414][cURL Example]]|Delete Collection|
|
briefcase.copy (
from_path varchar,
to_path varchar,
overwrite int := 0,
permissions varchar := '110100000RR'
)
| * [[VirtuosoOdsControllersBriefcaseEx15][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx1515][cURL Example]]|Copy Resource(s)|
|
briefcase.move (
from_path varchar,
to_path varchar
)| * [[VirtuosoOdsControllersBriefcaseEx16][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx1616][cURL Example]]|Move Resource(s)|
|
briefcase.property.set (
path varchar,
name varchar,
value varchar
)| * [[VirtuosoOdsControllersBriefcaseEx17][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx1717][cURL Example]]|Create New Property / Update Existing Property|
|
briefcase.property.list (
path varchar
)
| * [[VirtuosoOdsControllersBriefcaseEx18][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx1818][cURL Example]]|Get Resource / Collection Properties Details |
|
briefcase.property.get (
path varchar,
name varchar
)
| * [[VirtuosoOdsControllersBriefcaseEx19][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx1919][cURL Example]]|Get Property Value|
|
briefcase.property.remove (
path varchar,
name varchar
)
| * [[VirtuosoOdsControllersBriefcaseEx20][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx2020][cURL Example]]|Remove Property|
|
briefcase.share.add (
path varchar,
user varchar,
inheritance varchar := 'all',
allow varchar := 'rw-',
deny varchar := '---'
)
| * [[VirtuosoOdsControllersBriefcaseEx21][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx2121][cURL Example]]|Share Resource Or Collection To User. The inheritance is one of the following: 'object', 'all', 'children'. |
|
briefcase.share.list (
path varchar
)
| * [[VirtuosoOdsControllersBriefcaseEx22][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx2222][cURL Example]]|Get Resource Or Collection Shares Details|
|
briefcase.share.remove (
path varchar,
user varchar,
inheritance varchar := 'all'
)
| * [[VirtuosoOdsControllersBriefcaseEx23][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx2323][cURL Example]]|Remove Share|
|
briefcase.options.set (
inst_id integer,
options any
)
| * [[VirtuosoOdsControllersBriefcaseEx24][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx2424][cURL Example]]| Set ODS Briefcase Instance Options.
Options parameters names can be:
- chars
- rows
- tbLabels
- hiddens
- atomVersion
|
|
briefcase.options.get (
inst_id integer
)
| * [[VirtuosoOdsControllersBriefcaseEx25][Using OAuth Tool Example]]
* [[VirtuosoOdsControllersBriefcaseEx2525][cURL Example]]|Get ODS Briefcase Instance Options Details|
---+++Examples
* [[VirtOAuthTestToolExampleBriefcase][ODS Briefcase OAuth REST API Example performed with the Virtuoso OAuth Testing Tool]]
---+++References
* [[VirtuosoOdsControllers][ODS Controllers]]