Page Comparison

...

Page Properties

hidden	true
id	DONE

Product Version
Report Note
Assignee

Resources & Remarks

OKTO-4413 - added info about includePermissions parameter

Modification History

Name	Date	Product Version	Action
Antje	08 FEB 2021	2.4	New page properties macro.
Antje	16 MAR 2022	2022 Summer	retention is considered in permissions section
Agnieszka	24 MAR 2022	2022 Summer	rLANG

As of Version

product version 1.0 | component version 1.0

Request Method GET

Response Format JSON

Required Permission action read
>> Roles and Role Sets

Description

To retrieve the metadata of a DMS object, send the request with the ID of the DMS object as objectId.

Exclusively for this endpoint, you can use the includePermissions query parameter to define, whether the information on permissions is part of the result (true) or not (false). Default value is false.
As of 2022 Summer, retentions are considered for the display of the available permissions. Thus, if the requested object is under retention, the delete permission is not available and the write permission can only be made available for metadata.

Request Example

Examle (A)/api/dms/objects/cdc7095f-a5ce-486d-92a7-6d0955d969ee

Example (B)
/api/dms/objects/cdc7095f-a5ce-486d-92a7-6d0955d969ff?includePermissions=true

Result Example

Example (A)

Code Block

{
	"objects": [{
		"properties": {
			"system:objectId": {
				"value": "cdc7095f-a5ce-486d-92a7-6d0955d969ee"
			},
			"system:baseTypeId": {
				"value": "system:document"
			},
			"system:objectTypeId": {
				"value": "appEmail:email"
			},
			"system:createdBy": {
				"value": "0d7fd0be-6a0b-4d3b-933c-25e0c4c5d794"
			},
			"system:creationDate": {
				"value": "2018-01-26T15:21:170Z"
			},
			"system:lastModifiedBy": {
				"value": "0d7fd0be-6a0b-4d3b-933c-25e0c4c5d794"
			},
			"system:lastModificationDate": {
				"value": "2018-01-26T15:21:170Z"
			},
			"system:versionNumber": {
				"value": 1
			},
			"system:tenant": {
				"value": "tenant1"
			},
			"system:traceId": {
				"value": "97a35859dbb4c435"
			},
			"appEmail:from": {
				"value": "Garco Meissler <garco@example.de>"
			},
			"appEmail:to": {
				"value": ["Dudreas Annkel <dudreas@example.de>"]
			},
			"appEmail:cc": {
				"value": ["Kruedeas Anger <kruedeas@example.de>"]
			},
			"appEmail:subject": {
				"value": "Bewerbungsunterlagen"
			}
		},
		"contentStreams": [{
			"contentStreamId": "2B797243-A1F5-11EA-A814-9FABD98CE7A7",
			"length": 173413,
			"mimeType": "message/rfc822",
			"fileName": "upload.eml",
			"digest": "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855",
			"repositoryId": "repo252"
		}]
	}]
}

Example (B)

Code Block

language	yml

{
    "objects": [
        {
            "properties": {
                "system:traceId": {
                    "value": "97a35859dbb4c436"
                },
                "system:objectTypeId": {
                    "value": "appMyapp:mydocumenttype"
                },
                "system:secondaryObjectTypeIds": {
                    "value": [
                        "system:rmDestructionRetention"
                    ]
                },
                "appMyapp:name": {
                    "value": "testdocument"
                },
                "system:versionNumber": {
                    "value": 1
                },
                "system:createdBy": {
                    "value": "0d7fd0be-6a0b-4d3b-933c-25e0c4c5d794"
                },
                "system:rmExpirationDate": {
                    "value": "2042-03-16T17:44:54.410Z"
                },
                "system:creationDate": {
                    "value": "2022-03-16T13:03:52.720Z"
                },
                "system:lastModificationDate": {
                    "value": "2022-03-16T13:03:52.720Z"
                },
                "system:baseTypeId": {
                    "value": "system:document"
                },
                "system:tenant": {
                    "value": "tenant1"
                },
                "system:lastModifiedBy": {
                    "value": "0d7fd0be-6a0b-4d3b-933c-25e0c4c5d794"
                },
                "system:objectId": {
                    "value": "cdc7095f-a5ce-486d-92a7-6d0955d969ff"
                }
            },
            "contentStreams": [
                {
                    "contentStreamId": "2B797243-A1F5-11EA-A814-9FABD98CE7A8",
                    "archivePath": "default/DOCUMENT/00/A9/9/",
                    "length": 23,
                    "mimeType": "text/plain",
                    "fileName": "myfilename.txt",
                    "digest": "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B856",
                    "repositoryId": "repo252es"
                }
            ],
            "permissions": {
                "read": [
                    "metadata",
                    "content"
                ],
                "create": [
                    "metadata",
                    "content"
                ],
                "write": [
                    "metadata"
                ]
            }
        }
    ]
}

...

Versions Compared

Old Version 14

New Version Current

Key