| POST,OPTIONS | /v1/projects/{ProjectID}/plansets/from-attachment |
|---|
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 SheetPin:
sheet_pin_i_d: int = 0
sheet_i_d: int = 0
entity_type: Optional[str] = None
entity_i_d: Optional[int] = None
entity_u_i_d: Optional[str] = None
x: float = 0.0
y: float = 0.0
label: Optional[str] = None
created_by: Optional[str] = None
created_at: Optional[datetime.datetime] = None
entity_no: Optional[str] = None
entity_title: Optional[str] = None
entity_status: Optional[str] = None
inspection_u_i_d: Optional[str] = None
sheet_number: Optional[str] = None
sheet_title: Optional[str] = None
plan_set_i_d: Optional[int] = None
plan_set_u_i_d: Optional[str] = None
plan_set_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Sheet:
sheet_i_d: int = 0
plan_set_i_d: int = 0
plan_set_u_i_d: Optional[str] = None
plan_set_name: Optional[str] = None
project_i_d: int = 0
page_index: int = 0
attachment_id: Optional[str] = None
version_no: int = 0
sheet_number: Optional[str] = None
sheet_key: Optional[str] = None
title: Optional[str] = None
discipline: Optional[str] = None
revision: Optional[str] = None
revision_date: Optional[datetime.datetime] = None
width_pt: float = 0.0
height_pt: float = 0.0
thumb_key: Optional[str] = None
thumb_url: Optional[str] = None
thumb_hash: Optional[str] = None
extract_source: Optional[str] = None
confidence: Optional[float] = None
change_kind: Optional[str] = None
supersedes_sheet_i_d: Optional[int] = None
is_current: bool = False
pin_count: int = 0
updated_by: Optional[str] = None
updated_at: Optional[datetime.datetime] = None
pins: List[SheetPin] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlanSet:
plan_set_i_d: int = 0
plan_set_u_i_d: Optional[str] = None
project_i_d: int = 0
name: Optional[str] = None
source: Optional[str] = None
source_label: Optional[str] = None
issued_date: Optional[datetime.datetime] = None
attachment_id: Optional[str] = None
attachment_name: Optional[str] = None
file_size_in_k_b: Optional[float] = None
version_no: int = 0
status: Optional[str] = None
progress: int = 0
page_count: int = 0
sheet_count: int = 0
extract_mode: Optional[str] = None
error_text: Optional[str] = None
supersedes_plan_set_i_d: Optional[int] = None
supersedes_name: Optional[str] = None
is_current: bool = False
created_by: Optional[str] = None
created_at: Optional[datetime.datetime] = None
processed_at: Optional[datetime.datetime] = None
age_seconds: int = 0
sheets: List[Sheet] = field(default_factory=list)
headline: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlanSetResponse:
response_status: Optional[ResponseStatus] = None
plan_set: Optional[PlanSet] = None
removed_sheets: List[Sheet] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlanSetFromAttachmentRequest:
project_i_d: int = 0
attachment_id: Optional[str] = None
name: Optional[str] = None
source: Optional[str] = None
issued_date: Optional[str] = None
supersedes_plan_set_u_i_d: Optional[str] = None
extract_mode: Optional[str] = None
standalone: bool = False
Python PlanSetFromAttachmentRequest 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/projects/{ProjectID}/plansets/from-attachment HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PlanSetFromAttachmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<ExtractMode>String</ExtractMode>
<IssuedDate>String</IssuedDate>
<Name>String</Name>
<ProjectID>0</ProjectID>
<Source>String</Source>
<Standalone>false</Standalone>
<SupersedesPlanSetUID>00000000-0000-0000-0000-000000000000</SupersedesPlanSetUID>
</PlanSetFromAttachmentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PlanSetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<PlanSet>
<AgeSeconds>0</AgeSeconds>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<AttachmentName>String</AttachmentName>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<ErrorText>String</ErrorText>
<ExtractMode>String</ExtractMode>
<FileSizeInKB>0</FileSizeInKB>
<Headline>String</Headline>
<IsCurrent>false</IsCurrent>
<IssuedDate>0001-01-01T00:00:00</IssuedDate>
<Name>String</Name>
<PageCount>0</PageCount>
<PlanSetID>0</PlanSetID>
<PlanSetUID>00000000-0000-0000-0000-000000000000</PlanSetUID>
<ProcessedAt>0001-01-01T00:00:00</ProcessedAt>
<Progress>0</Progress>
<ProjectID>0</ProjectID>
<SheetCount>0</SheetCount>
<Sheets>
<Sheet>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<ChangeKind>String</ChangeKind>
<Confidence>0</Confidence>
<Discipline>String</Discipline>
<ExtractSource>String</ExtractSource>
<HeightPt>0</HeightPt>
<IsCurrent>false</IsCurrent>
<PageIndex>0</PageIndex>
<PinCount>0</PinCount>
<Pins>
<SheetPin>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<EntityID>0</EntityID>
<EntityNo>String</EntityNo>
<EntityStatus>String</EntityStatus>
<EntityTitle>String</EntityTitle>
<EntityType>String</EntityType>
<EntityUID>00000000-0000-0000-0000-000000000000</EntityUID>
<InspectionUID>00000000-0000-0000-0000-000000000000</InspectionUID>
<Label>String</Label>
<PlanSetID>0</PlanSetID>
<PlanSetName>String</PlanSetName>
<PlanSetUID>00000000-0000-0000-0000-000000000000</PlanSetUID>
<SheetID>0</SheetID>
<SheetNumber>String</SheetNumber>
<SheetPinID>0</SheetPinID>
<SheetTitle>String</SheetTitle>
<X>0</X>
<Y>0</Y>
</SheetPin>
</Pins>
<PlanSetID>0</PlanSetID>
<PlanSetName>String</PlanSetName>
<PlanSetUID>00000000-0000-0000-0000-000000000000</PlanSetUID>
<ProjectID>0</ProjectID>
<Revision>String</Revision>
<RevisionDate>0001-01-01T00:00:00</RevisionDate>
<SheetID>0</SheetID>
<SheetKey>String</SheetKey>
<SheetNumber>String</SheetNumber>
<SupersedesSheetID>0</SupersedesSheetID>
<ThumbHash>String</ThumbHash>
<ThumbKey>String</ThumbKey>
<ThumbUrl>String</ThumbUrl>
<Title>String</Title>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<UpdatedBy>String</UpdatedBy>
<VersionNo>0</VersionNo>
<WidthPt>0</WidthPt>
</Sheet>
</Sheets>
<Source>String</Source>
<SourceLabel>String</SourceLabel>
<Status>String</Status>
<SupersedesName>String</SupersedesName>
<SupersedesPlanSetID>0</SupersedesPlanSetID>
<VersionNo>0</VersionNo>
</PlanSet>
<RemovedSheets>
<Sheet>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<ChangeKind>String</ChangeKind>
<Confidence>0</Confidence>
<Discipline>String</Discipline>
<ExtractSource>String</ExtractSource>
<HeightPt>0</HeightPt>
<IsCurrent>false</IsCurrent>
<PageIndex>0</PageIndex>
<PinCount>0</PinCount>
<Pins>
<SheetPin>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<EntityID>0</EntityID>
<EntityNo>String</EntityNo>
<EntityStatus>String</EntityStatus>
<EntityTitle>String</EntityTitle>
<EntityType>String</EntityType>
<EntityUID>00000000-0000-0000-0000-000000000000</EntityUID>
<InspectionUID>00000000-0000-0000-0000-000000000000</InspectionUID>
<Label>String</Label>
<PlanSetID>0</PlanSetID>
<PlanSetName>String</PlanSetName>
<PlanSetUID>00000000-0000-0000-0000-000000000000</PlanSetUID>
<SheetID>0</SheetID>
<SheetNumber>String</SheetNumber>
<SheetPinID>0</SheetPinID>
<SheetTitle>String</SheetTitle>
<X>0</X>
<Y>0</Y>
</SheetPin>
</Pins>
<PlanSetID>0</PlanSetID>
<PlanSetName>String</PlanSetName>
<PlanSetUID>00000000-0000-0000-0000-000000000000</PlanSetUID>
<ProjectID>0</ProjectID>
<Revision>String</Revision>
<RevisionDate>0001-01-01T00:00:00</RevisionDate>
<SheetID>0</SheetID>
<SheetKey>String</SheetKey>
<SheetNumber>String</SheetNumber>
<SupersedesSheetID>0</SupersedesSheetID>
<ThumbHash>String</ThumbHash>
<ThumbKey>String</ThumbKey>
<ThumbUrl>String</ThumbUrl>
<Title>String</Title>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<UpdatedBy>String</UpdatedBy>
<VersionNo>0</VersionNo>
<WidthPt>0</WidthPt>
</Sheet>
</RemovedSheets>
<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>
</PlanSetResponse>