KAkantata
Workspace Resources

Updating an existing Workspace Resource

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.

put/workspace_resources/{id}

Request

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

Path parameters

idinteger required

The ID of the Model.

Query parameters

includestring

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 include custom_field_value_ids, which references the data in the custom_field_values top-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 include organization_membership_id, which references the data in the organization_memberships top-level key.
  • participation (Participation) - Retrieves the participation associated with the resource. The response will include participation_id, which references the data in the participations top-level key.
  • role (Role) - Retrieves the role for this resource. The response will include role_id, which references the data in the roles top-level key.
  • user (User) - Retrieves the user associated with the resource. The response will include user_id, which references the data in the users top-level key. For unnamed resources, the user_id will be null.
  • workspace (Workspace) - Retrieves the workspace (project) the resource is in. The response will include workspace_id, which references the data in the workspaces top-level key.
optional_fieldsstring[]

Allows you to request one or more optional fields as an array.

Request body

Response

Workspace Resource has been updated.

countinteger
workspace_resourcesobject
external_referencesobject
usersobject
rolesobject
organization_membershipsobject
participationsobject
workspacesobject
custom_field_valuesobject

Changes

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