Kenesto Dependencies API
Kenesto Web API provides the same RESTful API that Kenesto web app and Kenesto Drive uses. You can use it for all the same operations for manipulating folders, documents and tasks. You must first be registered with Kenesto which means you must have an account in Kenesto to use the API.

Contents

Each method gets optional parameter called ud (userData) that returns same value. (To keep context or anything else)

Each method returns response status – ok or failed.

If it failed exception message is also returned.

Base URL: https://app.kenesto.com/Kenesto.Web.API/KDocuments.svc/

1. AddDependencies:

Description:  Add dependencies between two documents – the dependent document (the “from” document, e.g. – assembly file) and the dependency document (the “to” document, e.g. – part file). A dependent document can have many dependencies and vice versa.

Request:

AddDependencies?t={token}&ud={userData}

Http Method: Post

Parameters:

Name Type required Description
token string yes User’s encrypted and encoded session token.
fromDocumentId Guid yes The Id of the Dependent object (e.g. Assembly file).
toDocumentsInfo Object Array yes The object that have dependencies – another object depend on him (e.g. Part file).
ObjectId Guid yes The object Id.
Quantity int yes The quantity of this object.
clientKey Guid no Unique client identifier for the dependency.
userData string no User Data – free text.
Body Example

{

“fromDocumentId”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“toDocumentsInfo”: [{

“ObjectId”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“Quantity”: 1

}, {

“ObjectId”: “1510c4bd-a7bc-4beb-b5ca-0116bd5530fc”,

“Quantity”: 1

}],

“clientKey”: “41a28fe9-808d-4b70-870a-02310d0d38d1”

}

Response:

Type: Json Formatted String

Response Example

{

“ResponseData”: {

“RESULTS”: {

“Object 0”: {

“FROM_VERSION_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“TO_VERSION_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“DEP_QUANTITY”: “1”,

“CLIENT_KEY”: “41a28fe9-808d-4b70-870a-02310d0d38d1”,

“DELETED_OBJECT_FLAG”: “False”,

“DEPENDENCY_STATUS”: “PENDING”,

“IS_SUB_WORKFLOW”: “false”,

“FAMILY_ID”: “100703”,

“FROM_OBJECT_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“FROM_FAMILY_ID”: “100171”,

“TO_OBJECT_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“TO_FAMILY_ID”: “100171”,

“OBJECT_ID”: “567e2ea8-b4c2-44ce-be30-e45a6b5e09d4”,

“MASTER_LINK_ID”: “567e2ea8-b4c2-44ce-be30-e45a6b5e09d4”,

“CREATION_DATE”: “28/02/2017 12:26:35”,

“MODIFICATION_DATE”: “28/02/2017 12:26:35”,

“ORG_USER_ID”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,

“CREATED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,

“MODIFIED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,

“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”

},

“Object 1”: {

“FROM_VERSION_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“TO_VERSION_ID”: “1510c4bd-a7bc-4beb-b5ca-0116bd5530fc”,

“DEP_QUANTITY”: “1”,

“CLIENT_KEY”: “41a28fe9-808d-4b70-870a-02310d0d38d1”,

“DELETED_OBJECT_FLAG”: “False”,

“DEPENDENCY_STATUS”: “PENDING”,

“IS_SUB_WORKFLOW”: “false”,

“FAMILY_ID”: “100703”,

“FROM_OBJECT_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“FROM_FAMILY_ID”: “100171”,

“TO_OBJECT_ID”: “1510c4bd-a7bc-4beb-b5ca-0116bd5530fc”,

“TO_FAMILY_ID”: “100171”,

“OBJECT_ID”: “d6e41013-f49a-4163-ae09-a593528693e2”,

“MASTER_LINK_ID”: “d6e41013-f49a-4163-ae09-a593528693e2”,

“CREATION_DATE”: “28/02/2017 12:26:35”,

“MODIFICATION_DATE”: “28/02/2017 12:26:35”,

“ORG_USER_ID”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,

“CREATED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,

“MODIFIED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,

“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”

}

},

“INFO”: {

“TOTAL_PAGES”: 0

}

},

“ResponseStatus”: “OK”,

“UserData”: “My User Data”

}

2. UpdateDependencies:

Description:  Update existing dependency between two documents – currently, only the quantity parameter can be updated.

Request:

UpdateDependencies?t={token}&ud={userData}

Http Method: Post

Parameters:

Name Type required Description
token string yes User’s encrypted and encoded session token.
dependenciesInfo Object Array yes The object that have dependencies – another object depend on him (e.g. Part file).
ObjectId Guid yes The Id of the dependency that we want to update.
Quantity int yes The updated quantity.
userData string no User Data – free text.
Body Example

{

“toDocumentsInfo”: [{

“ObjectId”: “d6e41013-f49a-4163-ae09-a593528693e2”,

“Quantity”: 3

}, {

“ObjectId”: “567e2ea8-b4c2-44ce-be30-e45a6b5e09d4”,

“Quantity”: 2

}]}

Response:

Type: Json Formatted String

Response Example

{

“ResponseData”: {

“RESULTS”: {

“Object 0”: {

“FROM_VERSION_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“TO_VERSION_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“DEP_QUANTITY”: “1”,

“CLIENT_KEY”: “41a28fe9-808d-4b70-870a-02310d0d38d1”,

“DELETED_OBJECT_FLAG”: “False”,

“DEPENDENCY_STATUS”: “PENDING”,

“IS_SUB_WORKFLOW”: “false”,

“FAMILY_ID”: “100703”,

“FROM_OBJECT_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“FROM_FAMILY_ID”: “100171”,

“TO_OBJECT_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“TO_FAMILY_ID”: “100171”,

“OBJECT_ID”: “567e2ea8-b4c2-44ce-be30-e45a6b5e09d4”,

“MASTER_LINK_ID”: “567e2ea8-b4c2-44ce-be30-e45a6b5e09d4”,

“CREATION_DATE”: “28/02/2017 12:26:35”,

“MODIFICATION_DATE”: “28/02/2017 12:26:35”,

“ORG_USER_ID”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,

“CREATED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,

“MODIFIED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,

“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”

},

“Object 1”: {

“FROM_VERSION_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“TO_VERSION_ID”: “1510c4bd-a7bc-4beb-b5ca-0116bd5530fc”,

“DEP_QUANTITY”: “1”,

“CLIENT_KEY”: “41a28fe9-808d-4b70-870a-02310d0d38d1”,

“DELETED_OBJECT_FLAG”: “False”,

“DEPENDENCY_STATUS”: “PENDING”,

“IS_SUB_WORKFLOW”: “false”,

“FAMILY_ID”: “100703”,

“FROM_OBJECT_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“FROM_FAMILY_ID”: “100171”,

“TO_OBJECT_ID”: “1510c4bd-a7bc-4beb-b5ca-0116bd5530fc”,

“TO_FAMILY_ID”: “100171”,

“OBJECT_ID”: “d6e41013-f49a-4163-ae09-a593528693e2”,

“MASTER_LINK_ID”: “d6e41013-f49a-4163-ae09-a593528693e2”,

“CREATION_DATE”: “28/02/2017 12:26:35”,

“MODIFICATION_DATE”: “28/02/2017 12:26:35”,

“ORG_USER_ID”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,

“CREATED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,

“MODIFIED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”,

“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=New”

}

},

“INFO”: {

“TOTAL_PAGES”: 0

}

},

“ResponseStatus”: “OK”,

“UserData”: “My User Data”

}

3. DeleteDependenciesByIds:

Description:  Delete dependencies between two documents according to the dependencies Ids.

Request:

DeleteDependenciesByIds?t={token}&ud={userData}

Http Method: Post

Parameters:

Name Type required Description
token string yes User’s encrypted and encoded session token.
dependenciesIds Guid Array yes The Ids of the dependencies that we want to delete.
clientKey Guid no Unique client identifier for the dependency.
userData string no User Data – free text.
Body Example

{

“dependenciesIds”: [

“d6e41013-f49a-4163-ae09-a593528693e2”,

“567e2ea8-b4c2-44ce-be30-e45a6b5e09d4”

],

“clientKey”: “41a28fe9-808d-4b70-870a-02310d0d38d1”

}

Response:

Type: Json Formatted String

Response Example

{

“ResponseStatus”: “OK”,

“UserData”: “My User Data”

}

4. DeleteDependencies:

Description:  Delete dependencies between two documents according to the “from” and “to” documents Ids.

Request:

DeleteDependencies?t={token}&ud={userData}

Http Method: Post

Parameters:

Name Type required Description
token string yes User’s encrypted and encoded session token.
fromDocumentId Guid yes The Id of the Dependent object (e.g. Assembly file).
toDocumentsIds Guid Array yes The Ids of the objects that have dependencies – another object depend on them (e.g. Part file).
clientKey Guid no Unique client identifier for the dependency.
userData string no User Data – free text.
Body Example

{

“fromDocumentId”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“toDocumentsIds”: [

“ffcf2951-5dd7-49e3-84a9-a82099558096”,

“1510c4bd-a7bc-4beb-b5ca-0116bd5530fc”

],

“clientKey”: “41a28fe9-808d-4b70-870a-02310d0d38d1”

}

Response:

Type: Json Formatted String

Response Example

{

“ResponseStatus”: “OK”,

“UserData”: “My User Data”

}

5. GetDependencies:

Description:  Get the dependencies of a document.

Request:

GetDependencies?t={token}&id={rootDocumentId}&level={level}&root={isIncludeRootDocument}&ud={userData}

Http Method: Get

Parameters:

Name Type required Description
token string yes User’s encrypted and encoded session token.
rootDocumentId Guid yes The Id of the Document which we want its dependencies.
level int no In how many folders levels to look for dependencies. If null – all levels. Default is null
isIncludeRootDocument bool no Whether to include the root document in the response.
userData string no User Data – free text.

Response:

Type: Json Formatted String

Response Example

{

“ResponseData”: {

“RESULTS”: {

“Object 0”: {

“GENERAL”: {

“TENANT_ID”: “3”,

“ASSET_TITLE”: “part1”,

“ASSET_DESCRIPTION”: “”,

“ASSET_NAME”: “part1”,

“ASSET_KEYWORDS”: “”,

“IS_ASSET_VIEW_ONLY”: “False”,

“ASSET_STATE”: “DOC_PRELIMINARY”,

“ATTACHED_TO_FOLDER”: “True”,

“ATTACHED_FOLDER_ID”: “73b29225-7df3-4f7e-9334-f478e73cdb61”,

“IS_ASSET_FROZEN”: “False”,

“HAS_THUMBNAIL”: “False”,

“STORAGE_MODIFICATION_DATE”: “28/02/2017 11:38:01”,

“LATEST_REVISION_ID”: “00000000-0000-0000-0000-000000000000”,

“FAMILY_ID”: “100171”,

“OBJECT_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“CREATED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“CREATION_DATE”: “28/02/2017 11:38:02”,

“DELETED_OBJECT_FLAG”: “False”,

“DESCRIPTION”: “”,

“IS_IMPORTED”: “True”,

“MODIFICATION_DATE”: “28/02/2017 12:26:35”,

“MODIFIED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“ORG_USER_ID”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“IS_SYSTEM”: “False”,

“DELETED_CTX_ID”: “00000000-0000-0000-0000-000000000000”,

“FILE_SIZE”: “51”,

“FILE_EXTENSION”: “.txt”,

“FILE_NAME”: “part1.txt”,

“CONTENT_TYPE”: “application/octet-stream”,

“FILE_PATH”: “Customer Data/3/Files/ffcf2951-5dd7-49e3-84a9-a82099558096”,

“IS_PENDING”: “False”,

“PATH_TYPE”: “INTERNAL”,

“EXTERNAL_LINK”: “”,

“STORAGE_TYPE”: “AWS”,

“UPLOAD_PHASE”: “NONE”,

“EXTERNAL_LINK_TYPE”: “REGULAR”,

“CURRENT_VERSION_SIZE”: “51”,

“IS_REPLICATION”: “False”,

“REPLICATION_ID”: “00000000-0000-0000-0000-000000000000”,

“REPLICATING_ORG_ID”: “00000000-0000-0000-0000-000000000000”,

“REPLICATING_ORG_NAME”: “”,

“REPLICATION_INFO”: “”,

“SHARED_OBJECT_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“IS_DRAFT”: “False”,

“PUBLIC_ACCESS”: “False”,

“IS_EXT”: “False”,

“EXT_TOKEN”: “”,

“EXT_ORG_NAME”: “”,

“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,

“IS_SHARED”: “False”,

“HAS_DEPENDENCIES”: “True”,

“DROPBOX_BYTES”: “0”,

“DROPBOX_ICON”: “”,

“IS_BASE_VERSION”: “True”,

“IS_CURRENT_MANUAL”: “False”,

“BASE_VERSION_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“CURRENT_VERSION_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“LATEST_VERSION_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“VERSION_NUMBER”: “1”,

“CURRENT_VERSION_NUMBER”: “1”,

“LATEST_VERSION_NUMBER”: “1”,

“CURRENT_VERSION_EXT”: “.txt”,

“LATEST_VERSION_EXT”: “.txt”,

“CHECKED_OUT_BY”: “”,

“IN_WORK”: “False”,

“IN_WORK_BY”: “”,

“IN_WORK_PING”: “01/01/0001 00:00:00”,

“IS_DIRTY”: “False”,

“IS_REV_DIRTY”: “True”,

“TENANT_ID1”: “3”,

“REFERENCE_LINK_ID”: “567e2ea8-b4c2-44ce-be30-e45a6b5e09d4”,

“FAMILY_ID1”: “100171”,

“OBJECT_ID1”: “System.Byte[]”,

“DEP_QUANTITY”: “1”,

“LEVEL”: “1”,

“IS_LEAF”: “1”,

“USER_OBJECT_ID”: “System.Byte[]”,

“TENANT_ID2”: “3”,

“OBJECT_ID2”: “System.Byte[]”,

“FAMILY_ID2”: “100171”,

“PATH”: “EampleFolder\\”,

“ACCESSIBLE”: “True”

}

},

“Object 1”: {

“GENERAL”: {

“TENANT_ID”: “3”,

“ASSET_TITLE”: “part1 – Copy”,

“ASSET_DESCRIPTION”: “”,

“ASSET_NAME”: “part2”,

“ASSET_KEYWORDS”: “”,

“IS_ASSET_VIEW_ONLY”: “False”,

“ASSET_STATE”: “DOC_PRELIMINARY”,

“ATTACHED_TO_FOLDER”: “True”,

“ATTACHED_FOLDER_ID”: “73b29225-7df3-4f7e-9334-f478e73cdb61”,

“IS_ASSET_FROZEN”: “False”,

“HAS_THUMBNAIL”: “False”,

“STORAGE_MODIFICATION_DATE”: “28/02/2017 11:38:24”,

“LATEST_REVISION_ID”: “00000000-0000-0000-0000-000000000000”,

“FAMILY_ID”: “100171”,

“OBJECT_ID”: “1510c4bd-a7bc-4beb-b5ca-0116bd5530fc”,

“CREATED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“CREATION_DATE”: “28/02/2017 11:38:13”,

“DELETED_OBJECT_FLAG”: “False”,

“DESCRIPTION”: “”,

“IS_IMPORTED”: “True”,

“MODIFICATION_DATE”: “28/02/2017 12:26:35”,

“MODIFIED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“ORG_USER_ID”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“IS_SYSTEM”: “False”,

“DELETED_CTX_ID”: “00000000-0000-0000-0000-000000000000”,

“FILE_SIZE”: “51”,

“FILE_EXTENSION”: “.txt”,

“FILE_NAME”: “part1 – Copy.txt”,

“CONTENT_TYPE”: “application/octet-stream”,

“FILE_PATH”: “Customer Data/3/Files/1510c4bd-a7bc-4beb-b5ca-0116bd5530fc”,

“IS_PENDING”: “False”,

“PATH_TYPE”: “INTERNAL”,

“EXTERNAL_LINK”: “”,

“STORAGE_TYPE”: “AWS”,

“UPLOAD_PHASE”: “NONE”,

“EXTERNAL_LINK_TYPE”: “REGULAR”,

“CURRENT_VERSION_SIZE”: “51”,

“IS_REPLICATION”: “False”,

“REPLICATION_ID”: “00000000-0000-0000-0000-000000000000”,

“REPLICATING_ORG_ID”: “00000000-0000-0000-0000-000000000000”,

“REPLICATING_ORG_NAME”: “”,

“REPLICATION_INFO”: “”,

“SHARED_OBJECT_ID”: “1510c4bd-a7bc-4beb-b5ca-0116bd5530fc”,

“IS_DRAFT”: “False”,

“PUBLIC_ACCESS”: “False”,

“IS_EXT”: “False”,

“EXT_TOKEN”: “”,

“EXT_ORG_NAME”: “”,

“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,

“IS_SHARED”: “False”,

“HAS_DEPENDENCIES”: “True”,

“DROPBOX_BYTES”: “0”,

“DROPBOX_ICON”: “”,

“IS_BASE_VERSION”: “True”,

“IS_CURRENT_MANUAL”: “False”,

“BASE_VERSION_ID”: “1510c4bd-a7bc-4beb-b5ca-0116bd5530fc”,

“CURRENT_VERSION_ID”: “1510c4bd-a7bc-4beb-b5ca-0116bd5530fc”,

“LATEST_VERSION_ID”: “1510c4bd-a7bc-4beb-b5ca-0116bd5530fc”,

“VERSION_NUMBER”: “1”,

“CURRENT_VERSION_NUMBER”: “1”,

“LATEST_VERSION_NUMBER”: “1”,

“CURRENT_VERSION_EXT”: “.txt”,

“LATEST_VERSION_EXT”: “.txt”,

“CHECKED_OUT_BY”: “”,

“IN_WORK”: “False”,

“IN_WORK_BY”: “”,

“IN_WORK_PING”: “01/01/0001 00:00:00”,

“IS_DIRTY”: “False”,

“IS_REV_DIRTY”: “True”,

“TENANT_ID1”: “3”,

“REFERENCE_LINK_ID”: “d6e41013-f49a-4163-ae09-a593528693e2”,

“FAMILY_ID1”: “100171”,

“OBJECT_ID1”: “System.Byte[]”,

“DEP_QUANTITY”: “1”,

“LEVEL”: “1”,

“IS_LEAF”: “1”,

“USER_OBJECT_ID”: “System.Byte[]”,

“TENANT_ID2”: “3”,

“OBJECT_ID2”: “System.Byte[]”,

“FAMILY_ID2”: “100171”,

“PATH”: “EampleFolder\\”,

“ACCESSIBLE”: “True”

}

},

“Object 2”: {

“GENERAL”: {

“TENANT_ID”: “3”,

“FAMILY_ID”: “100171”,

“OBJECT_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“CREATED_BY”: “PersistentBusinessObject ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“CREATION_DATE”: “28/02/2017 11:37:46”,

“IS_IMPORTED”: “True”,

“MODIFICATION_DATE”: “28/02/2017 12:26:36”,

“MODIFIED_BY”: “PersistentBusinessObject ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“OWNER”: “PersistentBusinessObject ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“SHARED_OBJECT_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“FILE_SIZE”: “65”,

“FILE_EXTENSION”: “.txt”,

“FILE_NAME”: “AsmFile.txt”,

“CONTENT_TYPE”: “application/octet-stream”,

“FILE_PATH”: “Customer Data/3/Files/7e8f3225-379b-49b3-a60b-299972bd4b55”,

“IS_PENDING”: “False”,

“PATH_TYPE”: “INTERNAL”,

“EXTERNAL_LINK”: “”,

“STORAGE_TYPE”: “AWS”,

“UPLOAD_PHASE”: “NONE”,

“EXTERNAL_LINK_TYPE”: “REGULAR”,

“CURRENT_VERSION_SIZE”: “65”,

“IS_DRAFT”: “False”,

“PUBLIC_ACCESS”: “False”,

“IS_EXT”: “False”,

“EXT_TOKEN”: “”,

“EXT_ORG_NAME”: “”,

“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,

“IS_SHARED”: “False”,

“IS_BASE_VERSION”: “True”,

“IS_CURRENT_MANUAL”: “False”,

“BASE_VERSION_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“CURRENT_VERSION_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“LATEST_VERSION_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“VERSION_NUMBER”: “1”,

“CURRENT_VERSION_NUMBER”: “1”,

“LATEST_VERSION_NUMBER”: “1”,

“CURRENT_VERSION_EXT”: “.txt”,

“LATEST_VERSION_EXT”: “.txt”,

“CHECKED_OUT_BY”: “”,

“IN_WORK”: “False”,

“IN_WORK_BY”: “”,

“DROPBOX_BYTES”: “0”,

“DROPBOX_ICON”: “”,

“IS_REV_DIRTY”: “True”,

“HAS_DEPENDENCIES”: “False”,

“ASSET_TITLE”: “AsmFile”,

“ASSET_DESCRIPTION”: “”,

“ASSET_NAME”: “AsmFile”,

“ASSET_KEYWORDS”: “”,

“IS_ASSET_VIEW_ONLY”: “False”,

“ASSET_STATE”: “DOC_PRELIMINARY”,

“ATTACHED_TO_FOLDER”: “True”,

“ATTACHED_FOLDER_ID”: “73b29225-7df3-4f7e-9334-f478e73cdb61”,

“IS_ASSET_FROZEN”: “False”,

“HAS_THUMBNAIL”: “False”,

“LATEST_REVISION_ID”: “00000000-0000-0000-0000-000000000000”,

“ACCESSIBLE”: “True”

}

}

},

“INFO”: {

“TOTAL_PAGES”: 0

}

},

“ResponseStatus”: “OK”,

“UserData”: “My User Data”

}

6. GetDependents:

Description:  Get the dependents of a document.

Request:

GetDependents?t={token}&id={rootDocumentId}&level={level}&root={isIncludeRootDocument}&ud={userData}

Http Method: Get

Parameters:

Name Type required Description
token string yes User’s encrypted and encoded session token.
rootDocumentId Guid yes The Id of the Document which we want its dependents.
level int no In how many folders levels to look for dependents. If null – all levels. Default is null
isIncludeRootDocument bool no Whether to include the root document in the response.
userData string no User Data – free text.

Response:

Type: Json Formatted String

Response Example

{

“ResponseData”: {

“RESULTS”: {

“Object 0”: {

“GENERAL”: {

“TENANT_ID”: “3”,

“ASSET_TITLE”: “AsmFile”,

“ASSET_DESCRIPTION”: “”,

“ASSET_NAME”: “AsmFile”,

“ASSET_KEYWORDS”: “”,

“IS_ASSET_VIEW_ONLY”: “False”,

“ASSET_STATE”: “DOC_PRELIMINARY”,

“ATTACHED_TO_FOLDER”: “True”,

“ATTACHED_FOLDER_ID”: “73b29225-7df3-4f7e-9334-f478e73cdb61”,

“IS_ASSET_FROZEN”: “False”,

“HAS_THUMBNAIL”: “False”,

“STORAGE_MODIFICATION_DATE”: “28/02/2017 11:37:44”,

“LATEST_REVISION_ID”: “00000000-0000-0000-0000-000000000000”,

“FAMILY_ID”: “100171”,

“OBJECT_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“CREATED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“CREATION_DATE”: “28/02/2017 11:37:46”,

“DELETED_OBJECT_FLAG”: “False”,

“DESCRIPTION”: “”,

“IS_IMPORTED”: “True”,

“MODIFICATION_DATE”: “28/02/2017 12:26:36”,

“MODIFIED_BY”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“ORG_USER_ID”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“OWNER”: “ParticipantUserNtt ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“IS_SYSTEM”: “False”,

“DELETED_CTX_ID”: “00000000-0000-0000-0000-000000000000”,

“FILE_SIZE”: “65”,

“FILE_EXTENSION”: “.txt”,

“FILE_NAME”: “AsmFile.txt”,

“CONTENT_TYPE”: “application/octet-stream”,

“FILE_PATH”: “Customer Data/3/Files/7e8f3225-379b-49b3-a60b-299972bd4b55”,

“IS_PENDING”: “False”,

“PATH_TYPE”: “INTERNAL”,

“EXTERNAL_LINK”: “”,

“STORAGE_TYPE”: “AWS”,

“UPLOAD_PHASE”: “NONE”,

“EXTERNAL_LINK_TYPE”: “REGULAR”,

“CURRENT_VERSION_SIZE”: “65”,

“IS_REPLICATION”: “False”,

“REPLICATION_ID”: “00000000-0000-0000-0000-000000000000”,

“REPLICATING_ORG_ID”: “00000000-0000-0000-0000-000000000000”,

“REPLICATING_ORG_NAME”: “”,

“REPLICATION_INFO”: “”,

“SHARED_OBJECT_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“IS_DRAFT”: “False”,

“PUBLIC_ACCESS”: “False”,

“IS_EXT”: “False”,

“EXT_TOKEN”: “”,

“EXT_ORG_NAME”: “”,

“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,

“IS_SHARED”: “False”,

“HAS_DEPENDENCIES”: “False”,

“DROPBOX_BYTES”: “0”,

“DROPBOX_ICON”: “”,

“IS_BASE_VERSION”: “True”,

“IS_CURRENT_MANUAL”: “False”,

“BASE_VERSION_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“CURRENT_VERSION_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“LATEST_VERSION_ID”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“VERSION_NUMBER”: “1”,

“CURRENT_VERSION_NUMBER”: “1”,

“LATEST_VERSION_NUMBER”: “1”,

“CURRENT_VERSION_EXT”: “.txt”,

“LATEST_VERSION_EXT”: “.txt”,

“CHECKED_OUT_BY”: “”,

“IN_WORK”: “False”,

“IN_WORK_BY”: “”,

“IN_WORK_PING”: “01/01/0001 00:00:00”,

“IS_DIRTY”: “True”,

“IS_REV_DIRTY”: “True”,

“TENANT_ID1”: “3”,

“REFERENCE_LINK_ID”: “567e2ea8-b4c2-44ce-be30-e45a6b5e09d4”,

“FAMILY_ID1”: “100171”,

“OBJECT_ID1”: “System.Byte[]”,

“DEP_QUANTITY”: “1”,

“LEVEL”: “1”,

“IS_LEAF”: “1”,

“TENANT_ID2”: “3”,

“OBJECT_ID2”: “System.Byte[]”,

“FAMILY_ID2”: “100171”,

“PATH”: “EampleFolder\\”,

“ACCESSIBLE”: “True”

}

},

“Object 1”: {

“GENERAL”: {

“TENANT_ID”: “3”,

“FAMILY_ID”: “100171”,

“OBJECT_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“CREATED_BY”: “PersistentBusinessObject ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“CREATION_DATE”: “28/02/2017 11:38:02”,

“IS_IMPORTED”: “True”,

“MODIFICATION_DATE”: “28/02/2017 12:26:35”,

“MODIFIED_BY”: “PersistentBusinessObject ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“OWNER”: “PersistentBusinessObject ID=be3a3293-bc0a-a046-bbcd-704bfb068a2f, FamilyCode=PARTICIPANT_USER, Status=Retrieved”,

“SHARED_OBJECT_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“FILE_SIZE”: “51”,

“FILE_EXTENSION”: “.txt”,

“FILE_NAME”: “part1.txt”,

“CONTENT_TYPE”: “application/octet-stream”,

“FILE_PATH”: “Customer Data/3/Files/ffcf2951-5dd7-49e3-84a9-a82099558096”,

“IS_PENDING”: “False”,

“PATH_TYPE”: “INTERNAL”,

“EXTERNAL_LINK”: “”,

“STORAGE_TYPE”: “AWS”,

“UPLOAD_PHASE”: “NONE”,

“EXTERNAL_LINK_TYPE”: “REGULAR”,

“CURRENT_VERSION_SIZE”: “51”,

“IS_DRAFT”: “False”,

“PUBLIC_ACCESS”: “False”,

“IS_EXT”: “False”,

“EXT_TOKEN”: “”,

“EXT_ORG_NAME”: “”,

“EXT_ORG_ID”: “00000000-0000-0000-0000-000000000000”,

“IS_SHARED”: “False”,

“IS_BASE_VERSION”: “True”,

“IS_CURRENT_MANUAL”: “False”,

“BASE_VERSION_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“CURRENT_VERSION_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“LATEST_VERSION_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“VERSION_NUMBER”: “1”,

“CURRENT_VERSION_NUMBER”: “1”,

“LATEST_VERSION_NUMBER”: “1”,

“CURRENT_VERSION_EXT”: “.txt”,

“LATEST_VERSION_EXT”: “.txt”,

“CHECKED_OUT_BY”: “”,

“IN_WORK”: “False”,

“IN_WORK_BY”: “”,

“DROPBOX_BYTES”: “0”,

“DROPBOX_ICON”: “”,

“IS_REV_DIRTY”: “True”,

“HAS_DEPENDENCIES”: “True”,

“ASSET_TITLE”: “part1”,

“ASSET_DESCRIPTION”: “”,

“ASSET_NAME”: “part1”,

“ASSET_KEYWORDS”: “”,

“IS_ASSET_VIEW_ONLY”: “False”,

“ASSET_STATE”: “DOC_PRELIMINARY”,

“ATTACHED_TO_FOLDER”: “True”,

“ATTACHED_FOLDER_ID”: “73b29225-7df3-4f7e-9334-f478e73cdb61”,

“IS_ASSET_FROZEN”: “False”,

“HAS_THUMBNAIL”: “False”,

“LATEST_REVISION_ID”: “00000000-0000-0000-0000-000000000000”,

“ACCESSIBLE”: “True”

}

}

},

“INFO”: {

“TOTAL_PAGES”: 0

}

},

“ResponseStatus”: “OK”,

“UserData”: “My User Data”

}

7. GetIndependentDocuments:

Description:  Get the independent documents under a requested folder.

Request:

GetIndependentDocuments?t={token}&fid={folderId}&ext={fileExtension}&level={level}&ud={userData}

Http Method: Get

Parameters:

Name Type required Description
token string yes User’s encrypted and encoded session token.
folderId Guid yes The root folder to start the search.
fileExtension string no Can filter the search by file extension.
level int no In how many folders levels to look for documents. If null – all levels. Default is null
userData string no User Data – free text.

Response:

Type: Json Formatted String

Response Example

{

“ResponseData”: {

“RESULTS”: {

“Object 0”: {

“GENERAL”: {

“TENANT_ID”: “3”,

“OBJECT_ID”: “ffcf2951-5dd7-49e3-84a9-a82099558096”,

“FAMILY_ID”: “100171”,

“FILE_EXTENSION”: “.txt”

}

},

“Object 1”: {

“GENERAL”: {

“TENANT_ID”: “3”,

“OBJECT_ID”: “1510c4bd-a7bc-4beb-b5ca-0116bd5530fc”,

“FAMILY_ID”: “100171”,

“FILE_EXTENSION”: “.txt”

}

},

“Object 2”: {

“GENERAL”: {

“TENANT_ID”: “3”,

“OBJECT_ID”: “00ad8567-ea29-4842-a45a-648a0881b226”,

“FAMILY_ID”: “100171”,

“FILE_EXTENSION”: “.txt”

}

}

},

“INFO”: {

“TOTAL_PAGES”: 0

}

},

“ResponseStatus”: “OK”,

“UserData”: “My User Data”

}

8. AddSaveAsHistoryEvent:

Description:  Adds a “Save As” event to a document history log.

Request:

AddSaveAsHistoryEvent?t={token}&ud={userData}

Http Method: Post

Parameters:

Name Type required Description
token string yes User’s encrypted and encoded session token.
objectId Guid yes The Id of the document which is being saved.
saveAsName string yes The name in which the document was saved.
saveAsPath string yes The path in which the document was saved.
userData string no User Data – free text.
Body Example

{

“objectId”: “7e8f3225-379b-49b3-a60b-299972bd4b55”,

“saveAsName”: “newname.txt”,

“saveAsPath”: “Robot Co\\NewFolder\\”

}

Response:

Type: Json Formatted String

Response Example

{

“ResponseStatus”: “OK”,

“UserData”: “My User Data”

}

Need more help with Kenesto?

Contact Support

  • This field is for validation purposes and should be left unchanged.