Skip to content

Estimate Scenario Resource Allocations

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

Operations

Updating an existing Estimate Scenario Resource Allocation

Request

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.

Path
idintegerrequired

The ID of the Model.

Query
includestring

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.
Bodyapplication/jsonrequired
estimate_scenario_resource_allocationobject
PUT
/estimate_scenario_resource_allocations/{id}
{
  "estimate_scenario_resource_allocation": {
    "duration_days": 0,
    "percent_allocated": 0.1,
    "relative_start_day": 0
  }
}

Responses

Estimate Scenario Resource Allocation has been updated.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
estimate_scenario_resource_allocationsobject
estimate_scenario_resourcesobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "estimate_scenario_resource_allocations": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "duration_days": 0,
      "percent_allocated": 0.1,
      "relative_start_day": 0,
      "resource_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "duration_days": 0,
      "percent_allocated": 0.1,
      "relative_start_day": 0,
      "resource_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "estimate_scenario_resources": {
    "property1": {
      "allocation_id": "string",
      "bill_rate": 0,
      "cost_rate": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "display_label": "string",
      "estimate_scenario_id": 0,
      "external_reference_ids": [
        "string"
      ],
      "geography_id": "string",
      "label": "string",
      "organization_membership_id": "string",
      "role_id": "string",
      "role_name": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    },
    "property2": {
      "allocation_id": "string",
      "bill_rate": 0,
      "cost_rate": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "display_label": "string",
      "estimate_scenario_id": 0,
      "external_reference_ids": [
        "string"
      ],
      "geography_id": "string",
      "label": "string",
      "organization_membership_id": "string",
      "role_id": "string",
      "role_name": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    }
  }
}