Version 1
Connector Overview: This page documents all 500 actions for the Otdocumentumconnector v1.
Acl (5)
POST Create the acl (Documentum REST)
/repositories/{repositoryName}/acls
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the acl (Documentum REST)
/repositories/{repositoryName}/acls/{objectId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
force |
|
|
N/A |
GET Get the acl (Documentum REST)
/repositories/{repositoryName}/acls/{objectId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the acls (Documentum REST)
/repositories/{repositoryName}/acls
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the acl (Documentum REST)
/repositories/{repositoryName}/acls/{objectId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
AclAssociation
GET Get the aclAssociations (Documentum REST)
/repositories/{repositoryName}/acls/{objectId}/associations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Annotation (3)
POST Create the annotation
/repositories/{repositoryName}/objects/{id}/annotations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
GET Get the annotations
/repositories/{repositoryName}/objects/{id}/annotations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the annotations
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/annotations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
ArchivedContent (2)
GET Get the archivedContents (Documentum REST)
/repositories/{repositoryName}/archived-contents
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
include-children |
|
|
binding-label |
|
|
include-broken |
|
|
depth |
|
|
format |
|
|
The Accept header. |
|
|
N/A |
POST Update the archivedContent (Documentum REST)
/repositories/{repositoryName}/archived-contents
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
all-contents |
|
|
format |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
AspectType (2)
GET Get the aspectType (Documentum REST)
/repositories/{repositoryName}/aspect-types/{aspectTypeName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the aspectTypes (Documentum REST)
/repositories/{repositoryName}/aspect-types
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Audit (3)
GET Get the audits
/repositories/{repositoryName}/users/{userName}/audits
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the audits
/repositories/{repositoryName}/users/{userName}/documents-audit
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the audits
/repositories/{repositoryName}/users/{userName}/fav-doc-audits
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
AuditEvent (5)
POST Create the auditEvent (Documentum REST)
/repositories/{repositoryName}/registered-audit-events
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the auditEvent (Documentum REST)
/repositories/{repositoryName}/registered-audit-events/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
N/A |
DELETE Delete the auditEvents (Documentum REST)
/repositories/{repositoryName}/registered-audit-events
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
audit-scope |
|
|
The r_object_id of required sysobject. |
|
|
object-type |
|
|
N/A |
GET Get the auditEvent (Documentum REST)
/repositories/{repositoryName}/registered-audit-events/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the auditEvents (Documentum REST)
/repositories/{repositoryName}/registered-audit-events
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
AuditPolicy (5)
POST Create the auditPolicy (Documentum REST)
/repositories/{repositoryName}/audit-policies
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the auditPolicy (Documentum REST)
/repositories/{repositoryName}/audit-policies/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
N/A |
GET Get the auditPolicies (Documentum REST)
/repositories/{repositoryName}/audit-policies
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the auditPolicy (Documentum REST)
/repositories/{repositoryName}/audit-policies/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the auditPolicy (Documentum REST)
/repositories/{repositoryName}/audit-policies/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
AuditTrail (3)
DELETE Delete the auditTrail (Documentum REST)
/repositories/{repositoryName}/audit-trails/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
trace |
|
|
N/A |
GET Get the auditTrail (Documentum REST)
/repositories/{repositoryName}/audit-trails/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the auditTrails (Documentum REST)
/repositories/{repositoryName}/audit-trails
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
AvailableAuditEvent
GET Get the availableAuditEvents (Documentum REST)
/repositories/{repositoryName}/available-audit-events
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Batch
POST Update the batch (Documentum REST)
/repositories/{repositoryName}/batches
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
BatchCapability
GET Get the batchCapabilities (Documentum REST)
/repositories/{repositoryName}/batch-capabilities
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
BravacsrAnnotation (6)
GET Get the bravacsrAnnotations
/repositories/{repositoryName}/objects/{objectId}/d2-bravacsr-annotations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
user |
|
|
N/A |
GET Get the bravacsrAnnotations
/repositories/{repositoryName}/objects/{objectId}/d2-bravacsr-annotations-list
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
action |
|
|
N/A |
GET Get the bravacsrAnnotations
/repositories/{repositoryName}/objects/{objectId}/d2-bravacsr-changemark-config
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
N/A |
GET Get the bravacsrAnnotations
/repositories/{repositoryName}/objects/{objectId}/d2-bravacsr-raster-urls
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
N/A |
GET Get the bravacsrAnnotations
/repositories/{repositoryName}/objects/{objectId}/d2-bravacsr-rasters
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
raster-id |
|
|
content-type |
|
|
download-type |
|
|
N/A |
POST Update the bravacsrAnnotation
/repositories/{repositoryName}/objects/{objectId}/d2-bravacsr-annotations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Content-Type header. |
|
|
N/A |
BravacsrConfig
GET Get the bravacsrConfig
/repositories/{repositoryName}/objects/{id}/d2-bravacsr-searchinfo-fallback-url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
N/A |
Cabinet (5)
POST Create the cabinet (Documentum REST)
/repositories/{repositoryName}/cabinets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
constraint-validation-policy |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the cabinet (Documentum REST)
/repositories/{repositoryName}/cabinets/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
del-non-empty |
|
|
del-all-links |
|
|
N/A |
GET Get the cabinet (Documentum REST)
/repositories/{repositoryName}/cabinets/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the cabinets (Documentum REST)
/repositories/{repositoryName}/cabinets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the cabinet (Documentum REST)
/repositories/{repositoryName}/cabinets/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
constraint-validation-policy |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
Content (5)
POST Create the content (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/contents
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the content (Documentum REST)
/repositories/{repositoryName}/objects/{id}/contents/content
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the content (Documentum REST)
/repositories/{repositoryName}/objects/{id}/contents/content
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the contents (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/contents
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the content (Documentum REST)
/repositories/{repositoryName}/objects/{id}/contents/content
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
ContentMedia
GET Get the contentMedia (Documentum REST)
/repositories/{repositoryName}/objects/{id}/content-media
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
CoreUsersSearch
GET Get the coreUsersSearch
/repositories/{repositoryName}/share-to-core/core-users-search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
CurrentUser
GET Get the currentUser (Documentum REST)
/repositories/{repositoryName}/currentuser
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
CurrentUserPreference (5)
POST Create the currentUserPreference (Documentum REST)
/repositories/{repositoryName}/currentuser-preferences
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the currentUserPreference (Documentum REST)
/repositories/{repositoryName}/currentuser-preferences/{clientCode}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
clientCode |
|
|
The Accept header. |
|
|
N/A |
GET Get the currentUserPreference (Documentum REST)
/repositories/{repositoryName}/currentuser-preferences/{clientCode}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the currentUserPreferences (Documentum REST)
/repositories/{repositoryName}/currentuser-preferences
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the currentUserPreference (Documentum REST)
/repositories/{repositoryName}/currentuser-preferences/{clientCode}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
CurrentVersion
GET Get the currentVersion (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/versions/current
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#about
GET Get the d2#about
/repositories/{repositoryName}/about-d2
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#action
GET Get the d2#actions
/repositories/{repositoryName}/actions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#checkinServletHandler
POST Update the d2#checkinServletHandler
/repositories/{repositoryName}/servlet/CheckInWithLifeCycle
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Content-Type header. |
|
|
N/A |
D2#commentsCount
GET Get the d2#commentsCount
/repositories/{repositoryName}/comments-count
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#commentsRepliesCount
GET Get the d2#commentsRepliesCount
/repositories/{repositoryName}/objects/{objectId}/comments-replies-count
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#contentAssistConfiguration (2)
GET Get the d2#contentAssistConfiguration
/repositories/{repositoryName}/d2-configurations/content-assist-configs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2#contentAssistConfiguration
/repositories/{repositoryName}/d2-configurations/content-assist-configs/{configId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#createInProces
POST Update the d2#createInProces
/repositories/{repoName}/in-process-objects/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2#d2Configuration
GET Get the d2#d2Configurations
/repositories/{repositoryName}/d2-configurations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
N/A |
D2#d2ContentUploadUrl
GET Get the d2#d2ContentUploadUrls
/repositories/{repositoryName}/objects/{objectId}/d2-content-upload-urls
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#d2ExtractO2PropertiesUrl
GET Get the d2#d2ExtractO2PropertiesUrls
/repositories/{repositoryName}/d2-extract-o2-properties-urls
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#dialog
GET Get the d2#dialog
/repositories/{repositoryName}/objects/{objectId}/dialog
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
dialog_type |
|
|
The Accept header. |
|
|
N/A |
D2#dmTicket
GET Get the d2#dmTicket
/repositories/{repositoryName}/dm-ticket
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
secure |
|
|
timeout |
|
|
The Accept header. |
|
|
N/A |
D2#document (3)
DELETE Delete the d2#document
/repositories/{repositoryName}/documents/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2#document
/repositories/{repositoryName}/documents/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the d2#document
/repositories/{repositoryName}/documents/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
template-name |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2#documentTemplate
GET Get the d2#documentTemplates
/repositories/{repositoryName}/objects/{id}/document-templates
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The Accept header. |
|
|
N/A |
D2#folder (3)
DELETE Delete the d2#folder
/repositories/{repositoryName}/folders/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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) |
|
|
N/A |
GET Get the d2#folder
/repositories/{repositoryName}/folders/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the d2#folder
/repositories/{repositoryName}/folders/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2#folderChildDocument (2)
POST Create the d2#folderChildDocument
/repositories/{repositoryName}/folders/{folderId}/documents
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the d2#folderChildDocuments
/repositories/{repositoryName}/folders/{folderId}/documents
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#folderChildFolder
POST Create the d2#folderChildFolder
/repositories/{repositoryName}/folders/{folderId}/d2-folders
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
folderId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2#folderChildObject (2)
POST Create the d2#folderChildObject
/repositories/{repositoryName}/folders/{folderId}/objects
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the d2#folderChildObjects
/repositories/{repositoryName}/folders/{folderId}/objects
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#folderCreatePropertyPage
GET Get the d2#folderCreatePropertyPage
/repositories/{repositoryName}/folder-creation-property-page
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
It specifies the object type of folder/cabinet/it's subtype |
|
|
The Accept header. |
|
|
N/A |
D2#inbox
GET Get the d2#inbox
/repositories/{repositoryName}/d2-inbox
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#landingPageConfiguration (2)
GET Get the d2#landingPageConfiguration
/repositories/{repositoryName}/d2-configurations/landing-page-configs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2#landingPageConfiguration
/repositories/{repositoryName}/d2-configurations/landing-page-configs/{configId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#lcConditionsChecker
POST Update the d2#lcConditionsChecker
/repositories/{repositoryName}/d2-objects-lifecycle-conditions-checker
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2#lcState
PUT Put the d2#lcState
/repositories/{repositoryName}/d2-objects-lifecycle-state
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2#linkedDocumentConfiguration
GET Get the d2#linkedDocumentConfigurations
/repositories/{repositoryName}/d2-configurations/linked-document-configurations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#lock (2)
DELETE Delete the d2#lock
/repositories/{repositoryName}/objects/{id}/lock
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
N/A |
PUT Put the d2#lock
/repositories/{repositoryName}/objects/{id}/lock
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
D2#lockPrecheck
GET Get the d2#lockPrecheck
/repositories/{repositoryName}/objects/{id}/lock-precheck
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The Accept header. |
|
|
N/A |
D2#myWorkflow
GET Get the d2#myWorkflows
/repositories/{repositoryName}/d2-my-workflows
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#object (4)
POST Create the d2#object
/repositories/{repositoryName}/objects/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the d2#object
/repositories/{repositoryName}/objects/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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 |
|
|
N/A |
GET Get the d2#object
/repositories/{repositoryName}/objects/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PATCH Get the d2#object
/repositories/{repositoryName}/objects/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2#objectCreation (4)
POST Update the d2#objectCreation
/repositories/{repositoryName}/create-object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the d2#objectCreation
/repositories/{repositoryName}/d2-object-creation
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (13)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update the d2#objectCreation
/repositories/{repositoryName}/object-creation
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update the d2#objectCreation
/repositories/{repositoryName}/objects/{objectId}/set-content
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2#profileConfiguration (3)
GET Get the d2#profileConfiguration
/repositories/{repositoryName}/d2-configurations/creation-profiles/{profileId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
profileID of the creation profile |
|
|
The Accept header. |
|
|
N/A |
GET Get the d2#profileConfiguration
/repositories/{repositoryName}/d2-configurations/profile-configuration
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2#profileConfiguration
/repositories/{repositoryName}/d2-configurations/profile-configurations/{profileId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
profileID of the profile configurations |
|
|
The Accept header. |
|
|
N/A |
D2#propertyPage (2)
GET Get the d2#propertyPage
/repositories/{repositoryName}/objects/{id}/property-page
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
editMode |
|
|
objectID to be specified |
|
|
The repository name. |
|
|
N/A |
|
|
The Accept header. |
|
|
N/A |
GET Get the d2#propertyPage
/repositories/{repositoryName}/property-page
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
N/A |
|
|
create/import profile mode configs |
|
|
object type of the document |
|
|
name of the property config configured in D2-Config |
|
|
The Accept header. |
|
|
N/A |
D2#prviewUrl (4)
GET Get the d2#prviewUrls
/repositories/{repositoryName}/objects/{id}/download-url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2#prviewUrls
/repositories/{repositoryName}/objects/{id}/export-urls
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2#prviewUrls
/repositories/{repositoryName}/objects/{id}/preview-urls
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2#prviewUrls
/repositories/{repositoryName}/objects/{id}/print-urls
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#relation (5)
DELETE Delete the d2#relation
/repositories/{repositoryName}/relations/{relationId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
relationId |
|
|
N/A |
GET Get the d2#relation
/repositories/{repositoryName}/relations/{relationId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2#relations
/repositories/{repositoryName}/relations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the d2#relation
/repositories/{repositoryName}/relations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update the d2#relation
/repositories/{repositoryName}/relations/{relationId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2#search (2)
GET Get the d2#searches
/repositories/{repositoryName}/objects/{searchCategoryId}/searches
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
ID of the search category |
|
|
The Accept header. |
|
|
N/A |
GET Get the d2#searches
/repositories/{repositoryName}/searches
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
search_category |
|
|
types |
|
|
The Accept header. |
|
|
N/A |
D2#searchConfiguration (2)
GET Get the d2#searchConfiguration
/repositories/{repositoryName}/d2-configurations/search-configuration
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2#searchConfiguration
/repositories/{repositoryName}/d2-configurations/search-configuration/{configId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
configId of the search configuration |
|
|
The Accept header. |
|
|
N/A |
D2#signOffCredentialValidation
POST Update the d2#signOffCredentialValidation
/repositories/{repositoryName}/d2-signoff-credential-validation
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2#task (2)
GET Get the d2#task
/repositories/{repositoryName}/d2-tasks/{queueItemId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PATCH Get the d2#task
/repositories/{repositoryName}/d2-tasks/{queueItemId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2#taskCategory
GET Get the d2#taskCategories
/repositories/{repositoryName}/d2-task-categories
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#typeConfiguration (2)
GET Get the d2#typeConfiguration
/repositories/{repositoryName}/type-configuration
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2#typeConfiguration
/repositories/{repositoryName}/type-configuration/{typeId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
typeId of the Type Configuration |
|
|
profileId |
|
|
The Accept header. |
|
|
N/A |
D2#vdsilentcheckin
POST Update the d2#vdsilentcheckin
/repositories/{repositoryName}/objects/{root-id}/d2-vd-silent-checkin
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#version
POST Create the d2#version
/repositories/{repositoryName}/objects/{chronicleId}/versions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2#virtualDocumentNode (2)
POST Create the d2#virtualDocumentNode
/repositories/{repositoryName}/objects/{objectId}/vd-nodes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Get the d2#virtualDocumentNodes
/repositories/{repositoryName}/objects/{objectId}/vd-nodes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#workflow (2)
GET Get the d2#workflows
/repositories/{repositoryName}/d2-workflows
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the d2#workflow
/repositories/{repositoryName}/d2-workflows
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2#workflow_supporting_document (3)
DELETE Delete the d2#workflow_supporting_documents
/repositories/{repositoryName}/d2-workflows/{trackerId}/supporting-documents
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2#workflow_supporting_documents
/repositories/{repositoryName}/d2-workflows/{trackerId}/supporting-documents
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the d2#workflow_supporting_document
/repositories/{repositoryName}/d2-workflows/{trackerId}/supporting-documents
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2#workflow_working_document
GET Get the d2#workflow_working_documents
/repositories/{repositoryName}/d2-workflows/{trackerId}/working-documents
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2AccessorRemover
PATCH Get the d2AccessorRemover
/repositories/{repositoryName}/objects/{object-id}/d2-accessor-remover
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2AccessorReplacement
PATCH Get the d2AccessorReplacement
/repositories/{repositoryName}/objects/{object-id}/d2-accessor-replacement
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2AsyncObjectController
GET Get the d2AsyncObjectController
/repositories/{repositoryName}/d2-async-operations/{objectId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2Cabinet (5)
POST Create the d2Cabinet
/repositories/{repositoryName}/d2-cabinets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the d2Cabinet
/repositories/{repositoryName}/d2-cabinets/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2Cabinet
/repositories/{repositoryName}/d2-cabinets/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2Cabinets
/repositories/{repositoryName}/d2-cabinets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the d2Cabinet
/repositories/{repositoryName}/d2-cabinets/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2CheckedOutObject
GET Get the d2CheckedOutObjects
/repositories/{repositoryName}/checked-out-objects
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2ChildFolderLink (4)
POST Create the d2ChildFolderLink
/repositories/{repositoryName}/folders/{objectId}/child-links
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the d2ChildFolderLink
/repositories/{repositoryName}/folders/{parentFolderId}/child-links/{objectId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
parentFolderId |
|
|
The r_object_id of required sysobject. |
|
|
N/A |
GET Get the d2ChildFolderLink
/repositories/{repositoryName}/folders/{parentFolderId}/child-links/{objectId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2ChildFolderLinks
/repositories/{repositoryName}/folders/{objectId}/child-links
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2ColumnPreference (3)
GET Get the d2ColumnPreferences
/repositories/{repositoryName}/d2-preferences/column-preferences
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2ColumnPreferences
/repositories/{repositoryName}/d2-preferences/column-preferences/{colType}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
column type |
|
|
The Accept header. |
|
|
N/A |
PUT Put the d2ColumnPreference
/repositories/{repositoryName}/d2-preferences/column-preferences/{colType}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
column type |
|
|
create-if-absent |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
D2Content (3)
POST Create the d2Content
/repositories/{repositoryName}/queryFormSearch
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the d2Content
/repositories/{repositoryName}/objects/{queryId}/execute
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2Content
/repositories/{repositoryName}/users/{userName}/lastSearch
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2ContentCheckinUrl
GET Get the d2ContentCheckinUrls
/repositories/{repositoryName}/objects/{objectId}/d2-content-checkin-urls
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2CreationProfile
GET Get the d2CreationProfiles
/repositories/{repositoryName}/d2-creation-profiles
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2CreationProfileValueConfig (2)
GET Get the d2CreationProfileValueConfigs
/repositories/{repositoryName}/d2-configurations/creation-profiles/{profileId}/value-configs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2CreationProfileValueConfigs
/repositories/{repositoryName}/d2-configurations/creation-profiles/{profileId}/value-configs/{configId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
configID of the creation profile |
|
|
profileId |
|
|
format |
|
|
The Accept header. |
|
|
N/A |
D2CreationPropertiesPage (2)
GET Get the d2CreationPropertiesPage
/repositories/{repositoryName}/d2-creation-properties-page
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the d2CreationPropertiesPage
/repositories/{repositoryName}/d2-creation-properties-page
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
D2Delegation (6)
POST Create the d2Delegation
/repositories/{repositoryName}/users/{userName}/delegations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
userName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the d2Delegation
/repositories/{repositoryName}/users/{userName}/delegations/{delegationId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
delegationId |
|
|
userName |
|
|
The Accept header. |
|
|
N/A |
GET Get the d2Delegation
/repositories/{repositoryName}/users/{userName}/delegations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2Delegation
/repositories/{repositoryName}/users/{userName}/delegations/{delegationId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
delegationId |
|
|
userName |
|
|
The Accept header. |
|
|
N/A |
PUT Put the d2Delegation
/repositories/{repositoryName}/users/{userName}/delegations/{delegationId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
delegationId |
|
|
userName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Put the d2Delegation
/repositories/{repositoryName}/users/{userName}/delegations/{delegationId}/undo
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
delegationId |
|
|
userName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
D2DigitalSignature (3)
GET Get the d2DigitalSignature
/repositories/{repositoryName}/d2-digital-signatures/{signatureRequestID}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PUT Put the d2DigitalSignature
/repositories/{repositoryName}/d2-digital-signatures/{signatureRequestID}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the d2DigitalSignature
/repositories/{repositoryName}/d2-digital-signatures
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2DigitalSignatureDocumentsValidator
GET Get the d2DigitalSignatureDocumentsValidator
/repositories/{repositoryName}/d2-digital-signature-documents-validator
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2DigitalSignatureSignee
GET Get the d2DigitalSignatureSignees
/repositories/{repositoryName}/d2-tasks/{taskId}/d2-digital-signature-signees
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2DisplayType (2)
GET Get the d2DisplayType
/repositories/{repositoryName}/d2-display-types/{typeName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2DisplayTypes
/repositories/{repositoryName}/d2-display-types
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2DqlDoclist
GET Get the d2DqlDoclist
/repositories/{repositoryName}/dql-doclist-objects
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2Dump
GET Get the d2Dump
/repositories/{repositoryName}/d2-dump
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2EmailAttachment
GET Get the d2EmailAttachments
/repositories/{repositoryName}/objects/{objectId}/d2-email-attachments
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2ExtSignOffAuditEvent
POST Update the d2ExtSignOffAuditEvent
/repositories/{repositoryName}/d2-ext-sign-off-audit-event
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2Favorite (3)
POST Create the d2Favorite
/repositories/{repositoryName}/favorites
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the d2Favorites
/repositories/{repositoryName}/favorites/{objectId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
objectId to be specified |
|
|
N/A |
GET Get the d2Favorites
/repositories/{repositoryName}/favorites
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2FavoritesChecker
GET Get the d2FavoritesChecker
/repositories/{repositoryName}/favorites-checker
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
object-ids |
|
|
The Accept header. |
|
|
N/A |
D2GenericActionService
POST Update the d2GenericActionService
/repositories/{repositoryName}/d2-generic-action-service
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
service_name |
|
|
method_name |
|
|
object_ids |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
D2GenericDialog
POST Update the d2GenericDialog
/repositories/{repositoryName}/d2-generic-dialog/{dialogName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
D2InheritanceConfig
GET Get the d2InheritanceConfigs
/repositories/{repositoryName}/d2-configurations/inheritance-configs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2LifecycleChangeStatePropertyPage
POST Update the d2LifecycleChangeStatePropertyPage
/repositories/{repositoryName}/d2-lifecycle-change-state-property-page
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2MassupdateConfig
GET Get the d2MassupdateConfig
/repositories/{repositoryName}/d2-configurations/massupdate-configs/{configId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2MassupdateFolderValidation
POST Update the d2MassupdateFolderValidation
/repositories/{repositoryName}/d2-massupdate-folder-validation
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
D2MassupdateObjectsValidation
POST Update the d2MassupdateObjectsValidation
/repositories/{repositoryName}/d2-massupdate-objects-validation
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
D2MassupdatePropertiesPage
POST Update the d2MassupdatePropertiesPage
/repositories/{repositoryName}/d2-massupdate-properties-page
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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 |
|
|
N/A |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
D2MassupdateProperty
PATCH Get the d2MassupdateProperties
/repositories/{repositoryName}/d2-massupdate-properties
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
D2MyWorkflowSummaryController
GET Get the d2MyWorkflowSummaryController
/repositories/{repositoryName}/d2-my-workflows/status-summary
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2MyWorkflowsCount
GET Get the d2MyWorkflowsCount
/repositories/{repositoryName}/d2-my-workflows/count
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2Note (2)
GET Get the d2Notes
/repositories/{repositoryName}/d2-workflows/{trackerId}/notes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the d2Note
/repositories/{repositoryName}/d2-workflows/{trackerId}/notes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
trackerId |
|
|
It is a task inbox queue Id. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
D2ObjectCheckinConfig
GET Get the d2ObjectCheckinConfig
/repositories/{repositoryName}/objects/{objectId}/d2-object-checkin-config
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2ObjectChronicleVersionLabel
GET Get the d2ObjectChronicleVersionLabels
/repositories/{repositoryName}/objects/{chronicleId}/d2-object-chronicle-version-labels
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
chronicleId |
|
|
The Accept header. |
|
|
N/A |
D2ObjectLinkeddocumentConfig
GET Get the d2ObjectLinkeddocumentConfig
/repositories/{repositoryName}/objects/{objectId}/d2-object-linkeddocument-config
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
N/A |
D2ObjectRelation (2)
GET Get the d2ObjectRelations
/repositories/{repositoryName}/objects/{objectId}/d2-object-relations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the d2ObjectRelation
/repositories/{repositoryName}/objects/{parentId}/d2-object-relations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
parentId of the objects |
|
|
reverse-relation |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2ObjectVersion
GET Get the d2ObjectVersions
/repositories/{repositoryName}/objects/{chronicleId}/versions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2ObjectView (4)
GET Get the d2ObjectView
/repositories/{repositoryName}/objects/{id}/audits
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2ObjectView
/repositories/{repositoryName}/objects/{id}/views/c2-export
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The Accept header. |
|
|
N/A |
GET Get the d2ObjectView
/repositories/{repositoryName}/objects/{id}/views/c2-print
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2ObjectView
/repositories/{repositoryName}/objects/{id}/views/c2-view
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
objectID to be specified |
|
|
The Accept header. |
|
|
N/A |
D2ObjectsFacet
POST Create the d2ObjectsFacet
/repositories/{repositoryName}/folders/{folderId}/objects-facets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2ObjectsLifecycleConfig
POST Update the d2ObjectsLifecycleConfig
/repositories/{repositoryName}/d2-objects-lifecycle-configs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2ObjectsPreviewFormat
GET Get the d2ObjectsPreviewFormat
/repositories/{repositoryName}/d2-objects-preview-format
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2ObjectsRelationsCount
GET Get the d2ObjectsRelationsCount
/repositories/{repositoryName}/d2-objects-relations-count
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2ObjectsSpecificPermission
GET Get the d2ObjectsSpecificPermission
/repositories/{repositoryName}/objects-specific-permission
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2Option
GET Get the d2Options
/repositories/{repositoryName}/d2-configurations/d2-options
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
N/A |
D2ParentFolderLink (5)
POST Create the d2ParentFolderLink
/repositories/{repositoryName}/objects/{objectId}/parent-links
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the d2ParentFolderLink
/repositories/{repositoryName}/objects/{objectId}/parent-links/{parentFolderId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
parentFolderId |
|
|
N/A |
GET Get the d2ParentFolderLink
/repositories/{repositoryName}/objects/{objectId}/parent-links/{parentFolderId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2ParentFolderLinks
/repositories/{repositoryName}/objects/{objectId}/parent-links
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PUT Put the d2ParentFolderLink
/repositories/{repositoryName}/objects/{objectId}/parent-links/{parentFolderId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
parentFolderId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2PerformerAliasParticipant
GET Get the d2PerformerAliasParticipants
/repositories/{repositoryName}/d2-performer-alias-participants
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
|
|
Selected document Id one has to be passed |
|
|
Workflow configuration name |
|
|
Participant attribute selected in Participant structure Workflow config |
|
|
The Accept header. |
|
|
N/A |
D2PermissionSet
GET Get the d2PermissionSet
/repositories/{repositoryName}/objects/{objectId}/d2-permission-set
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2PresetProfile (2)
GET Get the d2PresetProfile
/repositories/{repositoryName}/d2-preset-profiles/{presetProfileName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
presetProfileName of the d2-preset-profile |
|
|
The Accept header. |
|
|
N/A |
GET Get the d2PresetProfiles
/repositories/{repositoryName}/d2-preset-profiles
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2PresetProfileValueConfig (2)
GET Get the d2PresetProfileValueConfig
/repositories/{repositoryName}/d2-preset-profiles/{presetProfileName}/value-configs/{presetProfileValueConfigName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2PresetProfileValueConfigs
/repositories/{repositoryName}/d2-preset-profiles/{presetProfileName}/value-configs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2Print (2)
GET Get the d2Print
/repositories/{repositoryName}/objects/{objectId}/d2-print
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
N/A |
POST Update the d2Print
/repositories/{repositoryName}/objects/{objectId}/d2-print
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
D2ProcessVariablesDialog
GET Get the d2ProcessVariablesDialog
/repositories/{repositoryName}/process-variables-dialog
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
workflow-config-id |
|
|
document-id |
|
|
task-id |
|
|
The Accept header. |
|
|
N/A |
D2ProductInfo
GET Get the d2ProductInfo
/product-info
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Accept header. |
|
|
N/A |
D2QueryFormDialog
GET Get the d2QueryFormDialog
/repositories/{repositoryName}/d2-saved-searches/query-forms/{queryFormId}/dialog
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
queryFormId |
|
|
The Accept header. |
|
|
N/A |
D2RecentlyUsedProfile
GET Get the d2RecentlyUsedProfiles
/repositories/{repositoryName}/d2-recently-used-profiles
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2RecentlyUsedTemplate
GET Get the d2RecentlyUsedTemplates
/repositories/{repositoryName}/objects/{objectId}/d2-recently-used-templates
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2RecentlyUsedVdTemplate
GET Get the d2RecentlyUsedVdTemplates
/repositories/{repositoryName}/d2-recently-used-vd-templates
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2RelationTypesConfig
GET Get the d2RelationTypesConfig
/repositories/{repositoryName}/d2-configurations/d2-relation-types-config
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2Rendition (3)
DELETE Delete the d2Rendition
/repositories/{repositoryName}/objects/{id}/d2-renditions/{contentId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
contentId |
|
|
N/A |
GET Get the d2Rendition
/repositories/{repositoryName}/objects/{id}/d2-renditions/{contentId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2Renditions
/repositories/{repositoryName}/objects/{objectId}/d2-renditions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2SavedSearchGroup (5)
DELETE Delete the d2SavedSearchGroup
/repositories/{repositoryName}/d2-saved-search-groups/{groupId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2SavedSearchGroup
/repositories/{repositoryName}/d2-saved-search-groups/{groupId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PATCH Get the d2SavedSearchGroup
/repositories/{repositoryName}/d2-saved-search-groups/{groupId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Get the d2SavedSearchGroups
/repositories/{repositoryName}/d2-saved-search-groups
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the d2SavedSearchGroup
/repositories/{repositoryName}/d2-saved-search-groups
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
D2SavedSearchResult (2)
POST Execute the saved search with facet
/repositories/{repositoryName}/d2-saved-searches/{id}/results
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Execute the search template
/repositories/{repositoryName}/d2-saved-searches/{id}/results
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2SearchAttributeValueList
GET Get the d2SearchAttributeValueList
/repositories/{repositoryName}/d2-configurations/search-configuration/d2-search-attribute-value-list
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2SearchContent (2)
POST Create the d2SearchContent
/repositories/{repositoryName}/quickSearch
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the d2SearchContent
/repositories/{repositoryName}/quickSearch
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2SendmailConfig
GET Get the d2SendmailConfig
/repositories/{repositoryName}/d2-sendmail-config/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
ID of the sendmail config |
|
|
object_names |
|
|
locate_urls @return @throws Exception |
|
|
The Accept header. |
|
|
N/A |
D2SharedRecipient (3)
DELETE Delete the d2SharedRecipients
/repositories/{repositoryName}/objects/{id}/share-to-core/recipients
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2SharedRecipients
/repositories/{repositoryName}/objects/{id}/share-to-core/recipients
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PUT Put the d2SharedRecipient
/repositories/{repositoryName}/objects/{id}/share-to-core/recipients
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2SharedToCore (4)
DELETE Delete the d2SharedToCore
/repositories/{repositoryName}/objects/{id}/share-to-core
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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". |
|
|
N/A |
GET Get the d2SharedToCore
/repositories/{repositoryName}/objects/{id}/share-to-core
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PATCH Get the d2SharedToCore
/repositories/{repositoryName}/objects/{id}/share-to-core
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update the d2SharedToCore
/repositories/{repositoryName}/objects/{id}/share-to-core
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2SignoffIntentionsDictionary
GET Get the d2SignoffIntentionsDictionary
/repositories/{repositoryName}/signoff-intentions-dictionary
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2SilentLinkedDocumentCreation
POST Update the d2SilentLinkedDocumentCreation
/repositories/{repositoryName}/objects/{objectId}/silent-linked-document-creation
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2Sysobject
GET Get the d2Sysobjects
/repositories/{repositoryName}/objects
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2TaskDelegateUser
GET Get the d2TaskDelegateUsers
/repositories/{repositoryName}/d2-tasks/{taskId}/d2-task-delegate-users
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2TaskDigitalSignatureConfig
GET Get the d2TaskDigitalSignatureConfig
/repositories/{repositoryName}/d2-tasks/{queueItemId}/d2-task-digital-signature-config
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2TaskLifecycleCheckerController
GET Get the d2TaskLifecycleCheckerController
/repositories/{repositoryName}/d2-tasks/{taskId}/d2-task-lifecycle-condition-checker
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2TaskLockStateChecker
GET Get the d2TaskLockStateChecker
/repositories/{repositoryName}/d2-tasks/{taskId}/lock-state-checker
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
taskId |
|
|
The Accept header. |
|
|
N/A |
D2TaskPropertyPage
GET Get the d2TaskPropertyPage
/repositories/{repositoryName}/d2-tasks/{taskId}/property-page
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2TaskStatus
PUT Put the d2TaskStatus
/repositories/{repositoryName}/d2-tasks/{taskId}/status
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2TemplateValueConfig
GET Get the d2TemplateValueConfigs
/repositories/{repositoryName}/d2-configurations/default-templ-value-configs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2ThemeConfig (2)
GET Get the d2ThemeConfig
/d2-configurations/d2-theme-configs/default-theme
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Ensures 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. |
|
|
N/A |
GET Get the d2ThemeConfig
/repositories/{repositoryName}/d2-configurations/d2-theme-configs/{theme-name}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Ensures 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. |
|
|
N/A |
D2ThumbnailsUrl
GET Get the d2ThumbnailsUrl
/repositories/{repositoryName}/d2-thumbnails-url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2Type (2)
GET Get the d2Type
/repositories/{repositoryName}/d2-types/{typeName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2Types
/repositories/{repositoryName}/d2-types
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2UserProfileImage (3)
DELETE Delete the d2UserProfileImage
/repositories/{repositoryName}/users/{userName}/d2-user-profile-image
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
userName |
|
|
The Accept header. |
|
|
N/A |
GET Get the d2UserProfileImage
/repositories/{repositoryName}/users/{userName}/d2-user-profile-image
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
userName |
|
|
The Accept header. |
|
|
N/A |
POST Update the d2UserProfileImage
/repositories/{repositoryName}/users/{userName}/d2-user-profile-image
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2UserTheme
GET Get the d2UserThemes
/repositories/{repositoryName}/d2-themes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2UsersAndGroup
GET Get the d2UsersAndGroups
/repositories/{repositoryName}/d2-users-and-groups
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2VdNode (2)
GET Get the d2VdNode
/repositories/{repositoryName}/objects/{objectId}/d2-vd-nodes/{vdmNumber}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PATCH Get the d2VdNode
/repositories/{repositoryName}/objects/{objectId}/d2-vd-nodes/{vdmNumber}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2VdRelation (3)
DELETE Delete the d2VdRelation
/repositories/{repositoryName}/d2-vd-relations/{object-id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
DELETE Delete the d2VdRelations
/repositories/{repositoryName}/d2-vd-relations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PATCH Get the d2VdRelations
/repositories/{repositoryName}/d2-vd-relations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2VdSnapshot
POST Update the d2VdSnapshot
/repositories/{repositoryName}/d2-vd-snapshots
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (11)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2VdSnapshotNode
GET Get the d2VdSnapshotNodes
/repositories/{repositoryName}/snapshots/{snapshotId}/d2-vd-nodes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2VirtualDocumentNode (2)
GET Get the d2VirtualDocumentNodes
/repositories/{repositoryName}/objects/{objectId}/d2-vd-nodes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the d2VirtualDocumentNode
/repositories/{repositoryName}/objects/{objectId}/d2-vd-nodes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2VirtualDocumentTemplate
GET Get the d2VirtualDocumentTemplates
/repositories/{repositoryName}/d2-vd-templates
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WidgetConfig (2)
GET Get the d2WidgetConfig
/repositories/{repositoryName}/d2-configurations/widget-configs/{object-name}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2WidgetConfigs
/repositories/{repositoryName}/d2-configurations/widget-configs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2Workflow (2)
GET Get the d2Workflow
/repositories/{repositoryName}/d2-workflows/{trackerId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PATCH Get the d2Workflow
/repositories/{repositoryName}/d2-workflows/{trackerId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2WorkflowActivityAudit
GET Get the d2WorkflowActivityAudits
/repositories/{repositoryName}/d2-workflows/{trackerId}/activity-audits
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowAssignableSupervisor
GET Get the d2WorkflowAssignableSupervisors
/repositories/{repositoryName}/d2-workflows/{trackerId}/assignable-supervisors
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowAudit
GET Get the d2WorkflowAudits
/repositories/{repositoryName}/d2-workflows/{trackerId}/audits
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowConfig
GET Get the d2WorkflowConfig
/repositories/{repositoryName}/d2-configurations/d2-workflow-configs/{configId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowEntryConditionsChecker (2)
GET Get the d2WorkflowEntryConditionsChecker
/repositories/{repositoryName}/d2-configurations/d2-workflow-configs/{workflowConfigId}/d2-workflow-entry-conditions-checker
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2WorkflowEntryConditionsChecker
/repositories/{repositoryName}/d2-configurations/d2-workflow-configs/{workflowConfigId}/d2-workflow-packagetype-checker
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowLaunchPerformersDialog
GET Get the d2WorkflowLaunchPerformersDialog
/repositories/{repositoryName}/d2-configurations/d2-workflow-configs/{templateId}/performers-dialog
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowNotesConfig
GET Get the d2WorkflowNotesConfig
/repositories/{repositoryName}/d2-workflow-notes-config
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
|
|
The Accept header. |
|
|
N/A |
D2WorkflowOverviewWidgetUser
GET Get the d2WorkflowOverviewWidgetUsers
/repositories/{repositoryName}/d2-workflows/users
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowPerformer (2)
GET Get the d2WorkflowPerformers
/repositories/{repositoryName}/d2-workflows/{trackerId}/workflow-performers
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
trackerId |
|
|
Task inbox queue Id |
|
|
Optional param |
|
|
The workflow overview widget name |
|
|
The Accept header. |
|
|
N/A |
PATCH Get the d2WorkflowPerformers
/repositories/{repositoryName}/d2-workflows/{trackerId}/workflow-performers
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
trackerId |
|
|
Task inbox queue Id |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
D2WorkflowPerformersDialog
GET Get the d2WorkflowPerformersDialog
/repositories/{repositoryName}/d2-workflows/{trackerId}/workflow-performers-dialog
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowReportTask
GET Get the d2WorkflowReportTask
/repositories/{repositoryName}/d2-workflows/{trackerId}/d2-report-tasks/{queueItemOrWorkItem}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowReportTaskByActivity
GET Get the d2WorkflowReportTaskByActivity
/repositories/{repositoryName}/d2-workflows/{trackerId}/d2-report-tasks/{activityName}/{performerName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowStatusController
PUT Put the d2WorkflowStatusController
/repositories/{repositoryName}/d2-workflows/{trackerId}/status
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowTask
GET Get the d2WorkflowTasks
/repositories/{repositoryName}/d2-workflows/{trackerId}/d2-report-tasks
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowTasksAudit
GET Get the d2WorkflowTasksAudits
/repositories/{repositoryName}/d2-workflows/{trackerId}/d2-report-tasks/{queueItemIdOrWorkItemId}/audits
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowTemplatesController
GET Get the d2WorkflowTemplatesController
/repositories/{repositoryName}/d2-workflows/templates
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2WorkflowsCount
GET Get the d2WorkflowsCount
/repositories/{repositoryName}/d2-workflows/count
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2ZipAndDownload
POST Update the d2ZipAndDownload
/repositories/{repositoryName}/d2-zip-and-downloads
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
D2ZipAndDownloadContent
GET Get the d2ZipAndDownloadContent
/repositories/{repositoryName}/d2-zip-and-downloads/{tracker_id}/content
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
tracker_id |
|
|
file_name |
|
|
The Accept header. |
|
|
N/A |
D2ZipAndDownloadStatus (2)
GET Get the d2ZipAndDownloadStatus
/repositories/{repositoryName}/d2-zip-and-downloads/{tracker_id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PUT Put the d2ZipAndDownloadStatus
/repositories/{repositoryName}/d2-zip-and-downloads/{tracker_id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2ZipAndDownloadValidation
POST Update the d2ZipAndDownloadValidation
/repositories/{repositoryName}/d2-zip-and-download-validation
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
D2_workflow_supporting_document_count
GET Get the d2_workflow_supporting_document_count
/repositories/{repositoryName}/d2-workflows/{trackerId}/supporting-documents/count
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2_workflow_working_document_count
GET Get the d2_workflow_working_document_count
/repositories/{repositoryName}/d2-workflows/{trackerId}/working-documents/count
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2lifecycle (2)
GET Get the d2lifecycle
/repositories/{repositoryName}/d2-configurations/lifecycle-configs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the d2lifecycle
/repositories/{repositoryName}/d2-configurations/lifecycle-configs/{object-name}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2locate
GET Get the d2locate
/repositories/{repositoryName}/locate
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2location
GET Get the d2locations
/repositories/{repositoryName}/objects-locations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
D2objectcheckoutconfig
GET Get the d2objectcheckoutconfig
/repositories/{repositoryName}/objects/{object-id}/object-checkout-config
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
N/A |
D2objectsendmailconfig
GET Get the d2objectsendmailconfig
/repositories/{repositoryName}/objects/{object-id}/object-sendmail-config
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
It gives the url of the object being shared. |
|
|
The Accept header. |
|
|
N/A |
D2userpreference (2)
GET Get the d2userpreferences
/repositories/{repositoryName}/d2-preferences
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PATCH Get the d2userpreferences
/repositories/{repositoryName}/d2-preferences
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
D2userwidgetconfig
GET Get the d2userwidgetconfig
/repositories/{repositoryName}/d2-widgets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Dar (3)
POST Create the dar (Documentum REST)
/repositories/{repositoryName}/dars
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the dar (Documentum REST)
/repositories/{repositoryName}/dars/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the dars (Documentum REST)
/repositories/{repositoryName}/dars
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
DcCompletion
POST Update the dcCompletion (Documentum REST)
/dc-completion
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
dc-token |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DefaultFolder
GET Get the defaultFolder (Documentum REST)
/repositories/{repositoryName}/users/{userName}/home
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
DialogOptionsController
GET Get the dialogOptionsController
/repositories/{repositoryName}/dialog-options/{option}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
option |
|
|
N/A |
|
|
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. |
|
|
N/A |
DqlQuery (2)
POST Create the dqlQuery (Documentum REST)
/repositories/{repositoryName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the dqlQuery (Documentum REST)
/repositories/{repositoryName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
EventHubEventCreation
POST Update the eventHubEventCreation (Documentum REST)
/repositories/{repositoryName}/event-hub-event
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
ExternalShareChecker
GET Get the externalShareChecker
/repositories/{repositoryName}/external-share-checker
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
ExternalShareObject
GET Get the externalShareObjects
/repositories/{repositoryName}/external-share-objects
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Favorite (2)
GET Get the favorites
/repositories/{repositoryName}/is-favorite/{objectId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
objectId to be specified |
|
|
The Accept header. |
|
|
N/A |
GET Get the favorites
/repositories/{repositoryName}/users/{userName}/favorites
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
FederatedSearch (2)
POST Create the federatedSearch (Documentum REST)
/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the federatedSearch (Documentum REST)
/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
FolderChildFolder (2)
POST Create the folderChildFolder (Documentum REST)
/repositories/{repositoryName}/folders/{folderId}/folders
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
folderId |
|
|
constraint-validation-policy |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the folderChildFolders (Documentum REST)
/repositories/{repositoryName}/folders/{folderId}/folders
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
FolderPathCreation
POST Create the folderPathCreation
/repositories/{repositoryName}/folders/{folderId}/folder-path-creation
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
folderId |
|
|
inherit_parent_acl |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
FolderStructureConverionConfig
GET Get the folderStructureConverionConfig
/repositories/{repositoryName}/folders/{objectId}/folder-structure-conversion-config
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
N/A |
FolderStructureImportConfig
GET Get the folderStructureImportConfigs
/repositories/{repositoryName}/folder-structure-import-configs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
FolderStructureImportUrl
GET Get the folderStructureImportUrls
/repositories/{repositoryName}/folder-structure-import-urls
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
N/A |
Format (2)
GET Get the d2formats
/repositories/{repositoryName}/formats
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the format (Documentum REST)
/repositories/{repositoryName}/formats/{formatName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Group (5)
POST Create the group (Documentum REST)
/repositories/{repositoryName}/groups
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the group (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
groupName |
|
|
N/A |
GET Get the group (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the groups (Documentum REST)
/repositories/{repositoryName}/groups
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the group (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
GroupMemberGroup (3)
POST Create the groupMemberGroup (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}/groups
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
groupName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the groupMemberGroup (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}/groups/{memberName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
groupName |
|
|
memberName |
|
|
N/A |
GET Get the groupMemberGroups (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}/groups
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GroupMemberUser (3)
POST Create the groupMemberUser (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}/users
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
groupName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the groupMemberUser (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}/users/{userName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
groupName |
|
|
userName |
|
|
N/A |
GET Get the groupMemberUsers (Documentum REST)
/repositories/{repositoryName}/groups/{groupName}/users
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
HomeDocument
GET Get the homeDocument (Documentum REST)
/services
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Accept header. |
|
|
N/A |
Inbox
GET Get the inbox (Documentum REST)
/repositories/{repositoryName}/inbox
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
InboxItem (3)
DELETE Delete the inboxItem (Documentum REST)
/repositories/{repositoryName}/inbox/{itemId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
itemId |
|
|
N/A |
GET Get the inboxItem (Documentum REST)
/repositories/{repositoryName}/inbox/{itemId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PUT Put the inboxItem (Documentum REST)
/repositories/{repositoryName}/inbox/{itemId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
itemId |
|
|
action |
|
|
delegate-user |
|
|
repeat-users |
|
|
signoff-password |
|
|
activity |
|
|
assign-performers |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Job (5)
POST Create the job (Documentum REST)
/repositories/{repositoryName}/jobs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the job (Documentum REST)
/repositories/{repositoryName}/jobs/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
N/A |
GET Get the job (Documentum REST)
/repositories/{repositoryName}/jobs/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the jobs (Documentum REST)
/repositories/{repositoryName}/jobs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the job (Documentum REST)
/repositories/{repositoryName}/jobs/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
Lifecycle (2)
GET Get the lifecycle (Documentum REST)
/repositories/{repositoryName}/lifecycles/{objectId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the lifecycles (Documentum REST)
/repositories/{repositoryName}/lifecycles
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Mail
POST Update the mail (Documentum REST)
/appworks/mail
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
otagtoken |
|
|
async |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Materialization (2)
DELETE Delete the materialization (Documentum REST)
/repositories/{repositoryName}/objects/{id}/materialization
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
N/A |
PUT Put the materialization (Documentum REST)
/repositories/{repositoryName}/objects/{id}/materialization
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Method (5)
POST Create the method (Documentum REST)
/repositories/{repositoryName}/methods
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
method-category |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the method (Documentum REST)
/repositories/{repositoryName}/methods/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
del-version |
|
|
del-vd-all |
|
|
N/A |
GET Get the method (Documentum REST)
/repositories/{repositoryName}/methods/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the methods (Documentum REST)
/repositories/{repositoryName}/methods
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the method (Documentum REST)
/repositories/{repositoryName}/methods/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
Module (3)
GET Get the module (Documentum REST)
/repositories/{repositoryName}/modules/{moduleId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the modules (Documentum REST)
/repositories/{repositoryName}/modules
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the module (Documentum REST)
/repositories/{repositoryName}/modules/{moduleId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
NetworkLocation (2)
GET Get the networkLocation (Documentum REST)
/repositories/{repositoryName}/network-locations/{networkLocationIdentifier}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the networkLocations (Documentum REST)
/repositories/{repositoryName}/network-locations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
NotesCount
GET Get the notesCount
/repositories/{repositoryName}/d2-workflows/{trackerId}/notes/count
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Notification
POST Update the notification (Documentum REST)
/appworks/notification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
otagtoken |
|
|
client-id |
|
|
send-to-admins |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
ObjectAspect (3)
DELETE Delete the objectAspect (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/aspects/{aspectName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
aspectName |
|
|
N/A |
GET Get the objectAspects (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/aspects
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the objectAspect (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/aspects
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
ObjectLifecycle (3)
DELETE Delete the objectLifecycle (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
N/A |
GET Get the objectLifecycle (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PUT Put the objectLifecycle (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
ObjectLifecycleDemotion (2)
DELETE Delete the objectLifecycleDemotion (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/demotion
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
schedule |
|
|
N/A |
PUT Put the objectLifecycleDemotion (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/demotion
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
ObjectLifecyclePromotion (2)
DELETE Delete the objectLifecyclePromotion (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/promotion
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
schedule |
|
|
N/A |
PUT Put the objectLifecyclePromotion (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/promotion
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
ObjectLifecycleResumption (2)
DELETE Delete the objectLifecycleResumption (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/resumption
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
schedule |
|
|
N/A |
PUT Put the objectLifecycleResumption (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/resumption
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
ObjectLifecycleSuspension (2)
DELETE Delete the objectLifecycleSuspension (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/suspension
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
schedule |
|
|
N/A |
PUT Put the objectLifecycleSuspension (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lifecycle/suspension
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
ObjectLightweightObject (2)
POST Create the objectLightweightObject (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lw-objects
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
format |
|
|
content-length |
|
|
content-charset |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the objectLightweightObjects (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/lw-objects
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
ObjectParent (2)
GET Get the objectParent (Documentum REST)
/repositories/{repositoryName}/objects/{id}/parent
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the objectParent (Documentum REST)
/repositories/{repositoryName}/objects/{id}/parent
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
ObjectSubscription (2)
DELETE Delete the objectSubscription (Documentum REST)
/repositories/{repositoryName}/objects/{id}/subscription
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
N/A |
PUT Put the objectSubscription (Documentum REST)
/repositories/{repositoryName}/objects/{id}/subscription
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Permission
GET Get the permissions (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/permissions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PermissionSet (2)
GET Get the permissionSet (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/permission-set
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PUT Put the permissionSet (Documentum REST)
/repositories/{repositoryName}/objects/{objectId}/permission-set
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of required sysobject. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
QueueTask (3)
GET Get the queueTask (Documentum REST)
/repositories/{repositoryName}/queue-tasks/{itemId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the queueTasks (Documentum REST)
/repositories/{repositoryName}/queue-tasks
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PUT Put the queueTask (Documentum REST)
/repositories/{repositoryName}/queue-tasks/{itemId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
itemId |
|
|
action |
|
|
pulled |
|
|
unsuspend-time |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
RecentlyAccessedController
GET Get the recentlyAccessedController
/repositories/{repositoryName}/recently-accessed
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
RelatedDoc
GET Get the relatedDocs (Documentum REST)
/repositories/{repositoryName}/documents/{id}/related-docs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
RelatedSme
GET Get the relatedSme (Documentum REST)
/repositories/{repositoryName}/documents/{id}/related-sme
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
RelationType (2)
GET Get the relationType (Documentum REST)
/repositories/{repositoryName}/relation-types/{relationName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the relationTypes (Documentum REST)
/repositories/{repositoryName}/relation-types
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Repository
GET Get the repositories (Documentum REST)
/repositories
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
SavedSearch (3)
DELETE Delete the savedSearch (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
N/A |
GET Get the savedSearch (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the savedSearch (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
query-locale |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
SavedSearchExecution
GET Get the savedSearchExecution (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}/execution
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
SavedSearchResult (3)
DELETE Delete the savedSearchResults (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}/results
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
N/A |
GET Get the savedSearchResults (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}/results
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PUT Put the savedSearchResult (Documentum REST)
/repositories/{repositoryName}/saved-searches/{id}/results
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Search (2)
POST Create the search (Documentum REST)
/repositories/{repositoryName}/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the search (Documentum REST)
/repositories/{repositoryName}/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
SearchTemplate (4)
POST Create the searchTemplate
/repositories/{repositoryName}/search-templates
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
query-locale |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the search template
/repositories/{repositoryName}/search-templates/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The r_object_id of queried object. |
|
|
N/A |
GET Get the search template
/repositories/{repositoryName}/search-templates/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the searchTemplates
/repositories/{repositoryName}/search-templates
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
SearchTemplateExecution (7)
PUT Create or update the search template
/repositories/{repositoryName}/d2-saved-searches/{savedSearchObjectId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Execute the search template
/repositories/{repositoryName}/d2-saved-searches/{savedSearchObjectId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Execute the search template
/repositories/{repositoryName}/d2-saved-searches
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Execute the search template
/repositories/{repositoryName}/d2-saved-searches/query-forms/{queryFormId}/results
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Execute the search template
/repositories/{repositoryName}/search-templates/{id}/execution
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the search template
/repositories/{repositoryName}/d2-saved-searches
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PATCH Update the search template
/repositories/{repositoryName}/d2-saved-searches/{savedSearchObjectId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
SignificantTerm
GET Get the significantTerms (Documentum REST)
/repositories/{repositoryName}/documents/{id}/significant-terms
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Subscription
GET Get the subscriptions (Documentum REST)
/repositories/{repositoryName}/subscriptions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
SupportedFacet
GET Get the supportedFacets (Documentum REST)
/repositories/{repositoryName}/supported-facets
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Synonym
GET Get the synonyms (Documentum REST)
/repositories/{repositoryName}/cce/synonyms
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
SynonymCategory
GET Get the synonymCategories (Documentum REST)
/repositories/{repositoryName}/cce/synonym-categories
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
TaskList (2)
GET Get the taskList
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
taskId |
|
|
taskName |
|
|
processId |
|
|
processName |
|
|
includeContentURL |
|
|
The Accept header. |
|
|
N/A |
GET Get the taskList
/repositories/{repositoryName}/tasklist
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
TaskNote (2)
GET Get the taskNotes
/repositories/{repositoryName}/d2-tasks/{taskId}/notes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PUT Put the taskNote
/repositories/{repositoryName}/d2-tasks/{taskId}/notes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
taskId of the d2-task |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
TaskStatus (2)
GET Get the taskStatus
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/status
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
taskId |
|
|
taskName |
|
|
processId |
|
|
processName |
|
|
The Accept header. |
|
|
N/A |
PUT Put the taskStatus
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/status
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
taskId |
|
|
taskName |
|
|
processId |
|
|
processName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
Taskattachment (4)
DELETE Delete the taskattachment
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/attachments
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
taskId |
|
|
taskName |
|
|
processId |
|
|
processName |
|
|
The Accept header. |
|
|
N/A |
GET Get the taskattachment
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/attachments
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the taskattachment
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/master-documents
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PUT Put the taskattachment
/repositories/{repositoryName}/processes/{processName}/{processId}/{taskName}/{taskId}/attachments
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
taskId |
|
|
taskName |
|
|
processId |
|
|
processName |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
Taxonomy
GET Get the taxonomy
/repositories/{repositoryName}/d2-configurations/taxonomy/{taxonomy_name}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
ThumbnailUrl
GET Get the thumbnailUrl
/repositories/{repositoryName}/objects/{id}/d2-thumbnail-url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Type (2)
GET Get the type (Documentum REST)
/repositories/{repositoryName}/types/{type}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the types (Documentum REST)
/repositories/{repositoryName}/types
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
TypeAssistValue
POST Update the typeAssistValue (Documentum REST)
/repositories/{repositoryName}/types/{typeName}/assist-values
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
User (5)
POST Create the user (Documentum REST)
/repositories/{repositoryName}/users
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the user (Documentum REST)
/repositories/{repositoryName}/users/{userName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
userName |
|
|
N/A |
GET Get the user (Documentum REST)
/repositories/{repositoryName}/users/{userName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the users (Documentum REST)
/repositories/{repositoryName}/users
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the user (Documentum REST)
/repositories/{repositoryName}/users/{userName}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
UserDefinedCollection (4)
DELETE Delete the userDefinedCollections
/repositories/{repositoryName}/collections/user-defined/{collectionId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
Collection ID to fetch User Defined Collections |
|
|
N/A |
GET Get the userDefinedCollections
/repositories/{repositoryName}/collections/user-defined
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the userDefinedCollection
/repositories/{repositoryName}/collections/user-defined
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update the userDefinedCollections
/repositories/{repositoryName}/collections/user-defined/{collectionId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
Collection ID to fetch User Defined Collections |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
UserDefinedCollectionItem (3)
DELETE Delete the userDefinedCollectionItems
/repositories/{repositoryName}/collections/user-defined/{collectionId}/items
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
collectionId |
|
|
N/A |
GET Get the userDefinedCollectionItems
/repositories/{repositoryName}/collections/user-defined/{collectionId}/items
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the userDefinedCollectionItem
/repositories/{repositoryName}/collections/user-defined/{collectionId}/items
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
collectionId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
UserPermissionSet
GET Get the userPermissionSet (Documentum REST)
/repositories/{repositoryName}/users/{userName}/permission-set
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
VdSnapshot (4)
POST Create the vdSnapshot (Documentum REST)
/repositories/{repositoryName}/snapshots
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the vdSnapshot (Documentum REST)
/repositories/{repositoryName}/snapshots/{snapshotId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
snapshotId |
|
|
N/A |
GET Get the vdSnapshot (Documentum REST)
/repositories/{repositoryName}/snapshots/{snapshotId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the vdSnapshots (Documentum REST)
/repositories/{repositoryName}/snapshots
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
VdSnapshotFrozen (2)
DELETE Delete the vdSnapshotFrozen (Documentum REST)
/repositories/{repositoryName}/snapshots/{snapshotId}/frozen
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
snapshotId |
|
|
N/A |
PUT Put the vdSnapshotFrozen (Documentum REST)
/repositories/{repositoryName}/snapshots/{snapshotId}/frozen
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
snapshotId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
VdSnapshotNode
GET Get the vdSnapshotNodes (Documentum REST)
/repositories/{repositoryName}/snapshots/{objectId}/vd-nodes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
VirtualDocumentRelation (3)
DELETE Delete the virtualDocumentRelation (Documentum REST)
/repositories/{repositoryName}/vd-relations/{nodeId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
nodeId |
|
|
N/A |
GET Get the virtualDocumentRelation (Documentum REST)
/repositories/{repositoryName}/vd-relations/{nodeId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the virtualDocumentRelation (Documentum REST)
/repositories/{repositoryName}/vd-relations/{nodeId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
nodeId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
WordSuggestion
GET Get the wordSuggestions (Documentum REST)
/repositories/{repositoryName}/cce/suggestions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
WorkItem (2)
GET Get the workItem (Documentum REST)
/repositories/{repositoryName}/work-items/{itemId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the workItems (Documentum REST)
/repositories/{repositoryName}/workflows/{workflowId}/work-items
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
WorkQueue (2)
GET Get the workQueue (Documentum REST)
/repositories/{repositoryName}/work-queues/{queueId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the workQueues (Documentum REST)
/repositories/{repositoryName}/work-queues
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
Workflow (4)
POST Create the workflow (Documentum REST)
/repositories/{repositoryName}/workflows
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
quick-flow |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the workflow (Documentum REST)
/repositories/{repositoryName}/workflows/{workflowId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the workflows (Documentum REST)
/repositories/{repositoryName}/workflows
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PUT Put the workflow (Documentum REST)
/repositories/{repositoryName}/workflows/{workflowId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
workflowId |
|
|
action |
|
|
activity |
|
|
supervisor |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
WorkflowActivity (2)
GET Get the workflowActivities (Documentum REST)
/repositories/{repositoryName}/workflow-templates/{templateId}/activities
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the workflowActivity (Documentum REST)
/repositories/{repositoryName}/workflow-activities/{activityId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
WorkflowAttachment (3)
POST Create the workflowAttachment (Documentum REST)
/repositories/{repositoryName}/workflows/{workflowId}/attachments
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
workflowId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete the workflowAttachment (Documentum REST)
/repositories/{repositoryName}/workflows/{workflowId}/attachments/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
workflowId |
|
|
The r_object_id of queried object. |
|
|
N/A |
GET Get the workflowAttachments (Documentum REST)
/repositories/{repositoryName}/workflows/{workflowId}/attachments
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
WorkflowTaskPackage (3)
GET Get the workflowTaskPackage (Documentum REST)
/repositories/{repositoryName}/work-items/{itemId}/packages/{index}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the workflowTaskPackages (Documentum REST)
/repositories/{repositoryName}/work-items/{itemId}/packages
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
POST Update the workflowTaskPackage (Documentum REST)
/repositories/{repositoryName}/work-items/{itemId}/packages/{index}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
itemId |
|
|
index |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (13)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
WorkflowTaskPackageDocument
DELETE Delete the workflowTaskPackageDocuments (Documentum REST)
/repositories/{repositoryName}/work-items/{itemId}/packages/{index}/documents
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
itemId |
|
|
index |
|
|
N/A |
WorkflowTaskPackageNote
DELETE Delete the workflowTaskPackageNote (Documentum REST)
/repositories/{repositoryName}/work-items/{itemId}/packages/{index}/notes/{noteId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
itemId |
|
|
index |
|
|
noteId |
|
|
N/A |
WorkflowTemplate (4)
GET Get the workflowTemplate (Documentum REST)
/repositories/{repositoryName}/workflow-templates/{templateId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
GET Get the workflowTemplates (Documentum REST)
/repositories/{repositoryName}/workflow-templates
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
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. |
|
|
N/A |
PUT Put the workflowTemplate (Documentum REST)
/repositories/{repositoryName}/workflow-templates/{templateId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
templateId |
|
|
action |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
POST Update the workflowTemplate (Documentum REST)
/repositories/{repositoryName}/workflow-templates/{templateId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repository name. |
|
|
templateId |
|
|
The Accept header. |
|
|
The Content-Type header. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |