The response payload that the external data service returns includes changes to the properties that it manages. The service can modify attributes of properties in addition to modifying property values.
IBM Content Navigator then merges these changes with the base data in the repository and returns the data to IBM Content Navigator.
/type/{class name}
Name | Type | Description |
---|---|---|
{object type name} | String | The symbolic name of the class name or item type name that defines the property that is being updated. |
{
"repositoryId":"target_object_store_name",
"objectId" : "GUID_or_PID_of_item_that_is_being_edited",
"requestMode" : "request_context",
"externalDataIdentifier" : "identifier_for_the_service",
"properties":
[
{
"symbolicName" : "property_name",
"value" : current_value,
}
// More properties ...
],
"clientContext":
{
"Key1":"Value1",
"Key2":"Value2"
}
}
Name | Type | Required? | Description |
---|---|---|---|
repositoryId | String | Yes | The symbolic name of the target external data store that contains the property data. |
objectId | String | No | The globally unique identifier (GUID) or persistent identifier (PID) that identifies the item that is being edited. |
requestMode | String | Yes | One of the following request modes that indicates
the reason that the POST method is being called:
|
externalData |
String | Yes | A string that indicates the state of the data
that was returned by the external data service. The request must include
this identifier if the requestMode parameter
is set to one of these values:
|
properties | Array | Yes | An array that contains values for the properties that are defined for the class or item type. For each property, the request contains the symbolic name and the property value. |
clientContext | Array | No | An array that contains the following key-value pairs:
Restriction: The clientContext parameter does
not include user credentials. Your EDS implementation is invoked by IBM
Content Navigator without propagating the user's session and credentials.
EDS is therefore not suitable to implement in cases where you need user
credentials to connect to your external system, for example, to filter
results (choice list values) by the logged in user. To do something with
EDS that requires access to the content server, you can implement a
custom response filter.
The
clientContext array can also contain the following
key-value pairs, which were added in IBM Content
Navigator, Version 2.0.3 to support the
ability to include the active entry template's ID and name in the EDS
context so that EDS implementations can return a different response if an
entry template is active:
|
Code | Description |
---|---|
200 OK | The method completed successfully. The response that is returned by the POST method includes the updated information for the property. |
400 Bad Request | One of the required parameters was missing or a parameter value was invalid. |
404 Not Found | The class that was specified in the request was not found. This error does not indicate that the class is invalid. Instead, it indicates that the external data service does not manage any property values for the class. The EDS REST protocol does not return an error to IBM Content Navigator. |
500 Internal Server Error | A server error occurred. For information about the error, see the userMessage element in the JSON response. |