Bookmark Manager's Programmers Guide

Bookmark Manager Controllers

Bookmark get

• Description: get bookmark by given id
• API name: ODS.ODS_API."bookmark.get"
• Parameters:
  • bookmark_id

Bookmark new

• Description: creates new bookmark
• API name: ODS.ODS_API."bookmark.new"
• Parameters:
  • inst_id
  • uri
  • name
  • description
  • tags
  • folder_id

Bookmark edit

• Description: edits bookmark by given id
• API name: ODS.ODS_API."bookmark.edit"
• Parameters:
  • bookmark_id
  • uri
  • name
  • description
  • tags
  • folder_id

Bookmark delete

• Description: deletes bookmark by given id
• API name: ODS.ODS_API."bookmark.delete"
• Parameters:
  • bookmark_id

Folder new

• Description: create new bookmarks folder
• API name: ODS.ODS_API."bookmark.folder.new"
• Parameters:
  • inst_id
  • path

Folder delete

• Description: deletes bookmark folder by given path
• API name: ODS.ODS_API."bookmark.folder.delete"
• Parameters:
  • inst_id
  • path

Bookmark Import

• Description: Imports bookmarks
• API name: ODS.ODS_API."bookmark.import"
• Parameters:
  • inst_id
  • source
  • sourceType
  • tags

Bookmark Export

• Description: export bookmarks
• API name: ODS.ODS_API."bookmark.export"
• Parameters:
  • inst_id
  • contentType

Annotaiton get

• Description: gets annotation by given id
• API name: ODS.ODS_API."bookmark.annotation.get"
• Parameters:
  • annotation_id

Annotation new

• Description: creates new annotation
• API name: ODS.ODS_API."bookmark.annotation.new"
• Parameters:
  • bookmark_id
  • author
  • body

Annotation claim

• Description: creates annotation claim
• API name: ODS.ODS_API."bookmark.annotation.claim"
• Parameters:
  • annotation_id
  • claimIri
  • claimRelation
  • claimValue

Annotation delete

• Description: deletes annotation by given id
• API name: ODS.ODS_API."bookmark.annotation.delete"
• Parameters:
  • annotation_id

Comment get

• Description: gets comment by given id
• API name: ODS.ODS_API."bookmark.comment.get"
• Parameters:
  • comment_id

Comment new

• Description: creates new comment
• API name: ODS.ODS_API."bookmark.comment.new"
• Parameters:
  • bookmark_id
  • parent_id
  • title
  • text
  • name
  • email
  • url

Comment delete

• Description: deletes comment by given id
• API name: ODS.ODS_API."bookmark.comment.delete"
• Parameters:
  • comment_id

Publication new

• Description: creates new publication
• API name: ODS.ODS_API."bookmark.publication.new"
• Parameters:
  • inst_id
  • name
  • updateType
  • updatePeriod
  • updateFreq
  • destinationType
  • destination
  • userName
  • userPassword
  • folderPath
  • tagsInclude
  • tagsExclude

Publication edit

• Description: edits existing publication
• API name: ODS.ODS_API."bookmark.publication.edit"
• Parameters:
  • publication_id
  • name
  • updateType
  • updatePeriod
  • updateFreq
  • destinationType
  • destination
  • userName
  • userPassword
  • folderPath
  • tagsInclude
  • tagsExclude

Publication delete

• Description: deletes publication by given id
• API name: ODS.ODS_API."bookmark.publication.delete"
• Parameters:
  • publication_id

Subscription new

• Description: creates new subscription
• API name: ODS.ODS_API."bookmark.subscription.new"
• Parameters:
  • inst_id
  • name
  • updateType
  • updatePeriod
  • updateFreq
  • sourceType
  • source
  • userName
  • userPassword
  • folderPath
  • tags

Subscription edit

• Description: edits existing subcription
• API name: ODS.ODS_API."bookmark.subscription.edit"
• Parameters:
  • subscription_id
  • name
  • updateType
  • updatePeriod
  • updateFreq
  • sourceType
  • source
  • userName
  • userPassword
  • folderPath
  • tags

Subscription delete

• Description: deletes subscription by given id
• API name: ODS.ODS_API."bookmark.subscription.delete"
• Parameters:
  • subscription_id

Options set

• Description: sets options
• API name: ODS.ODS_API."bookmark.options.set"
• Parameters:
  • inst_id
  • options

Options get

• Description: gets options
• API name: ODS.ODS_API."bookmark.options.get"
• Parameters:
  • inst_id