Show TOC

Background documentationReading an Object (Read) Locate this document in the navigation structure

 

With this operation you can read objects from the Integration Directory.

If no object is found for a specified object key, then an error message is displayed.

WSDL Description

Element

Description

<Objecttype>CreateRequest

Describes the Web Service call for reading an object.

Based on type <Objecttype>ReadIn.

Parameters:

  • Object Key

    An object key uniquely identifies an object. For more informationon object keys in general, see Object Keys for Configuration Objects.

    The object key is object-type-specific. You can find further information in the description of the Web Service for the object type.

  • Read context (ReadContext)

    Using these optional parameters you can specify whether you want to read active objects (default) or inactive objects, which are locked in your change list.

    Possible values:

    • User: reads inactive objects in your change list.

    • Active: Only reads active objects.

readResponse

Contains parameters that are displayed when an object is read.

Based on type <Objecttype>ReadOut.

The Web Service returns the object complete with all attributes.