complexType XmlOrganization
diagram de-orgmodel-service_diagrams/de-orgmodel-service_p169.png
namespace http://base.api.de.bpm.tibco.com
type extension of XmlModelEntity
properties
base XmlModelEntity
children schema-type allocation-method location-ref org-unit attribute push-destination
used by
elements getOrgModelRootsResponse/organization getOrgModelEntityResponse/organization getOrgModelResponse/organization
attributes
Name  Type  Use  Default  Fixed  Annotation
guid  xs:string  required      
documentation
The GUID that uniquely identifies the entity.
name  xs:string  required      
documentation
The name assigned to the entity.
label  xs:string  optional      
documentation
The optional label assigned to the entity. This is used for display purposes. If not given, the name is used for display.
calendar-alias  xs:string  optional      
documentation
The alias of the calendar that this organization will use for deadline calculations. This information is only included if requested as part of the request parameters.
annotation
documentation
Describes an organization model organization and its associated entities.
source <xs:complexType name="XmlOrganization">
 
<xs:annotation>
   
<xs:documentation>Describes an organization model organization and its associated entities.</xs:documentation>
 
</xs:annotation>
 
<xs:complexContent>
   
<xs:extension base="XmlModelEntity">
     
<xs:sequence>
       
<xs:element name="schema-type" type="XmlModelEntity" minOccurs="0" maxOccurs="1">
         
<xs:annotation>
           
<xs:documentation>Describes the organization model schema type from which this organization is derived. This is an optional element, as an organization need not be derived from a schema type.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="allocation-method" type="XmlSelectionMode" minOccurs="0" maxOccurs="1">
         
<xs:annotation>
           
<xs:documentation>Describes the method of work allocation for this organization.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="location-ref" type="XmlModelEntity" minOccurs="0" maxOccurs="1">
         
<xs:annotation>
           
<xs:documentation>Identifies the location to which this organization is associated.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="org-unit" type="XmlOrgUnit" minOccurs="0" maxOccurs="unbounded">
         
<xs:annotation>
           
<xs:documentation>Describes the organizational-units directly associated with this organization.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="attribute" type="XmlOrgAttributeValue" minOccurs="0" maxOccurs="unbounded">
         
<xs:annotation>
           
<xs:documentation>Names an attribute assigned to this organization, and gives the definition for that attribute. Attributes can only be assigned to an organization if it has a schema-type.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="push-destination" type="XmlPushDestination" minOccurs="0" maxOccurs="unbounded">
         
<xs:annotation>
           
<xs:documentation>Describes a push destination used to push work items to resources.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
     
</xs:sequence>
     
<xs:attribute name="calendar-alias" type="xs:string" use="optional">
       
<xs:annotation>
         
<xs:documentation>The alias of the calendar that this organization will use for deadline calculations. This information is only included if requested as part of the request parameters.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
   
</xs:extension>
 
</xs:complexContent>
</xs:complexType>

attribute XmlOrganization/@calendar-alias
type xs:string
properties
use optional
annotation
documentation
The alias of the calendar that this organization will use for deadline calculations. This information is only included if requested as part of the request parameters.
source <xs:attribute name="calendar-alias" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>The alias of the calendar that this organization will use for deadline calculations. This information is only included if requested as part of the request parameters.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

element XmlOrganization/schema-type
diagram de-orgmodel-service_diagrams/de-orgmodel-service_p170.png
type XmlModelEntity
properties
minOcc 0
maxOcc 1
content complex
attributes
Name  Type  Use  Default  Fixed  Annotation
guid  xs:string  required      
documentation
The GUID that uniquely identifies the entity.
name  xs:string  required      
documentation
The name assigned to the entity.
label  xs:string  optional      
documentation
The optional label assigned to the entity. This is used for display purposes. If not given, the name is used for display.
annotation
documentation
Describes the organization model schema type from which this organization is derived. This is an optional element, as an organization need not be derived from a schema type.
source <xs:element name="schema-type" type="XmlModelEntity" minOccurs="0" maxOccurs="1">
 
<xs:annotation>
   
<xs:documentation>Describes the organization model schema type from which this organization is derived. This is an optional element, as an organization need not be derived from a schema type.</xs:documentation>
 
</xs:annotation>
</xs:element>

element XmlOrganization/allocation-method
diagram de-orgmodel-service_diagrams/de-orgmodel-service_p171.png
type XmlSelectionMode
properties
minOcc 0
maxOcc 1
content complex
attributes
Name  Type  Use  Default  Fixed  Annotation
method  XmlAllocationMethod  required      
documentation
Algorithm used to select a resource. One of:
- ANY: use random selection.
- NEXT: use iterative selection.
- THIS: use the specifically identified resource.
- PLUGIN: use the named plugin code (where the name is given separately) to perform the selection.
plugin  xs:string  optional      
documentation
Name of custom plugin implementation.
annotation
documentation
Describes the method of work allocation for this organization.
source <xs:element name="allocation-method" type="XmlSelectionMode" minOccurs="0" maxOccurs="1">
 
<xs:annotation>
   
<xs:documentation>Describes the method of work allocation for this organization.</xs:documentation>
 
</xs:annotation>
</xs:element>

element XmlOrganization/location-ref
diagram de-orgmodel-service_diagrams/de-orgmodel-service_p172.png
type XmlModelEntity
properties
minOcc 0
maxOcc 1
content complex
attributes
Name  Type  Use  Default  Fixed  Annotation
guid  xs:string  required      
documentation
The GUID that uniquely identifies the entity.
name  xs:string  required      
documentation
The name assigned to the entity.
label  xs:string  optional      
documentation
The optional label assigned to the entity. This is used for display purposes. If not given, the name is used for display.
annotation
documentation
Identifies the location to which this organization is associated.
source <xs:element name="location-ref" type="XmlModelEntity" minOccurs="0" maxOccurs="1">
 
<xs:annotation>
   
<xs:documentation>Identifies the location to which this organization is associated.</xs:documentation>
 
</xs:annotation>
</xs:element>

element XmlOrganization/org-unit
diagram de-orgmodel-service_diagrams/de-orgmodel-service_p173.png
type XmlOrgUnit
properties
minOcc 0
maxOcc unbounded
content complex
children schema-type allocation-method location-ref privilege-holding attribute push-destination extension-point instance-id-attr position org-unit
attributes
Name  Type  Use  Default  Fixed  Annotation
guid  xs:string  required      
documentation
The GUID that uniquely identifies the entity.
name  xs:string  required      
documentation
The name assigned to the entity.
label  xs:string  optional      
documentation
The optional label assigned to the entity. This is used for display purposes. If not given, the name is used for display.
calendar-alias  xs:string  optional      
documentation
The alias of the calendar that this org-unit will use for deadline calculations.
                        This information is only included if requested as part of the request parameters.
dynamic  xs:boolean  optional      
documentation
Returns true if this entity was dynamically generated as a result of an
                        Organisational Model Extension Point; rather than part of an org-model deployment.
                       
extension-point  xs:boolean  optional      
documentation
Only used in the org-model drill-down API. Returns true if this Org-Unit has been designated as an Extension Point.
                       
annotation
documentation
Describes the organizational-units directly associated with this organization.
source <xs:element name="org-unit" type="XmlOrgUnit" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Describes the organizational-units directly associated with this organization.</xs:documentation>
 
</xs:annotation>
</xs:element>

element XmlOrganization/attribute
diagram de-orgmodel-service_diagrams/de-orgmodel-service_p174.png
type XmlOrgAttributeValue
properties
minOcc 0
maxOcc unbounded
content complex
children definition value
annotation
documentation
Names an attribute assigned to this organization, and gives the definition for that attribute. Attributes can only be assigned to an organization if it has a schema-type.
source <xs:element name="attribute" type="XmlOrgAttributeValue" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Names an attribute assigned to this organization, and gives the definition for that attribute. Attributes can only be assigned to an organization if it has a schema-type.</xs:documentation>
 
</xs:annotation>
</xs:element>

element XmlOrganization/push-destination
diagram de-orgmodel-service_diagrams/de-orgmodel-service_p175.png
type XmlPushDestination
properties
minOcc 0
maxOcc unbounded
content complex
children value
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string  required      
documentation
The name of the push destination.
channel-type  ChannelType  required      
documentation
Enumerated type defining the presentation technology used by the channel associated with this push destination.
channel-id  xs:string  required      
documentation
Unique ID of the channel associated with this push destination.
enabled  xs:boolean  required      
documentation
Boolean value indicating whether this push destination is currently enabled (TRUE) or not (FALSE).
resource-attr-guid  xs:string  optional      
documentation
Unique ID of a resource attribute whose value should be used for the push destination. The parameter descriptor must be assigned to the organization model entity for whom the push destination is being set.  If a value is assigned to both this attribute and the "value" element, the value of this attribute will be used.
annotation
documentation
Describes a push destination used to push work items to resources.
source <xs:element name="push-destination" type="XmlPushDestination" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Describes a push destination used to push work items to resources.</xs:documentation>
 
</xs:annotation>
</xs:element>


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