retrieve_objects_with_uri
The following is a list of properties for the function retrieve_objects_with_uri
:
Property | Value |
---|---|
brief | Retrieve adaptive object with URI |
category | adaptor |
description | Retrieve adaptive objects with a given URI. The optional queryCriteria is used to filter the adaptive objects returned. Use the objectOptions parameter to influence how the objects are viewed. Options, specific to the adaptorId, can be optionally supplied. |
functionId | retrieve_objects_with_uri |
functionLabel | retrieve_objects_with_uri |
parameters | [ { "dataType": "anyURI", "description": "URI of objects to retrieve. If a URI begins with a single slash ('/'), it is the local object path. A query string can be specified.", "name": "uri" }, { "brief": "Object options", "dataType": "object", "dataTypeParameter": "_AdaptiveObjectOptions_", "description": "Object view options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.", "name": "options", "optional": true }, { "brief": "Adaptor specific", "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}_retrieve_objects\n\nWhere ${adaptorType} is the adaptor type id.", "name": "adaptorTypeSpecific", "optional": true } ] |
returns | { "brief": "Objects retrieved or undefined", "dataType": "list", "description": "This is the list of objects retrieved." } |