Kantata Kantata OX Knowledge Base Release Notes Status Page

Estimate Scenario Resources

Estimate Scenario Resources represent placeholders for unnamed resources in a specific estimate scenario.

Fetching a list of Estimate Scenario Resources

This endpoint provides a list of all scenario resources associated with the specified estimate scenario.

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

Request
query Parameters
estimate_scenario_id
required
integer <int32>

Required to retrieve the resources for a specified estimate scenario.

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.

  • allocation (EstimateScenarioResourceAllocation) - The Estimate Scenario Resource Allocation of the Estimate Scenario Resource.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • geography (Geography) - The Geography of the Estimate Scenario Resource.
  • organization_membership (OrganizationMembership)
  • role (Role)
  • user (User).
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: "updated_at:desc"

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

Valid values: alphabetically:asc, alphabetically:desc, created_at:asc, created_at:desc, updated_at:asc, and updated_at: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 Scenario Resources 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/estimate_scenario_resources
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "estimate_scenario_resources": {
    },
  • "external_references": {
    },
  • "users": {
    },
  • "roles": {
    },
  • "organization_memberships": {
    },
  • "estimate_scenario_resource_allocations": {
    },
  • "organizations": {
    }
}

Creating a new Estimate Scenario Resource

This endpoint returns structured Estimate Scenario Resource 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_resources 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.

  • allocation (EstimateScenarioResourceAllocation) - The Estimate Scenario Resource Allocation of the Estimate Scenario Resource.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • geography (Geography) - The Geography of the Estimate Scenario Resource.
  • organization_membership (OrganizationMembership)
  • role (Role)
  • user (User).
Request Body schema: application/json
object
estimate_scenario_id
required
integer <int32>

The estimate scenario to which the resource is attached.

label
string

The name of the resource. An auto-generated label will be supplied if not present.

role_id
required
integer <int32>

The role with which the resource will be associated.

object
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 HubSpot Deal to a Kantata OX Project).

Responses
200

Estimate Scenario Resource 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/estimate_scenario_resources
Request samples
application/json
{
  • "estimate_scenario_resource": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "estimate_scenario_resources": {
    },
  • "external_references": {
    },
  • "users": {
    },
  • "roles": {
    },
  • "organization_memberships": {
    },
  • "estimate_scenario_resource_allocations": {
    },
  • "organizations": {
    }
}

Fetching a single Estimate Scenario Resource

This endpoint returns structured Estimate Scenario Resource 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_resources 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.

  • allocation (EstimateScenarioResourceAllocation) - The Estimate Scenario Resource Allocation of the Estimate Scenario Resource.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • geography (Geography) - The Geography of the Estimate Scenario Resource.
  • organization_membership (OrganizationMembership)
  • role (Role)
  • user (User).
Responses
200

The Estimate Scenario Resource 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/estimate_scenario_resources/{id}
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "estimate_scenario_resources": {
    },
  • "external_references": {
    },
  • "users": {
    },
  • "roles": {
    },
  • "organization_memberships": {
    },
  • "estimate_scenario_resource_allocations": {
    },
  • "organizations": {
    }
}

Updating an existing Estimate Scenario Resource

This endpoint returns structured Estimate Scenario Resource 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_resources 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.

  • allocation (EstimateScenarioResourceAllocation) - The Estimate Scenario Resource Allocation of the Estimate Scenario Resource.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • geography (Geography) - The Geography of the Estimate Scenario Resource.
  • organization_membership (OrganizationMembership)
  • role (Role)
  • user (User).
Request Body schema: application/json
object
role_id
required
integer <int32>

The role with which the resource will be associated.

label
string

The name of the resource.

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 HubSpot Deal to a Kantata OX Project).

Responses
200

Estimate Scenario Resource 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/estimate_scenario_resources/{id}
Request samples
application/json
{
  • "estimate_scenario_resource": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "estimate_scenario_resources": {
    },
  • "external_references": {
    },
  • "users": {
    },
  • "roles": {
    },
  • "organization_memberships": {
    },
  • "estimate_scenario_resource_allocations": {
    },
  • "organizations": {
    }
}

Deleting an existing Estimate Scenario Resource

This will delete an estimate scenario resource and its 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 Resource 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_scenario_resources/{id}
Request samples
Response samples
application/json
{
  • "errors": [
    ]
}