complexType CreateDocumentRequestType
diagram bds-document_diagrams/bds-document_p23.png
namespace http://document.api.bds.tibco.com
children owner name versioningState mimeType content contentURL
used by
element CreateDocumentRequest
attributes
Name  Type  Use  Default  Fixed  Annotation
returnMetadata  xs:boolean        
documentation
The response will contain a document reference.  If this boolean attribute is set true, it will also include document metadata. (Assumed false if omitted)
annotation
documentation
Request for CreateDocument
source <xs:complexType name="CreateDocumentRequestType">
 
<xs:annotation>
   
<xs:documentation>Request for CreateDocument</xs:documentation>
 
</xs:annotation>
 
<xs:sequence>
   
<xs:element name="owner" type="OwnerReference"/>
   
<xs:element name="name" type="xs:string">
     
<xs:annotation>
       
<xs:documentation>Name for the document</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="versioningState" type="VersioningStateEnum" minOccurs="0">
     
<xs:annotation>
       
<xs:documentation>Determines initial version number of document. MAJOR, MINOR or NONE. e.g. may map to 1.0, 0.1 or a non-versioned document, as per repository capabilities. If omitted, the repository will decide the appropriate default.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="mimeType" type="xs:string" minOccurs="0">
     
<xs:annotation>
       
<xs:documentation>mime-type of content. If omitted, the repository will assume a default.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:choice>
     
<xs:annotation>
       
<xs:documentation>Choice of document content or URL from which document content can be fetched</xs:documentation>
     
</xs:annotation>
     
<xs:element name="content" type="xs:base64Binary">
       
<xs:annotation>
         
<xs:documentation>base64Binary encoding of document content</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="contentURL" type="xs:anyURI">
       
<xs:annotation>
         
<xs:documentation>URL from which the document content can be fetched (i.e. This URL must be resolvable from the AMX-BPM server)</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:choice>
 
</xs:sequence>
 
<xs:attribute name="returnMetadata" type="xs:boolean">
   
<xs:annotation>
     
<xs:documentation>The response will contain a document reference.  If this boolean attribute is set true, it will also include document metadata. (Assumed false if omitted)</xs:documentation>
   
</xs:annotation>
 
</xs:attribute>
</xs:complexType>

attribute CreateDocumentRequestType/@returnMetadata
type xs:boolean
annotation
documentation
The response will contain a document reference.  If this boolean attribute is set true, it will also include document metadata. (Assumed false if omitted)
source <xs:attribute name="returnMetadata" type="xs:boolean">
 
<xs:annotation>
   
<xs:documentation>The response will contain a document reference.  If this boolean attribute is set true, it will also include document metadata. (Assumed false if omitted)</xs:documentation>
 
</xs:annotation>
</xs:attribute>

element CreateDocumentRequestType/owner
diagram bds-document_diagrams/bds-document_p24.png
type OwnerReference
properties
content complex
children caseReference
source <xs:element name="owner" type="OwnerReference"/>

element CreateDocumentRequestType/name
diagram bds-document_diagrams/bds-document_p25.png
type xs:string
properties
content simple
annotation
documentation
Name for the document
source <xs:element name="name" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>Name for the document</xs:documentation>
 
</xs:annotation>
</xs:element>

element CreateDocumentRequestType/versioningState
diagram bds-document_diagrams/bds-document_p26.png
type VersioningStateEnum
properties
minOcc 0
maxOcc 1
content simple
facets
Kind Value Annotation
enumeration MAJOR
enumeration MINOR
enumeration NONE
annotation
documentation
Determines initial version number of document. MAJOR, MINOR or NONE. e.g. may map to 1.0, 0.1 or a non-versioned document, as per repository capabilities. If omitted, the repository will decide the appropriate default.
source <xs:element name="versioningState" type="VersioningStateEnum" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>Determines initial version number of document. MAJOR, MINOR or NONE. e.g. may map to 1.0, 0.1 or a non-versioned document, as per repository capabilities. If omitted, the repository will decide the appropriate default.</xs:documentation>
 
</xs:annotation>
</xs:element>

element CreateDocumentRequestType/mimeType
diagram bds-document_diagrams/bds-document_p27.png
type xs:string
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
mime-type of content. If omitted, the repository will assume a default.
source <xs:element name="mimeType" type="xs:string" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>mime-type of content. If omitted, the repository will assume a default.</xs:documentation>
 
</xs:annotation>
</xs:element>

element CreateDocumentRequestType/content
diagram bds-document_diagrams/bds-document_p28.png
type xs:base64Binary
properties
content simple
annotation
documentation
base64Binary encoding of document content
source <xs:element name="content" type="xs:base64Binary">
 
<xs:annotation>
   
<xs:documentation>base64Binary encoding of document content</xs:documentation>
 
</xs:annotation>
</xs:element>

element CreateDocumentRequestType/contentURL
diagram bds-document_diagrams/bds-document_p29.png
type xs:anyURI
properties
content simple
annotation
documentation
URL from which the document content can be fetched (i.e. This URL must be resolvable from the AMX-BPM server)
source <xs:element name="contentURL" type="xs:anyURI">
 
<xs:annotation>
   
<xs:documentation>URL from which the document content can be fetched (i.e. This URL must be resolvable from the AMX-BPM server)</xs:documentation>
 
</xs:annotation>
</xs:element>


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