Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

As of Version

product version 2021 Winter | component version 

Request MethodGET
Response FormatJSON
Description

Retrieve the object types that are available for all available actions on DMS objects for the currently logged-in user. Available options are create, write, read and delete (see Roleset 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. 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 true.


Request Example

/search/api/search/dsl/check

Response Example
{
	"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"
		]
	}
}
  • No labels