OSDB  OSDB Service Actions

Actions for Service: ods_briefcase

Action IDDescription
briefcase_resource_delete
Action options:

-p, --path <path>
	<p>The path to the resource to be deleted.</p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_resource_vc_versions
Action options:

-p, --path <path>
	<p>The path to the versioned resource.</p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_property_set
Action options:

-p, --path <path>
	<p>The path of the resource which should be modified. </p>
	Required: yes
-n, --name <name>
	<p>The name of the property to change. </p>
	Required: yes
-v, --value <value>
	<p>The value of the property to change.</p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_resource_vc_lock
Action options:

-s, --state [state]
	<p>Can be 'on' or 'off' to either lock or unlock the resource.</p>
	Required: no
-p, --path <path>
	<p>The path to the resource to lock or unlock. </p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_resource_vc_checkin
Action options:

-p, --path <path>
	<p>The path to the resource to check in.</p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_resource_vc_info
Action options:

-p, --path <path>
	<p>Path to the resource in question.</p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_options_get
Action options:

-i, --inst_id <inst_id>
	<p>The id of the Briefcase instance. See <ref kindref="member" refid="group__ods__module__instance_1ods_instance_id">ODS App Instance Ids</ref> for details.</p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_options_set
Action options:

-o, --options <options>
	<p>A comma-separated list of <computeroutput>"key=value"</computeroutput> pairs. Supported keys are:<itemizedlist>
	<listitem><p>chars</p></listitem><listitem><p>rows</p></listitem><listitem><p>tbLabels</p></listitem><listitem><p>hiddens</p></listitem><listitem><p>atomVersion FIXME: what are these options?</p></listitem></itemizedlist>
	</p>
	Required: yes
-i, --inst_id <inst_id>
	<p>The id of the Briefcase instance. See <ref kindref="member" refid="group__ods__module__instance_1ods_instance_id">ODS App Instance Ids</ref> for details. </p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_collection_info
Action options:

-p, --path <path>
	<p>The path to the collection.</p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_resource_vc_get
Action options:

-v, --version [version]
	<p>The version to get. This can either be an exact numerical version to get or the special version 'last' which will fetch the last version that has been checked in. FIXME: is this correct?</p>
	Required: no
-p, --path <path>
	<p>The path of the resource to get. </p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_share_list
Action options:

-p, --path <path>
	<p>The path to the resource for which shares should be listed.</p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_move
Action options:

-f, --from_path <from_path>
	<p>The resource path. </p>
	Required: yes
-t, --to_path <to_path>
	<p>The target path. FIXME: is this like in UNIX shells or is this the new full path of the resource? </p>
	Required: yes
-o, --overwrite [overwrite]
	<p>Flag to indicate if an already existing resource at <computeroutput>to_path</computeroutput> should be overwritten. If 0 then then call will fail in case that a resource exists.</p>
	Required: no
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_list
Action options:

-p, --path <path>
	<p>The path to the WebDAV folder to list.</p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_property_get
Action options:

-n, --name [name]
	<p>The name of the property to return.</p>
	Required: no
-p, --path <path>
	<p>The path of the resource. </p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_resource_vc_set
Action options:

-s, --state [state]
	<p>Value indicating whether version control should be enabled ("on") or disabled ("off").</p>
	Required: no
-p, --path <path>
	<p>The path to the resource in question. </p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_property_list
Action options:

-m, --mask [mask]
	<p>FIXME: what is he mask?</p>
	Required: no
-p, --path <path>
	<p>The path of the resource to list properties for. </p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_collection_delete
Action options:

-p, --path <path>
	<p>The path to the collection to be deleted.</p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_resource_store
Action options:

-p, --path <path>
	<p>The target path of the newly created resource. </p>
	Required: yes
-q, --permissions [permissions]
	<p>The permissions of the newly created resource as detailed in <ref kindref="member" refid="group__ods__module__briefcase_1ods_briefcase_resource_permissions">Resource Permissions</ref>.</p>
	Required: no
-t, --type [type]
	<p>The mimetype of the resource. </p>
	Required: no
-c, --content [content]
	<p>The content of the resource. This parameter can only be used for rather small text files. Any other file content should be sent in the body of an HTTP POST request. </p>
	Required: no
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-s, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_resource_info
Action options:

-p, --path <path>
	<p>The path to the resource in question.</p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_resource_get
Action options:

-p, --path <path>
	<p>The path to the resource to retrieve.</p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_resource_vc_checkout
Action options:

-p, --path <path>
	<p>The path to the resource to check out.</p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_share_add
Action options:

-d, --deny [deny]
	<p>The permissions to deny the user. The value is the same as with <computeroutput>allow</computeroutput> except that the given rights are revoked instead of granted. Thus, specifying <computeroutput>"r--"</computeroutput> would revoke read rights while leaving the write and execute rights untouched.</p>
	Required: no
-i, --inheritance [inheritance]
	<p>The way the given rights should be propagated to children of the given path (in case of a collection).<itemizedlist>
	<listitem><p><computeroutput>'object'</computeroutput> will only change the permissions on the resource itself</p></listitem><listitem><p><computeroutput>'all'</computeroutput> will recursively update permissions on all children</p></listitem><listitem><p><computeroutput>'children'</computeroutput> will only update permissions on direct children. FIXME: is this correct? </p></listitem></itemizedlist>
	</p>
	Required: no
-p, --path <path>
	<p>The path to the resource to share. </p>
	Required: yes
-u, --user <user>
	<p>The user to share the resource with. </p>
	Required: yes
-a, --allow [allow]
	<p>The actions the <computeroutput>user</computeroutput> should be allowed to perform. This is a UNIX style permission mask string consisting of three chars <computeroutput>"rwx"</computeroutput>, referring to read, write, and execute permissions respectively. Each of these permissions can be granted by writing the character or not granted by writing a dash <computeroutput>-</computeroutput> instead. Example: <computeroutput>"r--"</computeroutput> would grant only read rights while it does not make any changes to the write and execute rights. </p>
	Required: no
-v, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_copy
Action options:

-t, --to_path <to_path>
	<p>The target path. FIXME: is this like in UNIX shells or is this the new full path of the resource? </p>
	Required: yes
-o, --overwrite [overwrite]
	<p>Flag to indicate if an already existing resource at <computeroutput>to_path</computeroutput> should be overwritten. If 0 then then call will fail in case that a resource exists. </p>
	Required: no
-p, --permissions [permissions]
	<p>The permissions of the newly created resource as detailed in <ref kindref="member" refid="group__ods__module__briefcase_1ods_briefcase_resource_permissions">Resource Permissions</ref>.</p>
	Required: no
-f, --from_path <from_path>
	<p>The resource path. </p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_share_remove
Action options:

-p, --path <path>
	<p>The path to the resource to remove the share from. </p>
	Required: yes
-u, --user <user>
	<p>The user to revoke the share from. </p>
	Required: yes
-i, --inheritance [inheritance]
	<p>The way the given rights should be propagated to children of the given path (in case of a collection).<itemizedlist>
	<listitem><p><computeroutput>'object'</computeroutput> will only change the permissions on the resource itself</p></listitem><listitem><p><computeroutput>'all'</computeroutput> will recursively update permissions on all children</p></listitem><listitem><p><computeroutput>'children'</computeroutput> will only update permissions on direct children. FIXME: is this correct?</p></listitem></itemizedlist>
	</p>
	Required: no
-v, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_collection_create
Action options:

-d, --det [det]
	<p>The optional DET type of the created collection. If omitted a normal folder will be created. Can be one of:<itemizedlist>
	<listitem><p><computeroutput>Box</computeroutput> - Box external drive</p></listitem><listitem><p><computeroutput>Dropbox</computeroutput> - Dropbox external drive</p></listitem><listitem><p><computeroutput>IMAP</computeroutput> - IMAP mail box</p></listitem><listitem><p><computeroutput>GDrive</computeroutput> - Google Drive external drive</p></listitem><listitem><p><computeroutput>RACKSPACE</computeroutput> - RACKSPACE external drive</p></listitem><listitem><p><computeroutput>S3</computeroutput> - Amazon S3 external drive</p></listitem><listitem><p><computeroutput>SkyDrive</computeroutput> - SkyDrive external drive</p></listitem><listitem><p><computeroutput>Share</computeroutput> - Shared resources</p></listitem><listitem><p><computeroutput>WebDAV</computeroutput> - WebDAV external drive</p></listitem><listitem><p><computeroutput>CardDAV</computeroutput> - WebDAV CardDAV extension (RFC 6352)</p></listitem><listitem><p><computeroutput>CalDAV</computeroutput> - WebDAV CalDAV extension (RFC 4791)</p></listitem><listitem><p><computeroutput>DynamicResource</computeroutput> or DR - a store for dynamic SQL queries (in particular SPARQL)</p></listitem><listitem><p><computeroutput>LinkedDataImport</computeroutput> or LDI - import RDF data in an internal RDF graph</p></listitem><listitem><p><computeroutput>SocialNetwork</computeroutput> or SN - Social Networks external drives: Twitter, Facebook, LinkedIn, WordPress, Google+</p></listitem><listitem><p><computeroutput>FTP</computeroutput> - FTP external drive (passive mode)</p></listitem></itemizedlist>
	</p>
	Required: no
-p, --parents [parents]
	<p>Can be one of <computeroutput>all</computeroutput> or <computeroutput>none</computeroutput>, to either create all parent collections or not. In the latter (the default) case the command will fail on existing collections. <computeroutput>all</computeroutput> is comparable to the <computeroutput>-p</computeroutput> option of the *NIX <computeroutput>mkdir</computeroutput> command. </p>
	Required: no
-q, --permissions [permissions]
	<p>The permissions of the newly created collection as detailed in <ref kindref="member" refid="group__ods__module__briefcase_1ods_briefcase_resource_permissions">Resource Permissions</ref> </p>
	Required: no
-r, --path <path>
	<p>The path of the collection to create. </p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-s, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-t, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no
briefcase_property_remove
Action options:

-n, --name <name>
	<p>The name of the property to remove.</p>
	Required: yes
-p, --path <path>
	<p>The path of the resource. </p>
	Required: yes
-u, --url_only [url_only]
	Return only the action URL, not the action results
	Required: no
-r, --response_format [response_format]
	Sets the response media type through an Accept header.
	Required: no
	Permitted values: text/xml
-q, --quality_values [quality_values]
	Quality value string. e.g. application/json;q=1.0,text/turtle;q=0.8,*/*;q=0.5. 
	--response_format takes precedence.
	Required: no