delete_object_with_uri
The following is a list of properties for the function delete_object_with_uri
:
Property | Value |
---|---|
brief | Delete adaptive object with URI |
category | adaptor |
description | Delete an adaptive object with a given URI. |
functionId | delete_object_with_uri |
functionLabel | delete_object_with_uri |
parameters | [ { "dataType": "anyURI", "description": "URI of object to delete. If a URI begins with a single slash ('/'), it is the local object path.", "name": "uri" }, { "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" ] |