About this resource
Representation of a public URI
Properties
Property | Description | Type |
---|---|---|
canDelete | Gets whether the public URI can be deleted or not. | boolean |
createdOn | Gets the creation datetime in UTC time. | datetime |
fileName | Gets the file name. | string |
fileVersionId | Gets the file version id. | guid |
id | Gets the id of public link. | guid |
modifiedOn | Gets the last modification datetime in UTC time. | datetime |
origin | Get the origin of public link, i.e. Order or API. | string (values: order, api) |
provider | Gets the CDN provider name. | string |
recordId | Gets the record id. | guid |
renditionId | Gets the rendition id. | guid |
renditionName | Gets the rendition name. | string |
renditionType | Gets the rendition type. | string (values: original, preset, crop, trim, custom) |
status | Gets the publish status. | string (values: pending, published, failed, overwritten, tobedeleted) |
targetId | Gets the target id. | guid |
targetType | Gets the target type. | string (values: version, preview, thumbnail, custom, additionalfile) |
uri | Get the uri for published file. | string |
Relations
Method | Name | Select-key | Resource type | Description |
---|---|---|---|---|
GET | self | Provides a link to this resource. | ||
GET | modifiedby | select-PublicUri: modifiedby | User | Gets or sets the user that last modified this resource. |
GET | createdby | select-PublicUri: createdby | User | Gets or sets the user that created this resource. |
Actions
Method | Action | Description | Response codes |
---|---|---|---|
PUT /publicuri/{publicUriId} | edit | Edits existing public uri | |
DELETE /publicuri/{publicUriId} | delete | Deletes an existing public uri |