Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
hiddentrue
idPROGRESSDONE

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje08 NOV 20212021 WinterPage created.


...

As of Version

product version 2021 Winter | component version 

Request MethodGET
Response FormatJSON
Description


Excerpt

Retrieve Retrieves the object types that are available for all available actions on DMS objects for the currently logged-in user. Available options actions are create, write, read and  and delete (see Roleset Role set documentation).


The response body is a JSON structure listing the object types grouped in instantiable object types (including folder and document object types) and secondary object types for each action. Every missing action in the response map indicates a prohibited action for this user.

Note: The list of available object types might contain types that are forbidden under specific conditions defined in the role set. If a role contains a permission for the specified action that is limited by a condition, this condition can reference type-specific metadata properties. In this case, the entire condition is always evaluated to as true.


Request Example

https://<host>/search/api/search/dsl/check

Response Example


Code Block
languageyml
{
	"CREATE": {
		"secondaryObjectTypeIds": [],
		"objectTypeIds": []
	},
    "WRITE": {
		"secondaryObjectTypeIds": [
			"system:rmDestructionRetention",
			"appClient:clientdefaults"
		],
		"objectTypeIds": [
			"email:email",
			"appEmail:email"
		]
	},
    "READ": {
		"secondaryObjectTypeIds": [
			"system:rmDestructionRetention",
			"appClient:clientdefaults"
		],
		"objectTypeIds": [
			"email:email",
			"appEmail:email",
            "document:invoice"
		]
	}
}


...