GET api/CustomSheetView/GetCustomSheet?uniqueId={uniqueId}

Request Information

URI Parameters

Name	Description	Type	Additional information
uniqueId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

CustomSheetViewViewModel

Name	Type	Additional information
CustomSheetName	string	None.
Content	string	None.
PageSize	integer	None.
PageOrientation	integer	None.
AnnotationContent	Collection of AnnotationViewModel	None.
CustomSheetExtensionInformation	CustomSheetExtensionViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "customSheetName": "sample string 1",
  "content": "sample string 2",
  "pageSize": 3,
  "pageOrientation": 4,
  "annotationContent": [
    {
      "jobUid": "sample string 1",
      "id": 2,
      "reportId": "sample string 3",
      "annotationId": "sample string 4",
      "annotationType": 5,
      "pageNo": 6,
      "pageOrientation": 7,
      "left": "sample string 8",
      "top": "sample string 9",
      "width": "sample string 10",
      "height": "sample string 11",
      "contents": "sample string 12",
      "fontFamily": "sample string 13",
      "fontStyle": "sample string 14",
      "fontWeight": "sample string 15",
      "fontSize": "sample string 16",
      "fontColor": "sample string 17",
      "textDecoration": "sample string 18",
      "border": "sample string 19",
      "fillColor": "sample string 20",
      "alignment": "sample string 21",
      "arrowId": "sample string 22",
      "arrowLineId": "sample string 23",
      "arrowX": "sample string 24",
      "arrowY": "sample string 25",
      "imageUrl": "sample string 26",
      "imageUniqueId": "24db7e4c-7a38-40e7-ae2a-d73c0972c8ef",
      "isAnnotationDeleted": true,
      "imageAnnotation": {
        "id": 1,
        "uniqueId": "598a5759-f878-46d8-ac8a-32e5631b5764",
        "fileName": "sample string 3",
        "jobUid": "451d5ff1-3f4e-4778-bea7-36199fe21d2b"
      },
      "rotateValue": "sample string 29",
      "shapeName": "sample string 30",
      "shapeStrokeWidth": "sample string 31",
      "shapeStrokeColor": "sample string 32",
      "shapeStrokeDashArray": "sample string 33",
      "shapeFillColor": "sample string 34",
      "shapeHatchSelection": "sample string 35",
      "annotationUniqueName": "sample string 36",
      "annotationWorkOrderId": 37,
      "zIndex": 38
    },
    {
      "jobUid": "sample string 1",
      "id": 2,
      "reportId": "sample string 3",
      "annotationId": "sample string 4",
      "annotationType": 5,
      "pageNo": 6,
      "pageOrientation": 7,
      "left": "sample string 8",
      "top": "sample string 9",
      "width": "sample string 10",
      "height": "sample string 11",
      "contents": "sample string 12",
      "fontFamily": "sample string 13",
      "fontStyle": "sample string 14",
      "fontWeight": "sample string 15",
      "fontSize": "sample string 16",
      "fontColor": "sample string 17",
      "textDecoration": "sample string 18",
      "border": "sample string 19",
      "fillColor": "sample string 20",
      "alignment": "sample string 21",
      "arrowId": "sample string 22",
      "arrowLineId": "sample string 23",
      "arrowX": "sample string 24",
      "arrowY": "sample string 25",
      "imageUrl": "sample string 26",
      "imageUniqueId": "24db7e4c-7a38-40e7-ae2a-d73c0972c8ef",
      "isAnnotationDeleted": true,
      "imageAnnotation": {
        "id": 1,
        "uniqueId": "598a5759-f878-46d8-ac8a-32e5631b5764",
        "fileName": "sample string 3",
        "jobUid": "451d5ff1-3f4e-4778-bea7-36199fe21d2b"
      },
      "rotateValue": "sample string 29",
      "shapeName": "sample string 30",
      "shapeStrokeWidth": "sample string 31",
      "shapeStrokeColor": "sample string 32",
      "shapeStrokeDashArray": "sample string 33",
      "shapeFillColor": "sample string 34",
      "shapeHatchSelection": "sample string 35",
      "annotationUniqueName": "sample string 36",
      "annotationWorkOrderId": 37,
      "zIndex": 38
    }
  ],
  "customSheetExtensionInformation": {
    "customSheetScale": [
      {
        "customSheetName": "sample string 1",
        "drawingId": "sample string 2",
        "originalScale": 3.1,
        "scale": 4.1,
        "scalePercent": 5.1,
        "applyScale": true,
        "rotation": 7.1
      },
      {
        "customSheetName": "sample string 1",
        "drawingId": "sample string 2",
        "originalScale": 3.1,
        "scale": 4.1,
        "scalePercent": 5.1,
        "applyScale": true,
        "rotation": 7.1
      }
    ],
    "customSheetDimOverrides": [
      {
        "customSheetName": "sample string 1",
        "customDrawingId": "sample string 2",
        "dimOverides": [
          {
            "id": "sample string 1",
            "type": "sample string 2",
            "x": "sample string 3",
            "y": "sample string 4",
            "x1": "sample string 5",
            "y1": "sample string 6",
            "x2": "sample string 7",
            "y2": "sample string 8",
            "hide": true
          },
          {
            "id": "sample string 1",
            "type": "sample string 2",
            "x": "sample string 3",
            "y": "sample string 4",
            "x1": "sample string 5",
            "y1": "sample string 6",
            "x2": "sample string 7",
            "y2": "sample string 8",
            "hide": true
          }
        ]
      },
      {
        "customSheetName": "sample string 1",
        "customDrawingId": "sample string 2",
        "dimOverides": [
          {
            "id": "sample string 1",
            "type": "sample string 2",
            "x": "sample string 3",
            "y": "sample string 4",
            "x1": "sample string 5",
            "y1": "sample string 6",
            "x2": "sample string 7",
            "y2": "sample string 8",
            "hide": true
          },
          {
            "id": "sample string 1",
            "type": "sample string 2",
            "x": "sample string 3",
            "y": "sample string 4",
            "x1": "sample string 5",
            "y1": "sample string 6",
            "x2": "sample string 7",
            "y2": "sample string 8",
            "hide": true
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<CustomSheetViewViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <AnnotationContent>
    <AnnotationViewModel>
      <Alignment>sample string 21</Alignment>
      <AnnotationId>sample string 4</AnnotationId>
      <AnnotationType>5</AnnotationType>
      <AnnotationUniqueName>sample string 36</AnnotationUniqueName>
      <AnnotationWorkOrderId>37</AnnotationWorkOrderId>
      <ArrowId>sample string 22</ArrowId>
      <ArrowLineId>sample string 23</ArrowLineId>
      <ArrowX>sample string 24</ArrowX>
      <ArrowY>sample string 25</ArrowY>
      <Border>sample string 19</Border>
      <Contents>sample string 12</Contents>
      <FillColor>sample string 20</FillColor>
      <FontColor>sample string 17</FontColor>
      <FontFamily>sample string 13</FontFamily>
      <FontSize>sample string 16</FontSize>
      <FontStyle>sample string 14</FontStyle>
      <FontWeight>sample string 15</FontWeight>
      <Height>sample string 11</Height>
      <Id>2</Id>
      <ImageAnnotation>
        <FileName>sample string 3</FileName>
        <Id>1</Id>
        <JobUid>451d5ff1-3f4e-4778-bea7-36199fe21d2b</JobUid>
        <UniqueId>598a5759-f878-46d8-ac8a-32e5631b5764</UniqueId>
      </ImageAnnotation>
      <ImageUniqueId>24db7e4c-7a38-40e7-ae2a-d73c0972c8ef</ImageUniqueId>
      <ImageUrl>sample string 26</ImageUrl>
      <IsAnnotationDeleted>true</IsAnnotationDeleted>
      <JobUid>sample string 1</JobUid>
      <Left>sample string 8</Left>
      <PageNo>6</PageNo>
      <PageOrientation>7</PageOrientation>
      <ReportId>sample string 3</ReportId>
      <RotateValue>sample string 29</RotateValue>
      <ShapeFillColor>sample string 34</ShapeFillColor>
      <ShapeHatchSelection>sample string 35</ShapeHatchSelection>
      <ShapeName>sample string 30</ShapeName>
      <ShapeStrokeColor>sample string 32</ShapeStrokeColor>
      <ShapeStrokeDashArray>sample string 33</ShapeStrokeDashArray>
      <ShapeStrokeWidth>sample string 31</ShapeStrokeWidth>
      <TextDecoration>sample string 18</TextDecoration>
      <Top>sample string 9</Top>
      <Width>sample string 10</Width>
      <ZIndex>38</ZIndex>
    </AnnotationViewModel>
    <AnnotationViewModel>
      <Alignment>sample string 21</Alignment>
      <AnnotationId>sample string 4</AnnotationId>
      <AnnotationType>5</AnnotationType>
      <AnnotationUniqueName>sample string 36</AnnotationUniqueName>
      <AnnotationWorkOrderId>37</AnnotationWorkOrderId>
      <ArrowId>sample string 22</ArrowId>
      <ArrowLineId>sample string 23</ArrowLineId>
      <ArrowX>sample string 24</ArrowX>
      <ArrowY>sample string 25</ArrowY>
      <Border>sample string 19</Border>
      <Contents>sample string 12</Contents>
      <FillColor>sample string 20</FillColor>
      <FontColor>sample string 17</FontColor>
      <FontFamily>sample string 13</FontFamily>
      <FontSize>sample string 16</FontSize>
      <FontStyle>sample string 14</FontStyle>
      <FontWeight>sample string 15</FontWeight>
      <Height>sample string 11</Height>
      <Id>2</Id>
      <ImageAnnotation>
        <FileName>sample string 3</FileName>
        <Id>1</Id>
        <JobUid>451d5ff1-3f4e-4778-bea7-36199fe21d2b</JobUid>
        <UniqueId>598a5759-f878-46d8-ac8a-32e5631b5764</UniqueId>
      </ImageAnnotation>
      <ImageUniqueId>24db7e4c-7a38-40e7-ae2a-d73c0972c8ef</ImageUniqueId>
      <ImageUrl>sample string 26</ImageUrl>
      <IsAnnotationDeleted>true</IsAnnotationDeleted>
      <JobUid>sample string 1</JobUid>
      <Left>sample string 8</Left>
      <PageNo>6</PageNo>
      <PageOrientation>7</PageOrientation>
      <ReportId>sample string 3</ReportId>
      <RotateValue>sample string 29</RotateValue>
      <ShapeFillColor>sample string 34</ShapeFillColor>
      <ShapeHatchSelection>sample string 35</ShapeHatchSelection>
      <ShapeName>sample string 30</ShapeName>
      <ShapeStrokeColor>sample string 32</ShapeStrokeColor>
      <ShapeStrokeDashArray>sample string 33</ShapeStrokeDashArray>
      <ShapeStrokeWidth>sample string 31</ShapeStrokeWidth>
      <TextDecoration>sample string 18</TextDecoration>
      <Top>sample string 9</Top>
      <Width>sample string 10</Width>
      <ZIndex>38</ZIndex>
    </AnnotationViewModel>
  </AnnotationContent>
  <Content>sample string 2</Content>
  <CustomSheetExtensionInformation>
    <CustomSheetDimOverrides>
      <CustomSheetDimOverridesMain>
        <CustomDrawingId>sample string 2</CustomDrawingId>
        <CustomSheetName>sample string 1</CustomSheetName>
        <DimOverides>
          <CustomSheetDimOverridesDetails>
            <Hide>true</Hide>
            <Id>sample string 1</Id>
            <Type>sample string 2</Type>
            <X>sample string 3</X>
            <X1>sample string 5</X1>
            <X2>sample string 7</X2>
            <Y>sample string 4</Y>
            <Y1>sample string 6</Y1>
            <Y2>sample string 8</Y2>
          </CustomSheetDimOverridesDetails>
          <CustomSheetDimOverridesDetails>
            <Hide>true</Hide>
            <Id>sample string 1</Id>
            <Type>sample string 2</Type>
            <X>sample string 3</X>
            <X1>sample string 5</X1>
            <X2>sample string 7</X2>
            <Y>sample string 4</Y>
            <Y1>sample string 6</Y1>
            <Y2>sample string 8</Y2>
          </CustomSheetDimOverridesDetails>
        </DimOverides>
      </CustomSheetDimOverridesMain>
      <CustomSheetDimOverridesMain>
        <CustomDrawingId>sample string 2</CustomDrawingId>
        <CustomSheetName>sample string 1</CustomSheetName>
        <DimOverides>
          <CustomSheetDimOverridesDetails>
            <Hide>true</Hide>
            <Id>sample string 1</Id>
            <Type>sample string 2</Type>
            <X>sample string 3</X>
            <X1>sample string 5</X1>
            <X2>sample string 7</X2>
            <Y>sample string 4</Y>
            <Y1>sample string 6</Y1>
            <Y2>sample string 8</Y2>
          </CustomSheetDimOverridesDetails>
          <CustomSheetDimOverridesDetails>
            <Hide>true</Hide>
            <Id>sample string 1</Id>
            <Type>sample string 2</Type>
            <X>sample string 3</X>
            <X1>sample string 5</X1>
            <X2>sample string 7</X2>
            <Y>sample string 4</Y>
            <Y1>sample string 6</Y1>
            <Y2>sample string 8</Y2>
          </CustomSheetDimOverridesDetails>
        </DimOverides>
      </CustomSheetDimOverridesMain>
    </CustomSheetDimOverrides>
    <CustomSheetScale>
      <CustomSheetScaleDetailViewModel>
        <ApplyScale>true</ApplyScale>
        <CustomSheetName>sample string 1</CustomSheetName>
        <DrawingId>sample string 2</DrawingId>
        <OriginalScale>3.1</OriginalScale>
        <Rotation>7.1</Rotation>
        <Scale>4.1</Scale>
        <ScalePercent>5.1</ScalePercent>
      </CustomSheetScaleDetailViewModel>
      <CustomSheetScaleDetailViewModel>
        <ApplyScale>true</ApplyScale>
        <CustomSheetName>sample string 1</CustomSheetName>
        <DrawingId>sample string 2</DrawingId>
        <OriginalScale>3.1</OriginalScale>
        <Rotation>7.1</Rotation>
        <Scale>4.1</Scale>
        <ScalePercent>5.1</ScalePercent>
      </CustomSheetScaleDetailViewModel>
    </CustomSheetScale>
  </CustomSheetExtensionInformation>
  <CustomSheetName>sample string 1</CustomSheetName>
  <PageOrientation>4</PageOrientation>
  <PageSize>3</PageSize>
</CustomSheetViewViewModel>