Show TOC

Background documentationDescription of Object Types Locate this document in the navigation structure

 

Note Note

You can find information on the concept and structure that underlies every configuration object type in the documentation for the Integration Directory. It is assumed that you are familiar with these concepts if you want to access configuration objects using the programming interface.

For more information, see: Configuration Objects

End of the note.

This section describes the most important elements of the Web Service description for the various different configuration object types. For each object type there is an element that describes the object key (<Objecttype>ID), as well as an element that describes the contents of the object with all attributes (<Objecttype> or <Objecttype>Restricted).

Use the element <Objecttype> for reading operations and the element <Objecttype>Restricted for writing operations. There are two different structures for reading and writing operations because there are normally fewer attributes changed in a writing operation than can be displayed in a reading operation. Note the explanations of the elements ObjectAdministrativeDataRestricted and ObjectAdministrativeData under Cross-Object Type Elements

In particular the administrative information of all object types cannot be changed. In addition to this, in the object typeBusinessSystemComponent there are other differences between reading and writing access.

For more information, see: Communication Component (sectionBusiness System Component)

Note Note

If you would like to deal with more complex configuration objects (for example Communication channels), then also see section 6 under Working with more Complex Conifuration Objects in addition to the section relating to the corresponding object type.

End of the note.