Not logged in : Login

About: EntryPoint - briefcase_collection_create     Goto   Sponge   NotDistinct   Permalink

An Entity of Type : schema:EntryPoint, within Data Space : ods-qa.openlinksw.com:8896 associated with source document(s)

AttributesValues
type
described by
name
  • EntryPoint - briefcase_collection_create
schema:contentType
  • text/xml
description
  • 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 drive

    Dropbox - Dropbox external drive

    IMAP - IMAP mail box

    GDrive - Google Drive external drive

    RACKSPACE - RACKSPACE external drive

    S3 - Amazon S3 external drive

    SkyDrive - SkyDrive external drive

    Share - Shared resources

    WebDAV - WebDAV external drive

    CardDAV - 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 graph

    SocialNetwork 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 WordPress

serviceId - The identifier profile URL

activity - create activity log ('on') or not ('off')

checkInterval - update interval in minutes (default value is 15)

graph - SPARQL graph to store extracted triplets

sponger - use sponger for extracting meta data ('on') or not ('off')

cartridges - cartridges used by sponger

metaCartridges - meta cartridges used by sponger

display_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 triplets

sponger - use sponger for extracting meta data ('on') or not ('off')

cartridges - cartridges used by sponger

metaCartridges - meta cartridges used by sponger

BucketName (*) - name of the accessed bucked

path - a path in the external storage used as a root path

AccessKeyID (*) - access key

SecretKey (*) - 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 triplets

sponger - use sponger for extracting meta data ('on') or not ('off')

cartridges - cartridges used by sponger

metaCartridges - meta cartridges used by sponger

Type (*) - type of the account: 'USA' or 'UK'

User (*) - owner name of the account

Container (*) - name of the accessed container

path - a path in the external storage used as a root path

API_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 triplets

sponger - use sponger for extracting meta data ('on') or not ('off')

cartridges - cartridges used by sponger

metaCartridges - meta cartridges used by sponger

connection (*) - type of connection: None ('none') or SSL/TLS ('ssl')

server (*) - address of the IMAP server

port (*) - port of the IMAP server

user (*) - owner name of the IMAP account

password (*) - owner password of the IMAP account

folder - 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 triplets

sponger - use sponger for extracting meta data ('on') or not ('off')

cartridges - cartridges used by sponger

metaCartridges - meta cartridges used by sponger

path - path to the WebDAV data

authenticationType (*) - 'Digest' or 'WebID'

Digest parameters:

user (*) - name for WebDAV access

password (*) - password for WebDAV access

WebID parameters:

key (*) - name of the stored key used for WebDAV access

keyOwner (*) - name of the owner of the key

Linked Data Import (LinkedDataImport or LDI) DET parameters:

graph (*) - SPARQL graph to store extracted triplets

base - Base IRI to resolve relative IRIs to absolute

sponger - use sponger for extracting meta data ('on') or not ('off')

cartridges - cartridges used by sponger

metaCartridges - 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 posts

subscribe - enable ('on') or disable ('off') subscribing posts

serviceId - The identifier profile URL

activity - create activity log ('on') or not ('off')

checkInterval - update interval in minutes (default value is 15)

graph - SPARQL graph to store extracted triplets

sponger - use sponger for extracting meta data ('on') or not ('off')

cartridges - cartridges used by sponger

metaCartridges - meta cartridges used by sponger

display_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 triplets

sponger - use sponger for extracting meta data ('on') or not ('off')

cartridges - cartridges used by sponger

metaCartridges - meta cartridges used by sponger

host - FTP host address

path - FTP path

user - name for FTP access

password - 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://ods-qa.openlinksw.com/ods/api/briefcase.collection.create?path=/DAV/home/demo/mytest&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh"

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>

Example 2 (DET IMAP):

$ curl -i "http://ods-qa.openlinksw.com/ods/api/briefcase.collection.create?path=/DAV/home/demo/mydet&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh&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>

Example 3 (DET Dropbox):

$ curl -i "http://ods-qa.openlinksw.com/ods/api/briefcase.collection.create?path=/DAV/home/demo/mydet&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh&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>

Example 4 (DET SkyDrive):

$ curl -i "http://ods-qa.openlinksw.com/ods/api/briefcase.collection.create?path=/DAV/home/demo/mydet&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh&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>

Example 5 (DET Linked Data Import):

$ curl -i "http://ods-qa.openlinksw.com/ods/api/briefcase.collection.create?path=/DAV/home/demo/mydet&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh&det=LDI&det_graph=urn:dav:home:demo:mydet&det_base=http://ods-qa.openlinksw.com/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>

Authentication

This function requries authentication via one of the supported authentication methods as described in ODS Authentication.

schema:httpMethod
  • GET
schema:shortDescription
  • Create a new WebDAV collection/folder.

isWebServiceOf
url
oplwebservices:endPointURL
hasParameter
is topic of
is target of
Faceted Search & Find service v1.17_git55 as of Mar 01 2021


Alternative Linked Data Documents: ODE     Content Formats:       RDF       ODATA       Microdata      About   
This material is Open Knowledge   W3C Semantic Web Technology [RDF Data] Valid XHTML + RDFa
OpenLink Virtuoso version 08.03.3322 as of Mar 14 2022, on Linux (x86_64-generic-linux-glibc25), Single-Server Edition (7 GB total memory)
Data on this page belongs to its respective rights holders.
Virtuoso Faceted Browser Copyright © 2009-2024 OpenLink Software