Web service kt document detail

From KnowledgeTree Document Management Made Simple

Jump to: navigation, search

The kt_document_detail record has the following structure:

Field Type Description
status_code int The status of the request. This should be 0 for a successful request.
message string In case of an error, this will be populated with a reason.
document_id int The KnowledgeTree document reference for the document.
custom_document_no string * reserved *
oem_document_no string A custom document number that may be associated with a document by system integrators.
title string Title of the document. Note this is different to the filename.
document_type string Document type of the document.
full_path string The full path of the document, excluding the root folder name.
filename string The filename of the document. Note this is different to the title.
filesize int The filesize of the document.
folder_id int The internal folder id.
created_by string The full name of the user that created the document.
created_date string the date when the document was created.
checked_out_by string The full name of the user that checked out the document.
checked_out_date string The date when the document was checked out.
modified_by string The full name of the user that modified the document.
modified_date string The date when the document was modified.
owned_by string The full name of the user that owns the document.
version float The version of the document. This is a float because of the major/minor versioning mechanism that KnowledgeTree implements.
is_immutable boolean Indicates if any modifications can be done to the document.
permissions string * reserved *
workflow string The name of the workflow the document is associated with.
workflow_state string If the state of the document in the assigned workflow.
mime_type string The document mime type.
mime_icon_path string Indicative of the display icon to be associated with the document.
mime_display string A friendly name to display for the mime type.
storage_path string The storage location.
metadata kt_metadata_fieldsets Only available if 'M' is included in the detail string of the get_document_detail_xxx functions
links kt_linked_documents Only available if 'L' is included in the detail string of the get_document_detail_xxx functions
transitions kt_workflow_transitions Only available if 'T' is included in the detail string of the get_document_detail_xxx functions
version_history kt_document_version_history Only available if 'V' is included in the detail string of the get_document_detail_xxx functions
transaction_history kt_document_transaction_history Only available if 'H' is included in the detail string of the get_document_detail_xxx functions
Personal tools