ASaspect
Shares

Create Share

Create a new share for a resource (requires FULL_ACCESS)

post/shares

Request

  • Base URL
    https://api.aspect.inc
  • URL
    https://api.aspect.inc/shares
  • Auth
    API key in header Authorization

Request body

resource_idstring uuid required

Resource being shared

namestring nullable

User-friendly name for the share

actionsinteger required

Bitmap of allowed actions (VIEW=1, EDIT=2)

passwordstring nullable

Optional password for share protection

expires_atstring date-time nullable

Optional expiration timestamp

watermark_idstring uuid nullable

Watermark configuration to apply to share viewers

visible_metadata_attribute_idsstring[] nullable

Metadata attribute IDs share users can see (everything else is hidden)

Response

Successful Response

idstring uuid required

Share ID (used in URLs)

resource_idstring uuid required

Resource being shared

resource_type'workspace' | 'project' | 'directory' | 'asset' | 'symlink' | 'collection' | 'canvas' required

Types of resources in the hierarchy.

resource_namestring required

Name of the resource

created_by_user_idstring uuid nullable

User who created the share. Null when that account has been deleted

namestring nullable

Share name

actionsinteger required

Allowed actions bitmap

has_passwordboolean required

Whether share is password protected

expires_atstring date-time nullable

Expiration timestamp

is_activeboolean required

Whether the share is active

watermark_idstring uuid nullable

Watermark configuration applied to share viewers

visible_metadata_attribute_idsstring[] nullable

Metadata attribute IDs share users can see

createdstring date-time required

Creation timestamp

updatedstring date-time required

Last update timestamp

Changes

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