Kantata Kantata OX Knowledge Base Release Notes Status Page

Daily Scheduled Hours (Story Allocation Days)

Daily Scheduled Hours (also called Story Allocation Days) is the allocation of time for a resource to spend on a specific task, on a specific day. Daily Scheduled Hours are part of Assignments, so if an Assignment is deleted, so are its Daily Scheduled Hours.

Fetching a list of Daily Scheduled Hours (Story Allocation Day)s

Returns all Daily Scheduled Hours that are visible to the requester, based on permissions. Filter results by specific projects, users, tasks, and more.

NOTES:

  • The response includes Daily Scheduled Hours that are part of inactive Assignments, by default. To filter these out, use the current parameter.
  • If you are an Account Administrator, you can use the only_my_account parameter to filter for Daily Scheduled Hours from only your account. This optimizes performance of the endpoint.

The returned Daily Scheduled Hours are sorted by when they were last updated.

This endpoint returns structured Daily Scheduled Hours (Story Allocation Day) 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 story_allocation_days top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
assignee_id
integer <int32>

Returns Daily Scheduled Hours that are assigned to the User of the specified ID.

assignment_id
integer <int32>

Returns Daily Scheduled Hours that belong to the Assignment of the specified 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

Returns Daily Scheduled Hours that belong to active Assignments.

date_between
string

Requires a colon separated pair of dates in YYYY-MM-DD format. Results are inclusive of the endpoints. If a date is not passed in, it is interpreted as negative or positive infinity.

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

Returns Daily Scheduled Hours that belong to active (not archived) Stories.

in_unarchived_workspaces
boolean
Default: true

Returns Daily Scheduled Hours that belong to active (not archived) Workspaces.

include
string

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

  • assignment (Assignment) - Reference the Assignment of the Story Allocation Day.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • story (Story) - Reference the Story of the Story Allocation Day.
  • workspace (Workspace) - Reference the Workspace of the Story Allocation Day.
include_unnamed
boolean
Default: false

Includes Daily Scheduled Hours from Assignments with 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.

only_my_account
boolean
Default: false

If you are an Account Administrator, you can set this to True in order to filter for Daily Scheduled Hours from only your account.

Enabling this filter optimizes performance of the endpoint. The filter is set to False by default.

order
string
Default: "updated_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, date:asc, date:desc, id:asc, id:desc, updated_at:asc, and updated_at:desc.

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

Returns Daily Scheduled Hours that belong to the Story of the specified ID.

uncurrent
boolean

Returns Daily Scheduled Hours that belong to inactive Assignments.

updated_after
string

Filter for records updated after a specified datetime.

updated_at_between
string

Requires a colon separated pair of timestamps. Timestamps are in ISO8601 format with colons removed. Results are inclusive of the endpoints. If a timestamp is not passed in, it is interpreted as negative or positive infinity.

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>

Returns Daily Scheduled Hours that belong to the Workspace of the specified ID.

Responses
200

A list of Daily Scheduled Hours (Story Allocation Day)s 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/story_allocation_days
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "story_allocation_days": {
    },
  • "external_references": {
    },
  • "assignments": {
    },
  • "stories": {
    },
  • "workspaces": {
    }
}

Creating a new Daily Scheduled Hours (Story Allocation Day)

This endpoint returns structured Daily Scheduled Hours (Story Allocation Day) 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 story_allocation_days 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.

  • assignment (Assignment) - Reference the Assignment of the Story Allocation Day.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • story (Story) - Reference the Story of the Story Allocation Day.
  • workspace (Workspace) - Reference the Workspace of the Story Allocation Day.
Request Body schema: application/json
object
assignment_id
required
integer <int32>

The ID of the Assignment the Daily Scheduled Hours are part of.

date
required
string <date>

The date of the scheduled hours in ISO8601 format (e.g. 2014-12-31).

minutes
required
integer <int32>

The amount of time scheduled for the day, in minutes (e.g. 120 for 120 minutes, which is 2 hours).

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

Daily Scheduled Hours (Story Allocation Day) 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/story_allocation_days
Request samples
application/json
{
  • "story_allocation_day": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "story_allocation_days": {
    },
  • "external_references": {
    },
  • "assignments": {
    },
  • "stories": {
    },
  • "workspaces": {
    }
}

Fetching a single Daily Scheduled Hours (Story Allocation Day)

This endpoint returns structured Daily Scheduled Hours (Story Allocation Day) 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 story_allocation_days 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.

  • assignment (Assignment) - Reference the Assignment of the Story Allocation Day.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • story (Story) - Reference the Story of the Story Allocation Day.
  • workspace (Workspace) - Reference the Workspace of the Story Allocation Day.
Responses
200

The Daily Scheduled Hours (Story Allocation Day) 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/story_allocation_days/{id}
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "story_allocation_days": {
    },
  • "external_references": {
    },
  • "assignments": {
    },
  • "stories": {
    },
  • "workspaces": {
    }
}

Updating an existing Daily Scheduled Hours (Story Allocation Day)

This endpoint returns structured Daily Scheduled Hours (Story Allocation Day) 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 story_allocation_days 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.

  • assignment (Assignment) - Reference the Assignment of the Story Allocation Day.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • story (Story) - Reference the Story of the Story Allocation Day.
  • workspace (Workspace) - Reference the Workspace of the Story Allocation Day.
Request Body schema: application/json
object
minutes
required
integer <int32>

The amount of time scheduled for the day, in minutes (e.g. 120 for 120 minutes, which is 2 hours).

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

Daily Scheduled Hours (Story Allocation Day) 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/story_allocation_days/{id}
Request samples
application/json
{
  • "story_allocation_day": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "story_allocation_days": {
    },
  • "external_references": {
    },
  • "assignments": {
    },
  • "stories": {
    },
  • "workspaces": {
    }
}

Deleting an existing Daily Scheduled Hours (Story Allocation Day)

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

Daily Scheduled Hours (Story Allocation Day) has been deleted.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

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