Click or drag to resize

IHdsiServiceContract Methods

The IHdsiServiceContract type exposes the following members.

Methods
 NameDescription
Public methodAssociationCreate Assigns the child object as a child (or link) of the parent
Public methodAssociationGet(String, String, String) Performs a linked or chained search on a sub-property
Public methodAssociationGet(String, String, String, String) Performs a linked or chained search on a sub-property
Public methodAssociationRemove(String, String, String) Removes a child resource instance from the parent container
Public methodAssociationRemove(String, String, String, String) Removes a child resource instance from the parent container
Public methodAssociationSearch(String, String) Performs a linked or chained search on a sub-property
Public methodAssociationSearch(String, String, String) Performs a linked or chained search on a sub-property
Public methodCheckIn Releases an edit lock on the specified object
Public methodCheckOut Acquires an edit lock on the specified object
Public methodCopy Downloads a copy of the specified resource and all dependent objects from another cdr to this CDR
Public methodCreate Creates the resource. If the resource already exists, then a 409 is thrown
Public methodCreateUpdate Creates or updates a resource. That is, creates the resource if it does not exist, or updates it if it does
Public methodDelete Deletes the specified resource from the server
Public methodGet Retrieves the current version of the specified resource
Public methodGetBarcode Gets the specified barcode for the resource
Public methodGetDataset Get the dataset for the specified object
Public methodGetSchema Get the schema of the HDSI API for use in code generation frameworks
Public methodGetVersion Retrieves a specific version of the specified resource
Public methodGetVrpPointerData Gets the digitally signed pointer (in JWS format) for the resource
Public methodHead Retrieves only the metadata of the specified resource
Public methodHeadSearch Perform a search (query) and return only the headers
Public methodHistory Gets a complete history of all changes made to the specified resource
Public methodInvokeMethod(String, String, ParameterCollection) Invokes the specified operation
Public methodInvokeMethod(String, String, String, ParameterCollection) Invokes the specified operation
Public methodOptions Returns a service capability statement of the HDSI
Public methodPatch Updates the specified resource according to the instructions in the PATCH file
Public methodPatchAll Performs a patch on all resources in the resourceType collection
Public methodPing Performs a minimal PING request to test service availability
Public methodResolvePointer Resolve a code to a resource by posting a form-encoded search to the API
Public methodResourceOptions Returns specific options for a single resource
Public methodSearch Perform a search (query) for resourceType matching the HTTP query parameters provided
Public methodTime Gets the current server time from the API allowing for time synchronization
Obsolete
Public methodTouch Touch the resource (update its timestamp) without modifying the resource itself
Public methodUpdate Updates the specified resource. If the resource does not exist than a 404 is thrown, if there is a conflict (such a mismatch of data) a 409 is thrown
Top
See Also