Skip to main content

GetObjectDataOfMultipleObjects

Gets requested information about the specified objects.

Syntax

// Assumes shellUI has been initialized with IShellUI instance
const results =
await shellUI.Vault.ObjectOperations.GetObjectDataOfMultipleObjects({
obj_vers: [] /* Array of ObjVer */,
data_request: {
required_data_flags: {
all: false,
object_version: false,
properties: false,
acl: false,
current_user_permissions: false,
properties_for_display: false,
relationships: false,
collection_member_relationships: false,
object_activities: false,
},
error_tolerance: 1 /* Enum: ObjectVersionDataRequestErrorTolerance */,
identity_type: 1 /* Enum: ObjectVersionDataRequestIdentityType */,
object_activities_parameters: {
category_filter: {
all: false,
metadata: false,
file_content: false,
comments: false,
},
limit: 0,
offset_obj_ver_version: {
type: 7 /* Enum: ObjVerVersionType */,
internal_version: 0,
external_repository_version: "<external_repository_version>",
external_repository_sort_key: 0,
},
},
},
});

Message

NameDescriptionType
obj_versObject versions as JSON.ObjVer[]
data_requestObject data request.ObjectVersionDataRequest

Return type

NameDescriptionType
resultsReceives information about the requested objects as JSON array (represented by CMF_ObjectVersionDataResult struct.) The results are ordered in the same way as the input object versions.ObjectVersionDataResult[]

Example

{
"results": [] /* Array of ObjectVersionDataResult */
}