complexType XmlUpdateResourceType

diagram |
namespace | http://resource.api.de.bpm.tibco.com
children | set-name set-label set-date-range ldap-reference set-location add-position remove-position add-group remove-group add-capability remove-capability set-attribute
used by |
element | XmlUpdateResource/resource
attributes |
Name | Type | Use | Default | Fixed | Annotation
guid | xs:string | required |  |  |
documentation
The GUID that identifies the Resource.
source | <xs:complexType name="XmlUpdateResourceType"> <xs:sequence> <xs:element name="set-name" type="de:XmlStringAttribute" minOccurs="0"> <xs:annotation> <xs:documentation>The name value to be assigned to the resource.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="set-label" type="de:XmlOptionalStringAttribute" minOccurs="0"> <xs:annotation> <xs:documentation>The name to be assigned to the resource that is used for display purposes. To remove the label from a resource, do not include a value attribute.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="set-date-range" type="de:XmlDateRangeAttribute" minOccurs="0"> <xs:annotation> <xs:documentation>Identifies the date range for which the resource should be present. To remove a date range, do not set any attribute values.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="ldap-reference" minOccurs="0"> <xs:annotation> <xs:documentation>Lists the LDAP mappings of the resource to be modified. The LDAP alias's listed must correspond to those of the LDAP container to which the resource belongs.</xs:documentation> </xs:annotation> <xs:complexType> <xs:complexContent> <xs:extension base="de:XmlLdapContainerEntry"> <xs:attribute name="container-id" type="xs:long" use="optional"> <xs:annotation> <xs:documentation>Identifies the LDAP container to which the candidate is to be moved.</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element> <xs:element name="set-location" type="de:XmlOptionalEntityReference" minOccurs="0"> <xs:annotation> <xs:documentation>Identifies a location to which the resource is to be associated.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="add-position" type="de:XmlEntityReferenceDateRange" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the positions to which the resource is to be associated. Note that add requests are processed ahead of remove requests when included in the same update. Adding the same position multiple times, overwrites any existing positions.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="remove-position" type="de:XmlEntityReference" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the positions from which the resource is to be removed. Note that add requests are processed ahead of remove requests when included in the same update. Removing the same position multiple times in the same request is acceptable.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="add-group" type="de:XmlEntityReferenceDateRange" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the groups to which the resource is to be associated. Note that add requests are processed ahead of remove requests when included in the same update. Adding the same group multiple times overwrites any existing groups.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="remove-group" type="de:XmlEntityReference" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the groups from which the resource is to be removed. Note that add requests are processed ahead of remove requests when included in the same update. Removing the same group multiple times in the same request is acceptable.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="add-capability" type="de:XmlEntityReferenceQualified" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the capabilities to which the resource is to be associated. Note that add requests are processed ahead of remove requests when included in the same update. Adding the same capability multiple times overwrites any existing capabilities.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="remove-capability" type="de:XmlEntityReference" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the capabilities from which the resource is to be removed. Note that add requests are processed ahead of remove requests when included in the same update. Removing the same capability multiple times in the same request is acceptable.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="set-attribute" type="de:XmlEntityReferenceAttributes" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the resource attributes, and the values to be assigned to the resource. Adding the same attribute multiple times overwrites any existing attributes. To remove an attribute value, do not include the value attribute. Note that for an EnumSet type, the value attribute is repeated as a list. For all other types, there should be just one value attribute.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="guid" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The GUID that identifies the Resource.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

attribute XmlUpdateResourceType/@guid

type | xs:string
properties |
use | required
annotation |
documentation
The GUID that identifies the Resource.
source | <xs:attribute name="guid" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The GUID that identifies the Resource.</xs:documentation> </xs:annotation> </xs:attribute>

element XmlUpdateResourceType/set-name

diagram |
type | XmlStringAttribute
properties |
minOcc | 0
maxOcc | 1
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
value | xs:string | required |  |  |
documentation
The text value of the attribute.
annotation |
documentation
The name value to be assigned to the resource.
source | <xs:element name="set-name" type="de:XmlStringAttribute" minOccurs="0"> <xs:annotation> <xs:documentation>The name value to be assigned to the resource.</xs:documentation> </xs:annotation> </xs:element>

element XmlUpdateResourceType/set-label

diagram |
type | XmlOptionalStringAttribute
properties |
minOcc | 0
maxOcc | 1
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
value | xs:string |  |  |  |
documentation
The optional text value of the attribute.
annotation |
documentation
The name to be assigned to the resource that is used for display purposes. To remove the label from a resource, do not include a value attribute.
source | <xs:element name="set-label" type="de:XmlOptionalStringAttribute" minOccurs="0"> <xs:annotation> <xs:documentation>The name to be assigned to the resource that is used for display purposes. To remove the label from a resource, do not include a value attribute.</xs:documentation> </xs:annotation> </xs:element>

element XmlUpdateResourceType/set-date-range

diagram |
type | XmlDateRangeAttribute
properties |
minOcc | 0
maxOcc | 1
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
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
Identifies the date range for which the resource should be present. To remove a date range, do not set any attribute values.
source | <xs:element name="set-date-range" type="de:XmlDateRangeAttribute" minOccurs="0"> <xs:annotation> <xs:documentation>Identifies the date range for which the resource should be present. To remove a date range, do not set any attribute values.</xs:documentation> </xs:annotation> </xs:element>

element XmlUpdateResourceType/ldap-reference

diagram |
type | extension of XmlLdapContainerEntry
properties |
minOcc | 0
maxOcc | 1
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 | optional |  |  |
documentation
Identifies the LDAP container to which the candidate is to be moved.
annotation |
documentation
Lists the LDAP mappings of the resource to be modified. The LDAP alias's listed must correspond to those of the LDAP container to which the resource belongs.
source | <xs:element name="ldap-reference" minOccurs="0"> <xs:annotation> <xs:documentation>Lists the LDAP mappings of the resource to be modified. The LDAP alias's listed must correspond to those of the LDAP container to which the resource belongs.</xs:documentation> </xs:annotation> <xs:complexType> <xs:complexContent> <xs:extension base="de:XmlLdapContainerEntry"> <xs:attribute name="container-id" type="xs:long" use="optional"> <xs:annotation> <xs:documentation>Identifies the LDAP container to which the candidate is to be moved.</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element>

attribute XmlUpdateResourceType/ldap-reference/@container-id

type | xs:long
properties |
use | optional
annotation |
documentation
Identifies the LDAP container to which the candidate is to be moved.
source | <xs:attribute name="container-id" type="xs:long" use="optional"> <xs:annotation> <xs:documentation>Identifies the LDAP container to which the candidate is to be moved.</xs:documentation> </xs:annotation> </xs:attribute>

element XmlUpdateResourceType/set-location

diagram |
type | XmlOptionalEntityReference
properties |
minOcc | 0
maxOcc | 1
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
guid | xs:string |  |  |  |
documentation
The optional GUID that uniquely identifies the entity.
annotation |
documentation
Identifies a location to which the resource is to be associated.
source | <xs:element name="set-location" type="de:XmlOptionalEntityReference" minOccurs="0"> <xs:annotation> <xs:documentation>Identifies a location to which the resource is to be associated.</xs:documentation> </xs:annotation> </xs:element>

element XmlUpdateResourceType/add-position

diagram |
type | XmlEntityReferenceDateRange
properties |
minOcc | 0
maxOcc | unbounded
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
guid | xs:string | required |  |  |
documentation
The GUID that uniquely identifies the entity.
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
Identifies the positions to which the resource is to be associated. Note that add requests are processed ahead of remove requests when included in the same update. Adding the same position multiple times, overwrites any existing positions.
source | <xs:element name="add-position" type="de:XmlEntityReferenceDateRange" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the positions to which the resource is to be associated. Note that add requests are processed ahead of remove requests when included in the same update. Adding the same position multiple times, overwrites any existing positions.</xs:documentation> </xs:annotation> </xs:element>

element XmlUpdateResourceType/remove-position

diagram |
type | XmlEntityReference
properties |
minOcc | 0
maxOcc | unbounded
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
guid | xs:string | required |  |  |
documentation
The GUID that uniquely identifies the entity.
annotation |
documentation
Identifies the positions from which the resource is to be removed. Note that add requests are processed ahead of remove requests when included in the same update. Removing the same position multiple times in the same request is acceptable.
source | <xs:element name="remove-position" type="de:XmlEntityReference" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the positions from which the resource is to be removed. Note that add requests are processed ahead of remove requests when included in the same update. Removing the same position multiple times in the same request is acceptable.</xs:documentation> </xs:annotation> </xs:element>

element XmlUpdateResourceType/add-group

diagram |
type | XmlEntityReferenceDateRange
properties |
minOcc | 0
maxOcc | unbounded
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
guid | xs:string | required |  |  |
documentation
The GUID that uniquely identifies the entity.
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
Identifies the groups to which the resource is to be associated. Note that add requests are processed ahead of remove requests when included in the same update. Adding the same group multiple times overwrites any existing groups.
source | <xs:element name="add-group" type="de:XmlEntityReferenceDateRange" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the groups to which the resource is to be associated. Note that add requests are processed ahead of remove requests when included in the same update. Adding the same group multiple times overwrites any existing groups.</xs:documentation> </xs:annotation> </xs:element>

element XmlUpdateResourceType/remove-group

diagram |
type | XmlEntityReference
properties |
minOcc | 0
maxOcc | unbounded
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
guid | xs:string | required |  |  |
documentation
The GUID that uniquely identifies the entity.
annotation |
documentation
Identifies the groups from which the resource is to be removed. Note that add requests are processed ahead of remove requests when included in the same update. Removing the same group multiple times in the same request is acceptable.
source | <xs:element name="remove-group" type="de:XmlEntityReference" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the groups from which the resource is to be removed. Note that add requests are processed ahead of remove requests when included in the same update. Removing the same group multiple times in the same request is acceptable.</xs:documentation> </xs:annotation> </xs:element>

element XmlUpdateResourceType/add-capability

diagram |
type | XmlEntityReferenceQualified
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | qualifier-value
attributes |
Name | Type | Use | Default | Fixed | Annotation
guid | xs:string | required |  |  |
documentation
The GUID that uniquely identifies the entity.
annotation |
documentation
Identifies the capabilities to which the resource is to be associated. Note that add requests are processed ahead of remove requests when included in the same update. Adding the same capability multiple times overwrites any existing capabilities.
source | <xs:element name="add-capability" type="de:XmlEntityReferenceQualified" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the capabilities to which the resource is to be associated. Note that add requests are processed ahead of remove requests when included in the same update. Adding the same capability multiple times overwrites any existing capabilities.</xs:documentation> </xs:annotation> </xs:element>

element XmlUpdateResourceType/remove-capability

diagram |
type | XmlEntityReference
properties |
minOcc | 0
maxOcc | unbounded
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
guid | xs:string | required |  |  |
documentation
The GUID that uniquely identifies the entity.
annotation |
documentation
Identifies the capabilities from which the resource is to be removed. Note that add requests are processed ahead of remove requests when included in the same update. Removing the same capability multiple times in the same request is acceptable.
source | <xs:element name="remove-capability" type="de:XmlEntityReference" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the capabilities from which the resource is to be removed. Note that add requests are processed ahead of remove requests when included in the same update. Removing the same capability multiple times in the same request is acceptable.</xs:documentation> </xs:annotation> </xs:element>

element XmlUpdateResourceType/set-attribute

diagram |
type | XmlEntityReferenceAttributes
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | value
attributes |
Name | Type | Use | Default | Fixed | Annotation
guid | xs:string | required |  |  |
documentation
The GUID that uniquely identifies the entity.
annotation |
documentation
Identifies the resource attributes, and the values to be assigned to the resource. Adding the same attribute multiple times overwrites any existing attributes. To remove an attribute value, do not include the value attribute. Note that for an EnumSet type, the value attribute is repeated as a list. For all other types, there should be just one value attribute.
source | <xs:element name="set-attribute" type="de:XmlEntityReferenceAttributes" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the resource attributes, and the values to be assigned to the resource. Adding the same attribute multiple times overwrites any existing attributes. To remove an attribute value, do not include the value attribute. Note that for an EnumSet type, the value attribute is repeated as a list. For all other types, there should be just one value attribute.</xs:documentation> </xs:annotation> </xs:element>

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