myCC - Assets

Updates an asset record. Updates S3 only if filename or MyCC account have changed, or if a new file is included with the update.

If there are no changes to the file itself, the File arg can be left null to avoid overwriting the existing upload in S3.

put/Assets/{assetId}

Request

  • Base URL: https://api.carboncure.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.carboncure.com/Assets/{assetId}
  • Auth: one of:
    • none
    • OAuth 2 (authorization code, authorization URL https://auth.carboncure.com/oauth2/authorize, token URL https://auth.carboncure.com/oauth2/token, scopes: applicationId, roles)
    • none

Path parameters

assetIdinteger required

The ID of the asset to update

Query parameters

Namestring
FileExtensionstring
Descriptionstring
Linkstring

URL pointing to location of the asset. Only required if asset is an external link.

Pathstring

Asset path displayed in the UI. Not required for Folder or Icon AssetTypes

MyCCAccountIdinteger

ID of MyCC account associated with the asset. Should be null if asset is "shared" or associated with a staff user.

StaffUserIdinteger

Only Icon asset types can be associated with StaffUsers.

AssetType'File' | 'Folder' | 'ExternalLink' | 'Icon'
IsKeyResourceboolean
ThumbnailLinkstring

Deprecated. Public URL pointing asset location. Use GET Assets/AssetUrl/{assetId}?isThumbnail=true to get a pre-signed URL providing access to the asset thumbnail. Use POST Assets/Thumbnail/{assetId} to upload a new thumbnail for an asset.

LastUpdatedTimestampstring date-time

Response

OK

namestring required
fileExtensionstring nullable
sizeBytesnumber double nullable
myCCAssetIdinteger
mongoIdstring nullable
pathstring nullable
assetType'File' | 'Folder' | 'ExternalLink' | 'Icon'
descriptionstring nullable
linkstring nullable
lastUpdatedTimestampstring date-time nullable
thumbnailLinkstring nullable
isKeyResourceboolean nullable
thumbnailS3BucketPathstring nullable
hasThumbnailboolean
myCCAccountIdinteger nullable
myCCAccountNamestring nullable
isHiddenboolean

Changes

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