Task Creator

Version: 1.0.0 OpenAPI: 3.1.0

Consolidated API documentation for the TM Creator service — project creation, management, templates, and file uploads.

Authentication

All endpoints require an API key passed in the apikey request header.

Integration Flows

Flow 1: Form-based Project Creation

For simple, template-based, or XML-based project creation using multipart/form-data:

┌─────────────────────────────────────────────────────────────┐
│  Client                                                     │
│    │                                                        │
│    ├── POST /tm/api/v1/projects/create/simple               │
│    │     └─ Form fields + optional file attachment           │
│    │                                                        │
│    ├── POST /tm/api/v1/projects/create/from-template        │
│    │     └─ templateId + scheduling + distribution params    │
│    │                                                        │
│    ├── POST /tm/api/v1/projects/create/from-xml             │
│    │     └─ domainId + XML file                             │
│    │                                                        │
│    └── POST /tm/api/v1/projects/create/plan-from-xml        │
│          └─ domainId + XML file                             │
└─────────────────────────────────────────────────────────────┘

These endpoints accept all data in a single request and return a project ID on success.

Flow 2: Structured Project Creation (JSON-based, two-step)

For advanced project creation with tasks, feedback questionnaires, rollout rules, and pre-uploaded attachments:

┌────────────────────────────────────────────────────────────────────────┐
│  Step 1 (Optional): Upload files                                       │
│                                                                        │
│    POST /tm/v1/uploads                                                 │
│      Content-Type: multipart/form-data                                 │
│      Body: { files: [binary, binary, ...] }                            │
│      Response: { items: [{ resource_id: "res_abc..." }, ...] }          │
│                                                                        │
│    ⮕ resource_ids are valid for 24 hours                               │
│                                                                        │
├────────────────────────────────────────────────────────────────────────┤
│  Step 2: Create project                                                │
│                                                                        │
│    POST /tm/v1/projects                                                │
│      Content-Type: application/json                                    │
│      Headers: Idempotency-Key: <uuid>                                  │
│      Body: {                                                           │
│        title, type, schedule, assignees, rollout,                       │
│        tasks, feedback_questions,                                       │
│        attachments: [{ type: "file", resource_id: "res_abc..." }]      │
│      }                                                                 │
│      Response: { id: "prj_123", status: "created" }                    │
└────────────────────────────────────────────────────────────────────────┘

If no file attachments are needed, skip Step 1 and call Step 2 directly. URL attachments (external links) do not require a prior upload.

Flow 3: Project Lifecycle Actions

After a project is created, use these endpoints to manage it:

GET  /tm/api/v1/project/status     → Check current project status
GET  /tm/api/v1/project/notes      → Retrieve project/task notes
POST /tm/api/v1/projects/action/update  → Recall / Withdraw / Complete
POST /tm/api/v1/projects/action/delete  → Delete pre-launch projects

Flow 4: Discovery (Templates & Project Types)

Before creating a project, query available templates and project types:

GET /tm/api/v1/project-types       → List all available project types
GET /tm/api/v1/templates           → List templates (filter by type, title, etc.)
GET /tm/api/v1/templates/task      → List templates with their task definitions

Servers

Security schemes

Operations

Use the sidebar to browse individual operations generated from this specification.