GetAssociatedFilePathsByIds Method
Gets associated file paths for a list of file Ids.
Required Permissions
FileReadSyntax
public FilePathArray[] GetAssociatedFilePathsByIds(
System.long[] fileIds,
FileAssociationTypeEnum parentAssociationType,
System.bool parentRecurse,
FileAssociationTypeEnum childAssociationType,
System.bool childRecurse,
System.bool includeRelatedDocuments,
System.bool includeHidden
)Public Function GetAssociatedFilePathsByIds( _
ByVal fileIds() As System.Long, _
ByVal parentAssociationType As FileAssociationTypeEnum, _
ByVal parentRecurse As System.Boolean, _
ByVal childAssociationType As FileAssociationTypeEnum, _
ByVal childRecurse As System.Boolean, _
ByVal includeRelatedDocuments As System.Boolean, _
ByVal includeHidden As System.Boolean _
) As FilePathArray()Parameters
| Name | Description |
|---|---|
| fileIds | An array of file Ids in the Vault. |
| parentAssociationType | The types of parents to get. |
| parentRecurse | Indicates whether multiple levels of associated files should be returned. When false, only immediate parent associated files are returned. When true, associations are recursed to return all available levels of hierarchy (e.g. parents/grandparents/great-grandparents). |
| childAssociationType | The types of children to get. |
| childRecurse | Indicates whether multiple levels of associated files should be returned. When false, only immediate child associated files are returned. When true, associations are recursed to return all available levels of hierarchy (e.g. children/grandchildren/great-grandchildren). |
| includeRelatedDocuments | If true, parent design documents are returned for all returned files. If false, no additional files will be added to the return set. |
| includeHidden | If true, files marked as hidden will show up in the search. Otherwise hidden files will be excluded. |
Return Value
A list of FilePathArray objects related to the input fileIds array. The order of the items is not guaranteed.