How to run a Compass API as a Job?

Legacy Contributor

Hello,

How can I schedule a job to run a Compass query and export the results to a file?

Thanks for your help!!

Venkat

Find more posts tagged with

Infor Data Fabric

Accepted answers

All comments

Alistair Johnson

Write it in powershell

movexblog.blogspot.com/.../calling-ion-apis-from-powershell.html

Al.

Legacy Contributor

Nice blog!

If your authorized app is configured to get refresh token, you can add the step to revoke the token so grants don't pile up.

Alistair Johnson

A colleague mentioned that, but I haven't spent time looking at yet. What call needs to be made to revoke the token?

Legacy Contributor

Venkat:

I would recommend creating a back end service through ION API; the process will generate a service account tied to a Ming.le user so you can extend security to the service account. There will be a Ming.le role to extend connectivity to Compass API. The ionapi credential file will be available for download after you link the service account to the Ming.le user.

API calls are authorized through ouath2 tokens, which I believe have a maximum life of 2 hours, so you don't have to be overly concerned with revoking tokens.

Postman is a solid tools to validate the ionapi credentials API call and return messaging. I believe you can use a name value pair to request that your result set is returned as JSON, XML or CSV, and Postman can be used to experiment with the name value pairs.

Just about any language that supports https, auth2 and REST can be used here, but in my opinion javascript, java, python, .NET have the broadest support. The powershell example cited here demonstrates the flexibility of the architecture.

If you are using Compass API to requesting a document from Data Lake, you will have 3 distinct calls. Once of the APIs will return a key that you use to monitor the progress as your document is converted from AWS S3 infrequent storage class. You will need to drop that into an do/while loop whilst waiting.

I am an old school Java fan. I jar everything and use a jvm command line cal, there are similar approach can by used for python. You can run this on any server or a lappy, but the bulk of my APIs calls are now based on Lamba Serverless, and use CloudWatch Events (cron based scheduling) to schedule tasks, and secured S3 for results.

Copyright © 2025 Infor. All rights reserved.