An Estimate Scenario is a possible project configuration, consisting of an estimated budget, rate card, resources, and other related fields for a specified estimate.
This endpoint returns structured Estimate Scenario 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_scenarios
top-level JSON key.
Please see our Response Format section for more information.
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "estimate_scenarios": {
- "property1": {
- "budget_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "estimate_id": 0,
- "estimate_scenario_resource_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "rate_card_id": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "target_margin_percent": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "budget_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "estimate_id": 0,
- "estimate_scenario_resource_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "rate_card_id": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "target_margin_percent": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "rate_cards": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}
}, - "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"
}
}
}
This endpoint returns structured Estimate Scenario 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_scenarios
top-level JSON key.
Please see our Response Format section for more information.
{- "estimate_scenario": {
- "name": "string",
- "estimate_id": 0,
- "start_date": "2019-08-24",
- "budget_in_cents": 0,
- "rate_card_id": 0,
- "external_reference": {
- "service_name": "string",
- "service_model": "string",
- "service_model_ref": "string",
- "status": "string",
- "external_message": "string",
- "external_link": "string",
- "external_status": "string",
- "locked": true
}
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "estimate_scenarios": {
- "property1": {
- "budget_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "estimate_id": 0,
- "estimate_scenario_resource_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "rate_card_id": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "target_margin_percent": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "budget_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "estimate_id": 0,
- "estimate_scenario_resource_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "rate_card_id": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "target_margin_percent": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "rate_cards": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}
}, - "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"
}
}
}
This endpoint returns structured Estimate Scenario 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_scenarios
top-level JSON key.
Please see our Response Format section for more information.
include | string Any of the below associations can be included in your request by providing the
|
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "estimate_scenarios": {
- "property1": {
- "budget_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "estimate_id": 0,
- "estimate_scenario_resource_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "rate_card_id": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "target_margin_percent": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "budget_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "estimate_id": 0,
- "estimate_scenario_resource_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "rate_card_id": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "target_margin_percent": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "rate_cards": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}
}, - "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"
}
}
}
This endpoint returns structured Estimate Scenario 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_scenarios
top-level JSON key.
Please see our Response Format section for more information.
include | string Any of the below associations can be included in your request by providing the
|
object | |||||||||||
|
{- "estimate_scenario": {
- "budget_in_cents": 0,
- "name": "string",
- "rate_card_id": 0,
- "start_date": "2019-08-24",
- "external_reference": {
- "service_name": "string",
- "service_model": "string",
- "service_model_ref": "string",
- "status": "string",
- "external_message": "string",
- "external_link": "string",
- "external_status": "string",
- "locked": true
}
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "estimate_scenarios": {
- "property1": {
- "budget_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "estimate_id": 0,
- "estimate_scenario_resource_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "rate_card_id": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "target_margin_percent": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "budget_in_cents": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "estimate_id": 0,
- "estimate_scenario_resource_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "rate_card_id": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "target_margin_percent": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "rate_cards": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "currency": "string",
- "effective_rate_card_version_id": "string",
- "external_reference_ids": [
- "string"
], - "rate_card_set_id": "string",
- "rate_card_set_title": "string",
- "rate_card_version_ids": [
- "string"
], - "removable": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "uses": 0
}
}, - "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"
}
}
}
Deletes an estimate scenario, including all of its resources and their allocations.
The response will contain no content and an HTTP 204 status code if the request was successful, or a standard Kantata OX error message explaining why the object could not be deleted.
Estimate Scenario has been deleted.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "errors": [
- {
- "type": "string",
- "message": "string"
}
]
}