| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<FormSubmissionExportPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Query>
<Assignees xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>0</d3p1:int>
</Assignees>
<Branches xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Branches>
<Conds>
<FormAnswerCond>
<F>String</F>
<Op>String</Op>
<V>String</V>
</FormAnswerCond>
</Conds>
<Flags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Flags>
<FormUID>00000000-0000-0000-0000-000000000000</FormUID>
<Forms xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
</Forms>
<Mode>String</Mode>
<Search>String</Search>
<Skip>0</Skip>
<SortDir>0</SortDir>
<SortKey>String</SortKey>
<Stages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Stages>
<Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Tags>
<Take>0</Take>
</Query>
<SubmissionUIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</SubmissionUIDs>
</FormSubmissionExportPreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormSubmissionExportPreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<CanExport>false</CanExport>
<Cap>0</Cap>
<FormName>String</FormName>
<Message>String</Message>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Rows>0</Rows>
</FormSubmissionExportPreviewResponse>