Content Model Web Services Definition - 8.0.0 Schema to define the base content model Base content model attribute group definitions All of the attributes on the BaseAttrs are read-only. However, for update operations, the id and/or path attributes are set by the consumer to tell the server which node is being updated. The permissions attribute is a comma delimited value. The delimited values will map to the Permission enumeration The hidden attribute is read-only for all derived types. The created and lastModified are read-only and system managed for all derived types except ClbDraft. When creating a draft, the consumer can specify these values to reflect the time on the consumer machine and not the server. The language attribute is read-only for ClbFolder. The dataLength and dataLastModified attributes are read-only for all derived types. The dataMimeType is read-only for all derived types except ClbDraft. The dataMimeType can only be set when the draft is created. Once the dataMimeType is set, it can not be changed. The label attribute is read-only for all derived types. The effectiveDate and expirationDate are currently only applicable for ClbDocument and ClbDraft. These are reserved for future use on all other sub-types. Base content model complex type definitions The creator, lastModifier, lockOwner, owners and categories attributes are read-only for all derived types. The Version is currently only used on retrieval operations, so all attributes are considered read-only. Schema to define the Clb content model Clb content model attribute group definitions The currentState attribute is read-only for all derived types. Clb content model simple type definitions Clb content model complex type definitions The key attribute is read-only. However, for update operations, the consumer will set this value to indicate to the server which dynamic value is to be updated. The id attribute inherited from BaseAttrs is read-only. However, for ClbDraft create/update operations, the consumer can create an empty ClbDocumentType and set the id to indicate to the server that a specific ClbDocumentType is to be applied. All other attributes on ClbDocumentType are considered read-only. The propertySheetTypeId and extracted attributes are read-only. The typical usage pattern for the dynamicXXX arrays is for the consumer to retrieve the populated values from the server, and then update any "value" attributes on the dynamicXXX elements that need to be updated on the server. The id, extracted and templateXml attributes are read-only. The propertySheets and propertySheetTypes attributes are read-only. The downloadURL and documentType attributes are read-only. A document can only have a single draft, so the drafts array has a maximum size of 1. The ClbDraft data inside of the drafts array can be updated, but the array itself should be considered immutable. The approvers, approvalStates, expandGroups, approvalEnabled, approvalType and submitted attributes are read-only. The documentType is also read-only, however, create and update operations, the consumer can create an empty ClbDocumentType and set the id to indicate to the server that a specific ClbDocumentType is to be applied. The folders and documents arrays are read-only. The ClbLibrary is currently only used on retrieval operations, so all attributes are considered read-only. The ClbTreeItem is currently only used on retrieval operations, so all attributes are considered read-only. The ClbTreeFolder is currently only used on retrieval operations, so all attributes are considered read-only. The ClbView is currently only used on retrieval operations, so all attributes are considered read-only. The ClbLabelType is currently only used on retrieval operations, so all attributes are considered read-only. The ClbStyleType is currently only used on retrieval operations, so all attributes are considered read-only. The ClbOptionType is currently only used on retrieval operations, so all attributes are considered read-only. The ClbPropertyType is currently only used on retrieval operations, so all attributes are considered read-only. The ClbViewFormatColumn is currently only used on retrieval operations, so all attributes are considered read-only. The ClbColumn is currently only used on retrieval operations, so all attributes are considered read-only. The ClbViewResult is currently only used on retrieval operations, so all attributes are considered read-only. Schema to define the service exceptions Service exceptions complex type definitions Schema to define the service methods Service methods simple type definitions Service options enable clients of the service to specify optional behavior for a call. Multiple options may be passed in a call to customize the response. None - specifying an option of none implies that no additonal custom behavior will take place on the call. IncludeDrafts - Will result in the ClbDocument that is returned from a call to include its ClbDraft objects if they exist. IncludeApproveDrafts - Will result in the ClbDocument that is returned from a call to include its ClbDraft objects if the caller is an approver of the draft. IncludeReferences - Will result in the returned objects to include types that are concidered references. Currently, this only applies to ClbDocumentType and ClbPropertySheetType. IncludePermissions - Will result in retrieving the permissions for a piece of content for the given user. IncludePropertySheets - Will result in any object that supports and has custom metadata to include the associated property sheets for that object. ResolveLockOwner - Will result in populating the lock owner, if any, on the piece of content. RetrieveDownloadURL - Will result in populating the url for a piece of content with the location to download its binary contents. RetrieveViewURL - Will result in populating the url for a piece of content with the address to view this object in the browser. IncludeFolderChildren - Will result in retrieving the child documents and folders when requesting a folder object. Each ClbResponse, or sub-type, that is returned from an operation can potentially contain an error. These errors are considered "application" level errors that the consumers can potentially react to. "System" level errors are manifested as SOAP faults. The supported error types and their meanings are below. AccessDenied - The user performing the operation does not have the required permissions to complete it. ItemNotFound - The requested item can not be found in the repository. ItemExists - The creation of an item takes place but the item already exists. DocumentNotLocked - The operation that is being executed requires that the document already be locked, but it is not locked. DocumentAlreadyLocked - The operation that is being executed needs to lock the document, but it is already locked by another user. DraftExists - The operation that is being executed can not be performed because a draft exists. DraftSubmitted - The operation that is being executed can not be completed because the draft is in the submitted state. UnsupportedVersion - The consumer has sent up a serviceVersion that is not supported by the server. UnsupportedOperation - The server that the consumer is connected to does not support the operation that was invoked. OnlyDocumentsCanBeLocked - The consumer is attempting to lock a node that is not a document type. ExtensionChangeNotAllowed - The consumer is attempting to change the document extension during a renameDocument call. VersionLabelNotFound - The consumer has supplied a version label that does not exist on the document. ConstraintViolation - The consumer has sent up data that violates a repository constraint. Example: property value too large, or invalid characters. FixedFolder - The consumer is attempting to create, update or delete a folder under a business component, and the library does not support these actions. InvalidTypeForOperation - The consumer has sent up an id and/or path that resolves to a type that is not expected by that operation. InvalidPath - The consumer has sent up a path value that is either too long, or contains invalid characters. GeneralInformation - A general purpose error, which contains an appropriate message, that is returned when no other error type is applicable. Service methods complex type definitions The Property is currently only used on retrieval operations, so all attributes are considered read-only. The UserInfo is currently only used on retrieval operations, so all attributes are considered read-only. The ServerInfo is currently only used on retrieval operations, so all attributes are considered read-only. Service methods response definitions The ClbResponse is the base type for all response types. It contains a single error field. If one of the errors, which are defined in the ClbErrorType, occurred while processing the request, then the error field will contain that error. If no error occurred, the error will be null. The UserResponse contains a single userInfo field. This field will contain the requested information about the user. If an error occurred while processing the request, the userInfo field will be null. The UsersResponse contains an single userInfos field. This field will contain the array of UserInfo objects that corresponds to the list of userIds that was requested. If an error occurred while processing the request, the userInfos field will be null. The ServerInfoResponse contains a single serverInfo field. This field will contain the requested information about the server. If an error occurred while processing the request, the serverInfo field will be null. The ClbDocumentResponse contains a document field that contains the requested ClbDocument. If an error occurred while processing the request, the document field will be null. The ClbDocumentsResponse contains a documents field that contains the requested list of ClbDocuments. If an error occurred while processing the request, the document field will be null. The ClbCancelDocumentResponse contains a documentDeleted boolean that indicates if the document was deleted. If a new document has not yet been published, and it is cancelled, then the document will be deleted. If an error occurred while processing the request, the value of the documentDeleted field should be ignored. The ClbVersionResponse contains a singe versionName attribute, which will contain the version name that was generated. If an error occurred while processing the request, the versionName field will be null. The ClbVersionsResponse contains a list of Version objects. If an error occurred while processing the request, the versions field will be null. The ClbDraftResponse contains a draft field that contains the requested ClbDraft. If an error occurred while processing the request, the draft field will be null. The ClbApproveDraftResponse contains a draftPublished boolean that indicates if the draft was published. If the person approving the draft is the last one in the list, then the draft will be published. Otherwise, the draft will be forwarded to the next approver. If an error occurred while processing the request, the value of the draftPublished field should be ignored. The ClbDraftsResponse contains a drafts field that contains the requested list of ClbDraft objects. If an error occurred while processing the request, the drafts field will be null. The ClbFolderResponse contains a folder field that contains the requested ClbFolder. If an error occurred while processing the request, the folder field will be null. The ClbFoldersResponse contains a folders field that contains the requested list of ClbFolder objects. If an error occurred while processing the request, the folders field will be null. The ClbLibraryResponse contains a library field that contains the requested ClbLibrary. If an error occurred while processing the request, the library field will be null. The ClbLibrariesResponse contains a libraries field that contains the requested list of ClbLibrary objects. If an error occurred while processing the request, the libraries field will be null. The ClbPropertySheetTypeResponse contains a propertySheetType field that contains the requested ClbPropertySheetType. If an error occurred while processing the request, the propertySheetType field will be null. The ClbTreeResponse contains a root field that contains the requested ClbTreeFolder, which represents the root node of the requested tree. If an error occurred while processing the request, the root field will be null. The ClbViewResponse contains a view field that contains the requested ClbView. If an error occurred while processing the request, the view field will be null. The ClbViewsResponse contains a views field that contains the requested list of ClbView objects. If an error occurred while processing the request, the views field will be null. The ClbViewResultsResponse contains a columnFormats and results fields that contain the requested view information. If an error occurred while processing the request, these fields will be null. The ClbViewFormatResponse contains a columnFormats field that contains the requested ClbView. If an error occurred while processing the request, the columnFormats field will be null. The ClbContentURLResponse contains a url field that contains the requested URL. If an error occurred while processing the request, the url field will be null. The ClbDocumentTypeResponse contains a documentType field that contains the requested ClbDocumentType. If an error occurred while processing the request, the documentType field will be null. The ClbDocumentTypesResponse contains a documentTypes field that contains the requested list of ClbDocumentType objects. If an error occurred while processing the request, the documentTypes field will be null. The ClbCopyResponse contains attributes from the newly created node. If an error occurred while processing the request, these fields will be null. The ClbMoveResponse contains attributes from the moved node. If an error occurred while processing the request, these fields will be null. The ClbCheckinResponse contains attributes from the checked in node. If an error occurred while processing the request, these fields will be null. Element definitions for the ContentService The getUser operation retrieves the requested UserInfo object and returns it in the UserResponse. The getUsers operation retrieves a list of UserInfo objects that are specified by the ids parameter and returns then in the UsersResponse. Parameters: ids - The list of user dn values to retrieve. The getServerInfo operation retrieves the ServerInfo object and returns it in the ServerInfoResponse. Element definitions for the DocumentService The getDocument operation retrieves the requested ClbDocument and returns it in the ClbDocumentResponse. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDocument to retrieve. If only a path is provided, that path must be the absolute path to the ClbDocument to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDocument and the path must be the relative path from the parent folder. The url attribute of the returned ClbDocument will also be populated if the ClbServiceOption RetrieveDownloadURL or RetrieveViewURL is provided. If the RetrieveDownloadURL is provided, then the url attribute will be populated with a URL that will download the binary content of the document. If the RetrieveViewURL is provided, then the url attribute will be populated with a URL that will bring up the portal web page that contains the document. If both RetrieveDownloadURL and RetrieveViewURL options are provided, the url attribute will be populated with the download url. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. downloadOption - Placeholder for future MTOM attachment support. serviceOptions - Multiple service options can be provided to control the returned results. The supported values are None, IncludeDrafts, IncludeReferences, IncludePermissions, IncludePropertySheets, ResolveLockOwner, IncludeApproveDrafts, RetrieveDownloadURL and RetrieveViewURL. The getDocuments operation retrieves a list of ClbDocuments that are in a specified folder and returns the documents in the ClbDocumentsResponse. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbFolder that contains the documents to retrieve. If only a path is provided, that path must be the absolute path to the ClbFolder that contains the documents to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the target folder and the path must be the relative path from the parent folder to the target folder that contains the documents to retrieve. Parameters: id - The uuid of the folder that contains the documents to retrieve if no path is provided. If both id and path are provided, the uuid must be the uuid of the folder that is a parent to the target folder that contains the documents to retrieve. path - The absolute path to the document if no id is provided. If id and path are provided the path must be the relative path from the parent folder to the target folder that contains the documents to retrieve. serviceOptions - Multiple service options can be provided to control the returned results. The supported values are None, IncludeDrafts, IncludeReferences, IncludePermissions and ResolveLockOwner. The getLockedDocuments operation retrieves a list of ClbDocuments, which are locked by the current user, and that are under the specified folder. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the root ClbFolder where the search will begin. If only a path is provided, that path must be the absolute path to the root ClbFolder. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the target ClbFolder and the path must be the relative path from the parent folder to the target folder where the search will begin. This operation searches all subfolders under the specified folder. Parameters: id - The uuid of the folder where the search will begin if no path is provided. If both id and path are provided, the uuid must be the uuid of the folder that is a parent to the target folder. path - The absolute path to the folder where the search will begin if no path is provided. If id and path are provided the path must be the relative path from the parent folder to the target folder. The getDocumentVersions operation retrieves a list of versions for the specified ClbDocument and returns them in the ClbVersionsResponse. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDocument If only a path is provided, that path must be the absolute path to the ClbDocument. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDocument and the path must be the relative path from the parent folder. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. The getDocumentVersion operation retrieves the specified version of a ClbDocument and returns it in the ClbDocumentResponse. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDocument to retrieve. If only a path is provided, that path must be the absolute path to the ClbDocument to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDocument and the path must be the relative path from the parent folder. This operation supports retrieving a version by name or version label. The value is of either the verion name or verion label is provided in the verion parameter. The type that is provided (i.e. name or label) is specified by the versionType parameter. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. version - Either the verion name or verion label. versionType - An enumeration value of either Name or Label. downloadOption - Placeholder for future MTOM attachment support. The restoreVersion operation makes the specified verion of a given document the current working version. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDocument to retrieve. If only a path is provided, that path must be the absolute path to the ClbDocument to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDocument and the path must be the relative path from the parent folder. This operation supports restoring a version by name or version label. The value of either the verion name or verion label is provided in the verion parameter. The type that is provided (i.e. name or label) is specified by the versionType parameter. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. version - Either the verion name or verion label. versionType - An enumeration value of either Name or Label. The createVersion operation creates a version of the specified document. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDocument to retrieve. If only a path is provided, that path must be the absolute path to the ClbDocument to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDocument and the path must be the relative path from the parent folder. Multiple versions of the same document are not allowed. In other words, the meta-data or the binary contents of the document must change before a subsequent version is allowed. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. comments - Optional comments text that will be part of this version. The addVersionLabel operation adds a label to a specified version of a document. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDocument to retrieve. If only a path is provided, that path must be the absolute path to the ClbDocument to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDocument and the path must be the relative path from the parent folder. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. version - The version name to add the label to. label - The label to be added. The removeVersionLabel operation removes a label from a specified version of a document. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDocument to retrieve. If only a path is provided, that path must be the absolute path to the ClbDocument to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDocument and the path must be the relative path from the parent folder. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. version - The version name to remove the label from. label - The label to be removed. The deleteDocument operation is used to delete a document from the repository. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the document to delete. If only a path is provided, that path must be the absolute path to the document to delete. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the document and the path must be the relative path from the parent folder. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. The copyDocument operation is used to copy a document into a specified folder. This operation can be called by id, path or a combination of id and path. This is true for both the source (i.e. the document to be copied) and for the destination folder. If only the srcId is provided, the srcId must be the uuid of the document to be copied. If only a srcPath is provided, that srcPath must be the absolute path to the document to be copied. If the srcId and srcPath are both provided, the srcId must be the uuid of a folder that is a parent of the document to be copied and the srcPath must be the relative path from the parent folder. The same pattern is true for destId and destPath. Parameters: srcId - The uuid of the source document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. srcPath - The absolute path to the source document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. destId - The uuid of the destination folder if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the destination folder. destPath - The absolute path to the destination folder if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. shallowCopy - If true, the copy will not include the children of the document. If false, the document and children will be copied to the target. Currently, the only child types that are copied are property sheets. The drafts and comments of a document are never copied. The moveDocument operation is used to move a document. This operation can be called by id, path or a combination of id and path. This is true for both the source and destination parameters. If only the srcId is provided, the srcId must be the uuid of the document to be moved. If only a srcPath is provided, that srcPath must be the absolute path to the document to be moved. If the srcId and srcPath are both provided, the srcId must be the uuid of a parent folder of the document to be moved and the srcPath must be the relative path from the parent folder. The same pattern is true for destId and destPath. NOTE: The destId and destPath should reference the resulting document and not the parent folder where the source document is being moved to. In other words, if a document is being moved, and only the destPath is supplied, this should be the absolute path of the document after the move is completed. Since the move results in a new document being created, and thus a new uuid, the user should not attempt to supply only a destId without a destPath. Parameters: srcId - The uuid of the source document if no path is provided. If both srcId and srcPath are provided, the srcId must be the uuid of the parent folder to the document that is being moved. srcPath - The absolute path to the source document if no srcId is provided. If both srcId and srcPath are provided, the path must be the relative path from the id provided. destId - The uuid of the destination parent folder. The destId should not be supplied without also providing a destPath. If both destId and destPath are provided, the destId must be the uuid of the destination parent folder destPath - The absolute path to the resulting document after the move. If both destId and destPath are provided, the path must be the relative path from the id provided. The renameDocument operation will rename the specified document. Prior to renaming a document, this operation will attempt to obtain a lock on the document. If the document is already locked by another user, a DocumentAlreadyLocked error will be returned. If the document is not locked, it will be locked, the document will be renamed, and then unlocked. If the document is locked by the current user and no draft exists, the document will be renamed and remain locked. If the document is locked by the current user and a draft exists, a DraftExists error will be returned. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the document to rename. If only a path is provided, that path must be the absolute path to the document to rename. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the document and the path must be the relative path from the parent folder. The newName should contain the name that the document will be renamed to. The base name can be changed, but not the extension. For example, if the current file name is foo.doc, a newName value of bar.doc is valid. However, a newName of foo.xls or bar.txt is not valid. If the extension is attempted to be changed, an ExtensionChangeNotAllowed ClbErrorType will be returned. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. newName - name that the document will be renamed to. The base name of a document can be changed, but not the extension. The lockDocument operation is used to lock a document in the repository. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the document to be locked. If only a path is provided, that path must be the absolute path to the document to be locked. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the document and the path must be the relative path from the parent folder. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. The unlockDocument operation is used to unlock a document in the repository. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the document to be unlocked. If only a path is provided, that path must be the absolute path to the document to be unlocked. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the document and the path must be the relative path from the parent folder. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. The checkoutDocument operation attempts to lock the requested ClbDocument and returns the data of the document in the ClbDocumentResponse. If the document is already locked by someone else, a DocumentAlreadyLocked error will be returned with the user information of the person that has it locked. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDocument to retrieve. If only a path is provided, that path must be the absolute path to the ClbDocument to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDocument and the path must be the relative path from the parent folder. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. downloadOption - Placeholder for future MTOM attachment support. The checkinDocument operation takes the data provided in the document parameter and updates the corresponding draft in the repository. If draft approval is enabled, the draft will be submitted for approval. Otherwise, the draft will be published and the parent document will be unlocked. The id or path attributes are the only required values to be supplied, and they must reference the document that is being checked in. Parameters: document - The id or path attribute is the only required attribute to be supplied in the document parameter. The id or path should reference the document to be checked in. If any other data is supplied in the document, that data will be updated on the document prior to checking it in. The cancelDocument operation will cancel a prior checkout of the referenced document. If a draft does not exist, the document will be unlocked. If a draft exists, the parent document has not yet been published (i.e. this is a newly created draft and document), the draft and parent document will both be deleted. In this scenario, the documentDeleted attribute in the ClbCancelDocumentResponse will be true. If a draft exists, and the parent document has already been published, the draft will be deleted and the parent document will be unlocked. If the document is locked by someone else, a DocumentAlreadyLocked error will be returned with the user information of the person that has it locked. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDocument to cancel. If only a path is provided, that path must be the absolute path to the ClbDocument to cancel. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDocument and the path must be the relative path from the parent folder. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. The approveDraft operation is called when the draft approver wishes to approve a draft. If there are additional approvers, the draft will be sent to the next approver in the chain. If there are no other approvers, the draft will be published. If the draft is published, the draftPublished attribute in the ClbApproveDraftResponse will be true. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDraft to approve. If only a path is provided, that path must be the absolute path to the ClbDraft to approve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDraft and the path must be the relative path from the parent folder. Parameters: id - The uuid of the draft if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the draft. path - The absolute path to the draft if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. The submitDraft operation will attempt to submit the referenced draft for approval. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDraft to submit. If only a path is provided, that path must be the absolute path to the ClbDraft to submit. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDraft and the path must be the relative path from the parent folder. Parameters: id - The uuid of the draft if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the draft. path - The absolute path to the draft if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. The rejectDraft operation is called when the draft approver wishes to reject a draft. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDraft to reject. If only a path is provided, that path must be the absolute path to the ClbDraft to reject. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDraft and the path must be the relative path from the parent folder. Parameters: id - The uuid of the draft if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the draft. path - The absolute path to the draft if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. The createDraft operation creates a ClbDraft in the repository. The data provided in the draft parameter will be used to populate the new draft in the repository. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDocument to create a draft of. If only a path is provided, that path must be the absolute path to the ClbDocument to create a draft of. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDocument and the path must be the relative path from the parent folder. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. draft - The data that will be used to populate the new draft. The getDraft operation retrieves the requested ClbDraft and returns it in the ClbDraftResponse. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDraft to retrieve. If only a path is provided, that path must be the absolute path to the ClbDraft to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDraft and the path must be the relative path from the parent folder. Parameters: id - The uuid of the draft if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the draft if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. downloadOption - Placeholder for future MTOM attachment support. The updateDraft operation takes the data provided in the draft parameter and updates the corresponding draft in the repository. The id or path attribute should be populated to indicate which draft in the repository should be updated. This operation does not support the id and path offset behavior that some of the other operations support. If the id is supplied, the id must be the uuid of the draft that is to be updated. If the path is supplied, the value can be the path of the draft or the path of the parent document. This behavior is a convenience for those consumers that may not differentiate between the path of the draft and the path of the parent document. If both the id and path are supplied, the id will be used. A common scenario is to first check to see if a document already exists, and if it does not, call createDraft to create both the document and draft. If the document already exists, then call updateDraft. For convenience, the updateDraft can be used for both scenarios. If the parent docuemnt does not exist, and the createDocument is true, the parent document will automaticaly be created as part of the draft creation. In this scenario, the path atribute of the draft parameter should be the absolute path of the document that is to be created. Parameters: draft - The data supplied in the draft will be used to update the draft in the repository. createDocument - If the createDocument=true and the parent document does not exist, it will be automatically created as part of the draft creation. In this scenario, the path of the draft should be that of the parent document that will be created. The getPrivateDrafts operation retrieves a list of ClbDraft objects that are in a specified folder and returns the doucments in the ClbDraftsResponse. The drafts that are returned are private drafts and con only be seen by the current user. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbFolder that contains the drafts to retrieve. If only a path is provided, that path must be the absolute path to the ClbFolder that contains the drafts to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the target ClbFolder and the path must be the relative path from the parent folder to the target folder. Parameters: id - If no path is provided, this should be the uuid of the folder to look for drafts under. If both id and path are provided, the id must be the uuid of the parent folder of the search folder. path - If no id is provided, the absolute path to the folder to look for drafts under. If both id and path are provided, the path must be the relative path from the id provided. The getSubmittedDrafts operation retrieves a list of ClbDraft objects that are in a specified folder and returns the doucments in the ClbDraftsResponse. The drafts that are returned are those drafts that the current user has submitted for approval. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbFolder that contains the drafts to retrieve. If only a path is provided, that path must be the absolute path to the ClbFolder that contains the drafts to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the target ClbFolder and the path must be the relative path from the parent folder to the target folder. Parameters: id - If no path is provided, this should be the uuid of the folder to look for drafts under. If both id and path are provided, the id must be the uuid of the parent folder of the search folder. path - If no id is provided, the absolute path to the folder to look for drafts under. If both id and path are provided, the path must be the relative path from the id provided. The getApproveDrafts operation retrieves a list of ClbDraft objects that are in a specified folder and returns the doucments in the ClbDraftsResponse. The drafts that are returned are those drafts that the current user is listed as an approver of. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbFolder that contains the drafts to retrieve. If only a path is provided, that path must be the absolute path to the ClbFolder that contains the drafts to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the target ClbFolder and the path must be the relative path from the parent folder to the target folder. Parameters: id - If no path is provided, this should be the uuid of the folder to look for drafts under. If both id and path are provided, the id must be the uuid of the parent folder of the search folder. path - If no id is provided, the absolute path to the folder to look for drafts under. If both id and path are provided, the path must be the relative path from the id provided. The getFolder operation retrieves the requested ClbFolder and returns it in the ClbFolderResponse. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbFolder to retrieve. If only a path is provided, that path must be the absolute path to the ClbFolder to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbFolder and the path must be the relative path from the parent folder. Parameters: id - The uuid of the folder if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the target folder. path - The absolute path to the folder if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. serviceOptions - Multiple service options can be provided to control the returned results. The supported values are None, IncludeFolderChildren, IncludePermissions, and IncludePropertySheets. The getFolders operation retrieves a list of ClbFolder objects that are in a specified folder and returns the folders in the ClbFoldersResponse. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbFolder that contains the folders to retrieve. If only a path is provided, that path must be the absolute path to the ClbFolder that contains the folders to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the target ClbFolder and the path must be the relative path from the parent folder to the target folder. Parameters: id - The uuid of the folder that contains the folders to retrieve if no path is provided. If both id and path are provided, the uuid must be the uuid of the folder that is a parent to the target folder. path - The absolute path to the folder if no id is provided. If id and path are provided the path must be the relative path from the parent folder to the target folder. The getTree operation can be used to get a recursive tree starting at a specified folder. This operation was designed to only return a minimal set of information to maximize performance of transmitting large amounts of excess data across the wire. The ClbTreeFolder and ClbTreeItem objects used in the return allow this, as opposed to returning ClbFolder and ClbDocument objects. Parameters: id - The uuid of the folder if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the target folder. path - The absolute path to the folder if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. The createFolder operation creates a ClbFolder in the repository. The data provided in the folder parameter will be used to populate the new ClbFolder in the repository. Parameters: folder - The data that will be used to populate the new folder. The path attribute must contain the absolute path of the folder to be created. The updateFolder operation takes the data provided in the folder parameter and updates the corresponding ClbFolder in the repository. The id or path attributes of the folder parameter must reference the folder that is being updated. Parameters: folder - The id or path attribute of the foler should reference the folder in the repository to be updated. The data supplied in the folder will be used to update the folder in the repository. The deleteFolder operation is used to delete a folder from the repository. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the folder to delete. If only a path is provided, that path must be the absolute path to the folder to delete. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the folder that is being deleted and the path must be the relative path from the parent folder. Parameters: id - The uuid of the folder if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the folder. path - The absolute path to the folder if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. The copyFolder operation is used to copy a folder into a specified folder. This operation can be called by id, path or a combination of id and path. This is true for both the source (i.e. the folder copied) and for the destination folder. If only the srcId is provided, the srcId must be the uuid of the folder to be copied. If only a srcPath is provided, that srcPath must be the absolute path to the folder to be copied. If the srcId and srcPath are both provided, the srcId must be the uuid of a folder that is a parent of the folder to be copied and the srcPath must be the relative path from the parent folder. The same pattern is true for destId and destPath. Parameters: srcId - The uuid of the source folder if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the item. srcPath - The absolute path to the source folder if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. destId - The uuid of the destination folder if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the destination folder. destPath - The absolute path to the destination folder if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. shallowCopy - If true, the copy will only be one level deep. If false, the entire tree under the source node will be copied to the target. The moveFolder operation is used to move a folder. This operation can be called by id, path or a combination of id and path. This is true for both the source and destination parameters. If only the srcId is provided, the srcId must be the uuid of the folder to be moved. If only a srcPath is provided, that srcPath must be the absolute path to the folder to be moved. If the srcId and srcPath are both provided, the srcId must be the uuid of a parent folder of the folder to be moved and the srcPath must be the relative path from the parent folder. The same pattern is true for destId and destPath. NOTE: The destId and destPath should reference the resulting folder and not the parent folder where the source folder is being moved to. In other words, if a folder is being moved, and only the destPath is supplied, this should be the absolute path of the folder after the move is completed. Since the move results in a new folder being created, and thus a new uuid, the user should not attempt to supply only a destId without a destPath. Parameters: srcId - The uuid of the source folder if no path is provided. If both srcId and srcPath are provided, the srcId must be the uuid of the parent folder to the folder that is being moved. srcPath - The absolute path to the source folder if no srcId is provided. If both srcId and srcPath are provided, the path must be the relative path from the srcId provided. destId - The uuid of the detination parent folder. The destId should not be supplied without also providing a destPath. If both destId and destPath are provided, the destId must be the uuid of the destination parent folder destPath - The absolute path to the resulting folder after the move. If both destId and destPath are provided, the path must be the relative path from the id provided. The renameFolder operation will rename the specified folder. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the folder to rename. If only a path is provided, that path must be the absolute path to the folder to rename. If an id and path are both provided, the id must be the uuid of a parent folder to the folder that is being renamed and the path must be the relative path from the parent folder. The newName should contain the name that the folder will be renamed to. Parameters: id - The uuid of the folder if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the folder that is being renamed. path - The absolute path to the folder if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. newName - name that the folder will be renamed to. The getFolderURL operation is used to obtain a URL to a folder. The mode parameter is supplied for future functionality only. The returned URL will be a view URL. The URL can be SSL or just http, which is controlled by the secureURL parameter. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the folder. If only a path is provided, that path must be the absolute path to the folder. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the requested folder and the path must be the relative path from the parent folder. Parameters: id - The uuid of the folder if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the requested folder. path - The absolute path to the folder if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. mode - Ignored for this operation. Only view URLs are supported. secureURL - If true, the returned URL will be prefixed with https. The getPropertySheetType operation returns the requested ClbPropertySheetType in the ClbPropertySheetTypeResponse. Parameters: id - The uuid of the ClbPropertySheetType The getDocumentType operation returns the requested ClbDocumentType in the ClbDocumentTypeResponse. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbDocumentType to retrieve. If only a path is provided, that path must be the absolute path to the ClbDocumentType to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbDocumentType and the path must be the relative path from the parent folder. Parameters: id - The uuid of the ClbDocumentType if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the ClbDocumentType. path - The absolute path to the ClbDocumentType if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. downloadOption - Placeholder for future MTOM attachment support. The getDocumentTypes operation retrieves a list of ClbDocumentType objects that are in a specified folder and returns the doucments in the ClbDocumentTypesResponse. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbLibrary that contains the document types to retrieve. If only a path is provided, that path must be the absolute path to the ClbLibrary that contains the document types to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the target ClbLibrary and the path must be the relative path from the parent folder to the target library. Parameters: libraryId - The uuid of the library if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the library. libraryPath - The absolute path to the library if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. extensionFilter - Results can be filtered by providing an extension. For example, if you want document types for Microsoft Word documents, you would supply a value of "doc". docTypeOption - If null or a value of LibraryScope is supplied, the operation will return document types that are scoped to the supplied library. If a value of All is supplied, you will get both the document types that are scoped to the supplied library and those scoped to the application root library. The getDocumentURL operation is used to obtain a URL to a document. The returned URL can be a download or a view URL, which is controlled by the mode parameter. The URL can also be SSL or just http, which is controlled by the secureURL parameter. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the document. If only a path is provided, that path must be the absolute path to the document. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the document and the path must be the relative path from the parent folder. Parameters: id - The uuid of the document if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the document. path - The absolute path to the document if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. mode - Indicates if the returned URL should bring up a web page to view the document, or if the URL should prompt the user to download the document. secureURL - If true, the returned URL will be prefixed with https. The getView operation retrieves the requested ClbView and returns it in the ClbViewResponse. Parameters: viewId - The uuid of the view to return. The getAllViews operation returns all views in the specified folder/library. Parameters: folderId - The uuid of the folder/library that contains the requested views. The getPrivateViews operation returns the private views in the specified folder/library. Parameters: folderId - The uuid of the folder/library that contains the requested views. The getSharedViews operation returns the shared views in the specified folder/library. Parameters: folderId - The uuid of the folder/library that contains the requested views. The executeView operation takes the specified view uuid, executes that view, and returns the results in the ClbViewResultsResponse. Parameters: viewId - The uuid of the view to execute. serviceOptions - Multiple service options can be provided to control the returned results. The supported values are None, IncludeReferences, IncludePermissions and ResolveLockOwner. The getViewFormat operation takes the specified view uuid and returns the view format in the ClbViewFormatResponse Parameters: viewId - The uuid of the view to get the view format of. Element definitions for the LibraryService The getApplicationRoot operation is used to obtain the default application root library. The ClbLibrary is returned in the ClbLibraryResponse. The getBusinessComponent operation retrieves the requested ClbLibrary and returns it in the ClbLibraryResponse. This operation can be called by id, path or a combination of id and path. If only an id is provided, the id must be the uuid of the ClbLibrary to retrieve. If only a path is provided, that path must be the absolute path to the ClbLibrary to retrieve. If an id and path are both provided, the id must be the uuid of a folder that is a parent to the ClbLibrary and the path must be the relative path from the parent folder. Parameters: id - The uuid of the business component if no path is provided. If both id and path are provided, the id must be the uuid of the parent folder to the business component. path - The absolute path to the business component if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. The getBusinessComponents operation is used to obtain a list of business components. If a list of business components are needed across all libraries, then null can be passed for the libraryId and libraryPath parameters. Otherwise, the returned business components will be scoped under the specified library. Parameters: libraryId - The uuid of the parent library if no path is provided. If both id and path are provided, the id must be the uuid of the parent library of the target library. libraryPath - The absolute path to the parent library if no id is provided. If both id and path are provided, the path must be the relative path from the id provided. categoryTypes - The business components that are returned can be filtered based on category types using this parameter.