Adds a named or unnamed resource to a project (workspace).
Bulk Create
This endpoint supports bulk creating up to 200 objects. In the request body, set the top-level key to its plural form and place the objects in an array. Example:
{
"workspace_resources": [
{
"workspace_id": 123,
"user_id": 111,
"role_id": 555
},
{
"workspace_id": 123,
"user_id": 222,
"role_id": 666
}
]
}This endpoint returns structured Workspace Resource 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_resources top-level JSON key. Please see our Response Format section for more information.
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.
custom_field_values(CustomFieldValue) - Retrieves the custom field values for the resource. The response will includecustom_field_value_ids, which references the data in thecustom_field_valuestop-level key.external_references(ExternalReference) - Includes references to external integrations for this object.organization_membership(OrganizationMembership) - Retrieves the organization memberships for the resource. The response will includeorganization_membership_id, which references the data in theorganization_membershipstop-level key.participation(Participation) - Retrieves the participation associated with the resource. The response will includeparticipation_id, which references the data in theparticipationstop-level key.role(Role) - Retrieves the role for this resource. The response will includerole_id, which references the data in therolestop-level key.user(User) - Retrieves the user associated with the resource. The response will includeuser_id, which references the data in theuserstop-level key. For unnamed resources, theuser_idwill benull.workspace(Workspace) - Retrieves the workspace (project) the resource is in. The response will includeworkspace_id, which references the data in theworkspacestop-level key.
- https://api.mavenlink.com/api/v1https://api.mavenlink.com/api/v1/workspace_resources
{ "workspace_resource": { "workspace_id": 0, "user_id": 0, "role_id": 0, "external_reference": { "service_name": "string", "service_model": "string", "service_model_ref": "string", "status": "string", "external_message": "string", "external_link": "string", "external_status": "string", "locked": true } } }
Response
{ "count": 0, "meta": { "count": 0, "page_count": 0, "page_number": 0, "page_size": 0 }, "results": [ { "key": "string", "id": "string" } ], "workspace_resources": { "property1": { "created_at": "2019-08-24T14:15:22Z", "custom_field_value_ids": [ "string" ], "display_label": "string", "external_reference_ids": [ "string" ], "full_name": "string", "label": "string", "organization_membership_id": "string", "participation_id": "string", "photo_path": "string", "resource_bill_rate": 0, "resource_cost_rate": 0, "role_id": "string", "role_initials": "string", "role_name": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "workspace_id": 0, "workspace_title": "string" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "custom_field_value_ids": [ "string" ], "display_label": "string", "external_reference_ids": [ "string" ], "full_name": "string", "label": "string", "organization_membership_id": "string", "participation_id": "string", "photo_path": "string", "resource_bill_rate": 0, "resource_cost_rate": 0, "role_id": "string", "role_initials": "string", "role_name": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "workspace_id": 0, "workspace_title": "string" } }, "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" } }, "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" ] } }, "roles": { "property1": { "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "external_reference_ids": [ "string" ], "name": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "external_reference_ids": [ "string" ], "name": "string", "updated_at": "2019-08-24T14:15:22Z" } }, "organization_memberships": { "property1": { "created_at": "2019-08-24T14:15:22Z", "department_id": "string", "effective_end_date": "2019-08-24", "effective_start_date": "2019-08-24", "geography_id": "string", "member_id": "string", "member_type": "string", "primary": true, "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "department_id": "string", "effective_end_date": "2019-08-24", "effective_start_date": "2019-08-24", "geography_id": "string", "member_id": "string", "member_type": "string", "primary": true, "updated_at": "2019-08-24T14:15:22Z" } }, "participations": { "property1": { "access_level": "string", "active_role_ids": [ "string" ], "allocated_workspace_minutes": 0, "can_edit": true, "can_edit_expense": true, "can_edit_time": true, "can_invite": true, "can_post": true, "can_schedule_team_hours": true, "can_schedule_their_hours": true, "cost_in_cents": 0, "created_at": "2019-08-24T14:15:22Z", "default_rate_in_cents": 0, "estimated_workspace_minutes": 0, "external_reference_ids": [ "string" ], "is_foreign_participant": true, "is_team_lead": true, "permissions_label": "string", "primary_role_id": "string", "rate_in_cents": 0, "role": "string", "show_as_read_only": true, "updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "workspace_id": "string", "workspace_resource_ids": [ "string" ], "workspace_role_id": "string" }, "property2": { "access_level": "string", "active_role_ids": [ "string" ], "allocated_workspace_minutes": 0, "can_edit": true, "can_edit_expense": true, "can_edit_time": true, "can_invite": true, "can_post": true, "can_schedule_team_hours": true, "can_schedule_their_hours": true, "cost_in_cents": 0, "created_at": "2019-08-24T14:15:22Z", "default_rate_in_cents": 0, "estimated_workspace_minutes": 0, "external_reference_ids": [ "string" ], "is_foreign_participant": true, "is_team_lead": true, "permissions_label": "string", "primary_role_id": "string", "rate_in_cents": 0, "role": "string", "show_as_read_only": true, "updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "workspace_id": "string", "workspace_resource_ids": [ "string" ], "workspace_role_id": "string" } }, "workspaces": { "property1": { "access_level": "string", "account_color_id": "string", "account_id": 0, "account_insights_mapping_ids": [ "string" ], "actual_fees_includes_additional_line_items": true, "actual_fees_includes_expenses": true, "approver_id": "string", "approver_ids": [ "string" ], "archived": true, "billable_minutes": 0, "billing_milestone_ids": [ "string" ], "budget_remaining": "string", "budget_used": "string", "budget_used_in_cents": 0, "budgeted": true, "can_create_line_items": true, "can_invite": true, "change_orders_enabled": true, "client_lead_name": "string", "client_role_name": "string", "consultant_role_name": "string", "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "current_status_report_id": "string", "current_user_participation_id": "string", "custom_field_value_ids": [ "string" ], "default_rate": "string", "description": "string", "due_date": "2019-08-24", "effective_due_date": "2019-08-24", "estimated_minutes": 0, "exclude_archived_stories_percent_complete": true, "expenses_in_burn_rate": true, "external_link": { "url": "string", "text": "string" }, "external_reference_ids": [ "string" ], "financial_viewer_ids": [ "string" ], "has_active_expense_report_submissions": true, "has_active_timesheet_submissions": true, "has_budget_access": true, "incoming_email_address": "string", "lock_date": "2019-08-24", "minutes_logged": 0, "next_uncompleted_milestone_id": "string", "non_billable_minutes": 0, "over_budget": true, "participant_ids": [ "string" ], "participation_ids": [ "string" ], "percent_of_budget_used": 0, "percentage_complete": 0, "permissions": { "can_upload_files": true, "can_private_message": true, "can_join": true, "is_participant": true, "access_level": "string", "team_lead": true, "user_is_client": true, "can_change_price": true, "can_change_story_billable": true, "can_post": true, "can_edit": true, "restricted": true, "can_see_financials": true, "is_guest_on_project": true }, "possible_approver_ids": [ "string" ], "posts_require_privacy_decision": true, "price": "string", "price_in_cents": 0, "primary_counterpart_id": "string", "primary_maven_id": "string", "primary_workspace_group_id": "string", "provider_lead_name": "string", "rate_card_id": 0, "require_expense_approvals": true, "require_notes_on_time_entries": true, "require_time_approvals": true, "revenue_recognition_method_id": "string", "revenue_recognition_method_name": "string", "stage": "string", "start_date": "2019-08-24", "status": { "color": "string", "key": "string", "message": "string" }, "status_report_ids": [ "string" ], "stories_are_fixed_fee_by_default": true, "target_margin": 0.1, "task_status_set_id": "string", "task_status_set_name": "string", "task_statuses": [ "string" ], "tasks_default_non_billable": true, "time_trackable": true, "timesheet_submission_ids": [ "string" ], "title": "string", "total_expenses_in_cents": 0, "total_invoiced": "string", "total_minutes_approved": 0, "updated_at": "2019-08-24T14:15:22Z", "workspace_group_ids": [ "string" ], "workspace_invoice_preference_id": 0, "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] }, "property2": { "access_level": "string", "account_color_id": "string", "account_id": 0, "account_insights_mapping_ids": [ "string" ], "actual_fees_includes_additional_line_items": true, "actual_fees_includes_expenses": true, "approver_id": "string", "approver_ids": [ "string" ], "archived": true, "billable_minutes": 0, "billing_milestone_ids": [ "string" ], "budget_remaining": "string", "budget_used": "string", "budget_used_in_cents": 0, "budgeted": true, "can_create_line_items": true, "can_invite": true, "change_orders_enabled": true, "client_lead_name": "string", "client_role_name": "string", "consultant_role_name": "string", "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "current_status_report_id": "string", "current_user_participation_id": "string", "custom_field_value_ids": [ "string" ], "default_rate": "string", "description": "string", "due_date": "2019-08-24", "effective_due_date": "2019-08-24", "estimated_minutes": 0, "exclude_archived_stories_percent_complete": true, "expenses_in_burn_rate": true, "external_link": { "url": "string", "text": "string" }, "external_reference_ids": [ "string" ], "financial_viewer_ids": [ "string" ], "has_active_expense_report_submissions": true, "has_active_timesheet_submissions": true, "has_budget_access": true, "incoming_email_address": "string", "lock_date": "2019-08-24", "minutes_logged": 0, "next_uncompleted_milestone_id": "string", "non_billable_minutes": 0, "over_budget": true, "participant_ids": [ "string" ], "participation_ids": [ "string" ], "percent_of_budget_used": 0, "percentage_complete": 0, "permissions": { "can_upload_files": true, "can_private_message": true, "can_join": true, "is_participant": true, "access_level": "string", "team_lead": true, "user_is_client": true, "can_change_price": true, "can_change_story_billable": true, "can_post": true, "can_edit": true, "restricted": true, "can_see_financials": true, "is_guest_on_project": true }, "possible_approver_ids": [ "string" ], "posts_require_privacy_decision": true, "price": "string", "price_in_cents": 0, "primary_counterpart_id": "string", "primary_maven_id": "string", "primary_workspace_group_id": "string", "provider_lead_name": "string", "rate_card_id": 0, "require_expense_approvals": true, "require_notes_on_time_entries": true, "require_time_approvals": true, "revenue_recognition_method_id": "string", "revenue_recognition_method_name": "string", "stage": "string", "start_date": "2019-08-24", "status": { "color": "string", "key": "string", "message": "string" }, "status_report_ids": [ "string" ], "stories_are_fixed_fee_by_default": true, "target_margin": 0.1, "task_status_set_id": "string", "task_status_set_name": "string", "task_statuses": [ "string" ], "tasks_default_non_billable": true, "time_trackable": true, "timesheet_submission_ids": [ "string" ], "title": "string", "total_expenses_in_cents": 0, "total_invoiced": "string", "total_minutes_approved": 0, "updated_at": "2019-08-24T14:15:22Z", "workspace_group_ids": [ "string" ], "workspace_invoice_preference_id": 0, "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] } }, "custom_field_values": { "property1": { "account_id": 0, "can_edit": true, "created_at": "2019-08-24T14:15:22Z", "custom_field_id": "string", "custom_field_name": "string", "display_value": "string", "external_reference_ids": [ "string" ], "selected_choice_ids": [ "string" ], "setter_id": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "type": "string", "updated_at": "2019-08-24T14:15:22Z", "value": "string" }, "property2": { "account_id": 0, "can_edit": true, "created_at": "2019-08-24T14:15:22Z", "custom_field_id": "string", "custom_field_name": "string", "display_value": "string", "external_reference_ids": [ "string" ], "selected_choice_ids": [ "string" ], "setter_id": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "type": "string", "updated_at": "2019-08-24T14:15:22Z", "value": "string" } } }