TimeBase
The following operations are supported. For a formal definition, please review the Service Description.
-
AttachmentCreate
Create new attachment. -
AttachmentGetBinary
Get attachment file.
SOAP with TimeBase.asmx is not recommended. Recommended method: Reading data from response body of Attachment.ashx (Attachment.ashx?SessionId={SessionId}&AttachmentId={AttachmentId}&Action=Get). -
AttachmentInfoSelect
Select attachment information with paging. -
AttachmentSetBinary
Set attachment file.
SOAP with TimeBase.asmx is not recommended. Recommended method: Writing data as request body to Attachment.ashx (Attachment.ashx?SessionId={SessionId}&AttachmentId={AttachmentId}&Action=Set). -
AttachmentsRemove
Remove attachments (binary) with given identities.
Does not affect references. -
BinaryCreate
Create new binary. -
BinaryGetBinary
Get binary file.
SOAP with TimeBase.asmx is not supported. Recommended method: Reading data from response body of Binary.ashx (Binary.ashx?SessionId={SessionId}&FileName={FileName}&Action=Get). -
BinaryInfoGet
Get binary information with paging. -
BinaryInfoSelect
Select binary information with paging. -
BinaryRemove
Remove binary (binary) with given FileName.
Does not affect references. -
BinarySetBinary
Set binary file.
SOAP with TimeBase.asmx is not supported. Recommended method: Writing data as request body to Binary.ashx (Binary.ashx?SessionId={SessionId}&FileName={FileName}&Action=Set). -
BinaryTypeInfo
Get list of allowed binary types. -
CollationGetByName
Get information about publication with name. -
CollationNameSelect
List all collations. -
ConversionRuleSelectAll
List all conversion rules. -
DocumentFormat
Format newly created document as WebEditor document. -
DocumentGet
Get information about document with given numeric identity.
Recomended: With parameter Extended as false, lock and parent folder information is omitted. -
DocumentGetAttributeValues
Get unique values for given element and attribute underr given position. ElementPath is path to root element as positions separated with vertical bar (|). One level required (just root: '1', root and second child: '1|2'). -
DocumentGetChildElementCount
Get child element count for element specified with ElementPath. ElementPath is path to element as positions separated with vertical bar (|). One level required (just root: '1', root and second child: '1|2'). -
DocumentGetChildElementInfo
Get child element names and InnetText -samples for element specified with ElementPath. ElementPath is path to element as positions separated with vertical bar (|). One level required (just root: '1', root and second child: '1|2').If count is -1, all child counting from startIndex elements are returned. -
DocumentGetElementInfo
Element name and InnetText -sample for element specified with ElementPath. ElementPath is path to element being locked as positions separated with vertical bar (|). One level required (just root: '1', root and second child: '1|2'). -
DocumentGetLock
Get Lock from document in specified ElementPath. ElementPath is path to element being locked as positions separated with vertical bar (|). One level required (just root: '1', root and second child: '1|2'). -
DocumentGetLockCount
Get count of locks in document. -
DocumentGetLocks
Get document locks. -
DocumentGetXml
Get XML for element specified with ElementPath. ElementPath is path to element being locked as positions separated with vertical bar (|). One level required (just root: '1', root and second child: '1|2').
SOAP with TimeBase.asmx is not recommended. Recommended method: Reading XML from response body of Xml.ashx (Xml.ashx?SessionId={SessionId}&DocumentId={DocumentId}&ElementPath={ElementPath}&Action=Get). -
DocumentRemovable
Returns value indicating whether document can be removed (does not have locks). -
DocumentRemove
Remove document. -
DocumentRename
Sets new name for document. -
DocumentSetAsFirstChildOf
Set Document as first child document of Folder. -
DocumentSetAsPreviousSiblingOf
Set Document as previous sibling of Sibling.
Locks and Parents are omitted. -
FolderChildren
List children of folder with given numeric identity. -
FolderCreate
Create new folder. No specified ParentId means root. -
FolderCreateDocument
Create new document to specified Folder.
Locks and Parents are not returned. -
FolderDocuments
List documents contained in folder with given numeric identity.
Recomended: With parameter Extended as false, Locks and Parents are omitted. -
FolderGet
Get information about folder with given numeric identity. -
FolderHierarchy
Get Folder and Document hiearachy. -
FolderRemovable
Returns value indicating whether folder can be removed (does not contain other folders or documents). -
FolderRemove
Remove folder. -
FolderRename
Sets new name for folder. -
FolderRoots
List root folders. -
FolderSetAsFirstChildOf
Set Folder as first child of Parent. No specified Parent means root. -
FolderSetAsPreviousSiblingOf
Set Folder as previous sibling of Sibling. -
GetChapterMetaTypesForDocument
Returns information about allowed chapter-specific metadata for web editor document. -
GetChapterMetaTypesForLock
Returns information about allowed chapter-specific metadata for web editor document. -
GetConfigurations
Return configurations for this TimeBase instance: Legacy method, returns only PublicationTargets xml. -
LockCreate
Create Lock to document. ElementPath is path to element being locked as positions separated with vertical bar (just root: '1', root and second child: '1|2'). Locking whole document, or just root has no difference. -
LockGet
Get information about lock with given numeric identity. -
LockGetAll
Get information about all existing locks. -
LockInsertXmlFragment
Insert xml fragment inside of specified position.
SOAP with TimeBase.asmx is not recommended. Recommended method: Writing XML as request body to Xml.ashx (Xml.ashx?SessionId={SessionId}&LockId={LockId}&ElementPath={ElementPath}&Mode={Mode}&Action=InsertFragment).
Allowed values for Mode: AsFirst, AsLast, ReplaceContent. -
LockModifyXml
Update document xml from specified position.
SOAP with TimeBase.asmx is not recommended. Recommended method: Writing XML as request body to Xml.ashx (Xml.ashx?SessionId={SessionId}&LockId={LockId}&ElementPath={ElementPath}&Action=Set). -
LockRemove
Remove lock. -
LockSelectForSession
Get information about all existing locks.
Recomended: With parameter Extended as false, document information is omitted. -
LogEntryGet
Get log entries from specified timespan. -
LogEntrySeek
Select log entries from specified timespan. -
LogEntrySelect
Select log entries from specified timespan. -
LogUserSelect
List all users. -
PublicationCreate
Create new publication. -
PublicationElementCreate
Add new element from document to to publication. -
PublicationElementModify
Save changes to element (Name and ElementPath) in publication. -
PublicationElementRemovable
Returns value indicating whether element in publication can be removed (no publishing process under way). -
PublicationElementRemove
Remove an element in publication. -
PublicationElementSelect
List elements of publication with given numeric identity. -
PublicationElementSortOrderSwitch
Switch sort order between two elements in publication. -
PublicationExport
Export publication data (to directory on server). -
PublicationGet
Get information about publication with given numeric identity. -
PublicationGetByName
Get information about publication with given name. -
PublicationLogSelect
List targets for publication with given numeric identity. -
PublicationMetaGet
Get metadata string for publication with given numeric identity. -
PublicationMetaSelect
List metadata of publication with given numeric identity. -
PublicationMetaSet
Set metadata string for publication with given numeric identity and string key. -
PublicationModify
Save changes to publication. -
PublicationRemovable
Returns value indicating whether publication can be removed (no publishing process under way). -
PublicationRemove
Remove a publication. -
PublicationSelectAll
List all publications. -
PublicationTargetCreate
Add new target for publication. Available TargetTypes: Http (HTTP POST). -
PublicationTargetModify
Save changes to target (TargetType and TargetUrl) in publication. -
PublicationTargetRemove
Remove target from publication. -
PublicationTargetSelect
List targets for publication with given numeric identity. -
PublishDocumentWebEdit
todo publish document -
PublishPercentage
Return publication progress percent -
SchemaGet
Get XML Schema specified with NamespaceURI. -
SchemaInfoSelect
Select all schema identities. -
SelectConfigurationProperty
Returns public configurations for this TimeBase instance. -
SelectUniqueIds
Select unique ids for set of elements -
SessionEnd
End session with given numeric identity. -
SessionGetLocks
Get document locks for session. -
SessionSelectAll
List all sessions.
Recomended: With parameter Extended as false, user information is omitted. -
SessionStart
Create new session for user with given UserName.
UserInformation is not returned. -
SessionStartExt
Create new session for user with given UserName.
UserInformation is not returned. -
SessionStartWithAuth
Create new session for user with given UserName.
UserInformation is not returned. -
Status
Check system status. Any response beginning with "OK" is valid. -
UserCreate
Create new user. -
UserGet
Get information about user with given numeric identity. -
UserGetGroups
Get users user groups. -
UserGetLocks
Get information about users existing locks. -
UserGetWithUserName
Get information about user with given user name. -
UserGroupAccessMask
List users belonging to user group. -
UserGroupAttachUser
Attach user to user group. -
UserGroupCreate
Create new user group. -
UserGroupDetachUser
Detach user from user group. -
UserGroupGet
Get information about user group with given numeric identity. -
UserGroupGetAll
Get all user groups. -
UserGroupModify
Save changes to user group. -
UserGroupRemovable
Returns value indicating whether user group can be removed (does not contain users). -
UserGroupRemove
Remove user group. -
UserGroupUsers
List users belonging to user group. -
UserMetaGet
Set value to user's metadata. -
UserMetaRemove
Remove entry from user's metadata. -
UserMetaSelectKeys
Select all user's meta keys. -
UserMetaSet
Set value to user's metadata. -
UserModify
Save changes to user. -
UserRemovable
Returns value indicating whether user can be removed (has not done anything yet). -
UserRemove
Remove user. -
UserSelectAll
List all users. -
UserSetPassword
Set password for user.