IE Update Web Services
General Purpose
The IE Update Web Services allow users to retrieve an IE and update its metadata without using the Rosetta UI.
Note: getMD and updateMD only support descriptive metadata (ie-dmd DC and source). As of 5.1 (logical) structmaps are also supported.
Required Role: Data Manager (full) or Editor (full).
Available Web Services
For specific details for each web-service (input parameters, returned XML) see the javadoc.
| Method | From | Description |
|---|---|---|
| getIE | 3.2 | Returns the METS file of the last version of requested IE, based on its PID. The METS file will include the latest revisions of all the Representations, including the Derivative Copies.Flags determine which elements to include (see javadoc). |
| getMD | 3.2 | Gets the metadata of an IE , REP or File. Only metadata on entity level (which is in Permanent) is returned. The ID of the source MD section is the MID (saved in Rosetta DB). |
| updateMD | 3.2 | Updates the metadata of a IE, REP or File according to the given Metadata object. |
| getDNX | 5.3 | Retrieves a DNX metadata record. |
| updateDNX | 5.3 | Updates a DNX metadata record (read-only fields are ignored; refer to Rosetta AIP Data Model document for details). |
| updateRepresentation | 3.2 | Updates an existing representation according to the given RepresentationContent object. |
| getRipStatus | 3.2 | Returns the current status of the given RIP. Can be one of the following: Finished, In Process – [stage], In TA – [stage]. |
| generateFixityEvent | 3.01 | Sends a fixity event for Rosetta to process. (The Event Handler in Rosetta determines whether the event is a provenance event or only a statistics event.) |
| createSharedMD | 5.0 | Creates a shared metadata record |
| getSharedMD | 5.0 | Returns a shared metadata record (by assigned object’s PID) |
| getSharedMDByMid | 5.0 | Returns a shared metadata record by MID |
| getSharedMDByType | 5.0 | Returns a shared metadata record by metadata type |
| assignSharedMD | 5.0 | Assigns a shared metadata record to an object |
| unassignSharedMD | 5.0 | Unassigns a shared metadata record from an object |
| updateSharedMD | 5.0 | Updates a shared metadata record |
| deleteSharedMD | 5.0 | Deletes a shared metadata record |
| addRepresentation | 6.0 | Adds a representation from a RepresentationContent object |
| manageIE | 6.2 | Lock/unlock, get status of an IE |
| assignCMS | 6.2 | Assigns an existing CMS record to an IE (requires running the CMS Update task to complete) |
| unassignCMS | 6.2 | Unassigns a CMS record from an IE |
Deprecated Methods:
- getIEMD
- updateIeMD
To access the WSDL on your server, go to:
http://<repository-load-balancer-host>:<port>/dpsws/repository/IEWebServices?wsdl