| DELETE | /api/media | ||
|---|---|---|---|
| DELETE | /api/attachments |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class DeleteMedia
{
/**
* Guid of the Media File to be deleted.
*/
@ApiMember(DataType="Guid", Description="Guid of the Media File to be deleted.", IsRequired=true, Name="MediaFileId")
open var MediaFileId:UUID? = null
/**
* File Name to be deleted.
*/
@ApiMember(DataType="string", Description="File Name to be deleted.", IsRequired=true, Name="FileName")
open var FileName:String? = null
/**
* Appliance from which media file is to be deleted.
*/
@ApiMember(DataType="Guid", Description="Appliance from which media file is to be deleted.", IsRequired=true, Name="ApplianceId")
open var ApplianceId:UUID? = null
/**
* Container from which media file is to be deleted. Defaults to 'attachments' container for attachments.
*/
@ApiMember(DataType="string", Description="Container from which media file is to be deleted. Defaults to 'attachments' container for attachments.", IsRequired=true, Name="ContainerName")
open var ContainerName:String? = null
/**
* Object connected to the attachment being deleted.
*/
@ApiMember(DataType="Guid", Description="Object connected to the attachment being deleted.", IsRequired=true, Name="ConnectedObjectId")
open var ConnectedObjectId:UUID? = null
/**
* Licensee Id of the Object owner for which primary image is to be uploaded.
*/
@ApiMember(DataType="Guid", Description="Licensee Id of the Object owner for which primary image is to be uploaded.", IsRequired=true, Name="ConnectedObjectLicenseeId")
open var ConnectedObjectLicenseeId:UUID? = null
/**
* Is the media file being deleted the primary file linked to the object?.
*/
@ApiMember(DataType="bool", Description="Is the media file being deleted the primary file linked to the object?.", Name="IsPrimary")
open var IsPrimary:Boolean? = null
}
open class DeleteMediaResponse
{
open var ResponseStatus:ResponseStatus? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
DELETE /api/media HTTP/1.1 Host: pfapi.pstpf.com.au Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}