The SMB Documentum DQL Connector can be configured using the Rest API. It requires the following entities to be created:

Connection
Connector
Seed
Credential

Below are the examples of how to create the Connection, the Seed, the Credentialthese entities. For the General Connector Configuration, please check this page.

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

Create Connection

Field	Required	Default	Multiple	Notes	Example
type	Yes	-	No	The value must be "

smb

documentum-DQL".

"

smb

documentum-DQL"
description	Yes	-	No	Name of the connection object.	"

smbConnection

documentum-DQL connection"
credential	Yes	-	No	The ID of the credential to be used with this seed. The credential type must match the seed type.	"602d3700-28dd-4a6a-8b51-e4a663fe9ee6"

hostname


properties	Yes	-	No	Configuration object
webtopUrl	Yes	-	No	Hostname where the shared directory is located.	"shared.example.com"

port

serverUrl

Yes

445

-

No

Port where the SMB protocol is used

The default URL for your Documentum server.

"

445

dctm://server-name:port"

properties

dfcPropsFilePath

Yes

-

No

Configuration objectdisableFetch

Specify the filepath where the dfc.properties file is located. Typically, this is placed in the "config" directory inside your Aspire Home.	"config/dfc.properties"
errorTolerant	No	false	No

Check to disable

If selected, the connector

fetcher, only metadata will be collected.true / false

will index only the item's metadata in case there is no document content available. If not selected, an error will be reported when there is no content (the item won't be indexed).	true / false
useRenditionType

verboseSMBJ

No

false

No

Check to enable SMBJ logging. (WARNING) Enabling this would decrease performance

If selected, include a list of rendition formats for documents to be extracted and indexed.

true / false

stopOnScanError

renditionType

No

true

[]

No

Yes	If enabled, the crawl will stop if there is an error on the scan phase.

true / false

"html,jpg"

useAttributes

indexContainers

No

false

No

Enable

If selected, include a list of attributes names to index

the directories.true / falsescanRecursivelyNotrueNoEnable to scan discovered directories recursively

. If not selected, all document/folder's metadata fields will be indexed.

true / false

include

attributeList

No

[]

Yes

Patterns to match against document URL, if any of them match, the document will be included in the crawl.[ ".*pdf$", ".*docx$" ]excludeNo[ ]YesPatterns to match against document URL, if any of them match, the document will be excluded from the crawl.[ ".*png$", ".*jpeg$" ]scanExcludedItemsNofalseNoEnable to force the scan of excluded directories, so child items within the scope can be found.true / falsefetchACLsNotrueNoCheck to retrieve owner, group and ACL information.true / false

resolveSIDs

NotrueNo

Check to resolve retrieved SIDs from owner, group and ACL.

true / false

addACLSID

NofalseNoCheck to include SID value on ACL output.true / false

addACLEncodedSID

NofalseNoCheck to include Encoded SID (Base 32) value on ACL output.true / false

addACLFlags

NofalseNoCheck to include ACL flags on ACL output.true / false

addACLType

NofalseNoCheck to include ACL type on ACL output.true / false

addACLAccessMask

NofalseNoCheck to include ACL access mask on ACL output.true / false

enableDFS

NotrueNoDistributed File System (DFS) resolutiontrue /false

connectionTimeout

Yes6000NoTimeout in milliseconds for each SMB request."6000"

maxRetries

Yes5NoMaximum retries permitted per document."5"

baseBackoff

Yes500NoBase time for the back off sleeps (in ms)."500"

backoffMultiplier

Yes2.0NoMultiplier factor to be used for the back off time."2.0"

lastAccessedUpdates

NofalseNoCheck to restore the last accessed date on the documents processed by the connector. WARNING: Requires a user with permissions for writing. This is not supported by windows.true /falsestaticAclNo

[ ]

YesStatic ACL configuration objectnameYes-NoName of the static ACL."group1"domainNo""NoDomain of the static ACL."testDomain"entityNo"user"NoEntity (user / group) represented by the static ACL."user" / "group"accessNo"allow"NoAccess (allow / deny) granted by the ACL."allow" / "deny"

Example

List of metadata field names to index separated by a comma (',').	"object_name,r_object_type,r_creation_date,r_modify_date,i_chronicle_id,title"
fullSelectDQL	No	-	No	Full crawl SELECT statement. Aspire needs at least these key fields in the SELECT: r_object_id and i_chronicle_id. This query will return the object_id value of all items that will be crawled and indexed.	SELECT r_object_id, i_chronicle_id FROM dm_document
incrementalStrategy	Yes	-	No	Incremental Strategy.	Audit trail / Event queue
incrementalSelectDQL	Yes	-	No	Incremental crawl SELECT statement. Aspire needs at least these key fields in the SELECT: r_object_id and i_chronicle_id. This query will return the object_id value of all items that will be crawled and indexed. The variable ${crawlTimeStamp} will be expanded upon incremental start.	SELECT r_object_id, i_chronicle_id FROM dm_document WHERE r_modify_date > ${crawlTimeStamp}
selectAuditAclChangesDQL	No	-	No	Audit ACL updates SELECT statement for incremental. Aspire needs at least these key fields in the SELECT - r_object_id and chronicle_id. The variable ${crawlTimeStamp} will be expanded upon incremental start.	SELECT r_object_id, chronicle_id FROM dm_audittrail WHERE event_name = 'dm_save' AND time_stamp_utc > ${crawlTimeStamp}
selectAuditDeletesDQL	No	-	No	Audit deletes SELECT statement for incremental. Aspire needs at least these fields in the SELECT - r_object_id and chronicle_id. The variable ${crawlTimeStamp} will be expanded upon incremental start.	SELECT r_object_id, chronicle_id FROM dm_audittrail WHERE (event_name = 'dm_destroy' OR event_name = 'dm_prune') AND time_stamp_utc > ${crawlTimeStamp}
selectAuditSafeguardDQL	No	-	No	Check to include SID value on ACL output.Audit safeguard SELECT statement for incremental. The variable ${auditChronicleId} will be expanded for current audit chronicle ID.	SELECT r_object_id FROM dm_document WHERE i_chronicle_id = ${auditChronicleId} AND -whereFromFullCrawl-
deleteAuditItems	No	false	No	If selected, audit items used to track document changes will be deleted after incremental.	true / false
repositoryZoneId	No	-	No	Valid repository time zone ID. Not mandatory. UTC is the default value	Europe/Minsk, UTC+3, UTC-6
selectEventsSafeguardDQL	No	-	No	Event safeguard SELECT statement for incremental. Not mandatory. The variable ${eventId} will be expanded for current event itemId.	SELECT i_chronicle_id FROM dm_document WHERE r_object_id = ${eventId} AND -whereFromFullCrawl-
deleteEvents	No	-	No	List of delete events names separated by comma ','.	"dm_destroy, dm_prune"
maxFileSize	No	Unlimited	Yes	Specify the limit for the size of the content to be crawled. Value should be submitted as MB. Type UNLIMITED if you do not wish to set a max content size.	"10"

Example

Connection with incremental strategy "Event queue"

Code Block

theme	RDark
title	POST aspire/_api/connections

Code Block

theme	RDark
title	POST aspire/_api/connections

{
    "type": "smb",
    "description": "SMB Test Connector",
	"credential": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
    "properties": {
        "host": "192.168.0.80",
        "port":"445",
        "disableFetch": false,
        "verboseSMBJ": false,
        "stopOnScanError": true,
        "indexContainerstype": true"documentum-DQL",
        "scanExcludedItems": true,
        "includesdescription": ".*\\.txtDQL_event_queue_connection",
            "excludescredential": ".*\\.png",
		"fetchACLs":true,
8153ae2e-7260-40d4-91e6-2501ce62fc91",
            "resolveSIDsproperties": true,
		"addACLSID": false,
		"addACLEncodedSID": false,
		"addACLFlags": false,
		"addACLType" : false,
		"addACLAccessMask": false,
		"enableDFS": true,
		"connectionTimeout": 60000,
		"maxRetries": 5,
		"baseBackoff": 500,
		"backoffMultiplier": 2.0,
		"lastAccessedUpdates": false,
{
                "serverUrl": "dctm://10.89.26.139:1489/",
                "dfcPropsFilePath": "config/dfc.properties",
                "errorTolerant": true,
         "staticAcl       "useRenditionType": [{true,
                "namerenditionType": "test-userhtml,jpg",
                "domainuseAttributes": "test-domain"true,
                "entityattributeList": "userobject_name,",
                "access": "allow"
"webtopUrl": "http://10.89.26.139:8080/da/component/main",
                "fullSelectDQL":  }, {"SELECT r_object_id, i_chronicle_id FROM dm_document",
                "nameincrementalStrategy": "test-groupeventQueue",
                "domainselectEventsSafeguardDQL": "",
                "entity": "group"SELECT i_chronicle_id FROM dm_document WHERE r_object_id = ${eventId} AND -whereFromFullCrawl-",
                "accessdeleteEvents": "deny"
       dm_destroy, dm_prune",
     }
        ]
    }
}"maxFileSize": "Unlimited"
            }

Update Connection

Field	Required	Default	Multiple	Notes	Example
type

Update Connection

webtopUrlHostname where the shared directory is locatedshared.example.comserverUrlrenditionTypeselectAuditDeletesDQL deletes for incremental Aspire audittrail (event_name = 'dm_destroy' OR event_name = 'dm_prune') AND time_stamp_utc SELECT i_document r_object_id = ${eventId} AND -whereFromFullCrawl-

Field	Required	Default	Multiple	Notes	Example
type	Yes	-	No	The value must be "documentum-DQL".	"documentum-DQL"
description	Yes	-	No	Name of the connection object.	"documentum-DQL connection"
credential	Yes	-	No	The ID of the credential to be used with this seed. The credential type must match the seed type.	"602d3700-28dd-4a6a-8b51-e4a663fe9ee6"
properties	Yes	-	No	Configuration object		Yes	-	No	The value must be "documentum-DQL".	"	documentum-DQL"
description	Yes	-	No	The default url for your documentum server	"dctm://server-name:port"	Name of the connection object.	"documentum-DQL connection"
credentialdfcPropsFilePath	Yes	-	No	Specify the filepath where the dfc.properties file is located. Typically this is placed in the "config" directory inside your Aspire Home.	"config/dfc.properties"
errorTolerant	No	false	No	If selected, the connector will index only item's metadata in case there is not document content available. If not select, an error will be reported when there is no content (the item won't be index).	true / false
useRenditionType	No	false	No	If selected, include a list of rendition formats for documents to be extracted and indexed	true/false
The ID of the credential to be used with this seed. The credential type must match the seed type.	"602d3700-28dd-4a6a-8b51-e4a663fe9ee6"
properties	Yes	-	No	Configuration object
webtopUrl	Yes	-	No	Hostname where the shared directory is located.	"shared.example.com"
serverUrl	Yes	-	No	The default URL for your Documentum server	"dctm://server-name:port"
dfcPropsFilePath	Yes	-	No	Specify the filepath where the dfc.properties file is located. Typically, this is placed in the "config" directory inside your Aspire Home.	"config/dfc.properties"
errorTolerant	No	[]	Yes	If enabled, the crawl will stop if there is an error on the scan phase.	"html,jpg"	useAttributes	No	false	No	If selected, include a list of attributes names to indexthe connector will index only the item's metadata in case there is no document content available. If not selected, all document/folder's metadata fields will be indexed.",	true / false
attributeList	No	[]	Yes	List of metadata fields name to index separated by comma ','.	"object_name,r_object_type,r_creation_date,r_modify_date,i_chronicle_id,title"
fullSelectDQL	No	-	No	Full crawl SELECT statement. Aspire needs at least these key fields in the SELECT - r_object_id and i_chronicle_id. This query will return the object_id value of all items that will be crawled and indexed	SELECT r_object_id, i_chronicle_id FROM dm_document
incrementalStrategy	Yes	-	No	Incremental Strategy	Audit trail / Event queue
incrementalSelectDQL	Yes	-	No	Incremental crawl SELECT statement. Aspire needs at least these key fields in the SELECT - r_object_id and i_chronicle_id. This query will return the object_id value of all items that will be crawled and indexed. The variable ${crawlTimeStamp} will be expanded upon incremental start.	SELECT r_object_id, i_chronicle_id FROM dm_document WHERE r_modify_date > ${crawlTimeStamp}
an error will be reported when there is no content (the item won't be indexed).	true / false
useRenditionType	No	false	No	If selected, include a list of rendition formats for documents to be extracted and indexed	true / false
renditionType	No	[]	Yes	If enabled, the crawl will stop if there is an error on the scan phase.	"html,jpg"
useAttributes	No	false	No	If selected, include a list of attributes names to index. If not selected, all document/folder's metadata fields will be indexed."	true / false
attributeList	No	[]	Yes	List of metadata field names to index separated by a comma (',').	"object_name,r_object_type,r_creation_date,r_modify_date,i_chronicle_id,title"
fullSelectDQL	No	-	No	Full crawl SELECT statement. Aspire	selectAuditAclChangesDQL	Yes	-	No	Audit ACL updates SELECT statement for incremental. Aspire needs at least these key fields in the SELECT - : r_object_id and i_chronicle_id. The variable ${crawlTimeStamp} will be expanded upon incremental startThis query will return the object_id value of all items that will be crawled and indexed.	SELECT r_object_id, chronicle_id FROM dm_audittrail WHERE event_name = 'dm_save' AND time_stamp_utc > ${crawlTimeStamp}, i_chronicle_id FROM dm_document
incrementalStrategy		Yes	-	No	Incremental Strategy.	Audit trail / Event queue
incrementalSelectDQL	Yes	-	No	Incremental crawl	SELECT statement	.	Aspire needs at least these key fields in the SELECT: - r_object_id and i_chronicle_id. This query will return the object_id value of all items that will be crawled and indexed. The variable ${crawlTimeStamp} will be expanded upon incremental start.	SELECT r_object_id, i_chronicle_id FROM dm_	document WHERE	r_modify_date > ${crawlTimeStamp}
selectAuditSafeguardDQLselectAuditAclChangesDQL	Yes	-	No	Check to include SID value on ACL output.Audit safeguard Audit ACL updates SELECT statement for incremental. Aspire needs at least these key fields in the SELECT: r_object_id and chronicle_id. The variable ${auditChronicleIdcrawlTimeStamp} will be expanded for current audit chronicle idbe expanded upon incremental start.	SELECT r_object_id, chronicle_id FROM dm_ document WHERE i_chronicle_id = ${auditChronicleId} AND -whereFromFullCrawl-
deleteAuditItems	No	false	No	If selected, audit items used to track document changes will be deleted after incremental	true / false
repositoryZoneId	No	-	No	Valid repository time zone id. Not mandatory - UTC being the default value	Europe/Minsk, UTC+3, UTC-6
audittrail WHERE event_name = 'dm_save' AND time_stamp_utc > ${crawlTimeStamp}
selectAuditDeletesDQL	Yes	-	No	Audit deletes SELECT statement for incremental. Aspire needs at least these fields in the SELECT: r_object_id and chronicle_id. The variable ${crawlTimeStamp} will be expanded upon incremental start.	SELECT r_object_id,	selectEventsSafeguardDQL	No	-	No	Event safeguard SELECT statement for incremental. Not mandatory. The variable ${eventId} will be expanded for current event itemId.	chronicle_id FROM dm_	audittrail WHERE
deleteEvents	No	-	No	"List of delete events names separated by comma ','.	"dm_destroy, dm_prune"
enableDFS	No	true	No	Distributed File System (DFS) resolution	true /false
connectionTimeout	Yes	6000	No	Timeout in milliseconds for each SMB request.	"6000"
maxRetries	Yes	5	No	Maximum retries permitted per document.	"5"
baseBackoff	Yes	500	No	Base time for the back off sleeps (in ms).	"500"
backoffMultiplier	Yes	2.0	No	Multiplier factor to be used for the back off time.	"2.0"
lastAccessedUpdates	No	false	No	Check to restore the last accessed date on the documents processed by the connector. WARNING: Requires a user with permissions for writing. This is not supported by windows.	true /false
staticAcl	No	[ ]	Yes	Static ACL configuration object
name	Yes	-	No	Name of the static ACL.	"group1"
domain	No	""	No	Domain of the static ACL.	"testDomain"
entity	No	"user"	No	Entity (user / group) represented by the static ACL.	"user" / "group"
access	No	"allow"	No	Access (allow / deny) granted by the ACL.	"allow" / "deny"

Example

(event_name = 'dm_destroy' OR event_name = 'dm_prune') AND time_stamp_utc > ${crawlTimeStamp}
selectAuditSafeguardDQL	Yes	-	No	Check to include SID value on ACL output.Audit safeguard SELECT statement for incremental. The variable ${auditChronicleId} will be expanded for current audit chronicle ID.	SELECT r_object_id FROM dm_document WHERE i_chronicle_id = ${auditChronicleId} AND -whereFromFullCrawl-
deleteAuditItems	No	false	No	If selected, audit items used to track document changes will be deleted after incremental.	true / false
repositoryZoneId	No	-	No	Valid repository time zone ID. Not mandatory. UTC is the default value.	Europe/Minsk, UTC+3, UTC-6
selectEventsSafeguardDQL	No	-	No	Event safeguard SELECT statement for incremental. Not mandatory. The variable ${eventId} will be expanded for current event itemId.	SELECT i_chronicle_id FROM dm_document WHERE r_object_id = ${eventId} AND -whereFromFullCrawl-
deleteEvents	No	-	No	List of delete events names separated by comma (',').	"dm_destroy, dm_prune"
maxFileSize	No	Unlimited	Yes	Specify the limit for the size of the content to be crawled. Value should be submitted as MB. Type UNLIMITED if you do not wish to set a max content size.	"10"

Example

Connection with incremental strategy "Audit trail"

Code Block

theme	RDark
title	PUT aspire/_api/connections/89d6632a-a296-426c-adb0-d442adcab4b0

{
         "id": "1a1da314-4ccb-49fa-ac0c-aa3a726e0e3a",
         "type": "documentum-DQL",
         "description": "DQL_audit_trail_connection",
         "credential": "8153ae2e-7260-40d4-91e6-2501ce62fc91",
         "properties": {
            "serverUrl": "dctm://10.89.26.139:1489/",
            "dfcPropsFilePath": "config/dfc.properties",
            "errorTolerant": true,
            "useRenditionType": true,
            "renditionType": "html,jpg",
            "useAttributes": true,
            "attributeList": "object_name,",
            "webtopUrl": "http://10.89.26.139:8080/da/component/main",
            "fullSelectDQL": "SELECT r_object_id, i_chronicle_id FROM dm_document",
            "incrementalStrategy": "auditTrail",
            "incrementalSelectDQL": "SELECT r_object_id, i_chronicle_id FROM dm_document WHERE r_modify_date > ${crawlTimeStamp}",
            "selectAuditAclChangesDQL": "SELECT r_object_id, chronicle_id FROM dm_audittrail WHERE event_name = 'dm_save'  AND time_stamp_utc > ${crawlTimeStamp}",
            "selectAuditDeletesDQL": "SELECT r_object_id, chronicle_id FROM dm_audittrail WHERE (event_name = 'dm_destroy' OR event_name = 'dm_prune' )  AND time_stamp_utc > 				     $>${crawlTimeStamp}",
            "selectAuditSafeguardDQL": "SELECT r_object_id FROM dm_document WHERE i_chronicle_id = ${auditChronicleId}",
            "deleteAuditItems": false,
            "repositoryZoneId": "",
            "maxFileSize": "Unlimited"
         }
}

Create Connector

For the creation of the Connector object using the Rest API, check this page

Update Connector

For the update of the Connector object using the Rest API, check this page

Create Seed

Field	Required	Default	Multiple	Notes	Example
seed	Yes	-	No	The repository to crawl. This value will be appended to the URL of the connection.	"/repository"
type	Yes	-	No	The value must be "documentu-DQL".	"documentu-DQL"
description	Yes	-	No	Name of the seed object.	"documentu-DQL seed"
connector	Yes	-	No	The ID of the connector to be used with this seed. The connector type must match the seed type.	"82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31"
connection	Yes	-	No	The ID of the connection to be used with this seed. The connection type must match the seed type.	"602d3700-28dd-4a6a-8b51-e4a663fe9ee6"
workflows	No	[ ]	Yes	The IDs of the workflows that will be executed for the documents crawled.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
throttlePolicy	No	-	No	ID of the throttle policy that applies to this connection object.	"f5587cee-9116-4011-b3a9-6b235b333a1b"
routingPolicies	No	[ ]	Yes	The IDs of the routing policies that this seed will use.	["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
tags	No	[ ]	Yes	The tags of the seed. These can be used to filter the seed.	["tag1", "tag2"]

Example

Code Block

theme	RDark
title	POST aspire/_api/seeds

   {
      "type":"documentum-DQL",
      "description":"dql_seed",
      "connector":"d859a13d-db0b-457b-bc4f-e0311cf8162c",
      "seed":"/repository",
      "priority":"medium",
      "connection":"2a5ca234-e328-4d40-bb2a-2df3e550b065"
      "workflows": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
      "tags": ["tag1", "tag2"],
      "throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
      "routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
    }

Update Seed

Field	Required	Default	Multiple	Notes	Example
id	Yes	-	No	ID of the seed to update.	"2f287669-d163-4e35-ad17-6bbfe9df3778"
seed	No	-	No	The repository to crawl. This value will be appended to the URL of the connection.	"/repository"
description	No	-	No	Name of the seed object.	"documentum-DQL seed"
connector	No	-	No	The ID of the connector to be used with this seed. The connector type must match the seed type.	"82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31"
connection	No	-	No	The ID of the connection to be used with this seed. The connection type must match the seed type.	"602d3700-28dd-4a6a-8b51-e4a663fe9ee6"
workflows	No	[ ]	Yes	The IDs of the workflows that will be executed for the documents crawled.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
workflows.add	No	[ ]	Yes	The IDs of the workflows to add.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
workflows.remove	No	[ ]	Yes	The IDs of the workflows to remove.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
throttlePolicy	No	-	No	ID of the throttle policy that applies to this connection object.	"f5587cee-9116-4011-b3a9-6b235b333a1b"
routingPolicies	No	[ ]	Yes	The IDs of the routing policies that this seed will use.	["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
routingPolicies.add	No	[ ]	Yes	The IDs of the routingPolicies to add.	["b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
routingPolicies.remove	No	[ ]	Yes	The IDs of the routingPolicies to remove.	["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7"]
tags	No	[ ]	Yes	The tags of the seed. These can be used to filter the seed.	["tag1", "tag3"]
tags.add	No	[ ]	Yes	The tags to add.	["tag4"]
tags.remove	No	[ ]	Yes	The tags to remove.	["tag2"]

Example

Code Block

theme	RDark
title	PUT aspire/_api/seeds/2f287669-d163-4e35-ad17-6bbfe9df3778

   {
      "id":"2f287669-d163-4e35-ad17-6bbfe9df3778",
      "type":"documentum-DQL",
      "description":"dql_seed",
      "connector":"d859a13d-db0b-457b-bc4f-e0311cf8162c",
      "seed":"/repository",
      "priority":"medium",
      "connection":"2a5ca234-e328-4d40-bb2a-2df3e550b065"
      "workflows": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
      "tags": ["tag1", "tag2"],
      "throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
      "routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
    }

Create Credential

Field	Required	Default	Multiple	Notes	Example
type	Yes	-	No	The value must be "documentum-DQL".	"documentum-DQL"
description	Yes	-	No	Name of the credential object.	"documentum-DQL Credential"
authentication	Yes	-	No	It can be just "basic" for now.	"basic"
username	Yes	-	No	Account user.	"admin"
password	Yes	-	No	Account password.	"234dfc22re!?"

Example

Code Block

theme	RDark
title	POST aspire/_api/credentials

   {
      "type":"documentum-DQL",
      "description": "documentum DQL - description",
      "authentication":"basic",
      "username":"docuser",
      "password":"encrypted:A9AC6E19DF4ECFA129A3F2FA23C326E6B280D901E0E20958BD51A0B2FFE2C14D"
    }

Update Credential

Field	Required	Default	Multiple	Notes	Example
type	Yes	-	No	The value must be "documentum-DQL".	"documentum-DQL"
description	Yes	-	No	Name of the credential object.	"documentum-DQL Credential"
authentication	Yes	-	No	It can be just "basic" for now.	"basic"
username	Yes	-	No	Account user.	"admin"
password	Yes	-	No	Account password.	"234dfc22re!?"

Example

Code Block

theme	RDark
title	PUT aspire/_api/credentials/2a5ca234-e328-4d40-bb2a-2df3e550b065

   {
      "id":"2a5ca234-e328-4d40-bb2a-2df3e550b065",
      "type":"documentum-DQL",
      "description": "documentum DQL - description",
      "authentication":"basic",
      "username":"docuser",
      "password":"encrypted:A9AC6E19DF4ECFA129A3F2FA23C326E6B280D901E0E20958BD51A0B2FFE2C14D"
    }

Page tree

Versions Compared

Old Version 3

New Version Current

Key

Create Connection

Example

Example

Connection with incremental strategy "Event queue"

Update Connection

Update Connection

Example

Example

Connection with incremental strategy "Audit trail"

Create Connector

Update Connector

Create Seed

Example

Update Seed

Example

Create Credential

Example

Update Credential

Example

Page tree

Page History

Versions Compared

Old Version 3

New Version Current

Key

Create Connection

Example

Example

Connection with incremental strategy "Event queue"

Update Connection

Update Connection

Example

Example

Connection with incremental strategy "Audit trail"

Create Connector

Update Connector

Create Seed

Example

Update Seed

Example

Create Credential

Example

Update Credential

Example