Skip to content
POST/api/v1/analysis/resources/async

Resource Analysis (Async)

Submit resource analysis as async job.

Request example

json
json
{
  "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.

FieldTypeRequiredDescription
tasksarray<unknown>RequiredSchedule tasks
tasks[].idstringRequiredUnique task identifier
status_datestring | nullOptionalSchedule status date (ISO 8601 YYYY-MM-DD). When omitted, today's date is used as the resource loading window anchor.
resource_availabilityarray<unknown> | nullOptionalOptional declared resource capacities
optionsobjectOptionalOptions controlling resource analysis behaviour.
options.period_size_daysintegerOptionalHistogram bucket size in days
options.include_histogram_databooleanOptionalInclude demand histogram per resource
options.include_leveling_candidatesbooleanOptionalInclude leveling candidate tasks
options.include_critical_path_resourcesbooleanOptionalInclude CP resource section
options.include_resource_curvesbooleanOptionalInclude cumulative resource curves
options.over_allocation_thresholdnumberOptionalMultiplier of declared capacity (or 1.0/day default) that triggers over-allocation
options.exclude_task_typesarray<string>OptionalTask types to exclude from analysis (e.g. 'loe', 'summary')
options.fieldsarray<string> | nullOptionalResponse fields to include (sparse fieldset)

Response example

json
json
{
  "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

TermsPrivacyContact

Schedule analysis guidance. Not legal advice. You remain responsible for contract and agency compliance.