Description

Returns the 'Navigation XML' of one or more objects.

Parameters (* denotes an optional parameter)

There are seven possible parameters that apply to the objs call. Only the ids parameter is mandatory, all others are optional.

ids

max

size

x

strict

nulls

counter

 

Ids

A comma-separated list of database ids of the objects to return.

NOTE: If any of the specified ids does not exist or the object with that id has been spiked, the command returns an error.

Example: http://server/gnportal/do.ashx?cmd=objsnav&ids=2244

 

Max*

An optional integer defining the maximum navigation depth. The default value = 3. Use 0 to return the simple XML of the object(s), -1 for unlimited depth. IMPORTANT: Use extreme caution when passing the Max parameter. Very large values, or -1, will result in very long database access time.

Example 1: http://server/gnportal/do.ashx?cmd=objsnav&ids=27687

<folderRef idref="obj27687">

 <nav:refObject idref="obj27687" />

</folderRef>

 

Example 2: http://server/gnportal/do.ashx?cmd=objsnav&ids=27687&max=4

Notice in this example that the navigation goes 1 level deeper (default in previous example =3).

<folderRef idref="obj27687">

 <nav:refObject idref="obj27687">

   <folder nav:objectType="folder"

          id="obj27687" name="Images"

          path="/system/users/Laura/Images" />

 </nav:refObject>

</folderRef>

 

Example 3: http://tera-ifra/gnportal/do.ashx?cmd=objsnav&ids=27687&max=5

<folderRef idref="obj27687">

 <nav:refObject idref="obj27687">

   <folder nav:objectType="folder" id="obj27687"

          name="Images" path="/system/users/Laura/Images">

     <nav:creation />

     <nav:modified />

     <nav:referencing />

     <access />

     <folderParent idref="obj19360" />

     <partitionRef idref="obj19367" />

     <description />

   </folder>

 </nav:refObject>

</folderRef>

 

Size*

An integer that defines the maximum size in bytes of the binary data content that is returned directly in the XML. The default is 0, that is, no binary data is returned directly, but is returned as a url. Use -1 for no size limit. If not specified, the binary data content is always returned as a URL.

X*

This optional string parameter contains the name of an XSL transformation to be applied to the XML. The XSL transformation must be loaded in the database. Note that it is just inserted as an XML instruction and applied by the browser.

Strict*

This optional parameter requests strict access. The call fails if any of the requested attributes are not accessible.

Nulls*

When present, this option parameter requests that missing (null) object attributes be rendered as xsi:nil XML elements or empty XML attributes instead of omitting them from the results.

NOTE: Some attribute types, such as strings are not nullable, therefore they appear in the output as empty even when the null parameter is not present.

Example 1: http://server/gnportal/do.ashx?cmd=objsnav&ids=2244

<image xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
id="obj2244" name="image_09102621404497" 
creationDate="2009-10-26T20:40:45.133Z"
modifiedDate="2009-10-26T20:40:45.133Z" author="" size="95450" 
pixWidth="200" pixHeight="300" resolutionX="200" 
resolutionY="200" width="2.53999996185303" height="3.80999994277954" 
headline="" country=""  colorUsage="cuGray"> 

 

Example 2: http://server/gnportal/do.ashx?cmd=objsnav&ids=2244&nulls=

<image xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
id="obj2244" name="image_09102621404497" 
creationDate="2009-10-26T20:40:45.133Z" 
modifiedDate="2009-10-26T20:40:45.133Z" 
author="" size="95450" 
pixWidth="200" pixHeight="300" resolutionX="200" resolutionY="200" 
width="2.53999996185303" height="3.80999994277954" 
headline="" country="" countryCode="" genre=""  colorUsage="cuGray"> 

 

Counter*

This option string parameter contains the name of the counter to increment for each returned object. The counter must be defined in the GN4 database.

See also

Objects, Objs, ObjsList