Kantata Kantata OX Knowledge Base Release Notes Status Page
Kantata OX API Documentation

Estimate Scenarios

An Estimate Scenario is a possible project configuration, consisting of an estimated budget, rate card, resources, and other related fields for a specified estimate.

Fetching a list of Estimate Scenarios

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.

Request
query Parameters
created_after
string

Filter for records created after a specified datetime.

created_before
string

Filter for records created before a specified datetime.

external_reference_external_message
string

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_status
string

Filter by the status of the external object in the external system.

external_reference_service_model
string

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_ref
integer <int32>

Filter by the id of the external object this external reference belongs to.

external_reference_service_name
string

Filter by the name of the provider for integration.

external_reference_status
string

Filter by the status of the integration, this can be successful or fail.

has_external_references
boolean

Filter by whether or not the object has external references.

include
string

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

  • estimate_scenario_resources (EstimateScenarioResource) - The Estimate Scenario Resources of the Estimate Scenario.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • rate_card (RateCard) - The rate card being used for the estimate scenario.
only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

order
string
Default: "name"

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: name:asc and name:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
updated_after
string

Filter for records updated after a specified datetime.

updated_before
string

Filter for records updated before a specified datetime.

without_external_reference_service_name
string

Exclude by the existence of an external reference with the specified service name.

Responses
200

A list of Estimate Scenarios have been retrieved.

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

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/estimate_scenarios
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "estimate_scenarios": {
    },
  • "external_references": {
    },
  • "rate_cards": {
    },
  • "estimate_scenario_resources": {
    }
}
Creating a new Estimate Scenario
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.


Request 
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.


    

  • estimate_scenario_resources (EstimateScenarioResource) - The Estimate Scenario Resources of the Estimate Scenario.
    • 

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 

  • rate_card (RateCard) - The rate card being used for the estimate scenario.
    • 



 
Request Body schema: application/json
object
 
name
required
string
The name of the scenario (must be a unique name within it's estimate).


 
estimate_id
required
integer <int32> 
The ID of the estimate that is associated with the scenario.


 
start_date
required
string <date> 
The planned start date of the project.


 
budget_in_cents
integer <int32> 
The planned budget for the scenario.


 
rate_card_id
integer <int32> 
The rate card being used to calculate the resources' rates. If this is not provided,
a rate card with the same currency as the estimate will be selected from the
account default rate cards.


 
object
Typically populated programmatically by a third party system via an integration, this is an optional
object that holds data from an external system. It connects objects in an external system with objects in
Kantata OX (for example, to connect a Jira issue to a Kantata OX Project).


 
Responses 
200
Estimate Scenario has been created.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/estimate_scenarios
Request samples 
application/json
{
  • "estimate_scenario": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "estimate_scenarios": {
    },
  • "external_references": {
    },
  • "rate_cards": {
    },
  • "estimate_scenario_resources": {
    }
}
Fetching a single Estimate Scenario
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.


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.


    

  • estimate_scenario_resources (EstimateScenarioResource) - The Estimate Scenario Resources of the Estimate Scenario.
    • 

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 

  • rate_card (RateCard) - The rate card being used for the estimate scenario.
    • 



 
Responses 
200
The Estimate Scenario has been retrieved.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/estimate_scenarios/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "estimate_scenarios": {
    },
  • "external_references": {
    },
  • "rate_cards": {
    },
  • "estimate_scenario_resources": {
    }
}
Updating an existing Estimate Scenario
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.


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.


    

  • estimate_scenario_resources (EstimateScenarioResource) - The Estimate Scenario Resources of the Estimate Scenario.
    • 

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 

  • rate_card (RateCard) - The rate card being used for the estimate scenario.
    • 



 
Request Body schema: application/json
object
 
budget_in_cents
integer <int32> 
The planned budget for the scenario.


 
name
string
The name of the scenario (must be a unique name within it's estimate).


 
rate_card_id
integer <int32> 
The rate card being used to calculate the resources' rates.


 
start_date
string <date> 
The planned start date of the project.


 
object
Typically populated programmatically by a third party system via an integration, this is an optional
object that holds data from an external system. It connects objects in an external system with objects in
Kantata OX (for example, to connect a Jira issue to a Kantata OX Project).


 
Responses 
200
Estimate Scenario has been updated.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/estimate_scenarios/{id}
Request samples 
application/json
{
  • "estimate_scenario": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "estimate_scenarios": {
    },
  • "external_references": {
    },
  • "rate_cards": {
    },
  • "estimate_scenario_resources": {
    }
}
Deleting an existing Estimate Scenario
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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Responses 
204
Estimate Scenario has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/estimate_scenarios/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Estimates