You must configure the external data service to respond with the data that is required for that action. For example, if the request is to add a document, when the Add Document wizard is opened, the service needs to respond with the initial property values that are defined for the Add Document class.
The requestMode parameter indicates the action that is being performed in IBM Content Navigator. This action determines the response that is returned by the external data service.
Value | Description |
---|---|
userid | The user ID for the user who is logged in to IBM Content Navigator. |
locale | The locale of the browser that initiated this call to the external data service. |
desktop | The desktop ID for the desktop that is in use. |
The initialNewObject request mode is called only for the first object that is added of a particular class. The EDS information that is returned from the initialNewObject request is used when adding subsequent documents of the same class.
The input payload also contains the objectId parameter that specifies the globally unique identifier (GUID) or persistent identifier (PID) of the content item that is being edited. The service can use the GUID to refer to the content item. However, remember that the values stored in the repository for the class can change. Therefore, the values that are provided in the input payload might not match the values that are currently stored in the repository for the class.
The input payload does not contain the externalDataIdentifier parameter. Instead, this parameter is set by the external data service and returned in the response payload. Subsequent requests made during the update of the class include the externalDataIdentifier parameter to indicate the current state of the data to the service.
The external data service responds to this request if the attributes or working value of any property that it manages changed. The service also responds to return a custom validation error.
For each property, the input payload that is passed to the service contains the working values for all properties that are defined by the class.
For each property, the input payload that is passed to the service contains the working values for all properties that are defined by the class or item type.