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

Estimates

An Estimate represents a potential project. Estimates allow you to plan out a project's budget, resources, and allocations through associated estimate scenarios.

Fetching a list of Estimates

This endpoint returns structured Estimate 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 estimates top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
by_custom_choice_value
string

Filter by a custom field choice value, represented as a string with the custom field id, followed by a colon, and 0 to many comma separated custom field choice values IDs. The custom field choice value can also be the word 'blank'. Multiple custom field choice values IDs can be provided by separating them with a semi-colon.

The filter supports the following formats:

  • custom_field_ID:choice_value_ID
  • custom_field_ID:choice_value_1_ID,choice_value_2_ID
  • custom_field_ID:blank
  • custom_field_1_ID:choice_value_1_ID,choice_value_2_ID;custom_field_2_ID:choice_value_2_ID;custom_field_3_ID:blank.
by_custom_currency_value
string

Filter by a custom field currency value, represented as a string with the custom field id and the currency value, separated by a colon. Optionally, the currency can be supplied, separted from the currency value with another colon. Multiple custom field currency values an be provided by separating them with a semi-colon. For example, "1:200.2:USD; 2:100".

by_custom_date_value
string

Filter by a custom field date value, represented as a string with the custom field id, starting date, and ending date, seperated by colons. Both a starting date and ending date can be supplied, or just one can be provided. Multiple custom field date values an be provided by separating them with a semi-colon. For example, "1:2014-12-05:2014-12-25;2:2014-12-05".

by_custom_number_value
string

Filter by a custom field number value, represented as a string with the custom field id and the number value, separated by a colon. Multiple custom field number values an be provided by separating them with a semi-colon. For example, "1:200; 2:101".

by_custom_text_value
string

Filter by a custom field text value, represented as a string with the custom field id and the text value, separated by a colon. Multiple custom field text values an be provided by separating them with a semi-colon. For example, "1:something; 2:else".

created_after
string

Filter for records created after a specified datetime.

created_before
string

Filter for records created before a specified datetime.

creator
string

Only includes estimates in which the specified set IDs belong to the creator of the estimates. For example, '10,20'.

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.

has_value_for_custom_field_ids
string

Filter by the presence of a custom field value for the specified comma-separated custom field ID(s).

include
string

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

  • creator (User) - The user who created the estimate.
  • custom_field_values (CustomFieldValue) - The value set on estimate custom fields.
  • estimate_scenarios (EstimateScenario) - The EstimateScenarios of the estimate.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • workspace (Workspace) - The Workspace that was created from the Project.
  • workspace_group (WorkspaceGroup) - The WorkspaceGroup (client) of the estimate.
matching
string
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: created_at:asc, created_at:desc, 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.

with_workspace_group_ids
string

Only includes estimates for the specified workspace group IDs. For example, '1,2,3'.

without_external_reference_service_name
string

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

Responses
200

A list of Estimates have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
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/estimates
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "estimates": {
    },
  • "external_references": {
    },
  • "users": {
    },
  • "workspace_groups": {
    },
  • "estimate_scenarios": {
    },
  • "workspaces": {
    },
  • "custom_field_values": {
    }
}
Creating a new Estimate
This endpoint returns structured Estimate 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 estimates 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.


    

  • creator (User) - The user who created the estimate.
    • 

  • custom_field_values (CustomFieldValue) - The value set on estimate custom fields.
    • 

  • estimate_scenarios (EstimateScenario) - The EstimateScenarios of the estimate.
    • 

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

  • workspace (Workspace) - The Workspace that was created from the Project.
    • 

  • workspace_group (WorkspaceGroup) - The WorkspaceGroup (client) of the estimate.
    • 



 
Request Body schema: application/json
object
 
name
required
string
The name of the estimate.


 
currency
required
string
The currency of the estimate, by code (for example, 'AUD' or 'USD').


 
workspace_group_id
integer <int32> 
The ID of the workspace group (client) of the estimate.


 
object
The estimated budget, start date, and rate card associated with the estimate.


 
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 has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
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/estimates
Request samples 
application/json
{
  • "estimate": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "estimates": {
    },
  • "external_references": {
    },
  • "users": {
    },
  • "workspace_groups": {
    },
  • "estimate_scenarios": {
    },
  • "workspaces": {
    },
  • "custom_field_values": {
    }
}
Fetching a single Estimate
This endpoint returns structured Estimate 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 estimates 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.


    

  • creator (User) - The user who created the estimate.
    • 

  • custom_field_values (CustomFieldValue) - The value set on estimate custom fields.
    • 

  • estimate_scenarios (EstimateScenario) - The EstimateScenarios of the estimate.
    • 

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

  • workspace (Workspace) - The Workspace that was created from the Project.
    • 

  • workspace_group (WorkspaceGroup) - The WorkspaceGroup (client) of the estimate.
    • 



 
Responses 
200
The Estimate has been retrieved.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
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/estimates/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "estimates": {
    },
  • "external_references": {
    },
  • "users": {
    },
  • "workspace_groups": {
    },
  • "estimate_scenarios": {
    },
  • "workspaces": {
    },
  • "custom_field_values": {
    }
}
Updating an existing Estimate
This endpoint returns structured Estimate 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 estimates 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.


    

  • creator (User) - The user who created the estimate.
    • 

  • custom_field_values (CustomFieldValue) - The value set on estimate custom fields.
    • 

  • estimate_scenarios (EstimateScenario) - The EstimateScenarios of the estimate.
    • 

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

  • workspace (Workspace) - The Workspace that was created from the Project.
    • 

  • workspace_group (WorkspaceGroup) - The WorkspaceGroup (client) of the estimate.
    • 



 
Request Body schema: application/json
object
 
name
string
The name of the Estimate.


 
workspace_group_id
integer <int32> 
The Client the Estimate is created for.


 
description
string
The description of the estimate.


 
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 has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
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/estimates/{id}
Request samples 
application/json
{
  • "estimate": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "estimates": {
    },
  • "external_references": {
    },
  • "users": {
    },
  • "workspace_groups": {
    },
  • "estimate_scenarios": {
    },
  • "workspaces": {
    },
  • "custom_field_values": {
    }
}
Deleting an existing Estimate
Deletes the estimate and it's associated scenarios, scenario resources,
and scenario resource 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 has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


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