Kantata Kantata OX Knowledge Base Release Notes Status Page

Assignments

The Assignments object allows you to view and manage task assignments for named or unnamed resources.

Note: Because Daily Scheduled Hours are a part of Assignments, they can be affected when an assignment changes.

Fetching a list of Assignments

For Account Administrators, returns task assignments in all projects across an account. For non-Account Administrators, returns task assignments only in projects they are part of.

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

Request
query Parameters
assignee_id
integer <int32>

Only includes assignments that belong to the specified user ID.

created_after
string

Filter for records created after a specified datetime.

created_before
string

Filter for records created before a specified datetime.

current
boolean

Only includes assignments that are active.

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.

in_unarchived_stories
boolean
Default: true

Only includes assignments that belong to inactive tasks. (Inactive tasks can exist in active projects, and vice versa.).

in_unarchived_workspaces
boolean
Default: true

Only includes assignments that belong to active projects.

include
string

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

  • assignee (User) - References the user who owns the assignment.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • story (Story) - References the task to which the assignment belongs.
  • story_allocation_days (StoryAllocationDay) - References all of the Story Allocation Days that belong to the assignment. Including story allocation days requires the request to be filtered with the plannable filter.
include_unnamed
boolean
Default: false

Includes task assignments to unnamed resources. Think of unnamed resources as placeholders; it indicates the need for a certain role, before knowing who will fill it. Set to False by default.

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: "created_at:desc"

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

Valid values: 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
plannable
boolean

Filters for assignments which the requester can view and create Daily Scheduled Hours for. Must be set to true when using the include parameter with the story_allocation_days association.

resource_id
integer <int32>

Only includes assignments that belong to the specified resource ID.

story_id
integer <int32>

Only includes assignments that belong to the specified task ID.

uncurrent
boolean

Only includes assignments that are inactive.

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.

workspace_id
integer <int32>

Only includes assignments that belong to the specified project ID.

Responses
200

A list of Assignments 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/assignments
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "assignments": {
    },
  • "external_references": {
    },
  • "stories": {
    },
  • "users": {
    },
  • "story_allocation_days": {
    }
}

Creating a new Assignment

This endpoint returns structured Assignment 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 assignments 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.

  • assignee (User) - References the user who owns the assignment.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • story (Story) - References the task to which the assignment belongs.
  • story_allocation_days (StoryAllocationDay) - References all of the Story Allocation Days that belong to the assignment. Including story allocation days requires the request to be filtered with the plannable filter.
Request Body schema: application/json
object
story_id
required
integer <int32>

The ID of the task being assigned to a resource.

assignee_id
integer <int32>

The ID of the user the assignment is for. Do not specify an assignee_id if a resource_id is also specified. When both parameters are specified, assignee_id is overridden by resource_id.

resource_id
required
integer <int32>

The ID of the resource the assignment is for.

current
boolean

Whether the assignment is active. True indicates an active assignment, and False indicates inactive.

Assignments cannot be deleted, but are considered inactive when a resource is unassigned from a task.

estimated_minutes
integer <int32>

The number of minutes the resource is estimated to work on the task.

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

Assignment 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/assignments
Request samples
application/json
{
  • "assignment": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "assignments": {
    },
  • "external_references": {
    },
  • "stories": {
    },
  • "users": {
    },
  • "story_allocation_days": {
    }
}

Fetching a single Assignment

This endpoint returns structured Assignment 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 assignments 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.

  • assignee (User) - References the user who owns the assignment.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • story (Story) - References the task to which the assignment belongs.
  • story_allocation_days (StoryAllocationDay) - References all of the Story Allocation Days that belong to the assignment. Including story allocation days requires the request to be filtered with the plannable filter.
Responses
200

The Assignment 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/assignments/{id}
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "assignments": {
    },
  • "external_references": {
    },
  • "stories": {
    },
  • "users": {
    },
  • "story_allocation_days": {
    }
}

Updating an existing Assignment

This endpoint returns structured Assignment 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 assignments 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.

  • assignee (User) - References the user who owns the assignment.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • story (Story) - References the task to which the assignment belongs.
  • story_allocation_days (StoryAllocationDay) - References all of the Story Allocation Days that belong to the assignment. Including story allocation days requires the request to be filtered with the plannable filter.
Request Body schema: application/json
object
assignee_id
integer <int32>

The ID of the user the assignment is for. Do not specify an assignee_id if a resource_id is also specified. When both parameters are specified, assignee_id is overridden by resource_id.

resource_id
integer <int32>

The ID of the resource the assignment is for.

current
boolean

Whether the assignment is active. True indicates an active assignment, and False indicates inactive.

Assignments cannot be deleted, but are considered inactive when a resource is unassigned from a task.

estimated_minutes
integer <int32>

The number of minutes the resource is estimated to work on the task.

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

Assignment 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/assignments/{id}
Request samples
application/json
{
  • "assignment": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "assignments": {
    },
  • "external_references": {
    },
  • "stories": {
    },
  • "users": {
    },
  • "story_allocation_days": {
    }
}

Deleting an existing Assignment

Assignments cannot be deleted. Instead, assignments are considered inactive when a resource is unassigned from a task. Using this endpoint is the same as updating the current parameter to false for an assignment.

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

Assignment has been deleted.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

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