KAkantata
User File Associations

Fetching a list of User File Associations

This endpoint returns structured User File Association 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 user_file_associations top-level JSON key. Please see our Response Format section for more information.

get/user_file_associations

Request

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

Query parameters

filenamestring

Only includes file associations with matching filenames.

includestring

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

  • asset_object (polymorphic) - When included, the polymorphic asset_object_ref struct will reference the attachment or Google document for which the user file association belongs. This will be a a two-key JSON object with "ID" and "key", where the "key" will be "attachments" or "google_documents".
  • post (Post) - The post to which the user file association belongs.
  • workspace (Workspace) - References the project to which the user file association belongs.
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 and created_at:desc.

pageinteger
per_pageinteger
workspace_idinteger

Only includes file associations from the specified project.

Response

A list of User File Associations have been retrieved.

countinteger
user_file_associationsobject
postsobject
workspacesobject

Changes

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