Not logged in : Login |
path
The path of the collection to create.
permissions
The permissions of the newly created collection as detailed in Resource Permissions
parents
Can be one of all or none, to either create all parent collections or not. In the latter (the default) case the command will fail on existing collections. all is comparable to the -p option of the *NIX mkdir command.
det
The optional DET type of the created collection. If omitted a normal folder will be created. Can be one of:
Box - Box external driveDropbox - Dropbox external driveIMAP - IMAP mail boxGDrive - Google Drive external driveRACKSPACE - RACKSPACE external driveS3 - Amazon S3 external driveSkyDrive - SkyDrive external driveShare - Shared resourcesWebDAV - WebDAV external driveCardDAV - WebDAV CardDAV extension (RFC 6352)CalDAV - WebDAV CalDAV extension (RFC 4791)DynamicResource or DR - a store for dynamic SQL queries (in particular SPARQL)LinkedDataImport or LDI - import RDF data in an internal RDF graphSocialNetwork or SN - Social Networks external drives: Twitter, Facebook, LinkedIn, WordPress, Google+FTP - FTP external drive (passive mode)
Each DET type has specific parameters. Each parameter name must be prefixed with 'det_'. Params marked with asterisk (*) are required. The cartridges and metaCartridges params are comma separated cartridges IDs: 3,6,12.Box, Dropbox, SkyDrive, GDrive, SocialNetwork DET parameters:
network (SocialNetwork only) - The social network identifier - Facebook, LinkedIn, Twitter or WordPressserviceId - The identifier profile URLactivity - create activity log ('on') or not ('off')checkInterval - update interval in minutes (default value is 15)graph - SPARQL graph to store extracted tripletssponger - use sponger for extracting meta data ('on') or not ('off')cartridges - cartridges used by spongermetaCartridges - meta cartridges used by spongerdisplay_name - name of the user (not required)email - email of the user (not required)path - a path in the external storage used as a root path
S3 DET parameters:
activity - create activity log ('on') or not ('off')checkInterval - update interval in minutes (default value is 15)graph - SPARQL graph to store extracted tripletssponger - use sponger for extracting meta data ('on') or not ('off')cartridges - cartridges used by spongermetaCartridges - meta cartridges used by spongerBucketName (*) - name of the accessed buckedpath - a path in the external storage used as a root pathAccessKeyID (*) - access keySecretKey (*) - secret key
RACKSPACE DET parameters:
activity - create activity log ('on') or not ('off')checkInterval - update interval in minutes (default value is 15)graph - SPARQL graph to store extracted tripletssponger - use sponger for extracting meta data ('on') or not ('off')cartridges - cartridges used by spongermetaCartridges - meta cartridges used by spongerType (*) - type of the account: 'USA' or 'UK'User (*) - owner name of the accountContainer (*) - name of the accessed containerpath - a path in the external storage used as a root pathAPI_Key (*) - API key
IMAP DET parameters:
activity - create activity log ('on') or not ('off')checkInterval - update interval in minutes (default value is 15)graph - SPARQL graph to store extracted tripletssponger - use sponger for extracting meta data ('on') or not ('off')cartridges - cartridges used by spongermetaCartridges - meta cartridges used by spongerconnection (*) - type of connection: None ('none') or SSL/TLS ('ssl')server (*) - address of the IMAP serverport (*) - port of the IMAP serveruser (*) - owner name of the IMAP accountpassword (*) - owner password of the IMAP accountfolder - name of the retrieved folder
WebDAV DET parameters:
activity - create activity log ('on') or not ('off')checkInterval - update interval in minutes (default value is 15)graph - SPARQL graph to store extracted tripletssponger - use sponger for extracting meta data ('on') or not ('off')cartridges - cartridges used by spongermetaCartridges - meta cartridges used by spongerpath - path to the WebDAV dataauthenticationType (*) - 'Digest' or 'WebID'
Digest parameters:
user (*) - name for WebDAV accesspassword (*) - password for WebDAV access
WebID parameters:
key (*) - name of the stored key used for WebDAV accesskeyOwner (*) - name of the owner of the key
Linked Data Import (LinkedDataImport or LDI) DET parameters:
graph (*) - SPARQL graph to store extracted tripletsbase - Base IRI to resolve relative IRIs to absolutesponger - use sponger for extracting meta data ('on') or not ('off')cartridges - cartridges used by spongermetaCartridges - meta cartridges used by sponger
Social Networks (SocialNetwork or SN) parameters:
network - The social network identifier - Facebook, LinkedIn, Twitter, WordPress or Google+publish - enable ('on') or disable ('off') publishing postssubscribe - enable ('on') or disable ('off') subscribing postsserviceId - The identifier profile URLactivity - create activity log ('on') or not ('off')checkInterval - update interval in minutes (default value is 15)graph - SPARQL graph to store extracted tripletssponger - use sponger for extracting meta data ('on') or not ('off')cartridges - cartridges used by spongermetaCartridges - meta cartridges used by spongerdisplay_name - name of the user (not required)email - email of the user (not required)
FTP parameters:
activity - create activity log ('on') or not ('off')checkInterval - update interval in minutes (default value is 15)graph - SPARQL graph to store extracted tripletssponger - use sponger for extracting meta data ('on') or not ('off')cartridges - cartridges used by spongermetaCartridges - meta cartridges used by spongerhost - FTP host addresspath - FTP pathuser - name for FTP accesspassword - password for FTP access
Share, CardDAV, CalDAV, Dynamic Resource (DynamicResource, DR) DETs have not parameters.An error code as defined in Response format with a value of 1 on success. On error the HTTP status code will be set to 403 or 400, depending on the type of error.
Example 1:
$ curl -i "http://kingsley.idehen.net/ods/api/briefcase.collection.create?path=/DAV/home/demo/mytest&user_name=demo&password_hash=5863d9e4cbdf522eaa62e0747fceb1c5b249ba13"
HTTP/1.1 200 OK
Server: Virtuoso/06.02.3129 (Solaris) x86_64-pc-solaris2.10-64 VDB
Connection: Keep-Alive
Date: Tue, 10 May 2011 12:07:07 GMT
Accept-Ranges: bytes
Content-Type: text/xml; charset="UTF-8"
Content-Length: 60
1
1
1
1
1
Attributes | Values |
---|---|
type | |
Description |
Box, Dropbox, SkyDrive, GDrive, SocialNetwork DET parameters: S3 DET parameters: RACKSPACE DET parameters: IMAP DET parameters: WebDAV DET parameters: Digest parameters: WebID parameters: Linked Data Import (LinkedDataImport or LDI) DET parameters: Social Networks (SocialNetwork or SN) parameters: FTP parameters: Share, CardDAV, CalDAV, Dynamic Resource (DynamicResource, DR) DETs have not parameters. An error code as defined in Response format with a value of $ curl -i "http://kingsley.idehen.net/ods/api/briefcase.collection.create?path=/DAV/home/demo/mytest&user_name=demo&password_hash=5863d9e4cbdf522eaa62e0747fceb1c5b249ba13" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Solaris) x86_64-pc-solaris2.10-64 VDB Connection: Keep-Alive Date: Tue, 10 May 2011 12:07:07 GMT Accept-Ranges: bytes Content-Type: text/xml; charset="UTF-8" Content-Length: 60 <result> <code>1</code> <message>Success</message> </result> $ curl -i "http://kingsley.idehen.net/ods/api/briefcase.collection.create?path=/DAV/home/demo/mydet&user_name=demo&password_hash=5863d9e4cbdf522eaa62e0747fceb1c5b249ba13&det=IMAP&det_connection=ssl&det_server=imap.gmail.com&det_port=993&det_user=ods.check&det_password=*******" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Solaris) x86_64-pc-solaris2.10-64 VDB Connection: Keep-Alive Date: Tue, 10 May 2011 12:07:07 GMT Accept-Ranges: bytes Content-Type: text/xml; charset="UTF-8" Content-Length: 60 <result> <code>1</code> <message>Success</message> </result> $ curl -i "http://kingsley.idehen.net/ods/api/briefcase.collection.create?path=/DAV/home/demo/mydet&user_name=demo&password_hash=5863d9e4cbdf522eaa62e0747fceb1c5b249ba13&det=Dropbox" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Solaris) x86_64-pc-solaris2.10-64 VDB Connection: Keep-Alive Date: Tue, 10 May 2011 12:07:07 GMT Accept-Ranges: bytes Content-Type: text/xml; charset="UTF-8" Content-Length: 60 <result> <code>1</code> <message>Success</message> </result> $ curl -i "http://kingsley.idehen.net/ods/api/briefcase.collection.create?path=/DAV/home/demo/mydet&user_name=demo&password_hash=5863d9e4cbdf522eaa62e0747fceb1c5b249ba13&det=SkyDrive" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Solaris) x86_64-pc-solaris2.10-64 VDB Connection: Keep-Alive Date: Tue, 10 May 2011 12:07:07 GMT Accept-Ranges: bytes Content-Type: text/xml; charset="UTF-8" Content-Length: 60 <result> <code>1</code> <message>Success</message> </result> $ curl -i "http://kingsley.idehen.net/ods/api/briefcase.collection.create?path=/DAV/home/demo/mydet&user_name=demo&password_hash=5863d9e4cbdf522eaa62e0747fceb1c5b249ba13&det=LDI&det_graph=urn:dav:home:demo:mydet&det_base=http://kingsley.idehen.net/DAV/home/demo/mydet" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Solaris) x86_64-pc-solaris2.10-64 VDB Connection: Keep-Alive Date: Tue, 10 May 2011 12:07:07 GMT Accept-Ranges: bytes Content-Type: text/xml; charset="UTF-8" Content-Length: 60 <result> <code>1</code> <message>Success</message> </result> This function requries authentication via one of the supported authentication methods as described in ODS Authentication. |
name |
|
url | |
contentType |
|
httpMethod |
|
isWebServiceOf | |
oplwebservices:endPointURL | |
hasParameter | |
schema:shortDescription |
|
is target of |