Trendsic Platform Service

<back to all web services

FormSubmissionExportPreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/export/preview
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 FormSubmissionExportPreviewResponse:
    rows: int = 0
    cap: int = 0
    form_name: Optional[str] = None
    can_export: bool = False
    message: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormAnswerCond:
    f: Optional[str] = None
    op: Optional[str] = None
    v: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionSearchRequest:
    form_u_i_d: Optional[str] = None
    mode: Optional[str] = None
    forms: List[str] = field(default_factory=list)
    stages: List[str] = field(default_factory=list)
    assignees: List[int] = field(default_factory=list)
    branches: List[str] = field(default_factory=list)
    tags: List[str] = field(default_factory=list)
    search: Optional[str] = None
    sort_key: Optional[str] = None
    sort_dir: int = 0
    skip: int = 0
    take: int = 0
    conds: List[FormAnswerCond] = field(default_factory=list)
    flags: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormSubmissionExportPreviewRequest:
    query: Optional[FormSubmissionSearchRequest] = None
    submission_u_i_ds: List[str] = field(default_factory=list)

Python FormSubmissionExportPreviewRequest 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 /v1/forms/submissions/export/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Query":{"FormUID":"00000000000000000000000000000000","Mode":"String","Forms":["00000000000000000000000000000000"],"Stages":["String"],"Assignees":[0],"Branches":["String"],"Tags":["String"],"Search":"String","SortKey":"String","SortDir":0,"Skip":0,"Take":0,"Conds":[{"F":"String","Op":"String","V":"String"}],"Flags":["String"]},"SubmissionUIDs":["00000000000000000000000000000000"]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Rows":0,"Cap":0,"FormName":"String","CanExport":false,"Message":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}