element describeEntity

diagram |
namespace | http://resolver.api.de.n2.tibco.com
type | extension of XmlOrgModelVersion
properties |
content | complex
children | dynamic-id-attr
attributes |
Name | Type | Use | Default | Fixed | Annotation
model-version | xs:int | optional | -1 |  |
documentation
Major version number of the organization model in which an organization model entity resides. If not specified, the default value will be the latest version of the organization model. (Version numbers must be compatible with, and conform to, the OSGi version number schema. For Directory Engine, only the major part of the version number is significant.)
entity-type | OrganisationalEntityType | optional |  |  |
documentation
Identifies the category of the org-entity, and used to improve and validate the search.
guid | xs:string | required |  |  |
documentation
Globally, unique identifier for the org-entity. Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID.
annotation |
documentation
**PRIVATE API - Reserved for internal use**
source | <xs:element name="describeEntity"> <xs:annotation> <xs:documentation>**PRIVATE API - Reserved for internal use**</xs:documentation> </xs:annotation> <xs:complexType> <xs:annotation> <xs:documentation> Request to describe the identified model entity. Extends XmlOrgModelVersion which provides the org-model version attribute. </xs:documentation> </xs:annotation> <xs:complexContent> <xs:extension base="orgdto:XmlOrgModelVersion"> <xs:sequence minOccurs="0" maxOccurs="1"> <xs:element name="dynamic-id-attr" type="orgdto:XmlDynamicIdField" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Provides a collection of name/value pairs that identify a Dynamic Organisational Instance.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="entity-type" type="orgdto:OrganisationalEntityType" use="optional"> <xs:annotation> <xs:documentation>Identifies the category of the org-entity, and used to improve and validate the search. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="guid" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Globally, unique identifier for the org-entity. Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID. </xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element>

attribute describeEntity/@entity-type

type | OrganisationalEntityType
properties |
use | optional
facets |
Kind | Value | Annotation
enumeration | ORGANIZATION |
enumeration | ORGANIZATIONAL_UNIT |
enumeration | GROUP |
enumeration | POSITION |
enumeration | PRIVILEGE |
enumeration | CAPABILITY |
enumeration | RESOURCE |
enumeration | LOCATION |
enumeration | ORGANIZATION_TYPE |
enumeration | ORGANIZATIONAL_UNIT_TYPE |
enumeration | POSITION_TYPE |
enumeration | LOCATION_TYPE |
enumeration | ORGUNIT_RELATIONSHIP_TYPE |
enumeration | POSITION_HELD |
enumeration | ORGUNIT_RELATIONSHIP |
enumeration | ORGUNIT_FEATURE |
enumeration | POSITION_FEATURE |
enumeration | PARAMETER_DESCRIPTOR |
enumeration | CANDIDATE_QUERY |
enumeration | MODEL_ORG_UNIT |
enumeration | MODEL_POSITION |
enumeration | QUERY |
annotation |
documentation
Identifies the category of the org-entity, and used to improve and validate the search.
source | <xs:attribute name="entity-type" type="orgdto:OrganisationalEntityType" use="optional"> <xs:annotation> <xs:documentation>Identifies the category of the org-entity, and used to improve and validate the search. </xs:documentation> </xs:annotation> </xs:attribute>

attribute describeEntity/@guid

type | xs:string
properties |
use | required
annotation |
documentation
Globally, unique identifier for the org-entity. Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID.
source | <xs:attribute name="guid" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Globally, unique identifier for the org-entity. Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID. </xs:documentation> </xs:annotation> </xs:attribute>

element describeEntity/dynamic-id-attr

diagram |
type | XmlDynamicIdField
properties |
minOcc | 0
maxOcc | unbounded
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
name | xs:token | required |  |  |
value | xs:string | optional |  |  |
annotation |
documentation
Provides a collection of name/value pairs that identify a Dynamic Organisational Instance.
source | <xs:element name="dynamic-id-attr" type="orgdto:XmlDynamicIdField" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Provides a collection of name/value pairs that identify a Dynamic Organisational Instance.</xs:documentation> </xs:annotation> </xs:element>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy