| DELETE | /api/media | ||
|---|---|---|---|
| DELETE | /api/attachments |
export class DeleteMediaResponse
{
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<DeleteMediaResponse>) { (Object as any).assign(this, init); }
}
export class DeleteMedia
{
/** @description Guid of the Media File to be deleted. */
// @ApiMember(DataType="Guid", Description="Guid of the Media File to be deleted.", IsRequired=true, Name="MediaFileId")
public MediaFileId: string;
/** @description File Name to be deleted. */
// @ApiMember(DataType="string", Description="File Name to be deleted.", IsRequired=true, Name="FileName")
public FileName: string;
/** @description 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")
public ApplianceId: string;
/** @description 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")
public ContainerName: string;
/** @description Object connected to the attachment being deleted. */
// @ApiMember(DataType="Guid", Description="Object connected to the attachment being deleted.", IsRequired=true, Name="ConnectedObjectId")
public ConnectedObjectId: string;
/** @description 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")
public ConnectedObjectLicenseeId: string;
/** @description 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")
public IsPrimary: boolean;
public constructor(init?: Partial<DeleteMedia>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}