SOAP Webservice Type Definitions

The following core types are defined by the webservice. Please note, this only covers the commonly used types and is not a comprehesive list.

Permissions

The permissions assigned to a document or folder are represented by a string of letters: RWASDNE.

R: READ
W: WRITE
A: Add Folder (folder specific)
S: Manage Security (folder specific)
D: Delete
N: Rename Folder (folder specific)
E: Edit (document specific) - available if the document has been checked out by the current (webservice) user.

kt_response

Field Type Description
status_codeintDetermines if the request has been successful. 0 for success.
messagestringContains an error message if the request is not successful. If successful, contents depend on the request.

kt_folder_detail

Field Type Description
status_codeintDetermines if the request has been successful. 0 for success.
messagestringContains an error message if the request is not successful.
idintID of the requested folder.
folder_namestringName of the requested folder.
parent_idintID of the parent folder.
full_pathstringFolder path to the folder.
permissionsstringPermissions string
created_bystringName of the user who created the folder.
linked_folder_idintIf this is a shortcut, the ID of the target folder.
clean_uristringURL to the folder.
parent_folder_idsstringComma separated list of the parent folder IDs
creator_idintID of the user who created the folder
created_datestringDate the folder was created.
modified_bystringName of the user who last updated the folder.
modified_user_idintID of the user who last updated the folder.
modified_datestringDate the folder was last updated.
owned_bystringName of the owner.
owner_idintID of the owner of the folder.

kt_folder_item

The folder item describes both folders and documents and some of the fields will only be relevant to one or the other. In these cases a “n/a” will be sent if the field is not applicable to the item.

Field Type Description
idintID of the requested folder.
item_typestringIndicates a folder: F, document: D or shortcut: S.
titlestringName of the item (folder name or document title)
filenamestringThe document filename.
filesizestringThe size of the document file in bytes.
document_typestringThe assigned Document Type.
created_bystringThe person who created the document or folder.
created_datestringDate the item was created.
checked_out_bystringIf checked out, the person who checked out the document.
checked_out_datestringIf checked out, the date the document was checked out.
modified_bystringThe person who last modified the item.
modified_datestringThe date the item was last modified.
owned_bystringThe owner of the document.
versionstringThe version of the document.
is_immutablestringIndicates if the document has been finalized.
permissionsstringPermissions string
workflowstringIf in a workflow, the name of the workflow.
workflow_statestringIf in a workflow, the current state of the workflow.
mime_typestringThe mime type. For a folder this will be “folder”.
mime_icon_pathstring
mime_displaystringThe display name for the mime type.
full_pathstringThe folder path to the item.
storage_pathstringThe path under which the file has been stored. For internal use only.
folder_namestringThe name of the folder
parent_idintThe ID of the containing or parent folder.
linked_folder_idintIf folder is a shortcut, the ID of the target folder
clean_uristringThe URI of the item.
creator_idintThe ID of the user who created the item.
created_by_user_namestringThe username (usually an email address) of the creator.
modified_user_idintThe ID of the user who last updated the item.
modified_by_user_namestringThe username of the user who last updated the item.
checked_out_by_user_namestringIf checked out, the username of the user who checked out the document.
owner_idintThe ID of the owner of the document.
owned_by_user_namestringThe username of the owner of the document.
has_renditionstringIndicates whether the document has an associated PDF rendition.
object_typestringIndicates the type of document: normal, remote, webpage, web document
custom_document_nostringDeprecated
oem_document_nostringDeprecated
itemskt_folder_itemsIf a folder, the list of contained items.

kt_folder_items

An array of kt_folder_item.

kt_folder_contents

Field Type Description
status_codeIntDetermines if the request has been successful. 0 for success.
messageStringContains an error message if the request is not successful.
folder_idIntID of the folder.
folder_nameStringName of the folder.
full_pathStringThe folder path of the folder.
itemskt_folder_itemsThe list of contained items

kt_document_detail

Field Type Description
status_codeintDetermines if the request has been successful. 0 for success.
messagestringContains an error message if the request is not successful.
document_idintThe ID of the document.
titlestringThe title of the document
document_typestringThe assigned Document Type.
full_pathstring
filenamestringThe document filename.
filesizeintThe size of the document file in bytes.
folder_idintThe ID of the folder the document is contained within.
created_bystringThe person who created the document
created_datestringDate the item was created.
checked_out_bystringIf checked out, the person who checked out the document.
checked_out_datestringIf checked out, the date the document was checked out.
modified_bystringThe person who last modified the item.
modified_datestringThe date the item was last modified.
owned_bystringThe owner of the document.
versionfloatThe version of the document.
is_immutablebooleanIndicates if the document has been finalized.
permissionsstringPermissions string
workflowstringIf in a workflow, the name of the workflow.
workflow_statestringIf in a workflow, the current state of the workflow.
mime_typestringThe mime type.
mime_icon_pathstring
mime_displaystringThe display name for the mime type.
storage_pathstringThe path under which the file has been stored. For internal use only.
metadatakt_metadata_fieldsets
linkskt_linked_documents
transitionskt_workflow_transitions
version_historykt_document_version_history
transaction_historykt_document_transaction_history
document_type_idintThe ID of the Document Type.
linked_document_idintIf document is a shortcut, the ID of the target document
clean_uristringThe URI of the item.
checked_in_datestring
document_statusstring
created_by_user_namestringThe username (usually an email address) of the creator.
modified_by_user_namestringThe username of the user who last updated the item.
checked_out_by_user_namestringIf checked out, the username of the user who checked out the document.
owned_by_user_namestringThe username of the owner of the document.
created_by_user_idintThe ID of the user who created the item.
modified_by_user_idintThe ID of the user who last updated the item.
owned_by_user_idintThe ID of the owner of the document.
content_idint
extensionstring
hashstring
custom_document_nostringDeprecated.
oem_document_nostringDeprecated