TNS Internal:NDR/API/2.0/implementationDetails/deleteCollection

From NSDLWiki

Jump to: navigation, search

Return to NDR/API 2.0 Requests By Object



Under Construction
Proposed method for inclusion in NDR/API 2.0.

NDR API Implementation Details - deleteCollection

Delete a collection for aggregating objects providing provenience that identifies the provider(s) of metadata and information stored as a part of this collection. Delete all objects that were created as part of the addCollection process.


Input Discussions

  • first parameter (required) is handle to collection aggregator


  • Should this cascade to resources if all metadata and annotations related to the resource are deleted?
  • Should cascade be assumed by definition of a collection?

purge vs. delete

Output Discussions


  • specific syntax for indicating success is unknown


  • specific syntax for error conditions is unknown
  • list of possible error conditions is unknown

Processing Discussions

  • what gets deleted?
    • collection aggregator
    • all metadata providers
    • all metadata for the metadata providers
    • collection resource
    • collection metadata
  • do deletes cascade?
    • yes - all objects created by addCollection AND all metadata objects
    • maybe - what about resources that no longer have metadata once the metadata objects are deleted?
  • are objects deleted or purged?
    • v1.0 API marks objects as deleted

General Discussions


Developer: TBA

Basic description of the process...

  • TBA


API Links:

Additional Links Related to This Call:

Personal tools