KAkantata
Daily Scheduled Hours (Story Allocation Days)

Fetching a list of Daily Scheduled Hours (Story Allocation Days)

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.

get/story_allocation_days

Request

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

Query parameters

assignee_idinteger

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

assignment_idinteger

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

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.

currentboolean

Returns Daily Scheduled Hours that belong to active Assignments.

date_betweenstring

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_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.

in_unarchived_storiesboolean

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

in_unarchived_workspacesboolean

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

includestring

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_unnamedboolean

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.

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.

only_my_accountboolean

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.

orderstring

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.

pageinteger
per_pageinteger
story_idinteger

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

uncurrentboolean

Returns Daily Scheduled Hours that belong to inactive Assignments.

updated_afterstring date-time

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

updated_at_betweenstring

Requires a colon separated pair of timestamps. Timestamps are in ISO 8601 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_beforestring date-time

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

without_external_reference_service_namestring

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

workspace_idinteger

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

Response

A list of Daily Scheduled Hours (Story Allocation Day)s have been retrieved.

countinteger
story_allocation_daysobject
external_referencesobject
assignmentsobject
storiesobject
workspacesobject

Changes

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