element createResourceResponse

diagram |
namespace | http://resource.api.de.bpm.tibco.com
properties |
content | complex
children | entity failure
annotation |
documentation
Response element for the createResource operation. Details the properties and attributes of the resource identified in the request.
source | <xs:element name="createResourceResponse"> <xs:annotation> <xs:documentation>Response element for the createResource operation. Details the properties and attributes of the resource identified in the request.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="entity" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>List of successfully created resources.</xs:documentation> </xs:annotation> <xs:complexType> <xs:complexContent> <xs:extension base="de:XmlLdapEntryId"> <xs:annotation> <xs:documentation>Identifies the candidate to which the Resource refers.</xs:documentation> </xs:annotation> <xs:attribute name="container-id" type="xs:long" use="required"> <xs:annotation> <xs:documentation>Identifies the LDAP Container from which the candidate was resolved.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="guid" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The GUID assigned to the newly created resource.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="name" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The name assigned to the resource.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="label" type="xs:string"> <xs:annotation> <xs:documentation>The name assigned to the resource for dispay purposes.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="already-present" type="xs:boolean" default="false"> <xs:annotation> <xs:documentation>Indicates whether a resource already exists for the given LDAP references.</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element> <xs:element name="failure" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>List of resources that could not be created due to an error.</xs:documentation> </xs:annotation> <xs:complexType> <xs:complexContent> <xs:extension base="de:XmlLdapEntryId"> <xs:annotation> <xs:documentation>Identifies the candidate to which the failure refers.</xs:documentation> </xs:annotation> <xs:attribute name="container-id" type="xs:long" use="required"> <xs:annotation> <xs:documentation>Identifies the LDAP container from which the candidate was resolved.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="name" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Identifies the Resource name given in the failing entry.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="error" type="de:XmlCandidateError" use="required"> <xs:annotation> <xs:documentation>Provides a coded explanation of why a resource could not be created from the corresponding candidate.</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element>

element createResourceResponse/entity

diagram |
type | extension of XmlLdapEntryId
properties |
minOcc | 0
maxOcc | unbounded
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
ldap-alias | xs:string | required |  |  |
documentation
The name (or alias) by which a configured LDAP connection shared resource is identified. LDAP connection shared resources are named with the prefix "ldap/de/" in order to indicate that they are intended for Directory Engine use. The alias given here is that name without the "ldap/de/" prefix.
ldap-dn | xs:string | required |  |  |
documentation
The full Distinguished Name (DN) of the LDAP entry identified by this element.
container-id | xs:long | required |  |  |
documentation
Identifies the LDAP Container from which the candidate was resolved.
guid | xs:string | required |  |  |
documentation
The GUID assigned to the newly created resource.
name | xs:string | required |  |  |
documentation
The name assigned to the resource.
label | xs:string |  |  |  |
documentation
The name assigned to the resource for dispay purposes.
already-present | xs:boolean |  | false |  |
documentation
Indicates whether a resource already exists for the given LDAP references.
annotation |
documentation
List of successfully created resources.
source | <xs:element name="entity" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>List of successfully created resources.</xs:documentation> </xs:annotation> <xs:complexType> <xs:complexContent> <xs:extension base="de:XmlLdapEntryId"> <xs:annotation> <xs:documentation>Identifies the candidate to which the Resource refers.</xs:documentation> </xs:annotation> <xs:attribute name="container-id" type="xs:long" use="required"> <xs:annotation> <xs:documentation>Identifies the LDAP Container from which the candidate was resolved.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="guid" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The GUID assigned to the newly created resource.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="name" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The name assigned to the resource.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="label" type="xs:string"> <xs:annotation> <xs:documentation>The name assigned to the resource for dispay purposes.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="already-present" type="xs:boolean" default="false"> <xs:annotation> <xs:documentation>Indicates whether a resource already exists for the given LDAP references.</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element>

attribute createResourceResponse/entity/@container-id

type | xs:long
properties |
use | required
annotation |
documentation
Identifies the LDAP Container from which the candidate was resolved.
source | <xs:attribute name="container-id" type="xs:long" use="required"> <xs:annotation> <xs:documentation>Identifies the LDAP Container from which the candidate was resolved.</xs:documentation> </xs:annotation> </xs:attribute>

attribute createResourceResponse/entity/@guid

type | xs:string
properties |
use | required
annotation |
documentation
The GUID assigned to the newly created resource.
source | <xs:attribute name="guid" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The GUID assigned to the newly created resource.</xs:documentation> </xs:annotation> </xs:attribute>

attribute createResourceResponse/entity/@name

type | xs:string
properties |
use | required
annotation |
documentation
The name assigned to the resource.
source | <xs:attribute name="name" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The name assigned to the resource.</xs:documentation> </xs:annotation> </xs:attribute>

attribute createResourceResponse/entity/@label

type | xs:string
annotation |
documentation
The name assigned to the resource for dispay purposes.
source | <xs:attribute name="label" type="xs:string"> <xs:annotation> <xs:documentation>The name assigned to the resource for dispay purposes.</xs:documentation> </xs:annotation> </xs:attribute>

attribute createResourceResponse/entity/@already-present

type | xs:boolean
properties |
default | false
annotation |
documentation
Indicates whether a resource already exists for the given LDAP references.
source | <xs:attribute name="already-present" type="xs:boolean" default="false"> <xs:annotation> <xs:documentation>Indicates whether a resource already exists for the given LDAP references.</xs:documentation> </xs:annotation> </xs:attribute>

element createResourceResponse/failure

diagram |
type | extension of XmlLdapEntryId
properties |
minOcc | 0
maxOcc | unbounded
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
ldap-alias | xs:string | required |  |  |
documentation
The name (or alias) by which a configured LDAP connection shared resource is identified. LDAP connection shared resources are named with the prefix "ldap/de/" in order to indicate that they are intended for Directory Engine use. The alias given here is that name without the "ldap/de/" prefix.
ldap-dn | xs:string | required |  |  |
documentation
The full Distinguished Name (DN) of the LDAP entry identified by this element.
container-id | xs:long | required |  |  |
documentation
Identifies the LDAP container from which the candidate was resolved.
name | xs:string | required |  |  |
documentation
Identifies the Resource name given in the failing entry.
error | XmlCandidateError | required |  |  |
documentation
Provides a coded explanation of why a resource could not be created from the corresponding candidate.
annotation |
documentation
List of resources that could not be created due to an error.
source | <xs:element name="failure" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>List of resources that could not be created due to an error.</xs:documentation> </xs:annotation> <xs:complexType> <xs:complexContent> <xs:extension base="de:XmlLdapEntryId"> <xs:annotation> <xs:documentation>Identifies the candidate to which the failure refers.</xs:documentation> </xs:annotation> <xs:attribute name="container-id" type="xs:long" use="required"> <xs:annotation> <xs:documentation>Identifies the LDAP container from which the candidate was resolved.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="name" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Identifies the Resource name given in the failing entry.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="error" type="de:XmlCandidateError" use="required"> <xs:annotation> <xs:documentation>Provides a coded explanation of why a resource could not be created from the corresponding candidate.</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element>

attribute createResourceResponse/failure/@container-id

type | xs:long
properties |
use | required
annotation |
documentation
Identifies the LDAP container from which the candidate was resolved.
source | <xs:attribute name="container-id" type="xs:long" use="required"> <xs:annotation> <xs:documentation>Identifies the LDAP container from which the candidate was resolved.</xs:documentation> </xs:annotation> </xs:attribute>

attribute createResourceResponse/failure/@name

type | xs:string
properties |
use | required
annotation |
documentation
Identifies the Resource name given in the failing entry.
source | <xs:attribute name="name" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Identifies the Resource name given in the failing entry.</xs:documentation> </xs:annotation> </xs:attribute>

attribute createResourceResponse/failure/@error

type | XmlCandidateError
properties |
use | required
facets |
Kind | Value | Annotation
enumeration | MULTIPLE-ENTRIES |
enumeration | MISSING-RESOURCE |
enumeration | NAME-EXISTS |
annotation |
documentation
Provides a coded explanation of why a resource could not be created from the corresponding candidate.
source | <xs:attribute name="error" type="de:XmlCandidateError" use="required"> <xs:annotation> <xs:documentation>Provides a coded explanation of why a resource could not be created from the corresponding candidate.</xs:documentation> </xs:annotation> </xs:attribute>

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