Kantata Kantata OX Knowledge Base Release Notes Status Page

Workspace Allocations

A workspace allocation represents a resource’s allocation over a specific period of time. A workspace allocation is always associate with a workspace resource.

Fetching a list of Workspace Allocations

This endpoint returns structured Workspace 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 workspace_allocations 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.

  • creator (User)
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • updater (User)
  • workspace (Workspace) - The workspace that the resource is allocated in.
  • workspace_resource (WorkspaceResource).
named_resources_only
boolean

Limit to allocations associated with only named resources.

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: updated_at:asc and updated_at:desc.

overlaps_with_date_range
string

Limit to allocations of that overlap with a specified date range. Accepts two dates separated by a colon.

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

Limit to allocations of a specific type. Valid values: hard and soft.

unnamed_resources_only
boolean

Limit to allocations associated with only unnamed resources.

updated_after
string

Filter for records updated after a specified datetime.

updated_before
string

Filter for records updated before a specified datetime.

user_ids
string

Limit to allocations associated with the workspace resource user's IDs.

without_external_reference_service_name
string

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

workspace_ids
string

Limit to allocations associated with the workspace IDs.

workspace_resource_ids
string

Limit to allocations associated with the workspace resource IDs.

Responses
200

A list of Workspace Allocations have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
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/workspace_allocations
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_allocations": {
    },
  • "external_references": {
    },
  • "workspace_resources": {
    },
  • "workspaces": {
    },
  • "users": {
    }
}

Creating a new Workspace Allocation

This endpoint returns structured Workspace 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 workspace_allocations 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)
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • updater (User)
  • workspace (Workspace) - The workspace that the resource is allocated in.
  • workspace_resource (WorkspaceResource).
Request Body schema: application/json
object
resource_id
required
integer <int32>

The id of the workspace resource that the allocation will be associated with.

start_date
required
string <date>

The date the allocation starts on.

end_date
required
string <date>

The date the allocation ends on.

minutes
required
integer <int32>

Total minutes the resource is allocated over the date range.

hard
boolean

Indicates if the allocation is a Hard Allocation (“true”) or Soft (“false”).

notes
string

User entered notes about the allocation.

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

Workspace Allocation has been created.

Response Schema: application/json
count
integer <int32>
object
Array of objects
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/workspace_allocations
Request samples
application/json
{
  • "workspace_allocation": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_allocations": {
    },
  • "external_references": {
    },
  • "workspace_resources": {
    },
  • "workspaces": {
    },
  • "users": {
    }
}

Splitting an Allocation

Split an existing allocation into two on the specified date.

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

Request
query Parameters
split_date
required
string <date>

The date on which the allocation splits, in YYYY-MM-DD format.

workspace_allocation_id
required
integer <int32>

The ID of the allocation. This can be found via the Fetch Workspace Allocations endpoint.

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)
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • updater (User)
  • workspace (Workspace) - The workspace that the resource is allocated in.
  • workspace_resource (WorkspaceResource).
Responses
200

Workspace Allocation has been updated.

Response Schema: application/json
count
integer <int32>
object
Array of objects
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/workspace_allocations/split
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_allocations": {
    },
  • "external_references": {
    },
  • "workspace_resources": {
    },
  • "workspaces": {
    },
  • "users": {
    }
}

Fetching a single Workspace Allocation

This endpoint returns structured Workspace 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 workspace_allocations 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)
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • updater (User)
  • workspace (Workspace) - The workspace that the resource is allocated in.
  • workspace_resource (WorkspaceResource).
Responses
200

The Workspace Allocation has been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
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/workspace_allocations/{id}
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_allocations": {
    },
  • "external_references": {
    },
  • "workspace_resources": {
    },
  • "workspaces": {
    },
  • "users": {
    }
}

Updating an existing Workspace Allocation

This endpoint returns structured Workspace 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 workspace_allocations 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)
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • updater (User)
  • workspace (Workspace) - The workspace that the resource is allocated in.
  • workspace_resource (WorkspaceResource).
Request Body schema: application/json
object
start_date
string <date>

The date the allocation starts on.

end_date
string <date>

The date the allocation ends on.

minutes
integer <int32>

Total minutes the resource is allocated over the date range.

hard
boolean

Indicates if the allocation is a Hard Allocation (“true”) or Soft (“false”).

notes
string

User entered notes about the allocation.

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

Workspace Allocation has been updated.

Response Schema: application/json
count
integer <int32>
object
Array of objects
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/workspace_allocations/{id}
Request samples
application/json
{
  • "workspace_allocation": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_allocations": {
    },
  • "external_references": {
    },
  • "workspace_resources": {
    },
  • "workspaces": {
    },
  • "users": {
    }
}

Deleting an existing Workspace Allocation

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

Workspace Allocation has been deleted.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

delete/workspace_allocations/{id}
Request samples
Response samples
application/json
{
  • "errors": [
    ]
}