REST examples (Browser Binding)

Example to query ArchiveLink repositories:

The interface allows data to be retrieved and set.

Authorization is required for this. Basic Auth and Token Auth according to OIDC are currently supported.

Determining the repository

URL:

<Host>:<Port>/<context>/browser/

Answer (Extract):

{
    "rfHN5c3RlbXwxfEZJfC8=": {
        "repositoryId": "rfHN5c3RlbXwxfEZJfC8=",
        "repositoryName": "FI",

Here the repositoryId must be determined via the repositoryName. All further queries require the repositoryId.

Querying data:

URL:

<Host>:<Port>/<context>/browser/<RepositoryID>/root/Knowledge%20Provider/ArchiveLink/<docId>/<ComponentId>?cmisselector=object&includeAllowableActions=true&includeRelationships=none&renditionFilter=cmis%3Anone&includePolicyIds=false&includeACL=false&succinct=true

Answer (Extract):

{
    "succinctProperties": {
        "cmis:baseTypeId": "cmis:document",
        "cmis:objectTypeId": "cmis:document",
        "cmis:objectId": "dfHN5c3RlbXwxfEZJfC9Lbm93bGVkZ2UgUHJvdmlkZXIvQXJjaGl2ZUxpbmsvNEEwRUMxNDNDRTUwNDQ5Nzg3NkY2QUMzQkY5OUQzRUQvZGF0YTI=",
        "cmis:name": "data2",
        "cmis:createdBy": "s.franz",
        "cmis:lastModifiedBy": "s.franz",
        "cmis:creationDate": 1637313879232,
        "cmis:lastModificationDate": 1637319263363,
        "cmis:rm_startOfRetention": 1637313879232,
        "cmis:rm_expirationDate": 1637317479232,

This interface allows to get the properties of an ArchiveLink component. Here in the field cmis:rm_expirationDate the retention end date is stored. The format is Unixtime in milliseconds (UTC time zone) .

The cmis:objectId is needed for changing the data.

Updating data:

<Host>:<Port>/<context>/browser/<RepositoryId>/root?objectId=<ObjectId>

POST body with ContentType: application/x-ww-form-urlencoded

cmisaction=update&propertyId%5B0%5D=cmis%3AsecondaryObjectTypeIds&propertyValue%5B0%5D=cmis%3Arm_clientMgtRetention&propertyId%5B1%5D=cmis%3Arm_expirationDate&propertyValue%5B1%5D=<expirationDate>&succinct=true

The format for <exprirationDate> is Unixtime in milliseconds (UTC time zone). It is only allowed to set the date into the future. The date to be set must be greater than an existing date.

HTTP status code 200 on successful execution.

Here are more examples: https://docs.oasis-open.org/cmis/CMIS/v1.1/os/examples/browser/

Attached is also a simple Postman example: