complexType XmlCreateResource

diagram |
namespace | http://resource.api.de.bpm.tibco.com
children | candidate
used by |
element | createResource
attributes |
Name | Type | Use | Default | Fixed | Annotation
schema-version | xs:int | optional | 1 |  |
documentation
Indicates the version of the request schema; which determines what information is to be included in the response. This allows for future, backward compatible modifications to the schema. The following values are recognised: 1: Include candidate name in failure elements of response.
annotation |
documentation
Having retrieved a list of the candidate resources, this method is used to create resources from the LDAP references returned with each candidate resource. The response returns the GUID assigned to the newly created resources. Each element in the response identifies the candidate to which it relates using the primary LDAP Source reference and the LDAP container ID. If a resource already exists with a given LDAP reference, no update is made to that resource, and the GUID of the existing resource is returned in the response (along with a boolean attribute "already-present"). For those candidates for which a resource could not be created (due to some logical error, rather than a system failure), the response includes a "failure" element identifying the candidate, as well as a reason for the failure. System failures are reported using a SOAP fault response.
source | <xs:complexType name="XmlCreateResource"> <xs:annotation> <xs:documentation>Having retrieved a list of the candidate resources, this method is used to create resources from the LDAP references returned with each candidate resource. The response returns the GUID assigned to the newly created resources. Each element in the response identifies the candidate to which it relates using the primary LDAP Source reference and the LDAP container ID. If a resource already exists with a given LDAP reference, no update is made to that resource, and the GUID of the existing resource is returned in the response (along with a boolean attribute "already-present"). For those candidates for which a resource could not be created (due to some logical error, rather than a system failure), the response includes a "failure" element identifying the candidate, as well as a reason for the failure. System failures are reported using a SOAP fault response.</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="candidate" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A list of candidate resources to be created.</xs:documentation> </xs:annotation> <xs:complexType> <xs:complexContent> <xs:extension base="de:XmlLdapContainerEntry"> <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>The name to be assigned to the resource created from this candidate entry.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="label" type="xs:string"> <xs:annotation> <xs:documentation>The name assigned to the resource for display purposes.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="start-date" type="xs:dateTime" use="optional"> <xs:annotation> <xs:documentation>The optional date and time on which the resource's presence should begin.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="end-date" type="xs:dateTime" use="optional"> <xs:annotation> <xs:documentation>The optional date and time on which the resource's presence should end. If specified, a start-date must also be specified.</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="schema-version" type="xs:int" use="optional" default="1"> <xs:annotation> <xs:documentation>Indicates the version of the request schema; which determines what information is to be included in the response. This allows for future, backward compatible modifications to the schema. The following values are recognised: 1: Include candidate name in failure elements of response.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

attribute XmlCreateResource/@schema-version

type | xs:int
properties |
use | optional
default | 1
annotation |
documentation
Indicates the version of the request schema; which determines what information is to be included in the response. This allows for future, backward compatible modifications to the schema. The following values are recognised: 1: Include candidate name in failure elements of response.
source | <xs:attribute name="schema-version" type="xs:int" use="optional" default="1"> <xs:annotation> <xs:documentation>Indicates the version of the request schema; which determines what information is to be included in the response. This allows for future, backward compatible modifications to the schema. The following values are recognised: 1: Include candidate name in failure elements of response.</xs:documentation> </xs:annotation> </xs:attribute>

element XmlCreateResource/candidate

diagram |
type | extension of XmlLdapContainerEntry
properties |
minOcc | 1
maxOcc | unbounded
content | complex
children | secondary-ref
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
The name to be assigned to the resource created from this candidate entry.
label | xs:string |  |  |  |
documentation
The name assigned to the resource for display purposes.
start-date | xs:dateTime | optional |  |  |
documentation
The optional date and time on which the resource's presence should begin.
end-date | xs:dateTime | optional |  |  |
documentation
The optional date and time on which the resource's presence should end. If specified, a start-date must also be specified.
annotation |
documentation
A list of candidate resources to be created.
source | <xs:element name="candidate" minOccurs="1" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>A list of candidate resources to be created.</xs:documentation> </xs:annotation> <xs:complexType> <xs:complexContent> <xs:extension base="de:XmlLdapContainerEntry"> <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>The name to be assigned to the resource created from this candidate entry.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="label" type="xs:string"> <xs:annotation> <xs:documentation>The name assigned to the resource for display purposes.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="start-date" type="xs:dateTime" use="optional"> <xs:annotation> <xs:documentation>The optional date and time on which the resource's presence should begin.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="end-date" type="xs:dateTime" use="optional"> <xs:annotation> <xs:documentation>The optional date and time on which the resource's presence should end. If specified, a start-date must also be specified.</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element>

attribute XmlCreateResource/candidate/@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 XmlCreateResource/candidate/@name

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

attribute XmlCreateResource/candidate/@label

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

attribute XmlCreateResource/candidate/@start-date

type | xs:dateTime
properties |
use | optional
annotation |
documentation
The optional date and time on which the resource's presence should begin.
source | <xs:attribute name="start-date" type="xs:dateTime" use="optional"> <xs:annotation> <xs:documentation>The optional date and time on which the resource's presence should begin.</xs:documentation> </xs:annotation> </xs:attribute>

attribute XmlCreateResource/candidate/@end-date

type | xs:dateTime
properties |
use | optional
annotation |
documentation
The optional date and time on which the resource's presence should end. If specified, a start-date must also be specified.
source | <xs:attribute name="end-date" type="xs:dateTime" use="optional"> <xs:annotation> <xs:documentation>The optional date and time on which the resource's presence should end. If specified, a start-date must also be specified.</xs:documentation> </xs:annotation> </xs:attribute>

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