POST api/{m2Id}/projects/{projectId}/clone

Clone one project from designated project

Request Information

URI Parameters

NameDescriptionTypeAdditional information
m2Id

Creator's MeasureSquare ID

string

Required

projectId

The source project's Id, to copy from

string

Required

Body Parameters

Only Name required for the new project name

CloneProjectInfoDTO
NameDescriptionTypeAdditional information
Name

Project Name

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1"
}

application/xml, text/xml

Sample:
<CloneProjectInfoDTO>
  <Name>sample string 1</Name>
</CloneProjectInfoDTO>

Response Information

Resource Description

the cloned project info. If cloned fail, the value of ProjectId is null.

ProjectDTO
NameDescriptionTypeAdditional information
ProjectId

Project ID

string

None.

Name

Project Name

string

None.

Revision

Revision. the project's latest revision

integer

None.

OwnerM2Id

The project owner

string

None.

CreatorM2Id

The project createor

string

None.

UsedM2Id

Who uses the project

string

None.

LastUpdatedOn

Timestamp. the project's latest updated time.

integer

None.

Size

File Size

integer

None.

ProjectInfo

Detail project info. customer, job site and products information.
This value will not be returned while getting from project list api.

ProjectInfoDTO

None.

IsArchived

Project is archived or not?

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ProjectId": "sample string 1",
  "Name": "sample string 2",
  "Revision": 3,
  "OwnerM2Id": "sample string 4",
  "CreatorM2Id": "sample string 5",
  "UsedM2Id": "sample string 6",
  "LastUpdatedOn": 7,
  "Size": 8,
  "ProjectInfo": {
    "TilePatternList": [
      {
        "ID": "sample string 1",
        "IsRandomHardwood": true,
        "IsHardwood": true,
        "Grout": "sample string 4",
        "GroutWidth": "sample string 5",
        "Thickness": "sample string 6",
        "PatternTiles": [
          {
            "ID": "sample string 1",
            "CountInPattern": 2,
            "Randomizers": [
              {
                "ID": "sample string 1",
                "Percent": "sample string 2"
              },
              {
                "ID": "sample string 1",
                "Percent": "sample string 2"
              }
            ]
          },
          {
            "ID": "sample string 1",
            "CountInPattern": 2,
            "Randomizers": [
              {
                "ID": "sample string 1",
                "Percent": "sample string 2"
              },
              {
                "ID": "sample string 1",
                "Percent": "sample string 2"
              }
            ]
          }
        ]
      },
      {
        "ID": "sample string 1",
        "IsRandomHardwood": true,
        "IsHardwood": true,
        "Grout": "sample string 4",
        "GroutWidth": "sample string 5",
        "Thickness": "sample string 6",
        "PatternTiles": [
          {
            "ID": "sample string 1",
            "CountInPattern": 2,
            "Randomizers": [
              {
                "ID": "sample string 1",
                "Percent": "sample string 2"
              },
              {
                "ID": "sample string 1",
                "Percent": "sample string 2"
              }
            ]
          },
          {
            "ID": "sample string 1",
            "CountInPattern": 2,
            "Randomizers": [
              {
                "ID": "sample string 1",
                "Percent": "sample string 2"
              },
              {
                "ID": "sample string 1",
                "Percent": "sample string 2"
              }
            ]
          }
        ]
      }
    ],
    "ProjectId": "sample string 1",
    "Name": "sample string 2",
    "ApplicationType": "sample string 3",
    "ProjectNote": "sample string 4",
    "ProjectName": "sample string 5",
    "ProjectStreet": "sample string 6",
    "ProjectCity": "sample string 7",
    "ProjectState": "sample string 8",
    "ProjectZipCode": "sample string 9",
    "ProjectCountry": "sample string 10",
    "ProjectEmail": "sample string 11",
    "ProjectPhone": "sample string 12",
    "ProjectMobile": "sample string 13",
    "ProjectFax": "sample string 14",
    "ProjectMemo": "sample string 15",
    "ContactName": "sample string 16",
    "Email": "sample string 17",
    "Phone": "sample string 18",
    "Mobile": "sample string 19",
    "Fax": "sample string 20",
    "Memo": "sample string 21",
    "Street": "sample string 22",
    "City": "sample string 23",
    "State": "sample string 24",
    "ZipCode": "sample string 25",
    "Country": "sample string 26",
    "InstallationDate": 1,
    "InstallationBy": "sample string 27",
    "MeasurementDate": 1,
    "MeasurementBy": "sample string 28",
    "CutDate": 1,
    "CutBy": "sample string 29",
    "ProductList": [
      {
        "ID": "sample string 1",
        "Type": "sample string 2",
        "Trade": "sample string 6",
        "Desc": "sample string 4",
        "Vendor": "sample string 7",
        "VendorSku": "sample string 3",
        "Color": "sample string 5",
        "Unit": "sample string 9",
        "Manufacturer": "sample string 8",
        "SalesPrice": "sample string 10",
        "CostPrice": "sample string 11",
        "BoxName": "sample string 12",
        "SellByBox": true,
        "BoxSalesPrice": "sample string 14",
        "BoxCostPrice": "sample string 15",
        "UnitsPerBox": "sample string 13",
        "Taxable": true,
        "Width": "sample string 18",
        "Length": "sample string 19",
        "Thickness": "sample string 22",
        "HoriRepeat": "sample string 24",
        "VertRepeat": "sample string 25",
        "HoriDrop": "sample string 26",
        "VertDrop": "sample string 27",
        "EstimatingWidth": "sample string 20",
        "EstimatingLength": "sample string 21",
        "TileCalcMethod": "sample string 28",
        "TileMinimumWaste": "sample string 29",
        "TileShape": "sample string 30",
        "TileEdgeSize": "sample string 31",
        "WasteAddon": "sample string 23",
        "IsAddOn": true,
        "AddOns": [
          {
            "ID": "sample string 1",
            "Method": "sample string 2"
          },
          {
            "ID": "sample string 1",
            "Method": "sample string 2"
          }
        ]
      },
      {
        "ID": "sample string 1",
        "Type": "sample string 2",
        "Trade": "sample string 6",
        "Desc": "sample string 4",
        "Vendor": "sample string 7",
        "VendorSku": "sample string 3",
        "Color": "sample string 5",
        "Unit": "sample string 9",
        "Manufacturer": "sample string 8",
        "SalesPrice": "sample string 10",
        "CostPrice": "sample string 11",
        "BoxName": "sample string 12",
        "SellByBox": true,
        "BoxSalesPrice": "sample string 14",
        "BoxCostPrice": "sample string 15",
        "UnitsPerBox": "sample string 13",
        "Taxable": true,
        "Width": "sample string 18",
        "Length": "sample string 19",
        "Thickness": "sample string 22",
        "HoriRepeat": "sample string 24",
        "VertRepeat": "sample string 25",
        "HoriDrop": "sample string 26",
        "VertDrop": "sample string 27",
        "EstimatingWidth": "sample string 20",
        "EstimatingLength": "sample string 21",
        "TileCalcMethod": "sample string 28",
        "TileMinimumWaste": "sample string 29",
        "TileShape": "sample string 30",
        "TileEdgeSize": "sample string 31",
        "WasteAddon": "sample string 23",
        "IsAddOn": true,
        "AddOns": [
          {
            "ID": "sample string 1",
            "Method": "sample string 2"
          },
          {
            "ID": "sample string 1",
            "Method": "sample string 2"
          }
        ]
      }
    ]
  },
  "IsArchived": true
}

application/xml, text/xml

Sample:
<ProjectDTO>
  <ProjectId>sample string 1</ProjectId>
  <Name>sample string 2</Name>
  <Revision>3</Revision>
  <OwnerM2Id>sample string 4</OwnerM2Id>
  <CreatorM2Id>sample string 5</CreatorM2Id>
  <UsedM2Id>sample string 6</UsedM2Id>
  <LastUpdatedOn>7</LastUpdatedOn>
  <Size>8</Size>
  <ProjectInfo>
    <ProjectId>sample string 1</ProjectId>
    <Name>sample string 2</Name>
    <ApplicationType>sample string 3</ApplicationType>
    <ProjectNote>sample string 4</ProjectNote>
    <ProjectName>sample string 5</ProjectName>
    <ProjectStreet>sample string 6</ProjectStreet>
    <ProjectCity>sample string 7</ProjectCity>
    <ProjectState>sample string 8</ProjectState>
    <ProjectZipCode>sample string 9</ProjectZipCode>
    <ProjectCountry>sample string 10</ProjectCountry>
    <ProjectEmail>sample string 11</ProjectEmail>
    <ProjectPhone>sample string 12</ProjectPhone>
    <ProjectMobile>sample string 13</ProjectMobile>
    <ProjectFax>sample string 14</ProjectFax>
    <ProjectMemo>sample string 15</ProjectMemo>
    <ContactName>sample string 16</ContactName>
    <Email>sample string 17</Email>
    <Phone>sample string 18</Phone>
    <Mobile>sample string 19</Mobile>
    <Fax>sample string 20</Fax>
    <Memo>sample string 21</Memo>
    <Street>sample string 22</Street>
    <City>sample string 23</City>
    <State>sample string 24</State>
    <ZipCode>sample string 25</ZipCode>
    <Country>sample string 26</Country>
    <InstallationDate>1</InstallationDate>
    <InstallationBy>sample string 27</InstallationBy>
    <MeasurementDate>1</MeasurementDate>
    <MeasurementBy>sample string 28</MeasurementBy>
    <CutDate>1</CutDate>
    <CutBy>sample string 29</CutBy>
    <ProductList>
      <ProductDTO>
        <ID>sample string 1</ID>
        <Type>sample string 2</Type>
        <VendorSku>sample string 3</VendorSku>
        <Desc>sample string 4</Desc>
        <Color>sample string 5</Color>
        <Trade>sample string 6</Trade>
        <Vendor>sample string 7</Vendor>
        <Manufacturer>sample string 8</Manufacturer>
        <Unit>sample string 9</Unit>
        <SalesPrice>sample string 10</SalesPrice>
        <CostPrice>sample string 11</CostPrice>
        <BoxName>sample string 12</BoxName>
        <UnitsPerBox>sample string 13</UnitsPerBox>
        <BoxSalesPrice>sample string 14</BoxSalesPrice>
        <BoxCostPrice>sample string 15</BoxCostPrice>
        <SellByBox>true</SellByBox>
        <Taxable>true</Taxable>
        <Width>sample string 18</Width>
        <Length>sample string 19</Length>
        <EstimatingWidth>sample string 20</EstimatingWidth>
        <EstimatingLength>sample string 21</EstimatingLength>
        <Thickness>sample string 22</Thickness>
        <WasteAddon>sample string 23</WasteAddon>
        <HoriRepeat>sample string 24</HoriRepeat>
        <VertRepeat>sample string 25</VertRepeat>
        <HoriDrop>sample string 26</HoriDrop>
        <VertDrop>sample string 27</VertDrop>
        <TileCalcMethod>sample string 28</TileCalcMethod>
        <TileMinimumWaste>sample string 29</TileMinimumWaste>
        <TileShape>sample string 30</TileShape>
        <TileEdgeSize>sample string 31</TileEdgeSize>
        <IsAddOn>true</IsAddOn>
        <AddOns>
          <AddOnProductDTO>
            <ID>sample string 1</ID>
            <Method>sample string 2</Method>
          </AddOnProductDTO>
          <AddOnProductDTO>
            <ID>sample string 1</ID>
            <Method>sample string 2</Method>
          </AddOnProductDTO>
        </AddOns>
      </ProductDTO>
      <ProductDTO>
        <ID>sample string 1</ID>
        <Type>sample string 2</Type>
        <VendorSku>sample string 3</VendorSku>
        <Desc>sample string 4</Desc>
        <Color>sample string 5</Color>
        <Trade>sample string 6</Trade>
        <Vendor>sample string 7</Vendor>
        <Manufacturer>sample string 8</Manufacturer>
        <Unit>sample string 9</Unit>
        <SalesPrice>sample string 10</SalesPrice>
        <CostPrice>sample string 11</CostPrice>
        <BoxName>sample string 12</BoxName>
        <UnitsPerBox>sample string 13</UnitsPerBox>
        <BoxSalesPrice>sample string 14</BoxSalesPrice>
        <BoxCostPrice>sample string 15</BoxCostPrice>
        <SellByBox>true</SellByBox>
        <Taxable>true</Taxable>
        <Width>sample string 18</Width>
        <Length>sample string 19</Length>
        <EstimatingWidth>sample string 20</EstimatingWidth>
        <EstimatingLength>sample string 21</EstimatingLength>
        <Thickness>sample string 22</Thickness>
        <WasteAddon>sample string 23</WasteAddon>
        <HoriRepeat>sample string 24</HoriRepeat>
        <VertRepeat>sample string 25</VertRepeat>
        <HoriDrop>sample string 26</HoriDrop>
        <VertDrop>sample string 27</VertDrop>
        <TileCalcMethod>sample string 28</TileCalcMethod>
        <TileMinimumWaste>sample string 29</TileMinimumWaste>
        <TileShape>sample string 30</TileShape>
        <TileEdgeSize>sample string 31</TileEdgeSize>
        <IsAddOn>true</IsAddOn>
        <AddOns>
          <AddOnProductDTO>
            <ID>sample string 1</ID>
            <Method>sample string 2</Method>
          </AddOnProductDTO>
          <AddOnProductDTO>
            <ID>sample string 1</ID>
            <Method>sample string 2</Method>
          </AddOnProductDTO>
        </AddOns>
      </ProductDTO>
    </ProductList>
    <TilePatternList>
      <TilePatternDTO>
        <ID>sample string 1</ID>
        <IsRandomHardwood>true</IsRandomHardwood>
        <IsHardwood>true</IsHardwood>
        <Grout>sample string 4</Grout>
        <GroutWidth>sample string 5</GroutWidth>
        <Thickness>sample string 6</Thickness>
        <PatternTiles>
          <PatternTileDTO>
            <ID>sample string 1</ID>
            <CountInPattern>2</CountInPattern>
            <Randomizers>
              <TileRandomizerDTO>
                <ID>sample string 1</ID>
                <Percent>sample string 2</Percent>
              </TileRandomizerDTO>
              <TileRandomizerDTO>
                <ID>sample string 1</ID>
                <Percent>sample string 2</Percent>
              </TileRandomizerDTO>
            </Randomizers>
          </PatternTileDTO>
          <PatternTileDTO>
            <ID>sample string 1</ID>
            <CountInPattern>2</CountInPattern>
            <Randomizers>
              <TileRandomizerDTO>
                <ID>sample string 1</ID>
                <Percent>sample string 2</Percent>
              </TileRandomizerDTO>
              <TileRandomizerDTO>
                <ID>sample string 1</ID>
                <Percent>sample string 2</Percent>
              </TileRandomizerDTO>
            </Randomizers>
          </PatternTileDTO>
        </PatternTiles>
      </TilePatternDTO>
      <TilePatternDTO>
        <ID>sample string 1</ID>
        <IsRandomHardwood>true</IsRandomHardwood>
        <IsHardwood>true</IsHardwood>
        <Grout>sample string 4</Grout>
        <GroutWidth>sample string 5</GroutWidth>
        <Thickness>sample string 6</Thickness>
        <PatternTiles>
          <PatternTileDTO>
            <ID>sample string 1</ID>
            <CountInPattern>2</CountInPattern>
            <Randomizers>
              <TileRandomizerDTO>
                <ID>sample string 1</ID>
                <Percent>sample string 2</Percent>
              </TileRandomizerDTO>
              <TileRandomizerDTO>
                <ID>sample string 1</ID>
                <Percent>sample string 2</Percent>
              </TileRandomizerDTO>
            </Randomizers>
          </PatternTileDTO>
          <PatternTileDTO>
            <ID>sample string 1</ID>
            <CountInPattern>2</CountInPattern>
            <Randomizers>
              <TileRandomizerDTO>
                <ID>sample string 1</ID>
                <Percent>sample string 2</Percent>
              </TileRandomizerDTO>
              <TileRandomizerDTO>
                <ID>sample string 1</ID>
                <Percent>sample string 2</Percent>
              </TileRandomizerDTO>
            </Randomizers>
          </PatternTileDTO>
        </PatternTiles>
      </TilePatternDTO>
    </TilePatternList>
  </ProjectInfo>
  <IsArchived>true</IsArchived>
</ProjectDTO>