How can I find XOG/API Information for Updating Tasks on Custom Investments?

Products

• Clarity PPM On Premise
• Clarity PPM SaaS

Issue/Introduction

You cannot find any XOG or API information to update/insert tasks on a custom investment.  When checking the API Documentation within your environment, you find operation info under "Other Resources" for updating the custom investment, but no information for its tasks. You have a requirement to automate the insert/update of a task on a custom investment.  What would be the preferred method to meet this requirement?

Environment

Clarity 16.3.3

Resolution

The reason you aren't finding a specific "Task" endpoint for your CI is that tasks in this context are technically sub-object instances tied to the specific Custom Investment Type you created. The REST API is the modern, preferred method for this requirement because it handles sub-objects dynamically based on the API Attribute ID you defined in Studio.

The Request Details to update Tasks

• Method: PATCH

• URL: https://[your-server]/clarity/rest/v1/private/[CI_API_ID]/[Parent_Internal_ID]/tasks/[Task_Internal_ID]

• Content-Type: application/json

{
    "name": "Updated Task Name",
    "status": "STARTED",
    "finish": "2026-12-31T17:00:00",
    "custom_attribute_id": "New Value",
    "percent_complete": 0.50
}

The Request Details to create new Task

• Method: POST

• URL: https://[your-server]/clarity/rest/v1/private/[CI_API_ID]/[Parent_Internal_ID]/tasks

• Content-Type: application/json

{
    "code": "TASK_2026_001",
    "name": "Market Analysis Phase 1",
    "start": "2026-03-01T08:00:00",
    "finish": "2026-03-15T17:00:00",
    "status": "NOT_STARTED",
    "description": "Initial research for the 2026 strategy roadmap."
}