update_object
The following is a list of properties for the function update_object:
| Property | Value |
|---|---|
brief | Update adaptive object |
category | adaptor |
description | Update an adaptive object. |
functionId | update_object |
functionLabel | update_object |
parameters | [ { "dataType": "string", "description": "Id of adaptor containing object to update.", "name": "adaptorId" }, { "dataType": "string", "description": "Id of adaptive object type of object to update.", "name": "objectType" }, { "dataType": "string", "description": "Id of object to update.", "name": "objectId" }, { "dataType": "object", "description": "Object containing properties to replace in existing object. You can use object_modify instead to update properties of embedded objects and lists, as well as to modify individual values of the object.", "name": "object" }, { "dataType": "object", "description": "The properties of this object will be added to the associated journal entry. Refer to /afw/_AdaptiveObjectType_/_AdaptiveJournalEntry_ for property names to avoid and for ones that have specific semantics.", "name": "journal", "optional": true }, { "dataType": "object", "description": "This is an optional object parameter with an objectType determined by the adaptorType associated with the adaptorId parameter. If the adaptorType supports this parameter, adaptor afw will have an adaptive object type with an id of:\n\n_AdaptiveAdaptorTypeSpecific_${adaptorType}_modify_object\n\nWhere ${adaptorType} is the adaptor type id.", "name": "adaptorTypeSpecific", "optional": true } ] |
returns | { "dataType": "object", "dataTypeParameter": "_AdaptiveJournalEntry_", "description": "Resulting journal entry." } |
sideEffects | [ "Object updated" ] |