| DELETE | /api/media | ||
|---|---|---|---|
| DELETE | /api/attachments |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteMediaResponse:
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteMedia:
# @ApiMember(DataType="Guid", Description="Guid of the Media File to be deleted.", IsRequired=true, Name="MediaFileId")
media_file_id: Optional[str] = None
"""
Guid of the Media File to be deleted.
"""
# @ApiMember(DataType="string", Description="File Name to be deleted.", IsRequired=true, Name="FileName")
file_name: Optional[str] = None
"""
File Name to be deleted.
"""
# @ApiMember(DataType="Guid", Description="Appliance from which media file is to be deleted.", IsRequired=true, Name="ApplianceId")
appliance_id: Optional[str] = None
"""
Appliance from which media file is to be deleted.
"""
# @ApiMember(DataType="string", Description="Container from which media file is to be deleted. Defaults to 'attachments' container for attachments.", IsRequired=true, Name="ContainerName")
container_name: Optional[str] = None
"""
Container from which media file is to be deleted. Defaults to 'attachments' container for attachments.
"""
# @ApiMember(DataType="Guid", Description="Object connected to the attachment being deleted.", IsRequired=true, Name="ConnectedObjectId")
connected_object_id: Optional[str] = None
"""
Object connected to the attachment being deleted.
"""
# @ApiMember(DataType="Guid", Description="Licensee Id of the Object owner for which primary image is to be uploaded.", IsRequired=true, Name="ConnectedObjectLicenseeId")
connected_object_licensee_id: Optional[str] = None
"""
Licensee Id of the Object owner for which primary image is to be uploaded.
"""
# @ApiMember(DataType="bool", Description="Is the media file being deleted the primary file linked to the object?.", Name="IsPrimary")
is_primary: bool = False
"""
Is the media file being deleted the primary file linked to the object?.
"""
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"}}}