GET /search/api/search/dsl/check/{action}

Owned by Technische Redaktion
Nov 12, 2021
1 min read
As of Version

product version 2021 Winter | component version 

Request MethodGET
Response FormatJSON
Description

Retrieves the object types that are available for the specified action on DMS objects for the currently logged-in user. Available options are create, write, read and delete (see 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. An empty 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 as true.


Request Example

/search/api/search/dsl/check/create

Response Example
{
	"CREATE": {
		"secondaryObjectTypeIds": [
			"system:rmDestructionRetention",
			"appClient:clientdefaults"
		],
		"objectTypeIds": [
			"email:email".
			"appEmail:email"
		]
	}
}