| PUT | /v1/forms/{FormUID} |
|---|
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 FormStats:
total: int = 0
need_decision: int = 0
waiting: int = 0
overdue: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormCard:
form_u_i_d: Optional[str] = None
name: Optional[str] = None
slug: Optional[str] = None
noun: Optional[str] = None
number_prefix: Optional[str] = None
description: Optional[str] = None
tone: Optional[str] = None
status: Optional[str] = None
published_version_no: Optional[int] = None
published_at: Optional[datetime.datetime] = None
published_by: Optional[str] = None
draft_dirty: bool = False
draft_updated_at: Optional[datetime.datetime] = None
draft_updated_by: Optional[str] = None
pack_label: Optional[str] = None
settings_json: Optional[str] = None
stats: Optional[FormStats] = None
offered: List[str] = field(default_factory=list)
created_by: Optional[str] = None
created_at: Optional[datetime.datetime] = None
updated_at: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormDetail(FormCard):
draft_json: Optional[str] = None
draft_rev: int = 0
source_template_u_i_d: Optional[str] = None
warnings: List[str] = field(default_factory=list)
always_hidden: List[str] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormResponse:
form: Optional[FormDetail] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormUpdateRequest:
form_u_i_d: Optional[str] = None
name: Optional[str] = None
noun: Optional[str] = None
description: Optional[str] = None
number_prefix: Optional[str] = None
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.
PUT /v1/forms/{FormUID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"FormUID":"00000000000000000000000000000000","Name":"String","Noun":"String","Description":"String","NumberPrefix":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Form":{"DraftJson":"String","DraftRev":0,"SourceTemplateUID":"00000000000000000000000000000000","Warnings":["String"],"AlwaysHidden":["String"],"FormUID":"00000000000000000000000000000000","Name":"String","Slug":"String","Noun":"String","NumberPrefix":"String","Description":"String","Tone":"String","Status":"String","PublishedVersionNo":0,"PublishedAt":"0001-01-01T00:00:00.0000000","PublishedBy":"String","DraftDirty":false,"DraftUpdatedAt":"0001-01-01T00:00:00.0000000","DraftUpdatedBy":"String","PackLabel":"String","SettingsJson":"String","Stats":{"Total":0,"NeedDecision":0,"Waiting":0,"Overdue":0},"Offered":["String"],"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}