Digital Repository Service
Provides services to interact with the Digial Repository: publication, search, retrieve and version history access.
Access to this service is restricted.
The following operations are supported. For a formal definition, please review the Service Description.
-
Delete
Deletes an existing material from the repository.Input message PackageId The package identifier. -
Find
Performs a search request on the digital repository.Input message Query The search query in XMDQL format. Start Start result index. Size Maximum number of results in the result set. Output message TotalCount The total number of results that match the query. Result Container element for result items. » Id Material unique numeric identifier. » PackageId The package identifier. » Type The material type. » Status Current material status. » Title Material title. » Descr Material description. -
GetHistory
Provides the versions history of a specific material.Input message PackageId The package identifier. Output message Version Container element for result items. Number Version number. DateTime Publication date and time. Username The username of who has published the version. Status Version status. Obsolete Boolean flag used to identify obsolete versions. Label Label attached to the version. Comment Comment attached to the version. -
GetStatus
Returns status information about specific package.Input message PackageId The package identifier. Output message CurrentStatus Container element for status information. Name Name of the current status. DevMode Boolean flag used to identify if a package is in development mode. RevMode Boolean flag used to identify if a package is in revision mode. DelMode Boolean flag used to identify if a package is in delivery mode. CheckoutStatus Container element for checkout status information. Status Name of the current checkout status (checkout|checkin). DateTime Last checkin/checkout operation date and time. User Last checkin/checkout operation user. AllowedActions Container element for allowed actions list. Update Boolean flag used to identify if user can update package. SetChekoutStatus If the user can change the package checkout status,
this element represents the package target checkout status.SetStatus If the user can change the package status,
this element represents one of the allowed target statuses. -
GetTypes
Returns the list of supported material types.Output message Code The package type unique string code. Preview The preview mode of the package type. Delivery The delivery mode of the package type. AggregationLevel The aggregation level of the package type. MetadataPosition The position of the main metadata section (resource level or manifest level). -
InsertNew
Asks for inserting a new content package into the repository.Input message PackageId The package identifier that the client wants to publish. Output message Proceed A boolean value that indicates if the client can proceed or not. FileName The name of the file the client must upload. Message An information message. UploadModes Container for the supported upload modes. Mode Upload mode (http or ftp). Url Url to be used for uploading. Username Optional username to be used for http or ftp authentication. Password Optional password to be used for http or ftp authentication. -
NotifyUploadDone
Notifies that the content package upload is completed.Input message Label Optional label for the new material version which will be created. Comment Optional comment for the new material version which will be created. -
SetCheckoutStatus
Set checkout status for a specific package.Input message PackageId The package identifier. CheckoutStatus The target checkout status. -
SetStatus
Set the status property of a particular material in digital repository.
This method is not yet implemented.Input message PackageId The package identifier. Status The status to set to the specified material. -
Update
Asks for updating an existing package in the repository.Input message PackageId The package identifier that the client wants to publish. Output message Proceed A boolean value that indicates if the client can proceed or not. FileName The name of the file the client must upload. Message An information message. UploadModes Container for the supported upload modes. Mode Upload mode (http or ftp). Url Url to be used for uploading. Username Optional username to be used for http or ftp authentication. Password Optional password to be used for http or ftp authentication.