Getting document report using ISHRemote API

Question

Hi, 
 Is there a way to view the referenced topics/images for a document using the ISHRemote API? 
 My end goal would be to create a report on document reuse. 
 
 Thank you, 
 Madison

Dave De Meyer · Accepted Answer

Hi Madison, 
 Every object in the Content Manager system has many fields defined, which are categorized in System (S), Descriptive (D) and Basic (B). Have a look at the difference on https://github.com/sdl/ISHRemote/blob/master/Doc/ReleaseNotes-ISHRemote-0.7.md section " Sample - Descriptive, Basic and All Fields" 
 You can recognize which fields are part of which group by the SDB column when running Get-IshTypeFieldDefinition 
 To connect the dots, your Get-IshFolderContent call uses the default value of $ishSession.DefaultRequestedMetadata which is to NOT return system fields like FISHLINK. Hence when you do your lookup, it shows up empty . 
 The simple way out is to do: $ishSession.DefaultRequestedMetadata = 'All'. This however means you are retrieving literally all fields which has a potential severe performance impact! So okay for a small data set or a one time run. 
 If you run your script often, I would suggest to explicitly request the specific fields you need by a: Get-IshDocumentObj -IshObject $content -RequestedMetadata (Set-IshRequestedMetadataField -Name FISHLINKS -Level Lng | Set-IshRequestedMetadataField ...) 
 Small hint on your Get-IshMetadataField usage, since ISHRemote 0.7 you can use the provided PSNoteProperties, see inside https://github.com/sdl/ISHRemote/releases/tag/v0.7 In short you can write: $content[0].fishlinks 
 Hope this helps, Dave 
 My test script eventually... 
 $folders = Get-IshFolder -BaseFolder Favorites -Recurse foreach ($folder in $folders) { $ishobjects = Get-IshFolderContent -IshFolder $folders $ishobjects = Get-IshDocumentObj -IshObject $ishobjects -RequestedMetadata (Set-IshRequestedMetadataField -Name FISHLINKS -Level Lng) } 
 foreach ($ishobject in $ishobjects) { $ishobject.fishlinks }

Dave De Meyer · Answer

Hi Madison, 
 I have to make a couple assumptions here like 
 
 Understanding the Logical-Version-Language paradigm, so in turn logical linking 
 Publications have a Baseline object which turns does the Version level selection 
 And the language level can be either source language or target language 
 
 Then in essence the fields you are looking for are language-level FISHLINKS and FISHIMAGELINKS (preferably on source language, so FSOURCELANGUAGE is empty). 
 
 More field information is available when your run ISHRemote 
 New-IshSession -WsBaseUrl " https://example.com/InfoShareWS/ " -IshUserName "username" -IshUserPassword "userpassword" 
 Get-IshTypeFieldDefinition 
 
 -Dave

Tridion Docs Developers > 03 - Developer Forum

Getting document report using ISHRemote API

Top Replies