digitaluapi

Files

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
All Verbs	/restfiles/files
All Verbs	/restfiles/files/{Path*}

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 Files:
    path: Optional[str] = None
    text_contents: Optional[str] = None
    for_download: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Folder:
    name: Optional[str] = None
    modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    file_count: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class File:
    name: Optional[str] = None
    extension: Optional[str] = None
    file_size_bytes: int = 0
    modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    is_text_file: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FolderResult:
    folders: Optional[List[Folder]] = None
    files: Optional[List[File]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FileResult:
    name: Optional[str] = None
    extension: Optional[str] = None
    file_size_bytes: int = 0
    modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    is_text_file: bool = False
    contents: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FilesResponse:
    directory: Optional[FolderResult] = None
    file: Optional[FileResult] = None
    response_status: Optional[ResponseStatus] = None

Python Files DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /restfiles/files HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Path":"String","TextContents":"String","ForDownload":false}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Directory":{"Folders":[{"Name":"String","ModifiedDate":"0001-01-01T00:00:00.0000000","FileCount":0}],"Files":[{"Name":"String","Extension":"String","FileSizeBytes":0,"ModifiedDate":"0001-01-01T00:00:00.0000000","IsTextFile":false}]},"File":{"Name":"String","Extension":"String","FileSizeBytes":0,"ModifiedDate":"0001-01-01T00:00:00.0000000","IsTextFile":false,"Contents":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}