Trendsic Platform Service

<back to all web services

PlanSetReprocessRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/plansets/{PlanSetUID}/reprocess
"use strict";
export class SheetPin {
    /** @param {{SheetPinID?:number,SheetID?:number,EntityType?:string,EntityID?:number,EntityUID?:string,X?:number,Y?:number,Label?:string,CreatedBy?:string,CreatedAt?:string,EntityNo?:string,EntityTitle?:string,EntityStatus?:string,InspectionUID?:string,SheetNumber?:string,SheetTitle?:string,PlanSetID?:number,PlanSetUID?:string,PlanSetName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SheetPinID;
    /** @type {number} */
    SheetID;
    /** @type {string} */
    EntityType;
    /** @type {?number} */
    EntityID;
    /** @type {?string} */
    EntityUID;
    /** @type {number} */
    X;
    /** @type {number} */
    Y;
    /** @type {string} */
    Label;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {string} */
    EntityNo;
    /** @type {string} */
    EntityTitle;
    /** @type {string} */
    EntityStatus;
    /** @type {?string} */
    InspectionUID;
    /** @type {string} */
    SheetNumber;
    /** @type {string} */
    SheetTitle;
    /** @type {?number} */
    PlanSetID;
    /** @type {?string} */
    PlanSetUID;
    /** @type {string} */
    PlanSetName;
}
export class Sheet {
    /** @param {{SheetID?:number,PlanSetID?:number,PlanSetUID?:string,PlanSetName?:string,ProjectID?:number,PageIndex?:number,AttachmentId?:string,VersionNo?:number,SheetNumber?:string,SheetKey?:string,Title?:string,Discipline?:string,Revision?:string,RevisionDate?:string,WidthPt?:number,HeightPt?:number,ThumbKey?:string,ThumbUrl?:string,ThumbHash?:string,ExtractSource?:string,Confidence?:number,ChangeKind?:string,SupersedesSheetID?:number,IsCurrent?:boolean,PinCount?:number,UpdatedBy?:string,UpdatedAt?:string,Pins?:SheetPin[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SheetID;
    /** @type {number} */
    PlanSetID;
    /** @type {?string} */
    PlanSetUID;
    /** @type {string} */
    PlanSetName;
    /** @type {number} */
    ProjectID;
    /** @type {number} */
    PageIndex;
    /** @type {string} */
    AttachmentId;
    /** @type {number} */
    VersionNo;
    /** @type {string} */
    SheetNumber;
    /** @type {string} */
    SheetKey;
    /** @type {string} */
    Title;
    /** @type {string} */
    Discipline;
    /** @type {string} */
    Revision;
    /** @type {?string} */
    RevisionDate;
    /** @type {number} */
    WidthPt;
    /** @type {number} */
    HeightPt;
    /** @type {string} */
    ThumbKey;
    /** @type {string} */
    ThumbUrl;
    /** @type {string} */
    ThumbHash;
    /** @type {string} */
    ExtractSource;
    /** @type {?number} */
    Confidence;
    /** @type {string} */
    ChangeKind;
    /** @type {?number} */
    SupersedesSheetID;
    /** @type {boolean} */
    IsCurrent;
    /** @type {number} */
    PinCount;
    /** @type {string} */
    UpdatedBy;
    /** @type {?string} */
    UpdatedAt;
    /** @type {SheetPin[]} */
    Pins = [];
}
export class PlanSet {
    /** @param {{PlanSetID?:number,PlanSetUID?:string,ProjectID?:number,Name?:string,Source?:string,SourceLabel?:string,IssuedDate?:string,AttachmentId?:string,AttachmentName?:string,FileSizeInKB?:number,VersionNo?:number,Status?:string,Progress?:number,PageCount?:number,SheetCount?:number,ExtractMode?:string,ErrorText?:string,SupersedesPlanSetID?:number,SupersedesName?:string,IsCurrent?:boolean,CreatedBy?:string,CreatedAt?:string,ProcessedAt?:string,AgeSeconds?:number,Sheets?:Sheet[],Headline?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PlanSetID;
    /** @type {string} */
    PlanSetUID;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Source;
    /** @type {string} */
    SourceLabel;
    /** @type {?string} */
    IssuedDate;
    /** @type {string} */
    AttachmentId;
    /** @type {string} */
    AttachmentName;
    /** @type {?number} */
    FileSizeInKB;
    /** @type {number} */
    VersionNo;
    /** @type {string} */
    Status;
    /** @type {number} */
    Progress;
    /** @type {number} */
    PageCount;
    /** @type {number} */
    SheetCount;
    /** @type {string} */
    ExtractMode;
    /** @type {string} */
    ErrorText;
    /** @type {?number} */
    SupersedesPlanSetID;
    /** @type {string} */
    SupersedesName;
    /** @type {boolean} */
    IsCurrent;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    ProcessedAt;
    /** @type {number} */
    AgeSeconds;
    /** @type {Sheet[]} */
    Sheets = [];
    /** @type {string} */
    Headline;
}
export class PlanSetResponse {
    /** @param {{ResponseStatus?:ResponseStatus,PlanSet?:PlanSet,RemovedSheets?:Sheet[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {PlanSet} */
    PlanSet;
    /** @type {Sheet[]} */
    RemovedSheets = [];
}
export class PlanSetReprocessRequest {
    /** @param {{PlanSetUID?:string,ExtractMode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PlanSetUID;
    /** @type {string} */
    ExtractMode;
}

JavaScript PlanSetReprocessRequest DTOs

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

HTTP + XML

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

POST /v1/plansets/{PlanSetUID}/reprocess HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PlanSetReprocessRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ExtractMode>String</ExtractMode>
  <PlanSetUID>00000000-0000-0000-0000-000000000000</PlanSetUID>
</PlanSetReprocessRequest>

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>