Skip to content

Documentum Connector Reference

The following operations allow you to work with the Documentum Connector. Find an operation name to see parameter details and samples on how to use it.

Create Folder

The Create Folder operation enables you to create a new folder in Documentum.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
objectcodeID The Documentum Object Code ID for the parent folder. For example, "0c0277b68002952c" Yes.
foldername The Folder name to be given which is user Specific. For example, “Sample123” Yes.

Sample request

{
    "repos":"doctest",
    "objectcodeID":"0c0277b68002952c",
    "foldername":" Sample123"
}
Find Folder

The Find Folder operation is used to find the folder.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
folderObjectID The Folder object ID of the Documentum to find. For example, “0b0277b680048998” Yes.

Sample request

{
    "repos":"doctest",
    "folderObjectID":"0b0277b680048998"
}
Delete Folder

The Delete Folder operation is used to delete the folder.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
folderObjectID The Folder object ID of the documentum to be deleted. For example, “0b0277b680048998” Yes.

Sample request

{
    "repos":"doctest",
    "folderObjectID":"0b0277b680048998"
}
Create Document

The Create Document operation enables you to create a new document in Documentum.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
FolderID The Documentum object ID of the folder where the document has to be created. For example, "0b0277b68004e7de" Yes.
object_name The name of the document which is user specific. For example, “TestDoc1” Yes.
a_content_type The content type of the document(pdf,gif,csv,png,etc.). For example, "pdf" Yes.

Sample request

{
    "repos":"doctest",
    "folderID":"0b0277b68004e7de",
    "object_name":"TestingJul24",
    "a_content_type":"pdf"
}
Find Document

The Find Document operation enables you to find an existing document in Documentum.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
FolderID The documentum object ID of the document to find . For example, "0b0277b68004e7de" Yes.

Sample request

{
    "repos":"doctest",
    "folderID":"0b0277b68004e7de",
}
Delete Document

The Delete Document operation enables you to delete an existing document in Documentum.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
FolderID The documentum object ID of the document to be deleted. For example, "0b0277b68004e7de" Yes.

Sample request

{
    "repos":"doctest",
    "folderID":"0b0277b68004e7de",
}
Add Content to Document

The Add Content to Document operation enables you to add some content into a document in Documentum.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
objectID The documentum Object ID of the document where the content to be added. For example, "090277b68002952c" Yes.
format The format of the present document(pdf,gif,png,csv,etc..). For example, "pdf". Yes.
overwrite Whether to Overwrite the content in the document. For example, "true" or "false". Yes.

Sample request

Click the form data in Postman and enter the key value as indicated below and attach the file to be uploaded.

Key Value
request File file123.pdf

Create Content Full Document

The Create Content Full Document operation is used to create a document with content in Documentum.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
objectID The documentum Folder Object ID where the document to be created. For example, "090277b68002952c" Yes.
format The format of the document(png,gif,pdf,csv,etc..). For example, "pdf". Yes.
count The no of the documents added to the content. For example, "1" or "2". Yes.
primary To make all data as primary content of the document. For example, "true" or "false". Yes.

Sample request

Click the form data in Postman and enter the key value as indicated below and attach the file to be uploaded.

Key Value
objects Text {"properties”: {"r_object_type":"dm_document","object_name": "TestDoc"}}
content1 File document.pdf

Get Document Content

The Get Document Content operation is used to get content from the document.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
documentObjectID The documentum object ID of the document to get content. For example, "090277b6800600a3" Yes.

Sample request

{
    "repos":"doctest",
    "documentObjectID":"090277b6800600a3"
}
Create Cabinet

The Create Cabinet operation is used to create the cabinet.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
object_name The name of the cabinet to be created which is user specific. For example, "TestCabinet6" Yes.

Sample request

{
    "repos":"doctest",
    "object_name":"TestCabinet6"
}
Find Cabinet

The Find Cabinet operation is used to find the cabinet.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
cabinateObjectID The documentum object ID of the cabinet to find. For example, "0c0277b68004dbc1" Yes.

Sample request

{
    "repos":"doctest",
    "cabinateObjectID":"0c0277b68004dbc1"
}
Delete Cabinet

The Delete Cabinet operation is used to delete the cabinet.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
cabinateObjectID The documentum object ID of the cabinet to be deleted. For example, "0c0277b68004dbc1" Yes.

Sample request

{
    "repos":"doctest",
    "cabinateObjectID":"0c0277b68004dbc1"
}
Get Cabinets

The Get Cabinets operation is used to retrieve all the cabinets.

Parameter Name Description Required
repos The name of the root repository being created in Documentum which list all child cabinets. For example, doctest. Yes.

Sample request

{
    "repos":"doctest"
}
Create ACL

The Create ACL operation enables you to create an ACL in Documentum.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
object_name The name of the ACL to be created which is user specific. For example, "Testacl8" Yes.
description The description of the ACL for details. For example, "TestaclonJul8". Yes.
owner_name The name of the Application admin/other privilege to be applied on the new ACL. For example, "appowner". Yes.

Sample request

{
    "repos":"doctest",
    "object_name":"Testacl8",
    "description": "TestaclJul8",
    "owner_name": "appowner"
}
Apply ACL

The Apply ACL operation is used to apply ACL in Documentum.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
objectID The documentum odject ID of the docuement where ACL has to be applied. For example, "Testacl8" Yes.
acl_name The name of the ACL to be applied. For example, "TestaclJul8". Yes.

Sample request

{
    "repos":"doctest",
    "objectID":"0b0277b680043127",
    "acl_name":"Testacl8"
}
Delete ACL

The Delete ACL operation is used to delete an ACL in Documentum.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
aclObjectID The ACL documentum object ID of the object(folder/document/cabinet) to be removed. For example, "450277b680001d42" Yes.

Sample request

{
    "repos":"doctest",
    "aclObjectID":"450277b680001d42"
}
Get All ACL

The Get All ACL operation is used to retrieve all ACL in Documentum.

Parameter Name Description Required
repos The name of the root repository being created in Documentum which list all ACL's created under that. For example, doctest. Yes.

Sample request

{
    "repos":"doctest",
}
Get Current Version

The Get Current Version operation is used to get all the versions in Documentum.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
chronical_id The documentum chronical object ID of the document. For example, "090277b680053e99" Yes.

Sample request

{
    "repos":"doctest",
    "chronical_id":"090277b680053e99"
}
Delete Version

The Delete Version operation is used to delete a version in Documentum.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
chronical_id The documentum chronical object ID of the document version to be deleted. For example, "090277b680053e99" Yes.

Sample request

{
    "repos":"doctest",
    "chronical_id":"090277b680053e99"
}
Find Sys Object

The Find Sys Object operation is used to find the system object in Documentum.

Parameter Name Description Required
repos The name of the root repository being created in Documentum. For example, doctest. Yes.
objectID The documentum object ID of any kind of object to find. For example, "090277b680047c89" Yes.

Sample request

{
    "repo":"doctest",
    "objectID":"090277b680047c89"
}
Top