POST/api/v1/analysis/resources/async
Resource Analysis (Async)
Submit resource analysis as async job.
Request example
jsonjson
{
"tasks": [
{
"id": "T1",
"duration_days": 5
}
]
}Request fields from OpenAPI contract
Required fields and the optional fields that change this call are listed here. The shared task model stays on the task schema guide.This table is generated from the endpoint schema in openapi.json.
| Field | Type | Required | Description |
|---|---|---|---|
| tasks | array<unknown> | Required | Schedule tasks |
| tasks[].id | string | Required | Unique task identifier |
| status_date | string | null | Optional | Schedule status date (ISO 8601 YYYY-MM-DD). When omitted, today's date is used as the resource loading window anchor. |
| resource_availability | array<unknown> | null | Optional | Optional declared resource capacities |
| options | object | Optional | Options controlling resource analysis behaviour. |
| options.period_size_days | integer | Optional | Histogram bucket size in days |
| options.include_histogram_data | boolean | Optional | Include demand histogram per resource |
| options.include_leveling_candidates | boolean | Optional | Include leveling candidate tasks |
| options.include_critical_path_resources | boolean | Optional | Include CP resource section |
| options.include_resource_curves | boolean | Optional | Include cumulative resource curves |
| options.over_allocation_threshold | number | Optional | Multiplier of declared capacity (or 1.0/day default) that triggers over-allocation |
| options.exclude_task_types | array<string> | Optional | Task types to exclude from analysis (e.g. 'loe', 'summary') |
| options.fields | array<string> | null | Optional | Response fields to include (sparse fieldset) |
Response example
jsonjson
{
"score": 92,
"grade": "A"
}Schema
json-schema
{
"$ref": "#/components/schemas/ResourceAnalysisRequest"
}Authentication
- x-api-key header
Reference details
- Operation ID
- analysis_resources_async
- Section
- Analysis
- Tags
- Analysis
- Playground link
- /playground?endpoint=%2Fapi%2Fv1%2Fanalysis%2Fresources%2Fasync&method=post
Was this page helpful?
Your feedback helps us improve docs, reference pages, and Playground flows.
Topic: Resource Analysis (Async) · Page: /docs/api-reference/analysis_resources_async