+Service Definition
<service name="DrmService">
<port binding="IDrmServiceSoapHttp" name="DrmServicePortType">
<address location="http://localhost:7001/oracle-epm-drm-webservices/DrmService?wsdl"/>
</port>
</service>
Creates a glyph; the image data bytes must be converted to a base-64 string.

Input Parameters:

string name: Name of glyph.
string descr: Description of glyph.
string imageData: Base-64 string value of the byte data.
ImageTypeEnum imageTypeEnum: Currently supported image types are PNG.
+Operation Definition
<operation name="addGlyph">
<input message="addGlyph"/>
<output message="addGlyphResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="addGlyph">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a hierarchy within an existing version; this method will also create a top node for the hierarchy.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string descr: Hierarchy description field.
string topNodeName: Top node name field.
string topNodeDescr: Top node description field.
+Operation Definition
<operation name="addHier">
<input message="addHier"/>
<output message="addHierResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="addHier">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a hierarchy group.

Input Parameters:

string name: Hierarchy group name field.
string descr: Hierarchy group description field.
int order: Sort order field for the hierarchy group.
+Operation Definition
<operation name="addHierGroup">
<input message="addHierGroup"/>
<output message="addHierGroupResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="addHierGroup">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a node and will insert that node under a parent if the parent exist.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string parentName: Parent node name field.
string nodeName: Node name field.
boolean isLeaf: Field indicating whether node is a leaf node.
NameValueListType propNameValueList: Name/value pair list field for property definition name and value for the node property value.
boolean updateIfExists: If True and the node exists, then update the properties for the node; if the node exists and this flag is False, then skip property updates.
+Operation Definition
<operation name="addNode">
<input message="addNode"/>
<output message="addNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="addNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a node access group; this method allows one to associate existing users.

Input Parameters:

NodeAccessGroupType nodeAccessGroup: Node access group input object.
+Operation Definition
<operation name="addNodeAccessGroup">
<input message="addNodeAccessGroup"/>
<output message="addNodeAccessGroupResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="addNodeAccessGroup">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a node type; this method allows one to associate properties, categories, validations, and a glyph.

Input Parameters:

string name: Name of the node type.
string descr: Description of the node type.
StringListType propNameList: Property definition names to associate with this node type.
StringListType categoryNameList: The property category names to associate with this node type.
StringListType validationList: The validation definition names to associate with this node type.
string glyphName: The glyph name to associate with this node type.
+Operation Definition
<operation name="addNodeType">
<input message="addNodeType"/>
<output message="addNodeTypeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="addNodeType">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a node; this method allows one to specify properties to update.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string parentName: Parent node name field.
string nodeName: Node name field.
boolean isLeaf: Field indicating if node is a leaf node.
PropListType propList: The list of properties and their values to set on the node.
boolean updateIfExists: If True and the node exists, then update the properties for the node; if the node exists and this flag is False, then skip property updates.
+Operation Definition
<operation name="addNodeWithProps">
<input message="addNodeWithProps"/>
<output message="addNodeWithPropsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="addNodeWithProps">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a node but does not associate that node to a parent node.

Input Parameters:

string versionName: Version name field.
string nodeName: Node name field.
boolean isLeaf: Field indicating whether node is a leaf node.
+Operation Definition
<operation name="addOrphanNode">
<input message="addOrphanNode"/>
<output message="addOrphanNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="addOrphanNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a property category; this method allows one to set the properties.

Input Parameters:

string propCategoryName: Property category name field.
string descr: Property category description field.
PropCategoryTypeEnum propCategoryType: An enumeration value indicating the type of property category.
StringListType propNameList: A list of property definition names to associate with this property category.
boolean availableUserCategory: Flag indicating whether the category should be saved as a user category.
int order: The order in which the property category appears in the property editor.
+Operation Definition
<operation name="addPropCategory">
<input message="addPropCategory"/>
<output message="addPropCategoryResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="addPropCategory">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a property definition.

Input Parameters:

PropDefType propDef: A property definition object field.
+Operation Definition
<operation name="addPropDef">
<input message="addPropDef"/>
<output message="addPropDefResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="addPropDef">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a user definition.

Input Parameters:

UserInputType userInput: User input object field.
string password: The password to set for this new user.
+Operation Definition
<operation name="addUser">
<input message="addUser"/>
<output message="addUserResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="addUser">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a validation definition.

Input Parameters:

string name: The validation name field.
string descr: Validation description.
string displayLabel: The label for the validation.
ValidationTypeEnum allowedType: An enumeration indicating how the validation can be executed.
boolean cascade: Flag indicating whether the validation is to be implicitly assigned via inheritance.
int columnWidth: (To be deprecated)
ValidationLevelEnum level: The validation level defines the scope of a business rule.
ValidationParamListType parameters: Parameters that are used by the validation during execution.
boolean setup: Flag that indicates whether the server should check the validity of the parameters.
int sortOrder: The sort order of the property definition within a category.
string validationClass: The type class of validation.
+Operation Definition
<operation name="addValidation">
<input message="addValidation"/>
<output message="addValidationResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="addValidation">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a version; depending on the input parameter dbConnect, the version will either be disconnected or persisted to the data store.

Input Parameters:

string versionName: Version name field.
string versionDescr: Description field.
boolean dbConnect: Flag that indicates whether the version should be persisted to the data store. If False, the version resides only in memory.

Output Parameters:

VersionType version: The version object field.
+Operation Definition
<operation name="addVersion">
<input message="addVersion"/>
<output message="addVersionResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="addVersion">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Removes the node from the hierarchy and deletes it if it is an orphan (For example, if a node has the same parent in all hierarchies in which it exists, then an annul results in the deletion of the node.)

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
boolean annulChildNodes: Flag indicating to remove children from the hierarchy and delete children if the child is an orphan.
+Operation Definition
<operation name="annulNode">
<input message="annulNode"/>
<output message="annulNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="annulNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Approves a request.

Input Parameters:

int requestId: ID of the request header.

Output Parameters:

RequestValidationResultType requestValidationResult: The request validation result. Returned when one validates a request.
+Operation Definition
<operation name="approveRequest">
<input message="approveRequest"/>
<output message="approveRequestResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="approveRequest">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Assigns a global, inheriting property to a hierarchy. This will control what hierarchy a property value is inherited from.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string propName: Property definition name.
+Operation Definition
<operation name="assignControlledProps">
<input message="assignControlledProps"/>
<output message="assignControlledPropsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="assignControlledProps">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Closing a version clears it from memory and deletes it if not saved to the database.

Input Parameters:

string versionName: Version name field.
+Operation Definition
<operation name="closeVersion">
<input message="closeVersion"/>
<output message="closeVersionResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="closeVersion">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Copies a node and inserts that node under a Parent.

Input Parameters:

string versionName: Version name of the source node.
string hierName: Hierarchy name of the source node.
string nodeName: Node name of the source node.
string targetHierName: Hierarchy name that the node will be copied to.
string targetParentName: Parent node that the new node will be inserted as a child.
+Operation Definition
<operation name="copyNode">
<input message="copyNode"/>
<output message="copyNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="copyNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Copies a node's specified property values to an existing node.

Input Parameters:

NodeLocatorType sourceNodeLocator: Source locator indicating version, hierarchy and node.
NodeLocatorType targetNodeLocator: Target locator indicating version, hierarchy and node.
PropCopyModeEnum propCopyMode: Mode that indicates to the server which type of properties should be copied.
StringListType selectedPropNameList: If copy mode is set to selected; this list will contain the properties to copy.
+Operation Definition
<operation name="copyNodeProps">
<input message="copyNodeProps"/>
<output message="copyNodePropsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="copyNodeProps">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a user based upon an existing user.

Input Parameters:

string existingUserName: User name of the user to copy.
string userName: User name desired for the new user.
+Operation Definition
<operation name="copyUser">
<input message="copyUser"/>
<output message="copyUserResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="copyUser">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous job to copy a version and its contents.

Input Parameters:

string sourceVersion: Name of the version to copy.
string targetVersion: Name of the new version.
string targetDescr: Description of the new version.
boolean clearApproval: Flag indicating whether the approval flags should be cleared.
boolean clearChanged: Flag indicating whether the changed on properties should be cleared.
boolean dbConnect: Flag indicating whether the version should be persisted to the data store.
+Operation Definition
<operation name="copyVersion">
<input message="copyVersion"/>
<output message="copyVersionResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="copyVersion">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a blender.

Input Parameters:

BlenderType blender: The input parameter for a blender.
+Operation Definition
<operation name="createBlender">
<input message="createBlender"/>
<output message="createBlenderResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="createBlender">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a book.

Input Parameters:

BookType book: The input parameter for a book.
+Operation Definition
<operation name="createBook">
<input message="createBook"/>
<output message="createBookResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="createBook">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a compare.

Input Parameters:

CompareType compare: The input parameter for creating a compare.
+Operation Definition
<operation name="createCompare">
<input message="createCompare"/>
<output message="createCompareResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="createCompare">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates an export.

Input Parameters:

ExportType export: The input parameter for creating an export.
+Operation Definition
<operation name="createExport">
<input message="createExport"/>
<output message="createExportResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="createExport">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates an import.

Input Parameters:

ImportType importDef: The input parameter for creating an import.
+Operation Definition
<operation name="createImport">
<input message="createImport"/>
<output message="createImportResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="createImport">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a query.

Input Parameters:

QueryType query: The input parameter for creating a query.
+Operation Definition
<operation name="createQuery">
<input message="createQuery"/>
<output message="createQueryResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="createQuery">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Creates a request.

Input Parameters:

RequestType request: The input parameter for creating a request.
+Operation Definition
<operation name="createRequest">
<input message="createRequest"/>
<output message="createRequestResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="createRequest">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a blender.

Input Parameters:

string blenderName: Blender name to delete.
ObjectAccessEnum access: Object access of the blender to delete.
+Operation Definition
<operation name="deleteBlender">
<input message="deleteBlender"/>
<output message="deleteBlenderResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteBlender">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a book.

Input Parameters:

string bookName: Book name to delete.
ObjectAccessEnum access: Object access of the book to delete.
+Operation Definition
<operation name="deleteBook">
<input message="deleteBook"/>
<output message="deleteBookResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteBook">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a compare.

Input Parameters:

string compareName: Compare name to delete.
ObjectAccessEnum access: Object access of the compare to delete.
+Operation Definition
<operation name="deleteCompare">
<input message="deleteCompare"/>
<output message="deleteCompareResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteCompare">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes an export.

Input Parameters:

string exportName: Export name to delete.
ObjectAccessEnum access: Object access of the export to delete.
+Operation Definition
<operation name="deleteExport">
<input message="deleteExport"/>
<output message="deleteExportResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteExport">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a glyph.

Input Parameters:

string glyphName: Glyph name to delete.
+Operation Definition
<operation name="deleteGlyph">
<input message="deleteGlyph"/>
<output message="deleteGlyphResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteGlyph">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a hierarchy within a version.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
+Operation Definition
<operation name="deleteHier">
<input message="deleteHier"/>
<output message="deleteHierResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteHier">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a hierarchy group.

Input Parameters:

string groupName: Name of the hierarchy group to delete.
+Operation Definition
<operation name="deleteHierGroup">
<input message="deleteHierGroup"/>
<output message="deleteHierGroupResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteHierGroup">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes an import.

Input Parameters:

string importName: Name of the import to delete.
ObjectAccessEnum access: Object access of the import to delete.
+Operation Definition
<operation name="deleteImport">
<input message="deleteImport"/>
<output message="deleteImportResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteImport">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a node within a hierarchy.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string mergeNodeName: Name of a node to merge with (if merging is desired and enabled).
boolean destroyNode: Flag indicating that the node should be permanently deleted if the node becomes an orphan after merging.
+Operation Definition
<operation name="deleteNode">
<input message="deleteNode"/>
<output message="deleteNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a node access group.

Input Parameters:

string nodeAccessGroupName: Name of the node access group to delete.
+Operation Definition
<operation name="deleteNodeAccessGroup">
<input message="deleteNodeAccessGroup"/>
<output message="deleteNodeAccessGroupResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteNodeAccessGroup">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a node type.

Input Parameters:

string nodeTypeName: Name of the node type to delete.
+Operation Definition
<operation name="deleteNodeType">
<input message="deleteNodeType"/>
<output message="deleteNodeTypeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteNodeType">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes one or more nodes within a hierarchy. Enables you to specify Merge nodes as well as destroy the nodes (if they exist under more than one parent)

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of nodes to delete.
StringListType mergeNodeNameList: Name of the nodes to merge with (if merging is desired and enabled).
boolean destroyNodes: Flag indicating that the nodes should be permanently deleted if the nodes become orphans after merging.
+Operation Definition
<operation name="deleteNodes">
<input message="deleteNodes"/>
<output message="deleteNodesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteNodes">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes Orphan nodes within a version. Enables you to specify a Merge node for the Orphan.

Input Parameters:

string versionName: Version name field.
StringListType nodeNames: List of orphan nodes to permanently delete.
StringListType mergeNodes: Name of the nodes to merge with (if merging is desired and enabled).
+Operation Definition
<operation name="deleteOrphanNodes">
<input message="deleteOrphanNodes"/>
<output message="deleteOrphanNodesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteOrphanNodes">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a property category.

Input Parameters:

string propCategoryName: Name of the property category to delete.
+Operation Definition
<operation name="deletePropCategory">
<input message="deletePropCategory"/>
<output message="deletePropCategoryResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deletePropCategory">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a property definition

Input Parameters:

string propDefName: Name of the property definition to delete.
+Operation Definition
<operation name="deletePropDef">
<input message="deletePropDef"/>
<output message="deletePropDefResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deletePropDef">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a query.

Input Parameters:

string queryName: Name of the query to delete.
ObjectAccessEnum objectAccess: Object access of the query to delete.
+Operation Definition
<operation name="deleteQuery">
<input message="deleteQuery"/>
<output message="deleteQueryResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteQuery">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a request.

Input Parameters:

int requestId: ID of the request to delete.
+Operation Definition
<operation name="deleteRequest">
<input message="deleteRequest"/>
<output message="deleteRequestResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteRequest">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a user.

Input Parameters:

string userName: User name of the user to delete.
+Operation Definition
<operation name="deleteUser">
<input message="deleteUser"/>
<output message="deleteUserResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteUser">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Deletes a validation definition.

Input Parameters:

string validationName: Name of the validation to delete.
+Operation Definition
<operation name="deleteValidation">
<input message="deleteValidation"/>
<output message="deleteValidationResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="deleteValidation">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns assigned global node validations for a version.

Input Parameters:

string versionName: Version name field.

Output Parameters:

ValidationListType validations: The assigned global node validations.
+Operation Definition
<operation name="getAssignedGlobalValidations">
<input message="getAssignedGlobalValidations"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getAssignedGlobalValidations">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns validations assigned at the hierarchy level.

Input Parameters:

HierLocatorType hierLocator: Hierarchy locator object to identify a hierarchy within a version.

Output Parameters:

ValidationListType validations: Assigned hierarchy validations.
+Operation Definition
<operation name="getAssignedHierValidations">
<input message="getAssignedHierValidations"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getAssignedHierValidations">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns validations assigned at the node level.

Input Parameters:

NodeLocatorType nodeLocator: Node locator object representing a node within a hierarchy.

Output Parameters:

ValidationListType validations: Assigned node validations.
+Operation Definition
<operation name="getAssignedNodeValidations">
<input message="getAssignedNodeValidations"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getAssignedNodeValidations">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns validations assigned at the version level.

Input Parameters:

string versionName: Version name field.

Output Parameters:

ValidationListType validations: Assigned version validations.
+Operation Definition
<operation name="getAssignedVersionValidations">
<input message="getAssignedVersionValidations"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getAssignedVersionValidations">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a blender.

Input Parameters:

string blenderName: Blender name.
ObjectAccessEnum access: Object access of the blender.

Output Parameters:

BlenderType blender: Blender object.
+Operation Definition
<operation name="getBlender">
<input message="getBlender"/>
<output message="getBlenderResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getBlender">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of blender names.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getBlenderNames">
<input message="getBlenderNames"/>
<output message="getBlenderNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getBlenderNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the blender results of the asynchronous Method startBlenderByName.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

BlenderResultsType blenderResult: Blender results object.
+Operation Definition
<operation name="getBlenderResults">
<input message="getBlenderResults"/>
<output message="getBlenderResultsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getBlenderResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a book.

Input Parameters:

string bookName: Book name.
ObjectAccessEnum access: Object access of the book.

Output Parameters:

BookType book: Represents the response for a book type.
+Operation Definition
<operation name="getBook">
<input message="getBook"/>
<output message="getBookResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getBook">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the individual book item results of the asynchronous startBookByName method.

Input Parameters:

BookItemResults bookResults: Asynchronous job results of a book run.

Output Parameters:

base64Binary content: Byte array of compressed bytes. Use the deflate algorithm to decompress the content.
+Operation Definition
<operation name="getBookItemResults">
<input message="getBookItemResults"/>
<output message="getBookItemResultsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getBookItemResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a string list of book names.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getBookNames">
<input message="getBookNames"/>
<output message="getBookNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getBookNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the results of the asynchronous startBookByName method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

base64Binary content: Byte array of compressed bytes. Use the deflate algorithm to decompress the content.
+Operation Definition
<operation name="getBookResults">
<input message="getBookResults"/>
<output message="getBookResultsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getBookResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the number of book items results from the startBookByName method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

int intVal: Primitive int value.
+Operation Definition
<operation name="getBookResultsItemCount">
<input message="getBookResultsItemCount"/>
<output message="getBookResultsItemCountResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getBookResultsItemCount">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the compare definition.

Input Parameters:

string compareName: Compare name.
ObjectAccessEnum access: Object access of the compare.

Output Parameters:

CompareType compare: The compare object.
+Operation Definition
<operation name="getCompare">
<input message="getCompare"/>
<output message="getCompareResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getCompare">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a string list of compare definition names.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getCompareNames">
<input message="getCompareNames"/>
<output message="getCompareNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getCompareNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the compare results from the asynchronous operation

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

CompareResultType compareResult: Results of a compare operation.
+Operation Definition
<operation name="getCompareResults">
<input message="getCompareResults"/>
<output message="getCompareResultsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getCompareResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a string list of global inheriting property names for a hierarchy.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getControlledPropNames">
<input message="getControlledPropNames"/>
<output message="getControlledPropNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getControlledPropNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the results from the asynchronous startCopyVersion method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

JobInfoType jobStatus: JobInfoType type.
+Operation Definition
<operation name="getCopyVersionResults">
<input message="getCopyVersionResults"/>
<output message="getCopyVersionResultsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getCopyVersionResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the results from the asynchronous startCreateVersionAsOfDate method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

AsOfVersionResultType asOfVersion: AsOfVersionResultType field.
+Operation Definition
<operation name="getCreateVersionAsOfDateResults">
<input message="getCreateVersionAsOfDateResults"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getCreateVersionAsOfDateResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the results from the asynchronous startCreateAsOfTxnID method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

AsOfVersionResultType asOfVersion: AsOfVersionResultType field.
+Operation Definition
<operation name="getCreateVersionAsOfTxnIDResults">
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getCreateVersionAsOfTxnIDResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the results from the asynchronous startDeleteVersion method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

JobInfoType jobStatus: JobInfoType type.
+Operation Definition
<operation name="getDeleteVersionResults">
<input message="getDeleteVersionResults"/>
<output message="getDeleteVersionResultsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getDeleteVersionResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a export definition.

Input Parameters:

string exportName: Export name.
ObjectAccessEnum access: Object access of the export.

Output Parameters:

ExportType export: Export object type.
+Operation Definition
<operation name="getExport">
<input message="getExport"/>
<output message="getExportResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getExport">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a string list of export definition names.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getExportNames">
<input message="getExportNames"/>
<output message="getExportNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getExportNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the results from the asynchronous startExport method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

base64Binary content: Byte array of compressed bytes. Use the deflate algorithm to decompress the content.
+Operation Definition
<operation name="getExportResults">
<input message="getExportResults"/>
<output message="getExportResultsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getExportResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a global node within a version.

Input Parameters:

string versionName: Version name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: Enumeration indicating how the properties should be returned.

Output Parameters:

GlobalNodeWithPropValuesType globalNode: A response object that represents a global node object and property values.
+Operation Definition
<operation name="getGlobalNode">
<input message="getGlobalNode"/>
<output message="getGlobalNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getGlobalNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns specified property values for a global node within a version. This method can return property values as a name value pair OR as a values-only object.

Input Parameters:

string versionName: Version name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum propValueListType: Enumeration indicating how the properties should be returned.

Output Parameters:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.
+Operation Definition
<operation name="getGlobalNodePropValues">
<input message="getGlobalNodePropValues"/>
<output message="getGlobalNodePropValuesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getGlobalNodePropValues">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns specified property values for a global node within a version. This method returns property values as a list of PropType objects.

Input Parameters:

string versionName: Version name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.

Output Parameters:

PropListType propList: Return list type field of PropListType types.
+Operation Definition
<operation name="getGlobalNodeProps">
<input message="getGlobalNodeProps"/>
<output message="getGlobalNodePropsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getGlobalNodeProps">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the number of references of a globalNode.

Input Parameters:

GlobalNodeLocatorType globalNodeLocator: Global node locator object to identify a global node.

Output Parameters:

int intVal: Primitive int value.
+Operation Definition
<operation name="getGlobalNodeRefCount">
<input message="getGlobalNodeRefCount"/>
<output message="getGlobalNodeRefCountResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getGlobalNodeRefCount">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the references of a global node.

Input Parameters:

GlobalNodeLocatorType globalNodeLocator: Global node locator object to identify a global node.

Output Parameters:

GlobalNodeRefsResponseType references: List of hierarchies in which the node exists (including current).
+Operation Definition
<operation name="getGlobalNodeReferences">
<input message="getGlobalNodeReferences"/>
<output message="getGlobalNodeReferencesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getGlobalNodeReferences">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns one or more global nodes within a version. This method enables you to specify the global nodes and their property values to return.

Input Parameters:

string versionName: Version name field.
StringListType nodeNameList: List of node names to retrieve.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: Enumeration indicating how the properties should be returned.

Output Parameters:

GlobalNodeWithPropValuesListType globalNodeList: An array of global nodes.
+Operation Definition
<operation name="getGlobalNodes">
<input message="getGlobalNodes"/>
<output message="getGlobalNodesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getGlobalNodes">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the query results of the asynchronous startGlobalQuery method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

GlobalQueryResultType globalQueryResult: A query results for a global query.
+Operation Definition
<operation name="getGlobalQueryResults">
<input message="getGlobalQueryResults"/>
<output message="getGlobalQueryResultsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getGlobalQueryResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a glyph.

Input Parameters:

string glyphName: Name of the glyph to return.

Output Parameters:

GlyphType glyph: Glyph type object.
+Operation Definition
<operation name="getGlyph">
<input message="getGlyph"/>
<output message="getGlyphResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getGlyph">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a hierarchy within a version.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.

Output Parameters:

HierType hier: The hierarchy object type.
+Operation Definition
<operation name="getHier">
<input message="getHier"/>
<output message="getHierResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getHier">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a hierarchy group.

Input Parameters:

string name: The hierarchy group name to return.

Output Parameters:

HierGroup hierGroup: The hierarchy group type object.
+Operation Definition
<operation name="getHierGroup">
<input message="getHierGroup"/>
<output message="getHierGroupResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getHierGroup">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns all hierarchy group names.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getHierGroupNames">
<input message="getHierGroupNames"/>
<output message="getHierGroupNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getHierGroupNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of hierarchy names within a version.

Input Parameters:

string versionName: Version name field.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getHierNames">
<input message="getHierNames"/>
<output message="getHierNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getHierNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns specified property values for a hierarchy. This method can return property values as a name value pair OR as a values-only object.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

Output Parameters:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.
+Operation Definition
<operation name="getHierPropValues">
<input message="getHierPropValues"/>
<output message="getHierPropValuesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getHierPropValues">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns specified property value objects for a hierarchy.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType propNameList: List of properties to return.

Output Parameters:

PropListType propList: Return list type field of PropListType types.
+Operation Definition
<operation name="getHierProps">
<input message="getHierProps"/>
<output message="getHierPropsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getHierProps">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a hierarchy top node.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

Output Parameters:

NodeWithPropValuesType node: A return type for a node and its property values.
+Operation Definition
<operation name="getHierTopNode">
<input message="getHierTopNode"/>
<output message="getHierTopNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getHierTopNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of hierarchies for a given version.

Input Parameters:

string versionName: Version name field.
StringListType hierNameList: List of hierarchies to return.

Output Parameters:

HierListType hierList: The hierarchy group list type object.
+Operation Definition
<operation name="getHiers">
<input message="getHiers"/>
<output message="getHiersResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getHiers">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns an import definition.

Input Parameters:

string importName: The import name to return.
ObjectAccessEnum access: The object access of the import.

Output Parameters:

ImportType importProfile: The import type object.
+Operation Definition
<operation name="getImport">
<input message="getImport"/>
<output message="getImportResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getImport">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of import names.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getImportNames">
<input message="getImportNames"/>
<output message="getImportNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getImportNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the import results from the asynchronous startImport OR startImportByName methods.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

ImportResultsType importResults: The results of an import run.
+Operation Definition
<operation name="getImportResults">
<input message="getImportResults"/>
<output message="getImportResultsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getImportResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a asynchronous job object; the job object contains information about status and any exceptions that may have occurred.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

JobInfoType jobStatus: JobInfoType type.
+Operation Definition
<operation name="getJobStatus">
<input message="getJobStatus"/>
<output message="getJobStatusResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getJobStatus">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns transaction log items.

Input Parameters:

LogCriteriaType logCriteria: An object representing criteria for transaction history.

Output Parameters:

LogItemListType logItemList: List of logItemType objects.
+Operation Definition
<operation name="getLogItems">
<input message="getLogItems"/>
<output message="getLogItemsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getLogItems">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a local node and optional property values for that node.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

Output Parameters:

NodeWithPropValuesType node: A return type for a node and its property values.
+Operation Definition
<operation name="getNode">
<input message="getNode"/>
<output message="getNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a node access group.

Input Parameters:

string nodeAccessGroupName: Node access group name to return.

Output Parameters:

NodeAccessGroupType nodeAccessGroup: An object representing a node access group.
+Operation Definition
<operation name="getNodeAccessGroup">
<input message="getNodeAccessGroup"/>
<output message="getNodeAccessGroupResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getNodeAccessGroup">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of node access group names.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getNodeAccessGroupNames">
<input message="getNodeAccessGroupNames"/>
<output message="getNodeAccessGroupNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getNodeAccessGroupNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of users for a node access group.

Input Parameters:

string nodeAccessGroupName: Node access group name.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getNodeAccessGroupUserList">
<input message="getNodeAccessGroupUserList"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getNodeAccessGroupUserList">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a node access groups access level.

Input Parameters:

NodeLocatorType nodeLocator: Node locator object representing a node within a hierarchy and version.

Output Parameters:

AccessLevelEnum accessLevel: The access level for a node.
+Operation Definition
<operation name="getNodeAccessLevel">
<input message="getNodeAccessLevel"/>
<output message="getNodeAccessLevelResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getNodeAccessLevel">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a node given a node ID.

Input Parameters:

HierLocatorType hierLocator: A hierarchy locator object representing a hierarchy in a version.
string name: The name of the node to return.

Output Parameters:

NodeType node: The node object.
+Operation Definition
<operation name="getNodeByID">
<input message="getNodeByID"/>
<output message="getNodeByIDResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getNodeByID">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a node's specified property values. This method can return property values as a name value pair OR as a values-only object.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

Output Parameters:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.
+Operation Definition
<operation name="getNodePropValues">
<input message="getNodePropValues"/>
<output message="getNodePropValuesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getNodePropValues">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a nodes's specified property values. This method returns property values as a list of PropType objects.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.

Output Parameters:

PropListType propList: Return list type field of PropListType types.
+Operation Definition
<operation name="getNodeProps">
<input message="getNodeProps"/>
<output message="getNodePropsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getNodeProps">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of node type names.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getNodeTypeNames">
<input message="getNodeTypeNames"/>
<output message="getNodeTypeNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getNodeTypeNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns an array of node type objects.

Output Parameters:

NodeTypeTypeListType nodeTypeList: A return list type for a node type.
+Operation Definition
<operation name="getNodeTypes">
<input message="getNodeTypes"/>
<output message="getNodeTypesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getNodeTypes">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a node and specified PropType objects.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.

Output Parameters:

NodeWithPropsType nodeWithProps: A return type that includes a node and its property objects.
+Operation Definition
<operation name="getNodeWithProps">
<input message="getNodeWithProps"/>
<output message="getNodeWithPropsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getNodeWithProps">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns one or more specified nodes.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of node names.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

Output Parameters:

NodeWithPropValuesListType nodeList: A return type for a list of nodes and their property values.
+Operation Definition
<operation name="getNodes">
<input message="getNodes"/>
<output message="getNodesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getNodes">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns orphan nodes and their properties for a given version. You can specify the global properties to be returned in the input parameter.

Input Parameters:

string versionName: Version name field.
StringListType requestedProps: List of properties to return.
int maxNodes: The maximum number of nodes to return in the result.

Output Parameters:

GlobalQueryResponseType queryResults: A global query result.
+Operation Definition
<operation name="getOrphanNodes">
<input message="getOrphanNodes"/>
<output message="getOrphanNodesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getOrphanNodes">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of property categories.

Output Parameters:

PropCategoryListType propCategoryListType: List type object representing property categories.
+Operation Definition
<operation name="getPropCategories">
<input message="getPropCategories"/>
<output message="getPropCategoriesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getPropCategories">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a property definition by name.

Input Parameters:

string propDefName: The name of the property definition to retrieve.

Output Parameters:

PropDefType propDef: A return type for a property definition.
+Operation Definition
<operation name="getPropDef">
<input message="getPropDef"/>
<output message="getPropDefResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getPropDef">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of specified property definition names.

Input Parameters:

ObjectScopeEnum propDefLevel: An enumeration indicating the scope of the property definition.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getPropDefNames">
<input message="getPropDefNames"/>
<output message="getPropDefNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getPropDefNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns an array list of specified property definition objects.

Input Parameters:

ObjectScopeEnum propDefLevel: An enumeration indicating the scope of the property definition.

Output Parameters:

PropDefListType propDefList: Return list type for property definitions.
+Operation Definition
<operation name="getPropDefs">
<input message="getPropDefs"/>
<output message="getPropDefsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getPropDefs">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns an array list property definition objects for a given property category.

Input Parameters:

string categoryName: Property category name.

Output Parameters:

PropDefListType propDefs: Array of property definition objects.
+Operation Definition
<operation name="getPropDefsByCategory">
<input message="getPropDefsByCategory"/>
<output message="getPropDefsByCategoryResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getPropDefsByCategory">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns an array list of specified query objects.

Input Parameters:

boolean global: Flag indicating if global queries should be returned.
StringListType queryNameList: The list of queries to return.

Output Parameters:

QueryListType queryList: Field for a queryListType object.
+Operation Definition
<operation name="getQueries">
<input message="getQueries"/>
<output message="getQueriesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getQueries">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a query by name.

Input Parameters:

string queryName: The name of the query.
ObjectAccessEnum access: The object access of the query.

Output Parameters:

QueryType query: A query type object.
+Operation Definition
<operation name="getQuery">
<input message="getQuery"/>
<output message="getQueryResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getQuery">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of query names.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getQueryNames">
<input message="getQueryNames"/>
<output message="getQueryNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getQueryNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns query results for the asynchronous startQuery method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

QueryResultType queryResult: A list type of queryResultType types.
+Operation Definition
<operation name="getQueryResults">
<input message="getQueryResults"/>
<output message="getQueryResultsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getQueryResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the related node count for a given node given the input of: ancestors, children, descendants, siblings.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
RelationshipEnum relationship: An enumeration indicating what types of nodes to return (Children, Descendants, and so on).
boolean visibleOnly: Flag indicating that visible children should only be returned.
boolean includeLeaves: Flag to include leaf nodes.

Output Parameters:

int intVal: Primitive int value.
+Operation Definition
<operation name="getRelatedNodeCount">
<input message="getRelatedNodeCount"/>
<output message="getRelatedNodeCountResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getRelatedNodeCount">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns related node names for a given node given the input of: ancestors, children, descendants, siblings.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getRelatedNodeNames">
<input message="getRelatedNodeNames"/>
<output message="getRelatedNodeNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getRelatedNodeNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the related nodes for a node given the input of: ancestors, children, descendants, siblings.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

Output Parameters:

NodeWithPropValuesListType nodeList: A return type for a list of nodes and their property values.
+Operation Definition
<operation name="getRelatedNodes">
<input message="getRelatedNodes"/>
<output message="getRelatedNodesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getRelatedNodes">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the related nodes and properties for a node given the input of: ancestors, children, descendants, siblings.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).
StringListType propNameList: List of properties to return.

Output Parameters:

NodeWithPropsListType nodeWithPropsList: A return type that includes a list of nodes and their node property objects.
+Operation Definition
<operation name="getRelatedNodesWithProps">
<input message="getRelatedNodesWithProps"/>
<output message="getRelatedNodesWithPropsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getRelatedNodesWithProps">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a request by external ID.

Input Parameters:

string externalId: The free-form field on a request object.

Output Parameters:

RequestHeaderListType requestHeaderList: List of request headers.
+Operation Definition
<operation name="getRequestByExternalId">
<input message="getRequestByExternalId"/>
<output message="getRequestByExternalIdResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getRequestByExternalId">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a request by ID.

Input Parameters:

int requestId: The system-generated ID for a request.

Output Parameters:

RequestType request: The request object.
+Operation Definition
<operation name="getRequestById">
<input message="getRequestById"/>
<output message="getRequestByIdResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getRequestById">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the results of the asynchronous startSaveVersion method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

JobInfoType jobStatus: JobInfoType type.
+Operation Definition
<operation name="getSaveVersionResults">
<input message="getSaveVersionResults"/>
<output message="getSaveVersionResultsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getSaveVersionResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of action items from transaction log criteria.

Input Parameters:

LogCriteriaType logCriteria: An object representing criteria for transaction history.

Output Parameters:

ActionItemListType getScriptFromLogResponse: List of action item objects.
+Operation Definition
<operation name="getScriptFromLog">
<input message="getScriptFromLog"/>
<output message="getScriptFromLogResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getScriptFromLog">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of action items for modeling a node.

Input Parameters:

string versionName: Version name field.
string nodeName: Node name field.
string newNodeName: The new node name to create.
string newNodeDescr: The new node description.
StringListType hierNameList: The list of hierarchies the existing node exists in.
PropCopyModeEnum propCopyMode: An enumeration indicating what type of properties should be included.
StringListType propNameList: If the copy mode is selected then this list of properties will be evaluated in the node model operation.

Output Parameters:

ActionItemListType getScriptFromModelResponse: List of action items.
+Operation Definition
<operation name="getScriptFromModel">
<input message="getScriptFromModel"/>
<output message="getScriptFromModelResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getScriptFromModel">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns the results of the asynchronous startScript method.

Input Parameters:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.

Output Parameters:

ActionItemResultListType actionItemList: List of action items.
+Operation Definition
<operation name="getScriptResults">
<input message="getScriptResults"/>
<output message="getScriptResultsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getScriptResults">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a system preference value.

Input Parameters:

string systemPreferenceName: The name of the system preference to return.

Output Parameters:

StringResponseType result: The result of the GetSysPrefValue operation.
+Operation Definition
<operation name="getSysPrefValue">
<input message="getSysPrefValue"/>
<output message="getSysPrefValueResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getSysPrefValue">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns all of the system preferences.

Output Parameters:

SystemPreferenceListType systemPreferences: The list result of system preference values.
+Operation Definition
<operation name="getSysPrefs">
<input message="getSysPrefs"/>
<output message="getSysPrefsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getSysPrefs">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a user by name.

Input Parameters:

string userName: The user name of the user to retrieve.

Output Parameters:

UserType user: Represents a user object.
+Operation Definition
<operation name="getUser">
<input message="getUser"/>
<output message="getUserResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getUser">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of user names.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getUserNames">
<input message="getUserNames"/>
<output message="getUserNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getUserNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a validation.

Input Parameters:

string validationName: The name of the validation to retrieve.

Output Parameters:

ValidationDefinitionType validation: The validation object.
+Operation Definition
<operation name="getValidation">
<input message="getValidation"/>
<output message="getValidationResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getValidation">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of validation names.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getValidationNames">
<input message="getValidationNames"/>
<output message="getValidationNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getValidationNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of all validations.

Output Parameters:

ValidationListType validations: An array of validation objects.
+Operation Definition
<operation name="getValidations">
<input message="getValidations"/>
<output message="getValidationsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getValidations">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a version by name.

Input Parameters:

string versionName: Version name field.

Output Parameters:

VersionType version: The version object field.
+Operation Definition
<operation name="getVersion">
<input message="getVersion"/>
<output message="getVersionResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getVersion">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns a list of version names.

Output Parameters:

StringListType stringList: A list of strings field.
+Operation Definition
<operation name="getVersionNames">
<input message="getVersionNames"/>
<output message="getVersionNamesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getVersionNames">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns version level property values for a version.This method can return property values as a name value pair OR as a values-only object.

Input Parameters:

string versionName: Version name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.

Output Parameters:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.
+Operation Definition
<operation name="getVersionPropValues">
<input message="getVersionPropValues"/>
<output message="getVersionPropValuesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getVersionPropValues">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns an array of specified version level property types.

Input Parameters:

string versionName: Version name field.
StringListType propNameList: List of properties to return.

Output Parameters:

PropListType propList: Return list type field of PropListType types.
+Operation Definition
<operation name="getVersionProps">
<input message="getVersionProps"/>
<output message="getVersionPropsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getVersionProps">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns an array of specified versions.

Input Parameters:

StringListType versionNameList: A list of version names.

Output Parameters:

VersionListType versionList: List type of versionType objects.
+Operation Definition
<operation name="getVersions">
<input message="getVersions"/>
<output message="getVersionsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="getVersions">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Inactivates a node.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name to inactivate.
string mergeNodeName: The name of the node to merge this inactive node to (if merging is enabled).
+Operation Definition
<operation name="inactivateNode">
<input message="inactivateNode"/>
<output message="inactivateNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="inactivateNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Inactivates specified nodes.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of nodes to inactivate.
StringListType mergeNodeNameList: List of node names to merge the corresponding nodeNameList with (if merging is enabled).
+Operation Definition
<operation name="inactivateNodes">
<input message="inactivateNodes"/>
<output message="inactivateNodesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="inactivateNodes">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Inserts a node under a parent node in a hierarchy.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string targetParentName: The existing parent node name to insert this node under.
NameValueListType propNameValueList: Name/Value Pair list field for property definition name and value for the node property value.
+Operation Definition
<operation name="insertNode">
<input message="insertNode"/>
<output message="insertNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="insertNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Inserts a node under a parent node in a hierarchy. This method also updates node properties that are specified in the input parameters.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string targetParentName: The existing parent node name to insert this node under.
PropListType propList: Array of properties to update.
+Operation Definition
<operation name="insertNodeWithProps">
<input message="insertNodeWithProps"/>
<output message="insertNodeWithPropsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="insertNodeWithProps">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Inserts one or more nodes under a parent node.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of nodes to insert under a new parent.
string targetParentName: The existing parent node name to insert this node under.
+Operation Definition
<operation name="insertNodes">
<input message="insertNodes"/>
<output message="insertNodesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="insertNodes">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Moves a node to a new parent node in a hierarchy.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string targetParentName: The name of the new parent node.
+Operation Definition
<operation name="moveNode">
<input message="moveNode"/>
<output message="moveNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="moveNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Moves one or more nodes to new parent node in a hierarchy.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of node names to move.
string targetParentName: The name of the new parent node.
+Operation Definition
<operation name="moveNodes">
<input message="moveNodes"/>
<output message="moveNodesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="moveNodes">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Opens a version into memory.

Input Parameters:

string versionName: Version name field.
+Operation Definition
<operation name="openVersion">
<input message="openVersion"/>
<output message="openVersionResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="openVersion">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Orders children nodes for a given parent node.

Input Parameters:

NodeLocatorType nodeLocator: Node locator object representing a node within a hierarchy.
StringListType nodeNames: List of nodes to order. The sequence of this list will be used to order the children.
+Operation Definition
<operation name="orderChildren">
<input message="orderChildren"/>
<output message="orderChildrenResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="orderChildren">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Returns request headers given query criteria.

Input Parameters:

RequestQueryParamsType requestQueryParams: Field for request query parameters.

Output Parameters:

RequestHeaderListType requestHeaderList: List of request headers.
+Operation Definition
<operation name="queryRequests">
<input message="queryRequests"/>
<output message="queryRequestsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="queryRequests">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Reactivates a inactive node.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
+Operation Definition
<operation name="reactivateNode">
<input message="reactivateNode"/>
<output message="reactivateNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="reactivateNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Reactivates one or more inactive nodes.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of node names to reactivate.
+Operation Definition
<operation name="reactivateNodes">
<input message="reactivateNodes"/>
<output message="reactivateNodesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="reactivateNodes">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Removes a parent child relationship for a node within a hierarchy; the node is not physically deleted.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
+Operation Definition
<operation name="removeNode">
<input message="removeNode"/>
<output message="removeNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="removeNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Removes a parent child relationship for one or more nodes within a hierarchy; the nodes are not physically deleted.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: A list of node names to remove.
+Operation Definition
<operation name="removeNodes">
<input message="removeNodes"/>
<output message="removeNodesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="removeNodes">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Runs an existing blender and returns the results.

Input Parameters:

string blenderName: The name of a blender.
string sourceVersionName: The source version name.
string targetVersionName: The target version name.
ObjectAccessEnum access: Access level of the blender to run.
string newVersionName: If present, the new version name that will be created as a result of the blend operation instead of blending into the target version.
string newVersionDescr: If present, the new version description that will be created as a result of the blend operation instead of blending into the target version.
int timeoutDuration: A timeout value in milliseconds to stop waiting for blender results.

Output Parameters:

BlenderResultsType blenderResult: Blender results object.
+Operation Definition
<operation name="runBlenderByName">
<input message="runBlenderByName"/>
<output message="runBlenderByNameResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="runBlenderByName">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Runs a compare given compareCriteria and a string list of properties to return with the results.

Input Parameters:

CompareType compareCriteria: The compare criteria to be used to run the compare.
StringListType returnPropNameList: List of property values to return after the compare.

Output Parameters:

CompareResultType compareResult: Results of a compare operation.
+Operation Definition
<operation name="runCompare">
<input message="runCompare"/>
<output message="runCompareResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="runCompare">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Runs a compare given a compare name. This method runs an existing compare.

Input Parameters:

string compareName: The compare name to run.
string fromVersionName: The source version name for the compare.
string toVersionName: The target version name for the compare.
ObjectAccessEnum access: Access level of the compare to run.
StringListType returnPropNameList: List of property values to return after the compare.

Output Parameters:

CompareResultType compareResult: Results of a compare operation.
+Operation Definition
<operation name="runCompareByName">
<input message="runCompareByName"/>
<output message="runCompareByNameResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="runCompareByName">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Runs a global query and returns the query results.

Input Parameters:

QueryType query: The query criteria for the global query.
StringListType propNameList: List of property values to return after the query.

Output Parameters:

GlobalQueryResultType globalQueryResult: A query results for a global query.
+Operation Definition
<operation name="runGlobalQuery">
<input message="runGlobalQuery"/>
<output message="runGlobalQueryResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="runGlobalQuery">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Rusn a local query and returns the query results.

Input Parameters:

QueryType query: The query criteria for the local query.
StringListType propNameList: List of property values to return after the query.

Output Parameters:

QueryResultType queryResult: A list type of queryResultType types.
+Operation Definition
<operation name="runQuery">
<input message="runQuery"/>
<output message="runQueryResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="runQuery">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Runs batch validations on a given hierarchy and returns the results.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType validationNameList: List of validation names to run for the hierarchy.
int maxNodes: The maximum number of results to return for the validation run.
StringListType propNameList: List of properties to return in the validation results.

Output Parameters:

HierValidationResultType validationResult: The results of a hierarchy level validation run.
+Operation Definition
<operation name="runValidateHier">
<input message="runValidateHier"/>
<output message="runValidateHierResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="runValidateHier">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Runs batch validations on a given node and returns the results.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType validationNameList: List of validation names to run for the node.
boolean recurse: Flag indicating if the validation should run the node specified and its descendants.
int maxNodes: The maximum number of validation results to return.
StringListType propNameList: List of properties to return in the validation results.

Output Parameters:

QueryResultType queryResult: A list type of queryResultType types.
+Operation Definition
<operation name="runValidateNode">
<input message="runValidateNode"/>
<output message="runValidateNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="runValidateNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Runs batch validations on a given version and returns the results.

Input Parameters:

string versionName: Version name field.
StringListType validationNameList: List of validation names to run for the version.
int maxNodes: The maximum number of validation results to return.
StringListType propNameList: List of properties to return in the validation results.

Output Parameters:

VersionValidationResultType validationResult: The version validation results.
+Operation Definition
<operation name="runValidateVersion">
<input message="runValidateVersion"/>
<output message="runValidateVersionResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="runValidateVersion">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Finds nodes within a hierarchy given a search value.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string propName: Property name field.
string searchString: The search criteria value. An asterisk (*) can be supplied as a wildcard character.
int maxNodes: The maximum number of nodes to return in the result.
StringListType returnPropNameList: List of properties to return in the results.

Output Parameters:

QueryResultType queryResult: A list type of queryResultType types.
+Operation Definition
<operation name="searchForNodesInHier">
<input message="searchForNodesInHier"/>
<output message="searchForNodesInHierResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="searchForNodesInHier">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Finds nodes within a version given a search value.

Input Parameters:

string versionName: Version name field.
string propName: Property name field.
string searchString: The search criteria value. An asterisk (*) can be supplied as a wildcard character.
int maxNodes: The maximum number of nodes to return in the result.
StringListType returnPropNameList: List of properties to return in the results.

Output Parameters:

QueryResultListType queryResultList: A list response type for query results.
+Operation Definition
<operation name="searchForNodesInVersion">
<input message="searchForNodesInVersion"/>
<output message="searchForNodesInVersionResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="searchForNodesInVersion">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates a hierarchy with a new top node.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string topNodeName: The top node name.
+Operation Definition
<operation name="setHierTopNode">
<input message="setHierTopNode"/>
<output message="setHierTopNodeResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="setHierTopNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Assigns validations at the hierarchy level (RealTime or Batch).

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType validationNameList: List of validation names.
+Operation Definition
<operation name="setHierValidations">
<input message="setHierValidations"/>
<output message="setHierValidationsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="setHierValidations">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an internal user's password.

Input Parameters:

string userName: The username field.
string newPassword: The new password for the user.
PasswordExpireEnum passwordExpireType: An enumeration indicating how the password should expire.
+Operation Definition
<operation name="setUserPassword">
<input message="setUserPassword"/>
<output message="setUserPasswordResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="setUserPassword">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Assigns validations at the version level (RealTime or Batch).

Input Parameters:

string versionName: Version name field.
StringListType validationNameList: List of version names.
+Operation Definition
<operation name="setVersionValidations">
<input message="setVersionValidations"/>
<output message="setVersionValidationsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="setVersionValidations">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts a asynchronous blender job.

Input Parameters:

string blenderName: The blender name field.
string sourceVersionName: The source version name.
string targetVersionName: The target version name.
ObjectAccessEnum access: The object access level of the blender.
string newVersionName: If present, the new version name that will be created as a result of the blend operation instead of blending into the target version.
string newVersionDescr: If present, the new version description that will be created as a result of the blend operation instead of blending into the target version.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startBlenderByName">
<input message="startBlenderByName"/>
<output message="startBlenderByNameResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startBlenderByName">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts aN asynchronous book job by book name.

Input Parameters:

string bookName: The book name field.
ObjectAccessEnum access: The object access field for the book.
string fromVersionName: The current version name.
string toVersionName: The previous version name.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startBookByName">
<input message="startBookByName"/>
<output message="startBookByNameResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startBookByName">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous compare job given a compare.

Input Parameters:

CompareType compareCriteria: The compare criteria to be used for the compare.
StringListType returnPropNameList: List of properties to return in the results.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startCompare">
<input message="startCompare"/>
<output message="startCompareResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startCompare">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous compare job by compare name.

Input Parameters:

string compareName: The compare name field.
string fromVersionName: The from version name field.
string toVersionName: The to version name field.
ObjectAccessEnum access: The object access field for the book.
StringListType returnPropNameList: List of properties to return in the results.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startCompareByName">
<input message="startCompareByName"/>
<output message="startCompareByNameResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startCompareByName">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous compare export job by export name.

Input Parameters:

string exportName: The name of the compare export.
string fromVersionName: The from version name field.
string toVersionName: The to version name field.
ObjectAccessEnum access: The object access level of the export.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startCompareExportByName">
<input message="startCompareExportByName"/>
<output message="startCompareExportByNameResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startCompareExportByName">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts a asynchronous compare export for a hierarchy.

Input Parameters:

string exportName: The name of the compare export.
string fromVersionName: The from version name field.
string fromHierName: The from hierarchy name field.
string toVersionName: The to version name field.
string toHierName: The to hierarchy name field.
ObjectAccessEnum access: Access level of the export to run.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startCompareExportByNameOnHier">
<input message="startCompareExportByNameOnHier"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startCompareExportByNameOnHier">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous compare export for a node.

Input Parameters:

string exportName: The name of the compare export.
string fromVersionName: The from version name field.
HierNodeNamePairType fromHierNode: The from hierarchy name field.
string toVersionName: The to version name field.
HierNodeNamePairType toHierNode: The to hierarchy name field.
ObjectAccessEnum access: Access level of the export to run.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startCompareExportByNameOnHierNode">
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startCompareExportByNameOnHierNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous copy version job.

Input Parameters:

string sourceVersionName: The name of the version to copy.
string destVersionName: The new name of the version.
string destDescr: The new description field of the version.
boolean clearApproval: Flag indicating that the approval flags should be cleared.
boolean clearChanged: Flag indicating that the changed on properties should be cleared.
boolean dbConnect: Flag indicating that the version should be persisted to the data store.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startCopyVersion">
<input message="startCopyVersion"/>
<output message="startCopyVersionResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startCopyVersion">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous job to create a as of version based upon transaction Id.

Input Parameters:

string versionName: Version name field.
int endTxnId: Ending transaction ID field.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startCreateAsOfTxnID">
<input message="startCreateAsOfTxnID"/>
<output message="startCreateAsOfTxnIDResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startCreateAsOfTxnID">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous job to create a as of version based upon a date.

Input Parameters:

string versionName: Version name field.
dateTime asOfDateTime: A date time value to create the version snapshot.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startCreateVersionAsOfDate">
<input message="startCreateVersionAsOfDate"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startCreateVersionAsOfDate">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts ann asynchronous job to delete a version.

Input Parameters:

string versionName: Version name field.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startDeleteVersion">
<input message="startDeleteVersion"/>
<output message="startDeleteVersionResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startDeleteVersion">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous export job using a export definition.

Input Parameters:

ExportType export: The export type field.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startExport">
<input message="startExport"/>
<output message="startExportResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startExport">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous export job by export name.

Input Parameters:

string exportName: The export name to run.
ObjectAccessEnum access: Access level of the export to run.
string fromVersionName: The from version name field.
string toVersionName: The to version name field.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startExportByName">
<input message="startExportByName"/>
<output message="startExportByNameResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startExportByName">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous query job using query definition. Also returns specified properties for query matches.

Input Parameters:

QueryType query: The query criteria field.
StringListType propNameList: List of properties to return in the results.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startGlobalQuery">
<input message="startGlobalQuery"/>
<output message="startGlobalQueryResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startGlobalQuery">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous job for an existing hierarchy export definition.

Input Parameters:

string exportName: The export name to run.
string versionName: Version name field.
boolean includeAllHiers: Flag indicating that the export should include all hierarchies.
ObjectAccessEnum access: Access level of the export to run.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startHierExportByName">
<input message="startHierExportByName"/>
<output message="startHierExportByNameResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startHierExportByName">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous job for an existing hierarchy export definition. This method enables you to specify only one node per hierarchy as the node to export from.

Input Parameters:

string exportName: The export name to run.
string versionName: Version name field.
HierNodeNamePairType hierNode: The hierarchy node field.
ObjectAccessEnum access: Access level of the export to run.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startHierExportByNameOnHierNode">
<input message="startHierExportByNameOnHierNode"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startHierExportByNameOnHierNode">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous job for an existing hierarchy export definition. This method enables you to specify nodes per hierarchy as the node to export from.

Input Parameters:

string exportName: The export name to run.
string versionName: Version name field.
HierNodeNamePairListType hierNodeList: A list type with hierarchy/node pairs.
ObjectAccessEnum access: Access level of the export to run.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startHierExportByNameOnHierNodes">
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startHierExportByNameOnHierNodes">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous job for an existing hierarchy export definition. This method enables you to set a list of hierarchies within a version to export; each hierarchy specified is exported from its top node.

Input Parameters:

string exportName: The export name to run.
string versionName: Version name field.
StringListType hierNameList: A list type fo hierarchy names.
ObjectAccessEnum access: Access level of the export to run.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startHierExportByNameOnHiers">
<input message="startHierExportByNameOnHiers"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startHierExportByNameOnHiers">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous job to import given an import definition.

Input Parameters:

ImportType importProfile: The import profile field.
base64Binary compressedFileContent: Byte array of compressed bytes that represent the script file. The deflate algorithm should be used to compress the content.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startImport">
<input message="startImport"/>
<output message="startImportResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startImport">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous job to import given an import definition.

Input Parameters:

string importName: The import name field.
base64Binary compressedFileContent: Byte array of compressed bytes that represent the file. The deflate algorithm should be used to compress the content.
ObjectAccessEnum access: Access level of the import.
string versionName: Version name field. This field value will be used as the name of the version.
string versionDescription: Version description field. This field value will be used as the description of the version.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startImportByName">
<input message="startImportByName"/>
<output message="startImportByNameResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startImportByName">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous job for a query given a query definition.

Input Parameters:

QueryType query: Query criteria field.
StringListType propNameList: List of properties to return in the results.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startQuery">
<input message="startQuery"/>
<output message="startQueryResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startQuery">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous job to save a version.

Input Parameters:

string versionName: Version name field.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startSaveVersion">
<input message="startSaveVersion"/>
<output message="startSaveVersionResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startSaveVersion">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous action script job. This method takes a list of action items as input. Below is a list of possible actions with their min and max parameter count, the parameters to input, and their positions:

Activate - MinParamCount = 3, MaxParamCount = 3. Position: Parameters and position:versionName = 0, HierNamePos = 1, nodeName = 2
Add - MinParamCount = 5, MaxParamCount = 5. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, ParentNodeNamePos = 3, LeafFlagPos = 4
AddHier - MinParamCount = 4, MaxParamCount = 5. Parameters and position: versionNamePos = 0, HierNamePos = 1, HierDescriptionPos = 2, TopNodeNamePos = 3, TopNodeDescriptionPos = 4
AddInsert - MinParamCount = 5, MaxParamCount = 5. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, ParentNodeNamePos = 3, LeafFlagPos = 4
AddOrphan - MinParamCount = 3, MaxParamCount = 3. Parameters and position: versionNamePos = 0, nodeNamePos = 1, LeafFlagPos = 2
Annul - MinParamCount = 3, MaxParamCount = 3. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2
AnnulAllBelow - MinParamCount = 3, MaxParamCount = 3. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2
AssignHierValidations - MinParamCount = 2, MaxParamCount = 3. Parameters and position: versionNamePos = 0, HierNamePos = 1, validationListPos = 2
AssignVersionValidations - MinParamCount = 1, MaxParamCount = 2. Parameters and position: versionNamePos = 0, validationListPos = 1
ChangeGlobalProps - MinParamCount = 3, MaxParamCount = 4. Parameters and position: versionNamePos = 0, nodeNamePos = 1, PropertyLabelPos = 2, PropertyValuePos = 3
ChangeHierTopNode - MinParamCount = 3, MaxParamCount = 3. Parameters and position: versionNamePos = 0, HierNamePos = 1, TopNodeNamePos = 2
ChangeProp - MinParamCount = 4, MaxParamCount = 5. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, PropertyLabelPos = 3, PropertyValuePos = 4
ClearPropsBelow - MinParamCount = 4, MaxParamCount = 4. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, PropertyLabelPos = 3
Delete - MinParamCount = 3, MaxParamCount = 4. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, MergeNodeNamePos = 3
DeleteHier - MinParamCount = 2, MaxParamCount = 2. Parameters and position: versionNamePos = 0, HierNamePos = 1
DeleteOrphan - MinParamCount = 2, MaxParamCount = 3. Parameters and position: versionNamePos = 0, nodeNamePos = 1, MergeNodeNamePos = 2
Destroy - MinParamCount = 3, MaxParamCount = 3. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2
Inactivate - MinParamCount = 3, MaxParamCount = 4. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, MergeNodeNamePos = 3
Insert - MinParamCount = 4, MaxParamCount = 4. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, ParentNodeNamePos = 3
LockProp - MinParamCount = 5, MaxParamCount = 5. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, PropertyLabelPos = 3, LockFlagPos = 4
Move - MinParamCount = 4, MaxParamCount = 4. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, NewParentNodeNamePos = 3
NodeExists - MinParamCount = 2, MaxParamCount = 2. Parameters and position: versionNamePos = 0, nodeNamePos = 1
NodeExistsInHier - MinParamCount = 3, MaxParamCount = 3. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2
NodeHasAsParent - MinParamCount = 4, MaxParamCount = 4. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, ParentNodeNamePos = 3
PropCompare - MinParamCount = 4, MaxParamCount = 5. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, PropertyLabelPos = 3, compareToStringPos = 4
PropQuery - MinParamCount = 4, MaxParamCount = 4. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, PropertyLabelPos = 3
Remove - MinParamCount = 3, MaxParamCount = 3. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2
RemoveDupProps - MinParamCount = 4, MaxParamCount = 4. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, PropertyLabelPos = 3
RemoveHierPropValue - MinParamCount = 3, MaxParamCount = 3. Parameters and position: versionNamePos = 0, HierNamePos = 1, PropertyLabelPos = 2
RemoveProp - MinParamCount = 4, MaxParamCount = 4. Parameters and position: versionNamePos = 0, HierNamePos = 1, nodeNamePos = 2, PropertyLabelPos = 3
RemoveVersionPropValue - MinParamCount = 2, MaxParamCount = 2. Parameters and position: versionNamePos = 0, PropertyLabelPos = 1
UpdateHierPropValue - MinParamCount = 3, MaxParamCount = 4. Parameters and position: versionNamePos = 0, HierNamePos = 1, PropertyLabelPos = 2, PropertyValuePos = 3
UpdateVersionPropValue - MinParamCount = 2, MaxParamCount = 3. Parameters and position: versionNamePos = 0, PropertyLabelPos = 1, PropertyValuePos = 2

Input Parameters:

ActionItemListType actionItemList: A list of action items to process.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startScript">
<input message="startScript"/>
<output message="startScriptResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startScript">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Starts an asynchronous action script given a action script file.

Input Parameters:

ScriptLoadParamsType scriptLoaderParams: Field describes the action script content to be processed.
CharacterEncodingEnum encoding: An enumeration indicating encoding of the text file.

Output Parameters:

JobInfoType jobInfo: Job info field.
+Operation Definition
<operation name="startScriptFromFile">
<input message="startScriptFromFile"/>
<output message="startScriptFromFileResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="startScriptFromFile">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing blender.

Input Parameters:

BlenderType blender: Blender to be updated.
+Operation Definition
<operation name="updateBlender">
<input message="updateBlender"/>
<output message="updateBlenderResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateBlender">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing book.

Input Parameters:

BookType book: Book to be updated.
+Operation Definition
<operation name="updateBook">
<input message="updateBook"/>
<output message="updateBookResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateBook">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing compare.

Input Parameters:

CompareType compare: Compare to be updated.
+Operation Definition
<operation name="updateCompare">
<input message="updateCompare"/>
<output message="updateCompareResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateCompare">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing export.

Input Parameters:

ExportType export: Export to be updated.
+Operation Definition
<operation name="updateExport">
<input message="updateExport"/>
<output message="updateExportResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateExport">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing glyph.

Input Parameters:

GlyphType updateGlyph: Glyph to be updated.
+Operation Definition
<operation name="updateGlyph">
<input message="updateGlyph"/>
<output message="updateGlyphResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateGlyph">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing hierarchy group.

Input Parameters:

HierGroup hierGroup: Hierarchy group to be updated.
+Operation Definition
<operation name="updateHierGroup">
<input message="updateHierGroup"/>
<output message="updateHierGroupResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateHierGroup">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates property values for a hierarchy given a namevalue list type object.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
NameValueListType propValueList: A name value list type field that indicates the properties and their values.
+Operation Definition
<operation name="updateHierPropValues">
<input message="updateHierPropValues"/>
<output message="updateHierPropValuesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateHierPropValues">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates property values for a hierarchy given a list of proptype objects.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
PropListType propList: A list type object for the PropListType type.
+Operation Definition
<operation name="updateHierProps">
<input message="updateHierProps"/>
<output message="updateHierPropsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateHierProps">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing import.

Input Parameters:

ImportType importDef: The import definition object.
+Operation Definition
<operation name="updateImport">
<input message="updateImport"/>
<output message="updateImportResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateImport">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing node access group.

Input Parameters:

NodeAccessGroupType updateNodeAccessGroup: The node access group object.
+Operation Definition
<operation name="updateNodeAccessGroup">
<input message="updateNodeAccessGroup"/>
<output message="updateNodeAccessGroupResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateNodeAccessGroup">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates a nodes property values by specifying list of name/value types.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
NameValueListType propNameValueList: Name/Value Pair list field for property definition name and value for the node property value.
+Operation Definition
<operation name="updateNodePropValues">
<input message="updateNodePropValues"/>
<output message="updateNodePropValuesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateNodePropValues">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates a nodes property values given a list of proptype object.

Input Parameters:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
PropListType propList: A list of property values to update for the node.
+Operation Definition
<operation name="updateNodeProps">
<input message="updateNodeProps"/>
<output message="updateNodePropsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateNodeProps">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updats an existing property category.

Input Parameters:

PropCategoryType propertyCategory: Property category field.
+Operation Definition
<operation name="updatePropCategory">
<input message="updatePropCategory"/>
<output message="updatePropCategoryResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updatePropCategory">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing property definition.

Input Parameters:

PropDefType propDef: The property definition field.
+Operation Definition
<operation name="updatePropDef">
<input message="updatePropDef"/>
<output message="updatePropDefResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updatePropDef">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates a property definitions list values.

Input Parameters:

string propDefName: Property definition name for a list type property definition.
StringListType listValues: List of values to update the property with.
+Operation Definition
<operation name="updatePropDefListValues">
<input message="updatePropDefListValues"/>
<output message="updatePropDefListValuesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updatePropDefListValues">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing query.

Input Parameters:

QueryType query: Query type field.
string renameName: If supplied a new name to give the query criteria.
+Operation Definition
<operation name="updateQuery">
<input message="updateQuery"/>
<output message="updateQueryResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateQuery">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing request definition.

Input Parameters:

RequestType request: The request object field.
+Operation Definition
<operation name="updateRequest">
<input message="updateRequest"/>
<output message="updateRequestResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateRequest">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing user.

Input Parameters:

UserType user: The user object field.
+Operation Definition
<operation name="updateUser">
<input message="updateUser"/>
<output message="updateUserResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateUser">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing users lockout settings.

Input Parameters:

UserType user: The user object field.
+Operation Definition
<operation name="updateUserLockout">
<input message="updateUserLockout"/>
<output message="updateUserLockoutResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateUserLockout">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates a password for a user other than the current user.

Input Parameters:

string userName: The existing user name field.
string oldPassword: The old password field.
string newPassword: The new password field.
+Operation Definition
<operation name="updateUserPassword">
<input message="updateUserPassword"/>
<output message="updateUserPasswordResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateUserPassword">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates an existing validation.

Input Parameters:

ValidationDefinitionType validation: The validation object field.
+Operation Definition
<operation name="updateValidation">
<input message="updateValidation"/>
<output message="updateValidationResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateValidation">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates a versions property values by specifying list of name/value types.

Input Parameters:

string versionName: Version name field.
NameValueListType propValueList: List type of nameValueListType for properties and their values.
+Operation Definition
<operation name="updateVersionPropValues">
<input message="updateVersionPropValues"/>
<output message="updateVersionPropValuesResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateVersionPropValues">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Updates a versions property values by specifying an array of proptype objects.

Input Parameters:

string versionName: Version name field.
PropListType propList: List type of PropListType for properties and their values.
+Operation Definition
<operation name="updateVersionProps">
<input message="updateVersionProps"/>
<output message="updateVersionPropsResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="updateVersionProps">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
Validates an existing request.

Input Parameters:

RequestType request: The request to validate.
boolean saveIfSuccessful: Flag indicating that the request should be saved if the validation was successful.

Output Parameters:

RequestValidationResultType requestValidationResult: The request validation result. Returned when one validates a request.
+Operation Definition
<operation name="validateRequest">
<input message="validateRequest"/>
<output message="validateRequestResponse"/>
<fault message="DrmServiceException" name="DrmServiceException"/>
</operation>
+Binding Operation Definition
<operation name="validateRequest">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="DrmServiceException">
<fault encodingStyle="" name="DrmServiceException" use="literal"/>
</fault>
</operation>
+Message Definition
<message name="DrmServiceException">
<part element="DrmServiceException" name="DrmServiceException"/>
</message>
Referenced By:
Operation: addGlyph
Operation: addHier
Operation: addHierGroup
Operation: addNode
Operation: addNodeAccessGroup
Operation: addNodeType
Operation: addNodeWithProps
Operation: addOrphanNode
Operation: addPropCategory
Operation: addPropDef
Operation: addUser
Operation: addValidation
Operation: addVersion
Operation: annulNode
Operation: approveRequest
Operation: assignControlledProps
Operation: closeVersion
Operation: copyNode
Operation: copyNodeProps
Operation: copyUser
Operation: copyVersion
Operation: createBlender
Operation: createBook
Operation: createCompare
Operation: createExport
Operation: createImport
Operation: createQuery
Operation: createRequest
Operation: deleteBlender
Operation: deleteBook
Operation: deleteCompare
Operation: deleteExport
Operation: deleteGlyph
Operation: deleteHier
Operation: deleteHierGroup
Operation: deleteImport
Operation: deleteNode
Operation: deleteNodeAccessGroup
Operation: deleteNodeType
Operation: deleteNodes
Operation: deleteOrphanNodes
Operation: deletePropCategory
Operation: deletePropDef
Operation: deleteQuery
Operation: deleteRequest
Operation: deleteUser
Operation: deleteValidation
Operation: getAssignedGlobalValidations
Operation: getAssignedHierValidations
Operation: getAssignedNodeValidations
Operation: getAssignedVersionValidations
Operation: getBlender
Operation: getBlenderNames
Operation: getBlenderResults
Operation: getBook
Operation: getBookItemResults
Operation: getBookNames
Operation: getBookResults
Operation: getBookResultsItemCount
Operation: getCompare
Operation: getCompareNames
Operation: getCompareResults
Operation: getControlledPropNames
Operation: getCopyVersionResults
Operation: getCreateVersionAsOfDateResults
Operation: getCreateVersionAsOfTxnIDResults
Operation: getDeleteVersionResults
Operation: getExport
Operation: getExportNames
Operation: getExportResults
Operation: getGlobalNode
Operation: getGlobalNodePropValues
Operation: getGlobalNodeProps
Operation: getGlobalNodeRefCount
Operation: getGlobalNodeReferences
Operation: getGlobalNodes
Operation: getGlobalQueryResults
Operation: getGlyph
Operation: getHier
Operation: getHierGroup
Operation: getHierGroupNames
Operation: getHierNames
Operation: getHierPropValues
Operation: getHierProps
Operation: getHierTopNode
Operation: getHiers
Operation: getImport
Operation: getImportNames
Operation: getImportResults
Operation: getJobStatus
Operation: getLogItems
Operation: getNode
Operation: getNodeAccessGroup
Operation: getNodeAccessGroupNames
Operation: getNodeAccessGroupUserList
Operation: getNodeAccessLevel
Operation: getNodeByID
Operation: getNodePropValues
Operation: getNodeProps
Operation: getNodeTypeNames
Operation: getNodeTypes
Operation: getNodeWithProps
Operation: getNodes
Operation: getOrphanNodes
Operation: getPropCategories
Operation: getPropDef
Operation: getPropDefNames
Operation: getPropDefs
Operation: getPropDefsByCategory
Operation: getQueries
Operation: getQuery
Operation: getQueryNames
Operation: getQueryResults
Operation: getRelatedNodeCount
Operation: getRelatedNodeNames
Operation: getRelatedNodes
Operation: getRelatedNodesWithProps
Operation: getRequestByExternalId
Operation: getRequestById
Operation: getSaveVersionResults
Operation: getScriptFromLog
Operation: getScriptFromModel
Operation: getScriptResults
Operation: getSysPrefValue
Operation: getSysPrefs
Operation: getUser
Operation: getUserNames
Operation: getValidation
Operation: getValidationNames
Operation: getValidations
Operation: getVersion
Operation: getVersionNames
Operation: getVersionPropValues
Operation: getVersionProps
Operation: getVersions
Operation: inactivateNode
Operation: inactivateNodes
Operation: insertNode
Operation: insertNodeWithProps
Operation: insertNodes
Operation: moveNode
Operation: moveNodes
Operation: openVersion
Operation: orderChildren
Operation: queryRequests
Operation: reactivateNode
Operation: reactivateNodes
Operation: removeNode
Operation: removeNodes
Operation: runBlenderByName
Operation: runCompare
Operation: runCompareByName
Operation: runGlobalQuery
Operation: runQuery
Operation: runValidateHier
Operation: runValidateNode
Operation: runValidateVersion
Operation: searchForNodesInHier
Operation: searchForNodesInVersion
Operation: setHierTopNode
Operation: setHierValidations
Operation: setUserPassword
Operation: setVersionValidations
Operation: startBlenderByName
Operation: startBookByName
Operation: startCompare
Operation: startCompareByName
Operation: startCompareExportByName
Operation: startCompareExportByNameOnHier
Operation: startCompareExportByNameOnHierNode
Operation: startCopyVersion
Operation: startCreateAsOfTxnID
Operation: startCreateVersionAsOfDate
Operation: startDeleteVersion
Operation: startExport
Operation: startExportByName
Operation: startGlobalQuery
Operation: startHierExportByName
Operation: startHierExportByNameOnHierNode
Operation: startHierExportByNameOnHierNodes
Operation: startHierExportByNameOnHiers
Operation: startImport
Operation: startImportByName
Operation: startQuery
Operation: startSaveVersion
Operation: startScript
Operation: startScriptFromFile
Operation: updateBlender
Operation: updateBook
Operation: updateCompare
Operation: updateExport
Operation: updateGlyph
Operation: updateHierGroup
Operation: updateHierPropValues
Operation: updateHierProps
Operation: updateImport
Operation: updateNodeAccessGroup
Operation: updateNodePropValues
Operation: updateNodeProps
Operation: updatePropCategory
Operation: updatePropDef
Operation: updatePropDefListValues
Operation: updateQuery
Operation: updateRequest
Operation: updateUser
Operation: updateUserLockout
Operation: updateUserPassword
Operation: updateValidation
Operation: updateVersionPropValues
Operation: updateVersionProps
Operation: validateRequest
+Message Definition
<message name="addGlyph">
<part element="addGlyph" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addGlyphResponse">
<part element="addGlyphResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addHier">
<part element="addHier" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addHierGroup">
<part element="addHierGroup" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addHierGroupResponse">
<part element="addHierGroupResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addHierResponse">
<part element="addHierResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addNode">
<part element="addNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addNodeAccessGroup">
<part element="addNodeAccessGroup" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addNodeAccessGroupResponse">
<part element="addNodeAccessGroupResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addNodeResponse">
<part element="addNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addNodeType">
<part element="addNodeType" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addNodeTypeResponse">
<part element="addNodeTypeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addNodeWithProps">
<part element="addNodeWithProps" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addNodeWithPropsResponse">
<part element="addNodeWithPropsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addOrphanNode">
<part element="addOrphanNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addOrphanNodeResponse">
<part element="addOrphanNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addPropCategory">
<part element="addPropCategory" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addPropCategoryResponse">
<part element="addPropCategoryResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addPropDef">
<part element="addPropDef" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addPropDefResponse">
<part element="addPropDefResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addUser">
<part element="addUser" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addUserResponse">
<part element="addUserResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addValidation">
<part element="addValidation" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addValidationResponse">
<part element="addValidationResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addVersion">
<part element="addVersion" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="addVersionResponse">
<part element="addVersionResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="annulNode">
<part element="annulNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="annulNodeResponse">
<part element="annulNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="approveRequest">
<part element="approveRequest" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="approveRequestResponse">
<part element="approveRequestResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="assignControlledProps">
<part element="assignControlledProps" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="assignControlledPropsResponse">
<part element="assignControlledPropsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="closeVersion">
<part element="closeVersion" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="closeVersionResponse">
<part element="closeVersionResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="copyNode">
<part element="copyNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="copyNodeProps">
<part element="copyNodeProps" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="copyNodePropsResponse">
<part element="copyNodePropsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="copyNodeResponse">
<part element="copyNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="copyUser">
<part element="copyUser" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="copyUserResponse">
<part element="copyUserResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="copyVersion">
<part element="copyVersion" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="copyVersionResponse">
<part element="copyVersionResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createBlender">
<part element="createBlender" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createBlenderResponse">
<part element="createBlenderResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createBook">
<part element="createBook" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createBookResponse">
<part element="createBookResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createCompare">
<part element="createCompare" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createCompareResponse">
<part element="createCompareResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createExport">
<part element="createExport" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createExportResponse">
<part element="createExportResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createImport">
<part element="createImport" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createImportResponse">
<part element="createImportResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createQuery">
<part element="createQuery" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createQueryResponse">
<part element="createQueryResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createRequest">
<part element="createRequest" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createRequestResponse">
<part element="createRequestResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteBlender">
<part element="deleteBlender" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteBlenderResponse">
<part element="deleteBlenderResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteBook">
<part element="deleteBook" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteBookResponse">
<part element="deleteBookResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteCompare">
<part element="deleteCompare" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteCompareResponse">
<part element="deleteCompareResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteExport">
<part element="deleteExport" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteExportResponse">
<part element="deleteExportResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteGlyph">
<part element="deleteGlyph" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteGlyphResponse">
<part element="deleteGlyphResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteHier">
<part element="deleteHier" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteHierGroup">
<part element="deleteHierGroup" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteHierGroupResponse">
<part element="deleteHierGroupResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteHierResponse">
<part element="deleteHierResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteImport">
<part element="deleteImport" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteImportResponse">
<part element="deleteImportResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteNode">
<part element="deleteNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteNodeAccessGroup">
<part element="deleteNodeAccessGroup" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteNodeAccessGroupResponse">
<part element="deleteNodeAccessGroupResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteNodeResponse">
<part element="deleteNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteNodeType">
<part element="deleteNodeType" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteNodeTypeResponse">
<part element="deleteNodeTypeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteNodes">
<part element="deleteNodes" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteNodesResponse">
<part element="deleteNodesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteOrphanNodes">
<part element="deleteOrphanNodes" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteOrphanNodesResponse">
<part element="deleteOrphanNodesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deletePropCategory">
<part element="deletePropCategory" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deletePropCategoryResponse">
<part element="deletePropCategoryResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deletePropDef">
<part element="deletePropDef" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deletePropDefResponse">
<part element="deletePropDefResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteQuery">
<part element="deleteQuery" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteQueryResponse">
<part element="deleteQueryResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteRequest">
<part element="deleteRequest" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteRequestResponse">
<part element="deleteRequestResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteUser">
<part element="deleteUser" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteUserResponse">
<part element="deleteUserResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteValidation">
<part element="deleteValidation" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteValidationResponse">
<part element="deleteValidationResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getAssignedGlobalValidations">
<part element="getAssignedGlobalValidations" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getAssignedGlobalValidationsResponse">
<part element="getAssignedGlobalValidationsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getAssignedHierValidations">
<part element="getAssignedHierValidations" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getAssignedHierValidationsResponse">
<part element="getAssignedHierValidationsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getAssignedNodeValidations">
<part element="getAssignedNodeValidations" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getAssignedNodeValidationsResponse">
<part element="getAssignedNodeValidationsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getAssignedVersionValidations">
<part element="getAssignedVersionValidations" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getAssignedVersionValidationsResponse">
<part element="getAssignedVersionValidationsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBlender">
<part element="getBlender" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBlenderNames">
<part element="getBlenderNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBlenderNamesResponse">
<part element="getBlenderNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBlenderResponse">
<part element="getBlenderResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBlenderResults">
<part element="getBlenderResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBlenderResultsResponse">
<part element="getBlenderResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBook">
<part element="getBook" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBookItemResults">
<part element="getBookItemResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBookItemResultsResponse">
<part element="getBookItemResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBookNames">
<part element="getBookNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBookNamesResponse">
<part element="getBookNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBookResponse">
<part element="getBookResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBookResults">
<part element="getBookResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBookResultsItemCount">
<part element="getBookResultsItemCount" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBookResultsItemCountResponse">
<part element="getBookResultsItemCountResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getBookResultsResponse">
<part element="getBookResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getCompare">
<part element="getCompare" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getCompareNames">
<part element="getCompareNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getCompareNamesResponse">
<part element="getCompareNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getCompareResponse">
<part element="getCompareResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getCompareResults">
<part element="getCompareResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getCompareResultsResponse">
<part element="getCompareResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getControlledPropNames">
<part element="getControlledPropNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getControlledPropNamesResponse">
<part element="getControlledPropNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getCopyVersionResults">
<part element="getCopyVersionResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getCopyVersionResultsResponse">
<part element="getCopyVersionResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getCreateVersionAsOfDateResults">
<part element="getCreateVersionAsOfDateResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getCreateVersionAsOfDateResultsResponse">
<part element="getCreateVersionAsOfDateResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getCreateVersionAsOfTxnIDResults">
<part element="getCreateVersionAsOfTxnIDResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getCreateVersionAsOfTxnIDResultsResponse">
<part element="getCreateVersionAsOfTxnIDResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getDeleteVersionResults">
<part element="getDeleteVersionResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getDeleteVersionResultsResponse">
<part element="getDeleteVersionResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getExport">
<part element="getExport" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getExportNames">
<part element="getExportNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getExportNamesResponse">
<part element="getExportNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getExportResponse">
<part element="getExportResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getExportResults">
<part element="getExportResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getExportResultsResponse">
<part element="getExportResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalNode">
<part element="getGlobalNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalNodePropValues">
<part element="getGlobalNodePropValues" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalNodePropValuesResponse">
<part element="getGlobalNodePropValuesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalNodeProps">
<part element="getGlobalNodeProps" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalNodePropsResponse">
<part element="getGlobalNodePropsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalNodeRefCount">
<part element="getGlobalNodeRefCount" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalNodeRefCountResponse">
<part element="getGlobalNodeRefCountResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalNodeReferences">
<part element="getGlobalNodeReferences" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalNodeReferencesResponse">
<part element="getGlobalNodeReferencesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalNodeResponse">
<part element="getGlobalNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalNodes">
<part element="getGlobalNodes" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalNodesResponse">
<part element="getGlobalNodesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalQueryResults">
<part element="getGlobalQueryResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlobalQueryResultsResponse">
<part element="getGlobalQueryResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlyph">
<part element="getGlyph" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getGlyphResponse">
<part element="getGlyphResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHier">
<part element="getHier" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHierGroup">
<part element="getHierGroup" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHierGroupNames">
<part element="getHierGroupNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHierGroupNamesResponse">
<part element="getHierGroupNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHierGroupResponse">
<part element="getHierGroupResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHierNames">
<part element="getHierNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHierNamesResponse">
<part element="getHierNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHierPropValues">
<part element="getHierPropValues" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHierPropValuesResponse">
<part element="getHierPropValuesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHierProps">
<part element="getHierProps" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHierPropsResponse">
<part element="getHierPropsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHierResponse">
<part element="getHierResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHierTopNode">
<part element="getHierTopNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHierTopNodeResponse">
<part element="getHierTopNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHiers">
<part element="getHiers" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getHiersResponse">
<part element="getHiersResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getImport">
<part element="getImport" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getImportNames">
<part element="getImportNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getImportNamesResponse">
<part element="getImportNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getImportResponse">
<part element="getImportResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getImportResults">
<part element="getImportResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getImportResultsResponse">
<part element="getImportResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getJobStatus">
<part element="getJobStatus" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getJobStatusResponse">
<part element="getJobStatusResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getLogItems">
<part element="getLogItems" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getLogItemsResponse">
<part element="getLogItemsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNode">
<part element="getNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeAccessGroup">
<part element="getNodeAccessGroup" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeAccessGroupNames">
<part element="getNodeAccessGroupNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeAccessGroupNamesResponse">
<part element="getNodeAccessGroupNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeAccessGroupResponse">
<part element="getNodeAccessGroupResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeAccessGroupUserList">
<part element="getNodeAccessGroupUserList" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeAccessGroupUserListResponse">
<part element="getNodeAccessGroupUserListResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeAccessLevel">
<part element="getNodeAccessLevel" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeAccessLevelResponse">
<part element="getNodeAccessLevelResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeByID">
<part element="getNodeByID" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeByIDResponse">
<part element="getNodeByIDResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodePropValues">
<part element="getNodePropValues" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodePropValuesResponse">
<part element="getNodePropValuesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeProps">
<part element="getNodeProps" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodePropsResponse">
<part element="getNodePropsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeResponse">
<part element="getNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeTypeNames">
<part element="getNodeTypeNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeTypeNamesResponse">
<part element="getNodeTypeNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeTypes">
<part element="getNodeTypes" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeTypesResponse">
<part element="getNodeTypesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeWithProps">
<part element="getNodeWithProps" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeWithPropsResponse">
<part element="getNodeWithPropsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodes">
<part element="getNodes" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodesResponse">
<part element="getNodesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getOrphanNodes">
<part element="getOrphanNodes" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getOrphanNodesResponse">
<part element="getOrphanNodesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getPropCategories">
<part element="getPropCategories" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getPropCategoriesResponse">
<part element="getPropCategoriesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getPropDef">
<part element="getPropDef" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getPropDefNames">
<part element="getPropDefNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getPropDefNamesResponse">
<part element="getPropDefNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getPropDefResponse">
<part element="getPropDefResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getPropDefs">
<part element="getPropDefs" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getPropDefsByCategory">
<part element="getPropDefsByCategory" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getPropDefsByCategoryResponse">
<part element="getPropDefsByCategoryResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getPropDefsResponse">
<part element="getPropDefsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getQueries">
<part element="getQueries" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getQueriesResponse">
<part element="getQueriesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getQuery">
<part element="getQuery" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getQueryNames">
<part element="getQueryNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getQueryNamesResponse">
<part element="getQueryNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getQueryResponse">
<part element="getQueryResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getQueryResults">
<part element="getQueryResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getQueryResultsResponse">
<part element="getQueryResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getRelatedNodeCount">
<part element="getRelatedNodeCount" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getRelatedNodeCountResponse">
<part element="getRelatedNodeCountResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getRelatedNodeNames">
<part element="getRelatedNodeNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getRelatedNodeNamesResponse">
<part element="getRelatedNodeNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getRelatedNodes">
<part element="getRelatedNodes" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getRelatedNodesResponse">
<part element="getRelatedNodesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getRelatedNodesWithProps">
<part element="getRelatedNodesWithProps" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getRelatedNodesWithPropsResponse">
<part element="getRelatedNodesWithPropsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getRequestByExternalId">
<part element="getRequestByExternalId" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getRequestByExternalIdResponse">
<part element="getRequestByExternalIdResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getRequestById">
<part element="getRequestById" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getRequestByIdResponse">
<part element="getRequestByIdResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getSaveVersionResults">
<part element="getSaveVersionResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getSaveVersionResultsResponse">
<part element="getSaveVersionResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getScriptFromLog">
<part element="getScriptFromLog" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getScriptFromLogResponse">
<part element="getScriptFromLogResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getScriptFromModel">
<part element="getScriptFromModel" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getScriptFromModelResponse">
<part element="getScriptFromModelResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getScriptResults">
<part element="getScriptResults" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getScriptResultsResponse">
<part element="getScriptResultsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getSysPrefValue">
<part element="getSysPrefValue" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getSysPrefValueResponse">
<part element="getSysPrefValueResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getSysPrefs">
<part element="getSysPrefs" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getSysPrefsResponse">
<part element="getSysPrefsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getUser">
<part element="getUser" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getUserNames">
<part element="getUserNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getUserNamesResponse">
<part element="getUserNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getUserResponse">
<part element="getUserResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getValidation">
<part element="getValidation" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getValidationNames">
<part element="getValidationNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getValidationNamesResponse">
<part element="getValidationNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getValidationResponse">
<part element="getValidationResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getValidations">
<part element="getValidations" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getValidationsResponse">
<part element="getValidationsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getVersion">
<part element="getVersion" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getVersionNames">
<part element="getVersionNames" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getVersionNamesResponse">
<part element="getVersionNamesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getVersionPropValues">
<part element="getVersionPropValues" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getVersionPropValuesResponse">
<part element="getVersionPropValuesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getVersionProps">
<part element="getVersionProps" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getVersionPropsResponse">
<part element="getVersionPropsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getVersionResponse">
<part element="getVersionResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getVersions">
<part element="getVersions" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getVersionsResponse">
<part element="getVersionsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="inactivateNode">
<part element="inactivateNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="inactivateNodeResponse">
<part element="inactivateNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="inactivateNodes">
<part element="inactivateNodes" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="inactivateNodesResponse">
<part element="inactivateNodesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="insertNode">
<part element="insertNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="insertNodeResponse">
<part element="insertNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="insertNodeWithProps">
<part element="insertNodeWithProps" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="insertNodeWithPropsResponse">
<part element="insertNodeWithPropsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="insertNodes">
<part element="insertNodes" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="insertNodesResponse">
<part element="insertNodesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="moveNode">
<part element="moveNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="moveNodeResponse">
<part element="moveNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="moveNodes">
<part element="moveNodes" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="moveNodesResponse">
<part element="moveNodesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="openVersion">
<part element="openVersion" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="openVersionResponse">
<part element="openVersionResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="orderChildren">
<part element="orderChildren" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="orderChildrenResponse">
<part element="orderChildrenResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="queryRequests">
<part element="queryRequests" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="queryRequestsResponse">
<part element="queryRequestsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="reactivateNode">
<part element="reactivateNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="reactivateNodeResponse">
<part element="reactivateNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="reactivateNodes">
<part element="reactivateNodes" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="reactivateNodesResponse">
<part element="reactivateNodesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="removeNode">
<part element="removeNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="removeNodeResponse">
<part element="removeNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="removeNodes">
<part element="removeNodes" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="removeNodesResponse">
<part element="removeNodesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runBlenderByName">
<part element="runBlenderByName" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runBlenderByNameResponse">
<part element="runBlenderByNameResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runCompare">
<part element="runCompare" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runCompareByName">
<part element="runCompareByName" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runCompareByNameResponse">
<part element="runCompareByNameResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runCompareResponse">
<part element="runCompareResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runGlobalQuery">
<part element="runGlobalQuery" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runGlobalQueryResponse">
<part element="runGlobalQueryResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runQuery">
<part element="runQuery" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runQueryResponse">
<part element="runQueryResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runValidateHier">
<part element="runValidateHier" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runValidateHierResponse">
<part element="runValidateHierResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runValidateNode">
<part element="runValidateNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runValidateNodeResponse">
<part element="runValidateNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runValidateVersion">
<part element="runValidateVersion" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="runValidateVersionResponse">
<part element="runValidateVersionResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="searchForNodesInHier">
<part element="searchForNodesInHier" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="searchForNodesInHierResponse">
<part element="searchForNodesInHierResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="searchForNodesInVersion">
<part element="searchForNodesInVersion" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="searchForNodesInVersionResponse">
<part element="searchForNodesInVersionResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="setHierTopNode">
<part element="setHierTopNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="setHierTopNodeResponse">
<part element="setHierTopNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="setHierValidations">
<part element="setHierValidations" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="setHierValidationsResponse">
<part element="setHierValidationsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="setUserPassword">
<part element="setUserPassword" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="setUserPasswordResponse">
<part element="setUserPasswordResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="setVersionValidations">
<part element="setVersionValidations" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="setVersionValidationsResponse">
<part element="setVersionValidationsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startBlenderByName">
<part element="startBlenderByName" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startBlenderByNameResponse">
<part element="startBlenderByNameResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startBookByName">
<part element="startBookByName" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startBookByNameResponse">
<part element="startBookByNameResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCompare">
<part element="startCompare" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCompareByName">
<part element="startCompareByName" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCompareByNameResponse">
<part element="startCompareByNameResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCompareExportByName">
<part element="startCompareExportByName" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCompareExportByNameOnHier">
<part element="startCompareExportByNameOnHier" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCompareExportByNameOnHierNode">
<part element="startCompareExportByNameOnHierNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCompareExportByNameOnHierNodeResponse">
<part element="startCompareExportByNameOnHierNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCompareExportByNameOnHierResponse">
<part element="startCompareExportByNameOnHierResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCompareExportByNameResponse">
<part element="startCompareExportByNameResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCompareResponse">
<part element="startCompareResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCopyVersion">
<part element="startCopyVersion" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCopyVersionResponse">
<part element="startCopyVersionResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCreateAsOfTxnID">
<part element="startCreateAsOfTxnID" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCreateAsOfTxnIDResponse">
<part element="startCreateAsOfTxnIDResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCreateVersionAsOfDate">
<part element="startCreateVersionAsOfDate" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startCreateVersionAsOfDateResponse">
<part element="startCreateVersionAsOfDateResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startDeleteVersion">
<part element="startDeleteVersion" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startDeleteVersionResponse">
<part element="startDeleteVersionResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startExport">
<part element="startExport" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startExportByName">
<part element="startExportByName" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startExportByNameResponse">
<part element="startExportByNameResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startExportResponse">
<part element="startExportResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startGlobalQuery">
<part element="startGlobalQuery" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startGlobalQueryResponse">
<part element="startGlobalQueryResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startHierExportByName">
<part element="startHierExportByName" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startHierExportByNameOnHierNode">
<part element="startHierExportByNameOnHierNode" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startHierExportByNameOnHierNodeResponse">
<part element="startHierExportByNameOnHierNodeResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startHierExportByNameOnHierNodes">
<part element="startHierExportByNameOnHierNodes" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startHierExportByNameOnHierNodesResponse">
<part element="startHierExportByNameOnHierNodesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startHierExportByNameOnHiers">
<part element="startHierExportByNameOnHiers" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startHierExportByNameOnHiersResponse">
<part element="startHierExportByNameOnHiersResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startHierExportByNameResponse">
<part element="startHierExportByNameResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startImport">
<part element="startImport" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startImportByName">
<part element="startImportByName" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startImportByNameResponse">
<part element="startImportByNameResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startImportResponse">
<part element="startImportResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startQuery">
<part element="startQuery" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startQueryResponse">
<part element="startQueryResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startSaveVersion">
<part element="startSaveVersion" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startSaveVersionResponse">
<part element="startSaveVersionResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startScript">
<part element="startScript" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startScriptFromFile">
<part element="startScriptFromFile" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startScriptFromFileResponse">
<part element="startScriptFromFileResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="startScriptResponse">
<part element="startScriptResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateBlender">
<part element="updateBlender" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateBlenderResponse">
<part element="updateBlenderResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateBook">
<part element="updateBook" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateBookResponse">
<part element="updateBookResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateCompare">
<part element="updateCompare" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateCompareResponse">
<part element="updateCompareResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateExport">
<part element="updateExport" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateExportResponse">
<part element="updateExportResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateGlyph">
<part element="updateGlyph" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateGlyphResponse">
<part element="updateGlyphResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateHierGroup">
<part element="updateHierGroup" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateHierGroupResponse">
<part element="updateHierGroupResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateHierPropValues">
<part element="updateHierPropValues" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateHierPropValuesResponse">
<part element="updateHierPropValuesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateHierProps">
<part element="updateHierProps" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateHierPropsResponse">
<part element="updateHierPropsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateImport">
<part element="updateImport" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateImportResponse">
<part element="updateImportResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateNodeAccessGroup">
<part element="updateNodeAccessGroup" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateNodeAccessGroupResponse">
<part element="updateNodeAccessGroupResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateNodePropValues">
<part element="updateNodePropValues" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateNodePropValuesResponse">
<part element="updateNodePropValuesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateNodeProps">
<part element="updateNodeProps" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateNodePropsResponse">
<part element="updateNodePropsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updatePropCategory">
<part element="updatePropCategory" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updatePropCategoryResponse">
<part element="updatePropCategoryResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updatePropDef">
<part element="updatePropDef" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updatePropDefListValues">
<part element="updatePropDefListValues" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updatePropDefListValuesResponse">
<part element="updatePropDefListValuesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updatePropDefResponse">
<part element="updatePropDefResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateQuery">
<part element="updateQuery" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateQueryResponse">
<part element="updateQueryResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateRequest">
<part element="updateRequest" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateRequestResponse">
<part element="updateRequestResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateUser">
<part element="updateUser" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateUserLockout">
<part element="updateUserLockout" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateUserLockoutResponse">
<part element="updateUserLockoutResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateUserPassword">
<part element="updateUserPassword" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateUserPasswordResponse">
<part element="updateUserPasswordResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateUserResponse">
<part element="updateUserResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateValidation">
<part element="updateValidation" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateValidationResponse">
<part element="updateValidationResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateVersionPropValues">
<part element="updateVersionPropValues" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateVersionPropValuesResponse">
<part element="updateVersionPropValuesResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateVersionProps">
<part element="updateVersionProps" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="updateVersionPropsResponse">
<part element="updateVersionPropsResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="validateRequest">
<part element="validateRequest" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="validateRequestResponse">
<part element="validateRequestResponse" name="parameters"/>
</message>
Referenced By:
This type is to be passed in the soap header.

Fields:

string serverUrl: API adapter URL of the DRM Server. Example: http://localhost:5240/Oracle/Drm/APIAdapter?wsdl
string sessionParams: Represents session parameters for the DRM server. Example: ProductVersion=11.1.2;CultureName=en-US;TimeZoneOffset=-360
+Element Definition
<element name="AppParameters" type="AppParameters"/>
Exception class for Web Service methods.

Fields:

string Message: Exception message.
int Code: Error code value for the message.
+Element Definition
<element name="DrmServiceException" type="DrmServiceException"/>
Referenced By:
Glyph input parameter.

Fields:

string name: Name of glyph.
string descr: Description of glyph.
string imageData: Base-64 string value of the byte data.
ImageTypeEnum imageTypeEnum: Currently supported image types are PNG.
+Element Definition
<element name="addGlyph" type="AddGlyph"/>
Referenced By:
Add glyph output parameter.
+Element Definition
<element name="addGlyphResponse" nillable="true" type="VoidType"/>
Referenced By:
Add hierarchy parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string descr: Hierarchy description field.
string topNodeName: Top node name field.
string topNodeDescr: Top node description field.
+Element Definition
<element name="addHier" type="AddHier"/>
Referenced By:
Add hierarchy group parameter.

Fields:

string name: Hierarchy group name field.
string descr: Hierarchy group description field.
int order: Sort order field for the hierarchy group.
+Element Definition
<element name="addHierGroup" type="AddHierGroup"/>
Referenced By:
Add hierarchy group output parameter.
+Element Definition
<element name="addHierGroupResponse" nillable="true" type="VoidType"/>
Referenced By:
Add hierarchy output parameter.
+Element Definition
<element name="addHierResponse" nillable="true" type="VoidType"/>
Referenced By:
Add node input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string parentName: Parent node name field.
string nodeName: Node name field.
boolean isLeaf: Field indicating whether node is a leaf node.
NameValueListType propNameValueList: Name/value pair list field for property definition name and value for the node property value.
boolean updateIfExists: If True and the node exists, then update the properties for the node; if the node exists and this flag is False, then skip property updates.
+Element Definition
<element name="addNode" type="AddNode"/>
Referenced By:
Add node access group input parameter.

Fields:

NodeAccessGroupType nodeAccessGroup: Node access group input object.
+Element Definition
<element name="addNodeAccessGroup" type="AddNodeAccessGroup"/>
Referenced By:
Add node access group output parameter.
+Element Definition
<element name="addNodeAccessGroupResponse" nillable="true" type="VoidType"/>
Referenced By:
Add node output parameter.
+Element Definition
<element name="addNodeResponse" nillable="true" type="VoidType"/>
Referenced By:
Add node type input parameter.

Fields:

string name: Name of the node type.
string descr: Description of the node type.
StringListType propNameList: Property definition names to associate with this node type.
StringListType categoryNameList: The property category names to associate with this node type.
StringListType validationList: The validation definition names to associate with this node type.
string glyphName: The glyph name to associate with this node type.
+Element Definition
<element name="addNodeType" type="AddNodeType"/>
Referenced By:
Add node type output parameter.
+Element Definition
<element name="addNodeTypeResponse" nillable="true" type="VoidType"/>
Referenced By:
Add node with properties input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string parentName: Parent node name field.
string nodeName: Node name field.
boolean isLeaf: Field indicating if node is a leaf node.
PropListType propList: The list of properties and their values to set on the node.
boolean updateIfExists: If True and the node exists, then update the properties for the node; if the node exists and this flag is False, then skip property updates.
+Element Definition
<element name="addNodeWithProps" type="AddNodeWithProps"/>
Referenced By:
Add node with properties output parameter.
+Element Definition
<element name="addNodeWithPropsResponse" nillable="true" type="VoidType"/>
Referenced By:
Add Orphan node input parameter.

Fields:

string versionName: Version name field.
string nodeName: Node name field.
boolean isLeaf: Field indicating whether node is a leaf node.
+Element Definition
<element name="addOrphanNode" type="AddOrphanNode"/>
Referenced By:
Add Orphan node output parameter.
+Element Definition
<element name="addOrphanNodeResponse" nillable="true" type="VoidType"/>
Referenced By:
Add property category input parameter.

Fields:

string propCategoryName: Property category name field.
string descr: Property category description field.
PropCategoryTypeEnum propCategoryType: An enumeration value indicating the type of property category.
StringListType propNameList: A list of property definition names to associate with this property category.
boolean availableUserCategory: Flag indicating whether the category should be saved as a user category.
int order: The order in which the property category appears in the property editor.
+Element Definition
<element name="addPropCategory" type="AddPropCategory"/>
Referenced By:
Add property category output parameter.
+Element Definition
<element name="addPropCategoryResponse" nillable="true" type="VoidType"/>
Referenced By:
Add property definition input parameter.

Fields:

PropDefType propDef: A property definition object field.
+Element Definition
<element name="addPropDef" type="AddPropDef"/>
Referenced By:
Add property definition output parameter.
+Element Definition
<element name="addPropDefResponse" nillable="true" type="VoidType"/>
Referenced By:
Add user input parameter.

Fields:

UserInputType userInput: User input object field.
string password: The password to set for this new user.
+Element Definition
<element name="addUser" type="AddUser"/>
Referenced By:
Add user output parameter.
+Element Definition
<element name="addUserResponse" nillable="true" type="VoidType"/>
Referenced By:
Add validation definition input parameter.

Fields:

string name: The validation name field.
string descr: Validation description.
string displayLabel: The label for the validation.
ValidationTypeEnum allowedType: An enumeration indicating how the validation can be executed.
boolean cascade: Flag indicating whether the validation is to be implicitly assigned via inheritance.
int columnWidth: (To be deprecated)
ValidationLevelEnum level: The validation level defines the scope of a business rule.
ValidationParamListType parameters: Parameters that are used by the validation during execution.
boolean setup: Flag that indicates whether the server should check the validity of the parameters.
int sortOrder: The sort order of the property definition within a category.
string validationClass: The type class of validation.
+Element Definition
<element name="addValidation" type="AddValidation"/>
Referenced By:
Add validation definition output parameter.
+Element Definition
<element name="addValidationResponse" nillable="true" type="VoidType"/>
Referenced By:
Add version input parameter.

Fields:

string versionName: Version name field.
string versionDescr: Description field.
boolean dbConnect: Flag that indicates whether the version should be persisted to the data store. If False, the version resides only in memory.
+Element Definition
<element name="addVersion" nillable="true" type="AddVersion"/>
Referenced By:
Add version output parameter.

Fields:

VersionType version: The version object field.
+Element Definition
<element name="addVersionResponse" nillable="true" type="VersionResponseType"/>
Referenced By:
Annul node input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
boolean annulChildNodes: Flag indicating to remove children from the hierarchy and delete children if the child is an orphan.
+Element Definition
<element name="annulNode" type="AnnulNode"/>
Referenced By:
Annul node output parameter.
+Element Definition
<element name="annulNodeResponse" nillable="true" type="VoidType"/>
Referenced By:
Approve request input parameter.

Fields:

int requestId: ID of the request header.
+Element Definition
<element name="approveRequest" type="ApproveRequest"/>
Referenced By:
Approve request output parameter.

Fields:

RequestValidationResultType requestValidationResult: The request validation result. Returned when one validates a request.
+Element Definition
<element name="approveRequestResponse" nillable="true" type="RequestValidationResponseType"/>
Referenced By:
Assign controlled properties input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string propName: Property definition name.
+Element Definition
<element name="assignControlledProps" type="AssignControlledProps"/>
Referenced By:
Assign controlled properties output parameter.
+Element Definition
<element name="assignControlledPropsResponse" nillable="true" type="VoidType"/>
Referenced By:
+Element Definition
<element name="authenticateResponse" nillable="true" type="VoidType"/>
Close version input parameter.

Fields:

string versionName: Version name field.
+Element Definition
<element name="closeVersion" type="CloseVersion"/>
Referenced By:
Close version output parameter.
+Element Definition
<element name="closeVersionResponse" nillable="true" type="VoidType"/>
Referenced By:
Copy node input parameter.

Fields:

string versionName: Version name of the source node.
string hierName: Hierarchy name of the source node.
string nodeName: Node name of the source node.
string targetHierName: Hierarchy name that the node will be copied to.
string targetParentName: Parent node that the new node will be inserted as a child.
+Element Definition
<element name="copyNode" type="CopyNode"/>
Referenced By:
Copy node properties input parameter.

Fields:

NodeLocatorType sourceNodeLocator: Source locator indicating version, hierarchy and node.
NodeLocatorType targetNodeLocator: Target locator indicating version, hierarchy and node.
PropCopyModeEnum propCopyMode: Mode that indicates to the server which type of properties should be copied.
StringListType selectedPropNameList: If copy mode is set to selected; this list will contain the properties to copy.
+Element Definition
<element name="copyNodeProps" type="CopyNodeProps"/>
Referenced By:
Copy node properties output parameter.
+Element Definition
<element name="copyNodePropsResponse" nillable="true" type="VoidType"/>
Referenced By:
Copy node output parameter.
+Element Definition
<element name="copyNodeResponse" nillable="true" type="VoidType"/>
Referenced By:
Copy user input parameter.

Fields:

string existingUserName: User name of the user to copy.
string userName: User name desired for the new user.
+Element Definition
<element name="copyUser" type="CopyUser"/>
Referenced By:
Copy user output parameter.
+Element Definition
<element name="copyUserResponse" nillable="true" type="VoidType"/>
Referenced By:
Copy version input parameter.

Fields:

string sourceVersion: Name of the version to copy.
string targetVersion: Name of the new version.
string targetDescr: Description of the new version.
boolean clearApproval: Flag indicating whether the approval flags should be cleared.
boolean clearChanged: Flag indicating whether the changed on properties should be cleared.
boolean dbConnect: Flag indicating whether the version should be persisted to the data store.
+Element Definition
<element name="copyVersion" type="CopyVersion"/>
Referenced By:
Copy version output parameter.
+Element Definition
<element name="copyVersionResponse" nillable="true" type="VoidType"/>
Referenced By:
Create blender input parameter.

Fields:

BlenderType blender: The input parameter for a blender.
+Element Definition
<element name="createBlender" type="CreateBlender"/>
Referenced By:
Create blender output parameter.
+Element Definition
<element name="createBlenderResponse" nillable="true" type="VoidType"/>
Referenced By:
Create book input parameter.

Fields:

BookType book: The input parameter for a book.
+Element Definition
<element name="createBook" type="CreateBook"/>
Referenced By:
Create book output parameter.
+Element Definition
<element name="createBookResponse" nillable="true" type="VoidType"/>
Referenced By:
Create compare input parameter.

Fields:

CompareType compare: The input parameter for creating a compare.
+Element Definition
<element name="createCompare" type="CreateCompare"/>
Referenced By:
Create compare output parameter.
+Element Definition
<element name="createCompareResponse" nillable="true" type="VoidType"/>
Referenced By:
Create export input parameter.

Fields:

ExportType export: The input parameter for creating an export.
+Element Definition
<element name="createExport" type="CreateExport"/>
Referenced By:
Create export output parameter.
+Element Definition
<element name="createExportResponse" nillable="true" type="VoidType"/>
Referenced By:
Create import input parameter.

Fields:

ImportType importDef: The input parameter for creating an import.
+Element Definition
<element name="createImport" type="CreateImport"/>
Referenced By:
Create import output parameter.
+Element Definition
<element name="createImportResponse" nillable="true" type="VoidType"/>
Referenced By:
Create query input parameter.

Fields:

QueryType query: The input parameter for creating a query.
+Element Definition
<element name="createQuery" type="CreateQuery"/>
Referenced By:
Create query output parameter.
+Element Definition
<element name="createQueryResponse" nillable="true" type="VoidType"/>
Referenced By:
Create request input parameter.

Fields:

RequestType request: The input parameter for creating a request.
+Element Definition
<element name="createRequest" type="CreateRequest"/>
Referenced By:
Create request output parameter.
+Element Definition
<element name="createRequestResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete blender input parameter.

Fields:

string blenderName: Blender name to delete.
ObjectAccessEnum access: Object access of the blender to delete.
+Element Definition
<element name="deleteBlender" type="DeleteBlender"/>
Referenced By:
Delete blender output parameter.
+Element Definition
<element name="deleteBlenderResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete book input parameter.

Fields:

string bookName: Book name to delete.
ObjectAccessEnum access: Object access of the book to delete.
+Element Definition
<element name="deleteBook" type="DeleteBook"/>
Referenced By:
Delete book output parameter.
+Element Definition
<element name="deleteBookResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete compare input parameter.

Fields:

string compareName: Compare name to delete.
ObjectAccessEnum access: Object access of the compare to delete.
+Element Definition
<element name="deleteCompare" type="DeleteCompare"/>
Referenced By:
Delete compare output parameter.
+Element Definition
<element name="deleteCompareResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete export input parameter.

Fields:

string exportName: Export name to delete.
ObjectAccessEnum access: Object access of the export to delete.
+Element Definition
<element name="deleteExport" type="DeleteExport"/>
Referenced By:
Delete export output parameter.
+Element Definition
<element name="deleteExportResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete glyph input parameter.

Fields:

string glyphName: Glyph name to delete.
+Element Definition
<element name="deleteGlyph" type="DeleteGlyph"/>
Referenced By:
Delete glyph output parameter.
+Element Definition
<element name="deleteGlyphResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete hierarchy input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
+Element Definition
<element name="deleteHier" type="DeleteHier"/>
Referenced By:
Delete hierarchy group input parameter.

Fields:

string groupName: Name of the hierarchy group to delete.
+Element Definition
<element name="deleteHierGroup" type="DeleteHierGroup"/>
Referenced By:
Delete hierarchy group output parameter.
+Element Definition
<element name="deleteHierGroupResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete hierarchy output parameter.
+Element Definition
<element name="deleteHierResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete import input parameter.

Fields:

string importName: Name of the import to delete.
ObjectAccessEnum access: Object access of the import to delete.
+Element Definition
<element name="deleteImport" type="DeleteImport"/>
Referenced By:
Delete import output parameter.
+Element Definition
<element name="deleteImportResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete node input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string mergeNodeName: Name of a node to merge with (if merging is desired and enabled).
boolean destroyNode: Flag indicating that the node should be permanently deleted if the node becomes an orphan after merging.
+Element Definition
<element name="deleteNode" type="DeleteNode"/>
Referenced By:
Delete node access group input parameter.

Fields:

string nodeAccessGroupName: Name of the node access group to delete.
+Element Definition
<element name="deleteNodeAccessGroup" type="DeleteNodeAccessGroup"/>
Referenced By:
Delete node access group output parameter.
+Element Definition
<element name="deleteNodeAccessGroupResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete node output parameter.
+Element Definition
<element name="deleteNodeResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete node type input parameter.

Fields:

string nodeTypeName: Name of the node type to delete.
+Element Definition
<element name="deleteNodeType" type="DeleteNodeType"/>
Referenced By:
Delete node type output parameter.
+Element Definition
<element name="deleteNodeTypeResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete nodes input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of nodes to delete.
StringListType mergeNodeNameList: Name of the nodes to merge with (if merging is desired and enabled).
boolean destroyNodes: Flag indicating that the nodes should be permanently deleted if the nodes become orphans after merging.
+Element Definition
<element name="deleteNodes" type="DeleteNodes"/>
Referenced By:
Delete nodes output parameter.
+Element Definition
<element name="deleteNodesResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete Orphan nodes input parameter.

Fields:

string versionName: Version name field.
StringListType nodeNames: List of orphan nodes to permanently delete.
StringListType mergeNodes: Name of the nodes to merge with (if merging is desired and enabled).
+Element Definition
<element name="deleteOrphanNodes" type="DeleteOrphanNodes"/>
Referenced By:
Delete Orphan nodes output parameter.
+Element Definition
<element name="deleteOrphanNodesResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete property category input parameter.

Fields:

string propCategoryName: Name of the property category to delete.
+Element Definition
<element name="deletePropCategory" type="DeletePropCategory"/>
Referenced By:
Delete property category output parameter.
+Element Definition
<element name="deletePropCategoryResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete property input parameter.

Fields:

string propDefName: Name of the property definition to delete.
+Element Definition
<element name="deletePropDef" type="DeletePropDef"/>
Referenced By:
Delete property output parameter.
+Element Definition
<element name="deletePropDefResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete query input parameter.

Fields:

string queryName: Name of the query to delete.
ObjectAccessEnum objectAccess: Object access of the query to delete.
+Element Definition
<element name="deleteQuery" type="DeleteQuery"/>
Referenced By:
Delete query output parameter.
+Element Definition
<element name="deleteQueryResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete request input parameter.

Fields:

int requestId: ID of the request to delete.
+Element Definition
<element name="deleteRequest" type="DeleteRequest"/>
Referenced By:
Delete request output parameter.
+Element Definition
<element name="deleteRequestResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete user input parameter.

Fields:

string userName: User name of the user to delete.
+Element Definition
<element name="deleteUser" type="DeleteUser"/>
Referenced By:
Delete user output parameter.
+Element Definition
<element name="deleteUserResponse" nillable="true" type="VoidType"/>
Referenced By:
Delete validation input parameter.

Fields:

string validationName: Name of the validation to delete.
+Element Definition
<element name="deleteValidation" type="DeleteValidation"/>
Referenced By:
Delete validation output parameter.
+Element Definition
<element name="deleteValidationResponse" nillable="true" type="VoidType"/>
Referenced By:
Get assigned global validations input parameter.

Fields:

string versionName: Version name field.
+Element Definition
<element name="getAssignedGlobalValidations" type="GetAssignedGlobalValidations"/>
Referenced By:
Get assigned global validation output parameter.

Fields:

ValidationListType validations: The assigned global node validations.
+Element Definition
<element name="getAssignedGlobalValidationsResponse" type="GetAssignedGlobalValidationsResponse"/>
Referenced By:
Get assigned hierarchy validations input parameter.

Fields:

HierLocatorType hierLocator: Hierarchy locator object to identify a hierarchy within a version.
+Element Definition
<element name="getAssignedHierValidations" type="GetAssignedHierValidations"/>
Referenced By:
Get assigned hierarchy validations output parameter.

Fields:

ValidationListType validations: Assigned hierarchy validations.
+Element Definition
<element name="getAssignedHierValidationsResponse" type="GetAssignedHierValidationsResponse"/>
Referenced By:
Get assigned node validations input parameter.

Fields:

NodeLocatorType nodeLocator: Node locator object representing a node within a hierarchy.
+Element Definition
<element name="getAssignedNodeValidations" type="GetAssignedNodeValidations"/>
Referenced By:
Get assigned node validation output parameter.

Fields:

ValidationListType validations: Assigned node validations.
+Element Definition
<element name="getAssignedNodeValidationsResponse" type="GetAssignedNodeValidationsResponse"/>
Referenced By:
Get assigned version validations input parameter.

Fields:

string versionName: Version name field.
+Element Definition
<element name="getAssignedVersionValidations" type="GetAssignedVersionValidations"/>
Referenced By:
Get assigned version validations output parameter.

Fields:

ValidationListType validations: Assigned version validations.
+Element Definition
<element name="getAssignedVersionValidationsResponse" type="GetAssignedVersionValidationsResponse"/>
Referenced By:
Get blender input parameter.

Fields:

string blenderName: Blender name.
ObjectAccessEnum access: Object access of the blender.
+Element Definition
<element name="getBlender" type="GetBlender"/>
Referenced By:
Get blender names input parameter.
+Element Definition
<element name="getBlenderNames" nillable="true" type="VoidType"/>
Referenced By:
Get blender names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getBlenderNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get blender output parameter.

Fields:

BlenderType blender: Blender object.
+Element Definition
<element name="getBlenderResponse" nillable="true" type="BlenderResponseType"/>
Referenced By:
Get blender results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getBlenderResults" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get blender results output parameter.

Fields:

BlenderResultsType blenderResult: Blender results object.
+Element Definition
<element name="getBlenderResultsResponse" nillable="true" type="BlenderResultsResponseType"/>
Referenced By:
Get book input parameter.

Fields:

string bookName: Book name.
ObjectAccessEnum access: Object access of the book.
+Element Definition
<element name="getBook" type="GetBook"/>
Referenced By:
Get book item input parameter.

Fields:

BookItemResults bookResults: Asynchronous job results of a book run.
+Element Definition
<element name="getBookItemResults" type="GetBookItemResults"/>
Referenced By:
Get book item output parameter.

Fields:

base64Binary content: Byte array of compressed bytes. Use the deflate algorithm to decompress the content.
+Element Definition
<element name="getBookItemResultsResponse" nillable="true" type="Base64BinaryResponseType"/>
Referenced By:
Get book names input parameter.
+Element Definition
<element name="getBookNames" nillable="true" type="VoidType"/>
Referenced By:
Get book names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getBookNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get book input parameter.

Fields:

BookType book: Represents the response for a book type.
+Element Definition
<element name="getBookResponse" nillable="true" type="BookResponseType"/>
Referenced By:
Get book results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getBookResults" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get book results item count input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getBookResultsItemCount" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get book results item count output parameter.

Fields:

int intVal: Primitive int value.
+Element Definition
<element name="getBookResultsItemCountResponse" nillable="true" type="IntResponseType"/>
Referenced By:
Get book results output parameter.

Fields:

base64Binary content: Byte array of compressed bytes. Use the deflate algorithm to decompress the content.
+Element Definition
<element name="getBookResultsResponse" nillable="true" type="Base64BinaryResponseType"/>
Referenced By:
Get compare input parameter.

Fields:

string compareName: Compare name.
ObjectAccessEnum access: Object access of the compare.
+Element Definition
<element name="getCompare" type="GetCompare"/>
Referenced By:
Get compare names input parameter.
+Element Definition
<element name="getCompareNames" nillable="true" type="VoidType"/>
Referenced By:
Get compare names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getCompareNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get compare output parameter.

Fields:

CompareType compare: The compare object.
+Element Definition
<element name="getCompareResponse" nillable="true" type="CompareResponseType"/>
Referenced By:
Get compare results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getCompareResults" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get compare results output parameter.

Fields:

CompareResultType compareResult: Results of a compare operation.
+Element Definition
<element name="getCompareResultsResponse" nillable="true" type="CompareResultResponseType"/>
Referenced By:
Get controlled property names input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
+Element Definition
<element name="getControlledPropNames" type="GetControlledPropNames"/>
Referenced By:
Get controlled property names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getControlledPropNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get copy version results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getCopyVersionResults" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get copy version results output parameter.

Fields:

JobInfoType jobStatus: JobInfoType type.
+Element Definition
<element name="getCopyVersionResultsResponse" nillable="true" type="JobStatusResponseType"/>
Referenced By:
Get Create version as of date results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getCreateVersionAsOfDateResults" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get create version as of date results output parameter.

Fields:

AsOfVersionResultType asOfVersion: AsOfVersionResultType field.
+Element Definition
<element name="getCreateVersionAsOfDateResultsResponse" nillable="true" type="AsOfVersionResultResponseType"/>
Referenced By:
Get create version as of txn ID results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getCreateVersionAsOfTxnIDResults" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get Create version as of txn ID results output parameter.

Fields:

AsOfVersionResultType asOfVersion: AsOfVersionResultType field.
+Element Definition
<element name="getCreateVersionAsOfTxnIDResultsResponse" nillable="true" type="AsOfVersionResultResponseType"/>
Referenced By:
Get delete version results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getDeleteVersionResults" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get delete version results output parameter.

Fields:

JobInfoType jobStatus: JobInfoType type.
+Element Definition
<element name="getDeleteVersionResultsResponse" nillable="true" type="JobStatusResponseType"/>
Referenced By:
Get export input parameter.

Fields:

string exportName: Export name.
ObjectAccessEnum access: Object access of the export.
+Element Definition
<element name="getExport" type="GetExport"/>
Referenced By:
Get export names input parameter.
+Element Definition
<element name="getExportNames" nillable="true" type="VoidType"/>
Referenced By:
Get export names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getExportNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get export output parameter.

Fields:

ExportType export: Export object type.
+Element Definition
<element name="getExportResponse" nillable="true" type="ExportResponseType"/>
Referenced By:
Get export results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getExportResults" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get export results output parameter.

Fields:

base64Binary content: Byte array of compressed bytes. Use the deflate algorithm to decompress the content.
+Element Definition
<element name="getExportResultsResponse" nillable="true" type="Base64BinaryResponseType"/>
Referenced By:
Get global node input parameter.

Fields:

string versionName: Version name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: Enumeration indicating how the properties should be returned.
+Element Definition
<element name="getGlobalNode" type="GetGlobalNode"/>
Referenced By:
Get global node property values input parameter.

Fields:

string versionName: Version name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum propValueListType: Enumeration indicating how the properties should be returned.
+Element Definition
<element name="getGlobalNodePropValues" type="GetGlobalNodePropValues"/>
Referenced By:
Get global node property values output parameter.

Fields:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.
+Element Definition
<element name="getGlobalNodePropValuesResponse" nillable="true" type="PropValuesResponseType"/>
Referenced By:
Get global node properties input parameter.

Fields:

string versionName: Version name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
+Element Definition
<element name="getGlobalNodeProps" type="GetGlobalNodeProps"/>
Referenced By:
Get global node properties output parameter.

Fields:

PropListType propList: Return list type field of PropListType types.
+Element Definition
<element name="getGlobalNodePropsResponse" nillable="true" type="PropListResponseType"/>
Referenced By:
Get global node reference count input parameter.

Fields:

GlobalNodeLocatorType globalNodeLocator: Global node locator object to identify a global node.
+Element Definition
<element name="getGlobalNodeRefCount" type="GetGlobalNodeRefCount"/>
Referenced By:
Get global node reference count output parameter.

Fields:

int intVal: Primitive int value.
+Element Definition
<element name="getGlobalNodeRefCountResponse" nillable="true" type="IntResponseType"/>
Referenced By:
Get global node references input parameter.

Fields:

GlobalNodeLocatorType globalNodeLocator: Global node locator object to identify a global node.
+Element Definition
<element name="getGlobalNodeReferences" type="GetGlobalNodeReferences"/>
Referenced By:
Get global node references output parameter.

Fields:

GlobalNodeRefsResponseType references: List of hierarchies in which the node exists (including current).
+Element Definition
<element name="getGlobalNodeReferencesResponse" type="GetGlobalNodeReferencesResponse"/>
Referenced By:
Get global node output parameter.

Fields:

GlobalNodeWithPropValuesType globalNode: A response object that represents a global node object and property values.
+Element Definition
<element name="getGlobalNodeResponse" nillable="true" type="GlobalNodeWithPropValuesResponseType"/>
Referenced By:
Get global nodes input parameter.

Fields:

string versionName: Version name field.
StringListType nodeNameList: List of node names to retrieve.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: Enumeration indicating how the properties should be returned.
+Element Definition
<element name="getGlobalNodes" type="GetGlobalNodes"/>
Referenced By:
Get global nodes output parameter.

Fields:

GlobalNodeWithPropValuesListType globalNodeList: An array of global nodes.
+Element Definition
<element name="getGlobalNodesResponse" nillable="true" type="GlobalNodeWithPropValuesListResponseType"/>
Referenced By:
Get global query results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getGlobalQueryResults" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get global query results output parameter.

Fields:

GlobalQueryResultType globalQueryResult: A query results for a global query.
+Element Definition
<element name="getGlobalQueryResultsResponse" nillable="true" type="GlobalQueryResponseType"/>
Referenced By:
Get glyph input parameter.

Fields:

string glyphName: Name of the glyph to return.
+Element Definition
<element name="getGlyph" type="GetGlyph"/>
Referenced By:
Get glyph output parameter.

Fields:

GlyphType glyph: Glyph type object.
+Element Definition
<element name="getGlyphResponse" type="GetGlyphResponse"/>
Referenced By:
Get hierarchy output parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
+Element Definition
<element name="getHier" type="GetHier"/>
Referenced By:
Get hierarchy group input parameter.

Fields:

string name: The hierarchy group name to return.
+Element Definition
<element name="getHierGroup" type="GetHierGroup"/>
Referenced By:
Get hierarchy group names input parameter.
+Element Definition
<element name="getHierGroupNames" nillable="true" type="VoidType"/>
Referenced By:
Get hierarchy group names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getHierGroupNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get hierarchy group output parameter.

Fields:

HierGroup hierGroup: The hierarchy group type object.
+Element Definition
<element name="getHierGroupResponse" nillable="true" type="HierGroupResponseType"/>
Referenced By:
Get hierarchy names input parameter.

Fields:

string versionName: Version name field.
+Element Definition
<element name="getHierNames" type="GetHierNames"/>
Referenced By:
Get hierarchy names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getHierNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get hierarchy property values input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Element Definition
<element name="getHierPropValues" type="GetHierPropValues"/>
Referenced By:
Get hierarchy property values output parameter.

Fields:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.
+Element Definition
<element name="getHierPropValuesResponse" nillable="true" type="PropValuesResponseType"/>
Referenced By:
Get hierarchy properties input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType propNameList: List of properties to return.
+Element Definition
<element name="getHierProps" type="GetHierProps"/>
Referenced By:
Get hierarchy properties output parameter.

Fields:

PropListType propList: Return list type field of PropListType types.
+Element Definition
<element name="getHierPropsResponse" nillable="true" type="PropListResponseType"/>
Referenced By:
Get hierarchy output parameter.

Fields:

HierType hier: The hierarchy object type.
+Element Definition
<element name="getHierResponse" nillable="true" type="HierResponseType"/>
Referenced By:
Get hierarchy top node input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Element Definition
<element name="getHierTopNode" type="GetHierTopNode"/>
Referenced By:
Get hierarchy top node output parameter.

Fields:

NodeWithPropValuesType node: A return type for a node and its property values.
+Element Definition
<element name="getHierTopNodeResponse" nillable="true" type="NodeWithPropValuesResponseType"/>
Referenced By:
Get hierarchies input parameter.

Fields:

string versionName: Version name field.
StringListType hierNameList: List of hierarchies to return.
+Element Definition
<element name="getHiers" type="GetHiers"/>
Referenced By:
Get hierarchies output parameter.

Fields:

HierListType hierList: The hierarchy group list type object.
+Element Definition
<element name="getHiersResponse" nillable="true" type="HierListResponseType"/>
Referenced By:
Get import input parameter.

Fields:

string importName: The import name to return.
ObjectAccessEnum access: The object access of the import.
+Element Definition
<element name="getImport" type="GetImport"/>
Referenced By:
Get import names input parameter.
+Element Definition
<element name="getImportNames" nillable="true" type="VoidType"/>
Referenced By:
Get import names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getImportNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get import output parameter.

Fields:

ImportType importProfile: The import type object.
+Element Definition
<element name="getImportResponse" nillable="true" type="ImportResponseType"/>
Referenced By:
Get import results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getImportResults" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get import results output parameter.

Fields:

ImportResultsType importResults: The results of an import run.
+Element Definition
<element name="getImportResultsResponse" nillable="true" type="ImportResultsResponseType"/>
Referenced By:
Get job status input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getJobStatus" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get job status output parameter.

Fields:

JobInfoType jobStatus: JobInfoType type.
+Element Definition
<element name="getJobStatusResponse" nillable="true" type="JobStatusResponseType"/>
Referenced By:
Get log items input parameter.

Fields:

LogCriteriaType logCriteria: An object representing criteria for transaction history.
+Element Definition
<element name="getLogItems" type="GetLogItems"/>
Referenced By:
Get log items output parameter.

Fields:

LogItemListType logItemList: List of logItemType objects.
+Element Definition
<element name="getLogItemsResponse" nillable="true" type="LogItemListResponseType"/>
Referenced By:
Get node input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Element Definition
<element name="getNode" type="GetNode"/>
Referenced By:
Get node access group input parameter.

Fields:

string nodeAccessGroupName: Node access group name to return.
+Element Definition
<element name="getNodeAccessGroup" type="GetNodeAccessGroup"/>
Referenced By:
Get node access group names input parameter.
+Element Definition
<element name="getNodeAccessGroupNames" nillable="true" type="VoidType"/>
Referenced By:
Get node access group names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getNodeAccessGroupNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get node access group output parameter.

Fields:

NodeAccessGroupType nodeAccessGroup: An object representing a node access group.
+Element Definition
<element name="getNodeAccessGroupResponse" type="GetNodeAccessGroupResponse"/>
Referenced By:
Get node access group user list input parameter.

Fields:

string nodeAccessGroupName: Node access group name.
+Element Definition
<element name="getNodeAccessGroupUserList" type="GetNodeAccessGroupUserList"/>
Referenced By:
Get node access group user list output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getNodeAccessGroupUserListResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get node access level input parameter.

Fields:

NodeLocatorType nodeLocator: Node locator object representing a node within a hierarchy and version.
+Element Definition
<element name="getNodeAccessLevel" type="GetNodeAccessLevel"/>
Referenced By:
Get node access level output parameter.

Fields:

AccessLevelEnum accessLevel: The access level for a node.
+Element Definition
<element name="getNodeAccessLevelResponse" nillable="true" type="NodeAccessLevelResponseType"/>
Referenced By:
Get node by ID input parameter.

Fields:

HierLocatorType hierLocator: A hierarchy locator object representing a hierarchy in a version.
string name: The name of the node to return.
+Element Definition
<element name="getNodeByID" type="GetNodeByID"/>
Referenced By:
Get node By ID output parameter.

Fields:

NodeType node: The node object.
+Element Definition
<element name="getNodeByIDResponse" nillable="true" type="NodeByIdResponseType"/>
Referenced By:
Get node property values input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Element Definition
<element name="getNodePropValues" type="GetNodePropValues"/>
Referenced By:
Get node property values output parameter.

Fields:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.
+Element Definition
<element name="getNodePropValuesResponse" nillable="true" type="PropValuesResponseType"/>
Referenced By:
Get node properties input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
+Element Definition
<element name="getNodeProps" type="GetNodeProps"/>
Referenced By:
Get node properties output parameter.

Fields:

PropListType propList: Return list type field of PropListType types.
+Element Definition
<element name="getNodePropsResponse" nillable="true" type="PropListResponseType"/>
Referenced By:
Get node input parameter.

Fields:

NodeWithPropValuesType node: A return type for a node and its property values.
+Element Definition
<element name="getNodeResponse" nillable="true" type="NodeWithPropValuesResponseType"/>
Referenced By:
Get node type names input parameter.
+Element Definition
<element name="getNodeTypeNames" nillable="true" type="VoidType"/>
Referenced By:
Get node type names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getNodeTypeNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get node types input parameter.
+Element Definition
<element name="getNodeTypes" nillable="true" type="VoidType"/>
Referenced By:
Get node types output parameter.

Fields:

NodeTypeTypeListType nodeTypeList: A return list type for a node type.
+Element Definition
<element name="getNodeTypesResponse" nillable="true" type="NodeTypeTypeListResponseType"/>
Referenced By:
Get node with properties input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
+Element Definition
<element name="getNodeWithProps" type="GetNodeWithProps"/>
Referenced By:
Get node with properties output parameter.

Fields:

NodeWithPropsType nodeWithProps: A return type that includes a node and its property objects.
+Element Definition
<element name="getNodeWithPropsResponse" nillable="true" type="NodeWithPropsResponseType"/>
Referenced By:
Get nodes input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of node names.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Element Definition
<element name="getNodes" type="GetNodes"/>
Referenced By:
Get nodes output parameter.

Fields:

NodeWithPropValuesListType nodeList: A return type for a list of nodes and their property values.
+Element Definition
<element name="getNodesResponse" nillable="true" type="NodeWithPropValuesListResponseType"/>
Referenced By:
Get orphan nodes input parameter.

Fields:

string versionName: Version name field.
StringListType requestedProps: List of properties to return.
int maxNodes: The maximum number of nodes to return in the result.
+Element Definition
<element name="getOrphanNodes" type="GetOrphanNodes"/>
Referenced By:
Get Orphan nodes output parameter.

Fields:

GlobalQueryResponseType queryResults: A global query result.
+Element Definition
<element name="getOrphanNodesResponse" type="GetOrphanNodesResponse"/>
Referenced By:
Get property categories input parameter.
+Element Definition
<element name="getPropCategories" nillable="true" type="VoidType"/>
Referenced By:
Get property categories output parameter.

Fields:

PropCategoryListType propCategoryListType: List type object representing property categories.
+Element Definition
<element name="getPropCategoriesResponse" type="GetPropCategoriesResponse"/>
Referenced By:
Get property definition input parameter.

Fields:

string propDefName: The name of the property definition to retrieve.
+Element Definition
<element name="getPropDef" nillable="true" type="GetPropDef"/>
Referenced By:
Get property definition names input parameter.

Fields:

ObjectScopeEnum propDefLevel: An enumeration indicating the scope of the property definition.
+Element Definition
<element name="getPropDefNames" nillable="true" type="GetPropDefNames"/>
Referenced By:
Get property definition names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getPropDefNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get property definition output parameter.

Fields:

PropDefType propDef: A return type for a property definition.
+Element Definition
<element name="getPropDefResponse" nillable="true" type="PropDefResponseType"/>
Referenced By:
Get property definitions input parameter.

Fields:

ObjectScopeEnum propDefLevel: An enumeration indicating the scope of the property definition.
+Element Definition
<element name="getPropDefs" nillable="true" type="GetPropDefs"/>
Referenced By:
Get property definition by property category input parameter.

Fields:

string categoryName: Property category name.
+Element Definition
<element name="getPropDefsByCategory" type="GetPropDefsByCategory"/>
Referenced By:
Get property definitions by property category output parameter.

Fields:

PropDefListType propDefs: Array of property definition objects.
+Element Definition
<element name="getPropDefsByCategoryResponse" type="GetPropDefsByCategoryResponse"/>
Referenced By:
Get property definitions output parameter.

Fields:

PropDefListType propDefList: Return list type for property definitions.
+Element Definition
<element name="getPropDefsResponse" nillable="true" type="PropDefListResponseType"/>
Referenced By:
Get Queries input parameter.

Fields:

boolean global: Flag indicating if global queries should be returned.
StringListType queryNameList: The list of queries to return.
+Element Definition
<element name="getQueries" type="GetQueries"/>
Referenced By:
Get queries output parameter.

Fields:

QueryListType queryList: Field for a queryListType object.
+Element Definition
<element name="getQueriesResponse" nillable="true" type="QueryListResponseType"/>
Referenced By:
Get query input parameter.

Fields:

string queryName: The name of the query.
ObjectAccessEnum access: The object access of the query.
+Element Definition
<element name="getQuery" type="GetQuery"/>
Referenced By:
Get query names input parameter.
+Element Definition
<element name="getQueryNames" nillable="true" type="VoidType"/>
Referenced By:
Get query names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getQueryNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get query output parameter.

Fields:

QueryType query: A query type object.
+Element Definition
<element name="getQueryResponse" nillable="true" type="QueryResponseType"/>
Referenced By:
Get query results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getQueryResults" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get query results output parameter.

Fields:

QueryResultType queryResult: A list type of queryResultType types.
+Element Definition
<element name="getQueryResultsResponse" nillable="true" type="QueryResultResponseType"/>
Referenced By:
Get related node count input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
RelationshipEnum relationship: An enumeration indicating what types of nodes to return (Children, Descendants, and so on).
boolean visibleOnly: Flag indicating that visible children should only be returned.
boolean includeLeaves: Flag to include leaf nodes.
+Element Definition
<element name="getRelatedNodeCount" type="GetRelatedNodeCount"/>
Referenced By:
Get related node count output parameter.

Fields:

int intVal: Primitive int value.
+Element Definition
<element name="getRelatedNodeCountResponse" nillable="true" type="IntResponseType"/>
Referenced By:
Get related node names input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).
+Element Definition
<element name="getRelatedNodeNames" type="GetRelatedNodeNames"/>
Referenced By:
Get related node names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getRelatedNodeNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get related nodes input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Element Definition
<element name="getRelatedNodes" type="GetRelatedNodes"/>
Referenced By:
Get related nodes output parameter.

Fields:

NodeWithPropValuesListType nodeList: A return type for a list of nodes and their property values.
+Element Definition
<element name="getRelatedNodesResponse" nillable="true" type="NodeWithPropValuesListResponseType"/>
Referenced By:
Get related nodes with properties input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).
StringListType propNameList: List of properties to return.
+Element Definition
<element name="getRelatedNodesWithProps" type="GetRelatedNodesWithProps"/>
Referenced By:
Get related nodes with properties output parameter.

Fields:

NodeWithPropsListType nodeWithPropsList: A return type that includes a list of nodes and their node property objects.
+Element Definition
<element name="getRelatedNodesWithPropsResponse" nillable="true" type="NodeWithPropsListResponseType"/>
Referenced By:
Get request by external ID input parameter.

Fields:

string externalId: The free-form field on a request object.
+Element Definition
<element name="getRequestByExternalId" type="GetRequestByExternalId"/>
Referenced By:
Get request by external ID output parameter.

Fields:

RequestHeaderListType requestHeaderList: List of request headers.
+Element Definition
<element name="getRequestByExternalIdResponse" nillable="true" type="RequestHeaderListResponseType"/>
Referenced By:
Get request by ID input parameter.

Fields:

int requestId: The system-generated ID for a request.
+Element Definition
<element name="getRequestById" type="GetRequestById"/>
Referenced By:
Get request by ID output parameter.

Fields:

RequestType request: The request object.
+Element Definition
<element name="getRequestByIdResponse" nillable="true" type="RequestResponseType"/>
Referenced By:
Get save version results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getSaveVersionResults" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get save version results output parameter.

Fields:

JobInfoType jobStatus: JobInfoType type.
+Element Definition
<element name="getSaveVersionResultsResponse" nillable="true" type="JobStatusResponseType"/>
Referenced By:
Get action script from transaction log input parameter.

Fields:

LogCriteriaType logCriteria: An object representing criteria for transaction history.
+Element Definition
<element name="getScriptFromLog" type="GetScriptFromLog"/>
Referenced By:
Get action script from transaction log output parameter.

Fields:

ActionItemListType getScriptFromLogResponse: List of action item objects.
+Element Definition
<element name="getScriptFromLogResponse" type="GetScriptFromLogResponse"/>
Referenced By:
Get action script from model input parameter.

Fields:

string versionName: Version name field.
string nodeName: Node name field.
string newNodeName: The new node name to create.
string newNodeDescr: The new node description.
StringListType hierNameList: The list of hierarchies the existing node exists in.
PropCopyModeEnum propCopyMode: An enumeration indicating what type of properties should be included.
StringListType propNameList: If the copy mode is selected then this list of properties will be evaluated in the node model operation.
+Element Definition
<element name="getScriptFromModel" type="GetScriptFromModel"/>
Referenced By:
Get action script from model output parameter.

Fields:

ActionItemListType getScriptFromModelResponse: List of action items.
+Element Definition
<element name="getScriptFromModelResponse" type="GetScriptFromModelResponse"/>
Referenced By:
Get action script results input parameter.

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Element Definition
<element name="getScriptResults" nillable="true" type="JobResultRetrievalInputType"/>
Referenced By:
Get action script results output parameter.

Fields:

ActionItemResultListType actionItemList: List of action items.
+Element Definition
<element name="getScriptResultsResponse" nillable="true" type="ActionItemListResponseType"/>
Referenced By:
Get system preference value input parameter.

Fields:

string systemPreferenceName: The name of the system preference to return.
+Element Definition
<element name="getSysPrefValue" type="GetSysPrefValue"/>
Referenced By:
Get system preference value output parameter.

Fields:

StringResponseType result: The result of the GetSysPrefValue operation.
+Element Definition
<element name="getSysPrefValueResponse" type="GetSysPrefValueResponse"/>
Referenced By:
Get system preferences input parameter.
+Element Definition
<element name="getSysPrefs" nillable="true" type="VoidType"/>
Referenced By:
Get system preferences output parameter.

Fields:

SystemPreferenceListType systemPreferences: The list result of system preference values.
+Element Definition
<element name="getSysPrefsResponse" type="GetSysPrefsResponse"/>
Referenced By:
Get user input parameter.

Fields:

string userName: The user name of the user to retrieve.
+Element Definition
<element name="getUser" type="GetUser"/>
Referenced By:
Get user names input parameter.
+Element Definition
<element name="getUserNames" nillable="true" type="VoidType"/>
Referenced By:
Get user names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getUserNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get user input parameter.

Fields:

UserType user: Represents a user object.
+Element Definition
<element name="getUserResponse" type="GetUserResponse"/>
Referenced By:
Get validation input parameter.

Fields:

string validationName: The name of the validation to retrieve.
+Element Definition
<element name="getValidation" type="GetValidation"/>
Referenced By:
Get validation names input parameter.
+Element Definition
<element name="getValidationNames" nillable="true" type="VoidType"/>
Referenced By:
Get validation names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getValidationNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get validation input parameter.

Fields:

ValidationDefinitionType validation: The validation object.
+Element Definition
<element name="getValidationResponse" type="GetValidationResponse"/>
Referenced By:
Get validations input parameter.
+Element Definition
<element name="getValidations" nillable="true" type="VoidType"/>
Referenced By:
Get validations output parameter.

Fields:

ValidationListType validations: An array of validation objects.
+Element Definition
<element name="getValidationsResponse" type="GetValidationsResponse"/>
Referenced By:
Get version input parameter.

Fields:

string versionName: Version name field.
+Element Definition
<element name="getVersion" nillable="true" type="GetVersion"/>
Referenced By:
Get version names input parameter.
+Element Definition
<element name="getVersionNames" nillable="true" type="VoidType"/>
Referenced By:
Get version names output parameter.

Fields:

StringListType stringList: A list of strings field.
+Element Definition
<element name="getVersionNamesResponse" nillable="true" type="StringListResponseType"/>
Referenced By:
Get version property values input parameter.

Fields:

string versionName: Version name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Element Definition
<element name="getVersionPropValues" nillable="true" type="GetVersionPropValues"/>
Referenced By:
Get version property values output parameter.

Fields:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.
+Element Definition
<element name="getVersionPropValuesResponse" nillable="true" type="PropValuesResponseType"/>
Referenced By:
Get version properties input parameter.

Fields:

string versionName: Version name field.
StringListType propNameList: List of properties to return.
+Element Definition
<element name="getVersionProps" nillable="true" type="GetVersionProps"/>
Referenced By:
Get version properties output parameter.

Fields:

PropListType propList: Return list type field of PropListType types.
+Element Definition
<element name="getVersionPropsResponse" nillable="true" type="PropListResponseType"/>
Referenced By:
Get version output parameter.

Fields:

VersionType version: The version object field.
+Element Definition
<element name="getVersionResponse" nillable="true" type="VersionResponseType"/>
Referenced By:
Get versions input parameter.

Fields:

StringListType versionNameList: A list of version names.
+Element Definition
<element name="getVersions" nillable="true" type="GetVersions"/>
Referenced By:
Get versions output parameter.

Fields:

VersionListType versionList: List type of versionType objects.
+Element Definition
<element name="getVersionsResponse" nillable="true" type="VersionListResponseType"/>
Referenced By:
Inactivate node input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name to inactivate.
string mergeNodeName: The name of the node to merge this inactive node to (if merging is enabled).
+Element Definition
<element name="inactivateNode" type="InactivateNode"/>
Referenced By:
Inactivate node output parameter.
+Element Definition
<element name="inactivateNodeResponse" nillable="true" type="VoidType"/>
Referenced By:
Inactivate nodes input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of nodes to inactivate.
StringListType mergeNodeNameList: List of node names to merge the corresponding nodeNameList with (if merging is enabled).
+Element Definition
<element name="inactivateNodes" type="InactivateNodes"/>
Referenced By:
Inactivate nodes output parameter.
+Element Definition
<element name="inactivateNodesResponse" nillable="true" type="VoidType"/>
Referenced By:
Insert node input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string targetParentName: The existing parent node name to insert this node under.
NameValueListType propNameValueList: Name/Value Pair list field for property definition name and value for the node property value.
+Element Definition
<element name="insertNode" type="InsertNode"/>
Referenced By:
Insert node output parameter.
+Element Definition
<element name="insertNodeResponse" nillable="true" type="VoidType"/>
Referenced By:
Insert node with properties input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string targetParentName: The existing parent node name to insert this node under.
PropListType propList: Array of properties to update.
+Element Definition
<element name="insertNodeWithProps" type="InsertNodeWithProps"/>
Referenced By:
Insert node with properties output parameter.
+Element Definition
<element name="insertNodeWithPropsResponse" nillable="true" type="VoidType"/>
Referenced By:
Insert nodes input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of nodes to insert under a new parent.
string targetParentName: The existing parent node name to insert this node under.
+Element Definition
<element name="insertNodes" type="InsertNodes"/>
Referenced By:
Insert nodes output parameter.
+Element Definition
<element name="insertNodesResponse" nillable="true" type="VoidType"/>
Referenced By:
Move node input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string targetParentName: The name of the new parent node.
+Element Definition
<element name="moveNode" type="MoveNode"/>
Referenced By:
Move node output parameter.
+Element Definition
<element name="moveNodeResponse" nillable="true" type="VoidType"/>
Referenced By:
Move nodes input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of node names to move.
string targetParentName: The name of the new parent node.
+Element Definition
<element name="moveNodes" type="MoveNodes"/>
Referenced By:
Move nodes output parameter.
+Element Definition
<element name="moveNodesResponse" nillable="true" type="VoidType"/>
Referenced By:
Open version input parameter.

Fields:

string versionName: Version name field.
+Element Definition
<element name="openVersion" type="OpenVersion"/>
Referenced By:
Open version output parameter.
+Element Definition
<element name="openVersionResponse" nillable="true" type="VoidType"/>
Referenced By:
Order children input parameter.

Fields:

NodeLocatorType nodeLocator: Node locator object representing a node within a hierarchy.
StringListType nodeNames: List of nodes to order. The sequence of this list will be used to order the children.
+Element Definition
<element name="orderChildren" type="OrderChildren"/>
Referenced By:
Order children output parameter.
+Element Definition
<element name="orderChildrenResponse" nillable="true" type="VoidType"/>
Referenced By:
Query request input parameter.

Fields:

RequestQueryParamsType requestQueryParams: Field for request query parameters.
+Element Definition
<element name="queryRequests" type="QueryRequests"/>
Referenced By:
Query requests output parameter.

Fields:

RequestHeaderListType requestHeaderList: List of request headers.
+Element Definition
<element name="queryRequestsResponse" nillable="true" type="RequestHeaderListResponseType"/>
Referenced By:
Reactivate node input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
+Element Definition
<element name="reactivateNode" type="ReactivateNode"/>
Referenced By:
Reactivate node output parameter.
+Element Definition
<element name="reactivateNodeResponse" nillable="true" type="VoidType"/>
Referenced By:
Reactivate nodes input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of node names to reactivate.
+Element Definition
<element name="reactivateNodes" type="ReactivateNodes"/>
Referenced By:
Reactivate nodes output parameter.
+Element Definition
<element name="reactivateNodesResponse" nillable="true" type="VoidType"/>
Referenced By:
Remvoe node input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
+Element Definition
<element name="removeNode" type="RemoveNode"/>
Referenced By:
Remove node output parameter.
+Element Definition
<element name="removeNodeResponse" nillable="true" type="VoidType"/>
Referenced By:
Remove nodes input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: A list of node names to remove.
+Element Definition
<element name="removeNodes" type="RemoveNodes"/>
Referenced By:
Remove nodes output parameter.
+Element Definition
<element name="removeNodesResponse" nillable="true" type="VoidType"/>
Referenced By:
Run blender by name input parameter.

Fields:

string blenderName: The name of a blender.
string sourceVersionName: The source version name.
string targetVersionName: The target version name.
ObjectAccessEnum access: Access level of the blender to run.
string newVersionName: If present, the new version name that will be created as a result of the blend operation instead of blending into the target version.
string newVersionDescr: If present, the new version description that will be created as a result of the blend operation instead of blending into the target version.
int timeoutDuration: A timeout value in milliseconds to stop waiting for blender results.
+Element Definition
<element name="runBlenderByName" type="RunBlenderByName"/>
Referenced By:
Run blender by name output parameter.

Fields:

BlenderResultsType blenderResult: Blender results object.
+Element Definition
<element name="runBlenderByNameResponse" nillable="true" type="BlenderResultsResponseType"/>
Referenced By:
Run compare input parameter.

Fields:

CompareType compareCriteria: The compare criteria to be used to run the compare.
StringListType returnPropNameList: List of property values to return after the compare.
+Element Definition
<element name="runCompare" type="RunCompare"/>
Referenced By:
Run compare by name input parameter.

Fields:

string compareName: The compare name to run.
string fromVersionName: The source version name for the compare.
string toVersionName: The target version name for the compare.
ObjectAccessEnum access: Access level of the compare to run.
StringListType returnPropNameList: List of property values to return after the compare.
+Element Definition
<element name="runCompareByName" type="RunCompareByName"/>
Referenced By:
Run compare by name output parameter.

Fields:

CompareResultType compareResult: Results of a compare operation.
+Element Definition
<element name="runCompareByNameResponse" nillable="true" type="CompareResultResponseType"/>
Referenced By:
Run compare output parameter.

Fields:

CompareResultType compareResult: Results of a compare operation.
+Element Definition
<element name="runCompareResponse" nillable="true" type="CompareResultResponseType"/>
Referenced By:
Run global query input parameter.

Fields:

QueryType query: The query criteria for the global query.
StringListType propNameList: List of property values to return after the query.
+Element Definition
<element name="runGlobalQuery" type="RunGlobalQuery"/>
Referenced By:
Run global query output parameter.

Fields:

GlobalQueryResultType globalQueryResult: A query results for a global query.
+Element Definition
<element name="runGlobalQueryResponse" nillable="true" type="GlobalQueryResponseType"/>
Referenced By:
Run query input parameter.

Fields:

QueryType query: The query criteria for the local query.
StringListType propNameList: List of property values to return after the query.
+Element Definition
<element name="runQuery" type="RunQuery"/>
Referenced By:
Run query output parameter.

Fields:

QueryResultType queryResult: A list type of queryResultType types.
+Element Definition
<element name="runQueryResponse" nillable="true" type="QueryResultResponseType"/>
Referenced By:
Run validate hierarchy input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType validationNameList: List of validation names to run for the hierarchy.
int maxNodes: The maximum number of results to return for the validation run.
StringListType propNameList: List of properties to return in the validation results.
+Element Definition
<element name="runValidateHier" type="RunValidateHier"/>
Referenced By:
Run validate hierarchy output parameter.

Fields:

HierValidationResultType validationResult: The results of a hierarchy level validation run.
+Element Definition
<element name="runValidateHierResponse" nillable="true" type="HierValidationResponseType"/>
Referenced By:
Run validate node input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType validationNameList: List of validation names to run for the node.
boolean recurse: Flag indicating if the validation should run the node specified and its descendants.
int maxNodes: The maximum number of validation results to return.
StringListType propNameList: List of properties to return in the validation results.
+Element Definition
<element name="runValidateNode" type="RunValidateNode"/>
Referenced By:
Run Validate node output parameter.

Fields:

QueryResultType queryResult: A list type of queryResultType types.
+Element Definition
<element name="runValidateNodeResponse" nillable="true" type="QueryResultResponseType"/>
Referenced By:
Run Validate version input parameter.

Fields:

string versionName: Version name field.
StringListType validationNameList: List of validation names to run for the version.
int maxNodes: The maximum number of validation results to return.
StringListType propNameList: List of properties to return in the validation results.
+Element Definition
<element name="runValidateVersion" type="RunValidateVersion"/>
Referenced By:
Run Validate version output parameter.

Fields:

VersionValidationResultType validationResult: The version validation results.
+Element Definition
<element name="runValidateVersionResponse" nillable="true" type="VersionValidationResponseType"/>
Referenced By:
Search For nodes in hierarchy input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string propName: Property name field.
string searchString: The search criteria value. An asterisk (*) can be supplied as a wildcard character.
int maxNodes: The maximum number of nodes to return in the result.
StringListType returnPropNameList: List of properties to return in the results.
+Element Definition
<element name="searchForNodesInHier" type="SearchForNodesInHier"/>
Referenced By:
Search For nodes in hierarchy output parameter.

Fields:

QueryResultType queryResult: A list type of queryResultType types.
+Element Definition
<element name="searchForNodesInHierResponse" nillable="true" type="QueryResultResponseType"/>
Referenced By:
Search For nodes In a version input parameter.

Fields:

string versionName: Version name field.
string propName: Property name field.
string searchString: The search criteria value. An asterisk (*) can be supplied as a wildcard character.
int maxNodes: The maximum number of nodes to return in the result.
StringListType returnPropNameList: List of properties to return in the results.
+Element Definition
<element name="searchForNodesInVersion" nillable="true" type="SearchForNodesInVersion"/>
Referenced By:
Search For nodes in a version output parameter.

Fields:

QueryResultListType queryResultList: A list response type for query results.
+Element Definition
<element name="searchForNodesInVersionResponse" nillable="true" type="QueryResultListResponseType"/>
Referenced By:
Set hierarchy top node input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string topNodeName: The top node name.
+Element Definition
<element name="setHierTopNode" type="SetHierTopNode"/>
Referenced By:
Set hierarchy top node output parameter.
+Element Definition
<element name="setHierTopNodeResponse" nillable="true" type="VoidType"/>
Referenced By:
Set hierarchy validations input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType validationNameList: List of validation names.
+Element Definition
<element name="setHierValidations" type="SetHierValidations"/>
Referenced By:
Set hierarchy validations output parameter.
+Element Definition
<element name="setHierValidationsResponse" nillable="true" type="VoidType"/>
Referenced By:
Set user password input parameter.

Fields:

string userName: The username field.
string newPassword: The new password for the user.
PasswordExpireEnum passwordExpireType: An enumeration indicating how the password should expire.
+Element Definition
<element name="setUserPassword" type="SetUserPassword"/>
Referenced By:
Set user password output parameter.
+Element Definition
<element name="setUserPasswordResponse" nillable="true" type="VoidType"/>
Referenced By:
Set version validations input parameter.

Fields:

string versionName: Version name field.
StringListType validationNameList: List of version names.
+Element Definition
<element name="setVersionValidations" type="SetVersionValidations"/>
Referenced By:
Set version validations output parameter.
+Element Definition
<element name="setVersionValidationsResponse" nillable="true" type="VoidType"/>
Referenced By:
Start blender by name input parameter.

Fields:

string blenderName: The blender name field.
string sourceVersionName: The source version name.
string targetVersionName: The target version name.
ObjectAccessEnum access: The object access level of the blender.
string newVersionName: If present, the new version name that will be created as a result of the blend operation instead of blending into the target version.
string newVersionDescr: If present, the new version description that will be created as a result of the blend operation instead of blending into the target version.
+Element Definition
<element name="startBlenderByName" type="StartBlenderByName"/>
Referenced By:
Start blender by name output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startBlenderByNameResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start book by name input parameter.

Fields:

string bookName: The book name field.
ObjectAccessEnum access: The object access field for the book.
string fromVersionName: The current version name.
string toVersionName: The previous version name.
+Element Definition
<element name="startBookByName" type="StartBookByName"/>
Referenced By:
Start book by name output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startBookByNameResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start compare input parameter.

Fields:

CompareType compareCriteria: The compare criteria to be used for the compare.
StringListType returnPropNameList: List of properties to return in the results.
+Element Definition
<element name="startCompare" type="StartCompare"/>
Referenced By:
Start compare by name input parameter.

Fields:

string compareName: The compare name field.
string fromVersionName: The from version name field.
string toVersionName: The to version name field.
ObjectAccessEnum access: The object access field for the book.
StringListType returnPropNameList: List of properties to return in the results.
+Element Definition
<element name="startCompareByName" type="StartCompareByName"/>
Referenced By:
Start compare by name output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startCompareByNameResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start compare export by name input parameter.

Fields:

string exportName: The name of the compare export.
string fromVersionName: The from version name field.
string toVersionName: The to version name field.
ObjectAccessEnum access: The object access level of the export.
+Element Definition
<element name="startCompareExportByName" type="StartCompareExportByName"/>
Referenced By:
Start compare export by name on hierarchy input parameter.

Fields:

string exportName: The name of the compare export.
string fromVersionName: The from version name field.
string fromHierName: The from hierarchy name field.
string toVersionName: The to version name field.
string toHierName: The to hierarchy name field.
ObjectAccessEnum access: Access level of the export to run.
+Element Definition
<element name="startCompareExportByNameOnHier" type="StartCompareExportByNameOnHier"/>
Referenced By:
Start compare export by name on hierarchy node input parameter.

Fields:

string exportName: The name of the compare export.
string fromVersionName: The from version name field.
HierNodeNamePairType fromHierNode: The from hierarchy name field.
string toVersionName: The to version name field.
HierNodeNamePairType toHierNode: The to hierarchy name field.
ObjectAccessEnum access: Access level of the export to run.
+Element Definition
<element name="startCompareExportByNameOnHierNode" type="StartCompareExportByNameOnHierNode"/>
Referenced By:
Start compare export by name on hierarchy node output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startCompareExportByNameOnHierNodeResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start compare export by name on hierarchy output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startCompareExportByNameOnHierResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start compare export by name output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startCompareExportByNameResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start compare output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startCompareResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start copy version input parameter.

Fields:

string sourceVersionName: The name of the version to copy.
string destVersionName: The new name of the version.
string destDescr: The new description field of the version.
boolean clearApproval: Flag indicating that the approval flags should be cleared.
boolean clearChanged: Flag indicating that the changed on properties should be cleared.
boolean dbConnect: Flag indicating that the version should be persisted to the data store.
+Element Definition
<element name="startCopyVersion" type="StartCopyVersion"/>
Referenced By:
Start copy version output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startCopyVersionResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start create as of transaction ID input parameter.

Fields:

string versionName: Version name field.
int endTxnId: Ending transaction ID field.
+Element Definition
<element name="startCreateAsOfTxnID" type="StartCreateAsOfTxnID"/>
Referenced By:
Start create as of transaction ID output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startCreateAsOfTxnIDResponse" type="StartJobResponseType"/>
Referenced By:
Start create version as of date input parameter.

Fields:

string versionName: Version name field.
dateTime asOfDateTime: A date time value to create the version snapshot.
+Element Definition
<element name="startCreateVersionAsOfDate" type="StartCreateVersionAsOfDate"/>
Referenced By:
Start create version as of date output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startCreateVersionAsOfDateResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start delete version input parameter.

Fields:

string versionName: Version name field.
+Element Definition
<element name="startDeleteVersion" type="StartDeleteVersion"/>
Referenced By:
Start delete version output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startDeleteVersionResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start export input parameter.

Fields:

ExportType export: The export type field.
+Element Definition
<element name="startExport" type="StartExport"/>
Referenced By:
Start export by name input parameter.

Fields:

string exportName: The export name to run.
ObjectAccessEnum access: Access level of the export to run.
string fromVersionName: The from version name field.
string toVersionName: The to version name field.
+Element Definition
<element name="startExportByName" type="StartExportByName"/>
Referenced By:
Start export by name output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startExportByNameResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start export output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startExportResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start global query input parameter.

Fields:

QueryType query: The query criteria field.
StringListType propNameList: List of properties to return in the results.
+Element Definition
<element name="startGlobalQuery" type="StartGlobalQuery"/>
Referenced By:
Start global query output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startGlobalQueryResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start hierarchy export by name input parameter.

Fields:

string exportName: The export name to run.
string versionName: Version name field.
boolean includeAllHiers: Flag indicating that the export should include all hierarchies.
ObjectAccessEnum access: Access level of the export to run.
+Element Definition
<element name="startHierExportByName" type="StartHierExportByName"/>
Referenced By:
Start hierarchy export by name on hierarchy node input parameter.

Fields:

string exportName: The export name to run.
string versionName: Version name field.
HierNodeNamePairType hierNode: The hierarchy node field.
ObjectAccessEnum access: Access level of the export to run.
+Element Definition
<element name="startHierExportByNameOnHierNode" type="StartHierExportByNameOnHierNode"/>
Referenced By:
Start hierarchy by name on hierarchy node output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startHierExportByNameOnHierNodeResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start hierarchy export by name on hierarchy nodes input parameter.

Fields:

string exportName: The export name to run.
string versionName: Version name field.
HierNodeNamePairListType hierNodeList: A list type with hierarchy/node pairs.
ObjectAccessEnum access: Access level of the export to run.
+Element Definition
<element name="startHierExportByNameOnHierNodes" type="StartHierExportByNameOnHierNodes"/>
Referenced By:
Start hierarchy export by name on hierarchy nodes output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startHierExportByNameOnHierNodesResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start hierarchy export by name on hierarchies input parameter.

Fields:

string exportName: The export name to run.
string versionName: Version name field.
StringListType hierNameList: A list type fo hierarchy names.
ObjectAccessEnum access: Access level of the export to run.
+Element Definition
<element name="startHierExportByNameOnHiers" type="StartHierExportByNameOnHiers"/>
Referenced By:
Start hierarchy export by name on hierarchies output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startHierExportByNameOnHiersResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start hierarchy export by name output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startHierExportByNameResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start import input parameter.

Fields:

ImportType importProfile: The import profile field.
base64Binary compressedFileContent: Byte array of compressed bytes that represent the script file. The deflate algorithm should be used to compress the content.
+Element Definition
<element name="startImport" type="StartImport"/>
Referenced By:
Start import by name input parameter.

Fields:

string importName: The import name field.
base64Binary compressedFileContent: Byte array of compressed bytes that represent the file. The deflate algorithm should be used to compress the content.
ObjectAccessEnum access: Access level of the import.
string versionName: Version name field. This field value will be used as the name of the version.
string versionDescription: Version description field. This field value will be used as the description of the version.
+Element Definition
<element name="startImportByName" type="StartImportByName"/>
Referenced By:
Start import by name output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startImportByNameResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start import input parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startImportResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start query input parameter.

Fields:

QueryType query: Query criteria field.
StringListType propNameList: List of properties to return in the results.
+Element Definition
<element name="startQuery" type="StartQuery"/>
Referenced By:
Start query output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startQueryResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start Save version input parameter.

Fields:

string versionName: Version name field.
+Element Definition
<element name="startSaveVersion" type="StartSaveVersion"/>
Referenced By:
Start Save version output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startSaveVersionResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start action script input parameter.

Fields:

ActionItemListType actionItemList: A list of action items to process.
+Element Definition
<element name="startScript" type="StartScript"/>
Referenced By:
Start action script from file input parameter.

Fields:

ScriptLoadParamsType scriptLoaderParams: Field describes the action script content to be processed.
CharacterEncodingEnum encoding: An enumeration indicating encoding of the text file.
+Element Definition
<element name="startScriptFromFile" type="StartScriptFromFile"/>
Referenced By:
Start action script from file output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startScriptFromFileResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Start Script output parameter.

Fields:

JobInfoType jobInfo: Job info field.
+Element Definition
<element name="startScriptResponse" nillable="true" type="StartJobResponseType"/>
Referenced By:
Update blender input parameter.

Fields:

BlenderType blender: Blender to be updated.
+Element Definition
<element name="updateBlender" type="UpdateBlender"/>
Referenced By:
Update blender output parameter.
+Element Definition
<element name="updateBlenderResponse" nillable="true" type="VoidType"/>
Referenced By:
Update book input parameter.

Fields:

BookType book: Book to be updated.
+Element Definition
<element name="updateBook" type="UpdateBook"/>
Referenced By:
Update book output parameter.
+Element Definition
<element name="updateBookResponse" nillable="true" type="VoidType"/>
Referenced By:
Update compare input parameter.

Fields:

CompareType compare: Compare to be updated.
+Element Definition
<element name="updateCompare" type="UpdateCompare"/>
Referenced By:
Update compare output parameter.
+Element Definition
<element name="updateCompareResponse" nillable="true" type="VoidType"/>
Referenced By:
Update export input parameter.

Fields:

ExportType export: Export to be updated.
+Element Definition
<element name="updateExport" type="UpdateExport"/>
Referenced By:
Update export output parameter.
+Element Definition
<element name="updateExportResponse" nillable="true" type="VoidType"/>
Referenced By:
Update glyph input parameter.

Fields:

GlyphType updateGlyph: Glyph to be updated.
+Element Definition
<element name="updateGlyph" type="UpdateGlyph"/>
Referenced By:
Update glyph output parameter.
+Element Definition
<element name="updateGlyphResponse" nillable="true" type="VoidType"/>
Referenced By:
Update hierarchy group input parameter.

Fields:

HierGroup hierGroup: Hierarchy group to be updated.
+Element Definition
<element name="updateHierGroup" type="UpdateHierGroup"/>
Referenced By:
Update hierarchy group output parameter.
+Element Definition
<element name="updateHierGroupResponse" nillable="true" type="VoidType"/>
Referenced By:
Update hierarchy property values input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
NameValueListType propValueList: A name value list type field that indicates the properties and their values.
+Element Definition
<element name="updateHierPropValues" type="UpdateHierPropValues"/>
Referenced By:
Update hierarchy property values output parameter.
+Element Definition
<element name="updateHierPropValuesResponse" nillable="true" type="VoidType"/>
Referenced By:
Update hierarchy properties input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
PropListType propList: A list type object for the PropListType type.
+Element Definition
<element name="updateHierProps" type="UpdateHierProps"/>
Referenced By:
Update hierarchy properties output parameter.
+Element Definition
<element name="updateHierPropsResponse" nillable="true" type="VoidType"/>
Referenced By:
Update import input parameter.

Fields:

ImportType importDef: The import definition object.
+Element Definition
<element name="updateImport" type="UpdateImport"/>
Referenced By:
Update import output parameter.
+Element Definition
<element name="updateImportResponse" nillable="true" type="VoidType"/>
Referenced By:
Update node access group input parameter.

Fields:

NodeAccessGroupType updateNodeAccessGroup: The node access group object.
+Element Definition
<element name="updateNodeAccessGroup" type="UpdateNodeAccessGroup"/>
Referenced By:
Update node access group output parameter.
+Element Definition
<element name="updateNodeAccessGroupResponse" nillable="true" type="VoidType"/>
Referenced By:
Update node property values input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
NameValueListType propNameValueList: Name/Value Pair list field for property definition name and value for the node property value.
+Element Definition
<element name="updateNodePropValues" type="UpdateNodePropValues"/>
Referenced By:
Update node property values output parameter.
+Element Definition
<element name="updateNodePropValuesResponse" nillable="true" type="VoidType"/>
Referenced By:
Update node properties input parameter.

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
PropListType propList: A list of property values to update for the node.
+Element Definition
<element name="updateNodeProps" type="UpdateNodeProps"/>
Referenced By:
Update node properties output parameter.
+Element Definition
<element name="updateNodePropsResponse" nillable="true" type="VoidType"/>
Referenced By:
Update property category input parameter.

Fields:

PropCategoryType propertyCategory: Property category field.
+Element Definition
<element name="updatePropCategory" type="UpdatePropCategory"/>
Referenced By:
Update property category output parameter.
+Element Definition
<element name="updatePropCategoryResponse" nillable="true" type="VoidType"/>
Referenced By:
Update property definition input parameter.

Fields:

PropDefType propDef: The property definition field.
+Element Definition
<element name="updatePropDef" type="UpdatePropDef"/>
Referenced By:
Update property definition list values input parameter.

Fields:

string propDefName: Property definition name for a list type property definition.
StringListType listValues: List of values to update the property with.
+Element Definition
<element name="updatePropDefListValues" type="UpdatePropDefListValues"/>
Referenced By:
Update property definition list values output parameter.
+Element Definition
<element name="updatePropDefListValuesResponse" nillable="true" type="VoidType"/>
Referenced By:
Update property definition output parameter.
+Element Definition
<element name="updatePropDefResponse" nillable="true" type="VoidType"/>
Referenced By:
Update query input parameter.

Fields:

QueryType query: Query type field.
string renameName: If supplied a new name to give the query criteria.
+Element Definition
<element name="updateQuery" type="UpdateQuery"/>
Referenced By:
Update query output parameter.
+Element Definition
<element name="updateQueryResponse" nillable="true" type="VoidType"/>
Referenced By:
Update request input parameter.

Fields:

RequestType request: The request object field.
+Element Definition
<element name="updateRequest" type="UpdateRequest"/>
Referenced By:
Update request output parameter.
+Element Definition
<element name="updateRequestResponse" nillable="true" type="VoidType"/>
Referenced By:
Update hierarchy input parameter.

Fields:

UserType user: The user object field.
+Element Definition
<element name="updateUser" type="UpdateUser"/>
Referenced By:
Update user lockout input parameter.

Fields:

UserType user: The user object field.
+Element Definition
<element name="updateUserLockout" type="UpdateUserLockout"/>
Referenced By:
Update user lockout output parameter.
+Element Definition
<element name="updateUserLockoutResponse" nillable="true" type="VoidType"/>
Referenced By:
Update user password input parameter.

Fields:

string userName: The existing user name field.
string oldPassword: The old password field.
string newPassword: The new password field.
+Element Definition
<element name="updateUserPassword" type="UpdateUserPassword"/>
Referenced By:
Update user password output parameter.
+Element Definition
<element name="updateUserPasswordResponse" nillable="true" type="VoidType"/>
Referenced By:
Update user output parameter.
+Element Definition
<element name="updateUserResponse" nillable="true" type="VoidType"/>
Referenced By:
Update validation definition input parameter.

Fields:

ValidationDefinitionType validation: The validation object field.
+Element Definition
<element name="updateValidation" type="UpdateValidation"/>
Referenced By:
Update validation definition output parameter.
+Element Definition
<element name="updateValidationResponse" nillable="true" type="VoidType"/>
Referenced By:
Update version property values input parameter.

Fields:

string versionName: Version name field.
NameValueListType propValueList: List type of nameValueListType for properties and their values.
+Element Definition
<element name="updateVersionPropValues" type="UpdateVersionPropValues"/>
Referenced By:
Update version property values output parameter.
+Element Definition
<element name="updateVersionPropValuesResponse" nillable="true" type="VoidType"/>
Referenced By:
Update version properties input parameter.

Fields:

string versionName: Version name field.
PropListType propList: List type of PropListType for properties and their values.
+Element Definition
<element name="updateVersionProps" type="UpdateVersionProps"/>
Referenced By:
Update version properties output parameter.
+Element Definition
<element name="updateVersionPropsResponse" nillable="true" type="VoidType"/>
Referenced By:
Validate request input parameter.

Fields:

RequestType request: The request to validate.
boolean saveIfSuccessful: Flag indicating that the request should be saved if the validation was successful.
+Element Definition
<element name="validateRequest" type="ValidateRequest"/>
Referenced By:
Validate request output parameter.

Fields:

RequestValidationResultType requestValidationResult: The request validation result. Returned when one validates a request.
+Element Definition
<element name="validateRequestResponse" nillable="true" type="RequestValidationResponseType"/>
Referenced By:
Enumeration indicating the access level permissions.
+Type Definition
<simpleType name="AccessLevelEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="Read"/>
<enumeration value="LimitedInsert"/>
<enumeration value="Edit"/>
<enumeration value="Insert"/>
<enumeration value="Inactivate"/>
<enumeration value="Add"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

ActionItemResultListType actionItemList: List of action items.
+Type Definition
<complexType name="ActionItemListResponseType">
<sequence>
<element name="actionItemList" type="ActionItemResultListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ActionItemType actionItem: Array of action script items.
+Type Definition
<complexType name="ActionItemListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="actionItem" nillable="true" type="ActionItemType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ActionItemResultType actionItemResult: Results of action items.
+Type Definition
<complexType name="ActionItemResultListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="actionItemResult" nillable="true" type="ActionItemResultType"/>
</sequence>
</complexType>
Referenced By:

Fields:

SuccessStateEnum successState: Result of the processed action item.
string returnValue: Return value of the Item.
string statusMsg: Message indicating whether the action item was successful.
+Type Definition
<complexType name="ActionItemResultType">
<sequence>
<element minOccurs="0" name="successState" type="SuccessStateEnum"/>
<element minOccurs="0" name="returnValue" type="string"/>
<element minOccurs="0" name="statusMsg" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string actionType: An action type; possible values: Activate, Add, AddHier, AddInsert, AddOrphan, AffectedNode, Annul, AnnulAllBelow, AssignHierValidations, AssignVersionValidations, ChangeGlobalProps, ChangeHierTopNode, ChangeProp, ClearPropsBelow, Delete, DeleteHier, DeleteOrphan, Destroy, Inactivate, Insert, LockProp, Move, NodeExists, NodeExistsInHier, NodeHasAsParent, PropCompare, PropQuery, Remove, RemoveDupProps, RemoveHierPropValue, RemoveProp, RemoveVersionPropValue, UpdateHierPropValue, UpdateVersionPropValue.
int minParamCount: Specifies the minimum number of parameters this action item can have.
int maxParamCount: Specifies the maximum number of parameters this action item can have.
StringListType params: The string list of parameters.
boolean skipFlag: Flag indicating whether to process the item or not.
+Type Definition
<complexType name="ActionItemType">
<sequence>
<element minOccurs="0" name="actionType" type="string"/>
<element minOccurs="0" name="minParamCount" type="int"/>
<element minOccurs="0" name="maxParamCount" type="int"/>
<element minOccurs="0" name="params" type="StringListType"/>
<element minOccurs="0" name="skipFlag" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: Name of glyph.
string descr: Description of glyph.
string imageData: Base-64 string value of the byte data.
ImageTypeEnum imageTypeEnum: Currently supported image types are PNG.
+Type Definition
<complexType name="AddGlyph">
<sequence>
<element name="name" type="string"/>
<element minOccurs="0" name="descr" type="string"/>
<element name="imageData" type="string"/>
<element name="imageTypeEnum" type="ImageTypeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string descr: Hierarchy description field.
string topNodeName: Top node name field.
string topNodeDescr: Top node description field.
+Type Definition
<complexType name="AddHier">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element minOccurs="0" name="descr" type="string"/>
<element name="topNodeName" type="string"/>
<element minOccurs="0" name="topNodeDescr" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: Hierarchy group name field.
string descr: Hierarchy group description field.
int order: Sort order field for the hierarchy group.
+Type Definition
<complexType name="AddHierGroup">
<sequence>
<element name="name" type="string"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="order" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string parentName: Parent node name field.
string nodeName: Node name field.
boolean isLeaf: Field indicating whether node is a leaf node.
NameValueListType propNameValueList: Name/value pair list field for property definition name and value for the node property value.
boolean updateIfExists: If True and the node exists, then update the properties for the node; if the node exists and this flag is False, then skip property updates.
+Type Definition
<complexType name="AddNode">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="parentName" type="string"/>
<element name="nodeName" type="string"/>
<element name="isLeaf" type="boolean"/>
<element minOccurs="0" name="propNameValueList" type="NameValueListType"/>
<element default="false" minOccurs="0" name="updateIfExists" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeAccessGroupType nodeAccessGroup: Node access group input object.
+Type Definition
<complexType name="AddNodeAccessGroup">
<sequence>
<element name="nodeAccessGroup" type="NodeAccessGroupType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: Name of the node type.
string descr: Description of the node type.
StringListType propNameList: Property definition names to associate with this node type.
StringListType categoryNameList: The property category names to associate with this node type.
StringListType validationList: The validation definition names to associate with this node type.
string glyphName: The glyph name to associate with this node type.
+Type Definition
<complexType name="AddNodeType">
<sequence>
<element name="name" type="string"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
<element minOccurs="0" name="categoryNameList" type="StringListType"/>
<element minOccurs="0" name="validationList" type="StringListType"/>
<element minOccurs="0" name="glyphName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string parentName: Parent node name field.
string nodeName: Node name field.
boolean isLeaf: Field indicating if node is a leaf node.
PropListType propList: The list of properties and their values to set on the node.
boolean updateIfExists: If True and the node exists, then update the properties for the node; if the node exists and this flag is False, then skip property updates.
+Type Definition
<complexType name="AddNodeWithProps">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="parentName" type="string"/>
<element name="nodeName" type="string"/>
<element name="isLeaf" type="boolean"/>
<element name="propList" type="PropListType"/>
<element default="false" minOccurs="0" name="updateIfExists" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string nodeName: Node name field.
boolean isLeaf: Field indicating whether node is a leaf node.
+Type Definition
<complexType name="AddOrphanNode">
<sequence>
<element name="versionName" type="string"/>
<element name="nodeName" type="string"/>
<element name="isLeaf" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

string propCategoryName: Property category name field.
string descr: Property category description field.
PropCategoryTypeEnum propCategoryType: An enumeration value indicating the type of property category.
StringListType propNameList: A list of property definition names to associate with this property category.
boolean availableUserCategory: Flag indicating whether the category should be saved as a user category.
int order: The order in which the property category appears in the property editor.
+Type Definition
<complexType name="AddPropCategory">
<sequence>
<element name="propCategoryName" type="string"/>
<element minOccurs="0" name="descr" type="string"/>
<element name="propCategoryType" type="PropCategoryTypeEnum"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
<element minOccurs="0" name="availableUserCategory" type="boolean"/>
<element minOccurs="0" name="order" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

PropDefType propDef: A property definition object field.
+Type Definition
<complexType name="AddPropDef">
<sequence>
<element name="propDef" type="PropDefType"/>
</sequence>
</complexType>
Referenced By:

Fields:

UserInputType userInput: User input object field.
string password: The password to set for this new user.
+Type Definition
<complexType name="AddUser">
<sequence>
<element name="userInput" type="UserInputType"/>
<element minOccurs="0" name="password" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: The validation name field.
string descr: Validation description.
string displayLabel: The label for the validation.
ValidationTypeEnum allowedType: An enumeration indicating how the validation can be executed.
boolean cascade: Flag indicating whether the validation is to be implicitly assigned via inheritance.
int columnWidth: (To be deprecated)
ValidationLevelEnum level: The validation level defines the scope of a business rule.
ValidationParamListType parameters: Parameters that are used by the validation during execution.
boolean setup: Flag that indicates whether the server should check the validity of the parameters.
int sortOrder: The sort order of the property definition within a category.
string validationClass: The type class of validation.
+Type Definition
<complexType name="AddValidation">
<sequence>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="displayLabel" type="string"/>
<element minOccurs="0" name="allowedType" type="ValidationTypeEnum"/>
<element minOccurs="0" name="cascade" type="boolean"/>
<element minOccurs="0" name="columnWidth" type="int"/>
<element minOccurs="0" name="level" type="ValidationLevelEnum"/>
<element minOccurs="0" name="parameters" type="ValidationParamListType"/>
<element minOccurs="0" name="setup" type="boolean"/>
<element minOccurs="0" name="sortOrder" type="int"/>
<element minOccurs="0" name="validationClass" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string versionDescr: Description field.
boolean dbConnect: Flag that indicates whether the version should be persisted to the data store. If False, the version resides only in memory.
+Type Definition
<complexType name="AddVersion">
<sequence>
<element name="versionName" type="string"/>
<element minOccurs="0" name="versionDescr" type="string"/>
<element minOccurs="0" name="dbConnect" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
boolean annulChildNodes: Flag indicating to remove children from the hierarchy and delete children if the child is an orphan.
+Type Definition
<complexType name="AnnulNode">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element default="false" minOccurs="0" name="annulChildNodes" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

string serverUrl: API adapter URL of the DRM Server. Example: http://localhost:5240/Oracle/Drm/APIAdapter?wsdl
string sessionParams: Represents session parameters for the DRM server. Example: ProductVersion=11.1.2;CultureName=en-US;TimeZoneOffset=-360
+Type Definition
<complexType name="AppParameters">
<sequence>
<element name="serverUrl" type="string"/>
<element name="sessionParams" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

int requestId: ID of the request header.
+Type Definition
<complexType name="ApproveRequest">
<sequence>
<element name="requestId" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

FlatFileActionColEnum FlatFileActionColEnum: Array of FlatFileActionColumnEnum.
+Type Definition
<complexType name="ArrayOfFlatFileActionColEnum">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="FlatFileActionColEnum" type="FlatFileActionColEnum"/>
</sequence>
</complexType>
Referenced By:
+Type Definition
<simpleType name="AsOfMethodEnum">
<restriction base="string">
<enumeration value="Date"/>
<enumeration value="Offset"/>
<enumeration value="ID"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

AsOfVersionResultType asOfVersion: AsOfVersionResultType field.
+Type Definition
<complexType name="AsOfVersionResultResponseType">
<sequence>
<element name="asOfVersion" type="AsOfVersionResultType"/>
</sequence>
</complexType>
Referenced By:

Fields:

VersionType newVersion: Name of the newly created version.
StringListType errorList: String list of errors that can occur while creating an as of.
+Type Definition
<complexType name="AsOfVersionResultType">
<sequence>
<element minOccurs="0" name="newVersion" type="VersionType"/>
<element minOccurs="0" name="errorList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string propName: Property definition name.
+Type Definition
<complexType name="AssignControlledProps">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="propName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

base64Binary content: Byte array of compressed bytes. Use the deflate algorithm to decompress the content.
+Type Definition
<complexType name="Base64BinaryResponseType">
<sequence>
<element name="content" type="base64Binary"/>
</sequence>
</complexType>
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
+Type Definition
<complexType name="BaseNodeRequestItemType">
<complexContent>
<extension base="HierRequestItemType">
<sequence>
<element name="nodeName" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string descr: Description of compare or query criteria.
boolean markNodes: Indicates that the result of the query or compare should Mark nodes.
boolean expandToMarkedNodes: Indicates that the result tree should be expanded.
boolean showList: Indicates that the result display should show a list of the results.
+Type Definition
<complexType name="BaseParamsType">
<sequence>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="1" name="markNodes" type="boolean"/>
<element minOccurs="1" name="expandToMarkedNodes" type="boolean"/>
<element minOccurs="1" name="showList" type="boolean"/>
</sequence>
</complexType>
Type Hierarchy:

Fields:

BlenderHierSetType blenderHierSet: Is a list of blenderHierSetType objects.
+Type Definition
<complexType name="BlenderHierSetListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="blenderHierSet" nillable="true" type="BlenderHierSetType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string sourceHierName: Indicates the source hierarchy to blend from.
string sourceTopNodeName: Indicates the source node to blend from.
string targetHierName: Indicates the target hierarchy to blend the Source into.
string targetTopNodeName: Indicates the target node to blend into.
BlenderPropListType blenderPropList: The list of blenderPropType objects. Each object represents the properties to blend.
int hierSetId: The ID of the hierarchy set. A blender profile can have one or many hierarchy Sets.
boolean processActivations: Flag indicating to process node activations (inactivate and reactivate) from the target to the source.
boolean processAdds: Flag indicating to insert any nodes existing only in the source hierarchy to the target hierarchy.
boolean processHierValAssignments: Flag indicating to process the hierarchy level validation assignments from the source to the target.
boolean processRemoves: Flag indicating to remove any nodes existing only in the target hierarchy according to the setting in the Remove Mode list and the Remove Indicator list.
boolean processStructure: Flag indicating to blend structural elements, such as hierarchies and nodes.
PropSelectModeEnum propSelectMode:
Enumeration indicating how to process the properties.
  • All - (Excluding Val/Access) All properties are blended; excludes properties used for node-level validations and for node access group- , leaf- , and limb-level settings.
  • None - No properties are blended.
  • Selected - Selected properties are blended.
RemoveModeEnum removeMode:
Enumeration indicating how to process Removes.
  • Remove - Node is immediately removed during blending.
  • Mark - Node is marked for later removal.
string removeIndicatorPropName: If RemoveMode is set to Mark, this field contains the property name that indicates that the node is flagged to be removed.
boolean useProfileDefaults: to use default values for all hierarchy/top node sets. You set the profile defaults for properties on the Properties tab. If you clear this option, you can choose which hierarchies should use the defaults and which should not when you select hierarchy/top node pairs.
+Type Definition
<complexType name="BlenderHierSetType">
<sequence>
<element name="sourceHierName" type="string"/>
<element name="sourceTopNodeName" type="string"/>
<element name="targetHierName" type="string"/>
<element name="targetTopNodeName" type="string"/>
<element minOccurs="0" name="blenderPropList" type="BlenderPropListType"/>
<element minOccurs="0" name="hierSetId" type="int"/>
<element minOccurs="0" name="processActivations" type="boolean"/>
<element minOccurs="0" name="processAdds" type="boolean"/>
<element minOccurs="0" name="processHierValAssignments" type="boolean"/>
<element minOccurs="0" name="processRemoves" type="boolean"/>
<element minOccurs="0" name="processStructure" type="boolean"/>
<element minOccurs="0" name="propSelectMode" type="PropSelectModeEnum"/>
<element minOccurs="0" name="removeMode" type="RemoveModeEnum"/>
<element minOccurs="0" name="removeIndicatorPropName" type="string"/>
<element minOccurs="0" name="useProfileDefaults" type="boolean"/>
</sequence>
</complexType>
Referenced By:
+Type Definition
<simpleType name="BlenderProfileStatusEnum">
<restriction base="string">
<enumeration value="Created"/>
<enumeration value="Started"/>
<enumeration value="IncompleteFatalError"/>
<enumeration value="IncompleteMaxErrors"/>
<enumeration value="IncompleteSystemError"/>
<enumeration value="Completed"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

BlenderPropType blenderProp: List of blenderPropType types
+Type Definition
<complexType name="BlenderPropListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="blenderProp" nillable="true" type="BlenderPropType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string propName: Property name field.
ValuePropagateModeEnum propagateMode:
Enumeration that indicates how to process properties when blending.
  • Force - Property is assigned for every node in the target, whether that property is defined at that node, is inherited, or is derived.
  • Difference - Populates the property for any node where the value is different, regardless of how that property is populated in the target.
  • Defined - Property is blended only when it is specifically defined for the node in the source.
boolean propagateLocks: Flag that indicates inheritance locks in the source to be blended to the target.
+Type Definition
<complexType name="BlenderPropType">
<sequence>
<element name="propName" type="string"/>
<element minOccurs="0" name="propagateMode" type="ValuePropagateModeEnum"/>
<element minOccurs="0" name="propagateLocks" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

BlenderType blender: Blender object.
+Type Definition
<complexType name="BlenderResponseType">
<sequence>
<element name="blender" type="BlenderType"/>
</sequence>
</complexType>
Referenced By:

Fields:

BlenderResultsType blenderResult: Blender results object.
+Type Definition
<complexType name="BlenderResultsResponseType">
<sequence>
<element name="blenderResult" type="BlenderResultsType"/>
</sequence>
</complexType>
Referenced By:

Fields:

BlenderProfileStatusEnum status: Enumeration indicating the status of the blend operation.
string statusDescr: Description of the result status.
boolean isSuccess: If the blender operation does not abort, this flag is True.
StringListType errors: List of errors for the blend operation.
boolean lastPropPassClear: Indicates whether the from and to property values were identical on the final pass.
boolean lastStructPassClear: Indicates whether the from and to nodes were identical on the final pass.
int propPassCount: Number of passes the blender runs to resolve property updates.
int structPassCount: Number of passes the blender runs to resolve structure differences.
+Type Definition
<complexType name="BlenderResultsType">
<sequence>
<element name="status" type="BlenderProfileStatusEnum"/>
<element minOccurs="0" name="statusDescr" type="string"/>
<element minOccurs="0" name="isSuccess" type="boolean"/>
<element minOccurs="0" name="errors" type="StringListType"/>
<element minOccurs="0" name="lastPropPassClear" type="boolean"/>
<element minOccurs="0" name="lastStructPassClear" type="boolean"/>
<element minOccurs="0" name="propPassCount" type="int"/>
<element minOccurs="0" name="structPassCount" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

ObjectAccessEnum objectAccess: Object access enumeration.
string name: Name of blender.
int id: The system-generated ID of the object.
string descr: Description of the object.
string sourceVersionName: Source version to blend from.
VersionParamsType sourceVersionParams: Parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
string targetVersionName: The version to blend the source version into.
VersionParamsType targetVersionParams: Parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
boolean createNewVersion: To blend changes into a copy of the selected target version. If you select this option, you must specify a name and description for the new version.
string newVersionName: Version name to be used if createNewVersion is set to True.
string newVersionDescr: Version description to be used if createNewVersion is set to True.
boolean blendAllHiers: Flag indicating to blend all hierarchies in the selected versions. If set to True, the Use Profile Defaults For All hierarchy Sets option is required.
boolean useDefaultForAllHiers:
Flag to use default values for all hierarchy/top node sets. The corresponding fields in this type apply.
  • defaultProcessActivations
  • defaultProcessAdds
  • defaultProcessHierValAssignments
  • defaultProcessRemoves
  • defaultProcessStructure
  • defaultPropSelectMode
  • defaultPropagateLocks
  • defaultPropagateMode
  • defaultRemoveIndicatorPropName
  • defaultRemoveMode
  • defaultSelectedPropListId

If you deselect this option, you can choose which hierarchies should use the defaults and which should not when you select hierarchy/top node pairs.
boolean allowHierCreation: Flag indicating that hierarchies are to be created during the blender operation.
BlenderPropListType blenderPropList: List of blenderProps to blend.
boolean processVersionValAssignments: Flag indicating to process version-level validation assignments from the source to the target
boolean allowLeafPromotion: Flag indicating to promote a node with children in the source to a limb in the target
boolean disableRTValidation: Flag indicating whether to turn off the real-time validations on the target version before blending or not.
string logFile: If blender is created for batch client purposes, this field contains the log file name to be used on the batch client when writing blender results.
int maxErrors: Value sets the maximum errors that can occur during processing before the blender stops without completion.
int maxPasses: Value determines the maximum attempts the blender performs in reconciling the source and target versions to prevent the blender from running indefinitely in the case of irresolvable conflicts. Recommended value is 3.
BlenderHierSetListType hierSets: One or more blenderHierSet objects, which include source and target hierarchy and top node and options for how to process the sets.
int hierSetsId: System-generated ID of the hierarchy set.
boolean defaultProcessActivations: Default value to process node activations (inactivate and reactivate) from the target to the source.
boolean defaultProcessAdds: Default value to blend structural elements, such as hierarchies and nodes.
boolean defaultProcessHierValAssignments: Default to process the hierarchy-level validation assignments from the source to the target.
boolean defaultProcessRemoves:
Default to remove any nodes existing only in the target hierarchy according to the setting in the Remove Mode list and the Remove Indicator list. If you selected Process Removes, select one of the following Remove Modes:
  • Remove - Node is immediately removed during blending.
  • Mark - Node is marked for later removal.
    When the Remove Mode is set to Mark, the Remove Indicator option designates which property contains the value showing that the node is flagged to be removed. The remove indicator property must be created as a local, Boolean property.
boolean defaultProcessStructure: Default to blend structural elements, such as hierarchies and nodes.
PropSelectModeEnum defaultPropSelectMode: Default Mode value indicating if the properties to be processed: Selected, None, or All (excluding validation and node access group properties).
boolean defaultPropagateLocks: Default value indicating that you want inheritance locks in the source to be blended to the target.
ValuePropagateModeEnum defaultPropagateMode: Default value that determines how a property is to be populated in the target.
string defaultRemoveIndicatorPropName: Property name that is set to True when a node is flagged to be removed (When using "Mark" Remove node). This property must be a local, Boolean property.
RemoveModeEnum defaultRemoveMode: Default mode that indicates how nodes are to be treated when removing nodes from the source to target version.
int defaultSelectedPropListId: If property selection is set to "Selected," this field indicates which property IDs are to be used.
boolean clearStatusProps: Flag to instruct the blender to set all blender status property values to False during processing.
boolean populateStatusProps: Flag to instruct the blender to set all blender status property values to True during processing.
string versionBlendedPropName: Name of the property that is set to True if the version has been blended {Version Level Boolean Defined Property}.
string hierBlendedPropName: The name of the property that is set to True if the hierarchy has been blended {Hierarchy Level Boolean Defined Property}.
string nodeGlobalAddedPropName: Name of the property that is set to True if the node had global properties changed by the blend {Global node Level Boolean Defined Property}.
string nodeAddedPropName: Name of the property that is set to True if the node was created by the blend {Global node Level Boolean Defined Property}.
string nodeGlobalChangedPropName: The name of the property that will be set to True if the node had global properties changed by the blend {Global node Level Boolean Defined Property}.
string nodeChangedPropName: The name of the property that will be set to True if the node had local properties changed by the blend {Local node Level Boolean Defined Property}.
string nodeMovedPropName: The name of the property that will be set to True if the node was moved by the blend {Local node Level Boolean Defined Property}.
string leafPromotedPropName: The name of the property that will be set to True if the node was promoted from a leaf to a limb by the blend {Global node Level Boolean Defined Property}.
int userId: User name of the user who creates the object.
+Type Definition
<complexType name="BlenderType">
<sequence>
<element minOccurs="0" name="objectAccess" type="ObjectAccessEnum"/>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="sourceVersionName" type="string"/>
<element minOccurs="0" name="sourceVersionParams" type="VersionParamsType"/>
<element minOccurs="0" name="targetVersionName" type="string"/>
<element minOccurs="0" name="targetVersionParams" type="VersionParamsType"/>
<element minOccurs="0" name="createNewVersion" type="boolean"/>
<element minOccurs="0" name="newVersionName" type="string"/>
<element minOccurs="0" name="newVersionDescr" type="string"/>
<element minOccurs="0" name="blendAllHiers" type="boolean"/>
<element minOccurs="0" name="useDefaultForAllHiers" type="boolean"/>
<element minOccurs="0" name="allowHierCreation" type="boolean"/>
<element minOccurs="0" name="blenderPropList" type="BlenderPropListType"/>
<element minOccurs="0" name="processVersionValAssignments" type="boolean"/>
<element minOccurs="0" name="allowLeafPromotion" type="boolean"/>
<element minOccurs="0" name="disableRTValidation" type="boolean"/>
<element minOccurs="0" name="logFile" type="string"/>
<element minOccurs="0" name="maxErrors" type="int"/>
<element minOccurs="0" name="maxPasses" type="int"/>
<element minOccurs="0" name="hierSets" type="BlenderHierSetListType"/>
<element minOccurs="0" name="hierSetsId" type="int"/>
<element minOccurs="0" name="defaultProcessActivations" type="boolean"/>
<element minOccurs="0" name="defaultProcessAdds" type="boolean"/>
<element minOccurs="0" name="defaultProcessHierValAssignments" type="boolean"/>
<element minOccurs="0" name="defaultProcessRemoves" type="boolean"/>
<element minOccurs="0" name="defaultProcessStructure" type="boolean"/>
<element minOccurs="0" name="defaultPropSelectMode" type="PropSelectModeEnum"/>
<element minOccurs="0" name="defaultPropagateLocks" type="boolean"/>
<element minOccurs="0" name="defaultPropagateMode" type="ValuePropagateModeEnum"/>
<element minOccurs="0" name="defaultRemoveIndicatorPropName" type="string"/>
<element minOccurs="0" name="defaultRemoveMode" type="RemoveModeEnum"/>
<element minOccurs="0" name="defaultSelectedPropListId" type="int"/>
<element minOccurs="0" name="clearStatusProps" type="boolean"/>
<element minOccurs="0" name="populateStatusProps" type="boolean"/>
<element minOccurs="0" name="versionBlendedPropName" type="string"/>
<element minOccurs="0" name="hierBlendedPropName" type="string"/>
<element minOccurs="0" name="nodeGlobalAddedPropName" type="string"/>
<element minOccurs="0" name="nodeAddedPropName" type="string"/>
<element minOccurs="0" name="nodeGlobalChangedPropName" type="string"/>
<element minOccurs="0" name="nodeChangedPropName" type="string"/>
<element minOccurs="0" name="nodeMovedPropName" type="string"/>
<element minOccurs="0" name="leafPromotedPropName" type="string"/>
<element minOccurs="0" name="userId" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

BookItemType bookItem: One or more BookItemType objects.
+Type Definition
<complexType name="BookItemListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="bookItem" nillable="true" type="BookItemType"/>
</sequence>
</complexType>
Referenced By:

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
int bookItemIndex: Includes job information about the book item that was executed.
+Type Definition
<complexType name="BookItemResults">
<complexContent>
<extension base="JobResultRetrievalInputType">
<sequence>
<element name="bookItemIndex" type="int"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

ObjectAccessEnum objectAccess: Object access enumeration field.
string exportName: Name of the export.
int exportId: System-generated ID for the export.
int sortOrder: The order in which the export definition will appear in the book.
+Type Definition
<complexType name="BookItemType">
<sequence>
<element minOccurs="0" name="objectAccess" type="ObjectAccessEnum"/>
<element name="exportName" type="string"/>
<element minOccurs="0" name="exportId" type="int"/>
<element minOccurs="0" name="sortOrder" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

BookType book: Represents the response for a book type.
+Type Definition
<complexType name="BookResponseType">
<sequence>
<element name="book" type="BookType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ObjectAccessEnum objectAccess: Object access enumeration.
string name: Name of the book definition.
int id: The system-generated ID of the book.
string descr: Description of the object.
string displayLabel: The label of the book.
VersionParamsType currentVersionParams: The current version parameters. Parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
VersionParamsType previousVersionParams: The previous version parameters. Parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
boolean outputToClient: If set to True, then the output of the book run operation can be retrieved with the getBookResults operation. The result will be a ZIP file.
boolean combineIntoSinglefile: If True, then each export result that is run as a result of the book run is combined into one file.
string combinedFileConnection: The external connection name for the combined file.
string combinedFilename: The filename of the combined file.
string preFilename: The filename of the pre file.
string preFileConnection: The external connection name for the pre file Connection.
BookItemListType items: List of book items for this book.
string postFilename: The filename of the post file.
string postFileConnection: The external connection name for the post file Connection.
+Type Definition
<complexType name="BookType">
<sequence>
<element minOccurs="0" name="objectAccess" type="ObjectAccessEnum"/>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="displayLabel" type="string"/>
<element minOccurs="0" name="currentVersionParams" type="VersionParamsType"/>
<element minOccurs="0" name="previousVersionParams" type="VersionParamsType"/>
<element minOccurs="0" name="outputToClient" type="boolean"/>
<element minOccurs="0" name="combineIntoSinglefile" type="boolean"/>
<element minOccurs="0" name="combinedFileConnection" type="string"/>
<element minOccurs="0" name="combinedFilename" type="string"/>
<element minOccurs="0" name="preFilename" type="string"/>
<element minOccurs="0" name="preFileConnection" type="string"/>
<element minOccurs="0" name="items" type="BookItemListType"/>
<element minOccurs="0" name="postFilename" type="string"/>
<element minOccurs="0" name="postFileConnection" type="string"/>
</sequence>
</complexType>
Referenced By:
An enumeration for formatting booleans during an export. For example, if the BoolFormatEnum is specified as "YesNo," then the exported result will be either Yes or No as the result value.
+Type Definition
<simpleType name="BoolFormatEnum">
<restriction base="string">
<enumeration value="TrueFalse"/>
<enumeration value="TF"/>
<enumeration value="YesNo"/>
<enumeration value="YN"/>
<enumeration value="bf10"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
string propName: Property definition name.
BoolFormatEnum BoolFormat: Boolean Format Enumeration.
boolean Negate: Flag to return the opposite of the default value.
+Type Definition
<complexType name="BoolPropColumnType">
<complexContent>
<extension base="PropColumnType">
<sequence>
<element minOccurs="0" name="BoolFormat" type="BoolFormatEnum"/>
<element minOccurs="0" name="Negate" type="boolean"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
An enumeration indicating a True or False value for a param.
+Type Definition
<simpleType name="BooleanParamMethodEnum">
<restriction base="string">
<enumeration value="All"/>
<enumeration value="True"/>
<enumeration value="False"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
string fieldName: Property name for the column.
+Type Definition
<complexType name="CalculatedDataColumnType">
<complexContent>
<extension base="DataColumnType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
+Type Definition
<complexType name="CalculatedNodeColumnType">
<complexContent>
<extension base="NodeColumnType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
int level: Field indicating level of the node.
+Type Definition
<complexType name="CalculatedSequenceColumnType">
<complexContent>
<extension base="CalculatedNodeColumnType">
<sequence>
<element minOccurs="0" name="level" type="int"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
An enumeration indicating encoding to be used.
+Type Definition
<simpleType name="CharacterEncodingEnum">
<restriction base="string">
<enumeration value="UTF8"/>
<enumeration value="UTF16LE"/>
<enumeration value="UTF16BE"/>
<enumeration value="UTF32"/>
<enumeration value="UTF7"/>
<enumeration value="ASCII"/>
<enumeration value="ANSI"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

string versionName: Version name field.
+Type Definition
<complexType name="CloseVersion">
<sequence>
<element name="versionName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

CompareType compare: The compare object.
+Type Definition
<complexType name="CompareResponseType">
<sequence>
<element name="compare" type="CompareType"/>
</sequence>
</complexType>
Referenced By:

Fields:

CompareResultType compareResult: Results of a compare operation.
+Type Definition
<complexType name="CompareResultResponseType">
<sequence>
<element name="compareResult" type="CompareResultType"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryResultType fromResult: The from query result. The from contents can vary depending on the compare criteria. For example, for a structure, differences compare, the from result would include any node in the from version/hierarchy/node pair that was not present in the to version/hierarchy/node pair.
QueryResultType toResult: The to query result. The to contents can vary depending on the compare criteria. For example, for a structure, differences compare, the To result would include any node in the to version/hierarchy/node pair that was not present in the from version/hierarchy/node pair.
+Type Definition
<complexType name="CompareResultType">
<sequence>
<element minOccurs="0" name="fromResult" type="QueryResultType"/>
<element minOccurs="0" name="toResult" type="QueryResultType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string descr: Description of compare or query criteria.
boolean markNodes: Indicates that the result of the query or compare should Mark nodes.
boolean expandToMarkedNodes: Indicates that the result tree should be expanded.
boolean showList: Indicates that the result display should show a list of the results.
ObjectAccessEnum objectAccess: The object access of the compare.
string name: The compare definition name.
int id: The system-generated ID for the compare.
CompareTypeEnum compareType: Enumeration indicating a hierarchy, property, or rename compare type.
VersionParamsType fromVersionParams: Source parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction id.
VersionParamsType toVersionParams: Target parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
NodeLocatorType fromNode: The node in the hierarchy to use as a basis for the compare operation.
NodeLocatorType toNode: The node in the hierarchy to use as a basis for the compare operation.
boolean showDifferences: Flag indicating whether the compare result should show differences or similarities.
boolean compareLeafs: Flag indicating whether the compare operation should consider node leafs for processing.
boolean compareLimbs: Flag indicating if the compare operation should consider node limbs for processing.
StringListType propsToCompare: String list of properties to evaluate during a property compare.
boolean expandList: Flag indicating that the results should be expanded in the user interface.
FilterChildrenEnum filterChildren: Flag indicating if the compare should exclude or include children during the compare operation.
boolean isInclusive: Includes the node that is used in the criteria.
string joinProp: Field for the join property. By default, compares map nodes from each hierarchy that have the same name. You can also join nodes based on other properties. For example, if a property named SortCode has a unique key in the specified hierarchies, then this property is used to identify differences between nodes having the same SortCode in each hierarchy.
QueryType query: The query type to be used as a inclusion filter.
boolean checkForRename: A flag indicating whether the server should treat renamed nodes the same for comparison purposes.
boolean isUserDefined: Flag indicating if this is a user defined compare instead of a system defined compare. A user-defined compare is is usually created through the compare interface; a system compare can be created for compare or export purposes and does not show up in the compare select screen.
string userName: The user name that owns the compare.
int userId: The user ID of the user who owns the compare.
+Type Definition
<complexType name="CompareType">
<complexContent>
<extension base="BaseParamsType">
<sequence>
<element minOccurs="0" name="objectAccess" type="ObjectAccessEnum"/>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="compareType" type="CompareTypeEnum"/>
<element minOccurs="0" name="fromVersionParams" type="VersionParamsType"/>
<element minOccurs="0" name="toVersionParams" type="VersionParamsType"/>
<element minOccurs="0" name="fromNode" type="NodeLocatorType"/>
<element minOccurs="0" name="toNode" type="NodeLocatorType"/>
<element minOccurs="0" name="showDifferences" type="boolean"/>
<element minOccurs="0" name="compareLeafs" type="boolean"/>
<element minOccurs="0" name="compareLimbs" type="boolean"/>
<element minOccurs="0" name="propsToCompare" type="StringListType"/>
<element minOccurs="0" name="expandList" type="boolean"/>
<element minOccurs="0" name="filterChildren" type="FilterChildrenEnum"/>
<element minOccurs="0" name="isInclusive" type="boolean"/>
<element minOccurs="0" name="joinProp" type="string"/>
<element minOccurs="0" name="query" type="QueryType"/>
<element minOccurs="0" name="checkForRename" type="boolean"/>
<element minOccurs="0" name="isUserDefined" type="boolean"/>
<element minOccurs="0" name="userName" type="string"/>
<element minOccurs="0" name="userId" type="int"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
An enumeration indicating the type of compare.
+Type Definition
<simpleType name="CompareTypeEnum">
<restriction base="string">
<enumeration value="HierCompare"/>
<enumeration value="PropCompare"/>
<enumeration value="RenameCompare"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
A enumeration value indicating a logical operator.
+Type Definition
<simpleType name="ComparisonOperatorEnum">
<restriction base="string">
<enumeration value="Invalid"/>
<enumeration value="Equal"/>
<enumeration value="NotEqual"/>
<enumeration value="GreaterThan"/>
<enumeration value="GreaterThanEqual"/>
<enumeration value="LessThan"/>
<enumeration value="LessThanEqual"/>
<enumeration value="In"/>
<enumeration value="NotIn"/>
<enumeration value="Contains"/>
<enumeration value="NotContains"/>
<enumeration value="Like"/>
<enumeration value="UnLike"/>
<enumeration value="Above"/>
<enumeration value="NotAbove"/>
<enumeration value="Below"/>
<enumeration value="NotBelow"/>
<enumeration value="IsBlank"/>
<enumeration value="LenEqual"/>
<enumeration value="LenNotEqual"/>
<enumeration value="LenGreaterThan"/>
<enumeration value="LenGreaterThanEqual"/>
<enumeration value="LenLessThan"/>
<enumeration value="LenLessThanEqual"/>
<enumeration value="IsNumeric"/>
<enumeration value="IsNotNumeric"/>
<enumeration value="IsNotBlank"/>
<enumeration value="IsDefined"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
string ConstantValue: Represents a constant value for a export column.
+Type Definition
<complexType name="ConstantColumnType">
<complexContent>
<extension base="ExportColumnType">
<sequence>
<element minOccurs="0" name="ConstantValue" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string versionName:
string hierName:
+Type Definition
<complexType name="ControllingHierType">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
</sequence>
</complexType>

Fields:

string versionName: Version name of the source node.
string hierName: Hierarchy name of the source node.
string nodeName: Node name of the source node.
string targetHierName: Hierarchy name that the node will be copied to.
string targetParentName: Parent node that the new node will be inserted as a child.
+Type Definition
<complexType name="CopyNode">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element name="targetHierName" type="string"/>
<element minOccurs="0" name="targetParentName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeLocatorType sourceNodeLocator: Source locator indicating version, hierarchy and node.
NodeLocatorType targetNodeLocator: Target locator indicating version, hierarchy and node.
PropCopyModeEnum propCopyMode: Mode that indicates to the server which type of properties should be copied.
StringListType selectedPropNameList: If copy mode is set to selected; this list will contain the properties to copy.
+Type Definition
<complexType name="CopyNodeProps">
<sequence>
<element name="sourceNodeLocator" type="NodeLocatorType"/>
<element name="targetNodeLocator" type="NodeLocatorType"/>
<element minOccurs="0" name="propCopyMode" type="PropCopyModeEnum"/>
<element minOccurs="0" name="selectedPropNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string existingUserName: User name of the user to copy.
string userName: User name desired for the new user.
+Type Definition
<complexType name="CopyUser">
<sequence>
<element minOccurs="0" name="existingUserName" type="string"/>
<element minOccurs="0" name="userName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string sourceVersion: Name of the version to copy.
string targetVersion: Name of the new version.
string targetDescr: Description of the new version.
boolean clearApproval: Flag indicating whether the approval flags should be cleared.
boolean clearChanged: Flag indicating whether the changed on properties should be cleared.
boolean dbConnect: Flag indicating whether the version should be persisted to the data store.
+Type Definition
<complexType name="CopyVersion">
<sequence>
<element name="sourceVersion" type="string"/>
<element name="targetVersion" type="string"/>
<element name="targetDescr" type="string"/>
<element name="clearApproval" type="boolean"/>
<element name="clearChanged" type="boolean"/>
<element name="dbConnect" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

BlenderType blender: The input parameter for a blender.
+Type Definition
<complexType name="CreateBlender">
<sequence>
<element name="blender" type="BlenderType"/>
</sequence>
</complexType>
Referenced By:

Fields:

BookType book: The input parameter for a book.
+Type Definition
<complexType name="CreateBook">
<sequence>
<element name="book" type="BookType"/>
</sequence>
</complexType>
Referenced By:

Fields:

CompareType compare: The input parameter for creating a compare.
+Type Definition
<complexType name="CreateCompare">
<sequence>
<element name="compare" type="CompareType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ExportType export: The input parameter for creating an export.
+Type Definition
<complexType name="CreateExport">
<sequence>
<element name="export" type="ExportType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ImportType importDef: The input parameter for creating an import.
+Type Definition
<complexType name="CreateImport">
<sequence>
<element name="importDef" type="ImportType"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryType query: The input parameter for creating a query.
+Type Definition
<complexType name="CreateQuery">
<sequence>
<element name="query" type="QueryType"/>
</sequence>
</complexType>
Referenced By:

Fields:

RequestType request: The input parameter for creating a request.
+Type Definition
<complexType name="CreateRequest">
<sequence>
<element name="request" type="RequestType"/>
</sequence>
</complexType>
Referenced By:

Fields:

CustomExportParamType CustomExportParam: List type for a CustomExportParamType
+Type Definition
<complexType name="CustomExportParamListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="CustomExportParam" type="CustomExportParamType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string paramName: Parameter name field.
string paramValue: Parameter value field.
+Type Definition
<complexType name="CustomExportParamType">
<sequence>
<element minOccurs="0" name="paramName" type="string"/>
<element minOccurs="0" name="paramValue" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
string fieldName: Property name for the column.
+Type Definition
<complexType name="DataColumnType">
<complexContent>
<extension base="ExportColumnType">
<sequence>
<element minOccurs="0" name="fieldName" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Enumeration representing the DataType of a property definition.
+Type Definition
<simpleType name="DataTypeEnum">
<restriction base="string">
<enumeration value="Invalid"/>
<enumeration value="Boolean"/>
<enumeration value="LeafNode"/>
<enumeration value="Date"/>
<enumeration value="Time"/>
<enumeration value="Float"/>
<enumeration value="Integer"/>
<enumeration value="Sort"/>
<enumeration value="Group"/>
<enumeration value="Node"/>
<enumeration value="LimbNode"/>
<enumeration value="String"/>
<enumeration value="Hier"/>
<enumeration value="Version"/>
<enumeration value="DropDown"/>
<enumeration value="ValType"/>
<enumeration value="ListGroup"/>
<enumeration value="MultiNode"/>
<enumeration value="AscNode"/>
<enumeration value="AscNodes"/>
<enumeration value="AscGroup"/>
<enumeration value="Memo"/>
<enumeration value="FormatMemo"/>
<enumeration value="SortProp"/>
<enumeration value="Property"/>
<enumeration value="Query"/>
<enumeration value="StdQuery"/>
<enumeration value="GlobalNode"/>
<enumeration value="NodeProps"/>
<enumeration value="RangeList"/>
<enumeration value="DateTime"/>
<enumeration value="HyperLink"/>
<enumeration value="Role"/>
<enumeration value="User"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
Enumeration representing the type of DateParamsType.
+Type Definition
<simpleType name="DateParamMethodEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="Single"/>
<enumeration value="Range"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

DateParamMethodEnum method: Indicates whether this date type object represents a point in time or a range.
dateTime date: Date value.
dateTime endDate: End date in a range.
+Type Definition
<complexType name="DateParamsType">
<sequence>
<element name="method" type="DateParamMethodEnum"/>
<element name="date" type="dateTime"/>
<element minOccurs="0" name="endDate" type="dateTime"/>
</sequence>
</complexType>
Referenced By:

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
string propName: Property definition name.
string DateFormat: String representation indicating how the date is to be formatted.
+Type Definition
<complexType name="DatePropColumnType">
<complexContent>
<extension base="PropColumnType">
<sequence>
<element minOccurs="0" name="DateFormat" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Enumeration indicating what type of database field.
+Type Definition
<simpleType name="DbFieldTypeEnum">
<restriction base="string">
<enumeration value="String"/>
<enumeration value="Integer"/>
<enumeration value="Float"/>
<enumeration value="DateTime"/>
<enumeration value="Boolean"/>
<enumeration value="TextField"/>
<enumeration value="ByteArray"/>
<enumeration value="Object"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

string blenderName: Blender name to delete.
ObjectAccessEnum access: Object access of the blender to delete.
+Type Definition
<complexType name="DeleteBlender">
<sequence>
<element name="blenderName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string bookName: Book name to delete.
ObjectAccessEnum access: Object access of the book to delete.
+Type Definition
<complexType name="DeleteBook">
<sequence>
<element name="bookName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string compareName: Compare name to delete.
ObjectAccessEnum access: Object access of the compare to delete.
+Type Definition
<complexType name="DeleteCompare">
<sequence>
<element name="compareName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string exportName: Export name to delete.
ObjectAccessEnum access: Object access of the export to delete.
+Type Definition
<complexType name="DeleteExport">
<sequence>
<element name="exportName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string glyphName: Glyph name to delete.
+Type Definition
<complexType name="DeleteGlyph">
<sequence>
<element name="glyphName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
+Type Definition
<complexType name="DeleteHier">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string groupName: Name of the hierarchy group to delete.
+Type Definition
<complexType name="DeleteHierGroup">
<sequence>
<element name="groupName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string importName: Name of the import to delete.
ObjectAccessEnum access: Object access of the import to delete.
+Type Definition
<complexType name="DeleteImport">
<sequence>
<element name="importName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string mergeNodeName: Name of a node to merge with (if merging is desired and enabled).
boolean destroyNode: Flag indicating that the node should be permanently deleted if the node becomes an orphan after merging.
+Type Definition
<complexType name="DeleteNode">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element minOccurs="0" name="mergeNodeName" type="string"/>
<element minOccurs="0" name="destroyNode" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

string nodeAccessGroupName: Name of the node access group to delete.
+Type Definition
<complexType name="DeleteNodeAccessGroup">
<sequence>
<element name="nodeAccessGroupName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string nodeTypeName: Name of the node type to delete.
+Type Definition
<complexType name="DeleteNodeType">
<sequence>
<element name="nodeTypeName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of nodes to delete.
StringListType mergeNodeNameList: Name of the nodes to merge with (if merging is desired and enabled).
boolean destroyNodes: Flag indicating that the nodes should be permanently deleted if the nodes become orphans after merging.
+Type Definition
<complexType name="DeleteNodes">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeNameList" type="StringListType"/>
<element minOccurs="0" name="mergeNodeNameList" type="StringListType"/>
<element minOccurs="0" name="destroyNodes" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
StringListType nodeNames: List of orphan nodes to permanently delete.
StringListType mergeNodes: Name of the nodes to merge with (if merging is desired and enabled).
+Type Definition
<complexType name="DeleteOrphanNodes">
<sequence>
<element name="versionName" type="string"/>
<element name="nodeNames" type="StringListType"/>
<element name="mergeNodes" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string propCategoryName: Name of the property category to delete.
+Type Definition
<complexType name="DeletePropCategory">
<sequence>
<element name="propCategoryName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string propDefName: Name of the property definition to delete.
+Type Definition
<complexType name="DeletePropDef">
<sequence>
<element name="propDefName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string queryName: Name of the query to delete.
ObjectAccessEnum objectAccess: Object access of the query to delete.
+Type Definition
<complexType name="DeleteQuery">
<sequence>
<element name="queryName" type="string"/>
<element minOccurs="0" name="objectAccess" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

int requestId: ID of the request to delete.
+Type Definition
<complexType name="DeleteRequest">
<sequence>
<element name="requestId" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

string userName: User name of the user to delete.
+Type Definition
<complexType name="DeleteUser">
<sequence>
<element minOccurs="0" name="userName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string validationName: Name of the validation to delete.
+Type Definition
<complexType name="DeleteValidation">
<sequence>
<element minOccurs="0" name="validationName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string Message: Exception message.
int Code: Error code value for the message.
+Type Definition
<complexType name="DrmServiceException">
<sequence>
<element name="Message" type="string"/>
<element name="Code" type="int"/>
</sequence>
</complexType>
Referenced By:
Enumeration indicating the case desired for output of a export column value.
+Type Definition
<simpleType name="ExportColumnCaseEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="Upper"/>
<enumeration value="Lower"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
Enumeration indicating the justification desired for output of a export column value.
+Type Definition
<simpleType name="ExportColumnLayoutEnum">
<restriction base="string">
<enumeration value="Left"/>
<enumeration value="Right"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

ExportColumnType exportColumn: List of export column types.
+Type Definition
<complexType name="ExportColumnListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="exportColumn" nillable="true" type="ExportColumnType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
+Type Definition
<complexType name="ExportColumnType">
<sequence>
<element minOccurs="0" name="title" type="string"/>
<element minOccurs="0" name="layout" type="ExportColumnLayoutEnum"/>
<element minOccurs="0" name="layoutString" type="string"/>
<element minOccurs="0" name="changeCaseTo" type="ExportColumnCaseEnum"/>
<element minOccurs="0" name="excludeDefault" type="boolean"/>
<element minOccurs="0" name="defaultValue" type="string"/>
<element minOccurs="0" name="formatClass" type="string"/>
<element minOccurs="0" name="isPrimaryKey" type="boolean"/>
<element minOccurs="0" name="key" type="string"/>
<element minOccurs="0" name="pivot" type="boolean"/>
<element minOccurs="0" name="useQuotedStrings" type="boolean"/>
<element minOccurs="0" name="isFixedWidth" type="boolean"/>
<element minOccurs="0" name="width" type="int"/>
<element minOccurs="0" name="padChar" type="int"/>
<element minOccurs="0" name="dbFieldName" type="string"/>
<element minOccurs="0" name="dbFieldType" type="DbFieldTypeEnum"/>
<element minOccurs="0" name="dbFieldLen" type="int"/>
<element minOccurs="0" name="dbKeyField" type="boolean"/>
</sequence>
</complexType>
Type Hierarchy:
Referenced By:
Enumeration of what type of medium the export results should be exported to.
+Type Definition
<simpleType name="ExportOutputModeEnum">
<restriction base="string">
<enumeration value="File"/>
<enumeration value="Preview"/>
<enumeration value="Table"/>
<enumeration value="FTP"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

ExportType export: Export object type.
+Type Definition
<complexType name="ExportResponseType">
<sequence>
<element name="export" type="ExportType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ObjectAccessEnum objectAccess: Object access of the export.
string name: Name field of the export.
int id: The system-generated ID.
string descr: Description of the object.
string exportClass: The fully qualified class name of the export type, including namespace. Example: Oracle.Drm.Engine.Core.ExportManager.TransactionLogExport.
VersionParamsType currentVersionParams: Current version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
VersionParamsType previousVersionParams: The previous version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
boolean useQuotedStrings: Puts quotation marks around strings in the export.
string recordDelimiter: A sequence of characters used to specify the record boundary.
boolean useFixedWidth: Flag that indicates that the export is to be a fixed-width export.
boolean insertHeaderFooterBlankLines: Flag that instructs the server to add a line between the header/footer and the body of the export results.
CharacterEncodingEnum characterEncoding: Enumeration indicating encoding of the text file.
boolean hasColumnHeaders: Flag indicating that the export result should include column header label.
ExportColumnListType columns: List of columns to export.
CustomExportParamListType customParams: Parameter values used by custom exports.
string queryName: Name of the query to apply to the export.
string validationName: Name of the validation to apply to the export.
boolean includeInactive: Flag indicating that the export results should include inactive nodes.
ExportOutputModeEnum outputMode: Enumeration of what type of medium the export results should be exported to.
string fileName: Name of the file to be exported.
string includeFileConnection: External connection name to be used if exporting to a server device.
boolean dbClearOnVersion: If exporting to a database, indicates whether export table records with KeyFields containing this export's version ID will be deleted before inserting export output records.
boolean dbClearTable: If exporting to a database, clears the table before exporting.
string dbConnectionString: If exporting to a database, connection string to the database.
string dbExportDAL: The fully qualified name (including namespace) of the export data access layer class that implements IExportDalFactory. This class will be used to create the export DAL used for this export's output.
boolean dbOutputEnabled: Indicates whether the export's type allows its output to be directed to a database. Note that this is a read-only field as far as the API is concerned. Any value for this property that is set though the API will be ignored.
string dbPassword: (To be deprecated)
string dbTableName: If exporting to a database, database table name to export to.
boolean dbUseFastAppends: If exporting to a database, indicates whether the export DAL table will be populated more quickly by using the SQL BulkUpdate facility. This is based on provider support.
boolean dbUseFastDeletes: Indicates whether an export table with data will cleared more quickly by using a SQL table "truncate" command rather than line-by-line deleting of records.
boolean dbUseTransactions: Determines whether records for this export's output will be inserted inside a database transaction. This parameter will be used only when the output mode is Table.
string dbUserName: The database user name that will be used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string dbVendor: The database vendor string used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string delimiter: Delimits values in a row of export output.
string header: Header text for the export output.
string footer: Footer text for the export output.
StringListType fromList: Array of string values to replace in the export results. Currently three string items are supported.
string fromStrValue: A string value representing each item in the fromList array delimited by a comma.
StringListType toList: Array of string values that are replacing values for the values in the fromList field. Currently three string items are supported.
string toStrValue: A string value representing each item in the toList array delimited by a comma.
string userName: User name associated with this export.
int userId: User ID associated with this export.
boolean hasWarning: Indicates whether a WarningMessage has been encountered during this export's execution.
StringListType warningMessages: Warnings that were encountered during export execution.
+Type Definition
<complexType name="ExportType">
<sequence>
<element minOccurs="0" name="objectAccess" type="ObjectAccessEnum"/>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="exportClass" type="string"/>
<element minOccurs="0" name="currentVersionParams" type="VersionParamsType"/>
<element minOccurs="0" name="previousVersionParams" type="VersionParamsType"/>
<element minOccurs="0" name="useQuotedStrings" type="boolean"/>
<element minOccurs="0" name="recordDelimiter" type="string"/>
<element minOccurs="0" name="useFixedWidth" type="boolean"/>
<element minOccurs="0" name="insertHeaderFooterBlankLines" type="boolean"/>
<element minOccurs="0" name="characterEncoding" type="CharacterEncodingEnum"/>
<element minOccurs="0" name="hasColumnHeaders" type="boolean"/>
<element minOccurs="0" name="columns" type="ExportColumnListType"/>
<element minOccurs="0" name="customParams" type="CustomExportParamListType"/>
<element minOccurs="0" name="queryName" type="string"/>
<element minOccurs="0" name="validationName" type="string"/>
<element minOccurs="0" name="includeInactive" type="boolean"/>
<element minOccurs="0" name="outputMode" type="ExportOutputModeEnum"/>
<element minOccurs="0" name="fileName" type="string"/>
<element minOccurs="0" name="includeFileConnection" type="string"/>
<element minOccurs="0" name="dbClearOnVersion" type="boolean"/>
<element minOccurs="0" name="dbClearTable" type="boolean"/>
<element minOccurs="0" name="dbConnectionString" type="string"/>
<element minOccurs="0" name="dbExportDAL" type="string"/>
<element minOccurs="0" name="dbOutputEnabled" type="boolean"/>
<element minOccurs="0" name="dbPassword" type="string"/>
<element minOccurs="0" name="dbTableName" type="string"/>
<element minOccurs="0" name="dbUseFastAppends" type="boolean"/>
<element minOccurs="0" name="dbUseFastDeletes" type="boolean"/>
<element minOccurs="0" name="dbUseTransactions" type="boolean"/>
<element minOccurs="0" name="dbUserName" type="string"/>
<element minOccurs="0" name="dbVendor" type="string"/>
<element minOccurs="0" name="delimiter" type="string"/>
<element minOccurs="0" name="header" type="string"/>
<element minOccurs="0" name="footer" type="string"/>
<element minOccurs="0" name="fromList" type="StringListType"/>
<element minOccurs="0" name="fromStrValue" type="string"/>
<element minOccurs="0" name="toList" type="StringListType"/>
<element minOccurs="0" name="toStrValue" type="string"/>
<element minOccurs="0" name="userName" type="string"/>
<element minOccurs="0" name="userId" type="int"/>
<element minOccurs="0" name="hasWarning" type="boolean"/>
<element minOccurs="0" name="warningMessages" type="StringListType"/>
</sequence>
</complexType>
Type Hierarchy:
Referenced By:
A enumeration indicating that a compare or query should include children.
+Type Definition
<simpleType name="FilterChildrenEnum">
<restriction base="string">
<enumeration value="NonFiltered"/>
<enumeration value="Filtered"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
Enumeration used indicating the contents of the columns in a ScriptLoadParamsType.
+Type Definition
<simpleType name="FlatFileActionColEnum">
<restriction base="string">
<enumeration value="Action"/>
<enumeration value="Param1"/>
<enumeration value="Param2"/>
<enumeration value="Param3"/>
<enumeration value="Param4"/>
<enumeration value="Param5"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
Column type that represents ancestors node names of a given node.

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
string propName: Property definition name.
+Type Definition
<complexType name="GenAncestorPropColumnType">
<complexContent>
<extension base="GenPropColumnType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Column type for Generation exports; this column represents the sequence of ancestors.

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
int level: Field indicating level of the node.
+Type Definition
<complexType name="GenAncestorSequenceColumnType">
<complexContent>
<extension base="CalculatedSequenceColumnType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Column type for Generation exports; this column represents a node property column.

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
string propName: Property definition name.
+Type Definition
<complexType name="GenNodePropColumnType">
<complexContent>
<extension base="GenPropColumnType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
A base class for GenPreSequenceColumnType, GenPostSequenceColumn types.

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
int level: Field indicating level of the node.
+Type Definition
<complexType name="GenNodeSequenceColumnType">
<complexContent>
<extension base="CalculatedSequenceColumnType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Column type for properties to export at the end of each row.

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
string propName: Property definition name.
+Type Definition
<complexType name="GenPostPropColumnType">
<complexContent>
<extension base="GenPropColumnType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Column type for properties to export at the beginning of each row.

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
string propName: Property definition name.
+Type Definition
<complexType name="GenPrePropColumnType">
<complexContent>
<extension base="GenPropColumnType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Base class for GenNodePropColumnType, GenAncestorPropColumnType, GenPrePropColumnType, GenPostPropColumnType types.

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
string propName: Property definition name.
+Type Definition
<complexType name="GenPropColumnType">
<complexContent>
<extension base="PropColumnType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

ObjectAccessEnum objectAccess: Object access of the export.
string name: Name field of the export.
int id: The system-generated ID.
string descr: Description of the object.
string exportClass: The fully qualified class name of the export type, including namespace. Example: Oracle.Drm.Engine.Core.ExportManager.TransactionLogExport.
VersionParamsType currentVersionParams: Current version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
VersionParamsType previousVersionParams: The previous version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
boolean useQuotedStrings: Puts quotation marks around strings in the export.
string recordDelimiter: A sequence of characters used to specify the record boundary.
boolean useFixedWidth: Flag that indicates that the export is to be a fixed-width export.
boolean insertHeaderFooterBlankLines: Flag that instructs the server to add a line between the header/footer and the body of the export results.
CharacterEncodingEnum characterEncoding: Enumeration indicating encoding of the text file.
boolean hasColumnHeaders: Flag indicating that the export result should include column header label.
ExportColumnListType columns: List of columns to export.
CustomExportParamListType customParams: Parameter values used by custom exports.
string queryName: Name of the query to apply to the export.
string validationName: Name of the validation to apply to the export.
boolean includeInactive: Flag indicating that the export results should include inactive nodes.
ExportOutputModeEnum outputMode: Enumeration of what type of medium the export results should be exported to.
string fileName: Name of the file to be exported.
string includeFileConnection: External connection name to be used if exporting to a server device.
boolean dbClearOnVersion: If exporting to a database, indicates whether export table records with KeyFields containing this export's version ID will be deleted before inserting export output records.
boolean dbClearTable: If exporting to a database, clears the table before exporting.
string dbConnectionString: If exporting to a database, connection string to the database.
string dbExportDAL: The fully qualified name (including namespace) of the export data access layer class that implements IExportDalFactory. This class will be used to create the export DAL used for this export's output.
boolean dbOutputEnabled: Indicates whether the export's type allows its output to be directed to a database. Note that this is a read-only field as far as the API is concerned. Any value for this property that is set though the API will be ignored.
string dbPassword: (To be deprecated)
string dbTableName: If exporting to a database, database table name to export to.
boolean dbUseFastAppends: If exporting to a database, indicates whether the export DAL table will be populated more quickly by using the SQL BulkUpdate facility. This is based on provider support.
boolean dbUseFastDeletes: Indicates whether an export table with data will cleared more quickly by using a SQL table "truncate" command rather than line-by-line deleting of records.
boolean dbUseTransactions: Determines whether records for this export's output will be inserted inside a database transaction. This parameter will be used only when the output mode is Table.
string dbUserName: The database user name that will be used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string dbVendor: The database vendor string used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string delimiter: Delimits values in a row of export output.
string header: Header text for the export output.
string footer: Footer text for the export output.
StringListType fromList: Array of string values to replace in the export results. Currently three string items are supported.
string fromStrValue: A string value representing each item in the fromList array delimited by a comma.
StringListType toList: Array of string values that are replacing values for the values in the fromList field. Currently three string items are supported.
string toStrValue: A string value representing each item in the toList array delimited by a comma.
string userName: User name associated with this export.
int userId: User ID associated with this export.
boolean hasWarning: Indicates whether a WarningMessage has been encountered during this export's execution.
StringListType warningMessages: Warnings that were encountered during export execution.
int maxTopNodes: (To be deprecated)
NodeLocatorListType nodesToExpand: List of node locator objects to identify the top nodes to export from.
boolean pushDown: Flag to automatically repeat nodes down to the defined level in the export structure.
string pushDownNode: Constant to push the repeat nodes from: BottomLeaf, Bottom, Root are possible values.
boolean recurse: Select to include output for all nodes below the top node. If False, only the top node is included (which is typically not the desired result).
int bottomLevel: Determines the maximum depth of the export structure
string bottomLevelProp: Property that determines the maximum depth of the export structure. This value can be defined as a hierarchy-level, integer property
QueryType query: Query to include
boolean removeDuplicates: Select to use the primary key (defined on the column Options tab) to suppress.
string repeatNumProp: References a local, node-level, integer property that repeats a node within an export structure.
boolean tabbedTree: Set to True to indent the nodes for each level of a hierarchy using tab characters to produce a structured output format.
boolean includeLeafs: Flag to include leaf nodes in the export results.
boolean includeLimbs: Flag to include limb nodes in the export results.
IncludeFileModeEnum includeFileMode: Enumeration indicating whether the nodes located in the includeFileName should be included or excluded.
string includeFileName: The name of the file on the external connection to use for filtering (include or exclude) nodes.
boolean includeImplicitlySharedNodes: Set to True to include descendant nodes below shared limb nodes that are explicitly shared. Implicit shared nodes are exported only if not filtered out by another option.
QueryType exclusionQuery: Query to be used to exclude nodes.
int exclusionQueryId: Query ID to be used to exclude nodes.
StringListType genPreColumnList: String list of properties to export at the beginning of each row.
ExportColumnListType genPreColumns: Array of properties to export at the beginning of each row.
StringListType genAncestorColumnList: String list of node properties for the ancestor list of the specified bottom node.
ExportColumnListType genAncestorColumns: Array of node properties for the ancestor list of the specified bottom node
StringListType genNodeColumnList: String list of properties for the specified bottom node.
ExportColumnListType genNodeColumns: Array of properties for the specified bottom node.
StringListType genPostColumnList: String list of properties to export at the end of each row.
ExportColumnListType genPostColumns: Array of properties to export at the end of each row.
boolean groupRepeatedColumns: If set to True, repeated columns are grouped property in the ancestor columns.
boolean blankRepeatedLevels: Prevents repeated nodes from appearing in the output. If cleared, a node may be repeated in the output to achieve the specified level.
int maxSystemLevel: A threshold value to control the number of ancestors exported.
boolean processRootToNode: Select to set the export order (if not selected, the order is node to Root.) For example, if node A is a parent to node B and this option is selected, then the output is A,B. Otherwise, with this box unchecked, it is B,A.
boolean useInvertedLevelProp: The Oracle Essbase level methodology is used where the leaves are at 0 and count up. For a node that has multiple branches under it, the node is the largest of the possible values.
+Type Definition
<complexType name="GenerationExportType">
<complexContent>
<extension base="HierExportType">
<sequence>
<element minOccurs="0" name="exclusionQuery" type="QueryType"/>
<element minOccurs="0" name="exclusionQueryId" type="int"/>
<element minOccurs="0" name="genPreColumnList" type="StringListType"/>
<element minOccurs="0" name="genPreColumns" type="ExportColumnListType"/>
<element minOccurs="0" name="genAncestorColumnList" type="StringListType"/>
<element minOccurs="0" name="genAncestorColumns" type="ExportColumnListType"/>
<element minOccurs="0" name="genNodeColumnList" type="StringListType"/>
<element minOccurs="0" name="genNodeColumns" type="ExportColumnListType"/>
<element minOccurs="0" name="genPostColumnList" type="StringListType"/>
<element minOccurs="0" name="genPostColumns" type="ExportColumnListType"/>
<element minOccurs="0" name="groupRepeatedColumns" type="boolean"/>
<element minOccurs="0" name="blankRepeatedLevels" type="boolean"/>
<element minOccurs="0" name="maxSystemLevel" type="int"/>
<element minOccurs="0" name="processRootToNode" type="boolean"/>
<element minOccurs="0" name="useInvertedLevelProp" type="boolean"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string versionName: Version name field.
+Type Definition
<complexType name="GetAssignedGlobalValidations">
<sequence>
<element minOccurs="0" name="versionName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

ValidationListType validations: The assigned global node validations.
+Type Definition
<complexType name="GetAssignedGlobalValidationsResponse">
<sequence>
<element name="validations" type="ValidationListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

HierLocatorType hierLocator: Hierarchy locator object to identify a hierarchy within a version.
+Type Definition
<complexType name="GetAssignedHierValidations">
<sequence>
<element minOccurs="0" name="hierLocator" type="HierLocatorType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ValidationListType validations: Assigned hierarchy validations.
+Type Definition
<complexType name="GetAssignedHierValidationsResponse">
<sequence>
<element name="validations" type="ValidationListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeLocatorType nodeLocator: Node locator object representing a node within a hierarchy.
+Type Definition
<complexType name="GetAssignedNodeValidations">
<sequence>
<element minOccurs="0" name="nodeLocator" type="NodeLocatorType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ValidationListType validations: Assigned node validations.
+Type Definition
<complexType name="GetAssignedNodeValidationsResponse">
<sequence>
<element name="validations" type="ValidationListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
+Type Definition
<complexType name="GetAssignedVersionValidations">
<sequence>
<element minOccurs="0" name="versionName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

ValidationListType validations: Assigned version validations.
+Type Definition
<complexType name="GetAssignedVersionValidationsResponse">
<sequence>
<element name="validations" type="ValidationListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string blenderName: Blender name.
ObjectAccessEnum access: Object access of the blender.
+Type Definition
<complexType name="GetBlender">
<sequence>
<element name="blenderName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string bookName: Book name.
ObjectAccessEnum access: Object access of the book.
+Type Definition
<complexType name="GetBook">
<sequence>
<element name="bookName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

BookItemResults bookResults: Asynchronous job results of a book run.
+Type Definition
<complexType name="GetBookItemResults">
<sequence>
<element name="bookResults" type="BookItemResults"/>
</sequence>
</complexType>
Referenced By:

Fields:

string compareName: Compare name.
ObjectAccessEnum access: Object access of the compare.
+Type Definition
<complexType name="GetCompare">
<sequence>
<element name="compareName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
+Type Definition
<complexType name="GetControlledPropNames">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string exportName: Export name.
ObjectAccessEnum access: Object access of the export.
+Type Definition
<complexType name="GetExport">
<sequence>
<element name="exportName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: Enumeration indicating how the properties should be returned.
+Type Definition
<complexType name="GetGlobalNode">
<sequence>
<element name="versionName" type="string"/>
<element name="nodeName" type="string"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
<element minOccurs="0" name="returnPropValueListType" type="PropValueListTypeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum propValueListType: Enumeration indicating how the properties should be returned.
+Type Definition
<complexType name="GetGlobalNodePropValues">
<sequence>
<element name="versionName" type="string"/>
<element name="nodeName" type="string"/>
<element name="propNameList" type="StringListType"/>
<element name="propValueListType" type="PropValueListTypeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
+Type Definition
<complexType name="GetGlobalNodeProps">
<sequence>
<element name="versionName" type="string"/>
<element name="nodeName" type="string"/>
<element name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

GlobalNodeLocatorType globalNodeLocator: Global node locator object to identify a global node.
+Type Definition
<complexType name="GetGlobalNodeRefCount">
<sequence>
<element name="globalNodeLocator" type="GlobalNodeLocatorType"/>
</sequence>
</complexType>
Referenced By:

Fields:

GlobalNodeLocatorType globalNodeLocator: Global node locator object to identify a global node.
+Type Definition
<complexType name="GetGlobalNodeReferences">
<sequence>
<element name="globalNodeLocator" type="GlobalNodeLocatorType"/>
</sequence>
</complexType>
Referenced By:

Fields:

GlobalNodeRefsResponseType references: List of hierarchies in which the node exists (including current).
+Type Definition
<complexType name="GetGlobalNodeReferencesResponse">
<sequence>
<element name="references" type="GlobalNodeRefsResponseType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
StringListType nodeNameList: List of node names to retrieve.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: Enumeration indicating how the properties should be returned.
+Type Definition
<complexType name="GetGlobalNodes">
<sequence>
<element name="versionName" type="string"/>
<element name="nodeNameList" type="StringListType"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
<element minOccurs="0" name="returnPropValueListType" type="PropValueListTypeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string glyphName: Name of the glyph to return.
+Type Definition
<complexType name="GetGlyph">
<sequence>
<element name="glyphName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

GlyphType glyph: Glyph type object.
+Type Definition
<complexType name="GetGlyphResponse">
<sequence>
<element name="glyph" type="GlyphType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
+Type Definition
<complexType name="GetHier">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: The hierarchy group name to return.
+Type Definition
<complexType name="GetHierGroup">
<sequence>
<element name="name" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
+Type Definition
<complexType name="GetHierNames">
<sequence>
<element name="versionName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Type Definition
<complexType name="GetHierPropValues">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="propNameList" type="StringListType"/>
<element name="returnPropValueListType" type="PropValueListTypeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType propNameList: List of properties to return.
+Type Definition
<complexType name="GetHierProps">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Type Definition
<complexType name="GetHierTopNode">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
<element minOccurs="0" name="returnPropValueListType" type="PropValueListTypeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
StringListType hierNameList: List of hierarchies to return.
+Type Definition
<complexType name="GetHiers">
<sequence>
<element name="versionName" type="string"/>
<element minOccurs="0" name="hierNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string importName: The import name to return.
ObjectAccessEnum access: The object access of the import.
+Type Definition
<complexType name="GetImport">
<sequence>
<element name="importName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

LogCriteriaType logCriteria: An object representing criteria for transaction history.
+Type Definition
<complexType name="GetLogItems">
<sequence>
<element name="logCriteria" type="LogCriteriaType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Type Definition
<complexType name="GetNode">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
<element minOccurs="0" name="returnPropValueListType" type="PropValueListTypeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string nodeAccessGroupName: Node access group name to return.
+Type Definition
<complexType name="GetNodeAccessGroup">
<sequence>
<element name="nodeAccessGroupName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeAccessGroupType nodeAccessGroup: An object representing a node access group.
+Type Definition
<complexType name="GetNodeAccessGroupResponse">
<sequence>
<element name="nodeAccessGroup" type="NodeAccessGroupType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string nodeAccessGroupName: Node access group name.
+Type Definition
<complexType name="GetNodeAccessGroupUserList">
<sequence>
<element name="nodeAccessGroupName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeLocatorType nodeLocator: Node locator object representing a node within a hierarchy and version.
+Type Definition
<complexType name="GetNodeAccessLevel">
<sequence>
<element name="nodeLocator" type="NodeLocatorType"/>
</sequence>
</complexType>
Referenced By:

Fields:

HierLocatorType hierLocator: A hierarchy locator object representing a hierarchy in a version.
string name: The name of the node to return.
+Type Definition
<complexType name="GetNodeByID">
<sequence>
<element name="hierLocator" type="HierLocatorType"/>
<element name="name" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Type Definition
<complexType name="GetNodePropValues">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element name="propNameList" type="StringListType"/>
<element name="returnPropValueListType" type="PropValueListTypeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
+Type Definition
<complexType name="GetNodeProps">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType propNameList: List of properties to return.
+Type Definition
<complexType name="GetNodeWithProps">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of node names.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Type Definition
<complexType name="GetNodes">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeNameList" type="StringListType"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
<element minOccurs="0" name="returnPropValueListType" type="PropValueListTypeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
StringListType requestedProps: List of properties to return.
int maxNodes: The maximum number of nodes to return in the result.
+Type Definition
<complexType name="GetOrphanNodes">
<sequence>
<element name="versionName" type="string"/>
<element name="requestedProps" type="StringListType"/>
<element name="maxNodes" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

GlobalQueryResponseType queryResults: A global query result.
+Type Definition
<complexType name="GetOrphanNodesResponse">
<sequence>
<element name="queryResults" type="GlobalQueryResponseType"/>
</sequence>
</complexType>
Referenced By:

Fields:

PropCategoryListType propCategoryListType: List type object representing property categories.
+Type Definition
<complexType name="GetPropCategoriesResponse">
<sequence>
<element name="propCategoryListType" type="PropCategoryListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string propDefName: The name of the property definition to retrieve.
+Type Definition
<complexType name="GetPropDef">
<sequence>
<element minOccurs="0" name="propDefName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

ObjectScopeEnum propDefLevel: An enumeration indicating the scope of the property definition.
+Type Definition
<complexType name="GetPropDefNames">
<sequence>
<element minOccurs="0" name="propDefLevel" type="ObjectScopeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

ObjectScopeEnum propDefLevel: An enumeration indicating the scope of the property definition.
+Type Definition
<complexType name="GetPropDefs">
<sequence>
<element minOccurs="0" name="propDefLevel" type="ObjectScopeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string categoryName: Property category name.
+Type Definition
<complexType name="GetPropDefsByCategory">
<sequence>
<element name="categoryName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

PropDefListType propDefs: Array of property definition objects.
+Type Definition
<complexType name="GetPropDefsByCategoryResponse">
<sequence>
<element name="propDefs" type="PropDefListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

boolean global: Flag indicating if global queries should be returned.
StringListType queryNameList: The list of queries to return.
+Type Definition
<complexType name="GetQueries">
<sequence>
<element minOccurs="0" name="global" type="boolean"/>
<element name="queryNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string queryName: The name of the query.
ObjectAccessEnum access: The object access of the query.
+Type Definition
<complexType name="GetQuery">
<sequence>
<element name="queryName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
RelationshipEnum relationship: An enumeration indicating what types of nodes to return (Children, Descendants, and so on).
boolean visibleOnly: Flag indicating that visible children should only be returned.
boolean includeLeaves: Flag to include leaf nodes.
+Type Definition
<complexType name="GetRelatedNodeCount">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element name="relationship" type="RelationshipEnum"/>
<element minOccurs="0" name="visibleOnly" type="boolean"/>
<element minOccurs="0" name="includeLeaves" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).
+Type Definition
<complexType name="GetRelatedNodeNames">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element name="relationship" type="RelationshipEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Type Definition
<complexType name="GetRelatedNodes">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element name="relationship" type="RelationshipEnum"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
<element minOccurs="0" name="returnPropValueListType" type="PropValueListTypeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
RelationshipEnum relationship: An enumeration indicating what types of nodes to return (i.e. Children, Descendants, etc).
StringListType propNameList: List of properties to return.
+Type Definition
<complexType name="GetRelatedNodesWithProps">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element name="relationship" type="RelationshipEnum"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string externalId: The free-form field on a request object.
+Type Definition
<complexType name="GetRequestByExternalId">
<sequence>
<element name="externalId" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

int requestId: The system-generated ID for a request.
+Type Definition
<complexType name="GetRequestById">
<sequence>
<element name="requestId" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

LogCriteriaType logCriteria: An object representing criteria for transaction history.
+Type Definition
<complexType name="GetScriptFromLog">
<sequence>
<element name="logCriteria" type="LogCriteriaType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ActionItemListType getScriptFromLogResponse: List of action item objects.
+Type Definition
<complexType name="GetScriptFromLogResponse">
<sequence>
<element name="getScriptFromLogResponse" type="ActionItemListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string nodeName: Node name field.
string newNodeName: The new node name to create.
string newNodeDescr: The new node description.
StringListType hierNameList: The list of hierarchies the existing node exists in.
PropCopyModeEnum propCopyMode: An enumeration indicating what type of properties should be included.
StringListType propNameList: If the copy mode is selected then this list of properties will be evaluated in the node model operation.
+Type Definition
<complexType name="GetScriptFromModel">
<sequence>
<element minOccurs="0" name="versionName" type="string"/>
<element minOccurs="0" name="nodeName" type="string"/>
<element minOccurs="0" name="newNodeName" type="string"/>
<element minOccurs="0" name="newNodeDescr" type="string"/>
<element minOccurs="0" name="hierNameList" type="StringListType"/>
<element minOccurs="0" name="propCopyMode" type="PropCopyModeEnum"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ActionItemListType getScriptFromModelResponse: List of action items.
+Type Definition
<complexType name="GetScriptFromModelResponse">
<sequence>
<element name="getScriptFromModelResponse" type="ActionItemListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string systemPreferenceName: The name of the system preference to return.
+Type Definition
<complexType name="GetSysPrefValue">
<sequence>
<element name="systemPreferenceName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

StringResponseType result: The result of the GetSysPrefValue operation.
+Type Definition
<complexType name="GetSysPrefValueResponse">
<sequence>
<element name="result" type="StringResponseType"/>
</sequence>
</complexType>
Referenced By:

Fields:

SystemPreferenceListType systemPreferences: The list result of system preference values.
+Type Definition
<complexType name="GetSysPrefsResponse">
<sequence>
<element name="systemPreferences" type="SystemPreferenceListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string userName: The user name of the user to retrieve.
+Type Definition
<complexType name="GetUser">
<sequence>
<element minOccurs="0" name="userName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

UserType user: Represents a user object.
+Type Definition
<complexType name="GetUserResponse">
<sequence>
<element minOccurs="0" name="user" type="UserType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string validationName: The name of the validation to retrieve.
+Type Definition
<complexType name="GetValidation">
<sequence>
<element name="validationName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

ValidationDefinitionType validation: The validation object.
+Type Definition
<complexType name="GetValidationResponse">
<sequence>
<element name="validation" type="ValidationDefinitionType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ValidationListType validations: An array of validation objects.
+Type Definition
<complexType name="GetValidationsResponse">
<sequence>
<element name="validations" type="ValidationListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
+Type Definition
<complexType name="GetVersion">
<sequence>
<element name="versionName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
StringListType propNameList: List of properties to return.
PropValueListTypeEnum returnPropValueListType: An enumeration indicating how the properties should be returned.
+Type Definition
<complexType name="GetVersionPropValues">
<sequence>
<element name="versionName" type="string"/>
<element name="propNameList" type="StringListType"/>
<element name="returnPropValueListType" type="PropValueListTypeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
StringListType propNameList: List of properties to return.
+Type Definition
<complexType name="GetVersionProps">
<sequence>
<element name="versionName" type="string"/>
<element name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

StringListType versionNameList: A list of version names.
+Type Definition
<complexType name="GetVersions">
<sequence>
<element minOccurs="0" name="versionNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string nodeName: Node name field.
+Type Definition
<complexType name="GlobalNodeLocatorType">
<sequence>
<element minOccurs="0" name="versionName" type="string"/>
<element minOccurs="0" name="nodeName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeTypeListType nodes: The list of node objects.
+Type Definition
<complexType name="GlobalNodeRefsResponseType">
<sequence>
<element name="nodes" type="NodeTypeListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

GlobalNodeType queryResult:
+Type Definition
<complexType name="GlobalNodeResponseType">
<sequence>
<element name="queryResult" type="GlobalNodeType"/>
</sequence>
</complexType>

Fields:

string name: The name of the node.
int id: The system-generated ID of the node.
string descr: Description of the object.
string versionName: Version name field.
boolean isLeaf: Field indicating if node is a Leaf node.
boolean isInactive: Flag indicating that the node is inactive.
int childCount: The number of children the node has.
boolean isNodeApproved: Flag indicating that the node has been approved.
+Type Definition
<complexType name="GlobalNodeType">
<sequence>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="descr" type="string"/>
<element name="versionName" type="string"/>
<element minOccurs="0" name="isLeaf" type="boolean"/>
<element minOccurs="0" name="isInactive" type="boolean"/>
<element minOccurs="0" name="childCount" type="int"/>
<element minOccurs="0" name="isNodeApproved" type="boolean"/>
</sequence>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

GlobalNodeWithPropValuesListType globalNodeList: An array of global nodes.
+Type Definition
<complexType name="GlobalNodeWithPropValuesListResponseType">
<sequence>
<element name="globalNodeList" type="GlobalNodeWithPropValuesListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

GlobalNodeWithPropValuesType globalNodeWithPropValues: List of global nodes and their properties.
+Type Definition
<complexType name="GlobalNodeWithPropValuesListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="globalNodeWithPropValues" nillable="true" type="GlobalNodeWithPropValuesType"/>
</sequence>
</complexType>
Referenced By:

Fields:

GlobalNodeWithPropValuesType globalNode: A response object that represents a global node object and property values.
+Type Definition
<complexType name="GlobalNodeWithPropValuesResponseType">
<sequence>
<element name="globalNode" type="GlobalNodeWithPropValuesType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: The name of the node.
int id: The system-generated ID of the node.
string descr: Description of the object.
string versionName: Version name field.
boolean isLeaf: Field indicating if node is a Leaf node.
boolean isInactive: Flag indicating that the node is inactive.
int childCount: The number of children the node has.
boolean isNodeApproved: Flag indicating that the node has been approved.
PropValueFlexListType propValueList: A list of property values.
+Type Definition
<complexType name="GlobalNodeWithPropValuesType">
<complexContent>
<extension base="GlobalNodeType">
<sequence>
<element minOccurs="0" name="propValueList" type="PropValueFlexListType"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

GlobalQueryResultType globalQueryResult: A query results for a global query.
+Type Definition
<complexType name="GlobalQueryResponseType">
<sequence>
<element name="globalQueryResult" type="GlobalQueryResultType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
int nodeCount: The number of nodes in the result.
GlobalNodeWithPropValuesListType nodes: An list type that represents the global nodes for the result.
boolean maxNodesExceeded: Flag indicating that the maximum number of nodes threshold was reached during the query run.
StringListType requestedPropNames: List of properties to return.
+Type Definition
<complexType name="GlobalQueryResultType">
<sequence>
<element minOccurs="0" name="versionName" type="string"/>
<element minOccurs="0" name="nodeCount" type="int"/>
<element minOccurs="0" name="nodes" type="GlobalNodeWithPropValuesListType"/>
<element minOccurs="0" name="maxNodesExceeded" type="boolean"/>
<element minOccurs="0" name="requestedPropNames" type="StringListType"/>
</sequence>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string name: The name of the glyph.
int id: The system-generated ID of the glyph.
string descr: Description of the glyph.
string imageData: Base-64 string value of the byte data.
ImageTypeEnum imageTypeEnum: An enumeration indicating the image type; currently supported image types are PNG.
+Type Definition
<complexType name="GlyphType">
<sequence>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="imageData" type="string"/>
<element minOccurs="0" name="imageTypeEnum" type="ImageTypeEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string hierDescr: The hierarchy description.
string topNodeName: The name of the top node.
string topNodeDescr: The description of the top node.
+Type Definition
<complexType name="HierAddRequestItemType">
<complexContent>
<extension base="HierRequestItemType">
<sequence>
<element minOccurs="0" name="hierDescr" type="string"/>
<element name="topNodeName" type="string"/>
<element minOccurs="0" name="topNodeDescr" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

ObjectAccessEnum objectAccess: Object access of the export.
string name: Name field of the export.
int id: The system-generated ID.
string descr: Description of the object.
string exportClass: The fully qualified class name of the export type, including namespace. Example: Oracle.Drm.Engine.Core.ExportManager.TransactionLogExport.
VersionParamsType currentVersionParams: Current version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
VersionParamsType previousVersionParams: The previous version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
boolean useQuotedStrings: Puts quotation marks around strings in the export.
string recordDelimiter: A sequence of characters used to specify the record boundary.
boolean useFixedWidth: Flag that indicates that the export is to be a fixed-width export.
boolean insertHeaderFooterBlankLines: Flag that instructs the server to add a line between the header/footer and the body of the export results.
CharacterEncodingEnum characterEncoding: Enumeration indicating encoding of the text file.
boolean hasColumnHeaders: Flag indicating that the export result should include column header label.
ExportColumnListType columns: List of columns to export.
CustomExportParamListType customParams: Parameter values used by custom exports.
string queryName: Name of the query to apply to the export.
string validationName: Name of the validation to apply to the export.
boolean includeInactive: Flag indicating that the export results should include inactive nodes.
ExportOutputModeEnum outputMode: Enumeration of what type of medium the export results should be exported to.
string fileName: Name of the file to be exported.
string includeFileConnection: External connection name to be used if exporting to a server device.
boolean dbClearOnVersion: If exporting to a database, indicates whether export table records with KeyFields containing this export's version ID will be deleted before inserting export output records.
boolean dbClearTable: If exporting to a database, clears the table before exporting.
string dbConnectionString: If exporting to a database, connection string to the database.
string dbExportDAL: The fully qualified name (including namespace) of the export data access layer class that implements IExportDalFactory. This class will be used to create the export DAL used for this export's output.
boolean dbOutputEnabled: Indicates whether the export's type allows its output to be directed to a database. Note that this is a read-only field as far as the API is concerned. Any value for this property that is set though the API will be ignored.
string dbPassword: (To be deprecated)
string dbTableName: If exporting to a database, database table name to export to.
boolean dbUseFastAppends: If exporting to a database, indicates whether the export DAL table will be populated more quickly by using the SQL BulkUpdate facility. This is based on provider support.
boolean dbUseFastDeletes: Indicates whether an export table with data will cleared more quickly by using a SQL table "truncate" command rather than line-by-line deleting of records.
boolean dbUseTransactions: Determines whether records for this export's output will be inserted inside a database transaction. This parameter will be used only when the output mode is Table.
string dbUserName: The database user name that will be used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string dbVendor: The database vendor string used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string delimiter: Delimits values in a row of export output.
string header: Header text for the export output.
string footer: Footer text for the export output.
StringListType fromList: Array of string values to replace in the export results. Currently three string items are supported.
string fromStrValue: A string value representing each item in the fromList array delimited by a comma.
StringListType toList: Array of string values that are replacing values for the values in the fromList field. Currently three string items are supported.
string toStrValue: A string value representing each item in the toList array delimited by a comma.
string userName: User name associated with this export.
int userId: User ID associated with this export.
boolean hasWarning: Indicates whether a WarningMessage has been encountered during this export's execution.
StringListType warningMessages: Warnings that were encountered during export execution.
CompareType compare: A compare type for this hierarchy compare export.
boolean includeAdditions: Includes all nodes in the target (to) hierarchy that are not in the source (from) hierarchy.
string addCode: Export specific code for a node addition that will be exported for the node.
boolean includePropUpdates: Includes all nodes that have different values in the specified list of properties in the compared hierarchies.
string propUpdateCode: Export specific code that will be exported for the node if the node has been added.
boolean includeMoves: Includes all nodes that have different parent nodes in the compared hierarchies.
string moveCode: Export specific code that will be exported for the node if the node has been moved.
boolean includeDeletions: Includes all nodes in the source (from) hierarchy that are not in the target (to) hierarchy.
string deletionCode: Export specific code that will be exported for the node if the node has been deleted.
boolean includeRenames: Includes all nodes that have different names but the same internal nodeID in the compared hierarchies.
string renameCode: Export specific code that will be exported for the node if the node has been renamed.
boolean includeMerges: Includes merge information in the export (if the merge feature is enabled).
string mergeCode: Export specific code that will be exported for the node if the node has been merged.
boolean removeDuplicates: Select to use the primary key (defined on the column Options tab) to suppress.
QueryType exclusionQueryName: Query name to be used to exclude nodes with.
int exclusionQueryId: Query ID to be used to exclude nodes with.
+Type Definition
<complexType name="HierCompareExportType">
<complexContent>
<extension base="ExportType">
<sequence>
<element minOccurs="0" name="compare" type="CompareType"/>
<element minOccurs="0" name="includeAdditions" type="boolean"/>
<element minOccurs="0" name="addCode" type="string"/>
<element minOccurs="0" name="includePropUpdates" type="boolean"/>
<element minOccurs="0" name="propUpdateCode" type="string"/>
<element minOccurs="0" name="includeMoves" type="boolean"/>
<element minOccurs="0" name="moveCode" type="string"/>
<element minOccurs="0" name="includeDeletions" type="boolean"/>
<element minOccurs="0" name="deletionCode" type="string"/>
<element minOccurs="0" name="includeRenames" type="boolean"/>
<element minOccurs="0" name="renameCode" type="string"/>
<element minOccurs="0" name="includeMerges" type="boolean"/>
<element minOccurs="0" name="mergeCode" type="string"/>
<element minOccurs="0" name="removeDuplicates" type="boolean"/>
<element minOccurs="0" name="exclusionQueryName" type="QueryType"/>
<element minOccurs="0" name="exclusionQueryId" type="int"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

ObjectAccessEnum objectAccess: Object access of the export.
string name: Name field of the export.
int id: The system-generated ID.
string descr: Description of the object.
string exportClass: The fully qualified class name of the export type, including namespace. Example: Oracle.Drm.Engine.Core.ExportManager.TransactionLogExport.
VersionParamsType currentVersionParams: Current version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
VersionParamsType previousVersionParams: The previous version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
boolean useQuotedStrings: Puts quotation marks around strings in the export.
string recordDelimiter: A sequence of characters used to specify the record boundary.
boolean useFixedWidth: Flag that indicates that the export is to be a fixed-width export.
boolean insertHeaderFooterBlankLines: Flag that instructs the server to add a line between the header/footer and the body of the export results.
CharacterEncodingEnum characterEncoding: Enumeration indicating encoding of the text file.
boolean hasColumnHeaders: Flag indicating that the export result should include column header label.
ExportColumnListType columns: List of columns to export.
CustomExportParamListType customParams: Parameter values used by custom exports.
string queryName: Name of the query to apply to the export.
string validationName: Name of the validation to apply to the export.
boolean includeInactive: Flag indicating that the export results should include inactive nodes.
ExportOutputModeEnum outputMode: Enumeration of what type of medium the export results should be exported to.
string fileName: Name of the file to be exported.
string includeFileConnection: External connection name to be used if exporting to a server device.
boolean dbClearOnVersion: If exporting to a database, indicates whether export table records with KeyFields containing this export's version ID will be deleted before inserting export output records.
boolean dbClearTable: If exporting to a database, clears the table before exporting.
string dbConnectionString: If exporting to a database, connection string to the database.
string dbExportDAL: The fully qualified name (including namespace) of the export data access layer class that implements IExportDalFactory. This class will be used to create the export DAL used for this export's output.
boolean dbOutputEnabled: Indicates whether the export's type allows its output to be directed to a database. Note that this is a read-only field as far as the API is concerned. Any value for this property that is set though the API will be ignored.
string dbPassword: (To be deprecated)
string dbTableName: If exporting to a database, database table name to export to.
boolean dbUseFastAppends: If exporting to a database, indicates whether the export DAL table will be populated more quickly by using the SQL BulkUpdate facility. This is based on provider support.
boolean dbUseFastDeletes: Indicates whether an export table with data will cleared more quickly by using a SQL table "truncate" command rather than line-by-line deleting of records.
boolean dbUseTransactions: Determines whether records for this export's output will be inserted inside a database transaction. This parameter will be used only when the output mode is Table.
string dbUserName: The database user name that will be used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string dbVendor: The database vendor string used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string delimiter: Delimits values in a row of export output.
string header: Header text for the export output.
string footer: Footer text for the export output.
StringListType fromList: Array of string values to replace in the export results. Currently three string items are supported.
string fromStrValue: A string value representing each item in the fromList array delimited by a comma.
StringListType toList: Array of string values that are replacing values for the values in the fromList field. Currently three string items are supported.
string toStrValue: A string value representing each item in the toList array delimited by a comma.
string userName: User name associated with this export.
int userId: User ID associated with this export.
boolean hasWarning: Indicates whether a WarningMessage has been encountered during this export's execution.
StringListType warningMessages: Warnings that were encountered during export execution.
CompareType compare: A compare type for this hierarchy compare export.
int nodeNameWidth: The width of the name column in the export results.
int parentNameWidth: The width of the parent column in the export results.
boolean includeAdditions: Includes all nodes in the target (to) hierarchy that are not in the source (from) hierarchy.
boolean includeDeletions: Includes all nodes in the source (from) hierarchy that are not in the target (to) hierarchy.
boolean inlcudeMergeNodes: Includes merge information in the export (if the merge feature is enabled.)
boolean includePropUpdates: Includes all nodes that have different values in the specified list of properties in the compared hierarchies.
boolean includeRenames: Includes all nodes that have different names but the same internal nodeID in the compared hierarchies.
boolean inlcudeStructureChanges: A structure section will be exported if there are structural changes between the source and target.
boolean includeSummary: Include a summary of the differences in the export result. Example: #Additions, #Deletions, #New, #Structure, #Old
ExportColumnListType extraColumns: (To be deprecated)
+Type Definition
<complexType name="HierDiffExportType">
<complexContent>
<extension base="ExportType">
<sequence>
<element minOccurs="0" name="compare" type="CompareType"/>
<element minOccurs="0" name="nodeNameWidth" type="int"/>
<element minOccurs="0" name="parentNameWidth" type="int"/>
<element minOccurs="0" name="includeAdditions" type="boolean"/>
<element minOccurs="0" name="includeDeletions" type="boolean"/>
<element minOccurs="0" name="inlcudeMergeNodes" type="boolean"/>
<element minOccurs="0" name="includePropUpdates" type="boolean"/>
<element minOccurs="0" name="includeRenames" type="boolean"/>
<element minOccurs="0" name="inlcudeStructureChanges" type="boolean"/>
<element minOccurs="0" name="includeSummary" type="boolean"/>
<element minOccurs="0" name="extraColumns" type="ExportColumnListType"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

ObjectAccessEnum objectAccess: Object access of the export.
string name: Name field of the export.
int id: The system-generated ID.
string descr: Description of the object.
string exportClass: The fully qualified class name of the export type, including namespace. Example: Oracle.Drm.Engine.Core.ExportManager.TransactionLogExport.
VersionParamsType currentVersionParams: Current version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
VersionParamsType previousVersionParams: The previous version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
boolean useQuotedStrings: Puts quotation marks around strings in the export.
string recordDelimiter: A sequence of characters used to specify the record boundary.
boolean useFixedWidth: Flag that indicates that the export is to be a fixed-width export.
boolean insertHeaderFooterBlankLines: Flag that instructs the server to add a line between the header/footer and the body of the export results.
CharacterEncodingEnum characterEncoding: Enumeration indicating encoding of the text file.
boolean hasColumnHeaders: Flag indicating that the export result should include column header label.
ExportColumnListType columns: List of columns to export.
CustomExportParamListType customParams: Parameter values used by custom exports.
string queryName: Name of the query to apply to the export.
string validationName: Name of the validation to apply to the export.
boolean includeInactive: Flag indicating that the export results should include inactive nodes.
ExportOutputModeEnum outputMode: Enumeration of what type of medium the export results should be exported to.
string fileName: Name of the file to be exported.
string includeFileConnection: External connection name to be used if exporting to a server device.
boolean dbClearOnVersion: If exporting to a database, indicates whether export table records with KeyFields containing this export's version ID will be deleted before inserting export output records.
boolean dbClearTable: If exporting to a database, clears the table before exporting.
string dbConnectionString: If exporting to a database, connection string to the database.
string dbExportDAL: The fully qualified name (including namespace) of the export data access layer class that implements IExportDalFactory. This class will be used to create the export DAL used for this export's output.
boolean dbOutputEnabled: Indicates whether the export's type allows its output to be directed to a database. Note that this is a read-only field as far as the API is concerned. Any value for this property that is set though the API will be ignored.
string dbPassword: (To be deprecated)
string dbTableName: If exporting to a database, database table name to export to.
boolean dbUseFastAppends: If exporting to a database, indicates whether the export DAL table will be populated more quickly by using the SQL BulkUpdate facility. This is based on provider support.
boolean dbUseFastDeletes: Indicates whether an export table with data will cleared more quickly by using a SQL table "truncate" command rather than line-by-line deleting of records.
boolean dbUseTransactions: Determines whether records for this export's output will be inserted inside a database transaction. This parameter will be used only when the output mode is Table.
string dbUserName: The database user name that will be used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string dbVendor: The database vendor string used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string delimiter: Delimits values in a row of export output.
string header: Header text for the export output.
string footer: Footer text for the export output.
StringListType fromList: Array of string values to replace in the export results. Currently three string items are supported.
string fromStrValue: A string value representing each item in the fromList array delimited by a comma.
StringListType toList: Array of string values that are replacing values for the values in the fromList field. Currently three string items are supported.
string toStrValue: A string value representing each item in the toList array delimited by a comma.
string userName: User name associated with this export.
int userId: User ID associated with this export.
boolean hasWarning: Indicates whether a WarningMessage has been encountered during this export's execution.
StringListType warningMessages: Warnings that were encountered during export execution.
int maxTopNodes: (To be deprecated)
NodeLocatorListType nodesToExpand: List of node locator objects to identify the top nodes to export from.
boolean pushDown: Flag to automatically repeat nodes down to the defined level in the export structure.
string pushDownNode: Constant to push the repeat nodes from: BottomLeaf, Bottom, Root are possible values.
boolean recurse: Select to include output for all nodes below the top node. If False, only the top node is included (which is typically not the desired result).
int bottomLevel: Determines the maximum depth of the export structure
string bottomLevelProp: Property that determines the maximum depth of the export structure. This value can be defined as a hierarchy-level, integer property
QueryType query: Query to include
boolean removeDuplicates: Select to use the primary key (defined on the column Options tab) to suppress.
string repeatNumProp: References a local, node-level, integer property that repeats a node within an export structure.
boolean tabbedTree: Set to True to indent the nodes for each level of a hierarchy using tab characters to produce a structured output format.
boolean includeLeafs: Flag to include leaf nodes in the export results.
boolean includeLimbs: Flag to include limb nodes in the export results.
IncludeFileModeEnum includeFileMode: Enumeration indicating whether the nodes located in the includeFileName should be included or excluded.
string includeFileName: The name of the file on the external connection to use for filtering (include or exclude) nodes.
boolean includeImplicitlySharedNodes: Set to True to include descendant nodes below shared limb nodes that are explicitly shared. Implicit shared nodes are exported only if not filtered out by another option.
+Type Definition
<complexType name="HierExportType">
<complexContent>
<extension base="ExportType">
<sequence>
<element minOccurs="0" name="maxTopNodes" type="int"/>
<element minOccurs="0" name="nodesToExpand" type="NodeLocatorListType"/>
<element minOccurs="0" name="pushDown" type="boolean"/>
<element minOccurs="0" name="pushDownNode" type="string"/>
<element minOccurs="0" name="recurse" type="boolean"/>
<element minOccurs="0" name="bottomLevel" type="int"/>
<element minOccurs="0" name="bottomLevelProp" type="string"/>
<element minOccurs="0" name="query" type="QueryType"/>
<element minOccurs="0" name="removeDuplicates" type="boolean"/>
<element minOccurs="0" name="repeatNumProp" type="string"/>
<element minOccurs="0" name="tabbedTree" type="boolean"/>
<element minOccurs="0" name="includeLeafs" type="boolean"/>
<element minOccurs="0" name="includeLimbs" type="boolean"/>
<element minOccurs="0" name="includeFileMode" type="IncludeFileModeEnum"/>
<element minOccurs="0" name="includeFileName" type="string"/>
<element minOccurs="0" name="includeImplicitlySharedNodes" type="boolean"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string name: The name of the hierarchy group.
string descr: The description of the hierarchy group.
int id: The system-generated ID of the hierarchy group.
int order: The sort order that the hierarchy group will appear in the version selector.
+Type Definition
<complexType name="HierGroup">
<sequence>
<element name="name" type="string"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="order" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

HierGroup hierGroup: The hierarchy group type object.
+Type Definition
<complexType name="HierGroupResponseType">
<sequence>
<element name="hierGroup" type="HierGroup"/>
</sequence>
</complexType>
Referenced By:

Fields:

HierListType hierList: The hierarchy group list type object.
+Type Definition
<complexType name="HierListResponseType">
<sequence>
<element name="hierList" type="HierListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

HierType hier: The hierarchy list type object.
+Type Definition
<complexType name="HierListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="hier" nillable="true" type="HierType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
+Type Definition
<complexType name="HierLocatorType">
<sequence>
<element minOccurs="0" name="versionName" type="string"/>
<element minOccurs="0" name="hierName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

HierNodeNamePairType hierNodeNamePair: List of hierarchy node pair type object.
+Type Definition
<complexType name="HierNodeNamePairListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="hierNodeNamePair" nillable="true" type="HierNodeNamePairType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string hierName: Hierarchy name field.
string nodeName: Node name field.
+Type Definition
<complexType name="HierNodeNamePairType">
<sequence>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
</sequence>
</complexType>
Referenced By:
A remove hierarchy property value request type.

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string propName: Name of the property definition.
+Type Definition
<complexType name="HierPropRemoveRequestItemType">
<complexContent>
<extension base="HierPropRequestItemType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string propName: Name of the property definition.
+Type Definition
<complexType name="HierPropRequestItemType">
<complexContent>
<extension base="HierRequestItemType">
<sequence>
<element name="propName" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string propName: Name of the property definition.
string Value: The value to be used during a property update.
+Type Definition
<complexType name="HierPropUpdateRequestItemType">
<complexContent>
<extension base="HierPropRequestItemType">
<sequence>
<element minOccurs="0" name="Value" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
+Type Definition
<complexType name="HierRequestItemType">
<complexContent>
<extension base="RequestItemType">
<sequence>
<element name="hierName" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

HierType hier: The hierarchy object type.
+Type Definition
<complexType name="HierResponseType">
<sequence>
<element name="hier" type="HierType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string name: The name of the hierarchy.
int id: The system-generated ID for the hierarchy.
string descr: Description of the object.
NodeType topNode: The top node type of the hierarchy.
string hierGroup: A hierarchy group name.
string displayBy: Default display by property. Can be a comma-separated value to indicate more than one property to display nodes by in the node tree.
boolean displayByEnabled: Flag to enable default display by functionality.
AccessLevelEnum accessLevel: Access level user must have to modify hierarchy.
StringListType defaultPasteProps: When copying properties from one node to another the default list of properties to copy and paste.
boolean enableSharedNodes: Determines if shared nodes are allowed in the hierarchy.
int idLengthLeaf: Used with the ID feature to determine the total length of the ID (excluding the prefix and including leading zeros). Points to the node-level property that is used to specify the length for the specified leaf node. If not set, then the length of the next sequential ID is used without leading zeros.
int idLengthLimb: Used with the ID feature to determine the total length of the ID (excluding the prefix and including leading zeros). Points to the node-level property that is used to specify the length for the specified limb node. If not set, then the length of the next sequential ID is used without leading zeros.
string prefillLeafProperty: Node-level property that is used to pre-fill node name when creating new leaf node.
string prefillLimbProperty: Node-level property that is used to pre-fill node name when creating new limb node.
int sortOrder: Integer value to allow sorting the order in which hierarchies appear within the version
boolean standardSortDefined: Is True if the hierarchy level property StandardHierSort is set to an appropriate node-level property that contains the sort order.
boolean isSynchByEnabled: Is True if either: userSynchBy or DefaultSynchBy property is used and is a valid property.
string synchByProperty: The property to synchronize nodes for the hierarchy.
boolean userDisplayByDefined: A user-defined display by property. Can be a comma separated value to indicate more than one property to display nodes by in the node tree.
boolean userFilterDefined: (To be deprecated)
boolean userSortDefined: True if the user supplies a sort order property for the userHierSort property.
boolean userSyncDefined: True if the user supplies a property in the userSyncBy property.
NodeType viewFromNode: A node object indicating what top node the hierarchy can be viewed from.
+Type Definition
<complexType name="HierType">
<sequence>
<element minOccurs="0" name="versionName" type="string"/>
<element name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="topNode" type="NodeType"/>
<element minOccurs="0" name="hierGroup" type="string"/>
<element minOccurs="0" name="displayBy" type="string"/>
<element minOccurs="0" name="displayByEnabled" type="boolean"/>
<element minOccurs="0" name="accessLevel" type="AccessLevelEnum"/>
<element minOccurs="0" name="defaultPasteProps" type="StringListType"/>
<element minOccurs="0" name="enableSharedNodes" type="boolean"/>
<element minOccurs="0" name="idLengthLeaf" type="int"/>
<element minOccurs="0" name="idLengthLimb" type="int"/>
<element minOccurs="0" name="prefillLeafProperty" type="string"/>
<element minOccurs="0" name="prefillLimbProperty" type="string"/>
<element minOccurs="0" name="sortOrder" type="int"/>
<element minOccurs="0" name="standardSortDefined" type="boolean"/>
<element minOccurs="0" name="isSynchByEnabled" type="boolean"/>
<element minOccurs="0" name="synchByProperty" type="string"/>
<element minOccurs="0" name="userDisplayByDefined" type="boolean"/>
<element minOccurs="0" name="userFilterDefined" type="boolean"/>
<element minOccurs="0" name="userSortDefined" type="boolean"/>
<element minOccurs="0" name="userSyncDefined" type="boolean"/>
<element minOccurs="0" name="viewFromNode" type="NodeType"/>
</sequence>
</complexType>
Referenced By:

Fields:

HierValidationResultType validationResult: The results of a hierarchy level validation run.
+Type Definition
<complexType name="HierValidationResponseType">
<sequence>
<element name="validationResult" type="HierValidationResultType"/>
</sequence>
</complexType>
Referenced By:

Fields:

HierValidationResultType HierValidationResult: A list type of hierarchy level validation results.
+Type Definition
<complexType name="HierValidationResultListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="HierValidationResult" type="HierValidationResultType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
NodeWithPropValuesListType nodeList: A type that includes a list of nodes and their property values.
StringListType requestedPropNames: A string list type of property names.
boolean maxNodesExceeded: A flag indicating that a query exceeded the number of nodes specified in queryType.
int totalNodeCount: The total number of nodes in the query result.
StringListType reasonList: List of validations that failed during a validation run.
+Type Definition
<complexType name="HierValidationResultType">
<complexContent>
<extension base="QueryResultType">
<sequence>
<element minOccurs="0" name="reasonList" type="StringListType"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
An enumeration for image type.
+Type Definition
<simpleType name="ImageTypeEnum">
<restriction base="string">
<enumeration value="PNG"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

ImportColumnType importColumn: List of importColumnType objects for an import.
+Type Definition
<complexType name="ImportColumnListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="importColumn" nillable="true" type="ImportColumnType"/>
</sequence>
</complexType>
Referenced By:

Fields:

boolean ignoreColumn: Flag indicating that the column should be ignored when processing an import.
string propName: The property name for this column.
string displayLabel: The display of the column.
boolean applyToAllHiers: A flag indicating that the property update should be applied to a node in each hierarchy it exists in.
StringListType hierMappings: A list of hierarchies that the property update should be applied to.
boolean isStructureColumn: A flag indicating that the column is deemed a structure column (Default and Required columns are structure columns).
+Type Definition
<complexType name="ImportColumnType">
<sequence>
<element minOccurs="0" name="ignoreColumn" type="boolean"/>
<element minOccurs="0" name="propName" type="string"/>
<element minOccurs="0" name="displayLabel" type="string"/>
<element minOccurs="0" name="applyToAllHiers" type="boolean"/>
<element minOccurs="0" name="hierMappings" type="StringListType"/>
<element minOccurs="0" name="isStructureColumn" type="boolean"/>
</sequence>
</complexType>
Type Hierarchy:
Referenced By:
An enumeration to determine the severity with which the import processor treats a duplicate.
+Type Definition
<simpleType name="ImportDupeModeEnum">
<restriction base="string">
<enumeration value="Error"/>
<enumeration value="Warning"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
An enumeration indicating the severity of the import result item.
+Type Definition
<simpleType name="ImportErrorLevelEnum">
<restriction base="string">
<enumeration value="Success"/>
<enumeration value="Warning"/>
<enumeration value="Error"/>
<enumeration value="FatalError"/>
<enumeration value="SystemError"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

ImportErrorLogType importErrorLog: List of import result items.
+Type Definition
<complexType name="ImportErrorLogListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="importErrorLog" nillable="true" type="ImportErrorLogType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string hierName: Hierarchy name field.
string nodeName: Node name field.
string propName: The property name processed during the import.
string action: The type of import item that was executed.
string before: The value before the import item was executed.
string after: The value after the import item was executed.
string errorDescr: A description of the error.
ImportErrorLevelEnum errorLevel: Indicates the severity of the import result item.
string errorLevelDescr: A description of the severity of the import result item.
+Type Definition
<complexType name="ImportErrorLogType">
<sequence>
<element minOccurs="0" name="hierName" type="string"/>
<element minOccurs="0" name="nodeName" type="string"/>
<element minOccurs="0" name="propName" type="string"/>
<element minOccurs="0" name="action" type="string"/>
<element minOccurs="0" name="before" type="string"/>
<element minOccurs="0" name="after" type="string"/>
<element minOccurs="0" name="errorDescr" type="string"/>
<element minOccurs="0" name="errorLevel" type="ImportErrorLevelEnum"/>
<element minOccurs="0" name="errorLevelDescr" type="string"/>
</sequence>
</complexType>
Referenced By:
An enumeration indicating whether the file format is delimited or fixed width.
+Type Definition
<simpleType name="ImportFileFormatEnum">
<restriction base="string">
<enumeration value="Delimited"/>
<enumeration value="FixedWidth"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
An enumeration indicating the location of the import file.
+Type Definition
<simpleType name="ImportFileSourceEnum">
<restriction base="string">
<enumeration value="ClientFile"/>
<enumeration value="ServerFile"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
An enumeration indicating the structure of the file.
+Type Definition
<simpleType name="ImportFileStructureEnum">
<restriction base="string">
<enumeration value="ParentChild"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

boolean ignoreColumn: Flag indicating that the column should be ignored when processing an import.
string propName: The property name for this column.
string displayLabel: The display of the column.
boolean applyToAllHiers: A flag indicating that the property update should be applied to a node in each hierarchy it exists in.
StringListType hierMappings: A list of hierarchies that the property update should be applied to.
boolean isStructureColumn: A flag indicating that the column is deemed a structure column (Default and Required columns are structure columns).
int fixedWidth: Integer value indicating the width of the column in a fixed width import.
+Type Definition
<complexType name="ImportFlatFileColumnType">
<complexContent>
<extension base="ImportColumnType">
<sequence>
<element minOccurs="0" name="fixedWidth" type="int"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

ObjectAccessEnum objectAccess: The object access of the import.
string name: The name of the import.
int id: The system-generated ID of the import.
string descr: Description of the object.
int importTypeId: Import type ID. Set to 1.
string versionName: Version name field.
string versionDescr: The version description.
ImportFileSourceEnum fileSource: Indicates the location of the file.
ImportVersionSectionType versionSection: The version section of the import.
ImportHierSectionType hierSection: The hierarchy section of the import.
ImportGlobalNodeSectionType nodeSection: The node section of the import.
ImportRelationshipSectionType relationshipSection: The relationship section of the import.
ImportPropSectionType propSection: The hierarchy node section of the import.
string namedConnection: If the import uses an external connection, the name of the connection to be used.
string logOutputFileName: The import results output file name.
int maxErrors: The import error threshold value at which the import halts execution.
string ignoreColumnText: (To be deprecated)
boolean postProcessLeafs: Flag to specify that, at the end of the import process, the import automatically sets the leaf property to True for any node that has no children.
boolean sortByRelationships: Select to enable the import to sort the nodes based on the order in which they are displayed in the relationship section of the source file.
string relationshipSortProp: The node property in which to store the sort order.
string relationshipSortHierConfig: String property that includes hierarchies to which to apply the sort. This field can be comma separated if more than one hierarchy is to be processed.
boolean useDupeAppendString: Flag indicating if the import engine should append the unique portion of the name to the end of the original node name.
string dupeAssocProp: Property to enable duplicate nodes to be grouped so they can be easily queried after the import is complete.
string dupeDelimiter: delimiter character to be used to separate the original node name from the unique portion of the name.
ImportDupeModeEnum dupeMode: An enumeration indicating how the import engine should treat duplicates (Warning or Error).
int dupeUniqueIdSeed: Starting point for duplicate handling ID. For example, if nodeA occurs three times in a hierarchy and the unique ID seed is 1, the original node is not changed, and the other node names are replaced with nodeA1 and nodeA2. This example ignores the other Duplicate settings in order to illustrate the use of unique ID seed.
string dupeUniqueString: A string to be used to form part of the new unique node name for when the import engine encounters duplicates.
int dupeZeroPadLength: The minimum number of digits required in the unique ID portion of the duplicate name. For example, a value of 3 for zero-pad length creates duplicate nodes named nodeA001, nodeA002, and so on. A value of 2 creates duplicate nodes named nodeA01, nodeA02, and so on.
boolean skipDefinedBlanks: Flag indicating that the import engine is to ignore blank values for defined properties.
boolean skipDefinedDefaults: Flag indicating that the import engine should skip property updates if the column value is equal to default value for property definition.
boolean skipDerivedBlanks: Flag indicating that the import engine is to ignore blank values for derived properties.
boolean skipDerivedDefaults: Flag indicating that the import engine should skip property updates if the column value is equal to the calculated value for property definition.
boolean skipInheritedBlanks: Flag indicating that the import engine is to ignore blank values for inheriting properties.
boolean skipInheritedDefaults: Flag indicating that the import engine should skip property updates if the column value is equal to the inherited value for property definition.
boolean isStandard: Read-only flag indicating that import is standard.
int userId: User ID associated with this import.
ImportFileFormatEnum importFileFormat: Field indicates if the file format is deli meted or fixed width.
ImportFileStructureEnum importFileStructure: Field indicates the structure of the file.
CharacterEncodingEnum inputFileEncoding: Field indicates the character encoding of the text file.
string inputFileName: Field indicating the name of the file.
boolean useQuotedStrings: Select to include quotation marks during data import.
string delimiter: The delimiter used to parse each column in a line.
string sectionDelimBegin: A character that is displayed at the beginning of a section heading.
string sectionDelimEnd: A character that is displayed at the end of a section heading.
+Type Definition
<complexType name="ImportFlatFileType">
<complexContent>
<extension base="ImportType">
<sequence>
<element minOccurs="1" name="importFileFormat" type="ImportFileFormatEnum"/>
<element minOccurs="0" name="importFileStructure" type="ImportFileStructureEnum"/>
<element minOccurs="1" name="inputFileEncoding" type="CharacterEncodingEnum"/>
<element minOccurs="0" name="inputFileName" type="string"/>
<element minOccurs="0" name="useQuotedStrings" type="boolean"/>
<element minOccurs="0" name="delimiter" type="string"/>
<element minOccurs="1" name="sectionDelimBegin" type="string"/>
<element minOccurs="1" name="sectionDelimEnd" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

ImportSectionTypeEnum sectionType: Indicates a section of an import.
string sectionName: The section name of an import.
string sectionHeading: The section heading of an import.
boolean processSection: Flag indicating whether the section should be processed or ignored.
ImportColumnListType columns: Array of import columns to process for the section.
StringListType propDefList: List of valid properties for the section.
boolean allowHierMappings: Flag indicating if the import engine should process the section for hierarchy mappings. Only the node and Relation section can process hierarchy mappings.
+Type Definition
<complexType name="ImportGlobalNodeSectionType">
<complexContent>
<extension base="ImportSectionType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

ImportSectionTypeEnum sectionType: Indicates a section of an import.
string sectionName: The section name of an import.
string sectionHeading: The section heading of an import.
boolean processSection: Flag indicating whether the section should be processed or ignored.
ImportColumnListType columns: Array of import columns to process for the section.
StringListType propDefList: List of valid properties for the section.
boolean allowHierMappings: Flag indicating if the import engine should process the section for hierarchy mappings. Only the node and Relation section can process hierarchy mappings.
+Type Definition
<complexType name="ImportHierSectionType">
<complexContent>
<extension base="ImportSectionType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

ImportSectionTypeEnum sectionType: Indicates a section of an import.
string sectionName: The section name of an import.
string sectionHeading: The section heading of an import.
boolean processSection: Flag indicating whether the section should be processed or ignored.
ImportColumnListType columns: Array of import columns to process for the section.
StringListType propDefList: List of valid properties for the section.
boolean allowHierMappings: Flag indicating if the import engine should process the section for hierarchy mappings. Only the node and Relation section can process hierarchy mappings.
+Type Definition
<complexType name="ImportPropSectionType">
<complexContent>
<extension base="ImportSectionType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

ImportSectionTypeEnum sectionType: Indicates a section of an import.
string sectionName: The section name of an import.
string sectionHeading: The section heading of an import.
boolean processSection: Flag indicating whether the section should be processed or ignored.
ImportColumnListType columns: Array of import columns to process for the section.
StringListType propDefList: List of valid properties for the section.
boolean allowHierMappings: Flag indicating if the import engine should process the section for hierarchy mappings. Only the node and Relation section can process hierarchy mappings.
+Type Definition
<complexType name="ImportRelationshipSectionType">
<complexContent>
<extension base="ImportSectionType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

ImportType importProfile: The import type object.
+Type Definition
<complexType name="ImportResponseType">
<sequence>
<element name="importProfile" type="ImportType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ImportResultsType importResults: The results of an import run.
+Type Definition
<complexType name="ImportResultsResponseType">
<sequence>
<element name="importResults" type="ImportResultsType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ImportStatusEnum status: An enumeration indicating the success or failure of the import run.
string versionNameCreated: The name of the version created during the import run.
int hierCount: The number of hierarchies created during the import run.
int nodeCount: The number of nodes created during the import run.
int orphanCount: The number of orphans that exist after the import run.
int dupeCount: The number of duplicates created during the import run.
int warningCount: The number of warnings logged during the import run.
int errorCount: The number of errors logged during the import run.
ImportErrorLogListType errorList: An array of import result error objects.
base64Binary compressedLogOutput: Byte array of compressed bytes that represent import results. The deflate algorithm should be used to decompress the content.
+Type Definition
<complexType name="ImportResultsType">
<sequence>
<element minOccurs="0" name="status" type="ImportStatusEnum"/>
<element minOccurs="0" name="versionNameCreated" type="string"/>
<element minOccurs="0" name="hierCount" type="int"/>
<element minOccurs="0" name="nodeCount" type="int"/>
<element minOccurs="0" name="orphanCount" type="int"/>
<element minOccurs="0" name="dupeCount" type="int"/>
<element minOccurs="0" name="warningCount" type="int"/>
<element minOccurs="0" name="errorCount" type="int"/>
<element minOccurs="0" name="errorList" type="ImportErrorLogListType"/>
<element minOccurs="0" name="compressedLogOutput" type="base64Binary"/>
</sequence>
</complexType>
Referenced By:

Fields:

ImportSectionTypeEnum sectionType: Indicates a section of an import.
string sectionName: The section name of an import.
string sectionHeading: The section heading of an import.
boolean processSection: Flag indicating whether the section should be processed or ignored.
ImportColumnListType columns: Array of import columns to process for the section.
StringListType propDefList: List of valid properties for the section.
boolean allowHierMappings: Flag indicating if the import engine should process the section for hierarchy mappings. Only the node and Relation section can process hierarchy mappings.
+Type Definition
<complexType name="ImportSectionType">
<sequence>
<element minOccurs="0" name="sectionType" type="ImportSectionTypeEnum"/>
<element minOccurs="0" name="sectionName" type="string"/>
<element minOccurs="0" name="sectionHeading" type="string"/>
<element minOccurs="0" name="processSection" type="boolean"/>
<element minOccurs="0" name="columns" type="ImportColumnListType"/>
<element minOccurs="0" name="propDefList" type="StringListType"/>
<element minOccurs="0" name="allowHierMappings" type="boolean"/>
</sequence>
</complexType>
Type Hierarchy:
Enumeration that indicates the section type.
+Type Definition
<simpleType name="ImportSectionTypeEnum">
<restriction base="string">
<enumeration value="Version"/>
<enumeration value="Hier"/>
<enumeration value="Node"/>
<enumeration value="Relation"/>
<enumeration value="Property"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
Enumeration that indicates the state of the import.
+Type Definition
<simpleType name="ImportStatusEnum">
<restriction base="string">
<enumeration value="Created"/>
<enumeration value="Initialized"/>
<enumeration value="Started"/>
<enumeration value="IncompleteFatalError"/>
<enumeration value="IncompleteMaxErrors"/>
<enumeration value="IncompleteSystemError"/>
<enumeration value="CompleteSuccess"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

ObjectAccessEnum objectAccess: The object access of the import.
string name: The name of the import.
int id: The system-generated ID of the import.
string descr: Description of the object.
int importTypeId: Import type ID. Set to 1.
string versionName: Version name field.
string versionDescr: The version description.
ImportFileSourceEnum fileSource: Indicates the location of the file.
ImportVersionSectionType versionSection: The version section of the import.
ImportHierSectionType hierSection: The hierarchy section of the import.
ImportGlobalNodeSectionType nodeSection: The node section of the import.
ImportRelationshipSectionType relationshipSection: The relationship section of the import.
ImportPropSectionType propSection: The hierarchy node section of the import.
string namedConnection: If the import uses an external connection, the name of the connection to be used.
string logOutputFileName: The import results output file name.
int maxErrors: The import error threshold value at which the import halts execution.
string ignoreColumnText: (To be deprecated)
boolean postProcessLeafs: Flag to specify that, at the end of the import process, the import automatically sets the leaf property to True for any node that has no children.
boolean sortByRelationships: Select to enable the import to sort the nodes based on the order in which they are displayed in the relationship section of the source file.
string relationshipSortProp: The node property in which to store the sort order.
string relationshipSortHierConfig: String property that includes hierarchies to which to apply the sort. This field can be comma separated if more than one hierarchy is to be processed.
boolean useDupeAppendString: Flag indicating if the import engine should append the unique portion of the name to the end of the original node name.
string dupeAssocProp: Property to enable duplicate nodes to be grouped so they can be easily queried after the import is complete.
string dupeDelimiter: delimiter character to be used to separate the original node name from the unique portion of the name.
ImportDupeModeEnum dupeMode: An enumeration indicating how the import engine should treat duplicates (Warning or Error).
int dupeUniqueIdSeed: Starting point for duplicate handling ID. For example, if nodeA occurs three times in a hierarchy and the unique ID seed is 1, the original node is not changed, and the other node names are replaced with nodeA1 and nodeA2. This example ignores the other Duplicate settings in order to illustrate the use of unique ID seed.
string dupeUniqueString: A string to be used to form part of the new unique node name for when the import engine encounters duplicates.
int dupeZeroPadLength: The minimum number of digits required in the unique ID portion of the duplicate name. For example, a value of 3 for zero-pad length creates duplicate nodes named nodeA001, nodeA002, and so on. A value of 2 creates duplicate nodes named nodeA01, nodeA02, and so on.
boolean skipDefinedBlanks: Flag indicating that the import engine is to ignore blank values for defined properties.
boolean skipDefinedDefaults: Flag indicating that the import engine should skip property updates if the column value is equal to default value for property definition.
boolean skipDerivedBlanks: Flag indicating that the import engine is to ignore blank values for derived properties.
boolean skipDerivedDefaults: Flag indicating that the import engine should skip property updates if the column value is equal to the calculated value for property definition.
boolean skipInheritedBlanks: Flag indicating that the import engine is to ignore blank values for inheriting properties.
boolean skipInheritedDefaults: Flag indicating that the import engine should skip property updates if the column value is equal to the inherited value for property definition.
boolean isStandard: Read-only flag indicating that import is standard.
int userId: User ID associated with this import.
+Type Definition
<complexType name="ImportType">
<sequence>
<element minOccurs="0" name="objectAccess" type="ObjectAccessEnum"/>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="importTypeId" type="int"/>
<element minOccurs="0" name="versionName" type="string"/>
<element minOccurs="0" name="versionDescr" type="string"/>
<element minOccurs="0" name="fileSource" type="ImportFileSourceEnum"/>
<element minOccurs="0" name="versionSection" type="ImportVersionSectionType"/>
<element minOccurs="0" name="hierSection" type="ImportHierSectionType"/>
<element minOccurs="0" name="nodeSection" type="ImportGlobalNodeSectionType"/>
<element minOccurs="0" name="relationshipSection" type="ImportRelationshipSectionType"/>
<element minOccurs="0" name="propSection" type="ImportPropSectionType"/>
<element minOccurs="0" name="namedConnection" type="string"/>
<element minOccurs="0" name="logOutputFileName" type="string"/>
<element minOccurs="0" name="maxErrors" type="int"/>
<element minOccurs="0" name="ignoreColumnText" type="string"/>
<element minOccurs="0" name="postProcessLeafs" type="boolean"/>
<element minOccurs="0" name="sortByRelationships" type="boolean"/>
<element minOccurs="0" name="relationshipSortProp" type="string"/>
<element minOccurs="0" name="relationshipSortHierConfig" type="string"/>
<element minOccurs="0" name="useDupeAppendString" type="boolean"/>
<element minOccurs="0" name="dupeAssocProp" type="string"/>
<element minOccurs="0" name="dupeDelimiter" type="string"/>
<element minOccurs="0" name="dupeMode" type="ImportDupeModeEnum"/>
<element minOccurs="0" name="dupeUniqueIdSeed" type="int"/>
<element minOccurs="0" name="dupeUniqueString" type="string"/>
<element minOccurs="0" name="dupeZeroPadLength" type="int"/>
<element minOccurs="0" name="skipDefinedBlanks" type="boolean"/>
<element minOccurs="0" name="skipDefinedDefaults" type="boolean"/>
<element minOccurs="0" name="skipDerivedBlanks" type="boolean"/>
<element minOccurs="0" name="skipDerivedDefaults" type="boolean"/>
<element minOccurs="0" name="skipInheritedBlanks" type="boolean"/>
<element minOccurs="0" name="skipInheritedDefaults" type="boolean"/>
<element minOccurs="0" name="isStandard" type="boolean"/>
<element minOccurs="0" name="userId" type="int"/>
</sequence>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

ImportSectionTypeEnum sectionType: Indicates a section of an import.
string sectionName: The section name of an import.
string sectionHeading: The section heading of an import.
boolean processSection: Flag indicating whether the section should be processed or ignored.
ImportColumnListType columns: Array of import columns to process for the section.
StringListType propDefList: List of valid properties for the section.
boolean allowHierMappings: Flag indicating if the import engine should process the section for hierarchy mappings. Only the node and Relation section can process hierarchy mappings.
string versionName: Version name field.
string versionDescr: Version description field.
+Type Definition
<complexType name="ImportVersionSectionType">
<complexContent>
<extension base="ImportSectionType">
<sequence>
<element minOccurs="0" name="versionName" type="string"/>
<element minOccurs="0" name="versionDescr" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name to inactivate.
string mergeNodeName: The name of the node to merge this inactive node to (if merging is enabled).
+Type Definition
<complexType name="InactivateNode">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element minOccurs="0" name="mergeNodeName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of nodes to inactivate.
StringListType mergeNodeNameList: List of node names to merge the corresponding nodeNameList with (if merging is enabled).
+Type Definition
<complexType name="InactivateNodes">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeNameList" type="StringListType"/>
<element minOccurs="0" name="mergeNodeNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:
Enumeration that indicates whether the file contents are to be included or excluded.
+Type Definition
<simpleType name="IncludeFileModeEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="IncludeNodes"/>
<enumeration value="ExcludeNodes"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string targetParentName: The existing parent node name to insert this node under.
NameValueListType propNameValueList: Name/Value Pair list field for property definition name and value for the node property value.
+Type Definition
<complexType name="InsertNode">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element name="targetParentName" type="string"/>
<element minOccurs="0" name="propNameValueList" type="NameValueListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string targetParentName: The existing parent node name to insert this node under.
PropListType propList: Array of properties to update.
+Type Definition
<complexType name="InsertNodeWithProps">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element name="targetParentName" type="string"/>
<element minOccurs="0" name="propList" type="PropListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of nodes to insert under a new parent.
string targetParentName: The existing parent node name to insert this node under.
+Type Definition
<complexType name="InsertNodes">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeNameList" type="StringListType"/>
<element name="targetParentName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

int intVal: Primitive int value.
+Type Definition
<complexType name="IntResponseType">
<sequence>
<element name="intVal" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

int id: Generated system ID of the asynchronous job.
string name: The name of the asynchronous job.
string machineName: The name of the machine that executes the asynchronous job.
int processId: Process ID assigned by the system.
int threadId: The thread that the process runs under.
string session: A session ID associated with the job.
JobStatusEnum status: An enumeration indicating the status of the job.
int percentComplete: The percentage complete for the running job. The server updates this value at intervals during an import run.
string progressMessage: A message that is set by the server indicating the progress of the job.
+Type Definition
<complexType name="JobInfoType">
<sequence>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="machineName" type="string"/>
<element minOccurs="0" name="processId" type="int"/>
<element minOccurs="0" name="threadId" type="int"/>
<element minOccurs="0" name="session" type="string"/>
<element minOccurs="0" name="status" type="JobStatusEnum"/>
<element minOccurs="0" name="percentComplete" type="int"/>
<element minOccurs="0" name="progressMessage" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

JobInfoType jobInfo: The jobInfoType object.
int timeoutDuration: A timeout value that a consumer can set to either wait infinite or within a specified value. Set to -1 for infinite. The value should be expressed in milliseconds.
+Type Definition
<complexType name="JobResultRetrievalInputType">
<sequence>
<element name="jobInfo" type="JobInfoType"/>
<element minOccurs="0" name="timeoutDuration" type="int"/>
</sequence>
</complexType>
Type Hierarchy:
Referenced By:
Enumeration indicates the status of an asynchronous job.
+Type Definition
<simpleType name="JobStatusEnum">
<restriction base="string">
<enumeration value="Invalid"/>
<enumeration value="Queued"/>
<enumeration value="Working"/>
<enumeration value="Done"/>
<enumeration value="DoneWithErrors"/>
<enumeration value="Cancelled"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

JobInfoType jobStatus: JobInfoType type.
+Type Definition
<complexType name="JobStatusResponseType">
<sequence>
<element name="jobStatus" type="JobInfoType"/>
</sequence>
</complexType>
Referenced By:
Enumeration indicating a join between queryCriteria types.
+Type Definition
<simpleType name="JoinOperatorEnum">
<restriction base="string">
<enumeration value="And"/>
<enumeration value="Or"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
Enumeration indicating a versions load status.
+Type Definition
<simpleType name="LoadStatusEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="Created"/>
<enumeration value="Initialized"/>
<enumeration value="Loaded"/>
<enumeration value="Loading"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

boolean filterToCurrentSession: Filters transactions to those performed during the current session.
string versionName: Version name field.
int versionId: Version ID field.
int hierId: Hierarchy ID field.
int nodeId: Node ID field.
string hierNameList: List of hierarchy names.
string nodeNameList: List of node names.
string propNameList: List of property names.
TxnActionLevelListType actionLevels: List of action levels to include for filtering transaction history.
TxnActionListType actions: List of transaction actions to include for filtering transaction history.
boolean useBeginDate: Flag indicating if a date range should be used for criteria.
dateTime beginDateTime: The begin date and time to be used if useBeginDate is set to True.
boolean useEndDate: Flag indicating that a date range should be used for criteria.
dateTime endDateTime: The end date and time to be used if useBeginDate is set to True.
boolean useBeginId: Flag indicating that transaction history should be filtered by transaction ID.
int beginId: The beginning transaction ID to be used when useBeginId is set to True.
boolean useEndId: Flag indicating that transaction history should be filtered by transaction id.
int endId: The ending transaction ID to be used when useBeginId is set to True.
boolean includeChildren: Flag indicating that children should be filtered in the transaction history.
boolean includeSharedNodes: Flag indicating that shared nodes should be filtered in the transaction history.
int maxRecords: The maximum number of transaction history records to return in the result.
string userNameList: List of user names to be used as filter criteria for the transaction history.
+Type Definition
<complexType name="LogCriteriaType">
<sequence>
<element minOccurs="0" name="filterToCurrentSession" type="boolean"/>
<element minOccurs="0" name="versionName" type="string"/>
<element minOccurs="0" name="versionId" type="int"/>
<element minOccurs="0" name="hierId" type="int"/>
<element minOccurs="0" name="nodeId" type="int"/>
<element minOccurs="0" name="hierNameList" type="string"/>
<element minOccurs="0" name="nodeNameList" type="string"/>
<element minOccurs="0" name="propNameList" type="string"/>
<element minOccurs="0" name="actionLevels" type="TxnActionLevelListType"/>
<element minOccurs="0" name="actions" type="TxnActionListType"/>
<element minOccurs="0" name="useBeginDate" type="boolean"/>
<element minOccurs="0" name="beginDateTime" type="dateTime"/>
<element minOccurs="0" name="useEndDate" type="boolean"/>
<element minOccurs="0" name="endDateTime" type="dateTime"/>
<element minOccurs="0" name="useBeginId" type="boolean"/>
<element minOccurs="0" name="beginId" type="int"/>
<element minOccurs="0" name="useEndId" type="boolean"/>
<element minOccurs="0" name="endId" type="int"/>
<element minOccurs="0" name="includeChildren" type="boolean"/>
<element minOccurs="0" name="includeSharedNodes" type="boolean"/>
<element minOccurs="0" name="maxRecords" type="int"/>
<element minOccurs="0" name="userNameList" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
LogItemColumnTypeEnum logItemColumn: Column type for transaction log exports.
+Type Definition
<complexType name="LogItemColumnType">
<complexContent>
<extension base="ExportColumnType">
<sequence>
<element minOccurs="0" name="logItemColumn" type="LogItemColumnTypeEnum"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Enumeration indicating the type of log item column.
+Type Definition
<simpleType name="LogItemColumnTypeEnum">
<restriction base="string">
<enumeration value="TransID"/>
<enumeration value="DetailID"/>
<enumeration value="TimeStamp"/>
<enumeration value="SessionID"/>
<enumeration value="UserName"/>
<enumeration value="Action"/>
<enumeration value="ActionLevel"/>
<enumeration value="VersionID"/>
<enumeration value="VersionAbbrev"/>
<enumeration value="HierID"/>
<enumeration value="HierAbbrev"/>
<enumeration value="NodeID"/>
<enumeration value="NodeAbbrev"/>
<enumeration value="NodeDescr"/>
<enumeration value="PropID"/>
<enumeration value="PropAbbrev"/>
<enumeration value="LeafFlag"/>
<enumeration value="ActionDescr"/>
<enumeration value="FromValue"/>
<enumeration value="ToValue"/>
<enumeration value="OriginatingID"/>
<enumeration value="OriginatingDetailID"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

LogItemListType logItemList: List of logItemType objects.
+Type Definition
<complexType name="LogItemListResponseType">
<sequence>
<element name="logItemList" type="LogItemListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

LogItemType logItem: List type that is returned when querying transaction history.
+Type Definition
<complexType name="LogItemListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="logItem" nillable="true" type="LogItemType"/>
</sequence>
</complexType>
Referenced By:

Fields:

int txnId: Transaction ID field.
string versionName: Version name field.
int versionId: The version ID field.
string hierName: Hierarchy name field.
int hierId: The hierarchy ID field.
string nodeName: Node name field.
int nodeId: The node ID field.
string nodeDescr: The node description field.
boolean isLeaf: Field indicating if node is a Leaf node.
string propName: Property definition name field.
int propId: Property ID field of a property definition.
TxnActionEnum action: Transaction action field. Can contain version, hierarchy, node, logging, and administrative actions.
TxnActionLevelEnum actionLevel: An enumeration indicating the action level for the log item.
string description: The description of the log item.
string fromValue: The value prior to a property update.
string toValue: The value after a property update.
int sessionId: The user session ID that was logged with the transaction history item.
string userName: The user name that was logged with the transaction history item.
dateTime dateTime: The date and time that the transaction item was logged.
int detailId: The detail ID field; used in data loss type actions where one action results in subsequent actions. Each subsequent actions will contain a detail ID.
string isFromOrigin: Represents a properties source origin field.
string isToOrigin: Represents a properties target origin field
int originatingId: In a transaction loss level, the originating transaction ID that resulted in data the data loss.
int originatingDetailId: In a transaction loss level, the originating detail ID that resulted in data the data loss.
+Type Definition
<complexType name="LogItemType">
<sequence>
<element minOccurs="0" name="txnId" type="int"/>
<element minOccurs="0" name="versionName" type="string"/>
<element minOccurs="0" name="versionId" type="int"/>
<element minOccurs="0" name="hierName" type="string"/>
<element minOccurs="0" name="hierId" type="int"/>
<element minOccurs="0" name="nodeName" type="string"/>
<element minOccurs="0" name="nodeId" type="int"/>
<element minOccurs="0" name="nodeDescr" type="string"/>
<element minOccurs="0" name="isLeaf" type="boolean"/>
<element minOccurs="0" name="propName" type="string"/>
<element minOccurs="0" name="propId" type="int"/>
<element minOccurs="0" name="action" type="TxnActionEnum"/>
<element minOccurs="0" name="actionLevel" type="TxnActionLevelEnum"/>
<element minOccurs="0" name="description" type="string"/>
<element minOccurs="0" name="fromValue" type="string"/>
<element minOccurs="0" name="toValue" type="string"/>
<element minOccurs="0" name="sessionId" type="int"/>
<element minOccurs="0" name="userName" type="string"/>
<element minOccurs="0" name="dateTime" type="dateTime"/>
<element minOccurs="0" name="detailId" type="int"/>
<element minOccurs="0" name="isFromOrigin" type="string"/>
<element minOccurs="0" name="isToOrigin" type="string"/>
<element minOccurs="0" name="originatingId" type="int"/>
<element minOccurs="0" name="originatingDetailId" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

ObjectAccessEnum objectAccess: Object access of the export.
string name: Name field of the export.
int id: The system-generated ID.
string descr: Description of the object.
string exportClass: The fully qualified class name of the export type, including namespace. Example: Oracle.Drm.Engine.Core.ExportManager.TransactionLogExport.
VersionParamsType currentVersionParams: Current version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
VersionParamsType previousVersionParams: The previous version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
boolean useQuotedStrings: Puts quotation marks around strings in the export.
string recordDelimiter: A sequence of characters used to specify the record boundary.
boolean useFixedWidth: Flag that indicates that the export is to be a fixed-width export.
boolean insertHeaderFooterBlankLines: Flag that instructs the server to add a line between the header/footer and the body of the export results.
CharacterEncodingEnum characterEncoding: Enumeration indicating encoding of the text file.
boolean hasColumnHeaders: Flag indicating that the export result should include column header label.
ExportColumnListType columns: List of columns to export.
CustomExportParamListType customParams: Parameter values used by custom exports.
string queryName: Name of the query to apply to the export.
string validationName: Name of the validation to apply to the export.
boolean includeInactive: Flag indicating that the export results should include inactive nodes.
ExportOutputModeEnum outputMode: Enumeration of what type of medium the export results should be exported to.
string fileName: Name of the file to be exported.
string includeFileConnection: External connection name to be used if exporting to a server device.
boolean dbClearOnVersion: If exporting to a database, indicates whether export table records with KeyFields containing this export's version ID will be deleted before inserting export output records.
boolean dbClearTable: If exporting to a database, clears the table before exporting.
string dbConnectionString: If exporting to a database, connection string to the database.
string dbExportDAL: The fully qualified name (including namespace) of the export data access layer class that implements IExportDalFactory. This class will be used to create the export DAL used for this export's output.
boolean dbOutputEnabled: Indicates whether the export's type allows its output to be directed to a database. Note that this is a read-only field as far as the API is concerned. Any value for this property that is set though the API will be ignored.
string dbPassword: (To be deprecated)
string dbTableName: If exporting to a database, database table name to export to.
boolean dbUseFastAppends: If exporting to a database, indicates whether the export DAL table will be populated more quickly by using the SQL BulkUpdate facility. This is based on provider support.
boolean dbUseFastDeletes: Indicates whether an export table with data will cleared more quickly by using a SQL table "truncate" command rather than line-by-line deleting of records.
boolean dbUseTransactions: Determines whether records for this export's output will be inserted inside a database transaction. This parameter will be used only when the output mode is Table.
string dbUserName: The database user name that will be used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string dbVendor: The database vendor string used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string delimiter: Delimits values in a row of export output.
string header: Header text for the export output.
string footer: Footer text for the export output.
StringListType fromList: Array of string values to replace in the export results. Currently three string items are supported.
string fromStrValue: A string value representing each item in the fromList array delimited by a comma.
StringListType toList: Array of string values that are replacing values for the values in the fromList field. Currently three string items are supported.
string toStrValue: A string value representing each item in the toList array delimited by a comma.
string userName: User name associated with this export.
int userId: User ID associated with this export.
boolean hasWarning: Indicates whether a WarningMessage has been encountered during this export's execution.
StringListType warningMessages: Warnings that were encountered during export execution.
string propName: Property name of a property definition.
boolean includeDifferencesOnly: Flag to filter out lookup pairs where the lookup key and result value are the same.
+Type Definition
<complexType name="LookupExportType">
<complexContent>
<extension base="ExportType">
<sequence>
<element minOccurs="0" name="propName" type="string"/>
<element minOccurs="0" name="includeDifferencesOnly" type="boolean"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
An enumeration indicating what happens to the node that is being merged.
+Type Definition
<simpleType name="MergeActionEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="Reactivate"/>
<enumeration value="Inactivate"/>
<enumeration value="Delete"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

MergeActionEnum mergeAction: A list of MergeActionEnum values.
+Type Definition
<complexType name="MergeActionListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="mergeAction" nillable="true" type="MergeActionEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

ObjectAccessEnum objectAccess: Object access of the export.
string name: Name field of the export.
int id: The system-generated ID.
string descr: Description of the object.
string exportClass: The fully qualified class name of the export type, including namespace. Example: Oracle.Drm.Engine.Core.ExportManager.TransactionLogExport.
VersionParamsType currentVersionParams: Current version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
VersionParamsType previousVersionParams: The previous version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
boolean useQuotedStrings: Puts quotation marks around strings in the export.
string recordDelimiter: A sequence of characters used to specify the record boundary.
boolean useFixedWidth: Flag that indicates that the export is to be a fixed-width export.
boolean insertHeaderFooterBlankLines: Flag that instructs the server to add a line between the header/footer and the body of the export results.
CharacterEncodingEnum characterEncoding: Enumeration indicating encoding of the text file.
boolean hasColumnHeaders: Flag indicating that the export result should include column header label.
ExportColumnListType columns: List of columns to export.
CustomExportParamListType customParams: Parameter values used by custom exports.
string queryName: Name of the query to apply to the export.
string validationName: Name of the validation to apply to the export.
boolean includeInactive: Flag indicating that the export results should include inactive nodes.
ExportOutputModeEnum outputMode: Enumeration of what type of medium the export results should be exported to.
string fileName: Name of the file to be exported.
string includeFileConnection: External connection name to be used if exporting to a server device.
boolean dbClearOnVersion: If exporting to a database, indicates whether export table records with KeyFields containing this export's version ID will be deleted before inserting export output records.
boolean dbClearTable: If exporting to a database, clears the table before exporting.
string dbConnectionString: If exporting to a database, connection string to the database.
string dbExportDAL: The fully qualified name (including namespace) of the export data access layer class that implements IExportDalFactory. This class will be used to create the export DAL used for this export's output.
boolean dbOutputEnabled: Indicates whether the export's type allows its output to be directed to a database. Note that this is a read-only field as far as the API is concerned. Any value for this property that is set though the API will be ignored.
string dbPassword: (To be deprecated)
string dbTableName: If exporting to a database, database table name to export to.
boolean dbUseFastAppends: If exporting to a database, indicates whether the export DAL table will be populated more quickly by using the SQL BulkUpdate facility. This is based on provider support.
boolean dbUseFastDeletes: Indicates whether an export table with data will cleared more quickly by using a SQL table "truncate" command rather than line-by-line deleting of records.
boolean dbUseTransactions: Determines whether records for this export's output will be inserted inside a database transaction. This parameter will be used only when the output mode is Table.
string dbUserName: The database user name that will be used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string dbVendor: The database vendor string used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string delimiter: Delimits values in a row of export output.
string header: Header text for the export output.
string footer: Footer text for the export output.
StringListType fromList: Array of string values to replace in the export results. Currently three string items are supported.
string fromStrValue: A string value representing each item in the fromList array delimited by a comma.
StringListType toList: Array of string values that are replacing values for the values in the fromList field. Currently three string items are supported.
string toStrValue: A string value representing each item in the toList array delimited by a comma.
string userName: User name associated with this export.
int userId: User ID associated with this export.
boolean hasWarning: Indicates whether a WarningMessage has been encountered during this export's execution.
StringListType warningMessages: Warnings that were encountered during export execution.
dateTime beginDate: Begin date field for the export.
dateTime endDate: End date field for the export.
string deletedNode: Node name of the deleted node.
string mergeNode: The merge node name.
MergeActionListType mergeActions: List of merge action enumeration values.
+Type Definition
<complexType name="MergeLogExportType">
<complexContent>
<extension base="ExportType">
<sequence>
<element minOccurs="0" name="beginDate" type="dateTime"/>
<element minOccurs="0" name="endDate" type="dateTime"/>
<element minOccurs="0" name="deletedNode" type="string"/>
<element minOccurs="0" name="mergeNode" type="string"/>
<element minOccurs="0" name="mergeActions" type="MergeActionListType"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string targetParentName: The name of the new parent node.
+Type Definition
<complexType name="MoveNode">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element name="targetParentName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of node names to move.
string targetParentName: The name of the new parent node.
+Type Definition
<complexType name="MoveNodes">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeNameList" type="StringListType"/>
<element name="targetParentName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

NameValueType nv: List of name/value list types.
+Type Definition
<complexType name="NameValueListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="nv" nillable="true" type="NameValueType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string n: The name field.
string v: The value field.
+Type Definition
<complexType name="NameValueType">
<sequence>
<element name="n" type="string"/>
<element minOccurs="0" name="v" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: The name of the node access group.
int id: The system-generated ID for the node access group.
string label: The label of the node access group.
string descr: Description of the object.
int order: (To be deprecated)
boolean global: Flag indicating if the node access group is global. If set to True, global node access groups can be created and must have a controlling hierarchy defined. This is done by assigning controlled node access groups to a hierarchy.
StringListType users: List of users for the node access group.
+Type Definition
<complexType name="NodeAccessGroupType">
<sequence>
<element name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element name="label" type="string"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="order" type="int"/>
<element minOccurs="0" name="global" type="boolean"/>
<element minOccurs="0" name="users" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

AccessLevelEnum accessLevel: The access level for a node.
+Type Definition
<complexType name="NodeAccessLevelResponseType">
<sequence>
<element minOccurs="0" name="accessLevel" type="AccessLevelEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
+Type Definition
<complexType name="NodeActivateRequestItemType">
<complexContent>
<extension base="BaseNodeRequestItemType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string parentName: Parent node name field.
boolean isLeaf: Field indicating that the node is a Leaf node.
+Type Definition
<complexType name="NodeAddInsertRequestItemType">
<complexContent>
<extension base="NodeAddRequestItemType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string parentName: Parent node name field.
boolean isLeaf: Field indicating that the node is a Leaf node.
+Type Definition
<complexType name="NodeAddRequestItemType">
<complexContent>
<extension base="NodeRequestItemType">
<sequence>
<element name="isLeaf" type="boolean"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

NodeType node: The node object.
+Type Definition
<complexType name="NodeByIdResponseType">
<sequence>
<element name="node" type="NodeType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
+Type Definition
<complexType name="NodeColumnType">
<complexContent>
<extension base="ExportColumnType">
<sequence>
<element minOccurs="0" name="dummy" type="int"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string mergeName: The name of the merge node.
+Type Definition
<complexType name="NodeDeleteRequestItemType">
<complexContent>
<extension base="NodeMergeRequestItemType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string mergeName: The name of the merge node.
+Type Definition
<complexType name="NodeInactivateRequestItemType">
<complexContent>
<extension base="NodeMergeRequestItemType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string parentName: Parent node name field.
+Type Definition
<complexType name="NodeInsertRequestItemType">
<complexContent>
<extension base="NodeRequestItemType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

NodeLocatorType nodeLocator: A node locator object identifying a node within a hierarchy.
+Type Definition
<complexType name="NodeLocatorListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="nodeLocator" nillable="true" type="NodeLocatorType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
+Type Definition
<complexType name="NodeLocatorType">
<sequence>
<element minOccurs="0" name="versionName" type="string"/>
<element minOccurs="0" name="hierName" type="string"/>
<element minOccurs="0" name="nodeName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string mergeName: The name of the merge node.
+Type Definition
<complexType name="NodeMergeRequestItemType">
<complexContent>
<extension base="BaseNodeRequestItemType">
<sequence>
<element name="mergeName" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string destParentName: The name of the new parent node.
+Type Definition
<complexType name="NodeMoveRequestItemType">
<complexContent>
<extension base="BaseNodeRequestItemType">
<sequence>
<element name="destParentName" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
string propName: Property definition name.
NodePropPartEnum propPart: (To be deprecated)
+Type Definition
<complexType name="NodePropColumnType">
<complexContent>
<extension base="PropColumnType">
<sequence>
<element minOccurs="0" name="propPart" type="NodePropPartEnum"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
(To be deprecated)
+Type Definition
<simpleType name="NodePropPartEnum">
<restriction base="string">
<enumeration value="HierNode"/>
<enumeration value="Node"/>
<enumeration value="Hier"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string propName: The property definition name.
+Type Definition
<complexType name="NodePropRemoveRequestItemType">
<complexContent>
<extension base="NodePropRequestItemType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string propName: The property definition name.
+Type Definition
<complexType name="NodePropRequestItemType">
<complexContent>
<extension base="BaseNodeRequestItemType">
<sequence>
<element name="propName" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string propName: The property definition name.
string value: Property value for the node property.
+Type Definition
<complexType name="NodePropUpdateRequestItemType">
<complexContent>
<extension base="NodePropRequestItemType">
<sequence>
<element minOccurs="0" name="value" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
+Type Definition
<complexType name="NodeRemoveRequestItemType">
<complexContent>
<extension base="BaseNodeRequestItemType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string hierName: Hierarchy name field.
string nodeName: Node name field.
string parentName: Parent node name field.
+Type Definition
<complexType name="NodeRequestItemType">
<complexContent>
<extension base="BaseNodeRequestItemType">
<sequence>
<element name="parentName" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string name: Node name field.
int id: The system-generated ID field for the node.
string descr: Description of the object.
string versionName: Version name field.
string hierName: Hierarchy name field.
string parentName: Parent node name field.
string nodeType: The nodeType name.
boolean isInactive: Flag indicating that the node is inactive.
boolean hasChildren: Flag indicating that the node has children.
int childCount: The number of children the node has.
boolean isLeaf: Field indicating that the node is a Leaf node.
boolean isApproved: Flag indicating that node approval has been granted.
StringListType displayByPropValueList: List type for the display by properties.
string displayByString: The display by value for the node.
boolean isPrimary: Indicates whether a node has shared nodes that point to it.
boolean isShared: Indicates whether the node is a shared node.
boolean isPrimaryMissing: Indicates whether the shared node points to a primary node that does not exist.
string primaryName: The primary name portion of the shared node name. For non-shared nodes, this property returns the node name in its entirety.
boolean isPrimaryNotInHier: Indicates whether the primary node is not in the same hierarchy.
boolean primaryHasDescendants: Indicates whether the primary node has structure below it. only populated on shared nodes.
+Type Definition
<complexType name="NodeType">
<sequence>
<element name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="descr" type="string"/>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element minOccurs="0" name="parentName" type="string"/>
<element minOccurs="0" name="nodeType" type="string"/>
<element minOccurs="1" name="isInactive" type="boolean"/>
<element minOccurs="1" name="hasChildren" type="boolean"/>
<element minOccurs="0" name="childCount" type="int"/>
<element minOccurs="0" name="isLeaf" type="boolean"/>
<element minOccurs="0" name="isApproved" type="boolean"/>
<element minOccurs="0" name="displayByPropValueList" type="StringListType"/>
<element minOccurs="0" name="displayByString" type="string"/>
<element minOccurs="0" name="isPrimary" type="boolean"/>
<element minOccurs="0" name="isShared" type="boolean"/>
<element minOccurs="0" name="isPrimaryMissing" type="boolean"/>
<element minOccurs="0" name="primaryName" type="string"/>
<element minOccurs="0" name="isPrimaryNotInHier" type="boolean"/>
<element minOccurs="0" name="primaryHasDescendants" type="boolean"/>
</sequence>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

NodeType nodes: List of nodeType type.
+Type Definition
<complexType name="NodeTypeListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="nodes" nillable="true" type="NodeType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: The name of the node type.
int id: The system-generated ID for the node type.
string descr: Description of the object.
StringListType propNameList: A list of properties for the node type.
StringListType categoryNameList: A list of available categories for the node type.
StringListType validationList: A list of validations for the node type.
int glyphId: The glyph ID associated with the node type.
+Type Definition
<complexType name="NodeTypeType">
<sequence>
<element name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
<element minOccurs="0" name="categoryNameList" type="StringListType"/>
<element minOccurs="0" name="validationList" type="StringListType"/>
<element minOccurs="0" name="glyphId" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeTypeTypeListType nodeTypeList: A return list type for a node type.
+Type Definition
<complexType name="NodeTypeTypeListResponseType">
<sequence>
<element name="nodeTypeList" type="NodeTypeTypeListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeTypeType nodeType: A list type for a node type.
+Type Definition
<complexType name="NodeTypeTypeListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="nodeType" nillable="true" type="NodeTypeType"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeWithPropValuesListType nodeList: A return type for a list of nodes and their property values.
+Type Definition
<complexType name="NodeWithPropValuesListResponseType">
<sequence>
<element name="nodeList" type="NodeWithPropValuesListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeWithPropValuesType nodeWithPropValues: A list type that includes nodes and their property values.
+Type Definition
<complexType name="NodeWithPropValuesListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="nodeWithPropValues" nillable="true" type="NodeWithPropValuesType"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeWithPropValuesType node: A return type for a node and its property values.
+Type Definition
<complexType name="NodeWithPropValuesResponseType">
<sequence>
<element name="node" type="NodeWithPropValuesType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: Node name field.
int id: The system-generated ID field for the node.
string descr: Description of the object.
string versionName: Version name field.
string hierName: Hierarchy name field.
string parentName: Parent node name field.
string nodeType: The nodeType name.
boolean isInactive: Flag indicating that the node is inactive.
boolean hasChildren: Flag indicating that the node has children.
int childCount: The number of children the node has.
boolean isLeaf: Field indicating that the node is a Leaf node.
boolean isApproved: Flag indicating that node approval has been granted.
StringListType displayByPropValueList: List type for the display by properties.
string displayByString: The display by value for the node.
boolean isPrimary: Indicates whether a node has shared nodes that point to it.
boolean isShared: Indicates whether the node is a shared node.
boolean isPrimaryMissing: Indicates whether the shared node points to a primary node that does not exist.
string primaryName: The primary name portion of the shared node name. For non-shared nodes, this property returns the node name in its entirety.
boolean isPrimaryNotInHier: Indicates whether the primary node is not in the same hierarchy.
boolean primaryHasDescendants: Indicates whether the primary node has structure below it. only populated on shared nodes.
PropValueFlexListType propValueList: A type for a node and its property values.
+Type Definition
<complexType name="NodeWithPropValuesType">
<complexContent>
<extension base="NodeType">
<sequence>
<element minOccurs="0" name="propValueList" type="PropValueFlexListType"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

NodeWithPropsListType nodeWithPropsList: A return type that includes a list of nodes and their node property objects.
+Type Definition
<complexType name="NodeWithPropsListResponseType">
<sequence>
<element name="nodeWithPropsList" type="NodeWithPropsListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeWithPropsType nodeWithProps: A type that includes a list of nodes and their node property objects.
+Type Definition
<complexType name="NodeWithPropsListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="nodeWithProps" nillable="true" type="NodeWithPropsType"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeWithPropsType nodeWithProps: A return type that includes a node and its property objects.
+Type Definition
<complexType name="NodeWithPropsResponseType">
<sequence>
<element name="nodeWithProps" type="NodeWithPropsType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: Node name field.
int id: The system-generated ID field for the node.
string descr: Description of the object.
string versionName: Version name field.
string hierName: Hierarchy name field.
string parentName: Parent node name field.
string nodeType: The nodeType name.
boolean isInactive: Flag indicating that the node is inactive.
boolean hasChildren: Flag indicating that the node has children.
int childCount: The number of children the node has.
boolean isLeaf: Field indicating that the node is a Leaf node.
boolean isApproved: Flag indicating that node approval has been granted.
StringListType displayByPropValueList: List type for the display by properties.
string displayByString: The display by value for the node.
boolean isPrimary: Indicates whether a node has shared nodes that point to it.
boolean isShared: Indicates whether the node is a shared node.
boolean isPrimaryMissing: Indicates whether the shared node points to a primary node that does not exist.
string primaryName: The primary name portion of the shared node name. For non-shared nodes, this property returns the node name in its entirety.
boolean isPrimaryNotInHier: Indicates whether the primary node is not in the same hierarchy.
boolean primaryHasDescendants: Indicates whether the primary node has structure below it. only populated on shared nodes.
PropListType propList: A type that includes a node and its property objects.
+Type Definition
<complexType name="NodeWithPropsType">
<complexContent>
<extension base="NodeType">
<sequence>
<element minOccurs="0" name="propList" type="PropListType"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Object access method for accessing import, export, and blender objects.
Valid values are:
  • User - Personal objects that are only available to an individual user to view and run. All user roles have the ability to create and manage objects of this access level.
  • Standard - Public objects that are available to all users to view and run. only Data Manager role users have the ability to create and manage objects of this access level.
  • System - Restricted objects that are only available to Application Administrator role users to view and run. only those users have the ability to create and manage objects of this access level.
+Type Definition
<simpleType name="ObjectAccessEnum">
<restriction base="string">
<enumeration value="System"/>
<enumeration value="Standard"/>
<enumeration value="User"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
Enumeration indicating scope of properties.
+Type Definition
<simpleType name="ObjectScopeEnum">
<restriction base="string">
<enumeration value="All"/>
<enumeration value="Version"/>
<enumeration value="Hierarchy"/>
<enumeration value="GlobalNode"/>
<enumeration value="LocalNode"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

string versionName: Version name field.
+Type Definition
<complexType name="OpenVersion">
<sequence>
<element name="versionName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeLocatorType nodeLocator: Node locator object representing a node within a hierarchy.
StringListType nodeNames: List of nodes to order. The sequence of this list will be used to order the children.
+Type Definition
<complexType name="OrderChildren">
<sequence>
<element name="nodeLocator" type="NodeLocatorType"/>
<element minOccurs="0" name="nodeNames" type="StringListType"/>
</sequence>
</complexType>
Referenced By:
An enumeration that indicates how a users password should expire.
+Type Definition
<simpleType name="PasswordExpireEnum">
<restriction base="string">
<enumeration value="Instantly"/>
<enumeration value="PerSysPref"/>
<enumeration value="Never"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
An enumeration for level 1,2,3 permissions.
+Type Definition
<simpleType name="PermissionEnum">
<restriction base="string">
<enumeration value="NoPermissionRequired"/>
<enumeration value="AuditDataTransactions"/>
<enumeration value="AuditSystemTransactions"/>
<enumeration value="AuditUserTransactions"/>
<enumeration value="BrowseCategories"/>
<enumeration value="BrowseHierarchies"/>
<enumeration value="BrowseProperties"/>
<enumeration value="BrowseVersions"/>
<enumeration value="CreateHierarchies"/>
<enumeration value="CreateRequests"/>
<enumeration value="CreateVersions"/>
<enumeration value="ManageAccess"/>
<enumeration value="ManageAccessGroups"/>
<enumeration value="ManageApplication"/>
<enumeration value="ManageCategories"/>
<enumeration value="ManageHierarchies"/>
<enumeration value="ManageNodeTypes"/>
<enumeration value="ManagePreferences"/>
<enumeration value="ManageProperties"/>
<enumeration value="ManagePropertyAccess"/>
<enumeration value="ManagePropertyLists"/>
<enumeration value="ManageRequests"/>
<enumeration value="ManageRoles"/>
<enumeration value="ManageStandardBlenders"/>
<enumeration value="ManageStandardCompares"/>
<enumeration value="ManageStandardExports"/>
<enumeration value="ManageStandardImports"/>
<enumeration value="ManageStandardQueries"/>
<enumeration value="ManageSystemBlenders"/>
<enumeration value="ManageSystemCompares"/>
<enumeration value="ManageSystemExports"/>
<enumeration value="ManageSystemImports"/>
<enumeration value="ManageSystemQueries"/>
<enumeration value="ManageUserCompares"/>
<enumeration value="ManageUserExports"/>
<enumeration value="ManageUserQueries"/>
<enumeration value="ManageUserImports"/>
<enumeration value="ManageUserBlenders"/>
<enumeration value="ManageUsers"/>
<enumeration value="ManageValidations"/>
<enumeration value="ManageVersions"/>
<enumeration value="RunActionScript"/>
<enumeration value="RunBlender"/>
<enumeration value="RunCompare"/>
<enumeration value="RunExport"/>
<enumeration value="RunImport"/>
<enumeration value="RunQuery"/>
<enumeration value="ManageSystemConfiguration"/>
<enumeration value="RelaxedLockoutMeasures"/>
<enumeration value="AllowNextIdKeyCreation"/>
<enumeration value="AllowLeafPropertyEdit"/>
<enumeration value="AllowInactiveNodeChanges"/>
<enumeration value="AllowRenameLeaf"/>
<enumeration value="AllowRenameLimb"/>
<enumeration value="EnablePropCopyOptions"/>
<enumeration value="InactivateNode"/>
<enumeration value="BrowseExternalConnections"/>
<enumeration value="ManageExternalConnections"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

PermissionEnum permissions: A list type object for PermissionEnums.
+Type Definition
<complexType name="PermissionListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="permissions" nillable="true" type="PermissionEnum"/>
</sequence>
</complexType>
Referenced By:
An enumeration for an action that can be taken on a node property.
+Type Definition
<simpleType name="PropActionEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="Remove"/>
<enumeration value="Lock"/>
<enumeration value="Clear"/>
<enumeration value="ClearAndLock"/>
<enumeration value="Unlock"/>
<enumeration value="RemoveDups"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

PropActionEnum propAction: A list type object for PropActionEnums.
+Type Definition
<complexType name="PropActionListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="propAction" nillable="true" type="PropActionEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

PropCategoryType propCategory: A list type object for PropCategoryType.
+Type Definition
<complexType name="PropCategoryListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="propCategory" nillable="true" type="PropCategoryType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: Name of the property category.
int id: The system-generated ID for the property category.
string descr: Description of the object.
PropCategoryTypeEnum propCategoryType: An enumeration field indicating the type of property category.
boolean availableUserCategory: Flag indicating that the property category is a user property category.
int order: Sort order of the property category.
UserAccessListType users: List of user's and their access levels.
StringListType properties: List of properties for a property category.
+Type Definition
<complexType name="PropCategoryType">
<sequence>
<element name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="descr" type="string"/>
<element name="propCategoryType" type="PropCategoryTypeEnum"/>
<element minOccurs="0" name="availableUserCategory" type="boolean"/>
<element minOccurs="0" name="order" type="int"/>
<element minOccurs="0" name="users" type="UserAccessListType"/>
<element minOccurs="0" name="properties" type="StringListType"/>
</sequence>
</complexType>
Referenced By:
An enumeration indicating the type of property category.
+Type Definition
<simpleType name="PropCategoryTypeEnum">
<restriction base="string">
<enumeration value="Property"/>
<enumeration value="Validation"/>
<enumeration value="NodeAccessGroup"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

string title: Title of the column.
ExportColumnLayoutEnum layout: Enumeration for the justification of the column contents.
string layoutString: (To be deprecated)
ExportColumnCaseEnum changeCaseTo: Enumeration indicating the desired case of the column value.
boolean excludeDefault: Flag indicating if the export should exclude default values for the property.
string defaultValue: Default value for the property definition.
string formatClass: (To be deprecated)
boolean isPrimaryKey: Flag indicating if the column is considered a primary key.
string key: Key is used to determine if duplicates exist.
boolean pivot: Flag indicating that the column value exported has a comma-delimited value. For each value in the list for that column, a row is exported with all other fields set to the same values. The Pivot option may be selected on one column.
boolean useQuotedStrings: Flag indicating that the column value should be surrounded with quotes.
boolean isFixedWidth: Flag that enables you to specify field widths, left or right justification for the column, and number of pad characters.
int width: A value indicating the column width in a fixed width ex
int padChar: Character to pad the column with.
string dbFieldName: If exporting to a database, the name of the field in the database that this column exports to.
DbFieldTypeEnum dbFieldType: If exporting to a database, the data type of this column's values.
int dbFieldLen: If exporting to a database, the allowable length of this column's field in the database.
boolean dbKeyField: If exporting to a database, set to True if this column corresponds to a primary key field in the database table.
int dummy: (To be deprecated)
string propName: Property definition name.
+Type Definition
<complexType name="PropColumnType">
<complexContent>
<extension base="NodeColumnType">
<sequence>
<element minOccurs="0" name="propName" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
An enumeration indicating what types of properties are to be copied.
+Type Definition
<simpleType name="PropCopyModeEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="Overridden"/>
<enumeration value="Selected"/>
<enumeration value="ForceAll"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

PropDefListType propDefList: Return list type for property definitions.
+Type Definition
<complexType name="PropDefListResponseType">
<sequence>
<element name="propDefList" type="PropDefListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

PropDefType propDef: List type for property definitions.
+Type Definition
<complexType name="PropDefListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="propDef" nillable="true" type="PropDefType"/>
</sequence>
</complexType>
Referenced By:

Fields:

int id: system-generated ID for property definition parameter.
string name: The name of the property definition parameter.
string descr: Description of the object.
DataTypeEnum dataType: The property definition parameter data type.
string value: A value for the property definition parameter.
+Type Definition
<complexType name="PropDefParamType">
<sequence>
<element minOccurs="1" name="id" type="int"/>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="1" name="dataType" type="DataTypeEnum"/>
<element minOccurs="0" name="value" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

PropDefType propDef: A return type for a property definition.
+Type Definition
<complexType name="PropDefResponseType">
<sequence>
<element name="propDef" type="PropDefType"/>
</sequence>
</complexType>
Referenced By:

Fields:

int id: A system-generated ID for a property definition.
string name: The name of the property definition.
string namespace: Fully qualified name for a property definition. A namespace is used to avoid conflicts where properties have the same name.
string rootNamespace: The first segment of a namespace. Customer applications always have a blank root namespace.
string descr: Description of the object.
string editorLabel: Label of the property definition.
PropLevelEnum propLevel: An enumeration field indicating the property level.
boolean isGlobal: Flag indicating that the property is a global property.
DataTypeEnum dataType: Data type field for property definition.
boolean isInheritable: Flag indicating if the property definition is a inheriting property.
PropTypeEnum propType: The property type field for the property definition.
string propClass: String representation of the property definition type. Example: Formula
boolean isRestrictedToAllowedValues: (To be deprecated)
StringListType allowedValues: If a list type property, a list of allowed values for the property definition.
string defaultValue: A default value for the property definition.
int lookupPropDefId: If the property definition is a lookup type property then this
boolean isReadOnly: Flag indicating if the property is read only; for instance, if the property is a formula type property.
boolean isHidden: Flag indicating if the property is a hidden property.
boolean isList: Flag indicating that the property has allowed values.
PropCategoryListType propCategoryList: List of property categories for the property definition.
int columnWidth: A default column width value for the property definition; this value is used mainly by fixed with type exports and imports.
int maxColumnWidth: A maximum length width value for the property definition.
string minValue: Minimum value/length for the property/string.
string maxValue: Maximum value/length for the property/string.
PropLevelListType allowedPropLevelList: List of enumerations indicating the allowed property levels.
boolean approvalMgrProp: Flag indicating if the property definition is a node approval type property.
boolean changeMgrProp: Flag indicating if the property definition is a change tracking type property.
AccessLevelEnum accessLevel: The current users access level for the property.
PropParamListType propParams: List of PropDefParamType types.
NameValueListType lookupValues: Field is a NameValueListType type.
+Type Definition
<complexType name="PropDefType">
<sequence>
<element minOccurs="1" name="id" type="int"/>
<element minOccurs="1" name="name" type="string"/>
<element minOccurs="1" name="namespace" type="string"/>
<element minOccurs="1" name="rootNamespace" type="string"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="editorLabel" type="string"/>
<element minOccurs="0" name="propLevel" type="PropLevelEnum"/>
<element minOccurs="0" name="isGlobal" type="boolean"/>
<element minOccurs="0" name="dataType" type="DataTypeEnum"/>
<element minOccurs="0" name="isInheritable" type="boolean"/>
<element minOccurs="0" name="propType" type="PropTypeEnum"/>
<element minOccurs="0" name="propClass" type="string"/>
<element minOccurs="0" name="isRestrictedToAllowedValues" type="boolean"/>
<element minOccurs="0" name="allowedValues" type="StringListType"/>
<element minOccurs="0" name="defaultValue" type="string"/>
<element minOccurs="0" name="lookupPropDefId" type="int"/>
<element minOccurs="0" name="isReadOnly" type="boolean"/>
<element minOccurs="0" name="isHidden" type="boolean"/>
<element minOccurs="0" name="isList" type="boolean"/>
<element minOccurs="0" name="propCategoryList" type="PropCategoryListType"/>
<element minOccurs="0" name="columnWidth" type="int"/>
<element minOccurs="0" name="maxColumnWidth" type="int"/>
<element minOccurs="0" name="minValue" type="string"/>
<element minOccurs="0" name="maxValue" type="string"/>
<element minOccurs="0" name="allowedPropLevelList" type="PropLevelListType"/>
<element minOccurs="0" name="approvalMgrProp" type="boolean"/>
<element minOccurs="0" name="changeMgrProp" type="boolean"/>
<element minOccurs="0" name="accessLevel" type="AccessLevelEnum"/>
<element minOccurs="0" name="propParams" type="PropParamListType"/>
<element minOccurs="0" name="lookupValues" type="NameValueListType"/>
</sequence>
</complexType>
Referenced By:
Enumeration indicating the level of a property definition.
+Type Definition
<simpleType name="PropLevelEnum">
<restriction base="string">
<enumeration value="Node"/>
<enumeration value="Hier"/>
<enumeration value="Version"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

PropLevelEnum propLevel: List of property levels.
+Type Definition
<complexType name="PropLevelListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="propLevel" nillable="true" type="PropLevelEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

ObjectAccessEnum objectAccess: Object access of the export.
string name: Name field of the export.
int id: The system-generated ID.
string descr: Description of the object.
string exportClass: The fully qualified class name of the export type, including namespace. Example: Oracle.Drm.Engine.Core.ExportManager.TransactionLogExport.
VersionParamsType currentVersionParams: Current version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
VersionParamsType previousVersionParams: The previous version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
boolean useQuotedStrings: Puts quotation marks around strings in the export.
string recordDelimiter: A sequence of characters used to specify the record boundary.
boolean useFixedWidth: Flag that indicates that the export is to be a fixed-width export.
boolean insertHeaderFooterBlankLines: Flag that instructs the server to add a line between the header/footer and the body of the export results.
CharacterEncodingEnum characterEncoding: Enumeration indicating encoding of the text file.
boolean hasColumnHeaders: Flag indicating that the export result should include column header label.
ExportColumnListType columns: List of columns to export.
CustomExportParamListType customParams: Parameter values used by custom exports.
string queryName: Name of the query to apply to the export.
string validationName: Name of the validation to apply to the export.
boolean includeInactive: Flag indicating that the export results should include inactive nodes.
ExportOutputModeEnum outputMode: Enumeration of what type of medium the export results should be exported to.
string fileName: Name of the file to be exported.
string includeFileConnection: External connection name to be used if exporting to a server device.
boolean dbClearOnVersion: If exporting to a database, indicates whether export table records with KeyFields containing this export's version ID will be deleted before inserting export output records.
boolean dbClearTable: If exporting to a database, clears the table before exporting.
string dbConnectionString: If exporting to a database, connection string to the database.
string dbExportDAL: The fully qualified name (including namespace) of the export data access layer class that implements IExportDalFactory. This class will be used to create the export DAL used for this export's output.
boolean dbOutputEnabled: Indicates whether the export's type allows its output to be directed to a database. Note that this is a read-only field as far as the API is concerned. Any value for this property that is set though the API will be ignored.
string dbPassword: (To be deprecated)
string dbTableName: If exporting to a database, database table name to export to.
boolean dbUseFastAppends: If exporting to a database, indicates whether the export DAL table will be populated more quickly by using the SQL BulkUpdate facility. This is based on provider support.
boolean dbUseFastDeletes: Indicates whether an export table with data will cleared more quickly by using a SQL table "truncate" command rather than line-by-line deleting of records.
boolean dbUseTransactions: Determines whether records for this export's output will be inserted inside a database transaction. This parameter will be used only when the output mode is Table.
string dbUserName: The database user name that will be used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string dbVendor: The database vendor string used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string delimiter: Delimits values in a row of export output.
string header: Header text for the export output.
string footer: Footer text for the export output.
StringListType fromList: Array of string values to replace in the export results. Currently three string items are supported.
string fromStrValue: A string value representing each item in the fromList array delimited by a comma.
StringListType toList: Array of string values that are replacing values for the values in the fromList field. Currently three string items are supported.
string toStrValue: A string value representing each item in the toList array delimited by a comma.
string userName: User name associated with this export.
int userId: User ID associated with this export.
boolean hasWarning: Indicates whether a WarningMessage has been encountered during this export's execution.
StringListType warningMessages: Warnings that were encountered during export execution.
string propName: Name of the property definition.
+Type Definition
<complexType name="PropListExportType">
<complexContent>
<extension base="ExportType">
<sequence>
<element minOccurs="0" name="propName" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

PropListType propList: Return list type field of PropListType types.
+Type Definition
<complexType name="PropListResponseType">
<sequence>
<element name="propList" type="PropListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

PropType prop: List type field of property definitions.
+Type Definition
<complexType name="PropListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="prop" nillable="true" type="PropType"/>
</sequence>
</complexType>
Referenced By:

Fields:

PropDefParamType propParam: List type field of property parameters.
+Type Definition
<complexType name="PropParamListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="propParam" nillable="true" type="PropDefParamType"/>
</sequence>
</complexType>
Referenced By:
Enumeration indicating the property selection type.
+Type Definition
<simpleType name="PropSelectModeEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="Selected"/>
<enumeration value="All"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

string name: Node property name.
string value: Node property value.
PropValueOriginEnum valueOrigin: An enumeration indicating the origin of the property value.
PropTypeEnum propType: An enumeration indicating the property type of the node property.
AccessLevelEnum accessLevel: The access level the current user has to this node property.
PropActionEnum propAction: Property action enumeration indicating the treatment of the node property upon update.
boolean isLocked: Flag indicating it the node property has been locked by a user.
boolean isModified: Flag to signal that the property is modified; this is an indicator that should be set to True when updating node properties.
string sourceHier: The hierarchy name field.
string sourceNode: The node name field.
PropActionListType validPropActionList: List type object for PropActionEnum.
+Type Definition
<complexType name="PropType">
<sequence>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="value" type="string"/>
<element minOccurs="0" name="valueOrigin" type="PropValueOriginEnum"/>
<element minOccurs="0" name="propType" type="PropTypeEnum"/>
<element minOccurs="0" name="accessLevel" type="AccessLevelEnum"/>
<element minOccurs="0" name="propAction" type="PropActionEnum"/>
<element minOccurs="0" name="isLocked" type="boolean"/>
<element minOccurs="0" name="isModified" type="boolean"/>
<element minOccurs="0" name="sourceHier" type="string"/>
<element minOccurs="0" name="sourceNode" type="string"/>
<element minOccurs="0" name="validPropActionList" type="PropActionListType"/>
</sequence>
</complexType>
Referenced By:
Enumeration for property type.
+Type Definition
<simpleType name="PropTypeEnum">
<restriction base="string">
<enumeration value="Invalid"/>
<enumeration value="System"/>
<enumeration value="Defined"/>
<enumeration value="Lookup"/>
<enumeration value="Derived"/>
<enumeration value="Stats"/>
<enumeration value="Validation"/>
<enumeration value="Verification"/>
<enumeration value="LimbAccessGroup"/>
<enumeration value="LeafAccessGroup"/>
<enumeration value="UserSpecific"/>
<enumeration value="RWDerived"/>
<enumeration value="SharedInfo"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

NameValueListType propNameValueList: Name/Value Pair list field for property definition name and value for the node property value.
StringListType propValueList: A string list type of values.
+Type Definition
<complexType name="PropValueFlexListType">
<sequence>
<element minOccurs="0" name="propNameValueList" type="NameValueListType"/>
<element minOccurs="0" name="propValueList" type="StringListType"/>
</sequence>
<attribute name="propValueListType" type="tns:PropValueListTypeEnum"/>
</complexType>
Referenced By:
Enumeration indicating how property values are to be returned.
+Type Definition
<simpleType name="PropValueListTypeEnum">
<restriction base="string">
<enumeration value="NameValuePairs"/>
<enumeration value="ValuesOnly"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
Enumeration indicating the property value origin.
+Type Definition
<simpleType name="PropValueOriginEnum">
<restriction base="string">
<enumeration value="Default"/>
<enumeration value="Inherited"/>
<enumeration value="Overridden"/>
<enumeration value="InheritedHier"/>
<enumeration value="InheritedVer"/>
<enumeration value="Derived"/>
<enumeration value="Unknown"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

PropValueFlexListType propValueFlexList: A field that includes a list of PropValueFlexListType objects.
+Type Definition
<complexType name="PropValuesResponseType">
<sequence>
<element name="propValueFlexList" type="PropValueFlexListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryCriteriaType queryCriteria: List type field for queryCriteriaType.
+Type Definition
<complexType name="QueryCriteriaListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="queryCriteria" nillable="true" type="QueryCriteriaType"/>
</sequence>
</complexType>
Referenced By:

Fields:

int numOpenParens: The number of open parenthesis.
string propDefName: A property definition name.
ComparisonOperatorEnum comparisonOperator: An enumeration indicating a comparison operator.
string comparisonStringValue: The criteria value.
int numCloseParens: The number of closed parenthesis.
JoinOperatorEnum joinOperator: Enumeration that can be used to specify a compound condition.
string critDescr: Description of the query criteria.
string formulaLine: Read only field that includes a string representation of the criteria.
string formulaLineWithoutJoinOperator: Read only field that includes a string representation of the criteria without the join operator value.
boolean includeInherited: Flag indicating if nodes that inherit property values should be included in the results.
+Type Definition
<complexType name="QueryCriteriaType">
<sequence>
<element minOccurs="0" name="numOpenParens" type="int"/>
<element minOccurs="0" name="propDefName" type="string"/>
<element minOccurs="0" name="comparisonOperator" type="ComparisonOperatorEnum"/>
<element minOccurs="0" name="comparisonStringValue" type="string"/>
<element minOccurs="0" name="numCloseParens" type="int"/>
<element minOccurs="0" name="joinOperator" type="JoinOperatorEnum"/>
<element minOccurs="0" name="critDescr" type="string"/>
<element minOccurs="0" name="formulaLine" type="string"/>
<element minOccurs="0" name="formulaLineWithoutJoinOperator" type="string"/>
<element minOccurs="0" name="includeInherited" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryListType queryList: Field for a queryListType object.
+Type Definition
<complexType name="QueryListResponseType">
<sequence>
<element name="queryList" type="QueryListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryType query: Field for a queryType object.
+Type Definition
<complexType name="QueryListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="query" nillable="true" type="QueryType"/>
</sequence>
</complexType>
Referenced By:

Fields:

RequestQueryParamsType requestQueryParams: Field for request query parameters.
+Type Definition
<complexType name="QueryRequests">
<sequence>
<element name="requestQueryParams" type="RequestQueryParamsType"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryType query: A query type object.
+Type Definition
<complexType name="QueryResponseType">
<sequence>
<element name="query" type="QueryType"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryResultListType queryResultList: A list response type for query results.
+Type Definition
<complexType name="QueryResultListResponseType">
<sequence>
<element name="queryResultList" type="QueryResultListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryResultType queryResult: A list type of queryResultType types.
+Type Definition
<complexType name="QueryResultListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="queryResult" nillable="true" type="QueryResultType"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryResultType queryResult: A list type of queryResultType types.
+Type Definition
<complexType name="QueryResultResponseType">
<sequence>
<element name="queryResult" type="QueryResultType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
NodeWithPropValuesListType nodeList: A type that includes a list of nodes and their property values.
StringListType requestedPropNames: A string list type of property names.
boolean maxNodesExceeded: A flag indicating that a query exceeded the number of nodes specified in queryType.
int totalNodeCount: The total number of nodes in the query result.
+Type Definition
<complexType name="QueryResultType">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element minOccurs="0" name="nodeList" type="NodeWithPropValuesListType"/>
<element minOccurs="0" name="requestedPropNames" type="StringListType"/>
<element minOccurs="0" name="maxNodesExceeded" type="boolean"/>
<element minOccurs="0" name="totalNodeCount" type="int"/>
</sequence>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string descr: Description of compare or query criteria.
boolean markNodes: Indicates that the result of the query or compare should Mark nodes.
boolean expandToMarkedNodes: Indicates that the result tree should be expanded.
boolean showList: Indicates that the result display should show a list of the results.
ObjectAccessEnum objectAccess: The object access enumeration for the query.
string name: The name field for the query.
int id: The system-generated ID for the query.
VersionParamsType versionParams: Version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction id.
NodeLocatorType topNode: Top node field for the query.
QueryCriteriaListType queryCriteriaList: A list of query criteria to be used during a query run.
boolean displayCriteria: Flag to automatically include properties referenced in the filter criteria in the query results.
string displayLabel: Label of the query.
boolean expandList: Flag indicating if the results should be expanded.
FilterChildrenEnum filterChildren: Flag to filter children in the result set.
boolean isGlobalQuery: Flag indicating if the query is a global query. If this flag is set to False then a hierarchy/top node pair must be chosen.
boolean includeChildren: Flag indicating if the query results should include children of the node that matches the criteria..
boolean includeParents: Flag indicating if the query results should include parents of the node that matches the criteria.
boolean isInclusive: Includes the node that matches the criteria.
int maxNodes: Maximum node threshold; used to limit the number of nodes in the result.
int userId: User ID that the query is owned by.
string userName: Username that the query is owned by.
boolean userDefined: Flag indicating if this is a user defined query instead of a system defined query. A user defined query is one that is normally created through the query interface while a system query is one that can be created for compare or export purposes and does not show up in the query select screen.
+Type Definition
<complexType name="QueryType">
<complexContent>
<extension base="BaseParamsType">
<sequence>
<element minOccurs="1" name="objectAccess" type="ObjectAccessEnum"/>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="1" name="id" type="int"/>
<element minOccurs="0" name="versionParams" type="VersionParamsType"/>
<element minOccurs="0" name="topNode" type="NodeLocatorType"/>
<element minOccurs="0" name="queryCriteriaList" type="QueryCriteriaListType"/>
<element minOccurs="1" name="displayCriteria" type="boolean"/>
<element minOccurs="0" name="displayLabel" type="string"/>
<element minOccurs="1" name="expandList" type="boolean"/>
<element minOccurs="1" name="filterChildren" type="FilterChildrenEnum"/>
<element minOccurs="1" name="isGlobalQuery" type="boolean"/>
<element minOccurs="1" name="includeChildren" type="boolean"/>
<element minOccurs="1" name="includeParents" type="boolean"/>
<element minOccurs="1" name="isInclusive" type="boolean"/>
<element minOccurs="1" name="maxNodes" type="int"/>
<element minOccurs="1" name="userId" type="int"/>
<element minOccurs="0" name="userName" type="string"/>
<element minOccurs="1" name="userDefined" type="boolean"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
+Type Definition
<complexType name="ReactivateNode">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: List of node names to reactivate.
+Type Definition
<complexType name="ReactivateNodes">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:
Enumeration indicating the type of relationship for a given node.
+Type Definition
<simpleType name="RelationshipEnum">
<restriction base="string">
<enumeration value="Child"/>
<enumeration value="Descendant"/>
<enumeration value="Ancestor"/>
<enumeration value="Siblings"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
Enumeration used during a blend which indicates how removes should be treated.
+Type Definition
<simpleType name="RemoveModeEnum">
<restriction base="string">
<enumeration value="Remove"/>
<enumeration value="Mark"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
+Type Definition
<complexType name="RemoveNode">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType nodeNameList: A list of node names to remove.
+Type Definition
<complexType name="RemoveNodes">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:
Enumeration indicating a request item type.
+Type Definition
<simpleType name="RequestActionEnum">
<restriction base="string">
<enumeration value="VersionPropUpdate"/>
<enumeration value="VersionPropRemove"/>
<enumeration value="VersionAddOrphan"/>
<enumeration value="VersionAssignValidations"/>
<enumeration value="HierAdd"/>
<enumeration value="HierPropUpdate"/>
<enumeration value="HierPropRemove"/>
<enumeration value="HierChangeTopNode"/>
<enumeration value="HierAssignValidations"/>
<enumeration value="NodeAdd"/>
<enumeration value="NodeAddInsert"/>
<enumeration value="NodeInsert"/>
<enumeration value="NodeDelete"/>
<enumeration value="NodeActivate"/>
<enumeration value="NodeInactivate"/>
<enumeration value="NodeRemove"/>
<enumeration value="NodeMove"/>
<enumeration value="NodeDestroy"/>
<enumeration value="NodeAnnul"/>
<enumeration value="NodeAnnulAllBelow"/>
<enumeration value="NodePropUpdate"/>
<enumeration value="NodePropRemove"/>
<enumeration value="NodePropRemoveDuplicates"/>
<enumeration value="NodePropClearBelow"/>
<enumeration value="NodePropLock"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

RequestHeaderListType requestHeaderList: List of request headers.
+Type Definition
<complexType name="RequestHeaderListResponseType">
<sequence>
<element name="requestHeaderList" type="RequestHeaderListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

RequestHeaderType requestHeader: The request header type.
+Type Definition
<complexType name="RequestHeaderListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="requestHeader" nillable="true" type="RequestHeaderType"/>
</sequence>
</complexType>
Referenced By:

Fields:

int id: The system-generated ID of the request.
string versionName: Version name field.
string ownedBy: The owner of the request.
string createdBy: The user that created the request.
dateTime createdDateTime: The date and time that the request was created.
string updatedBy: The user that updates the request.
dateTime updatedDateTime: The date and time that the request was updated.
string approvedBy: Approval field indicating if the request was approved. Set by the server during approve request operation (if successful).
dateTime approvedDateTime: Approval field for the date and time that the request was approved. Set by the server during approve request operation (if successful).
string committedBy: Approval field indicating the user that approved the request. Set by the server during approve request operation (if successful).
boolean isValidated: Field indicating that the request has been validated.
boolean isApproved: Field indicating that the request has been approved. Set by the server during approve request operation (if successful).
StringListType validationList: List of validations to run for the request.
string workflowInfo: Free-form field to be used updated by external systems.
string externalId: Free-form field to be used updated by external systems.
string externalLabel: Free-form field to be used updated by external systems.
string externalStatus: Free-form field to be used updated by external systems.
string comment: Free-form field to be used updated by external systems.
+Type Definition
<complexType name="RequestHeaderType">
<sequence>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="versionName" type="string"/>
<element minOccurs="0" name="ownedBy" type="string"/>
<element minOccurs="0" name="createdBy" type="string"/>
<element minOccurs="0" name="createdDateTime" type="dateTime"/>
<element minOccurs="0" name="updatedBy" type="string"/>
<element minOccurs="0" name="updatedDateTime" type="dateTime"/>
<element minOccurs="0" name="approvedBy" type="string"/>
<element minOccurs="0" name="approvedDateTime" type="dateTime"/>
<element minOccurs="0" name="committedBy" type="string"/>
<element minOccurs="0" name="isValidated" type="boolean"/>
<element minOccurs="0" name="isApproved" type="boolean"/>
<element minOccurs="0" name="validationList" type="StringListType"/>
<element minOccurs="0" name="workflowInfo" type="string"/>
<element minOccurs="0" name="externalId" type="string"/>
<element minOccurs="0" name="externalLabel" type="string"/>
<element minOccurs="0" name="externalStatus" type="string"/>
<element minOccurs="0" name="comment" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

RequestItemType requestItem: List of request item types.
+Type Definition
<complexType name="RequestItemListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="requestItem" nillable="true" type="RequestItemType"/>
</sequence>
</complexType>
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
+Type Definition
<complexType name="RequestItemType">
<sequence>
<element minOccurs="0" name="requestId" type="int"/>
<element minOccurs="0" name="itemId" type="int"/>
<element minOccurs="0" name="action" type="RequestActionEnum"/>
<element minOccurs="0" name="customValue" type="string"/>
</sequence>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int id: The system-generated ID for a request.
StringParamsType versionName: Version name field.
StringParamsType hierName: Hierarchy name field.
StringParamsType nodeName: Node name field.
string ownedBy: The owner of the request.
StringParamsType createdBy: The user that created the request.
DateParamsType createdDateTime: The create date type that the request was created.
StringParamsType updatedBy: The user that updated the request.
DateParamsType updatedDateTime: The date and time the request was updated.
StringParamsType approvedBy: Approval field indicating the user that approved the request. Set by the server during approve request operation (if successful).
DateParamsType approvedDateTime: Approval field indication the approval date and time for the request. Set by the server during approve request operation (if successful).
string committedBy: Field indicating the user that committed the request. Set by the server during approve request operation (if successful).
BooleanParamMethodEnum isValidated: Field indicating that the request has been validated.
BooleanParamMethodEnum isApproved: Field indicating that the request has been approved. Set by the server during approve request operation (if successful).
StringParamsType externalId: Free-form field to be used updated by external systems.
StringParamsType externalLabel: Free-formfield to be used updated by external systems.
StringParamsType externalStatus: Free-form field to be used updated by external systems.
StringParamsType comment: Free-form field to be used updated by external systems.
int maxResultCount: Max result threshold count; used to limit the results that are returned.
+Type Definition
<complexType name="RequestQueryParamsType">
<sequence>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="versionName" type="StringParamsType"/>
<element minOccurs="0" name="hierName" type="StringParamsType"/>
<element minOccurs="0" name="nodeName" type="StringParamsType"/>
<element minOccurs="0" name="ownedBy" type="string"/>
<element minOccurs="0" name="createdBy" type="StringParamsType"/>
<element minOccurs="0" name="createdDateTime" type="DateParamsType"/>
<element minOccurs="0" name="updatedBy" type="StringParamsType"/>
<element minOccurs="0" name="updatedDateTime" type="DateParamsType"/>
<element minOccurs="0" name="approvedBy" type="StringParamsType"/>
<element minOccurs="0" name="approvedDateTime" type="DateParamsType"/>
<element minOccurs="0" name="committedBy" type="string"/>
<element minOccurs="0" name="isValidated" type="BooleanParamMethodEnum"/>
<element minOccurs="0" name="isApproved" type="BooleanParamMethodEnum"/>
<element minOccurs="0" name="externalId" type="StringParamsType"/>
<element minOccurs="0" name="externalLabel" type="StringParamsType"/>
<element minOccurs="0" name="externalStatus" type="StringParamsType"/>
<element minOccurs="0" name="comment" type="StringParamsType"/>
<element minOccurs="0" name="maxResultCount" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

RequestType request: The request object.
+Type Definition
<complexType name="RequestResponseType">
<sequence>
<element name="request" type="RequestType"/>
</sequence>
</complexType>
Referenced By:

Fields:

RequestHeaderType header: The request header field.
RequestItemListType itemList: The list of request items.
+Type Definition
<complexType name="RequestType">
<sequence>
<element minOccurs="0" name="header" type="RequestHeaderType"/>
<element minOccurs="0" name="itemList" type="RequestItemListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

RequestValidationResultType requestValidationResult: The request validation result. Returned when one validates a request.
+Type Definition
<complexType name="RequestValidationResponseType">
<sequence>
<element name="requestValidationResult" type="RequestValidationResultType"/>
</sequence>
</complexType>
Referenced By:

Fields:

RequestValidationResultItemType requestValidationResultItem: List of request validation result items. Returned when one validates a request.
+Type Definition
<complexType name="RequestValidationResultItemListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="requestValidationResultItem" nillable="true" type="RequestValidationResultItemType"/>
</sequence>
</complexType>
Referenced By:

Fields:

int itemId: A system-generated ID for the request validation result item.
SuccessStateEnum successState: Enumeration indicating the state of the request item.
string reason: If the success state indicates an error, this field will include the reason for the failure. For example, the validation description would be included in this field if a validation failed during the approve request operation.
+Type Definition
<complexType name="RequestValidationResultItemType">
<sequence>
<element name="itemId" type="int"/>
<element minOccurs="0" name="successState" type="SuccessStateEnum"/>
<element name="reason" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

RequestValidationResultNodeType requestValidationResultNode: List of request validation results.
+Type Definition
<complexType name="RequestValidationResultNodeListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="requestValidationResultNode" nillable="true" type="RequestValidationResultNodeType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: The name of a node.
StringListType errorList: String list indicating errors for the node.
+Type Definition
<complexType name="RequestValidationResultNodeType">
<sequence>
<element name="name" type="string"/>
<element minOccurs="0" name="errorList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

int requestId: The system-generated ID of the request validation result item.
SuccessStateEnum successState: An enumeration field indicating the status of the request after a validate or approve request operation. For example, if any validation errors occurred after validating a request this field would indicate an error.
RequestValidationResultItemListType itemList: The list of request items and their state.
RequestValidationResultNodeListType validationNodes: List of nodes and their validation failures.
+Type Definition
<complexType name="RequestValidationResultType">
<sequence>
<element name="requestId" type="int"/>
<element minOccurs="0" name="successState" type="SuccessStateEnum"/>
<element minOccurs="0" name="itemList" type="RequestValidationResultItemListType"/>
<element minOccurs="0" name="validationNodes" type="RequestValidationResultNodeListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string blenderName: The name of a blender.
string sourceVersionName: The source version name.
string targetVersionName: The target version name.
ObjectAccessEnum access: Access level of the blender to run.
string newVersionName: If present, the new version name that will be created as a result of the blend operation instead of blending into the target version.
string newVersionDescr: If present, the new version description that will be created as a result of the blend operation instead of blending into the target version.
int timeoutDuration: A timeout value in milliseconds to stop waiting for blender results.
+Type Definition
<complexType name="RunBlenderByName">
<sequence>
<element name="blenderName" type="string"/>
<element name="sourceVersionName" type="string"/>
<element name="targetVersionName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
<element minOccurs="0" name="newVersionName" type="string"/>
<element minOccurs="0" name="newVersionDescr" type="string"/>
<element minOccurs="0" name="timeoutDuration" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

CompareType compareCriteria: The compare criteria to be used to run the compare.
StringListType returnPropNameList: List of property values to return after the compare.
+Type Definition
<complexType name="RunCompare">
<sequence>
<element name="compareCriteria" type="CompareType"/>
<element minOccurs="0" name="returnPropNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string compareName: The compare name to run.
string fromVersionName: The source version name for the compare.
string toVersionName: The target version name for the compare.
ObjectAccessEnum access: Access level of the compare to run.
StringListType returnPropNameList: List of property values to return after the compare.
+Type Definition
<complexType name="RunCompareByName">
<sequence>
<element name="compareName" type="string"/>
<element name="fromVersionName" type="string"/>
<element name="toVersionName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
<element minOccurs="0" name="returnPropNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryType query: The query criteria for the global query.
StringListType propNameList: List of property values to return after the query.
+Type Definition
<complexType name="RunGlobalQuery">
<sequence>
<element name="query" type="QueryType"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryType query: The query criteria for the local query.
StringListType propNameList: List of property values to return after the query.
+Type Definition
<complexType name="RunQuery">
<sequence>
<element name="query" type="QueryType"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType validationNameList: List of validation names to run for the hierarchy.
int maxNodes: The maximum number of results to return for the validation run.
StringListType propNameList: List of properties to return in the validation results.
+Type Definition
<complexType name="RunValidateHier">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element minOccurs="0" name="validationNameList" type="StringListType"/>
<element minOccurs="0" name="maxNodes" type="int"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
StringListType validationNameList: List of validation names to run for the node.
boolean recurse: Flag indicating if the validation should run the node specified and its descendants.
int maxNodes: The maximum number of validation results to return.
StringListType propNameList: List of properties to return in the validation results.
+Type Definition
<complexType name="RunValidateNode">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element minOccurs="0" name="validationNameList" type="StringListType"/>
<element minOccurs="0" name="recurse" type="boolean"/>
<element minOccurs="0" name="maxNodes" type="int"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
StringListType validationNameList: List of validation names to run for the version.
int maxNodes: The maximum number of validation results to return.
StringListType propNameList: List of properties to return in the validation results.
+Type Definition
<complexType name="RunValidateVersion">
<sequence>
<element name="versionName" type="string"/>
<element minOccurs="0" name="validationNameList" type="StringListType"/>
<element minOccurs="0" name="maxNodes" type="int"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

base64Binary compressedFileContent: Byte array of compressed bytes that represent the script file. The deflate algorithm should be used to decompress the content.
string delimiter: The delimiter value used in the script flat file.
boolean useQuotedStrings: Set to True to process quotation marks.
StringListType columns: Row column names that correspond to the column indices.
ArrayOfFlatFileActionColEnum columnIndices: Column data for the action script row.
int returnBatchSize: The number of action items to return in a batch.
+Type Definition
<complexType name="ScriptLoadParamsType">
<sequence>
<element name="compressedFileContent" type="base64Binary"/>
<element minOccurs="0" name="delimiter" type="string"/>
<element minOccurs="0" name="useQuotedStrings" type="boolean"/>
<element minOccurs="0" name="columns" type="StringListType"/>
<element minOccurs="0" name="columnIndices" type="ArrayOfFlatFileActionColEnum"/>
<element minOccurs="0" name="returnBatchSize" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string propName: Property name field.
string searchString: The search criteria value. An asterisk (*) can be supplied as a wildcard character.
int maxNodes: The maximum number of nodes to return in the result.
StringListType returnPropNameList: List of properties to return in the results.
+Type Definition
<complexType name="SearchForNodesInHier">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="propName" type="string"/>
<element name="searchString" type="string"/>
<element minOccurs="0" name="maxNodes" type="int"/>
<element minOccurs="0" name="returnPropNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string propName: Property name field.
string searchString: The search criteria value. An asterisk (*) can be supplied as a wildcard character.
int maxNodes: The maximum number of nodes to return in the result.
StringListType returnPropNameList: List of properties to return in the results.
+Type Definition
<complexType name="SearchForNodesInVersion">
<sequence>
<element name="versionName" type="string"/>
<element name="propName" type="string"/>
<element name="searchString" type="string"/>
<element minOccurs="0" name="maxNodes" type="int"/>
<element minOccurs="0" name="returnPropNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string topNodeName: The top node name.
+Type Definition
<complexType name="SetHierTopNode">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="topNodeName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
StringListType validationNameList: List of validation names.
+Type Definition
<complexType name="SetHierValidations">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="validationNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string userName: The username field.
string newPassword: The new password for the user.
PasswordExpireEnum passwordExpireType: An enumeration indicating how the password should expire.
+Type Definition
<complexType name="SetUserPassword">
<sequence>
<element minOccurs="0" name="userName" type="string"/>
<element minOccurs="0" name="newPassword" type="string"/>
<element name="passwordExpireType" type="PasswordExpireEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
StringListType validationNameList: List of version names.
+Type Definition
<complexType name="SetVersionValidations">
<sequence>
<element name="versionName" type="string"/>
<element name="validationNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string blenderName: The blender name field.
string sourceVersionName: The source version name.
string targetVersionName: The target version name.
ObjectAccessEnum access: The object access level of the blender.
string newVersionName: If present, the new version name that will be created as a result of the blend operation instead of blending into the target version.
string newVersionDescr: If present, the new version description that will be created as a result of the blend operation instead of blending into the target version.
+Type Definition
<complexType name="StartBlenderByName">
<sequence>
<element name="blenderName" type="string"/>
<element name="sourceVersionName" type="string"/>
<element name="targetVersionName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
<element minOccurs="0" name="newVersionName" type="string"/>
<element minOccurs="0" name="newVersionDescr" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string bookName: The book name field.
ObjectAccessEnum access: The object access field for the book.
string fromVersionName: The current version name.
string toVersionName: The previous version name.
+Type Definition
<complexType name="StartBookByName">
<sequence>
<element name="bookName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
<element name="fromVersionName" type="string"/>
<element name="toVersionName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

CompareType compareCriteria: The compare criteria to be used for the compare.
StringListType returnPropNameList: List of properties to return in the results.
+Type Definition
<complexType name="StartCompare">
<sequence>
<element name="compareCriteria" type="CompareType"/>
<element minOccurs="0" name="returnPropNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string compareName: The compare name field.
string fromVersionName: The from version name field.
string toVersionName: The to version name field.
ObjectAccessEnum access: The object access field for the book.
StringListType returnPropNameList: List of properties to return in the results.
+Type Definition
<complexType name="StartCompareByName">
<sequence>
<element name="compareName" type="string"/>
<element name="fromVersionName" type="string"/>
<element name="toVersionName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
<element minOccurs="0" name="returnPropNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string exportName: The name of the compare export.
string fromVersionName: The from version name field.
string toVersionName: The to version name field.
ObjectAccessEnum access: The object access level of the export.
+Type Definition
<complexType name="StartCompareExportByName">
<sequence>
<element name="exportName" type="string"/>
<element name="fromVersionName" type="string"/>
<element name="toVersionName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string exportName: The name of the compare export.
string fromVersionName: The from version name field.
string fromHierName: The from hierarchy name field.
string toVersionName: The to version name field.
string toHierName: The to hierarchy name field.
ObjectAccessEnum access: Access level of the export to run.
+Type Definition
<complexType name="StartCompareExportByNameOnHier">
<sequence>
<element name="exportName" type="string"/>
<element name="fromVersionName" type="string"/>
<element name="fromHierName" type="string"/>
<element name="toVersionName" type="string"/>
<element minOccurs="0" name="toHierName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string exportName: The name of the compare export.
string fromVersionName: The from version name field.
HierNodeNamePairType fromHierNode: The from hierarchy name field.
string toVersionName: The to version name field.
HierNodeNamePairType toHierNode: The to hierarchy name field.
ObjectAccessEnum access: Access level of the export to run.
+Type Definition
<complexType name="StartCompareExportByNameOnHierNode">
<sequence>
<element name="exportName" type="string"/>
<element name="fromVersionName" type="string"/>
<element name="fromHierNode" type="HierNodeNamePairType"/>
<element name="toVersionName" type="string"/>
<element minOccurs="0" name="toHierNode" type="HierNodeNamePairType"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string sourceVersionName: The name of the version to copy.
string destVersionName: The new name of the version.
string destDescr: The new description field of the version.
boolean clearApproval: Flag indicating that the approval flags should be cleared.
boolean clearChanged: Flag indicating that the changed on properties should be cleared.
boolean dbConnect: Flag indicating that the version should be persisted to the data store.
+Type Definition
<complexType name="StartCopyVersion">
<sequence>
<element name="sourceVersionName" type="string"/>
<element name="destVersionName" type="string"/>
<element minOccurs="0" name="destDescr" type="string"/>
<element minOccurs="0" name="clearApproval" type="boolean"/>
<element minOccurs="0" name="clearChanged" type="boolean"/>
<element minOccurs="0" name="dbConnect" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
int endTxnId: Ending transaction ID field.
+Type Definition
<complexType name="StartCreateAsOfTxnID">
<sequence>
<element name="versionName" type="string"/>
<element name="endTxnId" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
dateTime asOfDateTime: A date time value to create the version snapshot.
+Type Definition
<complexType name="StartCreateVersionAsOfDate">
<sequence>
<element name="versionName" type="string"/>
<element name="asOfDateTime" type="dateTime"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
+Type Definition
<complexType name="StartDeleteVersion">
<sequence>
<element name="versionName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

ExportType export: The export type field.
+Type Definition
<complexType name="StartExport">
<sequence>
<element name="export" type="ExportType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string exportName: The export name to run.
ObjectAccessEnum access: Access level of the export to run.
string fromVersionName: The from version name field.
string toVersionName: The to version name field.
+Type Definition
<complexType name="StartExportByName">
<sequence>
<element name="exportName" type="string"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
<element name="fromVersionName" type="string"/>
<element name="toVersionName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryType query: The query criteria field.
StringListType propNameList: List of properties to return in the results.
+Type Definition
<complexType name="StartGlobalQuery">
<sequence>
<element name="query" type="QueryType"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string exportName: The export name to run.
string versionName: Version name field.
boolean includeAllHiers: Flag indicating that the export should include all hierarchies.
ObjectAccessEnum access: Access level of the export to run.
+Type Definition
<complexType name="StartHierExportByName">
<sequence>
<element name="exportName" type="string"/>
<element name="versionName" type="string"/>
<element minOccurs="0" name="includeAllHiers" type="boolean"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string exportName: The export name to run.
string versionName: Version name field.
HierNodeNamePairType hierNode: The hierarchy node field.
ObjectAccessEnum access: Access level of the export to run.
+Type Definition
<complexType name="StartHierExportByNameOnHierNode">
<sequence>
<element name="exportName" type="string"/>
<element name="versionName" type="string"/>
<element name="hierNode" type="HierNodeNamePairType"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string exportName: The export name to run.
string versionName: Version name field.
HierNodeNamePairListType hierNodeList: A list type with hierarchy/node pairs.
ObjectAccessEnum access: Access level of the export to run.
+Type Definition
<complexType name="StartHierExportByNameOnHierNodes">
<sequence>
<element name="exportName" type="string"/>
<element name="versionName" type="string"/>
<element name="hierNodeList" type="HierNodeNamePairListType"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string exportName: The export name to run.
string versionName: Version name field.
StringListType hierNameList: A list type fo hierarchy names.
ObjectAccessEnum access: Access level of the export to run.
+Type Definition
<complexType name="StartHierExportByNameOnHiers">
<sequence>
<element name="exportName" type="string"/>
<element name="versionName" type="string"/>
<element name="hierNameList" type="StringListType"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

ImportType importProfile: The import profile field.
base64Binary compressedFileContent: Byte array of compressed bytes that represent the script file. The deflate algorithm should be used to compress the content.
+Type Definition
<complexType name="StartImport">
<sequence>
<element name="importProfile" type="ImportType"/>
<element name="compressedFileContent" type="base64Binary"/>
</sequence>
</complexType>
Referenced By:

Fields:

string importName: The import name field.
base64Binary compressedFileContent: Byte array of compressed bytes that represent the file. The deflate algorithm should be used to compress the content.
ObjectAccessEnum access: Access level of the import.
string versionName: Version name field. This field value will be used as the name of the version.
string versionDescription: Version description field. This field value will be used as the description of the version.
+Type Definition
<complexType name="StartImportByName">
<sequence>
<element name="importName" type="string"/>
<element name="compressedFileContent" type="base64Binary"/>
<element minOccurs="0" name="access" type="ObjectAccessEnum"/>
<element minOccurs="0" name="versionName" type="string"/>
<element minOccurs="0" name="versionDescription" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryType query: Query criteria field.
StringListType propNameList: List of properties to return in the results.
+Type Definition
<complexType name="StartQuery">
<sequence>
<element name="query" type="QueryType"/>
<element minOccurs="0" name="propNameList" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
+Type Definition
<complexType name="StartSaveVersion">
<sequence>
<element name="versionName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

ActionItemListType actionItemList: A list of action items to process.
+Type Definition
<complexType name="StartScript">
<sequence>
<element name="actionItemList" type="ActionItemListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ScriptLoadParamsType scriptLoaderParams: Field describes the action script content to be processed.
CharacterEncodingEnum encoding: An enumeration indicating encoding of the text file.
+Type Definition
<complexType name="StartScriptFromFile">
<sequence>
<element name="scriptLoaderParams" type="ScriptLoadParamsType"/>
<element minOccurs="0" name="encoding" type="CharacterEncodingEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

string s: A string value field.
+Type Definition
<complexType name="StringListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="s" nillable="true" type="string"/>
</sequence>
</complexType>
Referenced By:
Type: GetNodes
Type: OrderChildren
Type: MoveNodes
Type: RunQuery
Type: VersionValidationResultType
Type: UpdatePropDefListValues
Type: SetHierValidations
Type: GetNode
Type: StartHierExportByNameOnHiers
Type: StartCompare
Type: AddPropCategory
Type: StartCompareByName
Type: ImportSectionType
Type: NodeAccessGroupType
Type: GetGlobalNodePropValues
Type: ActionItemType
Type: RemoveNodes
Type: GetHiers
Type: RunCompare
Type: InsertNodes
Type: RunValidateNode
Type: HierValidationResultType
Type: CompareType
Type: GetRelatedNodes
Type: GetHierTopNode
Type: GetGlobalNodes
Type: GetVersions
Type: GetRelatedNodesWithProps
Type: ImportColumnType
Type: RunValidateVersion
Type: QueryResultType
Type: GetGlobalNode
Type: GenerationExportType
Type: GetOrphanNodes
Type: SetVersionValidations
Type: PropCategoryType
Type: NodeType
Type: RequestValidationResultNodeType
Type: CopyNodeProps
Type: AddNodeType
Type: ScriptLoadParamsType
Type: DeleteOrphanNodes
Type: StringListResponseType
Type: GetVersionPropValues
Type: RunGlobalQuery
Type: PropDefType
Type: SearchForNodesInVersion
Type: ValidationResultType
Type: NodeTypeType
Type: ExportType
Type: RunCompareByName
Type: GetNodePropValues
Type: GetHierProps
Type: DeleteNodes
Type: GetGlobalNodeProps
Type: RunValidateHier
Type: StartGlobalQuery
Type: PropValueFlexListType
Type: GetNodeWithProps
Type: RequestHeaderType
Type: BlenderResultsType
Type: GetScriptFromModel
Type: GetNodeProps
Type: GetVersionProps
Type: GetHierPropValues
Type: GetQueries
Type: GlobalQueryResultType
Type: UserInputType
Type: StartQuery
Type: InactivateNodes
Type: SearchForNodesInHier
Type: AsOfVersionResultType
Type: ReactivateNodes
Type: HierType
Enumeration indicating how a string value should be evaluated.
+Type Definition
<simpleType name="StringParamMethodEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="Equal"/>
<enumeration value="Like"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

StringParamMethodEnum method: Indicates how a string value should be evaluated.
string value: The value of the string parameter.
+Type Definition
<complexType name="StringParamsType">
<sequence>
<element name="method" type="StringParamMethodEnum"/>
<element name="value" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string stringVal: A string value response.
+Type Definition
<complexType name="StringResponseType">
<sequence>
<element name="stringVal" type="string"/>
</sequence>
</complexType>
Referenced By:
Enumeration indicating how a string value should be evaluated.
+Type Definition
<simpleType name="SuccessStateEnum">
<restriction base="string">
<enumeration value="Unprocessed"/>
<enumeration value="PartialFailure"/>
<enumeration value="Failure"/>
<enumeration value="Success"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

SystemPreferenceType systemPreferences: List of system preference type objects.
+Type Definition
<complexType name="SystemPreferenceListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="systemPreferences" nillable="true" type="SystemPreferenceType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: The name of the system preference.
int id: The system-generated ID of the system preference.
string descr: Description of the object.
string displayLabel: The display label of the system preference.
string value: The value of the system preference.
DataTypeEnum DataType: A data type enumeration value for the system preference.
string valueMin: A minimum value for the system preference if data type is Integer.
string valueMax: A maximum value for the system preference if data type is Integer.
+Type Definition
<complexType name="SystemPreferenceType">
<sequence>
<element name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element name="descr" type="string"/>
<element name="displayLabel" type="string"/>
<element name="value" type="string"/>
<element name="DataType" type="DataTypeEnum"/>
<element name="valueMin" type="string"/>
<element name="valueMax" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

ObjectAccessEnum objectAccess: Object access of the export.
string name: Name field of the export.
int id: The system-generated ID.
string descr: Description of the object.
string exportClass: The fully qualified class name of the export type, including namespace. Example: Oracle.Drm.Engine.Core.ExportManager.TransactionLogExport.
VersionParamsType currentVersionParams: Current version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
VersionParamsType previousVersionParams: The previous version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
boolean useQuotedStrings: Puts quotation marks around strings in the export.
string recordDelimiter: A sequence of characters used to specify the record boundary.
boolean useFixedWidth: Flag that indicates that the export is to be a fixed-width export.
boolean insertHeaderFooterBlankLines: Flag that instructs the server to add a line between the header/footer and the body of the export results.
CharacterEncodingEnum characterEncoding: Enumeration indicating encoding of the text file.
boolean hasColumnHeaders: Flag indicating that the export result should include column header label.
ExportColumnListType columns: List of columns to export.
CustomExportParamListType customParams: Parameter values used by custom exports.
string queryName: Name of the query to apply to the export.
string validationName: Name of the validation to apply to the export.
boolean includeInactive: Flag indicating that the export results should include inactive nodes.
ExportOutputModeEnum outputMode: Enumeration of what type of medium the export results should be exported to.
string fileName: Name of the file to be exported.
string includeFileConnection: External connection name to be used if exporting to a server device.
boolean dbClearOnVersion: If exporting to a database, indicates whether export table records with KeyFields containing this export's version ID will be deleted before inserting export output records.
boolean dbClearTable: If exporting to a database, clears the table before exporting.
string dbConnectionString: If exporting to a database, connection string to the database.
string dbExportDAL: The fully qualified name (including namespace) of the export data access layer class that implements IExportDalFactory. This class will be used to create the export DAL used for this export's output.
boolean dbOutputEnabled: Indicates whether the export's type allows its output to be directed to a database. Note that this is a read-only field as far as the API is concerned. Any value for this property that is set though the API will be ignored.
string dbPassword: (To be deprecated)
string dbTableName: If exporting to a database, database table name to export to.
boolean dbUseFastAppends: If exporting to a database, indicates whether the export DAL table will be populated more quickly by using the SQL BulkUpdate facility. This is based on provider support.
boolean dbUseFastDeletes: Indicates whether an export table with data will cleared more quickly by using a SQL table "truncate" command rather than line-by-line deleting of records.
boolean dbUseTransactions: Determines whether records for this export's output will be inserted inside a database transaction. This parameter will be used only when the output mode is Table.
string dbUserName: The database user name that will be used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string dbVendor: The database vendor string used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string delimiter: Delimits values in a row of export output.
string header: Header text for the export output.
string footer: Footer text for the export output.
StringListType fromList: Array of string values to replace in the export results. Currently three string items are supported.
string fromStrValue: A string value representing each item in the fromList array delimited by a comma.
StringListType toList: Array of string values that are replacing values for the values in the fromList field. Currently three string items are supported.
string toStrValue: A string value representing each item in the toList array delimited by a comma.
string userName: User name associated with this export.
int userId: User ID associated with this export.
boolean hasWarning: Indicates whether a WarningMessage has been encountered during this export's execution.
StringListType warningMessages: Warnings that were encountered during export execution.
LogCriteriaType LogCriteria: Transaction log criteria field.
+Type Definition
<complexType name="TransLogExportType">
<complexContent>
<extension base="ExportType">
<sequence>
<element minOccurs="0" name="LogCriteria" type="LogCriteriaType"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Enumeration indicating the type of transaction.
+Type Definition
<simpleType name="TxnActionEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="AddHier"/>
<enumeration value="AddNode"/>
<enumeration value="AddOrphanNode"/>
<enumeration value="AddVersion"/>
<enumeration value="AnnulNode"/>
<enumeration value="AnnulAllBelowNode"/>
<enumeration value="AssignedBatchVerificationsRun"/>
<enumeration value="AssignHierValidation"/>
<enumeration value="AssignVersionValidation"/>
<enumeration value="AutomatorRun"/>
<enumeration value="BatchVerificationRun"/>
<enumeration value="BCPRun"/>
<enumeration value="BlenderRun"/>
<enumeration value="ChangeHierTopNode"/>
<enumeration value="ClearAllBelow"/>
<enumeration value="CloseVersion"/>
<enumeration value="CompareRun"/>
<enumeration value="CopyVersion"/>
<enumeration value="DeleteHier"/>
<enumeration value="DeleteNode"/>
<enumeration value="DeleteOrphan"/>
<enumeration value="DeleteVersion"/>
<enumeration value="DetachVersion"/>
<enumeration value="DisableRTValidations"/>
<enumeration value="ExportRun"/>
<enumeration value="GlobalQuery"/>
<enumeration value="ImportRun"/>
<enumeration value="InactivateNode"/>
<enumeration value="InsertNode"/>
<enumeration value="LockNodeProp"/>
<enumeration value="LogIn"/>
<enumeration value="LogOut"/>
<enumeration value="MoveNode"/>
<enumeration value="NodePropDataLoss"/>
<enumeration value="OpenVersion"/>
<enumeration value="OrderChildren"/>
<enumeration value="PropCompareRun"/>
<enumeration value="Query"/>
<enumeration value="ReactivateNode"/>
<enumeration value="RebuildHierNode"/>
<enumeration value="RemoveDuplicates"/>
<enumeration value="RemoveFromOrphan"/>
<enumeration value="RemoveHierPropValue"/>
<enumeration value="RemoveNode"/>
<enumeration value="RemoveNodePropValue"/>
<enumeration value="RemoveVersionPropValue"/>
<enumeration value="RenameCompareRun"/>
<enumeration value="SaveVersion"/>
<enumeration value="UnlockNodeProp"/>
<enumeration value="UpdateHierPropValue"/>
<enumeration value="UpdateNodePropValue"/>
<enumeration value="UpdateVersionPropValue"/>
<enumeration value="AdminDeleteBlender"/>
<enumeration value="AdminSaveBlender"/>
<enumeration value="AdminAddCategory"/>
<enumeration value="AdminDeleteCategory"/>
<enumeration value="AdminUpdateCategory"/>
<enumeration value="AdminUpdateCategoryProps"/>
<enumeration value="AdminUpdateCategoryUsers"/>
<enumeration value="AdminDeleteCompareCrit"/>
<enumeration value="AdminRenameCompareCrit"/>
<enumeration value="AdminSaveCompareCrit"/>
<enumeration value="AdminUpdateCompareCrit"/>
<enumeration value="AdminDeleteBook"/>
<enumeration value="AdminDeleteExport"/>
<enumeration value="AdminSaveBook"/>
<enumeration value="AdminSaveExport"/>
<enumeration value="AdminDeleteImport"/>
<enumeration value="AdminSaveImport"/>
<enumeration value="AdminAddNodeAccessGroup"/>
<enumeration value="AdminDeleteNodeAccessGroup"/>
<enumeration value="AdminUpdateAccessGroupControllingHiers"/>
<enumeration value="AdminUpdateNodeAccessGroup"/>
<enumeration value="AdminUpdateAccessGroupMembers"/>
<enumeration value="AdminAddNodeType"/>
<enumeration value="AdminApplyNodeTypeProps"/>
<enumeration value="AdminApplyNodeTypeValidations"/>
<enumeration value="AdminDeleteNodeType"/>
<enumeration value="AdminUpdateNodeType"/>
<enumeration value="AdminUpdatePropDefParams"/>
<enumeration value="AdminAddPropDef"/>
<enumeration value="AdminDeletePropLookupValue"/>
<enumeration value="AdminDeletePropDef"/>
<enumeration value="AdminAddPropLookupValue"/>
<enumeration value="AdminUpdateCategoryListForPropDef"/>
<enumeration value="AdminUpdateControllingHier"/>
<enumeration value="AdminUpdatePropListValues"/>
<enumeration value="AdminUpdatePropLookupValue"/>
<enumeration value="AdminUpdatePropDef"/>
<enumeration value="AdminDeleteCritList"/>
<enumeration value="AdminRenameCritList"/>
<enumeration value="AdminUpdateCritList"/>
<enumeration value="AdminUpdateSysPref"/>
<enumeration value="AdminAddValidation"/>
<enumeration value="AdminDeleteValidation"/>
<enumeration value="AdminSetValidationParams"/>
<enumeration value="AdminUpdateHierValidations"/>
<enumeration value="AdminUpdateValidation"/>
<enumeration value="AdminUpdateVersionValidations"/>
<enumeration value="AdminDeleteHierarchyGroup"/>
<enumeration value="AdminUpdateHierarchyGroup"/>
<enumeration value="AdminAddHierarchyGroup"/>
<enumeration value="AdminAddUser"/>
<enumeration value="AdminUpdateUser"/>
<enumeration value="AdminDeleteUser"/>
<enumeration value="AdminAssignUserCategories"/>
<enumeration value="AdminAssignUserNodeAccessGroups"/>
<enumeration value="AdminChangeUserPassword"/>
<enumeration value="AdminSetUserPassword"/>
<enumeration value="AdminUpdateUserLockout"/>
<enumeration value="SaveRequest"/>
<enumeration value="DeleteRequest"/>
<enumeration value="ApproveRequest"/>
<enumeration value="MigrationExport"/>
<enumeration value="MigrationImport"/>
<enumeration value="AdminAddRole"/>
<enumeration value="AdminUpdateRole"/>
<enumeration value="AdminDeleteRole"/>
<enumeration value="AdminAssignUserRoles"/>
<enumeration value="AdminUpdateControllingProperties"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
Enumeration indicating the level of the transaction.
+Type Definition
<simpleType name="TxnActionLevelEnum">
<restriction base="string">
<enumeration value="Core"/>
<enumeration value="Logged"/>
<enumeration value="Loss"/>
<enumeration value="Result"/>
<enumeration value="Admin"/>
<enumeration value="Invalid"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

TxnActionLevelEnum txnActionLevel: List type field for transaction level enumerations.
+Type Definition
<complexType name="TxnActionLevelListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="txnActionLevel" nillable="true" type="TxnActionLevelEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

TxnActionEnum txnAction: List type field for transaction actions types.
+Type Definition
<complexType name="TxnActionListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="txnAction" nillable="true" type="TxnActionEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

BlenderType blender: Blender to be updated.
+Type Definition
<complexType name="UpdateBlender">
<sequence>
<element name="blender" type="BlenderType"/>
</sequence>
</complexType>
Referenced By:

Fields:

BookType book: Book to be updated.
+Type Definition
<complexType name="UpdateBook">
<sequence>
<element name="book" type="BookType"/>
</sequence>
</complexType>
Referenced By:

Fields:

CompareType compare: Compare to be updated.
+Type Definition
<complexType name="UpdateCompare">
<sequence>
<element name="compare" type="CompareType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ExportType export: Export to be updated.
+Type Definition
<complexType name="UpdateExport">
<sequence>
<element name="export" type="ExportType"/>
</sequence>
</complexType>
Referenced By:

Fields:

GlyphType updateGlyph: Glyph to be updated.
+Type Definition
<complexType name="UpdateGlyph">
<sequence>
<element name="updateGlyph" type="GlyphType"/>
</sequence>
</complexType>
Referenced By:

Fields:

HierGroup hierGroup: Hierarchy group to be updated.
+Type Definition
<complexType name="UpdateHierGroup">
<sequence>
<element name="hierGroup" type="HierGroup"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
NameValueListType propValueList: A name value list type field that indicates the properties and their values.
+Type Definition
<complexType name="UpdateHierPropValues">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="propValueList" type="NameValueListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
PropListType propList: A list type object for the PropListType type.
+Type Definition
<complexType name="UpdateHierProps">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="propList" type="PropListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ImportType importDef: The import definition object.
+Type Definition
<complexType name="UpdateImport">
<sequence>
<element name="importDef" type="ImportType"/>
</sequence>
</complexType>
Referenced By:

Fields:

NodeAccessGroupType updateNodeAccessGroup: The node access group object.
+Type Definition
<complexType name="UpdateNodeAccessGroup">
<sequence>
<element name="updateNodeAccessGroup" type="NodeAccessGroupType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
NameValueListType propNameValueList: Name/Value Pair list field for property definition name and value for the node property value.
+Type Definition
<complexType name="UpdateNodePropValues">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element name="propNameValueList" type="NameValueListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
string hierName: Hierarchy name field.
string nodeName: Node name field.
PropListType propList: A list of property values to update for the node.
+Type Definition
<complexType name="UpdateNodeProps">
<sequence>
<element name="versionName" type="string"/>
<element name="hierName" type="string"/>
<element name="nodeName" type="string"/>
<element name="propList" type="PropListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

PropCategoryType propertyCategory: Property category field.
+Type Definition
<complexType name="UpdatePropCategory">
<sequence>
<element name="propertyCategory" type="PropCategoryType"/>
</sequence>
</complexType>
Referenced By:

Fields:

PropDefType propDef: The property definition field.
+Type Definition
<complexType name="UpdatePropDef">
<sequence>
<element name="propDef" type="PropDefType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string propDefName: Property definition name for a list type property definition.
StringListType listValues: List of values to update the property with.
+Type Definition
<complexType name="UpdatePropDefListValues">
<sequence>
<element name="propDefName" type="string"/>
<element minOccurs="0" name="listValues" type="StringListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

QueryType query: Query type field.
string renameName: If supplied a new name to give the query criteria.
+Type Definition
<complexType name="UpdateQuery">
<sequence>
<element name="query" type="QueryType"/>
<element name="renameName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

RequestType request: The request object field.
+Type Definition
<complexType name="UpdateRequest">
<sequence>
<element name="request" type="RequestType"/>
</sequence>
</complexType>
Referenced By:

Fields:

UserType user: The user object field.
+Type Definition
<complexType name="UpdateUser">
<sequence>
<element minOccurs="0" name="user" type="UserType"/>
</sequence>
</complexType>
Referenced By:

Fields:

UserType user: The user object field.
+Type Definition
<complexType name="UpdateUserLockout">
<sequence>
<element minOccurs="0" name="user" type="UserType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string userName: The existing user name field.
string oldPassword: The old password field.
string newPassword: The new password field.
+Type Definition
<complexType name="UpdateUserPassword">
<sequence>
<element minOccurs="0" name="userName" type="string"/>
<element minOccurs="0" name="oldPassword" type="string"/>
<element minOccurs="0" name="newPassword" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

ValidationDefinitionType validation: The validation object field.
+Type Definition
<complexType name="UpdateValidation">
<sequence>
<element name="validation" type="ValidationDefinitionType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
NameValueListType propValueList: List type of nameValueListType for properties and their values.
+Type Definition
<complexType name="UpdateVersionPropValues">
<sequence>
<element name="versionName" type="string"/>
<element name="propValueList" type="NameValueListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
PropListType propList: List type of PropListType for properties and their values.
+Type Definition
<complexType name="UpdateVersionProps">
<sequence>
<element name="versionName" type="string"/>
<element name="propList" type="PropListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

UserAccessType userAccess: List type of userAccessType types.
+Type Definition
<complexType name="UserAccessListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="userAccess" nillable="true" type="UserAccessType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string userName: The username field.
AccessLevelEnum accessLevel: The user access level field.
+Type Definition
<complexType name="UserAccessType">
<sequence>
<element minOccurs="0" name="userName" type="string"/>
<element minOccurs="0" name="accessLevel" type="AccessLevelEnum"/>
</sequence>
</complexType>
Referenced By:
Enumeration indicating a user's authentication method.
+Type Definition
<simpleType name="UserAuthMethodEnum">
<restriction base="string">
<enumeration value="Internal"/>
<enumeration value="CSS"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

PermissionListType allowedPermissions: List type that indicates a user's permissions.
StringListType allowedRoles: String list type for listing the user's allowed security roles.
UserAuthMethodEnum authMethod: The authentication method for the user.
boolean changePassOnLogin: Flag indicating that the user should be forced to change the password on the next login.
string department: The department of the user.
boolean excludeFromTimeout: Flag indicating that the user should be excluded from session timeouts.
boolean excludeFromPasswordExpiration: Flag indicating that the user's password should never expire.
string fullName: Full name of the user.
int invalidLoginCount: Read-only field that indicates the number of invalid login attempts by the user.
dateTime lastValidLogin: Read-only field that indicates the last time the user logged in successfully.
boolean loginLockout: Flag indicating if the user is locked out.
dateTime loginLockoutDate: If the user is locked out, the date of the lockout.
string loginLockoutReason: If the user is locked out, the reason for the lockout.
StringListType nodeAccessGroups: List of node access groups the user belongs to.
string phone: Phone number field.
NameValueListType propertyCategories: The list of property categories for the user.
string userName: The user name of the user.
+Type Definition
<complexType name="UserInputType">
<sequence>
<element minOccurs="0" name="allowedPermissions" type="PermissionListType"/>
<element minOccurs="0" name="allowedRoles" type="StringListType"/>
<element minOccurs="0" name="authMethod" type="UserAuthMethodEnum"/>
<element minOccurs="0" name="changePassOnLogin" type="boolean"/>
<element minOccurs="0" name="department" type="string"/>
<element minOccurs="0" name="excludeFromTimeout" type="boolean"/>
<element minOccurs="0" name="excludeFromPasswordExpiration" type="boolean"/>
<element minOccurs="0" name="fullName" type="string"/>
<element minOccurs="0" name="invalidLoginCount" type="int"/>
<element minOccurs="0" name="lastValidLogin" type="dateTime"/>
<element minOccurs="0" name="loginLockout" type="boolean"/>
<element minOccurs="0" name="loginLockoutDate" type="dateTime"/>
<element minOccurs="0" name="loginLockoutReason" type="string"/>
<element minOccurs="0" name="nodeAccessGroups" type="StringListType"/>
<element minOccurs="0" name="phone" type="string"/>
<element minOccurs="0" name="propertyCategories" type="NameValueListType"/>
<element minOccurs="0" name="userName" type="string"/>
</sequence>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

PermissionListType allowedPermissions: List type that indicates a user's permissions.
StringListType allowedRoles: String list type for listing the user's allowed security roles.
UserAuthMethodEnum authMethod: The authentication method for the user.
boolean changePassOnLogin: Flag indicating that the user should be forced to change the password on the next login.
string department: The department of the user.
boolean excludeFromTimeout: Flag indicating that the user should be excluded from session timeouts.
boolean excludeFromPasswordExpiration: Flag indicating that the user's password should never expire.
string fullName: Full name of the user.
int invalidLoginCount: Read-only field that indicates the number of invalid login attempts by the user.
dateTime lastValidLogin: Read-only field that indicates the last time the user logged in successfully.
boolean loginLockout: Flag indicating if the user is locked out.
dateTime loginLockoutDate: If the user is locked out, the date of the lockout.
string loginLockoutReason: If the user is locked out, the reason for the lockout.
StringListType nodeAccessGroups: List of node access groups the user belongs to.
string phone: Phone number field.
NameValueListType propertyCategories: The list of property categories for the user.
string userName: The user name of the user.
int id: The system-generated ID of the user.
+Type Definition
<complexType name="UserType">
<complexContent>
<extension base="UserInputType">
<sequence>
<element minOccurs="0" name="id" type="int"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

RequestType request: The request to validate.
boolean saveIfSuccessful: Flag indicating that the request should be saved if the validation was successful.
+Type Definition
<complexType name="ValidateRequest">
<sequence>
<element name="request" type="RequestType"/>
<element minOccurs="0" name="saveIfSuccessful" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: The name of the validation.
int id: The system-generated ID of the validation.
string descr: Description of the object.
string displayLabel: The display label of the validation.
ValidationTypeEnum allowedType: An enumeration indicating the validation type.
boolean cascade: Flag indicating that the validation is to be implicitly assigned through inheritance.
int columnWidth: (To be deprecated)
ValidationLevelEnum level: The validation level defines the scope of a business rule.
ValidationParamListType parameters: Parameters that are used by the validation during execution.
boolean setup: Flag that indicates if the server should check the validity of the parameters.
int sortOrder: The Sort Order of the property definition within a category.
string validationClass: The type class of validation.
+Type Definition
<complexType name="ValidationDefinitionType">
<sequence>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="displayLabel" type="string"/>
<element minOccurs="0" name="allowedType" type="ValidationTypeEnum"/>
<element minOccurs="0" name="cascade" type="boolean"/>
<element minOccurs="0" name="columnWidth" type="int"/>
<element minOccurs="0" name="level" type="ValidationLevelEnum"/>
<element minOccurs="0" name="parameters" type="ValidationParamListType"/>
<element minOccurs="0" name="setup" type="boolean"/>
<element minOccurs="0" name="sortOrder" type="int"/>
<element minOccurs="0" name="validationClass" type="string"/>
</sequence>
</complexType>
Referenced By:
Enumeration indicating The validation level defines the scope of a business rule.
+Type Definition
<simpleType name="ValidationLevelEnum">
<restriction base="string">
<enumeration value="Node"/>
<enumeration value="Hier"/>
<enumeration value="Version"/>
<enumeration value="GlobalNodes"/>
<enumeration value="Merge"/>
<enumeration value="Move"/>
<enumeration value="Remove"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

ValidationDefinitionType validations: List type field of validationDefinitionType objects.
+Type Definition
<complexType name="ValidationListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="validations" nillable="true" type="ValidationDefinitionType"/>
</sequence>
</complexType>
Referenced By:

Fields:

DataTypeEnum dataType: An enumeration representing the DataType of a parameter.
string descr: Description of the object.
string displayLabel: The display label for the validation parameter.
string value: The value of the validation parameter.
+Type Definition
<complexType name="ValidationParamInputType">
<sequence>
<element minOccurs="0" name="dataType" type="DataTypeEnum"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="displayLabel" type="string"/>
<element minOccurs="0" name="value" type="string"/>
</sequence>
</complexType>
Type Hierarchy:

Fields:

ValidationParamType validationParams: List type field of validationParamType objects.
+Type Definition
<complexType name="ValidationParamListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="validationParams" nillable="true" type="ValidationParamType"/>
</sequence>
</complexType>
Referenced By:

Fields:

DataTypeEnum dataType: An enumeration representing the DataType of a parameter.
string descr: Description of the object.
string displayLabel: The display label for the validation parameter.
string value: The value of the validation parameter.
int id: The system-generated ID of the validation parameter.
+Type Definition
<complexType name="ValidationParamType">
<complexContent>
<extension base="ValidationParamInputType">
<sequence>
<element minOccurs="0" name="id" type="int"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string name: Node name field.
int id: The system-generated ID field for the node.
string descr: Description of the object.
string versionName: Version name field.
string hierName: Hierarchy name field.
string parentName: Parent node name field.
string nodeType: The nodeType name.
boolean isInactive: Flag indicating that the node is inactive.
boolean hasChildren: Flag indicating that the node has children.
int childCount: The number of children the node has.
boolean isLeaf: Field indicating that the node is a Leaf node.
boolean isApproved: Flag indicating that node approval has been granted.
StringListType displayByPropValueList: List type for the display by properties.
string displayByString: The display by value for the node.
boolean isPrimary: Indicates whether a node has shared nodes that point to it.
boolean isShared: Indicates whether the node is a shared node.
boolean isPrimaryMissing: Indicates whether the shared node points to a primary node that does not exist.
string primaryName: The primary name portion of the shared node name. For non-shared nodes, this property returns the node name in its entirety.
boolean isPrimaryNotInHier: Indicates whether the primary node is not in the same hierarchy.
boolean primaryHasDescendants: Indicates whether the primary node has structure below it. only populated on shared nodes.
PropValueFlexListType propValueList: A type for a node and its property values.
StringListType reasonList: List of validations that failed during a validation run.
+Type Definition
<complexType name="ValidationResultType">
<complexContent>
<extension base="NodeWithPropValuesType">
<sequence>
<element minOccurs="0" name="reasonList" type="StringListType"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Enumeration indicating the type of validation definition (RealTime or Batch).
+Type Definition
<simpleType name="ValidationTypeEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="RealTime"/>
<enumeration value="Batch"/>
<enumeration value="Both"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
Enumeration indicating how a property is populated in a target object.
+Type Definition
<simpleType name="ValuePropagateModeEnum">
<restriction base="string">
<enumeration value="Force"/>
<enumeration value="Difference"/>
<enumeration value="Defined"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

ObjectAccessEnum objectAccess: Object access of the export.
string name: Name field of the export.
int id: The system-generated ID.
string descr: Description of the object.
string exportClass: The fully qualified class name of the export type, including namespace. Example: Oracle.Drm.Engine.Core.ExportManager.TransactionLogExport.
VersionParamsType currentVersionParams: Current version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
VersionParamsType previousVersionParams: The previous version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
boolean useQuotedStrings: Puts quotation marks around strings in the export.
string recordDelimiter: A sequence of characters used to specify the record boundary.
boolean useFixedWidth: Flag that indicates that the export is to be a fixed-width export.
boolean insertHeaderFooterBlankLines: Flag that instructs the server to add a line between the header/footer and the body of the export results.
CharacterEncodingEnum characterEncoding: Enumeration indicating encoding of the text file.
boolean hasColumnHeaders: Flag indicating that the export result should include column header label.
ExportColumnListType columns: List of columns to export.
CustomExportParamListType customParams: Parameter values used by custom exports.
string queryName: Name of the query to apply to the export.
string validationName: Name of the validation to apply to the export.
boolean includeInactive: Flag indicating that the export results should include inactive nodes.
ExportOutputModeEnum outputMode: Enumeration of what type of medium the export results should be exported to.
string fileName: Name of the file to be exported.
string includeFileConnection: External connection name to be used if exporting to a server device.
boolean dbClearOnVersion: If exporting to a database, indicates whether export table records with KeyFields containing this export's version ID will be deleted before inserting export output records.
boolean dbClearTable: If exporting to a database, clears the table before exporting.
string dbConnectionString: If exporting to a database, connection string to the database.
string dbExportDAL: The fully qualified name (including namespace) of the export data access layer class that implements IExportDalFactory. This class will be used to create the export DAL used for this export's output.
boolean dbOutputEnabled: Indicates whether the export's type allows its output to be directed to a database. Note that this is a read-only field as far as the API is concerned. Any value for this property that is set though the API will be ignored.
string dbPassword: (To be deprecated)
string dbTableName: If exporting to a database, database table name to export to.
boolean dbUseFastAppends: If exporting to a database, indicates whether the export DAL table will be populated more quickly by using the SQL BulkUpdate facility. This is based on provider support.
boolean dbUseFastDeletes: Indicates whether an export table with data will cleared more quickly by using a SQL table "truncate" command rather than line-by-line deleting of records.
boolean dbUseTransactions: Determines whether records for this export's output will be inserted inside a database transaction. This parameter will be used only when the output mode is Table.
string dbUserName: The database user name that will be used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string dbVendor: The database vendor string used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string delimiter: Delimits values in a row of export output.
string header: Header text for the export output.
string footer: Footer text for the export output.
StringListType fromList: Array of string values to replace in the export results. Currently three string items are supported.
string fromStrValue: A string value representing each item in the fromList array delimited by a comma.
StringListType toList: Array of string values that are replacing values for the values in the fromList field. Currently three string items are supported.
string toStrValue: A string value representing each item in the toList array delimited by a comma.
string userName: User name associated with this export.
int userId: User ID associated with this export.
boolean hasWarning: Indicates whether a WarningMessage has been encountered during this export's execution.
StringListType warningMessages: Warnings that were encountered during export execution.
QueryType query: The query object field.
boolean includeLeaves: Flag indicating if the export should process leafs.
boolean includeLimbs: Flag indicating if the export should process limbs.
+Type Definition
<complexType name="VersionExportType">
<complexContent>
<extension base="ExportType">
<sequence>
<element minOccurs="0" name="query" type="QueryType"/>
<element minOccurs="0" name="includeLeaves" type="boolean"/>
<element minOccurs="0" name="includeLimbs" type="boolean"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

VersionListType versionList: List type of versionType objects.
+Type Definition
<complexType name="VersionListResponseType">
<sequence>
<element name="versionList" type="VersionListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

VersionType version: List type of versionType objects.
+Type Definition
<complexType name="VersionListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="version" nillable="true" type="VersionType"/>
</sequence>
</complexType>
Referenced By:

Fields:

VersionSelectionEnum versionSelection: Enumeration field indicating the version to choose.
string versionName: Version name field.
VersionTypeParamEnum versionType: The version type field.
AsOfMethodEnum asOfMethod: As of method field. Example: Date, offset, ID.
dateTime asOfDateTime: A date and time value to be used for the version.
int asOfId: A transaction ID value to be used for the version.
int asOfOffsetDays: Number of days offset from the current date.
int asOfOffsetTime: Time offset from the current time.
+Type Definition
<complexType name="VersionParamsType">
<sequence>
<element name="versionSelection" type="VersionSelectionEnum"/>
<element minOccurs="0" name="versionName" type="string"/>
<element minOccurs="0" name="versionType" type="VersionTypeParamEnum"/>
<element minOccurs="0" name="asOfMethod" type="AsOfMethodEnum"/>
<element minOccurs="0" name="asOfDateTime" type="dateTime"/>
<element minOccurs="0" name="asOfId" type="int"/>
<element minOccurs="0" name="asOfOffsetDays" type="int"/>
<element minOccurs="0" name="asOfOffsetTime" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string propName: The name of the property definition.
+Type Definition
<complexType name="VersionPropRemoveRequestItemType">
<complexContent>
<extension base="VersionPropRequestItemType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string propName: The name of the property definition.
+Type Definition
<complexType name="VersionPropRequestItemType">
<complexContent>
<extension base="RequestItemType">
<sequence>
<element name="propName" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

int requestId: The system-generated ID for the request the item belongs to.
int itemId: The system-generated ID for the request item.
RequestActionEnum action: An enumeration indicating the type of request item.
string customValue: Free-form field to be used updated by external systems.
string propName: The name of the property definition.
string value: The property value for the version level property.
+Type Definition
<complexType name="VersionPropUpdateRequestItemType">
<complexContent>
<extension base="VersionPropRequestItemType">
<sequence>
<element minOccurs="0" name="value" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

VersionType version: The version object field.
+Type Definition
<complexType name="VersionResponseType">
<sequence>
<element name="version" type="VersionType"/>
</sequence>
</complexType>
Referenced By:
Enumeration indicating the version to choose.
+Type Definition
<simpleType name="VersionSelectionEnum">
<restriction base="string">
<enumeration value="CurrentDefault"/>
<enumeration value="PreviousDefault"/>
<enumeration value="Explicit"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
+Type Definition
<simpleType name="VersionStatusEnum">
<restriction base="string">
<enumeration value="Working"/>
<enumeration value="Submitted"/>
<enumeration value="Finalized"/>
<enumeration value="Expired"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

string name: The name of the version.
int id: The system-generated ID for the version.
string descr: Description of the object.
VersionTypeEnum type: Enumeration indicating what type of version.
VersionStatusEnum status: Enumeration indicating the state of the version.
LoadStatusEnum loadStatus: Enumeration indicating the versions in memory state.
AccessLevelEnum accessLevel: Access level user must have to modify version.
VersionParamsType asOfParams: The as of parameters of the version.
string normalVersion: Flag indicating that the version is a normal version.
int baselineRefId: The transaction ID of the baseline version.
string baselineVersion: The name of the baseline version.
boolean dBDisconnect: If set to True, the version does not update the database as it is changed.
boolean isInDatabase: Flag indicating that the version has been persisted.
int legacyId: If the version has been copied, the legacyId is the ID of the source version. For AsOf versions, the legacyId is the ID of the version the AsOf is based on.
string legacyVersion: The legacy version, based on legacyId. If there is no legacy version, this object is null.
dateTime legacyCopyTime: The date and time that the version was copied from its source.
boolean rtvDisabled: Setting rtvDisabled to True prevents real-time validations from running. Real-time validations can only be disabled by a user with appropriate privalages on versions where DBDisconnect is True. If rtvDisabled is True and then toggled back to False, all local nodes in the version are validated.
boolean dirtyTransactions: (To be deprecated).
boolean exactCopy: Indicates that the version was an exact copy of its legacy version.
+Type Definition
<complexType name="VersionType">
<sequence>
<element name="name" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element minOccurs="0" name="descr" type="string"/>
<element minOccurs="0" name="type" type="VersionTypeEnum"/>
<element minOccurs="0" name="status" type="VersionStatusEnum"/>
<element minOccurs="0" name="loadStatus" type="LoadStatusEnum"/>
<element minOccurs="0" name="accessLevel" type="AccessLevelEnum"/>
<element minOccurs="0" name="asOfParams" type="VersionParamsType"/>
<element minOccurs="0" name="normalVersion" type="string"/>
<element minOccurs="0" name="baselineRefId" type="int"/>
<element minOccurs="0" name="baselineVersion" type="string"/>
<element minOccurs="0" name="dBDisconnect" type="boolean"/>
<element minOccurs="0" name="isInDatabase" type="boolean"/>
<element minOccurs="0" name="legacyId" type="int"/>
<element minOccurs="0" name="legacyVersion" type="string"/>
<element minOccurs="0" name="legacyCopyTime" type="dateTime"/>
<element minOccurs="0" name="rtvDisabled" type="boolean"/>
<element minOccurs="0" name="dirtyTransactions" type="boolean"/>
<element minOccurs="0" name="exactCopy" type="boolean"/>
</sequence>
</complexType>
Referenced By:
Enumeration for the version parameters that indicates the type of version to create.
+Type Definition
<simpleType name="VersionTypeEnum">
<restriction base="string">
<enumeration value="Normal"/>
<enumeration value="Baseline"/>
<enumeration value="AsOf"/>
<enumeration value="FutureDated"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
Enumeration that indicates what type of version.
+Type Definition
<simpleType name="VersionTypeParamEnum">
<restriction base="string">
<enumeration value="Normal"/>
<enumeration value="Baseline"/>
<enumeration value="AsOf"/>
<enumeration value="FutureDated"/>
<enumeration value="All"/>
<enumeration value="CreateAsOf"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

VersionValidationResultType validationResult: The version validation results.
+Type Definition
<complexType name="VersionValidationResponseType">
<sequence>
<element name="validationResult" type="VersionValidationResultType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string versionName: Version name field.
int nodeCount: The number of nodes in the result.
GlobalNodeWithPropValuesListType nodes: An list type that represents the global nodes for the result.
boolean maxNodesExceeded: Flag indicating that the maximum number of nodes threshold was reached during the query run.
StringListType requestedPropNames: List of properties to return.
HierValidationResultListType hierResultList: List object type that contains hierarchy validation results.
StringListType reasonList: List of validations that failed during a validation run.
+Type Definition
<complexType name="VersionValidationResultType">
<complexContent>
<extension base="GlobalQueryResultType">
<sequence>
<element minOccurs="0" name="hierResultList" type="HierValidationResultListType"/>
<element minOccurs="0" name="reasonList" type="StringListType"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
+Type Definition
<complexType name="VoidType">
<sequence/>
</complexType>
Referenced By:
Element: addUserResponse
Element: getImportNames
Element: deleteOrphanNodesResponse
Element: copyNodeResponse
Element: deleteHierGroupResponse
Element: updateHierPropValuesResponse
Element: deleteValidationResponse
Element: deleteImportResponse
Element: createRequestResponse
Element: deletePropDefResponse
Element: addOrphanNodeResponse
Element: updateVersionPropsResponse
Element: updateUserPasswordResponse
Element: getQueryNames
Element: updateValidationResponse
Element: updateNodePropsResponse
Element: addPropDefResponse
Element: updateHierPropsResponse
Element: insertNodeWithPropsResponse
Element: deleteNodeResponse
Element: addNodeAccessGroupResponse
Element: getBlenderNames
Element: deleteBookResponse
Element: copyUserResponse
Element: createBookResponse
Element: deleteNodesResponse
Element: updateExportResponse
Element: insertNodesResponse
Element: deleteCompareResponse
Element: deleteUserResponse
Element: updateGlyphResponse
Element: insertNodeResponse
Element: deleteQueryResponse
Element: annulNodeResponse
Element: getCompareNames
Element: setHierTopNodeResponse
Element: createQueryResponse
Element: deletePropCategoryResponse
Element: setVersionValidationsResponse
Element: getUserNames
Element: updateBlenderResponse
Element: addValidationResponse
Element: addNodeResponse
Element: removeNodesResponse
Element: orderChildrenResponse
Element: getHierGroupNames
Element: copyNodePropsResponse
Element: updateUserResponse
Element: updateQueryResponse
Element: assignControlledPropsResponse
Element: deleteExportResponse
Element: reactivateNodeResponse
Element: getVersionNames
Element: updateCompareResponse
Element: addNodeTypeResponse
Element: updateNodePropValuesResponse
Element: createBlenderResponse
Element: addPropCategoryResponse
Element: updateBookResponse
Element: getNodeAccessGroupNames
Element: updateVersionPropValuesResponse
Element: setHierValidationsResponse
Element: getSysPrefs
Element: moveNodesResponse
Element: setUserPasswordResponse
Element: deleteGlyphResponse
Element: getPropCategories
Element: deleteNodeTypeResponse
Element: moveNodeResponse
Element: addHierGroupResponse
Element: openVersionResponse
Element: updatePropDefResponse
Element: getNodeTypeNames
Element: updatePropDefListValuesResponse
Element: getExportNames
Element: getValidationNames
Element: deleteHierResponse
Element: updateUserLockoutResponse
Element: updateHierGroupResponse
Element: addGlyphResponse
Element: updateNodeAccessGroupResponse
Element: addNodeWithPropsResponse
Element: getBookNames
Element: updateImportResponse
Element: deleteBlenderResponse
Element: createCompareResponse
Element: authenticate
Element: reactivateNodesResponse
Element: deleteNodeAccessGroupResponse
Element: addHierResponse
Element: getValidations
Element: createExportResponse
Element: getNodeTypes
Element: copyVersionResponse
Element: createImportResponse
Element: deleteRequestResponse
Element: inactivateNodesResponse
Element: removeNodeResponse
Element: closeVersionResponse
Element: updateRequestResponse
Element: authenticateResponse
Element: inactivateNodeResponse
Element: updatePropCategoryResponse

Fields:

ObjectAccessEnum objectAccess: Object access of the export.
string name: Name field of the export.
int id: The system-generated ID.
string descr: Description of the object.
string exportClass: The fully qualified class name of the export type, including namespace. Example: Oracle.Drm.Engine.Core.ExportManager.TransactionLogExport.
VersionParamsType currentVersionParams: Current version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
VersionParamsType previousVersionParams: The previous version parameters that indicate what type of version to use; for example, specifying a version using a date and time, date offset from the current date, a specific transaction ID.
boolean useQuotedStrings: Puts quotation marks around strings in the export.
string recordDelimiter: A sequence of characters used to specify the record boundary.
boolean useFixedWidth: Flag that indicates that the export is to be a fixed-width export.
boolean insertHeaderFooterBlankLines: Flag that instructs the server to add a line between the header/footer and the body of the export results.
CharacterEncodingEnum characterEncoding: Enumeration indicating encoding of the text file.
boolean hasColumnHeaders: Flag indicating that the export result should include column header label.
ExportColumnListType columns: List of columns to export.
CustomExportParamListType customParams: Parameter values used by custom exports.
string queryName: Name of the query to apply to the export.
string validationName: Name of the validation to apply to the export.
boolean includeInactive: Flag indicating that the export results should include inactive nodes.
ExportOutputModeEnum outputMode: Enumeration of what type of medium the export results should be exported to.
string fileName: Name of the file to be exported.
string includeFileConnection: External connection name to be used if exporting to a server device.
boolean dbClearOnVersion: If exporting to a database, indicates whether export table records with KeyFields containing this export's version ID will be deleted before inserting export output records.
boolean dbClearTable: If exporting to a database, clears the table before exporting.
string dbConnectionString: If exporting to a database, connection string to the database.
string dbExportDAL: The fully qualified name (including namespace) of the export data access layer class that implements IExportDalFactory. This class will be used to create the export DAL used for this export's output.
boolean dbOutputEnabled: Indicates whether the export's type allows its output to be directed to a database. Note that this is a read-only field as far as the API is concerned. Any value for this property that is set though the API will be ignored.
string dbPassword: (To be deprecated)
string dbTableName: If exporting to a database, database table name to export to.
boolean dbUseFastAppends: If exporting to a database, indicates whether the export DAL table will be populated more quickly by using the SQL BulkUpdate facility. This is based on provider support.
boolean dbUseFastDeletes: Indicates whether an export table with data will cleared more quickly by using a SQL table "truncate" command rather than line-by-line deleting of records.
boolean dbUseTransactions: Determines whether records for this export's output will be inserted inside a database transaction. This parameter will be used only when the output mode is Table.
string dbUserName: The database user name that will be used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string dbVendor: The database vendor string used to connect to the export dal where output for this export will be directed. This parameter will be used only when the output mode is Table.
string delimiter: Delimits values in a row of export output.
string header: Header text for the export output.
string footer: Footer text for the export output.
StringListType fromList: Array of string values to replace in the export results. Currently three string items are supported.
string fromStrValue: A string value representing each item in the fromList array delimited by a comma.
StringListType toList: Array of string values that are replacing values for the values in the fromList field. Currently three string items are supported.
string toStrValue: A string value representing each item in the toList array delimited by a comma.
string userName: User name associated with this export.
int userId: User ID associated with this export.
boolean hasWarning: Indicates whether a WarningMessage has been encountered during this export's execution.
StringListType warningMessages: Warnings that were encountered during export execution.
int maxTopNodes: (To be deprecated)
NodeLocatorListType nodesToExpand: List of node locator objects to identify the top nodes to export from.
boolean pushDown: Flag to automatically repeat nodes down to the defined level in the export structure.
string pushDownNode: Constant to push the repeat nodes from: BottomLeaf, Bottom, Root are possible values.
boolean recurse: Select to include output for all nodes below the top node. If False, only the top node is included (which is typically not the desired result).
int bottomLevel: Determines the maximum depth of the export structure
string bottomLevelProp: Property that determines the maximum depth of the export structure. This value can be defined as a hierarchy-level, integer property
QueryType query: Query to include
boolean removeDuplicates: Select to use the primary key (defined on the column Options tab) to suppress.
string repeatNumProp: References a local, node-level, integer property that repeats a node within an export structure.
boolean tabbedTree: Set to True to indent the nodes for each level of a hierarchy using tab characters to produce a structured output format.
boolean includeLeafs: Flag to include leaf nodes in the export results.
boolean includeLimbs: Flag to include limb nodes in the export results.
IncludeFileModeEnum includeFileMode: Enumeration indicating whether the nodes located in the includeFileName should be included or excluded.
string includeFileName: The name of the file on the external connection to use for filtering (include or exclude) nodes.
boolean includeImplicitlySharedNodes: Set to True to include descendant nodes below shared limb nodes that are explicitly shared. Implicit shared nodes are exported only if not filtered out by another option.
+Type Definition
<complexType name="XmlHierExportType">
<complexContent>
<extension base="HierExportType">
<sequence/>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
+Type Definition
Referenced By:
Type: SystemPreferenceType
Type: HierExportType
Type: VersionType
Type: VersionParamsType
Type: RunBlenderByName
Type: RequestValidationResultItemType
Type: AddPropCategory
Type: NodeAccessGroupType
Type: IntResponseType
Type: BlenderType
Type: ActionItemType
Type: BlenderHierSetType
Type: UserType
Type: RunValidateNode
Type: StartCreateAsOfTxnID
Type: CompareType
Type: DeleteRequest
Type: RunValidateVersion
Type: QueryResultType
Type: GenerationExportType
Type: GetOrphanNodes
Type: JobResultRetrievalInputType
Type: ImportResultsType
Type: QueryType
Type: ExportColumnType
Type: PropCategoryType
Type: GlyphType
Type: ApproveRequest
Type: NodeType
Type: ValidationParamType
Type: BookType
Type: AddHierGroup
Type: CalculatedSequenceColumnType
Type: ScriptLoadParamsType
Type: BookItemType
Type: RequestItemType
Type: JobInfoType
Type: PropDefType
Type: SearchForNodesInVersion
Type: QueryCriteriaType
Type: NodeTypeType
Type: LogCriteriaType
Type: BookItemResults
Type: ExportType
Type: DrmServiceException
Type: RunValidateHier
Type: HierCompareExportType
Type: GetRequestById
Type: ValidationDefinitionType
Type: ImportType
Type: RequestQueryParamsType
Type: RequestHeaderType
Type: HierGroup
Type: BlenderResultsType
Type: GlobalNodeType
Type: PropDefParamType
Type: GlobalQueryResultType
Type: UserInputType
Type: RequestValidationResultType
Type: SearchForNodesInHier
Type: ImportFlatFileColumnType
Type: HierType
Type: AddValidation
Type: NodeColumnType
Type: LogItemType
Type: HierDiffExportType
+Type Definition
Type Hierarchy:
Referenced By:
Type: NodeMoveRequestItemType
Type: GetUser
Type: SetHierValidations
Type: AddHier
Type: UpdateNodePropValues
Type: RunBlenderByName
Type: RequestValidationResultItemType
Type: AddPropCategory
Type: UpdateHierPropValues
Type: ActionItemType
Type: ImportFlatFileType
Type: RunValidateNode
Type: CopyVersion
Type: AddUser
Type: LookupExportType
Type: ImportColumnType
Type: GetGlobalNode
Type: GetGlyph
Type: ImportResultsType
Type: HierPropUpdateRequestItemType
Type: NodeType
Type: DeleteHierGroup
Type: InactivateNode
Type: AddHierGroup
Type: AddOrphanNode
Type: ImportVersionSectionType
Type: InsertNodeWithProps
Type: GetVersion
Type: GetExport
Type: ValidationParamInputType
Type: HierAddRequestItemType
Type: QueryCriteriaType
Type: StartCompareExportByNameOnHierNode
Type: GetImport
Type: ExportType
Type: GetHierNames
Type: DeleteUser
Type: DatePropColumnType
Type: GetNodePropValues
Type: GetRequestByExternalId
Type: GetScriptFromModel
Type: PropDefParamType
Type: GetVersionProps
Type: DeleteNodeAccessGroup
Type: StartHierExportByNameOnHierNodes
Type: DeleteValidation
Type: StringResponseType
Type: AddValidation
Type: GetSysPrefValue
Type: SystemPreferenceType
Type: HierExportType
Type: GetNodeByID
Type: GetNode
Type: GetAssignedVersionValidations
Type: OpenVersion
Type: VersionType
Type: HierNodeNamePairType
Type: AssignControlledProps
Type: VersionParamsType
Type: NodeLocatorType
Type: ImportSectionType
Type: UpdateVersionPropValues
Type: GetGlobalNodePropValues
Type: DeleteNode
Type: StartHierExportByNameOnHierNode
Type: UpdateVersionProps
Type: MoveNode
Type: BlenderHierSetType
Type: InsertNodes
Type: NodeMergeRequestItemType
Type: StartCreateAsOfTxnID
Type: CompareType
Type: GetNodeAccessGroupUserList
Type: BaseNodeRequestItemType
Type: QueryResultType
Type: GlyphType
Type: SetHierTopNode
Type: BlenderPropType
Type: ActionItemResultType
Type: GetRelatedNodeNames
Type: UpdateUserPassword
Type: StartHierExportByName
Type: JobInfoType
Type: AddGlyph
Type: GetRelatedNodeCount
Type: DeleteGlyph
Type: AppParameters
Type: GetValidation
Type: HierLocatorType
Type: StartCopyVersion
Type: DeleteNodes
Type: GetGlobalNodeProps
Type: RunValidateHier
Type: GetControlledPropNames
Type: GetNodeWithProps
Type: HierGroup
Type: DeleteHier
Type: BlenderResultsType
Type: GetHierPropValues
Type: ReactivateNodes
Type: GetHier
Type: GetNodes
Type: MoveNodes
Type: StartSaveVersion
Type: UpdatePropDefListValues
Type: DeleteNodeType
Type: GetHierGroup
Type: DeleteExport
Type: NameValueType
Type: NodeAccessGroupType
Type: StartCreateVersionAsOfDate
Type: AddNode
Type: HierRequestItemType
Type: CustomExportParamType
Type: RemoveNodes
Type: GetPropDefsByCategory
Type: ConstantColumnType
Type: GetRelatedNodes
Type: StartCompareExportByNameOnHier
Type: GetGlobalNodes
Type: DeleteBlender
Type: RunValidateVersion
Type: GetPropDef
Type: SetVersionValidations
Type: QueryType
Type: ExportColumnType
Type: PropCategoryType
Type: ImportErrorLogType
Type: GetNodeAccessGroup
Type: DeleteImport
Type: VersionPropUpdateRequestItemType
Type: GetQuery
Type: RequestValidationResultNodeType
Type: BookType
Type: AddNodeType
Type: GetBook
Type: BookItemType
Type: UpdateHierProps
Type: DataColumnType
Type: RequestItemType
Type: PropDefType
Type: HierPropRequestItemType
Type: UpdateNodeProps
Type: PropListExportType
Type: NodeTypeType
Type: UserAccessType
Type: InsertNode
Type: ControllingHierType
Type: NodeRequestItemType
Type: ReactivateNode
Type: GetHierProps
Type: HierCompareExportType
Type: ImportType
Type: DeletePropDef
Type: RequestQueryParamsType
Type: RemoveNode
Type: StartExportByName
Type: GlobalNodeType
Type: GetNodeProps
Type: BaseParamsType
Type: UserInputType
Type: NodePropRequestItemType
Type: InactivateNodes
Type: SearchForNodesInHier
Type: SetUserPassword
Type: MergeLogExportType
Type: HierType
Type: GetCompare
Type: StartHierExportByNameOnHiers
Type: UpdateQuery
Type: StartCompareExportByName
Type: StartCompareByName
Type: VersionPropRequestItemType
Type: BlenderType
Type: GetHiers
Type: StartDeleteVersion
Type: StartBlenderByName
Type: DeletePropCategory
Type: DeleteBook
Type: GetHierTopNode
Type: GetRelatedNodesWithProps
Type: StringParamsType
Type: CopyNode
Type: GetOrphanNodes
Type: AnnulNode
Type: GlobalNodeLocatorType
Type: StringListType
Type: GetAssignedGlobalValidations
Type: DeleteCompare
Type: NodePropUpdateRequestItemType
Type: ScriptLoadParamsType
Type: DeleteOrphanNodes
Type: GetVersionPropValues
Type: SearchForNodesInVersion
Type: LogCriteriaType
Type: RunCompareByName
Type: StartBookByName
Type: DrmServiceException
Type: CloseVersion
Type: ValidationDefinitionType
Type: StartImportByName
Type: GetBlender
Type: RequestHeaderType
Type: PropType
Type: AddVersion
Type: GlobalQueryResultType
Type: DeleteQuery
Type: AddNodeWithProps
Type: PropColumnType
Type: LogItemType
Type: CopyUser