GetFromRefs

Build 1501 on 14/Nov/2017  This topic last edited on: 22/Mar/2016, at 17:00

Description

Gets from the database a list of objects, along with their access permissions and (optional) extra data. The objects are specified using references - i.e. either direct database id or key attibutes values (POST)

Parameters

Post

References to the object to retrieve, list of MultiReferenceValue in xml format.

Modes comma-separated load modes

List of load modes to be used for the object(s) to be loaded and returned

Attrs comma-separated strings

Attributes of the object(s) to be loaded and returned

AttrsToCheckOut comma-separated strings

Attributes of the object(s) to be checked-out

Extras comma-separated load extra data

List of extra data for the object(s) to be loaded and returned

As object type name

Object type whose attributes are loaded and returned

RefAttrs comma-separated list of attribute types - specified using their full name

Attributes to be used to retrieve the list of referencing objects.

Spiked spiked objects handling value

How to handle spiked objects: ignore the difference spiked/non-spiked, load only non-spiked objects, load only spiked objects.

SubCheckOutAttrs comma-separated list of attribute types - specified using their full name

Attributes to be used to retrieve check-out informantion of referenced and children objects.

OnlyIdsAttrs comma-separated list of attribute types - specified using their full name

Children attributes that should be loaded only as ids.

Strict

Requests strict access: fail if any of the attributes to get is not readable or any of the attributes to check-out is not writable

Encoding character encoding (e.g. utf-8, iso-8859-1)

The character encoding to use for the returned XML. If not specified the system uses UTF-8.

DataComplete

Include size, mime type and URL for binary data content attributes. If not specified, only the data id is specified for binary data content attributes.