Click or drag to resize

IAmiServiceContract Interface

Administrative Management Interface (AMI)

Namespace:  SanteDB.Rest.AMI
Assembly:  SanteDB.Rest.AMI (in SanteDB.Rest.AMI.dll) Version: 2.2.1
Syntax
Copy
public interface IAmiServiceContract : IRestApiContractImplementation

The IAmiServiceContract type exposes the following members.

Methods
  NameDescription
Public methodAssociationCreate
Assigns the body object with the resource at resourceType/key
Public methodAssociationGet
Performs a linked or chained search on a sub-property
Public methodAssociationRemove
Removes an association
Public methodAssociationSearch
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 methodCreate
Creates the specified resource
Public methodCreateDiagnosticReport
Creates a diagnostic report.
Public methodCreateUpdate
Creates the specified resource if it does not exist, otherwise updates it
Public methodDelete
Deletes the specified resource
Public methodDownloadLog
Download log
Public methodGet
Gets the specified resource from the service
Public methodGetLog
Gets a specific log file.
Public methodGetLogs
Get log files on the server and their sizes.
Public methodGetSchema
Get the schema for this service
Public methodGetServerDiagnosticReport
Gets a server diagnostic report.
Public methodGetTfaMechanisms
Gets the TFA mechanisms which can be set for the specified ID
Public methodGetVersion
Gets the specified versioned copy of the data
Public methodHead
Heads the specified resource from the service
Public methodHistory
Gets a complete history of changes made to the object (if supported)
Public methodInvokeMethod(String, String, ParameterCollection)
Invokes the specified operation
Public methodInvokeMethod(String, String, String, ParameterCollection)
Invokes the specified operation
Public methodLock
Locks the specified resource from the service
Public methodOptions
Get the service options
Public methodPatch
Updates the specified resource according to the instructions in the PATCH file
Public methodPing
Ping the service to determine up/down
Public methodResourceOptions
Get the specific options supported for the
Public methodSearch
Searches the specified resource type for matches
Public methodUnLock
Unlocks the specified resource from the service
Public methodUpdate
Updates the specified resource
Top
Remarks
This service contract represents the functionality required to administer the SanteDB server.
See Also