Kantata Kantata OX Knowledge Base Release Notes Status Page

Workspace Resources

A workspace resource is the object that is tied to assignments and allocations within a Workspace.

Workspace Resources can be:

  • Named Resources: Resources with a user_id.
  • Unnamed Resources: Resources with no user_id.

With workspace resources it is possible for a user to have many resources with different roles within a single workspace. Workspace resources can be assigned to tasks via Assignments.

e.g. In an example workspace, 'the Accounting Project', we could have 3 workspace resources:

  1. Alice as an Engineer in the Accounting Project
  2. Alice as an Designer in the Accounting Project
  3. Bob as a Designer in the Accounting Project

With workspace resources, Alice could be assigned to one task as an Engineer and use the Engineer rate for that task, and another task be assigned as a Designer and thus the designer rate would be used there.

When a named workspace resource is created, if role_id is not specified, it will default to the user's primary role within the project (see primary role definition below). When the workspace resource is created, label with be generated based on the user's primary role.

Primary Project Role

A user's primary project role is defined by role_id on the user's Participation for the workspace if that is set. If role_id is not set on the user's participation, primary project role is defined by default_role_id on the user's account_membership only if the user's account_membership.account_id matches the workspace.account_id (the user belongs to the project's account).

Fetching a list of Workspace Resources

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

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.

  • custom_field_values (CustomFieldValue)
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • organization_membership (OrganizationMembership)
  • participation (Participation) - ID of the participation associated with this resource.
  • role (Role) - ID of the role associated with this resource.
  • user (User) - ID of the user associated with this resource. A null value indicates that this is an unnamed resource.
  • workspace (Workspace) - The workspace of the resource.
include_unnamed
boolean

Returns Unnamed Resources in addition to Named Resources.

matching
string

Show Resources associated with a User that matches the specified parameter or has a Role that matches the specified parameter.

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.

only_unnamed
boolean

Returns only Unnamed Resources.

order
string
Default: "updated_at:desc"

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

Valid values: alphabetical, 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
potential_workspace_resource_for_story_with_unnamed_resources
integer <int32>

Takes a Reference to a Story Id. Show only Resources that are available to assign for specified Story.

potential_workspace_resources_for_reassignment
integer <int32>

Takes an Assignment Id. Shows only Resources that can be reassigned to the specified assignment.

potential_workspace_resources_for_story
integer <int32>

Takes a Reference to a Story Id Show only Resources that have an user assigned, and are available to assign for specified Story.

providers
boolean

Show only Resources that have an user assigned, and are consultants in the workspace.

providers_with_unnamed
boolean

Show only Resources that have consultant users or no users at all.

role_id
integer <int32>

Returns workspace resources for a specified role in a workspace. Returns workspace resources for a specified role when only the role is provided.

updated_after
string

Filter for records updated after a specified datetime.

updated_before
string

Filter for records updated before a specified datetime.

user_id
integer <int32>

Returns workspace resources for a specified user in a workspace. Returns workspace resources for a specified user when only the user is provided.

without_external_reference_service_name
string

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

workspace_id
integer <int32>

Id for a specified workspace you wish to retrieve.

Responses
200

A list of Workspace Resources have been retrieved.

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

Creating a new Workspace Resource

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

  • custom_field_values (CustomFieldValue)
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • organization_membership (OrganizationMembership)
  • participation (Participation) - ID of the participation associated with this resource.
  • role (Role) - ID of the role associated with this resource.
  • user (User) - ID of the user associated with this resource. A null value indicates that this is an unnamed resource.
  • workspace (Workspace) - The workspace of the resource.
Request Body schema: application/json
object
workspace_id
required
integer <int32>

The workspace ID associated with this resource.

user_id
integer <int32>

The user ID associated with this resource. A null value indicates that this is an unnamed resource.

role_id
integer <int32>

The role ID associated with this resource. The role ID is a required attribute to create unnamed resources. This defaults to the user's primary project role if the user is specified.

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

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

Creating Allocations from Scheduled Hours for Resources

This will create allocations for workspace resources based on their scheduled hours. This endpoint is only usable for Account Administrators and users with Users can edit allocations for unnamed resources or Users can edit allocations for named resources access in the Edit Allocations section of the Resource Management Access Group Set.

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

  • custom_field_values (CustomFieldValue)
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • organization_membership (OrganizationMembership)
  • participation (Participation) - ID of the participation associated with this resource.
  • role (Role) - ID of the role associated with this resource.
  • user (User) - ID of the user associated with this resource. A null value indicates that this is an unnamed resource.
  • workspace (Workspace) - The workspace of the resource.
Request Body schema: application/json
object
resource_ids
string

A comma-separated list of the IDs of the resources to create allocations for. NOTE: This is only applicable when updating multiple resources via workspace_resources/allocations_matching_scheduled_hours.

hard
boolean

Whether the allocation is a Hard Allocation (“true”) or Soft (“false”). This value must be set to false if you are including any unnamed resources in your request.

object

The timeframe of scheduled hours in which to create allocations for.

Responses
200

Workspace Resource has been created.

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

Fetching a single Workspace Resource

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

  • custom_field_values (CustomFieldValue)
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • organization_membership (OrganizationMembership)
  • participation (Participation) - ID of the participation associated with this resource.
  • role (Role) - ID of the role associated with this resource.
  • user (User) - ID of the user associated with this resource. A null value indicates that this is an unnamed resource.
  • workspace (Workspace) - The workspace of the resource.
Responses
200

The Workspace Resource has been retrieved.

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

Updating an existing Workspace Resource

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

  • custom_field_values (CustomFieldValue)
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • organization_membership (OrganizationMembership)
  • participation (Participation) - ID of the participation associated with this resource.
  • role (Role) - ID of the role associated with this resource.
  • user (User) - ID of the user associated with this resource. A null value indicates that this is an unnamed resource.
  • workspace (Workspace) - The workspace of the resource.
Request Body schema: application/json
object
label
string

A unique label that is automatically generated for a resource when it is created. Default resource labels in Kantata OX are based on role name and numerical order, but can be renamed by you.

user_id
integer <int32>

The user ID associated with this resource.

role_id
integer <int32>

The role ID associated with this resource. The role ID is a required attribute for unnamed resources.

auto_update_label
boolean

If true, automatically updates resource labels to match roles associated with updated role IDs when labels are not provided. When a label is provided, that overrides this setting.

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

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