ODS.VirtuosoOdsUbiquityAddressbook

Addressbook Ubiquity Commands

  1. establish OAuth session for ODS AddressBook? instance: 

    Syntax: ods-set-addressbook-oauth <session_key>
Example: ods-set-addressbook-oauth c4746c96bd8faa99798ad88448ba3bab

    • Example usage you can find here.
  2. create AddressBook? contact: 

    Syntax: ods-create-addressbook-contact <instance_id> name <name> [title <title>] [fName <fName>] [mName
<mName>] [lName <lName>] [fullName <fullName>] [gender <gender>] [birthday <birthday>]
[iri <iri>] [foaf <foaf>] [mail <mail>] [web <web>] [icq <icq>] [skype <skype>] [aim
<aim>] [yahoo <yahoo>] [msn <msn>] [hCountry <hCountry>] [hState <hState>] [hCity <hCity>]
[hCode <hCode>] [hAddress1 <hAddress1>] [hAddress2 <hAddress2>] [hTzone <hTzone>] [hLat
<hLat>] [hLng <hLng>] [hPhone <hPhone>] [hMobile <hMobile>] [hFax <hFax>] [hMail <hMail>]
[hWeb <hWeb>] [bCountry <bCountry>] [bState <bState>] [bCity <bCity>] [bCode <bCode>]
[bAddress1 <bAddress1>] [bAddress2 <bAddress2>] [bTzone <bTzone>] [bLat <bLat>] [bLng
<bLng>] [bPhone <bPhone>] [bMobile <bMobile>] [bFax <bFax>] [bIndustry <bIndustry>]
[bOrganization <bOrganization>] [bDepartment <bDepartment>] [bJob <bJob>] [bMail <bMail>]
[bWeb <bWeb>] [tags <tags>]
Example: ods-create-addressbook-contact 10 name John fName John lName Johnson mail john@openlinksw.com

    • Example usage you can find here.
  3. get contact resource information by resource ID: 

    Syntax: ods-get-addressbook-contact-by-id <contact_id>
Example: ods-get-addressbook-contact-by-id 1001

  4. update AddressBook? contact by resource ID: 

    Syntax: ods-update-addressbook-contact <contact_id> name <name> [title <title>] [fName <fName>] [mName
<mName>] [lName <lName>] [fullName <fullName>] [gender <gender>] [birthday <birthday>]
[iri <iri>] [foaf <foaf>] [mail <mail>] [web <web>] [icq <icq>] [skype <skype>] [aim
<aim>] [yahoo <yahoo>] [msn <msn>] [hCountry <hCountry>] [hState <hState>] [hCity <hCity>]
[hCode <hCode>] [hAddress1 <hAddress1>] [hAddress2 <hAddress2>] [hTzone <hTzone>] [hLat
<hLat>] [hLng <hLng>] [hPhone <hPhone>] [hMobile <hMobile>] [hFax <hFax>] [hMail <hMail>]
[hWeb <hWeb>] [bCountry <bCountry>] [bState <bState>] [bCity <bCity>] [bCode <bCode>]
[bAddress1 <bAddress1>] [bAddress2 <bAddress2>] [bTzone <bTzone>] [bLat <bLat>] [bLng
<bLng>] [bPhone <bPhone>] [bMobile <bMobile>] [bFax <bFax>] [bIndustry <bIndustry>]
[bOrganization <bOrganization>] [bDepartment <bDepartment>] [bJob <bJob>] [bMail <bMail>]
[bWeb <bWeb>] [tags <tags>]
Example: ods-update-addressbook-contact 1001 name John fName John lName Johnson fullName John Johnson mail john@openlinksw.com

  5. delete contact by resource ID: 

    Syntax: ods-delete-addressbook-contact <contact_id>
Example: ods-delete-addressbook-contact 1001

  6. export contacts: 

    Syntax: ods-export-addressbook <instance_id> [contentType <vcard|foaf|csv>]
Example: ods-export-addressbook 10 contentType vcard

  7. import contacts: 

    Syntax: ods-import-addressbook <instance_id> source <source> [sourceType <string|WebDAV|URL>] [contentType <contentType>] [tags <tags>]
Example: ods-import-addressbook 10 source /DAV/home/demo/contacts.vcard sourceType WebDAV

    • Example usage you can find here.
  8. create annotation to existing contact ID: 

    Syntax: ods-create-addressbook-annotation <contact_id> author <author> body <body>
Example: ods-create-addressbook-annotation 1001 author demo body OpenLink RDF Browser

  9. get contact annotation information by resource ID: 

    Syntax: ods-get-addressbook-annotation-by-id <annotation_id>
Example: ods-get-addressbook-annotation-by-id 10001

  10. create claim to existing annotation: 

    Syntax: ods-create-addressbook-annotation-claim <annotation_id> iri <iri> relation <relation> value <value>
Example: ods-create-addressbook-annotation-claim 10001 iri http://openlinksw.com relation rdfs:seeAlso value http://dbpedia.org
value <value>

  11. delete contact by resource ID: 

    Syntax: ods-delete-addressbook-annotation <annotation_id>
Example: ods-delete-addressbook-annotation 10001

  12. create comment to existing contact ID: 

    Syntax: ods-create-addressbook-comment <contact_id> title <title> body <body> author <author> authorMail <authorMail> authorUrl <authorUrl>
Example: ods-create-addressbook-comment 1001 title RDF body OpenLink RDF Browser author demo authorMail demo@openlinksw.com authorUrl  http://demo.openlinksw.com/rdfbrowser/

  13. get contact comment information by resource ID: 

    Syntax: ods-get-addressbook-comment-by-id <comment_id>
Example: ods-get-addressbook-comment-by-id 10001

  14. delete contact comment by resource ID: 

    Syntax: ods-delete-addressbook-comment <comment_id>
Example: ods-delete-addressbook-comment 10001

  15. create addressbook publication: 

    Syntax: ods-create-addressbook-publication <instance_id> name <name> [updateType <updateType>] [updatePeriod <hourly|daily>] [updateFreq <updateFreq>] [destinationType <destinationType>] destination <destination> [userName <userName>] [userPassword <userPassword>] [tagsInclude <tagsInclude>] [tagsExclude <tagsExclude>]
Example: ods-create-addressbook-publication 10 name Publish My Items destinationType WebDAV destination /~/demo/Public/DemoItems.vcard userName demo userPassword demo

    • Example usage you can find here.
  16. get addressbook publication information by resource ID: 

    Syntax: ods-get-addressbook-publication <publication_id>
Example: ods-get-addressbook-publication 1001

  17. update addressbook publication by resource ID: 

    Syntax: ods-update-addressbook-publication <publication_id> name <name> [updateType <updateType>] [updatePeriod <hourly|daily>] [updateFreq <updateFreq>] [destinationType <destinationType>] destination <destination> [userName <userName>] [userPassword <userPassword>] [tagsInclude <tagsInclude>] [tagsExclude <tagsExclude>]
Example: ods-update-addressbook-publication 1001 name Publish My Contacts destinationType WebDAV destination /~/demo/Public/DemoContacts.vcard userName demo userPassword demo

  18. sync addressbook publication by resource ID: 

    Syntax: ods-sync-addressbook-publication <publication_id>
Example: ods-sync-addressbook-publication 1001

    • Example usage you can find here.
  19. delete addressbook publication by resource ID: 

    Syntax: ods-delete-addressbook-publication <publication_id>
Example: ods-delete-addressbook-publication 1001

  20. create addressbook subscription: 

    Syntax: ods-create-addressbook-subscription <instance_id> name <name> [updateType <updateType>] [updatePeriod <hourly|daily>] [updateFreq <updateFreq>] [sourceType <sourceType>] source <source> [userName <userName>] [userPassword <userPassword>] [tagsInclude <tagsInclude>] [tagsExclude <tagsExclude>]
Example: ods-create-addressbook-subscription 10 name Subscribe Company Items sourceType WebDAV source /~/demo/Public/CompanyItems.vcard

    • Example usage you can find here.
  21. get addressbook subscription information by resource ID: 

    Syntax: ods-get-addressbook-subscription <subscription_id>
Example: ods-get-addressbook-subscription 1001

  22. update addressbook subscription by resource ID: 

    Syntax: ods-update-addressbook-subscription <subscription_id> name <name> [updateType <updateType>] [updatePeriod <hourly|daily>] [updateFreq <updateFreq>] [sourceType <sourceType>] source <source> [userName <userName>] [userPassword <userPassword>] [tagsInclude <tagsInclude>] [tagsExclude <tagsExclude>]
Example: ods-update-addressbook-subscription 1001 name Subscribe Company Contacts sourceType WebDAV source /~/demo/Public/CompanyContacts.vcard

  23. sync addressbook subscription by resource ID: 

    Syntax: ods-sync-addressbook-subscription <subscription_id>
Example: ods-sync-addressbook-subscription 1001

    • Example usage you can find here.
  24. delete addressbook subscription by resource ID: 

    Syntax: ods-delete-addressbook-subscription <subscription_id>
Example: ods-delete-addressbook-subscription 1001

  25. set addressbook instance options/properties: 

    Syntax: ods-set-addressbook-options <instance_id> options <options>
Example: ods-set-addressbook-options 10 options rows=20

  26. get addressbook instance options/properties: 

    Syntax: ods-get-addressbook-options <instance_id>
Example: ods-get-addressbook-options 10

References