Object XML - Web Services - Foundation 23.2 - Foundation 23.2 - Ready - Content Composer

<?xml version="1.0" encoding="utf-16"?>
<mws type="OBJECT"> 
   <process id="ba56e16a-b7ba-495f-8ab9-158e48df5846"> 
      <object title="COD6773_test_DIPWrite" type="P" name="COD6773_test_DIPWrite" index="12112018-20207-tdc-obatest" reference=""> 
         <object title="COD6773_Simple" type="D" name="COD6773_Simple" index="12112018-20208-tdr-obatest" reference="ED90176C-B7FF-46F8-A1B4-0D00F508B36C" state="1" enabled="1" print_asktime="0" form="COD6773_Html_Body" printer="COD6773" printer_type="OEP" printtime="1" print_changeable="1" copycount="0" copy="0" password="" doctype="1" dataid="Partner_V2" external_doctype_id="2" external_doctype_name="doc" filename="COD6773_Simple_ED90176C-B7FF-46F8-A1B4-0D00F508B36C_O.docx" isprotected="0"/> 
         <object title="COD6773_Simple_2" type="D" name="COD6773_Simple_2" index="12112018-20209-tdr-obatest" reference="19CA3FBB-1BFC-4122-B26D-67A8F503BF83" state="2" enabled="1" print_asktime="0" form="COD6773_Html_Body" printer="COD6773" printer_type="OEP" printtime="1" print_changeable="1" copycount="0" copy="0" password="" doctype="1" dataid="Partner_V2" external_doctype_id="2" external_doctype_name="doc" filename="COD6773_Simple_2_19CA3FBB-1BFC-4122-B26D-67A8F503BF83_O.docx" isprotected="0"/> 
         <object title="COD6773_Simple" type="D" name="COD6773_Simple" index="12112018-20210-tcr-obatest" reference="C4C8FDDB-2D27-4956-A6EA-BA2F08904433" state="1" enabled="1" print_asktime="0" form="COD6773_Html_Body" printer="COD6773" printer_type="OEP" printtime="1" print_changeable="1" copycount="0" copy="1" password="" doctype="1" external_doctype_id="23" external_doctype_name="doc" copytext="" originalid="ED90176C-B7FF-46F8-A1B4-0D00F508B36C"/> 
         <object title="COD6773_Simple_3" type="D" name="COD6773_Simple_3" index="20012020-20414-tdr-obatest" reference="7781B1FE-2F66-4B9D-9F7B-997E9E97424C" state="2" enabled="1" print_asktime="0" form="COD6773_Html_Body" printer="COD6773" printer_type="OEP" printtime="1" print_changeable="0" copycount="0" copy="0" password="" doctype="1" dataid="Partner_V2" filename="COD6773_Simple_3_7781B1FE-2F66-4B9D-9F7B-997E9E97424C_O.docx" isprotected="0"/> 
      </object> 
   </process>
</mws>

Description of the common attributes of the element 'object'

Element	Description
title	Title (replaces the name displayed to business users)
type	Object type P = Bundle D = Document Template B = Text Block
name	Object name
index	Object index
reference	Reference of the Document in the Bundle See: Address of an Object in a Bundle

Additional attributes for documents, copies and text blocks

Element	Description
state	0: Deactivated (object is deactivated, but can be activated) 1: Required (object is activated and cannot be deactivated) 2: Activated (object is activated, but can be deactivated) 3: Disabled (object is deactivated and cannot be activated)
enabled	0 for a document: when state is deactivated or disabled for a document copy: when the respective original is not activated (original has the state deactivated or disabled) 1 for a document: when the document is activated (state is activated or required) for a document copy: when the original is activated and the copy has the state activated or required

Element

Description

state

0: Deactivated (object is deactivated, but can be activated)

1: Required (object is activated and cannot be deactivated)

2: Activated (object is activated, but can be deactivated)

3: Disabled (object is deactivated and cannot be activated)

enabled

for a document: when state is deactivated or disabled
for a document copy: when the respective original is not activated (original has the state deactivated or disabled)

for a document: when the document is activated (state is activated or required)
for a document copy: when the original is activated and the copy has the state activated or required

Additional attributes for documents / copies

Element	Description
print_asktime	0: Query print time. 1: Do not query print time.
form	Form name
printer	Printer name
printer_type	OEP: Email printer OP: Online printer
printtime	0: unknown 1: immediately 2: shifted
print_changeable	0: Changes to print definition allowed 1: Changes to print definition not allowed
copyCount	Number of real copies
copy	0: Original 1: Copy
password	Document password in plain text
doctype	1: DynamicWord 2: StaticWord 3: StaticPdf 4: StaticTiff 5: StaticXps
external_doctype_id	OnBase document type ID (long)
external_doctype_name	OnBase document type name (string)

The following attribute is only included for originals:

Element	Description
dataid	Name of the assigned TextDataReference that references the selection to be used.

The following attributes are only included for copies:

Element	Description
copytext	Text on copy
originalid	Child ID of the original. The value corresponds to the value of the attribute reference of the respective original document

The following attributes are only included if the document or copy has already been created:

Element	Description
filename	Name of the document created
isprotected	0: Write protection is not activated 1: Write protection is activated

Element

Description

filename

Name of the document created

isprotected

0: Write protection is not activated

1: Write protection is activated

Additional text block attributes:

Element	Description
childcount	Number of child objects in the text block

The following attribute is only included for documents / text blocks, if an external document has been inserted into the object from the Client:

Element	Description
isexternaldocument	1: An external document is assigned

Object XML - Web Services - Foundation 23.2 - Foundation 23.2 - Ready - Content Composer - external

Content Composer Web Services