delete_object
The following is a list of properties for the function delete_object:
| Property | Value |
|---|---|
brief | Delete adaptive object |
category | adaptor |
description | Delete an adaptive object. |
functionId | delete_object |
functionLabel | delete_object |
parameters | [ { "dataType": "string", "description": "Id of adaptor containing object to delete.", "name": "adaptorId" }, { "dataType": "string", "description": "Id of adaptive object type of object to delete.", "name": "objectType" }, { "dataType": "string", "description": "Id of object to delete.", "name": "objectId" }, { "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}_delete_object\n\nwhere ${adaptorType} is the adaptor type id.", "name": "adaptorTypeSpecific", "optional": true } ] |
returns | { "dataType": "object", "dataTypeParameter": "_AdaptiveJournalEntry_", "description": "Resulting journal entry." } |
sideEffects | [ "Object deleted" ] |