Skip to content
DataMiner DoJo

More results...

Generic selectors
Exact matches only
Search in title
Search in content
Post Type Selectors
Search in posts
Search in pages
Search in posts
Search in pages
Log in
Menu
  • Updates & Insights
  • Questions
  • Learning
    • E-learning Courses
    • Empower Replay: Limited Edition
    • Tutorials
    • Open Classroom Training
    • Certification
      • DataMiner Fundamentals
      • DataMiner Configurator
      • DataMiner Automation
      • Scripts & Connectors Developer: HTTP Basics
      • Scripts & Connectors Developer: SNMP Basics
      • Visual Overview – Level 1
      • Verify a certificate
    • Video Library
    • Books We Like
    • >> Go to DataMiner Docs
  • Expert Center
    • Solutions & Use Cases
      • Solutions
      • Use Case Library
    • Markets & Industries
      • Media production
      • Government & defense
      • Content distribution
      • Service providers
      • Partners
      • OSS/BSS
    • Agile
      • Agile Webspace
      • Everything Agile
        • The Agile Manifesto
        • Best Practices
        • Retro Recipes
      • Methodologies
        • The Scrum Framework
        • Kanban
        • Extreme Programming
      • Roles
        • The Product Owner
        • The Agile Coach
        • The Quality & UX Coach (QX)
    • DataMiner DevOps Professional Program
      • About the DevOps Program
      • DataMiner DevOps Support
  • Downloads
  • More
    • DataMiner Releases & Updates
    • Feature Suggestions
    • Climb the leaderboard!
    • Swag Shop
    • Contact
    • Global Feedback Survey
  • PARTNERS
    • All Partners
    • Technology Partners
    • Strategic Partner Program
    • Deal Registration
  • >> Go to dataminer.services

User-Defined APIs – How to log API failures

Solved535 views10th April 2024User Defined APIs
3
Kévin Dugué [DevOps Advocate]263 9th April 2024 0 Comments

Hello !

In the following documentation Triggering a user-defined API | DataMiner Docs, there is a note:

"We recommend that API maintainers return errors in the same format for the sake of consistency ."

My first question is how to get the DataMiner ID of the DMA that executed the trigger for setting the "FaultingNode" property. (See my code below)

My second question is : What are your recommendations for managing api failure logging?

Thanks

Regards

Kévin Dugué [DevOps Advocate] Selected answer as best 10th April 2024

1 Answer

  • Active
  • Voted
  • Newest
  • Oldest
4
Wouter Van Robays [SLC] [DevOps Enabler]1.14K Posted 9th April 2024 1 Comment

Hi kévin,
To get the DataMiner ID of the DMA your script is running on, you can use the Engine object in your API script, see following question: Automation – How to get the ID from the Agent running the automation script?

To answer your second question, the User-defined APIs logic will log failing API requests in one of the logfiles mentioned in here: Troubleshooting User-Defined APIs | DataMiner Docs depending on where it fails. Note that these logfiles aren't permanent and can be overwritten due to restarts or when a certain filesize is reached.
You could also log failures in your script yourself using the LogHelper | DataMiner Docs. If you use this approach, note that if you e.g. try to trigger an API using a wrong token, you won't be able to log this, as in this case your API script will never be started. For these kind of fails, you will always have to look at the logfiles mentioned earlier.

Kévin Dugué [DevOps Advocate] Posted new comment 10th April 2024
Kévin Dugué [DevOps Advocate] commented 10th April 2024

Hi Wouter,

Thanks for your answer!

Regards.

You are viewing 1 out of 1 answers, click here to view all answers.
Please login to be able to comment or post an answer.

My DevOps rank

DevOps Members get more insights on their profile page.

My user earnings

0 Dojo credits

Spend your credits in our swag shop.

0 Reputation points

Boost your reputation, climb the leaderboard.

Promo banner DataMiner DevOps Professiona Program
DataMiner Integration Studio (DIS)
Empower Katas
Privacy Policy • Terms & Conditions • Contact

© 2025 Skyline Communications. All rights reserved.

DOJO Q&A widget

Can't find what you need?

? Explore the Q&A DataMiner Docs

[ Placeholder content for popup link ] WordPress Download Manager - Best Download Management Plugin