In Maximo Application Suite, documenten en afbeeldingen worden opgeslagen als bijlagen en gekoppeld via DOCLINKS. Hoewel dit in de UI eenvoudig is, is het programmatisch ophalen van deze bijlagen minder voor de hand liggend.
‍

Dit bericht beschrijft een eenvoudig patroon voor het gebruik van de REST API om:
‍

1. Een document te vinden via DOCLINKS

2. De daadwerkelijke binaire inhoud op te halen, inclusief afbeeldingen

Het proces begrijpen

Maximo slaat documentbinaire bestanden niet direct op de hoofd bedrijfsobjecten op. In plaats daarvan:

• Het DOCLINKS-object slaat metadata op over bijlagen die bestanden en records koppelen

• De DOCINFO vertegenwoordigt de daadwerkelijke bestandsinhoud en wordt opgehaald via een document-endpoint
  ‍
  ‍

Hierdoor omvat het proces altijd twee stappen:

1. Query DOCLINKS om de bijlage te identificeren

2. Gebruik de geretourneerde ID om de inhoud op te halen

Mijn Scenario

In Maximo heb ik mijn pasfoto als bijlage toegevoegd aan mijn persoonsrecord. Mijn persoonsrecord is PHIL.RUNION voor dit voorbeeld. Als onderdeel van dit voorbeeld ga ik de MXPERSON objectstructuur gebruiken om mijn pasfoto uit mijn persoonsrecord op te halen met behulp van de REST API en Postman.

Vereisten

• Zorg voor toegang tot de objectstructuur in Manage

• Zorg voor een Manage API-sleutel voor uw gebruiker

Stap 1: Een objectstructuur instellen

Ik begin met de MXPERSON objectstructuur, dupliceer deze en voeg het DOCLINKS object toe als bronobject. U kunt standaard objectstructuren gebruiken als deze al het DOCLINKS bronobject bevatten.  

• Dupliceer de MXPERSON objectstructuur in Manage

• Voeg DOCLINKS toe als bronobject met een relatie tot het hoofdobject

• Configureer beveiligingstoegang voor de objectstructuur

Stap 2: Uw record ophalen met Postman

Vervolgens stel ik een basis REST-query in Postman op om mijn persoonsrecord op te halen. Dit legt zowel een verbinding tot stand waarop we kunnen voortbouwen als dat het ons in staat stelt de documentreferentie op te halen voor de volgende stap. Merk op dat ik in mijn query een oslc where-clausule gebruik om alleen mijn voorbeeldrecord op te halen. Naast deze post heeft u een header nodig met de sleutel “apikey” en een geldige API-sleutel met toegang.  
‍

Voorbeeld GET-query in Postman:
‍

https://mas.manage.demo.naviam.app/maximo/api/os/NVMPERSON?oslc.select=personid, displayname, doclinks{*}&oslc.where=personid="PHIL.RUNION"&lean=1

Wat dit doet:

• oslc.where=document="..." filtert op een specifiek record

• oslc.select= personid, displayname, doclinks{*} retourneert een paar velden van person en alle beschikbare velden van doclinks

• lean=1 verwijdert metadataruis en vereenvoudigt de respons
  ‍

‍

In het DOCLINKS-object ziet u de bijlage-informatie die we kunnen gebruiken om de afbeelding op te halen. Identificeer uit de respons-payload het record dat het volgende bevat:

• De interne resource-identificatie

• De href-waarde, die het document-eindpunt vertegenwoordigt
  ‍

Deze href is wat u in de volgende stap zult gebruiken.

Stap 3: De afbeelding ophalen

Zodra u de documentreferentie heeft, kunt u het document-eindpunt direct aanroepen. Het mooie van Postman is dat het de ruwe documentgegevens in Base64-formaat kan verwerken en visualiseren. Als u een andere tool gebruikt, moet u de uitvoer verwerken tot een bruikbaar bestand.  
‍

Voorbeeld:

https://mas.manage.demo.naviam.app/maximo/api/os/m4m_doclinks/_MTYwNzc4L0F0dGFjaG1lbnRzLzM5NzE5L1BFUlNPTg--?oslc.select=documentdata&lean=1&inlinedoc=1

Belangrijke parameters:

• oslc.select=documentdata
  Retourneert de binaire inhoud van het document

• inlinedoc=1
  Zorgt ervoor dat de documentgegevens inline in de respons worden geretourneerd

• lean=1
  Houd de respons schoon en gericht.

Algemene overwegingen

Beveiliging en authenticatie

Zorg ervoor dat uw API-aanroep correcte authenticatie omvat, doorgaans via een API-sleutel of sessietoken.

Prestaties

Vermijd het in bulk ophalen van grote documenten. Doe in plaats daarvan het volgende:

• Filteren DOCLINKS Gericht

• Haal alleen de documenten op die u nodig heeft.

Limieten voor bestandsgrootte

Grote bijlagen kunnen de responsgrootte aanzienlijk vergroten. Overweeg streaming of een alternatieve verwerking indien nodig.

Objectstructuur

De exacte objectstructuur kan variëren afhankelijk van uw objectstructuurconfiguratie, maar het patroon blijft consistent.

‍

‍

Deze aanpak is eenvoudig zodra u de scheiding tussen metadata en inhoud in Maximo begrijpt. Het is vooral nuttig voor:

• Integraties die toegang tot bijlagen nodig hebben

• Aangepaste UI-componenten die afbeeldingen weergeven.

• Automatiseringen die geüploade bestanden verwerken
  ‍

Als u ontwikkelt met MAS API's, is dit een patroon dat u vaak zult hergebruiken.

‍