IBM Targetprocess

 View Only

 Questions regarding OKRs (Extendable Domain) APIs

Jump to  Best Answer
Gaurav Nigam's profile image
Gaurav Nigam posted Thu September 04, 2025 01:03 PM

Hello TargetProcess team/community,

We are working on integrating with TargetProcess to support OKR functionality, but we’ve hit a critical documentation gap regarding Extendable Domain (ExD) entities. Specifically, OKRs (Objectives and Key Results) appear to be implemented as ExD items, and we haven’t been able to find definitive API documentation for them.

Could you please help clarify the following?

  1. API Endpoints for OKR ExD entities once the solution is installed:

    • Objective entity endpoint(s)

    • Key Result entity endpoint

    • Any hierarchy-specific endpoints (Ultimate/Strategic/Tactical Objectives)

    • Required vs. optional fields

    • Field data types and formats

    • Relationship field structures

      Field Specifications for these entities:

    • Is there a way to programmatically discover ExD entity schemas?

    • Is configuration-specific API documentation accessible via a meta endpoint?

      Discoverability of ExD Entities:

    • Do you have JavaScript code samples or best practices for setting up automation rules to trigger HTTP POSTs when relationships are added or updated (as a replacement for deprecated webhooks)?

      Automation Rules for Notifications:

For reference, our provisional API patterns are based on the standard POST /api/v1/[EntityName] and POST /api/v1/[EntityName]/[EntityId] approach, but we need confirmation of the correct entity names and field structures before we proceed.

Any documentation, examples, or guidance you can share would be greatly appreciated.

Thanks in advance!

Varad Rajeev Muthal's profile image
Varad Rajeev Muthal  Best Answer

Hello @Gaurav Nigam
One of our experts shared information on above query, I hope this will be helpful:

Entity endpoints, ExD connections, fields metadata is available under this URL: https://md5.tpondemand.com/api/v1/index/meta. Account specific metdata: https://{your_account}.tpondemand.com/api/v1/index/metaOnce OKR entities are installed on the account, it's metadata will become available on https://{your_account}.tpondemand.com/api/v1/index/metaAutomation Rules documentation and library:https://www.ibm.com/docs/en/targetprocess/tp-dev-hub/saas?topic=rules-automation-overview

Thanks!

Varad Rajeev Muthal's profile image
Varad Rajeev Muthal

Hello @Gaurav Nigam Thanks for sharing above details, I would like to suggest that connecting with your Targetprocess Customer Success Manager is the best option for guidance on it.
Also, I am sharing Targetprocess documentation repository.
Link - https://www.ibm.com/docs/en/targetprocess/atp/saas?topic=targetprocess