Kantata Kantata OX Knowledge Base
Release Notes
Status Page

Estimate Scenario Resource Allocations

Estimate Scenario Resource Allocations contain time-related data for scenario resources, used for calculating estimated cost and scheduled hours.

Updating an existing Estimate Scenario Resource Allocation

This endpoint returns structured Estimate Scenario Resource Allocation objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the estimate_scenario_resource_allocations top-level JSON key. Please see our Response Format section for more information.

Request
path Parameters
id
required
integer

The ID of the Model.

query Parameters
include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • resource (EstimateScenarioResource) - The scenario resource that owns the estimate scenario resource allocation.
Request Body schema: application/json
required
object
duration_days
integer <int32>

The length of time for the allocation (in days).

percent_allocated
number <float>

The percentage allocated. This must be a decimal number between (and including) 0 and 1.

relative_start_day
integer <int32>

The number of business days, after the start date of the project, that the resource will begin working on the project.

Responses
200

Estimate Scenario Resource Allocation has been updated.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

put/estimate_scenario_resource_allocations/{id}
Request samples
application/json
{
  • "estimate_scenario_resource_allocation": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "estimate_scenario_resource_allocations": {
    },
  • "estimate_scenario_resources": {
    }
}