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.

Operations

Fetching a list of Assignments

Request

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.

Query

assignee_idinteger, (int32)

Only includes assignments that belong to the specified user 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

Only includes assignments that are active.

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, (int32)

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

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

Default:true

in_unarchived_workspacesboolean

Only includes assignments that belong to active projects.

Default:true

includestring

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

assignee (User) - Retrieves the user assigned to the task. The response will include assignee_id, which references the data in the users top-level key.
external_references (ExternalReference) - Includes references to external integrations for this object.
story (Story) - Retrieves the task. The response will include story_id, which references the data in the stories top-level key.
story_allocation_days (StoryAllocationDay) - Retrieves the Story Allocation Days (i.e. Daily Scheduled Hours) for the resource assigned to the task. When using this value, the plannable filter must be set to true. To retrieve story allocation days for unnamed resources, also set the include_unnamed filter to true. The response will include story_allocation_day_ids, which references the data in the story_allocation_days top-level key.

include_unnamedboolean

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.

Default:false

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: created_at:asc, created_at:desc, updated_at:asc, and updated_at:desc.

Default:"created_at:desc"

pageinteger, (int32)

Default:1

per_pageinteger, (int32), <= 200

Default:20

plannableboolean

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_idinteger, (int32)

Only includes assignments that belong to the specified resource ID.

story_idinteger, (int32)

Only includes assignments that belong to the specified task ID.

uncurrentboolean

Only includes assignments that are inactive.

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.

without_external_reference_service_namestring

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

workspace_idinteger, (int32)

Only includes assignments that belong to the specified project ID.

GET

/assignments

curl -i -X GET \
  'https://api.mavenlink.com/api/v1/assignments?assignee_id=0&created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&current=true&external_reference_external_message=string&external_reference_external_status=string&external_reference_service_model=string&external_reference_service_model_ref=0&external_reference_service_model_refs=string&external_reference_service_name=string&external_reference_status=string&has_external_references=true&in_unarchived_stories=true&in_unarchived_workspaces=true&include=string&include_unnamed=false&only=string&order=created_at%3Adesc&page=1&per_page=20&plannable=true&resource_id=0&story_id=0&uncurrent=true&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z&without_external_reference_service_name=string&workspace_id=0'

Responses

A list of Assignments have been retrieved.

Bodyapplication/json

countinteger, (int32)

metaobject

resultsArray of objects

assignmentsobject

external_referencesobject

storiesobject

usersobject

story_allocation_daysobject

Response

{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "assignments": {
    "property1": {
      "allocated_minutes": 0,
      "assignee_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "current": true,
      "estimated_minutes": 0,
      "external_reference_ids": [
        "string"
      ],
      "resource_id": 0,
      "story_allocation_day_ids": [
        "string"
      ],
      "story_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "allocated_minutes": 0,
      "assignee_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "current": true,
      "estimated_minutes": 0,
      "external_reference_ids": [
        "string"
      ],
      "resource_id": 0,
      "story_allocation_day_ids": [
        "string"
      ],
      "story_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "external_references": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "stories": {
    "property1": {
      "ancestor_ids": [
        "string"
      ],
      "ancestry_depth": 0,
      "archived": true,
      "archived_editable": true,
      "assigned_role_id": "string",
      "assignee_ids": [
        "string"
      ],
      "assignment_timestamped_at": "2019-08-24T14:15:22Z",
      "attachment_ids": [
        "string"
      ],
      "billable": true,
      "budget_estimate_in_cents": 0,
      "budget_used_in_cents": 0,
      "can_align_time": true,
      "can_edit": true,
      "can_post": true,
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "current_assignment_ids": [
        "string"
      ],
      "custom_field_value_ids": [
        "string"
      ],
      "custom_task_status_id": 0,
      "deleted_at": "2019-08-24T14:15:22Z",
      "descendant_ids": [
        "string"
      ],
      "description": "string",
      "due_date": "2019-08-24",
      "external_reference_ids": [
        "string"
      ],
      "fixed_fee": true,
      "follower_ids": [
        "string"
      ],
      "formatted_description": "string",
      "google_document_ids": [
        "string"
      ],
      "has_out_of_bounds_sads": true,
      "invoiced_balance_in_cents": 0,
      "is_time_trackable_type": true,
      "logged_billable_time_in_minutes": 0,
      "logged_nonbillable_time_in_minutes": 0,
      "parent_id": "string",
      "parsed_description": "string",
      "percentage_complete": 0,
      "position": 0,
      "potential_workspace_resource_ids": [
        "string"
      ],
      "potential_workspace_resources_with_unnamed_ids": [
        "string"
      ],
      "priority": 0,
      "project_plan": true,
      "read_only": true,
      "render_description_markdown": true,
      "reply_ids": [
        "string"
      ],
      "root_id": "string",
      "source_dependency_ids": [
        "string"
      ],
      "start_date": "2019-08-24",
      "state": "string",
      "status": "string",
      "story_state_change_ids": [
        "string"
      ],
      "story_task_ids": [
        "string"
      ],
      "story_type": "string",
      "sub_stories_billable_time_in_minutes": 0,
      "sub_stories_budget_estimate_in_cents": 0,
      "sub_stories_budget_used_in_cents": 0,
      "sub_stories_time_estimate_in_minutes": 0,
      "sub_story_count": 0,
      "sub_story_ids": [
        "string"
      ],
      "subtree_depth": 0,
      "tag_ids": [
        "string"
      ],
      "target_dependency_ids": [
        "string"
      ],
      "time_estimate_in_minutes": 0,
      "time_trackable": true,
      "title": "string",
      "uninvoiced_balance_in_cents": 0,
      "updated_at": "2019-08-24T14:15:22Z",
      "weight": 0,
      "workspace_id": "string",
      "workspace_resource_ids": [
        "string"
      ],
      "workspace_resources_with_unnamed_ids": [
        "string"
      ]
    },
    "property2": {
      "ancestor_ids": [
        "string"
      ],
      "ancestry_depth": 0,
      "archived": true,
      "archived_editable": true,
      "assigned_role_id": "string",
      "assignee_ids": [
        "string"
      ],
      "assignment_timestamped_at": "2019-08-24T14:15:22Z",
      "attachment_ids": [
        "string"
      ],
      "billable": true,
      "budget_estimate_in_cents": 0,
      "budget_used_in_cents": 0,
      "can_align_time": true,
      "can_edit": true,
      "can_post": true,
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "current_assignment_ids": [
        "string"
      ],
      "custom_field_value_ids": [
        "string"
      ],
      "custom_task_status_id": 0,
      "deleted_at": "2019-08-24T14:15:22Z",
      "descendant_ids": [
        "string"
      ],
      "description": "string",
      "due_date": "2019-08-24",
      "external_reference_ids": [
        "string"
      ],
      "fixed_fee": true,
      "follower_ids": [
        "string"
      ],
      "formatted_description": "string",
      "google_document_ids": [
        "string"
      ],
      "has_out_of_bounds_sads": true,
      "invoiced_balance_in_cents": 0,
      "is_time_trackable_type": true,
      "logged_billable_time_in_minutes": 0,
      "logged_nonbillable_time_in_minutes": 0,
      "parent_id": "string",
      "parsed_description": "string",
      "percentage_complete": 0,
      "position": 0,
      "potential_workspace_resource_ids": [
        "string"
      ],
      "potential_workspace_resources_with_unnamed_ids": [
        "string"
      ],
      "priority": 0,
      "project_plan": true,
      "read_only": true,
      "render_description_markdown": true,
      "reply_ids": [
        "string"
      ],
      "root_id": "string",
      "source_dependency_ids": [
        "string"
      ],
      "start_date": "2019-08-24",
      "state": "string",
      "status": "string",
      "story_state_change_ids": [
        "string"
      ],
      "story_task_ids": [
        "string"
      ],
      "story_type": "string",
      "sub_stories_billable_time_in_minutes": 0,
      "sub_stories_budget_estimate_in_cents": 0,
      "sub_stories_budget_used_in_cents": 0,
      "sub_stories_time_estimate_in_minutes": 0,
      "sub_story_count": 0,
      "sub_story_ids": [
        "string"
      ],
      "subtree_depth": 0,
      "tag_ids": [
        "string"
      ],
      "target_dependency_ids": [
        "string"
      ],
      "time_estimate_in_minutes": 0,
      "time_trackable": true,
      "title": "string",
      "uninvoiced_balance_in_cents": 0,
      "updated_at": "2019-08-24T14:15:22Z",
      "weight": 0,
      "workspace_id": "string",
      "workspace_resource_ids": [
        "string"
      ],
      "workspace_resources_with_unnamed_ids": [
        "string"
      ]
    }
  },
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  },
  "story_allocation_days": {
    "property1": {
      "assignment_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "current": true,
      "date": "2019-08-24",
      "external_reference_ids": [
        "string"
      ],
      "minutes": 0,
      "story_id": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_id": "string"
    },
    "property2": {
      "assignment_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "current": true,
      "date": "2019-08-24",
      "external_reference_ids": [
        "string"
      ],
      "minutes": 0,
      "story_id": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_id": "string"
    }
  }
}