DELETE api/external/v1/Workorder?Purge={Purge}

Request Information

URI Parameters

Name	Description	Type	Additional information
Purge		boolean	Default value is False

Body Parameters

Collection of SFE.Common.PublicEntities.WorkorderVM

Name	Type	Additional information
Id	integer	None.
GUID	string	None.
Created	date	None.
Modified	date	None.
UserName	string	None.
ClosedBy	string	None.
Comments	string	None.
AlphaNumId	string	None.
ProductAlphaNumId	string	None.
ProductLinkId	string	None.
ProductId	integer	None.
ProductName	string	None.
ProductKind	SFE.Common.Enumerations.ProductKind	None.
ProductSMV	decimal number	None.
ProductUnitOfMeasure	SFE.Common.Enumerations.UnitOfMeasure	None.
ProductConversionUOM	decimal number	None.
WorkOrderStatus	SFE.Common.Enumerations.WorkOrderStatus	None.
Active	boolean	None.
ProductProductCategoryAlphaNumId	string	None.
ProductProductCategoryName	string	None.
Quantity	integer	None.
QuantityUOM	decimal number	None.
UnitDefaultQuantity	integer	None.
SalesOrder	string	None.
Serialnumber	string	None.
ExternalWorkorder	string	None.
BatchId	string	None.
Tags	Collection of SFE.Common.PublicEntities.TagVM	None.
DepartmentId	integer	None.
DepartmentGUID	string	None.
DepartmentAlphaNumId	string	None.
Custom1	string	None.
Custom2	string	None.
Custom3	string	None.
Custom4	string	None.
NotesHeader	string	None.
Notes	string	None.
TabletEditableNotes	string	None.
PlannedStart	date	None.
PlannedEnd	date	None.
TeamId	integer	None.
TeamAlphaNumId	string	None.
TeamName	string	None.
HideInPlanning	boolean	None.
Closed	date	None.
Consolidate	boolean	None.
CustomerAlphaNumId	string	None.
CustomerName	string	None.
CustomerId	integer	None.
AuditAlphaNumId	string	None.
AuditName	string	None.
AuditId	integer	None.
UnitOfQuantityKey	string	None.
QuantityMultiplier	integer	None.
TotalUnits	integer	None.
IsPrinted	boolean	None.
PrintFactor	decimal number	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "guid": "sample string 1",
    "created": "2024-11-15T03:46:53.3467475Z",
    "modified": "2024-11-15T03:46:53.3467475Z",
    "userName": "sample string 3",
    "closedBy": "sample string 4",
    "comments": "sample string 5",
    "alphaNumId": "sample string 6",
    "productAlphaNumId": "sample string 7",
    "productLinkId": "sample string 8",
    "productId": 1,
    "productName": "sample string 9",
    "productKind": 0,
    "productSMV": 10.0,
    "productUnitOfMeasure": 0,
    "productConversionUOM": 1.0,
    "workOrderStatus": 0,
    "active": true,
    "productProductCategoryAlphaNumId": "sample string 11",
    "productProductCategoryName": "sample string 12",
    "quantity": 13,
    "quantityUOM": 1.0,
    "unitDefaultQuantity": 1,
    "salesOrder": "sample string 14",
    "serialnumber": "sample string 15",
    "externalWorkorder": "sample string 16",
    "batchId": "sample string 17",
    "tags": [
      {
        "id": 1,
        "alphaNumId": "sample string 1",
        "name": "sample string 2",
        "tagKindId": 3,
        "tagKindName": "sample string 4"
      },
      {
        "id": 1,
        "alphaNumId": "sample string 1",
        "name": "sample string 2",
        "tagKindId": 3,
        "tagKindName": "sample string 4"
      }
    ],
    "departmentId": 18,
    "departmentGUID": "sample string 19",
    "departmentAlphaNumId": "sample string 20",
    "custom1": "sample string 21",
    "custom2": "sample string 22",
    "custom3": "sample string 23",
    "custom4": "sample string 24",
    "notesHeader": "sample string 25",
    "notes": "sample string 26",
    "tabletEditableNotes": "sample string 27",
    "plannedStart": "2024-11-15T03:46:53.3467475Z",
    "plannedEnd": "2024-11-15T03:46:53.3467475Z",
    "teamId": 28,
    "teamAlphaNumId": "sample string 29",
    "teamName": "sample string 30",
    "hideInPlanning": true,
    "closed": "2024-11-15T03:46:53.3467475Z",
    "consolidate": true,
    "customerAlphaNumId": "sample string 32",
    "customerName": "sample string 33",
    "customerId": 34,
    "auditAlphaNumId": "sample string 35",
    "auditName": "sample string 36",
    "auditId": 37,
    "unitOfQuantityKey": "sample string 38",
    "quantityMultiplier": 1,
    "totalUnits": 1,
    "isPrinted": true,
    "printFactor": 1.0
  },
  {
    "id": 1,
    "guid": "sample string 1",
    "created": "2024-11-15T03:46:53.3467475Z",
    "modified": "2024-11-15T03:46:53.3467475Z",
    "userName": "sample string 3",
    "closedBy": "sample string 4",
    "comments": "sample string 5",
    "alphaNumId": "sample string 6",
    "productAlphaNumId": "sample string 7",
    "productLinkId": "sample string 8",
    "productId": 1,
    "productName": "sample string 9",
    "productKind": 0,
    "productSMV": 10.0,
    "productUnitOfMeasure": 0,
    "productConversionUOM": 1.0,
    "workOrderStatus": 0,
    "active": true,
    "productProductCategoryAlphaNumId": "sample string 11",
    "productProductCategoryName": "sample string 12",
    "quantity": 13,
    "quantityUOM": 1.0,
    "unitDefaultQuantity": 1,
    "salesOrder": "sample string 14",
    "serialnumber": "sample string 15",
    "externalWorkorder": "sample string 16",
    "batchId": "sample string 17",
    "tags": [
      {
        "id": 1,
        "alphaNumId": "sample string 1",
        "name": "sample string 2",
        "tagKindId": 3,
        "tagKindName": "sample string 4"
      },
      {
        "id": 1,
        "alphaNumId": "sample string 1",
        "name": "sample string 2",
        "tagKindId": 3,
        "tagKindName": "sample string 4"
      }
    ],
    "departmentId": 18,
    "departmentGUID": "sample string 19",
    "departmentAlphaNumId": "sample string 20",
    "custom1": "sample string 21",
    "custom2": "sample string 22",
    "custom3": "sample string 23",
    "custom4": "sample string 24",
    "notesHeader": "sample string 25",
    "notes": "sample string 26",
    "tabletEditableNotes": "sample string 27",
    "plannedStart": "2024-11-15T03:46:53.3467475Z",
    "plannedEnd": "2024-11-15T03:46:53.3467475Z",
    "teamId": 28,
    "teamAlphaNumId": "sample string 29",
    "teamName": "sample string 30",
    "hideInPlanning": true,
    "closed": "2024-11-15T03:46:53.3467475Z",
    "consolidate": true,
    "customerAlphaNumId": "sample string 32",
    "customerName": "sample string 33",
    "customerId": 34,
    "auditAlphaNumId": "sample string 35",
    "auditName": "sample string 36",
    "auditId": 37,
    "unitOfQuantityKey": "sample string 38",
    "quantityMultiplier": 1,
    "totalUnits": 1,
    "isPrinted": true,
    "printFactor": 1.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfWorkorderVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFE.Common.PublicEntities">
  <WorkorderVM>
    <Active>true</Active>
    <AlphaNumId>sample string 6</AlphaNumId>
    <AuditAlphaNumId>sample string 35</AuditAlphaNumId>
    <AuditId>37</AuditId>
    <AuditName>sample string 36</AuditName>
    <BatchId>sample string 17</BatchId>
    <Closed>2024-11-14T23:46:53.3467475-04:00</Closed>
    <ClosedBy>sample string 4</ClosedBy>
    <Comments>sample string 5</Comments>
    <Consolidate>true</Consolidate>
    <Created>2024-11-14T23:46:53.3467475-04:00</Created>
    <Custom1>sample string 21</Custom1>
    <Custom2>sample string 22</Custom2>
    <Custom3>sample string 23</Custom3>
    <Custom4>sample string 24</Custom4>
    <CustomerAlphaNumId>sample string 32</CustomerAlphaNumId>
    <CustomerId>34</CustomerId>
    <CustomerName>sample string 33</CustomerName>
    <DepartmentAlphaNumId>sample string 20</DepartmentAlphaNumId>
    <DepartmentGUID>sample string 19</DepartmentGUID>
    <DepartmentId>18</DepartmentId>
    <ExternalWorkorder>sample string 16</ExternalWorkorder>
    <GUID>sample string 1</GUID>
    <HideInPlanning>true</HideInPlanning>
    <Id>1</Id>
    <IsPrinted>true</IsPrinted>
    <Modified>2024-11-14T23:46:53.3467475-04:00</Modified>
    <Notes>sample string 26</Notes>
    <NotesHeader>sample string 25</NotesHeader>
    <PlannedEnd>2024-11-14T23:46:53.3467475-04:00</PlannedEnd>
    <PlannedStart>2024-11-14T23:46:53.3467475-04:00</PlannedStart>
    <PrintFactor>1</PrintFactor>
    <ProductAlphaNumId>sample string 7</ProductAlphaNumId>
    <ProductConversionUOM>1</ProductConversionUOM>
    <ProductId>1</ProductId>
    <ProductKind>Default</ProductKind>
    <ProductLinkId>sample string 8</ProductLinkId>
    <ProductName>sample string 9</ProductName>
    <ProductProductCategoryAlphaNumId>sample string 11</ProductProductCategoryAlphaNumId>
    <ProductProductCategoryName>sample string 12</ProductProductCategoryName>
    <ProductSMV>10</ProductSMV>
    <ProductUnitOfMeasure>PCS</ProductUnitOfMeasure>
    <Quantity>13</Quantity>
    <QuantityMultiplier>1</QuantityMultiplier>
    <QuantityUOM>1</QuantityUOM>
    <SalesOrder>sample string 14</SalesOrder>
    <Serialnumber>sample string 15</Serialnumber>
    <TabletEditableNotes>sample string 27</TabletEditableNotes>
    <Tags>
      <TagVM>
        <AlphaNumId>sample string 1</AlphaNumId>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <TagKindId>3</TagKindId>
        <TagKindName>sample string 4</TagKindName>
      </TagVM>
      <TagVM>
        <AlphaNumId>sample string 1</AlphaNumId>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <TagKindId>3</TagKindId>
        <TagKindName>sample string 4</TagKindName>
      </TagVM>
    </Tags>
    <TeamAlphaNumId>sample string 29</TeamAlphaNumId>
    <TeamId>28</TeamId>
    <TeamName>sample string 30</TeamName>
    <TotalUnits>1</TotalUnits>
    <UnitDefaultQuantity>1</UnitDefaultQuantity>
    <UnitOfQuantityKey>sample string 38</UnitOfQuantityKey>
    <UserName>sample string 3</UserName>
    <WorkOrderStatus>Released</WorkOrderStatus>
  </WorkorderVM>
  <WorkorderVM>
    <Active>true</Active>
    <AlphaNumId>sample string 6</AlphaNumId>
    <AuditAlphaNumId>sample string 35</AuditAlphaNumId>
    <AuditId>37</AuditId>
    <AuditName>sample string 36</AuditName>
    <BatchId>sample string 17</BatchId>
    <Closed>2024-11-14T23:46:53.3467475-04:00</Closed>
    <ClosedBy>sample string 4</ClosedBy>
    <Comments>sample string 5</Comments>
    <Consolidate>true</Consolidate>
    <Created>2024-11-14T23:46:53.3467475-04:00</Created>
    <Custom1>sample string 21</Custom1>
    <Custom2>sample string 22</Custom2>
    <Custom3>sample string 23</Custom3>
    <Custom4>sample string 24</Custom4>
    <CustomerAlphaNumId>sample string 32</CustomerAlphaNumId>
    <CustomerId>34</CustomerId>
    <CustomerName>sample string 33</CustomerName>
    <DepartmentAlphaNumId>sample string 20</DepartmentAlphaNumId>
    <DepartmentGUID>sample string 19</DepartmentGUID>
    <DepartmentId>18</DepartmentId>
    <ExternalWorkorder>sample string 16</ExternalWorkorder>
    <GUID>sample string 1</GUID>
    <HideInPlanning>true</HideInPlanning>
    <Id>1</Id>
    <IsPrinted>true</IsPrinted>
    <Modified>2024-11-14T23:46:53.3467475-04:00</Modified>
    <Notes>sample string 26</Notes>
    <NotesHeader>sample string 25</NotesHeader>
    <PlannedEnd>2024-11-14T23:46:53.3467475-04:00</PlannedEnd>
    <PlannedStart>2024-11-14T23:46:53.3467475-04:00</PlannedStart>
    <PrintFactor>1</PrintFactor>
    <ProductAlphaNumId>sample string 7</ProductAlphaNumId>
    <ProductConversionUOM>1</ProductConversionUOM>
    <ProductId>1</ProductId>
    <ProductKind>Default</ProductKind>
    <ProductLinkId>sample string 8</ProductLinkId>
    <ProductName>sample string 9</ProductName>
    <ProductProductCategoryAlphaNumId>sample string 11</ProductProductCategoryAlphaNumId>
    <ProductProductCategoryName>sample string 12</ProductProductCategoryName>
    <ProductSMV>10</ProductSMV>
    <ProductUnitOfMeasure>PCS</ProductUnitOfMeasure>
    <Quantity>13</Quantity>
    <QuantityMultiplier>1</QuantityMultiplier>
    <QuantityUOM>1</QuantityUOM>
    <SalesOrder>sample string 14</SalesOrder>
    <Serialnumber>sample string 15</Serialnumber>
    <TabletEditableNotes>sample string 27</TabletEditableNotes>
    <Tags>
      <TagVM>
        <AlphaNumId>sample string 1</AlphaNumId>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <TagKindId>3</TagKindId>
        <TagKindName>sample string 4</TagKindName>
      </TagVM>
      <TagVM>
        <AlphaNumId>sample string 1</AlphaNumId>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <TagKindId>3</TagKindId>
        <TagKindName>sample string 4</TagKindName>
      </TagVM>
    </Tags>
    <TeamAlphaNumId>sample string 29</TeamAlphaNumId>
    <TeamId>28</TeamId>
    <TeamName>sample string 30</TeamName>
    <TotalUnits>1</TotalUnits>
    <UnitDefaultQuantity>1</UnitDefaultQuantity>
    <UnitOfQuantityKey>sample string 38</UnitOfQuantityKey>
    <UserName>sample string 3</UserName>
    <WorkOrderStatus>Released</WorkOrderStatus>
  </WorkorderVM>
</ArrayOfWorkorderVM>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SFE.Common.PublicEntities.WorkorderVM

Name	Type	Additional information
Id	integer	None.
GUID	string	None.
Created	date	None.
Modified	date	None.
UserName	string	None.
ClosedBy	string	None.
Comments	string	None.
AlphaNumId	string	None.
ProductAlphaNumId	string	None.
ProductLinkId	string	None.
ProductId	integer	None.
ProductName	string	None.
ProductKind	SFE.Common.Enumerations.ProductKind	None.
ProductSMV	decimal number	None.
ProductUnitOfMeasure	SFE.Common.Enumerations.UnitOfMeasure	None.
ProductConversionUOM	decimal number	None.
WorkOrderStatus	SFE.Common.Enumerations.WorkOrderStatus	None.
Active	boolean	None.
ProductProductCategoryAlphaNumId	string	None.
ProductProductCategoryName	string	None.
Quantity	integer	None.
QuantityUOM	decimal number	None.
UnitDefaultQuantity	integer	None.
SalesOrder	string	None.
Serialnumber	string	None.
ExternalWorkorder	string	None.
BatchId	string	None.
Tags	Collection of SFE.Common.PublicEntities.TagVM	None.
DepartmentId	integer	None.
DepartmentGUID	string	None.
DepartmentAlphaNumId	string	None.
Custom1	string	None.
Custom2	string	None.
Custom3	string	None.
Custom4	string	None.
NotesHeader	string	None.
Notes	string	None.
TabletEditableNotes	string	None.
PlannedStart	date	None.
PlannedEnd	date	None.
TeamId	integer	None.
TeamAlphaNumId	string	None.
TeamName	string	None.
HideInPlanning	boolean	None.
Closed	date	None.
Consolidate	boolean	None.
CustomerAlphaNumId	string	None.
CustomerName	string	None.
CustomerId	integer	None.
AuditAlphaNumId	string	None.
AuditName	string	None.
AuditId	integer	None.
UnitOfQuantityKey	string	None.
QuantityMultiplier	integer	None.
TotalUnits	integer	None.
IsPrinted	boolean	None.
PrintFactor	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "guid": "sample string 1",
  "created": "2024-11-15T03:46:53.3467475Z",
  "modified": "2024-11-15T03:46:53.3467475Z",
  "userName": "sample string 3",
  "closedBy": "sample string 4",
  "comments": "sample string 5",
  "alphaNumId": "sample string 6",
  "productAlphaNumId": "sample string 7",
  "productLinkId": "sample string 8",
  "productId": 1,
  "productName": "sample string 9",
  "productKind": 0,
  "productSMV": 10.0,
  "productUnitOfMeasure": 0,
  "productConversionUOM": 1.0,
  "workOrderStatus": 0,
  "active": true,
  "productProductCategoryAlphaNumId": "sample string 11",
  "productProductCategoryName": "sample string 12",
  "quantity": 13,
  "quantityUOM": 1.0,
  "unitDefaultQuantity": 1,
  "salesOrder": "sample string 14",
  "serialnumber": "sample string 15",
  "externalWorkorder": "sample string 16",
  "batchId": "sample string 17",
  "tags": [
    {
      "id": 1,
      "alphaNumId": "sample string 1",
      "name": "sample string 2",
      "tagKindId": 3,
      "tagKindName": "sample string 4"
    },
    {
      "id": 1,
      "alphaNumId": "sample string 1",
      "name": "sample string 2",
      "tagKindId": 3,
      "tagKindName": "sample string 4"
    }
  ],
  "departmentId": 18,
  "departmentGUID": "sample string 19",
  "departmentAlphaNumId": "sample string 20",
  "custom1": "sample string 21",
  "custom2": "sample string 22",
  "custom3": "sample string 23",
  "custom4": "sample string 24",
  "notesHeader": "sample string 25",
  "notes": "sample string 26",
  "tabletEditableNotes": "sample string 27",
  "plannedStart": "2024-11-15T03:46:53.3467475Z",
  "plannedEnd": "2024-11-15T03:46:53.3467475Z",
  "teamId": 28,
  "teamAlphaNumId": "sample string 29",
  "teamName": "sample string 30",
  "hideInPlanning": true,
  "closed": "2024-11-15T03:46:53.3467475Z",
  "consolidate": true,
  "customerAlphaNumId": "sample string 32",
  "customerName": "sample string 33",
  "customerId": 34,
  "auditAlphaNumId": "sample string 35",
  "auditName": "sample string 36",
  "auditId": 37,
  "unitOfQuantityKey": "sample string 38",
  "quantityMultiplier": 1,
  "totalUnits": 1,
  "isPrinted": true,
  "printFactor": 1.0
}

application/xml, text/xml

Sample:

<WorkorderVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFE.Common.PublicEntities">
  <Active>true</Active>
  <AlphaNumId>sample string 6</AlphaNumId>
  <AuditAlphaNumId>sample string 35</AuditAlphaNumId>
  <AuditId>37</AuditId>
  <AuditName>sample string 36</AuditName>
  <BatchId>sample string 17</BatchId>
  <Closed>2024-11-14T23:46:53.3467475-04:00</Closed>
  <ClosedBy>sample string 4</ClosedBy>
  <Comments>sample string 5</Comments>
  <Consolidate>true</Consolidate>
  <Created>2024-11-14T23:46:53.3467475-04:00</Created>
  <Custom1>sample string 21</Custom1>
  <Custom2>sample string 22</Custom2>
  <Custom3>sample string 23</Custom3>
  <Custom4>sample string 24</Custom4>
  <CustomerAlphaNumId>sample string 32</CustomerAlphaNumId>
  <CustomerId>34</CustomerId>
  <CustomerName>sample string 33</CustomerName>
  <DepartmentAlphaNumId>sample string 20</DepartmentAlphaNumId>
  <DepartmentGUID>sample string 19</DepartmentGUID>
  <DepartmentId>18</DepartmentId>
  <ExternalWorkorder>sample string 16</ExternalWorkorder>
  <GUID>sample string 1</GUID>
  <HideInPlanning>true</HideInPlanning>
  <Id>1</Id>
  <IsPrinted>true</IsPrinted>
  <Modified>2024-11-14T23:46:53.3467475-04:00</Modified>
  <Notes>sample string 26</Notes>
  <NotesHeader>sample string 25</NotesHeader>
  <PlannedEnd>2024-11-14T23:46:53.3467475-04:00</PlannedEnd>
  <PlannedStart>2024-11-14T23:46:53.3467475-04:00</PlannedStart>
  <PrintFactor>1</PrintFactor>
  <ProductAlphaNumId>sample string 7</ProductAlphaNumId>
  <ProductConversionUOM>1</ProductConversionUOM>
  <ProductId>1</ProductId>
  <ProductKind>Default</ProductKind>
  <ProductLinkId>sample string 8</ProductLinkId>
  <ProductName>sample string 9</ProductName>
  <ProductProductCategoryAlphaNumId>sample string 11</ProductProductCategoryAlphaNumId>
  <ProductProductCategoryName>sample string 12</ProductProductCategoryName>
  <ProductSMV>10</ProductSMV>
  <ProductUnitOfMeasure>PCS</ProductUnitOfMeasure>
  <Quantity>13</Quantity>
  <QuantityMultiplier>1</QuantityMultiplier>
  <QuantityUOM>1</QuantityUOM>
  <SalesOrder>sample string 14</SalesOrder>
  <Serialnumber>sample string 15</Serialnumber>
  <TabletEditableNotes>sample string 27</TabletEditableNotes>
  <Tags>
    <TagVM>
      <AlphaNumId>sample string 1</AlphaNumId>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <TagKindId>3</TagKindId>
      <TagKindName>sample string 4</TagKindName>
    </TagVM>
    <TagVM>
      <AlphaNumId>sample string 1</AlphaNumId>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <TagKindId>3</TagKindId>
      <TagKindName>sample string 4</TagKindName>
    </TagVM>
  </Tags>
  <TeamAlphaNumId>sample string 29</TeamAlphaNumId>
  <TeamId>28</TeamId>
  <TeamName>sample string 30</TeamName>
  <TotalUnits>1</TotalUnits>
  <UnitDefaultQuantity>1</UnitDefaultQuantity>
  <UnitOfQuantityKey>sample string 38</UnitOfQuantityKey>
  <UserName>sample string 3</UserName>
  <WorkOrderStatus>Released</WorkOrderStatus>
</WorkorderVM>