KAkantata
Workspace Allocations

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.

get/workspace_allocations

Request

  • Base URL
    https://api.mavenlink.com/api/v1
  • Auth
    none declared

Query parameters

created_afterstring date-time

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring date-time

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

external_reference_external_messagestring

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

external_reference_external_statusstring

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

external_reference_service_modelstring

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

external_reference_service_model_refinteger

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

external_reference_service_model_refsstring

Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.

external_reference_service_namestring

Filter by the name of the provider for integration.

external_reference_statusstring

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

has_external_referencesboolean

Filter by whether or not the object has external references.

includestring

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_onlyboolean

Limit to allocations associated with only named resources.

onlystring

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.

orderstring

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_rangestring

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

pageinteger
per_pageinteger
typestring

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

unnamed_resources_onlyboolean

Limit to allocations associated with only unnamed resources.

updated_afterstring date-time

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring date-time

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

user_idsstring

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

without_external_reference_service_namestring

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

workspace_idsstring

Limit to allocations associated with the workspace IDs.

workspace_resource_idsstring

Limit to allocations associated with the workspace resource IDs.

Response

A list of Workspace Allocations have been retrieved.

countinteger
workspace_allocationsobject
external_referencesobject
workspace_resourcesobject
workspacesobject
usersobject

Changes

No recorded changes to this operation across all 1 revision of this API.