Version 1.0
Connector Overview: This page documents all 500 actions for the Otdocumentumconnector v1.0.
Acl (5)
POST Create the acl (Documentum REST)
/repositories/{repositoryName}/acls
Create a new access control list in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of ACL (e.g., "inherit", "derived"). |
|
|
Provide the ACL definition as a JSON string. |
|
|
Provide additional properties for the ACL as a JSON string. |
DELETE Delete the acl (Documentum REST)
/repositories/{repositoryName}/acls/{objectId}
Permanently delete the specified ACL from the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
force |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the acl (Documentum REST)
/repositories/{repositoryName}/acls/{objectId}
Retrieve details of a specific ACL by its object ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the acls (Documentum REST)
/repositories/{repositoryName}/acls
Retrieve a list of all ACLs in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the acl (Documentum REST)
/repositories/{repositoryName}/acls/{objectId}
Update an existing ACL with new type, definition, or properties.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the new type for the ACL (e.g., "inherit", "derived"). |
|
|
Provide the updated ACL definition as a JSON string. |
|
|
Provide updated properties for the ACL as a JSON string. |
AclAssociation
GET Get the aclAssociations (Documentum REST)
/repositories/{repositoryName}/acls/{objectId}/associations
Retrieve all associations for a given ACL.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Annotation (3)
POST Create the annotation
/repositories/{repositoryName}/objects/{id}/annotations
Create a new annotation on the specified object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the annotations
/repositories/{repositoryName}/objects/{id}/annotations
Retrieve all annotations for a given object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the annotations
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/annotations
Retrieve annotations for a specific process task.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
taskName |
|
|
processId |
|
|
processName |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
ArchivedContent (2)
GET Get the archivedContents (Documentum REST)
/repositories/{repositoryName}/archived-contents
Retrieve a list of archived content entries in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
include-children |
|
|
binding-label |
|
|
include-broken |
|
|
depth |
|
|
format |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the archivedContent (Documentum REST)
/repositories/{repositoryName}/archived-contents
Update an archived content entry with new type, definition, or properties.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
all-contents |
|
|
format |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of archived content (e.g., "file", "link"). |
|
|
Provide the archived content definition as a JSON string. |
|
|
Provide additional properties for the archived content as a JSON string. |
AspectType (2)
GET Get the aspectType (Documentum REST)
/repositories/{repositoryName}/aspect-types/{aspectTypeName}
Retrieve details of a specific aspect type by its name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
aspectTypeName |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
locale |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the aspectTypes (Documentum REST)
/repositories/{repositoryName}/aspect-types
Retrieve a list of all aspect types in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Audit (3)
GET Get the audits
/repositories/{repositoryName}/users/{userName}/audits
Retrieve audit trail entries for a specific user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
retrieve the audits for the specified userName |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
start_date |
|
|
end_date |
|
|
date_format |
|
|
include-dm-events |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the audits
/repositories/{repositoryName}/users/{userName}/documents-audit
Retrieve document audit trail entries for a specific user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
document audit for the specified userName |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
start_date |
|
|
end_date |
|
|
date_format |
|
|
include-dm-events |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the audits
/repositories/{repositoryName}/users/{userName}/fav-doc-audits
Retrieve favorite document audit trail entries for a specific user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
retrieve the favorite document audits of the specified userName |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
start_date |
|
|
end_date |
|
|
date_format |
|
|
include-dm-events |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
AuditEvent (5)
POST Create the auditEvent (Documentum REST)
/repositories/{repositoryName}/registered-audit-events
Register a new audit event in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
audit-scope |
|
|
The r_object_id of required sysobject. |
|
|
object-type |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
DELETE Delete the auditEvent (Documentum REST)
/repositories/{repositoryName}/registered-audit-events/{id}
Delete a specific registered audit event by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete the auditEvents (Documentum REST)
/repositories/{repositoryName}/registered-audit-events
Delete all registered audit events from the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
audit-scope |
|
|
The r_object_id of required sysobject. |
|
|
object-type |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the auditEvent (Documentum REST)
/repositories/{repositoryName}/registered-audit-events/{id}
Retrieve details of a specific registered audit event by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the auditEvents (Documentum REST)
/repositories/{repositoryName}/registered-audit-events
Retrieve a list of all registered audit events in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
audit-scope |
|
|
The r_object_id of required sysobject. |
|
|
object-type |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
AuditPolicy (5)
POST Create the auditPolicy (Documentum REST)
/repositories/{repositoryName}/audit-policies
Create a new audit policy in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The object ID to which the audit policy applies. |
|
|
A name for the audit policy. |
|
|
The accessor (user or group) name for the policy. |
|
|
Boolean flag indicating whether the accessor is a group. |
|
|
JSON string defining attribute-level audit rules. |
DELETE Delete the auditPolicy (Documentum REST)
/repositories/{repositoryName}/audit-policies/{id}
Delete a specific audit policy by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the auditPolicies (Documentum REST)
/repositories/{repositoryName}/audit-policies
Retrieve a list of all audit policies in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the auditPolicy (Documentum REST)
/repositories/{repositoryName}/audit-policies/{id}
Retrieve details of a specific audit policy by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the auditPolicy (Documentum REST)
/repositories/{repositoryName}/audit-policies/{id}
Update an existing audit policy for a repository. Use this to modify the configuration of a specific audit policy identified by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The object ID to which the audit policy applies. |
|
|
A name for the audit policy. |
|
|
The accessor (user or group) name for the policy. |
|
|
Boolean flag indicating whether the accessor is a group. |
|
|
JSON string defining attribute-level audit rules. |
AuditTrail (3)
DELETE Delete the auditTrail (Documentum REST)
/repositories/{repositoryName}/audit-trails/{id}
Permanently delete a specific audit trail entry from the repository. Use this to remove an audit trail record by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
trace |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the auditTrail (Documentum REST)
/repositories/{repositoryName}/audit-trails/{id}
Retrieve the details of a single audit trail entry by its ID. Use this to inspect the properties of a specific audit record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the auditTrails (Documentum REST)
/repositories/{repositoryName}/audit-trails
Retrieve a list of all audit trail entries for a repository. Use this to view the complete audit history.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
AvailableAuditEvent
GET Get the availableAuditEvents (Documentum REST)
/repositories/{repositoryName}/available-audit-events
Retrieve the list of audit event types that are available for the repository. Use this to see which events can be tracked by audit policies.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
object-type |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Batch
POST Update the batch (Documentum REST)
/repositories/{repositoryName}/batches
Submit a batch of operations to be executed sequentially in a single transaction. Use this to group multiple Documentum REST calls into one request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide an array of attachment references to include with the batch request. Each attachment should be a string identifier. |
BatchCapability
GET Get the batchCapabilities (Documentum REST)
/repositories/{repositoryName}/batch-capabilities
Retrieve the batch processing capabilities supported by the repository. Use this to discover which batch operations are available.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
BravacsrAnnotation (6)
GET Get the bravacsrAnnotations
/repositories/{repositoryName}/objects/{objectId}/d2-bravacsr-annotations
Retrieve the Brava CSR annotations associated with a specific object. Use this to get annotation data for the given object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
user |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the bravacsrAnnotations
/repositories/{repositoryName}/objects/{objectId}/d2-bravacsr-annotations-list
Retrieve a list of Brava CSR annotations for a specific object. Use this to get the annotation list rather than the full annotation data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
action |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the bravacsrAnnotations
/repositories/{repositoryName}/objects/{objectId}/d2-bravacsr-changemark-config
Retrieve the Brava CSR change mark configuration for a specific object. Use this to get the change mark settings applied to the object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the bravacsrAnnotations
/repositories/{repositoryName}/objects/{objectId}/d2-bravacsr-raster-urls
Retrieve the Brava CSR raster image URLs for a specific object. Use this to get the URLs of raster images associated with the object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the bravacsrAnnotations
/repositories/{repositoryName}/objects/{objectId}/d2-bravacsr-rasters
Retrieve the Brava CSR raster images for a specific object. Use this to get the raster image data itself.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
raster-id |
|
|
content-type |
|
|
download-type |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the bravacsrAnnotation
/repositories/{repositoryName}/objects/{objectId}/d2-bravacsr-annotations
Update the Brava CSR annotations for a specific object. Use this to modify or replace the existing annotation data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
BravacsrConfig
GET Get the bravacsrConfig
/repositories/{repositoryName}/objects/{id}/d2-bravacsr-searchinfo-fallback-url
Retrieve the Brava CSR search info fallback URL configuration for a specific object. Use this to get the fallback URL used when search info is unavailable.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The response format expected from the API (e.g. application/json). |
Cabinet (5)
POST Create the cabinet (Documentum REST)
/repositories/{repositoryName}/cabinets
Create a new cabinet in the repository. Use this to add a top-level cabinet container.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
constraint-validation-policy |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
DELETE Delete the cabinet (Documentum REST)
/repositories/{repositoryName}/cabinets/{id}
Permanently delete a specific cabinet from the repository. Use this to remove a cabinet by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
del-non-empty |
|
|
del-all-links |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the cabinet (Documentum REST)
/repositories/{repositoryName}/cabinets/{id}
Retrieve the properties of a single cabinet by its ID. Use this to inspect a specific cabinet's details.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
check-subscription |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the cabinets (Documentum REST)
/repositories/{repositoryName}/cabinets
Retrieve a list of all cabinets in the repository. Use this to browse the cabinet hierarchy.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
object-type |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the cabinet (Documentum REST)
/repositories/{repositoryName}/cabinets/{id}
Update the properties of an existing cabinet. Use this to modify a cabinet's metadata by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
constraint-validation-policy |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
Content (5)
POST Create the content (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/contents
Create new content for a specific object. Use this to add one or more content streams to an existing object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
Specifies the format name of the specific content or rendition. |
|
|
Specifies the page number of the specific content or rendition. |
|
|
Specifies the page modifier of the specific rendition. |
|
|
primary |
|
|
content-length |
|
|
content-charset |
|
|
overwrite |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Provide an array of href strings pointing to the content sources to be added. |
|
|
Specify a boolean value indicating the type of content being created. Set to true or false as required. |
|
|
Provide a string defining the content type definition. This specifies the format or category of the content. |
DELETE Delete the content (Documentum REST)
/repositories/{repositoryName}/objects/{id}/contents/content
Delete the primary content stream of a specific object. Use this to remove the content from the object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Specifies the format name of the specific content or rendition. |
|
|
Specifies the page number of the specific content or rendition. |
|
|
Specifies the page modifier of the specific rendition. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the content (Documentum REST)
/repositories/{repositoryName}/objects/{id}/contents/content
Retrieve the primary content stream of a specific object. Use this to download or inspect the content data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Specifies the format name of the specific content or rendition. |
|
|
Specifies the page number of the specific content or rendition. |
|
|
Specifies the page modifier of the specific rendition. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
media-url-policy |
|
|
network-location |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the contents (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/contents
Retrieve a list of all content streams associated with a specific object. Use this to see the content metadata and links.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
media-url-policy |
|
|
network-location |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the content (Documentum REST)
/repositories/{repositoryName}/objects/{id}/contents/content
Update the primary content stream of a specific object. Use this to replace the existing content with new data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Specifies the format name of the specific content or rendition. |
|
|
Specifies the page number of the specific content or rendition. |
|
|
Specifies the page modifier of the specific rendition. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
ContentMedia
GET Get the contentMedia (Documentum REST)
/repositories/{repositoryName}/objects/{id}/content-media
Retrieve the content media information for a specific object. Use this to get media type and streaming details.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Specifies the format name of the specific content or rendition. |
|
|
Specifies the page number of the specific content or rendition. |
|
|
Specifies the page modifier of the specific rendition. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
CoreUsersSearch
GET Get the coreUsersSearch
/repositories/{repositoryName}/share-to-core/core-users-search
Retrieve the list of core users that can be searched for sharing content to core. Use this to get available core users for sharing operations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The parameter specifies the search criterion with a full-text expression in simple search language. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
CurrentUser
GET Get the currentUser (Documentum REST)
/repositories/{repositoryName}/currentuser
Retrieve details about the currently authenticated user. Use this to get user information such as name, groups, and permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
CurrentUserPreference (5)
POST Create the currentUserPreference (Documentum REST)
/repositories/{repositoryName}/currentuser-preferences
Create a new preference for the current user. Use this to store user-specific settings such as client, owner name, title, subject, keywords, creation date, modify date, and preference content.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The client application identifier for the preference. |
|
|
The owner name associated with the preference. |
|
|
The title of the preference. |
|
|
The subject of the preference. |
|
|
An array of keywords related to the preference. |
|
|
The creation date of the preference in string format. |
|
|
The modification date of the preference in string format. |
|
|
The content of the preference. |
DELETE Delete the currentUserPreference (Documentum REST)
/repositories/{repositoryName}/currentuser-preferences/{clientCode}
Permanently delete a specific preference for the current user identified by the client code. Use this to remove a user preference that is no longer needed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
clientCode |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the currentUserPreference (Documentum REST)
/repositories/{repositoryName}/currentuser-preferences/{clientCode}
Retrieve a specific preference for the current user using the client code. Use this to get details of a particular user preference.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
clientCode |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the currentUserPreferences (Documentum REST)
/repositories/{repositoryName}/currentuser-preferences
Retrieve all preferences for the current user. Use this to list all stored user preferences.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the currentUserPreference (Documentum REST)
/repositories/{repositoryName}/currentuser-preferences/{clientCode}
Update an existing preference for the current user identified by the client code. Use this to modify user-specific settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
clientCode |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The client application identifier for the preference. |
|
|
The owner name associated with the preference. |
|
|
The title of the preference. |
|
|
The subject of the preference. |
|
|
An array of keywords related to the preference. |
|
|
The creation date of the preference in string format. |
|
|
The modification date of the preference in string format. |
|
|
The content of the preference. |
CurrentVersion
GET Get the currentVersion (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/versions/current
Retrieve the current version of a specific object. Use this to get the latest version of a document or object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#about
GET Get the d2#about
/repositories/{repositoryName}/about-d2
Retrieve information about the D2 application. Use this to get version and configuration details of the D2 environment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#action
GET Get the d2#actions
/repositories/{repositoryName}/actions
Retrieve a list of available D2 actions. Use this to get actions that can be performed on objects.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
An optional query parameter to filter the list of actions. |
|
|
It is the object id(s) of the object whose actions are required. |
|
|
It lists the object types in the repository. |
|
|
It Specifies promoted, non-promoted or all actions in the actions' response. By default, all the actions are returned. |
|
|
includes subtype value |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#checkinServletHandler
POST Update the d2#checkinServletHandler
/repositories/{repositoryName}/servlet/CheckInWithLifeCycle
Perform a check-in operation with lifecycle management via a servlet handler. Use this to check in a document and apply lifecycle transitions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#commentsCount
GET Get the d2#commentsCount
/repositories/{repositoryName}/comments-count
Retrieve the total count of comments across the repository. Use this to get an aggregate comment count.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
root-comments-only |
|
|
The object id(s) of the object whose actions are required. Object ids can be passed in one of the following formats:- object-ids= object-ids=&object-ids=&object-ids= |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#commentsRepliesCount
GET Get the d2#commentsRepliesCount
/repositories/{repositoryName}/objects/{objectId}/comments-replies-count
Retrieve the count of comments and replies for a specific object. Use this to get the number of comments and replies on a given object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
comment-ids |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#contentAssistConfiguration (2)
GET Get the d2#contentAssistConfiguration
/repositories/{repositoryName}/d2-configurations/content-assist-configs
Retrieve all content assist configurations. Use this to list all available content assist configurations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#contentAssistConfiguration
/repositories/{repositoryName}/d2-configurations/content-assist-configs/{configId}
Retrieve a specific content assist configuration by its identifier. Use this to get details of a particular configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
ID of D2-Config to fetch content assist configs |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#createInProces
POST Update the d2#createInProces
/repositories/{repoName}/in-process-objects/{id}
Create an object in process by updating the specified in-process object. Use this to finalize or modify an object that is being created in a process.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
repoName |
|
|
The r_object_id of queried object. |
|
|
Task Action. Possible values - FORWARD / REJECT / DELEGATE / ACQUIRE For Task Property Page Action. Possible values - FORWARD / REJECT For Workflow Status Action. Possible value - ABORT For Task Lifecycle check operation. Possible value - FORWARD / REJECT For Adding Audit Entry Action. Possible value - FORWARD / REJECT / EDIT_PROPERTIES / CHECKIN |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2#d2Configuration
GET Get the d2#d2Configurations
/repositories/{repositoryName}/d2-configurations
Retrieve all D2 configurations. Use this to list all available D2 configurations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#d2ContentUploadUrl
GET Get the d2#d2ContentUploadUrls
/repositories/{repositoryName}/objects/{objectId}/d2-content-upload-urls
Retrieve the content upload URLs for a specific object. Use this to get the URLs needed to upload content to an object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
integer/string |
|
|
It specifies the dm_format name for the content during document creation and content management. If this parameter is not specified, server will try to detect and determine the format according to the Content-Type provided for the primary content part in the multipart request and assign a format for the primary content. However, it might not be accurate always. |
|
|
It is the object id of the folder in which file should get linked. |
|
|
It is the name of the applicable O2 Config. This value will be taken from value configs. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#d2ExtractO2PropertiesUrl
GET Get the d2#d2ExtractO2PropertiesUrls
/repositories/{repositoryName}/d2-extract-o2-properties-urls
Retrieve the URLs for extracting O2 properties. Use this to get the URLs needed to extract properties from O2 documents.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
format |
|
|
object-type |
|
|
o2-config-name |
|
|
link-id |
|
|
content-size |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#dialog
GET Get the d2#dialog
/repositories/{repositoryName}/objects/{objectId}/dialog
Retrieve the dialog configuration for a specific object. Use this to get the dialog that is associated with an object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
dialog_type |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#dmTicket
GET Get the d2#dmTicket
/repositories/{repositoryName}/dm-ticket
Retrieve a Documentum ticket for authentication. Use this to get a ticket that can be used for subsequent requests.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
secure |
|
|
timeout |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#document (3)
DELETE Delete the d2#document
/repositories/{repositoryName}/documents/{id}
Permanently delete a specific document by its identifier. Use this to remove a document from the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Delete options for multi-version document object. selected - the version associated with the given object id will be removed. unused - means versions that do not have symbolic labels associated will be removed (in other hands, only have one numeric label); but v1.0 won't be deleted in this option. all - all revisions on the same version tree will be removed. |
|
|
Ensures whether virtual descendants is deleted this specified cabinet. true - deletes virtual document children that reside in different folders. false - for virtual document children that are linked to this specified folder, delete operation removes the child's link between the child and this folder. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#document
/repositories/{repositoryName}/documents/{id}
Retrieve a specific document by its identifier. Use this to get the details of a document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
includeContentURL |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2#document
/repositories/{repositoryName}/documents/{id}
Update an existing document with new properties or content. Use this to modify a document's metadata or content.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
template-name |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2#documentTemplate
GET Get the d2#documentTemplates
/repositories/{repositoryName}/objects/{id}/document-templates
Retrieve the document templates associated with a specific object. Use this to get templates that can be used to create documents based on the object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#folder (3)
DELETE Delete the d2#folder
/repositories/{repositoryName}/folders/{id}
Deletes a specified folder from the repository. Use this action to remove a folder and its contents permanently.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
del-vd-all |
|
|
Ensure whether allowing to delete non-empty cabinet or folder. true - indicates the deletion is on this cabinet/folder and all its descendants false - indicates the deletion is on this specified cabinet/folder only; deletion on a non-empty cabinet/folder will get an error |
|
|
Ensures whether multi-linked child is deleted or unlinked from this specified cabinet/folder. true - the multi-linked child is deleted along with all its folder links false - for multi-linked child, delete operation removes the child's folder link between the child and this folder. The child is still linked to other folder(s) |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#folder
/repositories/{repositoryName}/folders/{id}
Retrieves the details of a specific folder by its identifier. Use this action to view folder metadata and properties.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2#folder
/repositories/{repositoryName}/folders/{id}
Updates the properties of an existing folder. Use this action to modify folder attributes such as name or description.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2#folderChildDocument (2)
POST Create the d2#folderChildDocument
/repositories/{repositoryName}/folders/{folderId}/documents
Creates a new document within a specified folder. Use this action to upload or add a document as a child of the folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
folderId |
|
|
It specifies the dm_format name for the content during document creation and content management. If this parameter is not specified, server will try to detect and determine the format according to the Content-Type provided for the primary content part in the multipart request and assign a format for the primary content. However, this might not be accurate. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
GET Get the d2#folderChildDocuments
/repositories/{repositoryName}/folders/{folderId}/documents
Retrieves a list of all documents contained within a specified folder. Use this action to enumerate the documents in a folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
folderId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It specifies whether listing all versions of the child objects belong to the folder. When true:- it lists all versions of child objects When false:- it lists only the current version of child objects |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#folderChildFolder
POST Create the d2#folderChildFolder
/repositories/{repositoryName}/folders/{folderId}/d2-folders
Creates a new subfolder inside a specified parent folder. Use this action to build a folder hierarchy.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
folderId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2#folderChildObject (2)
POST Create the d2#folderChildObject
/repositories/{repositoryName}/folders/{folderId}/objects
Creates a new object (such as a document or folder) within a specified folder. Use this action to add any supported child object type to the folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
folderId |
|
|
It specifies the dm_format name for the content during document creation and content management. If this parameter is not specified, server will try to detect and determine the format according to the Content-Type provided for the primary content part in the multipart request and assign a format for the primary content. However, this might not be accurate. |
|
|
inherit_parent_acl |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
GET Get the d2#folderChildObjects
/repositories/{repositoryName}/folders/{folderId}/objects
Retrieves a list of all child objects within a specified folder. Use this action to view all items (documents, folders, etc.) contained in the folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
folderId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It specifies whether listing all versions of the child objects belong to the folder. When true:- it lists all versions of child objects When false:- it lists only the current version of child objects |
|
|
widgetName |
|
|
It specifies the type of the widget. |
|
|
viewMode |
|
|
filterPropName |
|
|
It is an optional parameter to be passed for locate type version and path (provided path should be complete). It is the object id to be located. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#folderCreatePropertyPage
GET Get the d2#folderCreatePropertyPage
/repositories/{repositoryName}/folder-creation-property-page
Retrieves the property page configuration used when creating a new folder. Use this action to obtain the dynamic form fields required for folder creation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
It specifies the object type of folder/cabinet/it's subtype |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#inbox
GET Get the d2#inbox
/repositories/{repositoryName}/d2-inbox
Retrieves the inbox items for the current user. Use this action to view tasks, workflows, or notifications assigned to the user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
task-category-ids |
|
|
widget-name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#landingPageConfiguration (2)
GET Get the d2#landingPageConfiguration
/repositories/{repositoryName}/d2-configurations/landing-page-configs
Retrieves all landing page configurations available in the repository. Use this action to list the available landing page setups.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#landingPageConfiguration
/repositories/{repositoryName}/d2-configurations/landing-page-configs/{configId}
Retrieves a specific landing page configuration by its identifier. Use this action to get the details of a particular landing page setup.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
configId of the landing page config |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#lcConditionsChecker
POST Update the d2#lcConditionsChecker
/repositories/{repositoryName}/d2-objects-lifecycle-conditions-checker
Checks and updates lifecycle conditions for specified objects. Use this action to validate and transition objects through lifecycle states based on conditions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the event name for which lifecycle transition should be triggered. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
An array of object identifiers whose lifecycle conditions will be checked. Provide the IDs of the objects to evaluate. |
|
|
The desired target lifecycle state to check conditions against. Specify the state name to transition towards. |
|
|
The property page configuration to use during condition checking. Provide the property page identifier if applicable. |
|
|
A token identifier for session or transaction context. Supply the token to associate with the operation. |
|
|
A warning message to display if conditions are not met. Provide a custom warning string. |
|
|
A hyperlink reference for navigation or callback. Supply a URL to be used after condition check. |
|
|
A boolean flag indicating whether to include deep copy logic. Set to true to process child objects recursively. |
|
|
A boolean flag indicating whether to replicate virtual document children. Set to true to include VD child objects. |
|
|
A boolean flag indicating whether to retain the original access control list. Set to true to keep existing ACLs. |
|
|
A label used for binding the lifecycle operation. Provide a string identifier for the binding. |
|
|
A boolean flag indicating whether to include objects with broken lifecycle states. Set to true to process objects in broken states. |
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2#lcState
PUT Put the d2#lcState
/repositories/{repositoryName}/d2-objects-lifecycle-state
Sets the lifecycle state for specified objects. Use this action to directly change the lifecycle state of one or more objects.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
An array of object identifiers whose lifecycle state will be updated. Provide the IDs of the objects to modify. |
|
|
The target lifecycle state to apply to the objects. Specify the desired state name. |
|
|
The property page configuration to use during state update. Provide the property page identifier if needed. |
|
|
A token identifier for session or transaction context. Supply the token to associate with the operation. |
|
|
A warning message to display when changing state. Provide a custom warning string. |
|
|
A hyperlink reference for navigation or callback. Supply a URL to be used after state update. |
|
|
A boolean flag indicating whether to apply the state change to child objects recursively. Set to true for deep copy. |
|
|
A boolean flag indicating whether to replicate the state change to virtual document children. Set to true to include VD children. |
|
|
A boolean flag indicating whether to retain the original access control list. Set to true to keep existing ACLs. |
|
|
A label used for binding the lifecycle state operation. Provide a string identifier for the binding. |
|
|
A boolean flag indicating whether to include objects with broken lifecycle states in the update. Set to true to process broken states. |
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2#linkedDocumentConfiguration
GET Get the d2#linkedDocumentConfigurations
/repositories/{repositoryName}/d2-configurations/linked-document-configurations
Retrieves all linked document configurations available in the repository. Use this action to list the configurations that define how documents are linked to other objects.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#lock (2)
DELETE Delete the d2#lock
/repositories/{repositoryName}/objects/{id}/lock
Remove the lock from a document object, allowing others to modify it.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the d2#lock
/repositories/{repositoryName}/objects/{id}/lock
Lock a document object to prevent others from modifying it.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#lockPrecheck
GET Get the d2#lockPrecheck
/repositories/{repositoryName}/objects/{id}/lock-precheck
Check whether a lock operation can be performed on the specified object without actually locking it.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#myWorkflow
GET Get the d2#myWorkflows
/repositories/{repositoryName}/d2-my-workflows
Retrieve the list of workflows assigned to the current user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Selected document Id one has to be passed |
|
|
The object id(s) of workflow process templates, used as filter to only return the WF belonging to these process templates. |
|
|
Array of wf-states [Ex:- wf-states=running&wf-states=paused]. Filter to return the WFs only in the requested states. The states include running, paused, finished, aborted, dormant [scheduled] |
|
|
Flag to specify if the response must include only the overdue entries. Where the entries are past the due date (Ex:- overdue workflows). |
|
|
Date parameter used as filter. To only filter the Workflows the got initiated afterem> the requested date. This param specifies the start range of the start date attribute. |
|
|
Date parameter used as filter. To only filter the Workflows the got initiated before the requested date. This param specifies the closing range of the start date attribute. |
|
|
To reflect the Column Preference in Doclist Widget of D2 in D2-REST quick Search, WidgetName should be passed as Query Param along with term. Example :- http:-//hostname/d2fs-rest/repositories/RepoName/quickSearch?term=test URIParams :- widgetName=WG Doclist QnM |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#object (4)
POST Create the d2#object
/repositories/{repositoryName}/objects/{id}
Create a new object with the specified ID within the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
DELETE Delete the d2#object
/repositories/{repositoryName}/objects/{id}
Permanently delete the specified object from the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
It deletes options for multi-version document object. unused - means versions that do not have symbolic labels associated will be removed (in other hands, only have one numeric label); but v1.0 won't be deleted in this option. all - all revisions on the same version tree will be removed. |
|
|
It ensures whether allowing to delete non-empty cabinet or folder. true - indicates the deletion is on this cabinet/folder and all its descendants. false - indicates the deletion is on this specified cabinet/folder only. Deletion on a non-empty cabinet/folder will get an error |
|
|
It ensures whether multi-linked child is deleted or unlinked from this specified cabinet/folder. true - the multi-linked child is deleted along with all its folder links false - for multi-linked child, delete operation removes the child's folder link between the child and this folder. The child is still linked to other folder(s) |
|
|
It ensures whether virtual descendants is deleted this specified cabinet. true - deletes virtual document children that reside in different folders. false - for virtual document children that are linked to this specified folder, delete operation removes the child's link between the child and this folder. @throws Exception |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#object
/repositories/{repositoryName}/objects/{id}
Retrieve the metadata and properties of the specified object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
includeContentURL |
|
|
It is the name of the d2 config widget. widget-type has to be passed along with this value. |
|
|
It is d2 config widget type. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Get the d2#object
/repositories/{repositoryName}/objects/{id}
Update specific properties of an existing object using partial modifications.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the Object id of the folder in which file should get linked |
|
|
It is the Object Id of the VD that has to be inherited. It is a mandatory request parameter. Child nodes will be added by applying the rules defined in the vd template on inherited VD set in the config. |
|
|
It indicates inheriting virtual document object or not. |
|
|
It is the Object Id of the preset profile value config. It is an optional request parameter. It is used for evaluation of setting a template for an object API. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2#objectCreation (4)
POST Update the d2#objectCreation
/repositories/{repositoryName}/create-object
Create a new object in the repository using default creation parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Specify the dm_format name for the content during document creation and content management. If this parameter is not specified, server will try to detect and determine the format according to the Content-Type provided for the primary content part in the multipart request and assign a format for the primary content. However, this is not guaranteed to be accurate. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2#objectCreation
/repositories/{repositoryName}/d2-object-creation
Create a new object in the repository with advanced configuration options such as profile, mode, and inheritance settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The custom-profile-name is the unique name provided by the user for the recently used profile. If user does not provide one system provides it.The custom-profile-name is optional. If user does not provide system provides and saves in DB. |
|
|
preset-profile-config-name is the name of the preset profile which is configured in d2 config matrix. |
|
|
preset-profile-value-name is the name of the preset profile value config name which is configured in d2 config. |
|
|
Name of the email attachment file which needs to be passed while creating attachment object |
|
|
User selected file name |
|
|
inprocess-object |
|
|
Indicates whether the object creation is for paste operation when single repository paste mode is enabled.The paste-mode parameter is required to be passed for paste operation when single repository paste mode is enabled. |
|
|
The r_object_id of copied object for paste operation when single repository paste mode is enabled. The source-object-id parameter is required to be passed for paste operation when single repository paste mode is enabled. |
|
|
Object Id of the profile selected by the user. |
|
|
Object Id of the profile value config, under a profile selected by the user. |
|
|
Content upload process. create - indicates creating a new document to docbase. import - indicates importing a document to docbase as a new document. |
|
|
Object Id of the VD that has to be inherited. |
|
|
Object id of the folder in which file should get linked |
|
|
Indicates inheriting content from another object or not. |
|
|
Indicates inheriting properties from another object or not. Will be set to "true" for Linked Document scenario |
|
|
Indicates inheriting virtual document object or not. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (13)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the profile to apply to the new object. |
|
|
The configuration ID for profile values used during object creation. |
|
|
The creation mode that determines how the object is created, such as "create" or "checkout". |
|
|
The ID of an existing object from which to inherit properties. |
|
|
The ID of a linked document to associate with the new object. |
|
|
A JSON string of extracted Office 365 properties to apply. |
|
|
When true, suppresses notifications for linked documents. |
|
|
The name of a custom profile to use instead of a profile ID. |
|
|
The name of a preset profile configuration. |
|
|
The name of a preset profile value. |
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
POST Update the d2#objectCreation
/repositories/{repositoryName}/object-creation
Create a new object in the repository using a simplified creation endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Specify the dm_format name for the content during document creation and content management. If this parameter is not specified, server will try to detect and determine the format according to the Content-Type provided for the primary content part in the multipart request and assign a format for the primary content. However, this is not guaranteed to be accurate. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
POST Update the d2#objectCreation
/repositories/{repositoryName}/objects/{objectId}/set-content
Set or replace the content of an existing object identified by its object ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectId of the set content |
|
|
Specify the dm_format name for the content during document creation and content management. If this parameter is not specified, server will try to detect and determine the format according to the Content-Type provided for the primary content part in the multipart request and assign a format for the primary content. However, this is not guaranteed to be accurate. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2#profileConfiguration (3)
GET Get the d2#profileConfiguration
/repositories/{repositoryName}/d2-configurations/creation-profiles/{profileId}
Retrieve the creation profile configuration for a specific profile ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
profileID of the creation profile |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#profileConfiguration
/repositories/{repositoryName}/d2-configurations/profile-configuration
Retrieve the list of all profile configurations available in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
mode |
|
|
inheritedId |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#profileConfiguration
/repositories/{repositoryName}/d2-configurations/profile-configurations/{profileId}
Retrieve a specific profile configuration by its profile ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
profileID of the profile configurations |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#propertyPage (2)
GET Get the d2#propertyPage
/repositories/{repositoryName}/objects/{id}/property-page
Retrieve the property page layout for a specific object, defining which properties are displayed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
editMode |
|
|
objectID to be specified |
|
|
The repository name. |
|
|
An optional query parameter to filter the list of actions. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#propertyPage
/repositories/{repositoryName}/property-page
Retrieve the default property page layout used for new objects.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
An optional query parameter to filter the list of actions. |
|
|
create/import profile mode configs |
|
|
object type of the document |
|
|
name of the property config configured in D2-Config |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#prviewUrl (4)
GET Get the d2#prviewUrls
/repositories/{repositoryName}/objects/{id}/download-url
Get a URL to download the content of a specific object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
Specifies the format name of the specific content or rendition. |
|
|
Specifies the page number of the specific content or rendition. |
|
|
Specifies the page modifier of the specific rendition. |
|
|
It specifies the Content ID of the portion. |
|
|
It is by default false. If passed as true, then it overrides the c2 rendition. It is a part of the request parameters. |
|
|
event-name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#prviewUrls
/repositories/{repositoryName}/objects/{id}/export-urls
Get URLs for exporting the object in various formats.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
Specifies the format name of the specific content or rendition. |
|
|
Specifies the page number of the specific content or rendition. |
|
|
Specifies the page modifier of the specific rendition. |
|
|
It specifies the Content ID of the portion. |
|
|
It is by default false. If passed as true, then it overrides the c2 rendition. It is a part of the request parameters. |
|
|
This parameter is passed to prevent API resources for giving BOCS/ACS URLs. This is applicable only if BOCS machines are configured for the App host machine. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#prviewUrls
/repositories/{repositoryName}/objects/{id}/preview-urls
Get URLs to preview the object content without downloading.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
Specifies the format name of the specific content or rendition. |
|
|
Specifies the page number of the specific content or rendition. |
|
|
Specifies the page modifier of the specific rendition. |
|
|
It specifies the Content ID of the portion. |
|
|
This parameter is passed to prevent API resources for giving BOCS/ACS URLs. This is applicable only if BOCS machines are configured for the App host machine |
|
|
include-page-serving-url |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#prviewUrls
/repositories/{repositoryName}/objects/{id}/print-urls
Get URLs for printing the object content.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
Specifies the format name of the specific content or rendition. |
|
|
Specifies the page number of the specific content or rendition. |
|
|
Specifies the page modifier of the specific rendition. |
|
|
It specifies the Content ID of the portion. |
|
|
It is the Controlled Field 1 input configured in C2 Print Config. |
|
|
It is the Controlled Field 2 input configured in C2 Print Config. |
|
|
It is the Controlled Field 3 input configured in C2 Print Config. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#relation (5)
DELETE Delete the d2#relation
/repositories/{repositoryName}/relations/{relationId}
Delete a specific relation by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
relationId |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#relation
/repositories/{repositoryName}/relations/{relationId}
Retrieve the details of a specific relation by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
relationId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#relations
/repositories/{repositoryName}/relations
Retrieve a list of all D2 relations available in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
object-type |
|
|
Only relations that contain an object whose object ID equals to the specified string are returned in the result. |
|
|
Indicates the role of the object specified by the object ID. (Only works when the related-object-id parameter is specified.) |
|
|
Only relations whose name equals to the specified string are returned in the result. Relation names are case sensitive. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2#relation
/repositories/{repositoryName}/relations
Create or update a D2 relation in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
POST Update the d2#relation
/repositories/{repositoryName}/relations/{relationId}
Update an existing D2 relation identified by its relation ID in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
relationId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2#search (2)
GET Get the d2#searches
/repositories/{repositoryName}/objects/{searchCategoryId}/searches
Retrieve a list of D2 searches for a specific search category within the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
ID of the search category |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#searches
/repositories/{repositoryName}/searches
Retrieve a list of all D2 searches available in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
search_category |
|
|
types |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#searchConfiguration (2)
GET Get the d2#searchConfiguration
/repositories/{repositoryName}/d2-configurations/search-configuration
Retrieve the D2 search configuration for the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#searchConfiguration
/repositories/{repositoryName}/d2-configurations/search-configuration/{configId}
Retrieve a specific D2 search configuration identified by its configuration ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
configId of the search configuration |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#signOffCredentialValidation
POST Update the d2#signOffCredentialValidation
/repositories/{repositoryName}/d2-signoff-credential-validation
Validate sign-off credentials by providing login, password, domain, intention, and optional nonce token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
It is the task inbox queue Id. |
|
|
It stands for external sign off initiation and cancellation. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The user login name for sign-off credential validation. |
|
|
The password associated with the sign-off user login. |
|
|
The domain for the sign-off user account. |
|
|
The intention or reason for the sign-off validation. |
|
|
An optional one-time token to use for the sign-off validation. |
D2#task (2)
GET Get the d2#task
/repositories/{repositoryName}/d2-tasks/{queueItemId}
Retrieve details of a specific D2 task identified by its queue item ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
queueItemId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Flag to indicate whether or not to include the workflow notes count in the response |
|
|
Flag to indicate whether or not to include the count of workflow supporting doc count |
|
|
To reflect the Column Preference in Doclist Widget of D2 in D2-REST quick Search, WidgetName should be passed as Query Param along with term. Example :- http:-//hostname/d2fs-rest/repositories/RepoName/quickSearch?term=test URIParams :- widgetName=WG Doclist QnM |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Get the d2#task
/repositories/{repositoryName}/d2-tasks/{queueItemId}
Update a specific D2 task with optional workflow metadata and next activity options.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
queueItemId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The number of notes associated with the workflow task. |
|
|
The number of working documents associated with the workflow task. |
|
|
The number of supporting documents associated with the workflow task. |
|
|
A boolean flag to disable notes for the workflow task. |
|
|
A boolean flag to disable supporting files for the workflow task. |
|
|
Provide additional properties for the audit event as a JSON string. |
|
|
A string specifying the next activities to forward the task to. |
|
|
A string specifying the next activities to reject the task to. |
D2#taskCategory
GET Get the d2#taskCategories
/repositories/{repositoryName}/d2-task-categories
Retrieve a list of all D2 task categories available in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Flag to decide whether or not to process Tasks (to create D2 Task folders for tasks/queue items for which categories have not been created and linked) Optional request parameter, default value is true |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#typeConfiguration (2)
GET Get the d2#typeConfiguration
/repositories/{repositoryName}/type-configuration
Retrieve the type configuration for the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
profileId |
|
|
config-id |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#typeConfiguration
/repositories/{repositoryName}/type-configuration/{typeId}
Retrieve a specific type configuration identified by its type ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
typeId of the Type Configuration |
|
|
profileId |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#vdsilentcheckin
POST Update the d2#vdsilentcheckin
/repositories/{repositoryName}/objects/{root-id}/d2-vd-silent-checkin
Perform a silent check-in for a virtual document identified by its root ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
root-id |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is a flag to specify if the descendants need to be checked-in or not. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#version
POST Create the d2#version
/repositories/{repositoryName}/objects/{chronicleId}/versions
Create a new version for an object identified by its chronicle ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
make-current |
|
|
format |
|
|
The repository name. |
|
|
version-policy |
|
|
chronicleId |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
The r_object_id of required sysobject. |
|
|
retain-lock |
|
|
comment |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2#virtualDocumentNode (2)
POST Create the d2#virtualDocumentNode
/repositories/{repositoryName}/objects/{objectId}/vd-nodes
Create a new virtual document node under the specified object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
GET Get the d2#virtualDocumentNodes
/repositories/{repositoryName}/objects/{objectId}/vd-nodes
Retrieve all virtual document nodes for the specified object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
The repository name. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
vdm-number |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
depth |
|
|
binding-label |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
A filter expression in a subset of XPath. |
|
|
The r_object_id of required sysobject. |
|
|
The r_object_id of required sysobject. |
|
|
include-broken |
|
|
follow-assembly |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#workflow (2)
GET Get the d2#workflows
/repositories/{repositoryName}/d2-workflows
Retrieve a list of all D2 workflows available in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
performer-name |
|
|
Selected document Id one has to be passed |
|
|
Specify the supervisor name as filter to only get those workflows where requested username is the supervisor |
|
|
The object id(s) of workflow process templates, used as filter to only return the WF belonging to these process templates. |
|
|
Array of wf-states [Ex:- wf-states=running&wf-states=paused]. Filter to return the WFs only in the requested states. The states include running, paused, finished, aborted, dormant [scheduled] |
|
|
Flag to specify if the response must include only the overdue entries. Where the entries are past the due date (Ex:- overdue workflows). |
|
|
Date parameter used as filter. To only filter the Workflows the got initiated afterem> the requested date. This param specifies the start range of the start date attribute. |
|
|
wf-start-date-range-to |
|
|
To reflect the Column Preference in Doclist Widget of D2 in D2-REST quick Search, WidgetName should be passed as Query Param along with term. Example :- http:-//hostname/d2fs-rest/repositories/RepoName/quickSearch?term=test URIParams :- widgetName=WG Doclist QnM |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2#workflow
/repositories/{repositoryName}/d2-workflows
Create or update a D2 workflow with specified configuration, documents, notes, and launch options.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the workflow configuration to use. |
|
|
An array of document IDs to be used as working documents in the workflow. |
|
|
An array of document IDs to be used as supporting documents in the workflow. |
|
|
A note or comment to attach to the workflow. |
|
|
The name to assign to the workflow. |
|
|
The date and time when the workflow should be launched. |
|
|
A boolean flag indicating whether to send a notification upon launch. |
|
|
The date and time for the workflow follow-up. |
|
|
A string containing process variables for the workflow. |
D2#workflow_supporting_document (3)
DELETE Delete the d2#workflow_supporting_documents
/repositories/{repositoryName}/d2-workflows/{trackerId}/supporting-documents
Delete all supporting documents from a D2 workflow identified by its tracker ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Task inbox queue Id |
|
|
The object id(s) of the object whose actions are required. Object ids can be passed in one of the following formats:- object-ids= object-ids=&object-ids=&object-ids= |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2#workflow_supporting_documents
/repositories/{repositoryName}/d2-workflows/{trackerId}/supporting-documents
Retrieve a list of supporting documents for a specific workflow tracker.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Task inbox queue Id |
|
|
To reflect the Column Preference in Doclist Widget of D2 in D2-REST quick Search, WidgetName should be passed as Query Param along with term. Example :- http:-//hostname/d2fs-rest/repositories/RepoName/quickSearch?term=test URIParams :- widgetName=WG Doclist QnM |
|
|
The workflow overview widget name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2#workflow_supporting_document
/repositories/{repositoryName}/d2-workflows/{trackerId}/supporting-documents
Add or update a supporting document for a workflow tracker.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Task inbox queue Id |
|
|
The object id(s) of the object whose actions are required. Object ids can be passed in one of the following formats:- object-ids= object-ids=&object-ids=&object-ids= |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2#workflow_working_document
GET Get the d2#workflow_working_documents
/repositories/{repositoryName}/d2-workflows/{trackerId}/working-documents
Retrieve a list of working documents for a specific workflow tracker.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the task inbox queue Id. |
|
|
It is the name of the d2 config widget. widget-type has to be passed along with this value. |
|
|
It is the workflow overview widget name. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2AccessorRemover
PATCH Get the d2AccessorRemover
/repositories/{repositoryName}/objects/{object-id}/d2-accessor-remover
Remove accessors from an object by applying a patch operation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
It determines if search can be within the sub-folders of current folder. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2AccessorReplacement
PATCH Get the d2AccessorReplacement
/repositories/{repositoryName}/objects/{object-id}/d2-accessor-replacement
Replace accessors on an object by applying a patch operation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
Determines if search can be within subfolders of current folder. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2AsyncObjectController
GET Get the d2AsyncObjectController
/repositories/{repositoryName}/d2-async-operations/{objectId}
Retrieve the status or details of an asynchronous operation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2Cabinet (5)
POST Create the d2Cabinet
/repositories/{repositoryName}/d2-cabinets
Create a new cabinet in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
DELETE Delete the d2Cabinet
/repositories/{repositoryName}/d2-cabinets/{id}
Permanently delete a specific cabinet.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Ensure whether allowing to delete non-empty cabinet or folder. true - indicates the deletion is on this cabinet/folder and all its descendants false - indicates the deletion is on this specified cabinet/folder only; deletion on a non-empty cabinet/folder will get an error |
|
|
Ensures whether multi-linked child is deleted or unlinked from this specified cabinet/folder. true - the multi-linked child is deleted along with all its folder links false - for multi-linked child, delete operation removes the child's folder link between the child and this folder. The child is still linked to other folder(s) |
|
|
Ensures whether virtual descendants is deleted this specified cabinet. true - deletes virtual document children that reside in different folders. false - for virtual document children that are linked to this specified folder, delete operation removes the child's link between the child and this folder. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2Cabinet
/repositories/{repositoryName}/d2-cabinets/{id}
Retrieve details of a specific cabinet.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Name of the widget to fetch the user preference columns of the logged in user. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2Cabinets
/repositories/{repositoryName}/d2-cabinets
Retrieve a list of all cabinets in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
widget-name |
|
|
view-mode |
|
|
custom-filter-property-name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2Cabinet
/repositories/{repositoryName}/d2-cabinets/{id}
Update the properties of an existing cabinet.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2CheckedOutObject
GET Get the d2CheckedOutObjects
/repositories/{repositoryName}/checked-out-objects
Retrieve a list of all objects currently checked out.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
The repository name. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
A filter expression in a subset of XPath. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
include-all-versions |
|
|
checked-out-by |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
It is the Name of the d2 config widget. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ChildFolderLink (4)
POST Create the d2ChildFolderLink
/repositories/{repositoryName}/folders/{objectId}/child-links
Create a child folder link between a parent folder and a child object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
A hyperlink reference for navigation or callback. Supply a URL to be used after state update. |
|
|
Specifies the identifier of the child object to link. |
|
|
Specifies the identifier of the parent folder. |
DELETE Delete the d2ChildFolderLink
/repositories/{repositoryName}/folders/{parentFolderId}/child-links/{objectId}
Delete a specific child folder link.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
parentFolderId |
|
|
The r_object_id of required sysobject. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2ChildFolderLink
/repositories/{repositoryName}/folders/{parentFolderId}/child-links/{objectId}
Retrieve details of a specific child folder link.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
parentFolderId |
|
|
The r_object_id of required sysobject. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2ChildFolderLinks
/repositories/{repositoryName}/folders/{objectId}/child-links
Retrieve all child folder links for a specific folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It specifies whether listing all versions of the child objects belong to the folder. Since it is false, it lists only the current version of child objects. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ColumnPreference (3)
GET Get the d2ColumnPreferences
/repositories/{repositoryName}/d2-preferences/column-preferences
Retrieve all column preferences for the current user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
d2 config widget type |
|
|
Name of the d2 config widget, widget-type has to be passed along with this value |
|
|
default col type of a widget |
|
|
include-widget-info |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2ColumnPreferences
/repositories/{repositoryName}/d2-preferences/column-preferences/{colType}
Retrieve column preferences for a specific column type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
column type |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the d2ColumnPreference
/repositories/{repositoryName}/d2-preferences/column-preferences/{colType}
Update or replace column preferences for a specific column type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
column type |
|
|
create-if-absent |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Specifies the column type identifier for which preferences are being set. |
D2Content (3)
POST Create the d2Content
/repositories/{repositoryName}/queryFormSearch
Perform a form-based search and create a query result set.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
GET Get the d2Content
/repositories/{repositoryName}/objects/{queryId}/execute
Execute a previously created query and retrieve the results.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
QueryId of the object |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
process_facets |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2Content
/repositories/{repositoryName}/users/{userName}/lastSearch
Retrieve the last search results for a specific user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
userName for lastSearch |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ContentCheckinUrl
GET Get the d2ContentCheckinUrls
/repositories/{repositoryName}/objects/{objectId}/d2-content-checkin-urls
Retrieve check-in URLs for uploading content to an object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Using this flag, the user can still put a lock on the old object (the object which is used to check-in). |
|
|
Using this flag, response will be having auth-tokens properties as well. The auth-tokens will be containing the cookies which are there in the request headers. It will consider DOCUMENTUM-CLIENT-TOKEN and D2-CORE-TOKENS cookies. |
|
|
Name of the applicable checkin config. |
|
|
Size of the file in bytes |
|
|
Specify the dm_format name for the content during document creation and content management. If this parameter is not specified, server will try to detect and determine the format according to the Content-Type provided for the primary content part in the multipart request and assign a format for the primary content. However, this is not guaranteed to be accurate. |
|
|
Name of the external-share-system (currently only 'core' is supported). |
|
|
Name of the target external-share-system (currently only 'core' is supported). |
|
|
Name of share. Default value will be - "default". |
|
|
C2 Override flag. This will override C2 behaviour. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2CreationProfile
GET Get the d2CreationProfiles
/repositories/{repositoryName}/d2-creation-profiles
Retrieve all creation profiles available in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Content upload process. create - indicates creating a new document to docbase. import - indicates importing a document to docbase as a new document. |
|
|
Current selected Folder object Id or Document object Id has to be passed. This "inherited-id" will be used to fetch the all default properties values for the properties dialog. For D2 creation profiles API, This inherited-id will be used to find the profile related to "“Folder properties used for creation" or "Extended creation profiles". |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2CreationProfileValueConfig (2)
GET Get the d2CreationProfileValueConfigs
/repositories/{repositoryName}/d2-configurations/creation-profiles/{profileId}/value-configs
Retrieve value configurations for a specific creation profile.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
profileId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
format |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2CreationProfileValueConfigs
/repositories/{repositoryName}/d2-configurations/creation-profiles/{profileId}/value-configs/{configId}
Retrieve the d2 creation profile value configuration for a specific profile and config within a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
configID of the creation profile |
|
|
profileId |
|
|
format |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2CreationPropertiesPage (2)
GET Get the d2CreationPropertiesPage
/repositories/{repositoryName}/d2-creation-properties-page
Retrieve the d2 creation properties page configuration for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
It indicates whether the linked document process is available or not. This parameter will be passed as true in case of fetching property page dialog for linked document scenario. |
|
|
It indicates whether the object creation is for paste operation when single repository paste mode is enabled. The paste-mode parameter should be mandatorily passed for paste operation when single repository paste mode is enabled. |
|
|
It is the r_object_id of copied object for paste operation when single repository paste mode is enabled. The source-object-id parameter should be mandatorily passed for paste operation when single repository paste mode is enabled. |
|
|
It has two values - create and import where create is default. For Content upload process; create indicates creating a new document to docbase, and indicates importing a document to docbase as a new document. |
|
|
It is the Object Id of the profile selected by the user. It is a mandatory request parameter is used to get the Dictionary values mapped with the profile while loading property page dialog. |
|
|
It is the Object Id of the profile value config, under a profile selected by the user. It is a mandatory request parameter and used to get the property page, O2 Config, default value template, inheritance while loading property page dialog. |
|
|
It is the Object Id of the VD that has to be inherited. It is a mandatory request parameter. Child nodes will be added by applying the rules defined in the vd template on inherited VD set in the config. |
|
|
It states the name of the file to be downloaded. If the filename is not mentioned, then by default, it will be downloaded as 'download.zip'. |
|
|
It indicates whether the properties are inherited from another object or not. It is set to 'true' for Linked Document scenario. |
|
|
It indicates whether the content is inherited from another object or not. |
|
|
It indicates whether virtual document object is inherited or not. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2CreationPropertiesPage
/repositories/{repositoryName}/d2-creation-properties-page
Update the d2 creation properties page configuration for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
It indicates whether virtual document object is inherited or not. |
|
|
It indicates whether the linked document process is available or not. This parameter will be passed as true in case of fetching property page dialog for linked document scenario. |
|
|
It ensures whether link relations are to be returned for this object representation. When it's true:- it returns links for the object. When it's false:- it does not return links for the object. |
|
|
It has two values - create and import where create is default. For Content upload process; create indicates creating a new document to docbase, and indicates importing a document to docbase as a new document. |
|
|
It is the Object Id of the profile selected by the user. It is a mandatory request parameter is used to get the Dictionary values mapped with the profile while loading property page dialog. |
|
|
It is the Object Id of the profile value config, under a profile selected by the user. It is a mandatory request parameter and used to get the property page, O2 Config, default value template, inheritance while loading property page dialog. |
|
|
It is the Object Id of the VD that has to be inherited. It is a mandatory request parameter. Child nodes will be added by applying the rules defined in the vd template on inherited VD set in the config. |
|
|
It states the name of the file to be downloaded. If the filename is not mentioned, then by default, it will be downloaded as 'download.zip'. |
|
|
It indicates whether the properties are inherited from another object or not. It is set to 'true' for Linked Document scenario. |
|
|
It indicates whether the content is inherited from another object or not. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
A JSON string of extracted Office 365 properties to apply. |
D2Delegation (6)
POST Create the d2Delegation
/repositories/{repositoryName}/users/{userName}/delegations
Create a new delegation for a specific user in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
userName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
DELETE Delete the d2Delegation
/repositories/{repositoryName}/users/{userName}/delegations/{delegationId}
Delete an existing delegation for a user in a repository using the delegation ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
delegationId |
|
|
userName |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2Delegation
/repositories/{repositoryName}/users/{userName}/delegations
Retrieve all delegations for a specific user in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
userName |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2Delegation
/repositories/{repositoryName}/users/{userName}/delegations/{delegationId}
Retrieve a specific delegation for a user in a repository using the delegation ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
delegationId |
|
|
userName |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the d2Delegation
/repositories/{repositoryName}/users/{userName}/delegations/{delegationId}
Update an existing delegation for a user in a repository using the delegation ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
delegationId |
|
|
userName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
PUT Put the d2Delegation
/repositories/{repositoryName}/users/{userName}/delegations/{delegationId}/undo
Undo a delegation for a user in a repository using the delegation ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
delegationId |
|
|
userName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2DigitalSignature (3)
GET Get the d2DigitalSignature
/repositories/{repositoryName}/d2-digital-signatures/{signatureRequestID}
Retrieve the digital signature details for a specific signature request ID in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
signatureRequestID |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the d2DigitalSignature
/repositories/{repositoryName}/d2-digital-signatures/{signatureRequestID}
Update the digital signature for a specific signature request ID in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
signatureRequestID |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
signature-provider |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2DigitalSignature
/repositories/{repositoryName}/d2-digital-signatures
Create or update a digital signature request in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Name of the digital signature provider |
|
|
Task inbox queue Id |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The status of the digital signature request, such as 'pending' or 'completed'. |
|
|
The subject of the preference. |
|
|
An optional message to include with the digital signature request. |
|
|
The URL used to prepare the digital signature, if applicable. |
|
|
The ID of the workflow tracker associated with the signature request. |
D2DigitalSignatureDocumentsValidator
GET Get the d2DigitalSignatureDocumentsValidator
/repositories/{repositoryName}/d2-digital-signature-documents-validator
Retrieve the digital signature documents validator configuration for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
signature-provider |
|
|
It is the object id(s) of the object whose actions are required. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2DigitalSignatureSignee
GET Get the d2DigitalSignatureSignees
/repositories/{repositoryName}/d2-tasks/{taskId}/d2-digital-signature-signees
Retrieve the digital signature signees for a specific task in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2DisplayType (2)
GET Get the d2DisplayType
/repositories/{repositoryName}/d2-display-types/{typeName}
Retrieve a specific display type configuration by type name in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
typeName of the D2-display-type |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2DisplayTypes
/repositories/{repositoryName}/d2-display-types
Retrieve all display type configurations in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2DqlDoclist
GET Get the d2DqlDoclist
/repositories/{repositoryName}/dql-doclist-objects
Retrieve the DQL document list objects for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It reflects the Column Preference in Doclist Widget of D2 in D2-REST quick Search. WidgetName should be passed as Query Param along with term. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2Dump
GET Get the d2Dump
/repositories/{repositoryName}/d2-dump
Retrieve the dump data for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The r_object_id of required sysobject. |
|
|
Flag to include config in dump response.(Valid only when sent along with object-id parameter) Optional request parameter. This flag will specify whether the config values to be shown in response or not. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2EmailAttachment
GET Get the d2EmailAttachments
/repositories/{repositoryName}/objects/{objectId}/d2-email-attachments
Retrieve the email attachments for a specific object in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ExtSignOffAuditEvent
POST Update the d2ExtSignOffAuditEvent
/repositories/{repositoryName}/d2-ext-sign-off-audit-event
Update the external sign-off audit event in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
This is the action to be audited. For example, for task e-sign off pop up comes then audit-action will be EXT_SIGN_OFF_INITIATE. If the user press cancel or close the pop up then it will be EXT_SIGN_OFF_CANCEL Possible Values:-- EXT_SIGN_OFF_INITIATE / EXT_SIGN_OFF_CANCEL |
|
|
Task Action. Possible values - FORWARD / REJECT / DELEGATE / ACQUIRE For Task Property Page Action. Possible values - FORWARD / REJECT For Workflow Status Action. Possible value - ABORT For Task Lifecycle check operation. Possible value - FORWARD / REJECT For Adding Audit Entry Action. Possible value - FORWARD / REJECT / EDIT_PROPERTIES / CHECKIN |
|
|
This is applicable only in the case of the action:- FORWARD or REJECT This should be the master document id (working document id) where the external e-sign off happens. @throws Exception |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2Favorite (3)
POST Create the d2Favorite
/repositories/{repositoryName}/favorites
Create a new favorite for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
DELETE Delete the d2Favorites
/repositories/{repositoryName}/favorites/{objectId}
Delete a favorite by object ID in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectId to be specified |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2Favorites
/repositories/{repositoryName}/favorites
Retrieve all favorites for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
widget-name |
|
|
include-all-versions |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2FavoritesChecker
GET Get the d2FavoritesChecker
/repositories/{repositoryName}/favorites-checker
Retrieve the favorites checker configuration for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
object-ids |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2GenericActionService
POST Update the d2GenericActionService
/repositories/{repositoryName}/d2-generic-action-service
Execute a generic action service update in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
service_name |
|
|
method_name |
|
|
object_ids |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide additional properties for the audit event as a JSON string. |
D2GenericDialog
POST Update the d2GenericDialog
/repositories/{repositoryName}/d2-generic-dialog/{dialogName}
Update the specified generic dialog configuration in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
dialogName |
|
|
Task Action. Possible values - FORWARD / REJECT / DELEGATE / ACQUIRE For Task Property Page Action. Possible values - FORWARD / REJECT For Workflow Status Action. Possible value - ABORT For Task Lifecycle check operation. Possible value - FORWARD / REJECT For Adding Audit Entry Action. Possible value - FORWARD / REJECT / EDIT_PROPERTIES / CHECKIN |
|
|
object_ids |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide additional properties for the audit event as a JSON string. |
D2InheritanceConfig
GET Get the d2InheritanceConfigs
/repositories/{repositoryName}/d2-configurations/inheritance-configs
Retrieve all inheritance configurations for the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
include-all-versions |
|
|
object-name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2LifecycleChangeStatePropertyPage
POST Update the d2LifecycleChangeStatePropertyPage
/repositories/{repositoryName}/d2-lifecycle-change-state-property-page
Update the lifecycle change state property page configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
An array of object identifiers whose lifecycle state will be updated. Provide the IDs of the objects to modify. |
|
|
The target lifecycle state to apply to the objects. Specify the desired state name. |
|
|
The property page configuration to use during state update. Provide the property page identifier if needed. |
|
|
A token identifier for session or transaction context. Supply the token to associate with the operation. |
|
|
A warning message to display when changing state. Provide a custom warning string. |
|
|
A hyperlink reference for navigation or callback. Supply a URL to be used after state update. |
|
|
A boolean flag indicating whether to apply the state change to child objects recursively. Set to true for deep copy. |
|
|
A boolean flag indicating whether to replicate the state change to virtual document children. Set to true to include VD children. |
|
|
A boolean flag indicating whether to retain the original access control list. Set to true to keep existing ACLs. |
|
|
A label used for binding the lifecycle state operation. Provide a string identifier for the binding. |
|
|
A boolean flag indicating whether to include objects with broken lifecycle states in the update. Set to true to process broken states. |
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2MassupdateConfig
GET Get the d2MassupdateConfig
/repositories/{repositoryName}/d2-configurations/massupdate-configs/{configId}
Retrieve a specific mass update configuration by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
configId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2MassupdateFolderValidation
POST Update the d2MassupdateFolderValidation
/repositories/{repositoryName}/d2-massupdate-folder-validation
Update the folder validation for a mass update operation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Whether the massupdate config validaton is to be done inside subfolders. Default false |
|
|
Configuration ID based on which end user will perform the operation. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of object identifiers whose lifecycle state will be updated. Provide the IDs of the objects to modify. |
D2MassupdateObjectsValidation
POST Update the d2MassupdateObjectsValidation
/repositories/{repositoryName}/d2-massupdate-objects-validation
Update the objects validation for a mass update operation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
There are only two possible values for this - FILE and FOLDER. |
|
|
It tells whether the massupdate config validaton is to be done inside the subfolders. The default value is false. |
|
|
It tells whether the massupdate config validaton will be applied to virtual document descendants. The default value is false. |
|
|
It is the configuration ID based on which end user will perform the operation. |
|
|
It specifies whether listing all versions of the child objects belong to the folder. When true, it lists all versions of child objects. When false, it lists only the current version of child objects. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of object identifiers whose lifecycle state will be updated. Provide the IDs of the objects to modify. |
D2MassupdatePropertiesPage
POST Update the d2MassupdatePropertiesPage
/repositories/{repositoryName}/d2-massupdate-properties-page
Update the properties page for a mass update operation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
config-id |
|
|
An optional query parameter to filter the list of actions. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of object identifiers whose lifecycle state will be updated. Provide the IDs of the objects to modify. |
D2MassupdateProperty
PATCH Get the d2MassupdateProperties
/repositories/{repositoryName}/d2-massupdate-properties
Retrieve the mass update properties configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Configuration ID based on which end user will perform the operation. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of object identifiers whose lifecycle state will be updated. Provide the IDs of the objects to modify. |
D2MyWorkflowSummaryController
GET Get the d2MyWorkflowSummaryController
/repositories/{repositoryName}/d2-my-workflows/status-summary
Retrieve a summary of the statuses of workflows assigned to the current user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the name of the d2 config widget. widget-type has to be passed along with this value. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2MyWorkflowsCount
GET Get the d2MyWorkflowsCount
/repositories/{repositoryName}/d2-my-workflows/count
Retrieve the count of workflows assigned to the current user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the selected document Id one has to be passed |
|
|
It is the object id(s) of workflow process templates, used as filter to only return the WF belonging to these process templates. |
|
|
It is an array of wf-states [Ex:- wf-states=running&wf-states=paused]. Filter to return the WFs only in the requested states. The states include running, paused, finished, aborted, dormant [scheduled] |
|
|
It is a flag to specify if the response must include only the overdue entries and where the entries are past the due date (Ex:- overdue workflows). |
|
|
It is a date parameter used as filter. To only filter the Workflows the got initiated afterem> the requested date. This param specifies the start range of the start date attribute. |
|
|
It is a date parameter used as filter. To only filter the Workflows the got initiated before the requested date. This param specifies the closing range of the start date attribute. |
|
|
It is the name of the d2 config widget. widget-type has to be passed along with this value. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2Note (2)
GET Get the d2Notes
/repositories/{repositoryName}/d2-workflows/{trackerId}/notes
Retrieve all notes associated with a specific workflow tracker.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is a task inbox queue Id. |
|
|
top-records |
|
|
It is used to filter the response w.r.t the value. The values can be task or workflow. |
|
|
It is the workflow overview widget name. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2Note
/repositories/{repositoryName}/d2-workflows/{trackerId}/notes
Update an existing note for a workflow tracker.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
It is a task inbox queue Id. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The object ID of the note to update, expected as a string. |
D2ObjectCheckinConfig
GET Get the d2ObjectCheckinConfig
/repositories/{repositoryName}/objects/{objectId}/d2-object-checkin-config
Retrieve the check-in configuration for a specific object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ObjectChronicleVersionLabel
GET Get the d2ObjectChronicleVersionLabels
/repositories/{repositoryName}/objects/{chronicleId}/d2-object-chronicle-version-labels
Retrieve version labels for all versions of a chronicle object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
chronicleId |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ObjectLinkeddocumentConfig
GET Get the d2ObjectLinkeddocumentConfig
/repositories/{repositoryName}/objects/{objectId}/d2-object-linkeddocument-config
Retrieve the linked document configuration for a specific object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ObjectRelation (2)
GET Get the d2ObjectRelations
/repositories/{repositoryName}/objects/{objectId}/d2-object-relations
Retrieve all relations for a specific object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
objectID |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
The repository name. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
A filter expression in a subset of XPath. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2ObjectRelation
/repositories/{repositoryName}/objects/{parentId}/d2-object-relations
Update or create a relation for a parent object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
parentId of the objects |
|
|
reverse-relation |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2ObjectVersion
GET Get the d2ObjectVersions
/repositories/{repositoryName}/objects/{chronicleId}/versions
Retrieve all versions of a chronicle object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
The repository name. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
version-label |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
A filter expression in a subset of XPath. |
|
|
chronicleId |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The r_object_id of required sysobject. |
|
|
latest-versions-only |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
Name of the d2 config widget,widget-type has to be passed along with this value |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ObjectView (4)
GET Get the d2ObjectView
/repositories/{repositoryName}/objects/{id}/audits
Retrieve audit records for a specific object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
date_format |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2ObjectView
/repositories/{repositoryName}/objects/{id}/views/c2-export
Retrieve the C2 export view configuration for a specific object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2ObjectView
/repositories/{repositoryName}/objects/{id}/views/c2-print
Retrieve the C2 print view configuration for a specific object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
It is the Controlled Field 1 input configured in C2 Print Config. |
|
|
It is the Controlled Field 2 input configured in C2 Print Config. |
|
|
It is the Controlled Field 3 input configured in C2 Print Config. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2ObjectView
/repositories/{repositoryName}/objects/{id}/views/c2-view
Retrieve the C2 view configuration for a specific object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ObjectsFacet
POST Create the d2ObjectsFacet
/repositories/{repositoryName}/folders/{folderId}/objects-facets
Creates a new objects facet for the specified folder. Use this action to add a facet configuration that defines how objects are categorized and displayed within a folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
folderId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It determines whether the facets should be returned along with search results |
|
|
process-facets-only |
|
|
It specifies whether listing all versions of the child objects belong to the folder. When true:- it lists all versions of child objects When false:- it lists only the current version of child objects |
|
|
It is the name of the d2 config widget. The widget-type has to be passed along with this value. |
|
|
It is d2 config widget type. |
|
|
viewMode |
|
|
A filter expression in a subset of XPath. |
|
|
It specifies the custom attribute name being used for filtering. Filtering on only one attribute is supported. This is not required to be specified for dm_sysobject attributes. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the facet configuration to create. |
|
|
The title of the preference. |
|
|
The timestamp indicating when the facet configuration was last updated. |
|
|
The page number for paginated retrieval of facet entries. |
|
|
The number of items to return per page for facet entries. |
|
|
The total number of entries in the facet configuration. |
|
|
An array of hypermedia links related to the facet configuration. |
|
|
An array of authors associated with the facet configuration. |
|
|
An array of entry objects that define the facet values and criteria. |
D2ObjectsLifecycleConfig
POST Update the d2ObjectsLifecycleConfig
/repositories/{repositoryName}/d2-objects-lifecycle-configs
Updates an existing objects lifecycle configuration in the repository. Use this action to modify lifecycle states, transitions, or policies for objects.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
evaluate-config-homogeneity |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
An array of object identifiers whose lifecycle state will be updated. Provide the IDs of the objects to modify. |
|
|
The target lifecycle state to apply to the objects. Specify the desired state name. |
|
|
The property page configuration to use during state update. Provide the property page identifier if needed. |
|
|
A token identifier for session or transaction context. Supply the token to associate with the operation. |
|
|
A warning message to display when changing state. Provide a custom warning string. |
|
|
A hyperlink reference for navigation or callback. Supply a URL to be used after state update. |
|
|
A boolean flag indicating whether to apply the state change to child objects recursively. Set to true for deep copy. |
|
|
A boolean flag indicating whether to replicate the state change to virtual document children. Set to true to include VD children. |
|
|
A boolean flag indicating whether to retain the original access control list. Set to true to keep existing ACLs. |
|
|
A label used for binding the lifecycle state operation. Provide a string identifier for the binding. |
|
|
A boolean flag indicating whether to include objects with broken lifecycle states in the update. Set to true to process broken states. |
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2ObjectsPreviewFormat
GET Get the d2ObjectsPreviewFormat
/repositories/{repositoryName}/d2-objects-preview-format
Retrieves the preview format configuration for objects in the repository. Use this action to obtain the settings that define how object previews are generated and displayed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The object id(s) of the object whose actions are required. Object ids can be passed in one of the following formats:- object-ids= object-ids=&object-ids=&object-ids= |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ObjectsRelationsCount
GET Get the d2ObjectsRelationsCount
/repositories/{repositoryName}/d2-objects-relations-count
Retrieves the count of relationships associated with objects in the repository. Use this action to get the number of related objects for display or validation purposes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It gives the object id(s) of the object whose actions are required. Object ids can be passed in one of the following formats:- object-ids= object-ids=&object-ids=&object-ids= |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ObjectsSpecificPermission
GET Get the d2ObjectsSpecificPermission
/repositories/{repositoryName}/objects-specific-permission
Retrieves the specific permission settings for objects in the repository. Use this action to check the exact permissions assigned to a particular object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The object id(s) of the object whose actions are required. Object ids can be passed in one of the following formats:- object-ids= object-ids=&object-ids=&object-ids= |
|
|
permission-level |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2Option
GET Get the d2Options
/repositories/{repositoryName}/d2-configurations/d2-options
Retrieves the D2 options configuration for the repository. Use this action to obtain global settings that affect D2 behavior and appearance.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ParentFolderLink (5)
POST Create the d2ParentFolderLink
/repositories/{repositoryName}/objects/{objectId}/parent-links
Creates a parent folder link for the specified object. Use this action to establish a direct parent-child relationship between an object and a folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
A hyperlink reference for navigation or callback. Supply a URL to be used after state update. |
|
|
Specifies the identifier of the child object to link. |
|
|
Specifies the identifier of the parent folder. |
DELETE Delete the d2ParentFolderLink
/repositories/{repositoryName}/objects/{objectId}/parent-links/{parentFolderId}
Deletes a specific parent folder link from an object. Use this action to remove the association between an object and its parent folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
parentFolderId |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2ParentFolderLink
/repositories/{repositoryName}/objects/{objectId}/parent-links/{parentFolderId}
Retrieves a specific parent folder link for an object. Use this action to view the details of a particular parent folder association.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
parentFolderId |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2ParentFolderLinks
/repositories/{repositoryName}/objects/{objectId}/parent-links
Retrieves all parent folder links for an object. Use this action to list all folders that are linked as parents to the specified object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the d2ParentFolderLink
/repositories/{repositoryName}/objects/{objectId}/parent-links/{parentFolderId}
Updates an existing parent folder link for an object. Use this action to modify the properties of a parent folder association.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
parentFolderId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
A hyperlink reference for navigation or callback. Supply a URL to be used after state update. |
|
|
Specifies the identifier of the child object to link. |
|
|
Specifies the identifier of the parent folder. |
D2PerformerAliasParticipant
GET Get the d2PerformerAliasParticipants
/repositories/{repositoryName}/d2-performer-alias-participants
Retrieves the performer alias participants configuration. Use this action to obtain the list of participants that can be assigned as performer aliases in workflows.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
An optional query parameter to filter the list of actions. |
|
|
Selected document Id one has to be passed |
|
|
Workflow configuration name |
|
|
Participant attribute selected in Participant structure Workflow config |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2PermissionSet
GET Get the d2PermissionSet
/repositories/{repositoryName}/objects/{objectId}/d2-permission-set
Retrieves the permission set for a specific object. Use this action to view the access rights and permissions applied to the object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The object id of the accessor. Accessor can be user or group or can be role as well. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2PresetProfile (2)
GET Get the d2PresetProfile
/repositories/{repositoryName}/d2-preset-profiles/{presetProfileName}
Retrieves a specific preset profile by name. Use this action to obtain the details of a predefined profile that controls object display and behavior.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
presetProfileName of the d2-preset-profile |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2PresetProfiles
/repositories/{repositoryName}/d2-preset-profiles
Retrieves all preset profiles available in the repository. Use this action to list the predefined profiles that can be applied to objects.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2PresetProfileValueConfig (2)
GET Get the d2PresetProfileValueConfig
/repositories/{repositoryName}/d2-preset-profiles/{presetProfileName}/value-configs/{presetProfileValueConfigName}
Retrieves a specific value configuration within a preset profile. Use this action to view the settings for a particular attribute value in the profile.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
specify Preset Profile Config Name |
|
|
specify Preset Profile Name |
|
|
Content upload process. create - indicates creating a new document to docbase. import - indicates importing a document to docbase as a new document. |
|
|
Current selected Folder object Id or Document object Id has to be passed. This "inherited-id" will be used to fetch the all default properties values for the properties dialog. For D2 creation profiles API, This inherited-id will be used to find the profile related to "Folder properties used for creation" or "Extended creation profiles". |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2PresetProfileValueConfigs
/repositories/{repositoryName}/d2-preset-profiles/{presetProfileName}/value-configs
Retrieves all value configurations for a preset profile. Use this action to list the attribute value settings defined in the profile.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
presetProfileName |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Content upload process. create - indicates creating a new document to docbase. import - indicates importing a document to docbase as a new document. |
|
|
Current selected Folder object Id or Document object Id has to be passed. This "inherited-id" will be used to fetch the all default properties values for the properties dialog. For D2 creation profiles API, This inherited-id will be used to find the profile related to "Folder properties used for creation" or "Extended creation profiles". |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2Print (2)
GET Get the d2Print
/repositories/{repositoryName}/objects/{objectId}/d2-print
Retrieves the print configuration for a specific object. Use this action to obtain the print settings and templates associated with the object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2Print
/repositories/{repositoryName}/objects/{objectId}/d2-print
Updates the print configuration for a specific object. Use this action to modify print settings, such as dialog content, for the object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The content of the print dialog that should be displayed when printing the object. |
D2ProcessVariablesDialog
GET Get the d2ProcessVariablesDialog
/repositories/{repositoryName}/process-variables-dialog
Retrieves the process variables dialog configuration. Use this action to obtain the dialog settings that define how process variables are displayed and edited.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
workflow-config-id |
|
|
document-id |
|
|
task-id |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ProductInfo
GET Get the d2ProductInfo
/product-info
Retrieves product information about the D2 application. Use this action to obtain version, build, and other product details.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2QueryFormDialog
GET Get the d2QueryFormDialog
/repositories/{repositoryName}/d2-saved-searches/query-forms/{queryFormId}/dialog
Retrieve the dialog configuration for a specific saved search query form.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
queryFormId |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2RecentlyUsedProfile
GET Get the d2RecentlyUsedProfiles
/repositories/{repositoryName}/d2-recently-used-profiles
Retrieve the list of recently used profiles for the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Content upload process. create - indicates creating a new document to docbase. import - indicates importing a document to docbase as a new document. |
|
|
Current selected Folder object Id or Document object Id has to be passed. This "inherited-id" will be used to fetch the all default properties values for the properties dialog. For D2 creation profiles API, This inherited-id will be used to find the profile related to "Folder properties used for creation" or "Extended creation profiles". |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2RecentlyUsedTemplate
GET Get the d2RecentlyUsedTemplates
/repositories/{repositoryName}/objects/{objectId}/d2-recently-used-templates
Retrieve the list of recently used templates associated with a given object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2RecentlyUsedVdTemplate
GET Get the d2RecentlyUsedVdTemplates
/repositories/{repositoryName}/d2-recently-used-vd-templates
Retrieve the list of recently used virtual document templates for the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Object Id of the VD that has to be inherited. Mandatory request parameter if add child nodes will happen by applying the rules defined in the vd template on inherited VD set in the config. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2RelationTypesConfig
GET Get the d2RelationTypesConfig
/repositories/{repositoryName}/d2-configurations/d2-relation-types-config
Retrieve the configuration for relation types used in the D2 application.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2Rendition (3)
DELETE Delete the d2Rendition
/repositories/{repositoryName}/objects/{id}/d2-renditions/{contentId}
Permanently delete a specific rendition of an object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
contentId |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2Rendition
/repositories/{repositoryName}/objects/{id}/d2-renditions/{contentId}
Retrieve details of a specific rendition of an object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
contentId |
|
|
Name of the d2 config widget,widget-type has to be passed along with this value |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2Renditions
/repositories/{repositoryName}/objects/{objectId}/d2-renditions
Retrieve all renditions associated with a given object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Name of the d2 config widget,widget-type has to be passed along with this value |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2SavedSearchGroup (5)
DELETE Delete the d2SavedSearchGroup
/repositories/{repositoryName}/d2-saved-search-groups/{groupId}
Permanently delete a specific saved search group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
groupId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
force_delete |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2SavedSearchGroup
/repositories/{repositoryName}/d2-saved-search-groups/{groupId}
Retrieve details of a specific saved search group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
groupId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Get the d2SavedSearchGroup
/repositories/{repositoryName}/d2-saved-search-groups/{groupId}
Update a specific saved search group using a partial update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
groupId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide additional properties for the audit event as a JSON string. |
GET Get the d2SavedSearchGroups
/repositories/{repositoryName}/d2-saved-search-groups
Retrieve all saved search groups in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It specifies the type of saved search. The saved search can be a public, private, recent or last search. The allowed values are:- public_search, private_search, recent_search, last_search |
|
|
It determines if search can be within the sub-folders of current folder. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2SavedSearchGroup
/repositories/{repositoryName}/d2-saved-search-groups
Create a new saved search group in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide additional properties for the audit event as a JSON string. |
D2SavedSearchResult (2)
POST Execute the saved search with facet
/repositories/{repositoryName}/d2-saved-searches/{id}/results
Execute a saved search with optional facet expressions to refine results.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
facet-id-constraints |
|
|
query-locale |
|
|
overwrite |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Array of facet expressions to apply to the search. |
|
|
Operator used to combine the facet expressions, such as 'AND' or 'OR'. |
|
|
Boolean flag indicating whether to clear the existing facet expression set before applying new ones. |
GET Execute the search template
/repositories/{repositoryName}/d2-saved-searches/{id}/results
Execute a saved search using its stored template without additional parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2SearchAttributeValueList
GET Get the d2SearchAttributeValueList
/repositories/{repositoryName}/d2-configurations/search-configuration/d2-search-attribute-value-list
Retrieve the list of valid attribute values for a search configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
r_object_type of the documents, that should be searched. |
|
|
search_type_attribute |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2SearchContent (2)
POST Create the d2SearchContent
/repositories/{repositoryName}/quickSearch
Create a new quick search content entry in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Search term should be as query Param Example :- - http:-//hostname/d2fs-rest/repositories/RepoName/quickSearch?term=test |
|
|
Name of the d2 config widget,widget-type has to be passed along with this value |
|
|
Determines if the facets should be returned along with search results |
|
|
Determines if search has to be within search results. |
|
|
The object ID of folder within which search is to be done. |
|
|
Determines if search can be within subfolders of current folder. |
|
|
object-types |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the facet configuration to create. |
|
|
The title of the preference. |
|
|
The timestamp indicating when the facet configuration was last updated. |
|
|
The page number for paginated retrieval of facet entries. |
|
|
The number of items to return per page for facet entries. |
|
|
The total number of entries in the facet configuration. |
|
|
An array of hypermedia links related to the facet configuration. |
|
|
An array of authors associated with the facet configuration. |
|
|
An array of entry objects that define the facet values and criteria. |
GET Get the d2SearchContent
/repositories/{repositoryName}/quickSearch
Retrieve quick search content results based on the repository's search configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
widgetType |
|
|
The repository name. |
|
|
widgetName |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
A filter expression in a subset of XPath. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
process_facets |
|
|
column |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
term |
|
|
Name of the d2 config widget,widget-type has to be passed along with this value |
|
|
Determines if search has to be within search results. |
|
|
The object ID of folder within which search is to be done. |
|
|
Determines if search can be within subfolders of current folder. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2SendmailConfig
GET Get the d2SendmailConfig
/repositories/{repositoryName}/d2-sendmail-config/{id}
Retrieve the sendmail configuration for a specific identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
ID of the sendmail config |
|
|
object_names |
|
|
locate_urls @return @throws Exception |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2SharedRecipient (3)
DELETE Delete the d2SharedRecipients
/repositories/{repositoryName}/objects/{id}/share-to-core/recipients
Delete all shared recipients for a specific object shared to the core.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Name of share. Default value will be - "default". |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2SharedRecipients
/repositories/{repositoryName}/objects/{id}/share-to-core/recipients
Retrieve the list of recipients for a specific object shared to the core.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Name of share. Default value will be - "default". |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the d2SharedRecipient
/repositories/{repositoryName}/objects/{id}/share-to-core/recipients
Replace the recipients for a specific object shared to the core with a new set.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Name of share. Default value will be - "default". |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Share mode to apply, such as 'direct' or 'group'. |
|
|
A name for the audit policy. |
|
|
An optional message to include with the digital signature request. |
|
|
Identifier of the current version of the object in the core. |
|
|
Identifier of the published version of the object to share. |
D2SharedToCore (4)
DELETE Delete the d2SharedToCore
/repositories/{repositoryName}/objects/{id}/share-to-core
Delete the share-to-core link for a specific object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the name of the share whose default value is "default". |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2SharedToCore
/repositories/{repositoryName}/objects/{id}/share-to-core
Retrieve the share-to-core details for a specific object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
share-name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Get the d2SharedToCore
/repositories/{repositoryName}/objects/{id}/share-to-core
Update the share-to-core settings for a specific object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
share-name |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Updated share mode to apply. |
|
|
A name for the audit policy. |
|
|
An optional message to include with the digital signature request. |
|
|
Updated identifier for the current version in the core. |
|
|
Updated identifier for the published version to share. |
POST Update the d2SharedToCore
/repositories/{repositoryName}/objects/{id}/share-to-core
Update the sharing status of an object to core Documentum repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
c2_override |
|
|
It is the name of the share whose default value is "default". |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Updated share mode to apply. |
|
|
A name for the audit policy. |
|
|
An optional message to include with the digital signature request. |
|
|
Updated identifier for the current version in the core. |
|
|
Updated identifier for the published version to share. |
D2SignoffIntentionsDictionary
GET Get the d2SignoffIntentionsDictionary
/repositories/{repositoryName}/signoff-intentions-dictionary
Retrieve the sign-off intentions dictionary for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
An optional query parameter to filter the list of actions. |
|
|
It is the name of the dictionary. |
|
|
It is an optional parameter which provides values for all the dependencies like title, object_name in the URL. |
|
|
It is the selected document Id one has to be passed. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2SilentLinkedDocumentCreation
POST Update the d2SilentLinkedDocumentCreation
/repositories/{repositoryName}/objects/{objectId}/silent-linked-document-creation
Update the silent linked document creation setting for an object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectId of the silent linked document creation |
|
|
Object id of the folder in which file should get linked |
|
|
In Linked document config list, for which entry the silent document is going to create. Value will be integer, starting index will be 0.Relation entry order will be getting populated automatically in the linkrel itself. |
|
|
Name of the email attachment file which needs to be passed while creating attachment object |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2Sysobject
GET Get the d2Sysobjects
/repositories/{repositoryName}/objects
Retrieve a list of sysobjects from a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Specifies the object type Example:- its dm_sysobject or any of its sub types including user defined custom types which are sub types of dm_sysobject. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2TaskDelegateUser
GET Get the d2TaskDelegateUsers
/repositories/{repositoryName}/d2-tasks/{taskId}/d2-task-delegate-users
Retrieve the delegate users assigned to a D2 task.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2TaskDigitalSignatureConfig
GET Get the d2TaskDigitalSignatureConfig
/repositories/{repositoryName}/d2-tasks/{queueItemId}/d2-task-digital-signature-config
Retrieve the digital signature configuration for a D2 task queue item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
queueItemId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2TaskLifecycleCheckerController
GET Get the d2TaskLifecycleCheckerController
/repositories/{repositoryName}/d2-tasks/{taskId}/d2-task-lifecycle-condition-checker
Retrieve the lifecycle condition checker for a D2 task.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Task Action. Possible values - FORWARD / REJECT / DELEGATE / ACQUIRE For Task Property Page Action. Possible values - FORWARD / REJECT For Workflow Status Action. Possible value - ABORT For Task Lifecycle check operation. Possible value - FORWARD / REJECT For Adding Audit Entry Action. Possible value - FORWARD / REJECT / EDIT_PROPERTIES / CHECKIN |
|
|
The activity id(s) from the current task, can be FORWARD activity or REJECT Activity. next-activity-ids can be passed in one of the following formats:- next-activity-ids= next-activity-ids=&next-activity-ids=&next- activity-ids= |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2TaskLockStateChecker
GET Get the d2TaskLockStateChecker
/repositories/{repositoryName}/d2-tasks/{taskId}/lock-state-checker
Retrieve the lock state checker for a D2 task.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2TaskPropertyPage
GET Get the d2TaskPropertyPage
/repositories/{repositoryName}/d2-tasks/{taskId}/property-page
Retrieve the property page configuration for a D2 task.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Task Action. Possible values - FORWARD / REJECT / DELEGATE / ACQUIRE For Task Property Page Action. Possible values - FORWARD / REJECT For Workflow Status Action. Possible value - ABORT For Task Lifecycle check operation. Possible value - FORWARD / REJECT For Adding Audit Entry Action. Possible value - FORWARD / REJECT / EDIT_PROPERTIES / CHECKIN |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2TaskStatus
PUT Put the d2TaskStatus
/repositories/{repositoryName}/d2-tasks/{taskId}/status
Update the status of a D2 task.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Task Action. Possible values - FORWARD / REJECT / DELEGATE / ACQUIRE For Task Property Page Action. Possible values - FORWARD / REJECT For Workflow Status Action. Possible value - ABORT For Task Lifecycle check operation. Possible value - FORWARD / REJECT For Adding Audit Entry Action. Possible value - FORWARD / REJECT / EDIT_PROPERTIES / CHECKIN |
|
|
non-mandatory request param to D2 task status API, has default value as true. This param can have values as true/false. |
|
|
non-mandatory request param to D2 task status API, has default value as true. This param can have values as true/false. If set to true the acquired task will be marked as read. |
|
|
The username of the user to which the task is to be delegated to. This is mandatory request parameter when the action is DELEGATE. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2TemplateValueConfig
GET Get the d2TemplateValueConfigs
/repositories/{repositoryName}/d2-configurations/default-templ-value-configs
Retrieve the default template value configurations for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
include-all-versions |
|
|
object-name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ThemeConfig (2)
GET Get the d2ThemeConfig
/d2-configurations/d2-theme-configs/default-theme
Retrieve the default D2 theme configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2ThemeConfig
/repositories/{repositoryName}/d2-configurations/d2-theme-configs/{theme-name}
Retrieve a specific D2 theme configuration by theme name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Name of the Repository |
|
|
Theme config name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ThumbnailsUrl
GET Get the d2ThumbnailsUrl
/repositories/{repositoryName}/d2-thumbnails-url
Retrieve the URL for generating D2 thumbnails.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It gives the object id(s) of the object whose actions are required. Object ids can be passed in one of the following formats:- object-ids= object-ids=&object-ids=&object-ids= |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2Type (2)
GET Get the d2Type
/repositories/{repositoryName}/d2-types/{typeName}
Retrieve a specific D2 type definition by type name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
typeName of the d2-type |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2Types
/repositories/{repositoryName}/d2-types
Retrieve all D2 type definitions for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2UserProfileImage (3)
DELETE Delete the d2UserProfileImage
/repositories/{repositoryName}/users/{userName}/d2-user-profile-image
Delete the profile image of a D2 user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
userName |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2UserProfileImage
/repositories/{repositoryName}/users/{userName}/d2-user-profile-image
Retrieve the profile image of a D2 user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
userName |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2UserProfileImage
/repositories/{repositoryName}/users/{userName}/d2-user-profile-image
Update or upload the profile image of a D2 user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
userName |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2UserTheme
GET Get the d2UserThemes
/repositories/{repositoryName}/d2-themes
Retrieve all D2 user themes for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2UsersAndGroup
GET Get the d2UsersAndGroups
/repositories/{repositoryName}/d2-users-and-groups
Retrieve a list of D2 users and groups.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2VdNode (2)
GET Get the d2VdNode
/repositories/{repositoryName}/objects/{objectId}/d2-vd-nodes/{vdmNumber}
Retrieve a specific virtual document node for an object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
vdmNumber |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the name of the d2 config widget. widget-type has to be passed along with this value. |
|
|
This is the relation id of the child being replaced. It is mandatory. This relation-id must belong to the parent-vd whose id is being sent in the path param. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Get the d2VdNode
/repositories/{repositoryName}/objects/{objectId}/d2-vd-nodes/{vdmNumber}
Update a specific virtual document node for an object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
vdmNumber |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the name of the d2 config widget. widget-type has to be passed along with this value. |
|
|
This is the relation id of the child being replaced. It is mandatory. This relation-id must belong to the parent-vd whose id is being sent in the path param. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
The relation identifier to use when updating the node. |
|
|
The virtual document number to associate with the node. |
|
|
The parent virtual document number for the node. |
|
|
Specifies the identifier of the parent folder. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2VdRelation (3)
DELETE Delete the d2VdRelation
/repositories/{repositoryName}/d2-vd-relations/{object-id}
Delete a specific virtual document relation by object ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete the d2VdRelations
/repositories/{repositoryName}/d2-vd-relations
Delete all virtual document relations for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The relation-ids of the child nodes which the user wants to be removed from its parent-node. Mandatory request parameter, this is the list of relation-ids of the components that will be removed from parent-node. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Get the d2VdRelations
/repositories/{repositoryName}/d2-vd-relations
Retrieve the d2 virtual document relations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Object Id of node before which the child nodes should be added. Optional request parameter |
|
|
Object Id of target parent under which all the nodes have to be moved. Mandatory request parameter, this is the parent root under which the nodes from multiple different parent VDs will be moved. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2VdSnapshot
POST Update the d2VdSnapshot
/repositories/{repositoryName}/d2-vd-snapshots
Update the d2VdSnapshot.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the VD root node object id. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (11)
|
Option Name |
Description |
|---|---|
|
|
The href of the snapshot to update. |
|
|
The href of the virtual document associated with the snapshot. |
|
|
A hyperlink reference for navigation or callback. Supply a URL to be used after state update. |
|
|
A boolean flag indicating whether to apply the state change to child objects recursively. Set to true for deep copy. |
|
|
A boolean flag indicating whether to replicate the state change to virtual document children. Set to true to include VD children. |
|
|
A boolean flag indicating whether to retain the original access control list. Set to true to keep existing ACLs. |
|
|
A label used for binding the lifecycle state operation. Provide a string identifier for the binding. |
|
|
A boolean flag indicating whether to include objects with broken lifecycle states in the update. Set to true to process broken states. |
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2VdSnapshotNode
GET Get the d2VdSnapshotNodes
/repositories/{repositoryName}/snapshots/{snapshotId}/d2-vd-nodes
Retrieve the d2VdSnapshotNodes for a given snapshot.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
snapshotId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
parent-id |
|
|
expand-all |
|
|
widget-name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2VirtualDocumentNode (2)
GET Get the d2VirtualDocumentNodes
/repositories/{repositoryName}/objects/{objectId}/d2-vd-nodes
Retrieve the d2VirtualDocumentNodes for a given object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is a flag to specify if the expanded structure is needed or just the immediate child nodes. It is an optional request parameter. This flag specifies if the entire VD structure must be expanded and returned or just the immediate children must be returned. |
|
|
It is the name of the d2 config widget. widget-type has to be passed along with this value. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the d2VirtualDocumentNode
/repositories/{repositoryName}/objects/{objectId}/d2-vd-nodes
Update the d2VirtualDocumentNode for a given object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is a flag to specify if the expanded structure is needed or just the immediate child nodes. It is an optional request parameter. This flag specifies if the entire VD structure must be expanded and returned or just the immediate children must be returned. |
|
|
If this flag is set and the operation is asynchronous then the operation progress can be tracked via a linkrel that will be returned. |
|
|
It is the name of the d2 config widget. widget-type has to be passed along with this value. |
|
|
As a D2-REST user I should be able control addition of child to vd based on suppress-checkout-warning flag and checkout-warning configuration in d2-config. When true - add a child in VD ignoring checkout-warning. When false - Do not add a child in VD ignoring checkout-warning. |
|
|
It is the Object Id of the folder structure that has to be converted to VD. It is a mandatory request parameter if the request is to convert the folder into VD. |
|
|
It is the Object Id of node before which the child nodes should be added. It is an optional request parameter. |
|
|
It is the Object Id of the VD that has to be inherited. It is a mandatory request parameter if add child nodes will happen by applying the rules defined in the vd template on inherited VD set in the config. |
|
|
It specifies whether the root should be inherited. It is an optional request parameter. If the flag is set to true then the inherited VD's root node will also be copied else only the child nodes inside the inherited-vd will be copied/linked/excluded according to the VD template. |
|
|
It specifies if the node with exact same name as the child node is already existing must be replaced or not. |
|
|
It is the Object Id of the VD template configured in D2 Config. It is a mandatory request parameter if a child is added by inherited-id since this will specify the rules that needs to followed while adding child from the inherited id. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2VirtualDocumentTemplate
GET Get the d2VirtualDocumentTemplates
/repositories/{repositoryName}/d2-vd-templates
Retrieve the d2VirtualDocumentTemplates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Object Id of the VD that has to be inherited. Mandatory request parameter if add child nodes will happen by applying the rules defined in the vd template on inherited VD set in the config. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WidgetConfig (2)
GET Get the d2WidgetConfig
/repositories/{repositoryName}/d2-configurations/widget-configs/{object-name}
Retrieve a specific d2WidgetConfig by its object name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
object-name of the widget configuration |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2WidgetConfigs
/repositories/{repositoryName}/d2-configurations/widget-configs
Retrieve all d2WidgetConfigs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
include-all-versions |
|
|
widget-name |
|
|
widget-type |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2Workflow (2)
GET Get the d2Workflow
/repositories/{repositoryName}/d2-workflows/{trackerId}
Retrieve a specific d2Workflow by its tracker ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
include-supporting-documents-count |
|
|
It is the workflow overview widget name. |
|
|
It is a flag to indicate whether, or not to include the workflow notes count in the response. |
|
|
It is an optional param. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Get the d2Workflow
/repositories/{repositoryName}/d2-workflows/{trackerId}
Update a specific d2Workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
The number of notes associated with the workflow task. |
|
|
The number of working documents associated with the workflow task. |
|
|
The number of supporting documents associated with the workflow task. |
|
|
A token identifier for session or transaction context. Supply the token to associate with the operation. |
|
|
A warning message to display when changing state. Provide a custom warning string. |
|
|
A hyperlink reference for navigation or callback. Supply a URL to be used after state update. |
|
|
A boolean flag indicating whether to apply the state change to child objects recursively. Set to true for deep copy. |
|
|
A boolean flag indicating whether to replicate the state change to virtual document children. Set to true to include VD children. |
|
|
A boolean flag indicating whether to retain the original access control list. Set to true to keep existing ACLs. |
|
|
A label used for binding the lifecycle state operation. Provide a string identifier for the binding. |
|
|
A boolean flag indicating whether to include objects with broken lifecycle states in the update. Set to true to process broken states. |
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
D2WorkflowActivityAudit
GET Get the d2WorkflowActivityAudits
/repositories/{repositoryName}/d2-workflows/{trackerId}/activity-audits
Retrieve the activity audits for a specific workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
activity-name |
|
|
Optional param.To filter workflows based on the past and present performers of the workflow |
|
|
The workflow overview widget name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowAssignableSupervisor
GET Get the d2WorkflowAssignableSupervisors
/repositories/{repositoryName}/d2-workflows/{trackerId}/assignable-supervisors
Retrieve the assignable supervisors for a specific workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowAudit
GET Get the d2WorkflowAudits
/repositories/{repositoryName}/d2-workflows/{trackerId}/audits
Retrieve the audits for a specific workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the workflow overview widget name. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowConfig
GET Get the d2WorkflowConfig
/repositories/{repositoryName}/d2-configurations/d2-workflow-configs/{configId}
Retrieve a specific d2WorkflowConfig by its config ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
configId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowEntryConditionsChecker (2)
GET Get the d2WorkflowEntryConditionsChecker
/repositories/{repositoryName}/d2-configurations/d2-workflow-configs/{workflowConfigId}/d2-workflow-entry-conditions-checker
Retrieve the entry conditions checker for a specific workflow config.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
workflowConfigId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Optional param |
|
|
The object id(s) of the object whose actions are required. Object ids can be passed in one of the following formats:- object-ids= object-ids=&object-ids=&object-ids= |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2WorkflowEntryConditionsChecker
/repositories/{repositoryName}/d2-configurations/d2-workflow-configs/{workflowConfigId}/d2-workflow-packagetype-checker
Retrieve the package type checker for a specific workflow config.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
workflowConfigId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The object id(s) of the object whose actions are required. Object ids can be passed in one of the following formats:- object-ids= object-ids=&object-ids=&object-ids= |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowLaunchPerformersDialog
GET Get the d2WorkflowLaunchPerformersDialog
/repositories/{repositoryName}/d2-configurations/d2-workflow-configs/{templateId}/performers-dialog
Retrieve the performers dialog for a specific workflow template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
templateId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the selected document Id that has to be passed. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowNotesConfig
GET Get the d2WorkflowNotesConfig
/repositories/{repositoryName}/d2-workflow-notes-config
Retrieve the d2WorkflowNotesConfig.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
An optional query parameter to filter the list of actions. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowOverviewWidgetUser
GET Get the d2WorkflowOverviewWidgetUsers
/repositories/{repositoryName}/d2-workflows/users
Retrieve the d2WorkflowOverviewWidgetUsers.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the workflow overview widget name. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowPerformer (2)
GET Get the d2WorkflowPerformers
/repositories/{repositoryName}/d2-workflows/{trackerId}/workflow-performers
Retrieve the performers for a specific workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
Task inbox queue Id |
|
|
Optional param |
|
|
The workflow overview widget name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Get the d2WorkflowPerformers
/repositories/{repositoryName}/d2-workflows/{trackerId}/workflow-performers
Update the performers for a specific workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
Task inbox queue Id |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowPerformersDialog
GET Get the d2WorkflowPerformersDialog
/repositories/{repositoryName}/d2-workflows/{trackerId}/workflow-performers-dialog
Retrieve the performers dialog for a specific workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
It is the task inbox queue Id. |
|
|
It is the Alias names assigned for the activity. |
|
|
Task Action. Possible values - FORWARD / REJECT / DELEGATE / ACQUIRE For Task Property Page Action. Possible values - FORWARD / REJECT For Workflow Status Action. Possible value - ABORT For Task Lifecycle check operation. Possible value - FORWARD / REJECT For Adding Audit Entry Action. Possible value - FORWARD / REJECT / EDIT_PROPERTIES / CHECKIN |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowReportTask
GET Get the d2WorkflowReportTask
/repositories/{repositoryName}/d2-workflows/{trackerId}/d2-report-tasks/{queueItemOrWorkItem}
Retrieve a specific report task for a workflow by queue item or work item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
queueItemOrWorkItem |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The workflow overview widget name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowReportTaskByActivity
GET Get the d2WorkflowReportTaskByActivity
/repositories/{repositoryName}/d2-workflows/{trackerId}/d2-report-tasks/{activityName}/{performerName}
Retrieve a specific report task for a workflow by activity and performer names.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
activityName |
|
|
performerName |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the workflow overview widget name. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowStatusController
PUT Put the d2WorkflowStatusController
/repositories/{repositoryName}/d2-workflows/{trackerId}/status
Update the status of a specific D2 workflow identified by its tracker ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
Task Action. Possible values - FORWARD / REJECT / DELEGATE / ACQUIRE For Task Property Page Action. Possible values - FORWARD / REJECT For Workflow Status Action. Possible value - ABORT For Task Lifecycle check operation. Possible value - FORWARD / REJECT For Adding Audit Entry Action. Possible value - FORWARD / REJECT / EDIT_PROPERTIES / CHECKIN |
|
|
delete-workflow-history |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowTask
GET Get the d2WorkflowTasks
/repositories/{repositoryName}/d2-workflows/{trackerId}/d2-report-tasks
Retrieve the list of report tasks associated with a D2 workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the workflow overview widget name. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowTasksAudit
GET Get the d2WorkflowTasksAudits
/repositories/{repositoryName}/d2-workflows/{trackerId}/d2-report-tasks/{queueItemIdOrWorkItemId}/audits
Retrieve the audit history for a specific report task within a D2 workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
queueItemIdOrWorkItemId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
This, when set to true, the task audits events pertaining only to core-sign are shown. |
|
|
It is the workflow overview widget name. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowTemplatesController
GET Get the d2WorkflowTemplatesController
/repositories/{repositoryName}/d2-workflows/templates
Retrieve all available D2 workflow templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The workflow overview widget name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2WorkflowsCount
GET Get the d2WorkflowsCount
/repositories/{repositoryName}/d2-workflows/count
Retrieve the total count of D2 workflows in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
document-id It is the selected document Id one has to be passed. |
|
|
It is the name of the supervisor of a workflow. |
|
|
It is an Optional param. It filters the workflows based on the past and present performers of the workflow. |
|
|
It is the object id(s) of workflow process templates, used as filter to only return the WF belonging to these process templates. |
|
|
It is an array of wf-states [Ex:- wf-states=running&wf-states=paused]. Filter to return the WFs only in the requested states. The states include running, paused, finished, aborted, dormant [scheduled]. |
|
|
It is a flag to specify if the response must include only the overdue entries and where the entries are past the due date (Ex:- overdue workflows). |
|
|
It is a date parameter used as filter. To only filter the Workflows the got initiated afterem> the requested date. This param specifies the start range of the start date attribute. |
|
|
It is a date parameter used as filter. To only filter the Workflows the got initiated before the requested date. This param specifies the closing range of the start date attribute. |
|
|
It is the name of the d2 config widget. widget-type has to be passed along with this value. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ZipAndDownload
POST Update the d2ZipAndDownload
/repositories/{repositoryName}/d2-zip-and-downloads
Create a new zip-and-download request for documents in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
This flag indicates whether to include nested sub folder or not. The Default value is false. |
|
|
It is by default false. If passed as true, then it overrides the c2 rendition. It is a part of the request parameters. |
|
|
It is the name of the widget to fetch the user preference columns of the logged in user. |
|
|
It is the type of the widget to fetch the user preference columns of the logged in user. |
|
|
It is the passphrase to encrypt the compressed file. |
|
|
include_only_manifest_file |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Specify additional options for the zip-and-download operation as a JSON string. |
D2ZipAndDownloadContent
GET Get the d2ZipAndDownloadContent
/repositories/{repositoryName}/d2-zip-and-downloads/{tracker_id}/content
Retrieve the content of a completed zip-and-download package identified by its tracker ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
tracker_id |
|
|
file_name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ZipAndDownloadStatus (2)
GET Get the d2ZipAndDownloadStatus
/repositories/{repositoryName}/d2-zip-and-downloads/{tracker_id}
Retrieve the current status of a zip-and-download request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
tracker_id |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the d2ZipAndDownloadStatus
/repositories/{repositoryName}/d2-zip-and-downloads/{tracker_id}
Update the status of a zip-and-download request (e.g., to mark it as downloaded).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
tracker_id |
|
|
Task Action. Possible values - FORWARD / REJECT / DELEGATE / ACQUIRE For Task Property Page Action. Possible values - FORWARD / REJECT For Workflow Status Action. Possible value - ABORT For Task Lifecycle check operation. Possible value - FORWARD / REJECT For Adding Audit Entry Action. Possible value - FORWARD / REJECT / EDIT_PROPERTIES / CHECKIN @throws Exception |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
D2ZipAndDownloadValidation
POST Update the d2ZipAndDownloadValidation
/repositories/{repositoryName}/d2-zip-and-download-validation
Validate the options for a zip-and-download request before creating it.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
include_subfolders |
|
|
include_only_manifest_file |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide the options to validate as a JSON string. |
D2_workflow_supporting_document_count
GET Get the d2_workflow_supporting_document_count
/repositories/{repositoryName}/d2-workflows/{trackerId}/supporting-documents/count
Retrieve the count of supporting documents attached to a D2 workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
task-id |
|
|
wf-overview-widget-name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2_workflow_working_document_count
GET Get the d2_workflow_working_document_count
/repositories/{repositoryName}/d2-workflows/{trackerId}/working-documents/count
Retrieve the count of working documents attached to a D2 workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
task-id |
|
|
wf-overview-widget-name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2lifecycle (2)
GET Get the d2lifecycle
/repositories/{repositoryName}/d2-configurations/lifecycle-configs
Retrieve all D2 lifecycle configuration entries.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
include-all-versions |
|
|
object_name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the d2lifecycle
/repositories/{repositoryName}/d2-configurations/lifecycle-configs/{object-name}
Retrieve a specific D2 lifecycle configuration by its object name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectName of the lifecycle configs |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2locate
GET Get the d2locate
/repositories/{repositoryName}/locate
Retrieve location information about the repository, such as its base URL and version.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
An optional query parameter to filter the list of actions. |
|
|
It is used to get to the location of an object. The values available are id,name,dql(only from clause query),path,version. |
|
|
It is located by locate type id,name,dql,path,version. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2location
GET Get the d2locations
/repositories/{repositoryName}/objects-locations
Retrieve the physical locations of objects in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The object id(s) of the object whose actions are required. Object ids can be passed in one of the following formats:- object-ids= object-ids=&object-ids=&object-ids= |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2objectcheckoutconfig
GET Get the d2objectcheckoutconfig
/repositories/{repositoryName}/objects/{object-id}/object-checkout-config
Retrieve the checkout configuration for a specific object, including versioning and checkout type options.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2objectsendmailconfig
GET Get the d2objectsendmailconfig
/repositories/{repositoryName}/objects/{object-id}/object-sendmail-config
Retrieve the send-mail configuration for a specific object, such as default recipients and templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
It gives the url of the object being shared. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
D2userpreference (2)
GET Get the d2userpreferences
/repositories/{repositoryName}/d2-preferences
Retrieve the current user's D2 preferences.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Get the d2userpreferences
/repositories/{repositoryName}/d2-preferences
Update one or more of the current user's D2 preferences.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Set the preferred date format, such as 'yyyy-MM-dd'. |
|
|
Set the preferred date-time format, such as 'yyyy-MM-dd HH:mm:ss'. |
|
|
Set the expected input format for dates when parsing user input. |
|
|
Set the expected input format for date-times when parsing user input. |
|
|
Set the format for thumbnail images, such as 'png' or 'jpg'. |
|
|
Set the size of thumbnail images, such as 'small', 'medium', or 'large'. |
|
|
Set the default language for the user interface, e.g., 'en' or 'fr'. |
|
|
Set the default template view for displaying content. |
|
|
Set the content view mode, such as 'list' or 'thumbnail'. |
|
|
Set whether to show the version number in version display (true/false). |
|
|
Set whether to show version labels in version display (true/false). |
|
|
Set whether to order folders before files in listings (true/false). |
|
|
Set whether to hide the main folder in folder trees (true/false). |
D2userwidgetconfig
GET Get the d2userwidgetconfig
/repositories/{repositoryName}/d2-widgets
Retrieve the list of available D2 widgets and their configurations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is d2 config widget type. |
|
|
It is the name of the d2 config widget. widget-type has to be passed along with this value. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Dar (3)
POST Create the dar (Documentum REST)
/repositories/{repositoryName}/dars
Upload and install a new DAR (Documentum Application Archive) file into the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
A hyperlink reference for navigation or callback. Supply a URL to be used after state update. |
|
|
A boolean flag indicating whether to apply the state change to child objects recursively. Set to true for deep copy. |
|
|
A boolean flag indicating whether to replicate the state change to virtual document children. Set to true to include VD children. |
|
|
A boolean flag indicating whether to retain the original access control list. Set to true to keep existing ACLs. |
|
|
A label used for binding the lifecycle state operation. Provide a string identifier for the binding. |
|
|
A boolean flag indicating whether to include objects with broken lifecycle states in the update. Set to true to process broken states. |
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
GET Get the dar (Documentum REST)
/repositories/{repositoryName}/dars/{id}
Retrieve details of a specific DAR by its identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the dars (Documentum REST)
/repositories/{repositoryName}/dars
Retrieve a list of all installed DARs in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
DcCompletion
POST Update the dcCompletion (Documentum REST)
/dc-completion
Update the dcCompletion resource to finalize or modify a completion event in the Documentum REST API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
dc-token |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
A hyperlink reference for navigation or callback. Supply a URL to be used after state update. |
|
|
A boolean flag indicating whether to apply the state change to child objects recursively. Set to true for deep copy. |
|
|
A boolean flag indicating whether to replicate the state change to virtual document children. Set to true to include VD children. |
|
|
A boolean flag indicating whether to retain the original access control list. Set to true to keep existing ACLs. |
|
|
A label used for binding the lifecycle state operation. Provide a string identifier for the binding. |
|
|
A boolean flag indicating whether to include objects with broken lifecycle states in the update. Set to true to process broken states. |
|
|
Specify the parent sharing option as a string to associate with the completion update. |
|
|
Specify a boolean value indicating the type of content being created. Set to true or false as required. |
|
|
Provide a string defining the content type definition. This specifies the format or category of the content. |
|
|
Provide additional properties for the audit event as a JSON string. |
DefaultFolder
GET Get the defaultFolder (Documentum REST)
/repositories/{repositoryName}/users/{userName}/home
Retrieve the default home folder for a specific user within a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
userName |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
DialogOptionsController
GET Get the dialogOptionsController
/repositories/{repositoryName}/dialog-options/{option}
Retrieve the dialog options controller for a specific option in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
option |
|
|
An optional query parameter to filter the list of actions. |
|
|
It is an expression supported by Core Rest. The behavior here is, Support is limited to '*' and '?' wildcards only. When no wild card is specified then it is "contains" behavior. |
|
|
object ids |
|
|
It is the name of the dictionary. |
|
|
It is a dictionary alias. |
|
|
auto_load |
|
|
limit |
|
|
It is the parameter that specifies the property page configuration name created in D2-Config. |
|
|
dialog_name |
|
|
field_name |
|
|
It is an optional parameter which provides values for all the dependencies like title, object_name in the URL. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
DqlQuery (2)
POST Create the dqlQuery (Documentum REST)
/repositories/{repositoryName}
Execute a DQL query by posting it to the repository and return the results.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
dql |
|
|
raw |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the dqlQuery (Documentum REST)
/repositories/{repositoryName}
Retrieve the results of a previously executed DQL query from the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
dql |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
include-domains |
|
|
raw |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
EventHubEventCreation
POST Update the eventHubEventCreation (Documentum REST)
/repositories/{repositoryName}/event-hub-event
Update the event hub event creation configuration in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Specify the event category as a string. |
|
|
Specify the event name as a string. |
|
|
Specify the event level as a number. |
|
|
Specify the event fields as a string. |
ExternalShareChecker
GET Get the externalShareChecker
/repositories/{repositoryName}/external-share-checker
Check the external share status for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
It gives the object id(s) of the object whose actions are required. Object ids can be passed in one of the following formats:- object-ids= object-ids=&object-ids=&object-ids= |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
ExternalShareObject
GET Get the externalShareObjects
/repositories/{repositoryName}/external-share-objects
Retrieve the list of external share objects for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the name of the d2 config widget. widget-type has to be passed along with this value. |
|
|
It is the name of the external-share-system (currently only 'core' is supported). |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Favorite (2)
GET Get the favorites
/repositories/{repositoryName}/is-favorite/{objectId}
Check if a specific object is marked as a favorite in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectId to be specified |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the favorites
/repositories/{repositoryName}/users/{userName}/favorites
Retrieve the list of favorites for a specific user in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
retrieve the favorites associated with the specified userName |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
permission-level |
|
|
include-all-versions |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
FederatedSearch (2)
POST Create the federatedSearch (Documentum REST)
/search
Create a federated search request to search across multiple repositories.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
q |
|
|
locations |
|
|
facet-value-constraints |
|
|
facet-id-constraints |
|
|
query-locale |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the facet configuration to create. |
|
|
The title of the preference. |
|
|
The timestamp indicating when the facet configuration was last updated. |
|
|
The page number for paginated retrieval of facet entries. |
|
|
The number of items to return per page for facet entries. |
|
|
The total number of entries in the facet configuration. |
|
|
An array of hypermedia links related to the facet configuration. |
|
|
An array of authors associated with the facet configuration. |
|
|
An array of entry objects that define the facet values and criteria. |
GET Get the federatedSearch (Documentum REST)
/search
Retrieve the results of a federated search from the search endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
q |
|
|
locations |
|
|
facet-value-constraints |
|
|
query-locale |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
FolderChildFolder (2)
POST Create the folderChildFolder (Documentum REST)
/repositories/{repositoryName}/folders/{folderId}/folders
Create a new child folder within a specified parent folder in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
folderId |
|
|
constraint-validation-policy |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
GET Get the folderChildFolders (Documentum REST)
/repositories/{repositoryName}/folders/{folderId}/folders
Retrieve the list of child folders within a specified parent folder in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
folderId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
object-type |
|
|
hide-shared-parent |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
FolderPathCreation
POST Create the folderPathCreation
/repositories/{repositoryName}/folders/{folderId}/folder-path-creation
Create a folder path (nested folders) within a specified folder in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
folderId |
|
|
inherit_parent_acl |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
FolderStructureConverionConfig
GET Get the folderStructureConverionConfig
/repositories/{repositoryName}/folders/{objectId}/folder-structure-conversion-config
Retrieve the folder structure conversion configuration for a specific object in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
FolderStructureImportConfig
GET Get the folderStructureImportConfigs
/repositories/{repositoryName}/folder-structure-import-configs
Retrieve the list of folder structure import configurations for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the object id of the folder in which file should get linked. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
FolderStructureImportUrl
GET Get the folderStructureImportUrls
/repositories/{repositoryName}/folder-structure-import-urls
Retrieve the list of folder structure import URLs for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Format (2)
GET Get the d2formats
/repositories/{repositoryName}/formats
Retrieve the list of available formats (D2 formats) for a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
The repository name. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
A filter expression in a subset of XPath. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the format (Documentum REST)
/repositories/{repositoryName}/formats/{formatName}
Retrieve details of a specific format by its name in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
formatName |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Group (5)
POST Create the group (Documentum REST)
/repositories/{repositoryName}/groups
Creates a new group in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
DELETE Delete the group (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}
Permanently removes a specific group from the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
groupName |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the group (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}
Retrieves the details of a specific group by its name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
groupName |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the groups (Documentum REST)
/repositories/{repositoryName}/groups
Returns a list of all groups in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
user-name |
|
|
group-name |
|
|
recursive |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the group (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}
Modifies the properties of an existing group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
groupName |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
GroupMemberGroup (3)
POST Create the groupMemberGroup (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}/groups
Adds a subgroup to an existing group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
groupName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
DELETE Delete the groupMemberGroup (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}/groups/{memberName}
Removes a specific subgroup from a group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
groupName |
|
|
memberName |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the groupMemberGroups (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}/groups
Retrieves all subgroups of a given group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
groupName |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
recursive |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GroupMemberUser (3)
POST Create the groupMemberUser (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}/users
Adds a user as a member of a group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
groupName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
DELETE Delete the groupMemberUser (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}/users/{userName}
Removes a specific user from a group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
groupName |
|
|
userName |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the groupMemberUsers (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}/users
Retrieves all users that are members of a group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
groupName |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
recursive |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
HomeDocument
GET Get the homeDocument (Documentum REST)
/services
Retrieves the home document or service document for the API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Inbox
GET Get the inbox (Documentum REST)
/repositories/{repositoryName}/inbox
Retrieves the inbox items for the current user in a repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
item-type |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
InboxItem (3)
DELETE Delete the inboxItem (Documentum REST)
/repositories/{repositoryName}/inbox/{itemId}
Permanently removes a specific inbox item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
itemId |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the inboxItem (Documentum REST)
/repositories/{repositoryName}/inbox/{itemId}
Retrieves the details of a specific inbox item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
itemId |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the inboxItem (Documentum REST)
/repositories/{repositoryName}/inbox/{itemId}
Updates the properties of a specific inbox item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
itemId |
|
|
action |
|
|
delegate-user |
|
|
repeat-users |
|
|
signoff-password |
|
|
activity |
|
|
assign-performers |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Job (5)
POST Create the job (Documentum REST)
/repositories/{repositoryName}/jobs
Creates a new job in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
DELETE Delete the job (Documentum REST)
/repositories/{repositoryName}/jobs/{id}
Permanently removes a specific job by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the job (Documentum REST)
/repositories/{repositoryName}/jobs/{id}
Retrieves the details of a specific job by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the jobs (Documentum REST)
/repositories/{repositoryName}/jobs
Returns a list of all jobs in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the job (Documentum REST)
/repositories/{repositoryName}/jobs/{id}
Modifies the properties of an existing job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
Lifecycle (2)
GET Get the lifecycle (Documentum REST)
/repositories/{repositoryName}/lifecycles/{objectId}
Retrieves the lifecycle state for a specific object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the lifecycles (Documentum REST)
/repositories/{repositoryName}/lifecycles
Returns a list of all lifecycles in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
include-all-versions |
|
|
The r_object_id of required sysobject. |
|
|
object-type |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Mail
POST Update the mail (Documentum REST)
/appworks/mail
Sends or updates an email notification using the specified parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
otagtoken |
|
|
async |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The subject of the preference. |
|
|
The email address that appears as the sender of the mail. |
|
|
An array of recipient email addresses for the mail. |
|
|
The text content of the email message. |
Materialization (2)
DELETE Delete the materialization (Documentum REST)
/repositories/{repositoryName}/objects/{id}/materialization
Removes the materialization of a specific object, reverting to its virtual state.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the materialization (Documentum REST)
/repositories/{repositoryName}/objects/{id}/materialization
Put the materialization of an object in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Method (5)
POST Create the method (Documentum REST)
/repositories/{repositoryName}/methods
Create a new method in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
method-category |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
DELETE Delete the method (Documentum REST)
/repositories/{repositoryName}/methods/{id}
Delete an existing method by its identifier from the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
del-version |
|
|
del-vd-all |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the method (Documentum REST)
/repositories/{repositoryName}/methods/{id}
Retrieve a method by its identifier from the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the methods (Documentum REST)
/repositories/{repositoryName}/methods
List all methods available in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
method-category |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the method (Documentum REST)
/repositories/{repositoryName}/methods/{id}
Update an existing method identified by its identifier in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
run-method |
|
|
use-content |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
Module (3)
GET Get the module (Documentum REST)
/repositories/{repositoryName}/modules/{moduleId}
Retrieve a module by its module identifier from the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
moduleId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the modules (Documentum REST)
/repositories/{repositoryName}/modules
List all modules in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the module (Documentum REST)
/repositories/{repositoryName}/modules/{moduleId}
Update an existing module identified by its module identifier in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
moduleId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide the options to validate as a JSON string. |
NetworkLocation (2)
GET Get the networkLocation (Documentum REST)
/repositories/{repositoryName}/network-locations/{networkLocationIdentifier}
Retrieve a network location by its identifier from the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
networkLocationIdentifier |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the networkLocations (Documentum REST)
/repositories/{repositoryName}/network-locations
List all network locations in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
NotesCount
GET Get the notesCount
/repositories/{repositoryName}/d2-workflows/{trackerId}/notes/count
Get the count of notes for a specific D2 workflow identified by its tracker ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
trackerId |
|
|
The workflow overview widget name |
|
|
Task inbox queue Id |
|
|
Filter the response w.r.t the value.The values can be task or workflow |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Notification
POST Update the notification (Documentum REST)
/appworks/notification
Send a notification to an application or user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
otagtoken |
|
|
client-id |
|
|
send-to-admins |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
A brief summary of the notification. |
|
|
The title of the preference. |
|
|
A key used to group related notifications together. |
|
|
The name of the topic to which the notification is sent. |
|
|
The username of the recipient. |
|
|
The target application that should receive the notification. |
|
|
The payload data for the notification. |
|
|
The project identifier for the topic destination. |
ObjectAspect (3)
DELETE Delete the objectAspect (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/aspects/{aspectName}
Remove a specific aspect from an object in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
aspectName |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the objectAspects (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/aspects
List all aspects associated with an object in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the objectAspect (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/aspects
Add or update aspects on an object in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of aspect objects to assign to the object. |
ObjectLifecycle (3)
DELETE Delete the objectLifecycle (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle
Remove the lifecycle association from an object in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the objectLifecycle (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle
Retrieve the lifecycle state information for an object in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the objectLifecycle (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle
Apply or update a lifecycle on an object in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the lifecycle to apply. |
|
|
The name of the lifecycle to apply. |
|
|
The current state of the object in the lifecycle. |
|
|
The previous state of the object in the lifecycle. |
|
|
The next state to which the object should be promoted. |
|
|
The state to resume if the lifecycle was suspended. |
|
|
Indicates whether the object can be promoted to the next state. |
|
|
Indicates whether the object can be demoted to the previous state. |
|
|
Indicates whether the object's lifecycle can be suspended. |
|
|
Indicates whether the object's lifecycle can be resumed. |
ObjectLifecycleDemotion (2)
DELETE Delete the objectLifecycleDemotion (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/demotion
Remove the demotion action from an object's lifecycle in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
schedule |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the objectLifecycleDemotion (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/demotion
Apply a demotion to an object's lifecycle in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
to-base |
|
|
schedule |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
ObjectLifecyclePromotion (2)
DELETE Delete the objectLifecyclePromotion (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/promotion
Remove the promotion action from an object's lifecycle in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
schedule |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the objectLifecyclePromotion (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/promotion
Apply a promotion to an object's lifecycle in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
force |
|
|
trial |
|
|
schedule |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
ObjectLifecycleResumption (2)
DELETE Delete the objectLifecycleResumption (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/resumption
Remove the resumption action from an object's lifecycle in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
schedule |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the objectLifecycleResumption (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/resumption
Resume a suspended lifecycle for a specific object. Use this to continue a lifecycle that was previously suspended.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
to-base |
|
|
force |
|
|
trial |
|
|
schedule |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
ObjectLifecycleSuspension (2)
DELETE Delete the objectLifecycleSuspension (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/suspension
Delete the suspension of an object's lifecycle, effectively unsuspending it. Use this to remove a suspension without resuming the lifecycle.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
schedule |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the objectLifecycleSuspension (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/suspension
Suspend the lifecycle of a specific object. Use this to temporarily halt the lifecycle progression.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
force |
|
|
trial |
|
|
schedule |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
ObjectLightweightObject (2)
POST Create the objectLightweightObject (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lw-objects
Create a lightweight object under a parent object. Use this to add a lightweight child object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
format |
|
|
content-length |
|
|
content-charset |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
GET Get the objectLightweightObjects (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lw-objects
Retrieve the list of lightweight objects associated with a parent object. Use this to view all lightweight children.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
ObjectParent (2)
GET Get the objectParent (Documentum REST)
/repositories/{repositoryName}/objects/{id}/parent
Retrieve the parent object of a specified object. Use this to navigate to the parent in a hierarchy.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the objectParent (Documentum REST)
/repositories/{repositoryName}/objects/{id}/parent
Update or set the parent object of a specified object. Use this to reparent an object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
ObjectSubscription (2)
DELETE Delete the objectSubscription (Documentum REST)
/repositories/{repositoryName}/objects/{id}/subscription
Delete the subscription for a specific object. Use this to unsubscribe from notifications.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the objectSubscription (Documentum REST)
/repositories/{repositoryName}/objects/{id}/subscription
Create or update a subscription for a specific object. Use this to subscribe to notifications.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of subscriber identifiers to receive notifications for the object. |
Permission
GET Get the permissions (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/permissions
Retrieve the permissions set on a specific object. Use this to view access rights.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
accessor |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PermissionSet (2)
GET Get the permissionSet (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/permission-set
Retrieve the permission set associated with an object. Use this to see the current permission configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the permissionSet (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/permission-set
Update the permission set for an object. Use this to modify access controls.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
An array of required groups for the permission set. |
|
|
An array of required group sets for the permission set. |
QueueTask (3)
GET Get the queueTask (Documentum REST)
/repositories/{repositoryName}/queue-tasks/{itemId}
Retrieve a specific queue task by its item ID. Use this to check the status or details of a single task.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
itemId |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the queueTasks (Documentum REST)
/repositories/{repositoryName}/queue-tasks
Retrieve a list of queue tasks in the repository. Use this to view all pending or processed tasks.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
queue-names |
|
|
filter-type |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the queueTask (Documentum REST)
/repositories/{repositoryName}/queue-tasks/{itemId}
Update a specific queue task. Use this to modify task properties or status.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
itemId |
|
|
action |
|
|
pulled |
|
|
unsuspend-time |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
RecentlyAccessedController
GET Get the recentlyAccessedController
/repositories/{repositoryName}/recently-accessed
Retrieve a list of recently accessed objects for the current user. Use this to quickly access recently viewed items.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
It is the name of the d2 config widget. The widget-type has to be passed along with this value. |
|
|
folders-only |
|
|
It gives the object id(s) of the object whose actions are required. Object ids can be passed in one of the following formats:- object-ids= object-ids=&object-ids=&object-ids= |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
RelatedDoc
GET Get the relatedDocs (Documentum REST)
/repositories/{repositoryName}/documents/{id}/related-docs
Retrieve related documents for a specific document. Use this to find documents associated by relation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
RelatedSme
GET Get the relatedSme (Documentum REST)
/repositories/{repositoryName}/documents/{id}/related-sme
Retrieve related subject matter experts for a specific document. Use this to find associated SMEs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
RelationType (2)
GET Get the relationType (Documentum REST)
/repositories/{repositoryName}/relation-types/{relationName}
Retrieve a specific relation type by its name. Use this to view the definition of a relation type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
relationName |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the relationTypes (Documentum REST)
/repositories/{repositoryName}/relation-types
Retrieve all relation types available in the repository. Use this to list all relation definitions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Repository
GET Get the repositories (Documentum REST)
/repositories
Retrieve a list of available repositories. Use this to discover which repositories are accessible.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
SavedSearch (3)
DELETE Delete the savedSearch (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}
Permanently delete a saved search. Use this to remove a stored search query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the savedSearch (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}
Retrieve a saved search by its ID. Use this to view the details of a stored search.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
The r_object_id of queried object. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the savedSearch (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}
Update an existing saved search. Use this to modify the search query or other properties.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
query-locale |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
|
|
The query document content as a string, used to update the saved search definition. |
SavedSearchExecution
GET Get the savedSearchExecution (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}/execution
Execute a saved search and retrieve the results. Use this to run a predefined search query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
q |
|
|
locations |
|
|
facet-value-constraints |
|
|
facet-id-constraints |
|
|
query-locale |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
SavedSearchResult (3)
DELETE Delete the savedSearchResults (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}/results
Delete the saved search results for a specific saved search. Use this action to remove stored result sets that are no longer needed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the savedSearchResults (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}/results
Retrieve the saved search results for a specific saved search. Use this action to fetch the stored result set of a previously executed search.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the savedSearchResult (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}/results
Update or replace the saved search results for a specific saved search. Use this action to overwrite the existing result set with new data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
q |
|
|
locations |
|
|
facet-value-constraints |
|
|
facet-id-constraints |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Search (2)
POST Create the search (Documentum REST)
/repositories/{repositoryName}/search
Create a new search query in the repository. Use this action to define and submit a search request with criteria and options.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
q |
|
|
locations |
|
|
facet-value-constraints |
|
|
facet-id-constraints |
|
|
query-locale |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the facet configuration to create. |
|
|
The title of the preference. |
|
|
The timestamp indicating when the facet configuration was last updated. |
|
|
The page number for paginated retrieval of facet entries. |
|
|
The number of items to return per page for facet entries. |
|
|
The total number of entries in the facet configuration. |
|
|
An array of hypermedia links related to the facet configuration. |
|
|
An array of authors associated with the facet configuration. |
|
|
An array of entry objects that define the facet values and criteria. |
GET Get the search (Documentum REST)
/repositories/{repositoryName}/search
Retrieve the results of a previously created search. Use this action to fetch the output of a search query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
q |
|
|
locations |
|
|
facet-value-constraints |
|
|
facet-id-constraints |
|
|
query-locale |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
SearchTemplate (4)
POST Create the searchTemplate
/repositories/{repositoryName}/search-templates
Create a new search template in the repository. Use this action to define a reusable search pattern with optional query document and external variables.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
query-locale |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Provide additional properties for the audit event as a JSON string. |
|
|
Provide the query document template content used to define the search structure. |
|
|
Supply a list of external variable definitions to customize the template execution. |
DELETE Delete the search template
/repositories/{repositoryName}/search-templates/{id}
Delete a specific search template from the repository. Use this action to permanently remove a template that is no longer needed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the search template
/repositories/{repositoryName}/search-templates/{id}
Retrieve details of a specific search template. Use this action to view the configuration and properties of a single template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the searchTemplates
/repositories/{repositoryName}/search-templates
Retrieve a list of all search templates in the repository. Use this action to get an overview of available templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
SearchTemplateExecution (7)
PUT Create or update the search template
/repositories/{repositoryName}/d2-saved-searches/{savedSearchObjectId}
Create or update a D2 saved search. Use this action to save a new search or modify an existing one with parameters like search name, category, types, and facets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
facet-id-constraints |
|
|
query-locale |
|
|
overwrite |
|
|
object Id of Saved Search |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Specify the name for the saved search to be created or updated. |
|
|
Indicate the category to group the search under. |
|
|
Define the object types to include in the search results. |
|
|
Set to true if this search uses a wizard interface, otherwise false. |
|
|
Provide the identifier for the link associated with the search. |
|
|
Specify the path of the link for the saved search. |
|
|
Give the display name for the link. |
|
|
Set to true to perform case-sensitive matching, false for case-insensitive. |
|
|
Set to true to include all versions of documents in results, false for only latest. |
|
|
Provide a list of facet definitions to refine search results. |
GET Execute the search template
/repositories/{repositoryName}/d2-saved-searches/{savedSearchObjectId}
Execute a saved D2 search template. Use this action to run a search defined by the specified saved search object ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
facet-id-constraints |
|
|
query-locale |
|
|
object Id of Saved Search |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Execute the search template
/repositories/{repositoryName}/d2-saved-searches
Execute a search template by creating a new saved search. Use this action to run a search with specified parameters and get results.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
facet-id-constraints |
|
|
query-locale |
|
|
overwrite |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Specify the name for the saved search to be created or updated. |
|
|
Indicate the category to group the search under. |
|
|
Define the object types to include in the search results. |
|
|
Set to true if this search uses a wizard interface, otherwise false. |
|
|
Provide the identifier for the link associated with the search. |
|
|
Specify the path of the link for the saved search. |
|
|
Give the display name for the link. |
|
|
Set to true to perform case-sensitive matching, false for case-insensitive. |
|
|
Set to true to include all versions of documents in results, false for only latest. |
|
|
Provide a list of facet definitions to refine search results. |
POST Execute the search template
/repositories/{repositoryName}/d2-saved-searches/query-forms/{queryFormId}/results
Execute a search template using a query form. Use this action to run a search based on a specific query form ID and retrieve results.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
id of the queryform |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Execute the search template
/repositories/{repositoryName}/search-templates/{id}/execution
Execute a search template by providing a query document template and external variables. Use this action to run a template with custom parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
facet-id-constraints |
|
|
query-locale |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Provide additional properties for the audit event as a JSON string. |
|
|
Provide the query document template content used to define the search structure. |
|
|
Supply a list of external variable definitions to customize the template execution. |
GET Get the search template
/repositories/{repositoryName}/d2-saved-searches
Retrieve a list of D2 saved searches. Use this action to get all saved searches available in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
search-category |
|
|
saved-searches-subcategory-id |
|
|
descend |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Update the search template
/repositories/{repositoryName}/d2-saved-searches/{savedSearchObjectId}
Updates an existing saved search template identified by its object ID in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
facet-id-constraints |
|
|
query-locale |
|
|
overwrite |
|
|
object Id of Saved Search |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Specify the name for the saved search to be created or updated. |
|
|
Indicate the category to group the search under. |
|
|
Define the object types to include in the search results. |
|
|
Set to true if this search uses a wizard interface, otherwise false. |
|
|
Provide the identifier for the link associated with the search. |
|
|
Specify the path of the link for the saved search. |
|
|
Give the display name for the link. |
|
|
Set to true to perform case-sensitive matching, false for case-insensitive. |
|
|
Set to true to include all versions of documents in results, false for only latest. |
|
|
Provide a list of facet definitions to refine search results. |
SignificantTerm
GET Get the significantTerms (Documentum REST)
/repositories/{repositoryName}/documents/{id}/significant-terms
Retrieves the significant terms associated with a document in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
doc-ids |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Subscription
GET Get the subscriptions (Documentum REST)
/repositories/{repositoryName}/subscriptions
Retrieves a list of all subscriptions in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
SupportedFacet
GET Get the supportedFacets (Documentum REST)
/repositories/{repositoryName}/supported-facets
Retrieves the list of supported facets available in the repository for faceted search.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Synonym
GET Get the synonyms (Documentum REST)
/repositories/{repositoryName}/cce/synonyms
Retrieves the list of synonyms defined in the Content and Classification Engine (CCE) configuration for the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
category |
|
|
word |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
SynonymCategory
GET Get the synonymCategories (Documentum REST)
/repositories/{repositoryName}/cce/synonym-categories
Retrieves the list of synonym categories defined in the Content and Classification Engine (CCE) configuration for the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
TaskList (2)
GET Get the taskList
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}
Retrieves details of a specific task within a process, identified by process name, process ID, task name, and task ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
taskName |
|
|
processId |
|
|
processName |
|
|
includeContentURL |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the taskList
/repositories/{repositoryName}/tasklist
Retrieves the full task list for the repository, showing all tasks assigned to the current user or relevant workflows.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
TaskNote (2)
GET Get the taskNotes
/repositories/{repositoryName}/d2-tasks/{taskId}/notes
Retrieves all notes attached to a specific D2 task identified by its task ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId of the d2-task |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the taskNote
/repositories/{repositoryName}/d2-tasks/{taskId}/notes
Adds or updates a note on a specific D2 task identified by its task ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId of the d2-task |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
TaskStatus (2)
GET Get the taskStatus
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/status
Retrieves the current status of a specific task within a process, identified by process name, process ID, task name, and task ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
taskName |
|
|
processId |
|
|
processName |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the taskStatus
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/status
Updates the status of a specific task within a process, identified by process name, process ID, task name, and task ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
taskName |
|
|
processId |
|
|
processName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
Taskattachment (4)
DELETE Delete the taskattachment
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/attachments
Removes all attachments from a specific task within a process.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
taskName |
|
|
processId |
|
|
processName |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the taskattachment
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/attachments
Retrieves the list of attachments associated with a specific task within a process.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
taskName |
|
|
processId |
|
|
processName |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
include-all-versions |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the taskattachment
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/master-documents
Retrieves the master documents associated with a specific task within a process.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
taskName |
|
|
processId |
|
|
processName |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
include-all-versions |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the taskattachment
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/attachments
Adds or replaces attachments on a specific task within a process.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taskId |
|
|
taskName |
|
|
processId |
|
|
processName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
Taxonomy
GET Get the taxonomy
/repositories/{repositoryName}/d2-configurations/taxonomy/{taxonomy_name}
Retrieves the configuration details for a specific taxonomy by its name in the D2 configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
taxonomyName specified in D2-Configurations |
|
|
property_config |
|
|
is_taxonomy_encoded |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
ThumbnailUrl
GET Get the thumbnailUrl
/repositories/{repositoryName}/objects/{id}/d2-thumbnail-url
Retrieves the thumbnail URL for a specific object identified by its ID in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Type (2)
GET Get the type (Documentum REST)
/repositories/{repositoryName}/types/{type}
Retrieves the definition and properties of a specific type in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
type |
|
|
inherited |
|
|
locale |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
include-value-assist |
|
|
include-lifecycle |
|
|
include-auditable-events |
|
|
include-display-configs |
|
|
include-mapping-tables |
|
|
include-value-constraints |
|
|
include-all |
|
|
scope-config |
|
|
display-config |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the types (Documentum REST)
/repositories/{repositoryName}/types
Retrieves a list of all types available in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
parent-type |
|
|
recursive |
|
|
inherited |
|
|
locale |
|
|
include-lifecycle |
|
|
include-auditable-events |
|
|
include-display-configs |
|
|
include-mapping-tables |
|
|
include-value-constraints |
|
|
include-all |
|
|
dml-view |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
TypeAssistValue
POST Update the typeAssistValue (Documentum REST)
/repositories/{repositoryName}/types/{typeName}/assist-values
Adds or updates assist values for a specified type in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
typeName |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
included-properties |
|
|
lifecycle-id |
|
|
state |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
User (5)
POST Create the user (Documentum REST)
/repositories/{repositoryName}/users
Creates a new user in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
DELETE Delete the user (Documentum REST)
/repositories/{repositoryName}/users/{userName}
Permanently deletes a user identified by their username from the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
userName |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the user (Documentum REST)
/repositories/{repositoryName}/users/{userName}
Retrieves details of a specific user identified by their username in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
userName |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the users (Documentum REST)
/repositories/{repositoryName}/users
Retrieves a list of all users in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the user (Documentum REST)
/repositories/{repositoryName}/users/{userName}
Update an existing user's properties in the specified repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
userName |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
UserDefinedCollection (4)
DELETE Delete the userDefinedCollections
/repositories/{repositoryName}/collections/user-defined/{collectionId}
Permanently delete a specific user-defined collection from the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Collection ID to fetch User Defined Collections |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the userDefinedCollections
/repositories/{repositoryName}/collections/user-defined
Retrieve a list of all user-defined collections in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the userDefinedCollection
/repositories/{repositoryName}/collections/user-defined
Create or replace a user-defined collection in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
PATCH Update the userDefinedCollections
/repositories/{repositoryName}/collections/user-defined/{collectionId}
Partially update an existing user-defined collection's properties.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Collection ID to fetch User Defined Collections |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
UserDefinedCollectionItem (3)
DELETE Delete the userDefinedCollectionItems
/repositories/{repositoryName}/collections/user-defined/{collectionId}/items
Remove all items from a specific user-defined collection.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
collectionId |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the userDefinedCollectionItems
/repositories/{repositoryName}/collections/user-defined/{collectionId}/items
Retrieve all items contained in a specific user-defined collection.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
collectionId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
widget-name |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the userDefinedCollectionItem
/repositories/{repositoryName}/collections/user-defined/{collectionId}/items
Add one or more items to a user-defined collection by specifying their object or chronicle IDs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
collectionId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Array of chronicle IDs identifying the items to add to the collection. |
|
|
Array of object IDs identifying the items to add to the collection. |
UserPermissionSet
GET Get the userPermissionSet (Documentum REST)
/repositories/{repositoryName}/users/{userName}/permission-set
Retrieve the permission set assigned to a specific user in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
userName |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
VdSnapshot (4)
POST Create the vdSnapshot (Documentum REST)
/repositories/{repositoryName}/snapshots
Create a new virtual document snapshot in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
binding-label |
|
|
include-broken |
|
|
frozen |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
DELETE Delete the vdSnapshot (Documentum REST)
/repositories/{repositoryName}/snapshots/{snapshotId}
Permanently delete a specific virtual document snapshot.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
snapshotId |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the vdSnapshot (Documentum REST)
/repositories/{repositoryName}/snapshots/{snapshotId}
Retrieve details of a specific virtual document snapshot.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
snapshotId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the vdSnapshots (Documentum REST)
/repositories/{repositoryName}/snapshots
Retrieve a list of all virtual document snapshots in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
VdSnapshotFrozen (2)
DELETE Delete the vdSnapshotFrozen (Documentum REST)
/repositories/{repositoryName}/snapshots/{snapshotId}/frozen
Remove the frozen state from a virtual document snapshot.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
snapshotId |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the vdSnapshotFrozen (Documentum REST)
/repositories/{repositoryName}/snapshots/{snapshotId}/frozen
Freeze a virtual document snapshot, preventing further modifications.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
snapshotId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
VdSnapshotNode
GET Get the vdSnapshotNodes (Documentum REST)
/repositories/{repositoryName}/snapshots/{objectId}/vd-nodes
Retrieve the virtual document nodes associated with a specific snapshot.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
depth |
|
|
vdm-number |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
VirtualDocumentRelation (3)
DELETE Delete the virtualDocumentRelation (Documentum REST)
/repositories/{repositoryName}/vd-relations/{nodeId}
Permanently delete a specific virtual document relation node.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
nodeId |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the virtualDocumentRelation (Documentum REST)
/repositories/{repositoryName}/vd-relations/{nodeId}
Retrieve details of a specific virtual document relation node.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
nodeId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the virtualDocumentRelation (Documentum REST)
/repositories/{repositoryName}/vd-relations/{nodeId}
Update the properties of a specific virtual document relation node.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
nodeId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
WordSuggestion
GET Get the wordSuggestions (Documentum REST)
/repositories/{repositoryName}/cce/suggestions
Retrieve word suggestions for content completion and entry (CCE) in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
suggestion-view |
|
|
word |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
WorkItem (2)
GET Get the workItem (Documentum REST)
/repositories/{repositoryName}/work-items/{itemId}
Retrieve details of a specific work item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
itemId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the workItems (Documentum REST)
/repositories/{repositoryName}/workflows/{workflowId}/work-items
Retrieve all work items associated with a specific workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
workflowId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
WorkQueue (2)
GET Get the workQueue (Documentum REST)
/repositories/{repositoryName}/work-queues/{queueId}
Retrieve details of a specific work queue.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
queueId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the workQueues (Documentum REST)
/repositories/{repositoryName}/work-queues
Retrieve a list of all work queues in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
userName |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
Workflow (4)
POST Create the workflow (Documentum REST)
/repositories/{repositoryName}/workflows
Create a new workflow definition in the repository.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
quick-flow |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |
GET Get the workflow (Documentum REST)
/repositories/{repositoryName}/workflows/{workflowId}
Retrieve details of a specific workflow by its ID. Use when you need to inspect the current state, participants, or properties of an active workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
workflowId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the workflows (Documentum REST)
/repositories/{repositoryName}/workflows
Retrieve a list of all workflows in the specified repository. Use to browse or search for workflows based on filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the workflow (Documentum REST)
/repositories/{repositoryName}/workflows/{workflowId}
Update or replace an existing workflow's properties. Use to modify workflow attributes such as name, description, or priority.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
workflowId |
|
|
action |
|
|
activity |
|
|
supervisor |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
WorkflowActivity (2)
GET Get the workflowActivities (Documentum REST)
/repositories/{repositoryName}/workflow-templates/{templateId}/activities
Retrieve all activities associated with a workflow template. Use to examine the steps and transitions defined in a template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
templateId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the workflowActivity (Documentum REST)
/repositories/{repositoryName}/workflow-activities/{activityId}
Retrieve details of a specific workflow activity by its ID. Use to inspect the configuration of a single activity step.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
activityId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
WorkflowAttachment (3)
POST Create the workflowAttachment (Documentum REST)
/repositories/{repositoryName}/workflows/{workflowId}/attachments
Attach a document or other object to a workflow. Use to link supporting materials to a workflow instance.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
workflowId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The object ID to which the audit policy applies. |
|
|
The unique identifier of the component to attach. |
|
|
The display name of the component being attached. |
|
|
The type of component (e.g., document) being attached. |
|
|
The name of the user who created the attachment. |
|
|
The creation date of the preference in string format. |
DELETE Delete the workflowAttachment (Documentum REST)
/repositories/{repositoryName}/workflows/{workflowId}/attachments/{id}
Permanently remove a specific attachment from a workflow. Use to detach a document or object that is no longer needed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
workflowId |
|
|
The r_object_id of queried object. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the workflowAttachments (Documentum REST)
/repositories/{repositoryName}/workflows/{workflowId}/attachments
Retrieve all attachments linked to a workflow. Use to list the documents or objects associated with the workflow instance.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
workflowId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
WorkflowTaskPackage (3)
GET Get the workflowTaskPackage (Documentum REST)
/repositories/{repositoryName}/work-items/{itemId}/packages/{index}
Retrieve a specific package by its index from a work item. Use to examine the contents and configuration of a single package.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
itemId |
|
|
index |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the workflowTaskPackages (Documentum REST)
/repositories/{repositoryName}/work-items/{itemId}/packages
Retrieve all packages associated with a work item. Use to list the packages that define required documents, notes, or forms.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
itemId |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the workflowTaskPackage (Documentum REST)
/repositories/{repositoryName}/work-items/{itemId}/packages/{index}
Modify the properties of an existing package in a work item. Use to change requirements such as document IDs, notes, or form templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
itemId |
|
|
index |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (13)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the task to which the package belongs. |
|
|
The name of the package being updated. |
|
|
The type of content required in the package. |
|
|
A list of labels that the package must include. |
|
|
The number of notes expected in the package. |
|
|
A list of note content strings for the package. |
|
|
The number of documents expected in the package. |
|
|
A list of document identifiers required in the package. |
|
|
The required skill level for completing the package. |
|
|
Whether a form template is defined for the package. |
|
|
The identifier of the form template to use. |
|
|
The name of the form template to use. |
|
|
Whether the form is used for property editing. |
WorkflowTaskPackageDocument
DELETE Delete the workflowTaskPackageDocuments (Documentum REST)
/repositories/{repositoryName}/work-items/{itemId}/packages/{index}/documents
Remove all documents from a specific package in a work item. Use to clear the document requirements of a package.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
itemId |
|
|
index |
|
|
The response format expected from the API (e.g. application/json). |
WorkflowTaskPackageNote
DELETE Delete the workflowTaskPackageNote (Documentum REST)
/repositories/{repositoryName}/work-items/{itemId}/packages/{index}/notes/{noteId}
Permanently delete a specific note from a package in a work item. Use to remove an unwanted note.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
itemId |
|
|
index |
|
|
noteId |
|
|
The response format expected from the API (e.g. application/json). |
WorkflowTemplate (4)
GET Get the workflowTemplate (Documentum REST)
/repositories/{repositoryName}/workflow-templates/{templateId}
Retrieve details of a specific workflow template by its ID. Use to inspect the template's structure, activities, and default settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
templateId |
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the workflowTemplates (Documentum REST)
/repositories/{repositoryName}/workflow-templates
Retrieve a list of all workflow templates in the repository. Use to browse available templates for creating workflows.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
|
|
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
|
|
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
|
|
Properties to return. The pattern is like:?view=(:view-name)?(,column). (:view-name) and (,columns) must be mutually exclusive names of predefined views start with colon (':'). The following view-name are defined: :all :default If no view-name is specified, names of properties or predefined views should be returned, separated by comma (','). |
|
|
A filter expression in a subset of XPath. |
|
|
Sorting for entries in collection result. A sort consists of multiple sort specifications, separated by comma (','). Each sort specification consists of an attribute to be sorted and its sort order, separated by the spacpe (' '). Sort order can be either DESC orASC, case insensitive. Sort order is optional, if not specified, the default sort order isASC. Optionally it can be specified with non-repeating attributes. Sort order can be forced to be in case insensitive mode, with the hint no-case. Whether the default sort is in case sensitive mode or not is determined by the database. Example: sort=r_modify_date desc,object_name asc no-case,title. If any attribute with invalid name is specified, error will be thrown. |
|
|
Ensures whether to show content (the object instance) in the atom entry for a collection. 'true', return object instance and embed object instance into entry's content element. 'false', do not return object instance within entry's content. |
|
|
Ensures whether link relations to be returned for this object representation. 'true', return links for the object. 'false' do not return links for the object. |
|
|
The Accept header. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Put the workflowTemplate (Documentum REST)
/repositories/{repositoryName}/workflow-templates/{templateId}
Update or replace an existing workflow template's properties. Use to modify template metadata such as name or description.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
templateId |
|
|
action |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
POST Update the workflowTemplate (Documentum REST)
/repositories/{repositoryName}/workflow-templates/{templateId}
Partially update an existing workflow template. Use to change specific attributes without replacing the entire template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The repository name. |
|
|
templateId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of audit event (e.g., "create", "update"). |
|
|
Provide the audit event definition as a JSON string. |
|
|
Provide additional properties for the audit event as a JSON string. |