REL documentation
properties transformcustom (http://api.3plcentral.com/rels/properties/transformcustom)
Resource:
transform custom object, either transforms a file into internal models or transforms internal models to a file.
C# Rel Const:
Rels.PropertySvc.TransformCustom
URI template:
transforms/custom/{id}
Obtain URI from:
Success status: 200
Name (* = required) Data Type Description
id * int
Type Description
TransformId int
Description string description for human eyes, not unique
FileType Common.Enum.TransformFileType
- 0: Edi
- 1: Xml
- 2: Other
ModelType Property.Models.TransformModelType
- 0: Order
- 1: Receiver
- 2: PurchaseOrder
- 3: Adjustment
- 4: Item
- 5: StockStatus
IsImport bool
ToFileContent Common.Enum.ToFileContent? ... only applicable if IsImport is false
- -1: Unspecified
- 0: AdvanceShippingNotice
- 1: RoutingRequest
- 2: ReceiptAdvice
- 3: AdjustmentAdvice
- 4: Invoice
- 5: StockStatus
- 6: ItemDescription
- 7: ReceiverConfirmation
- 8: OrderConfirmation
Assembly string
Class string
FileExtension string only applicable if IsImport is false
Links IList<WebApi.Hal.Link>
- edit
Sample accept: application/hal+json
{
  "transformId": 1,
  "description": "str",
  "fileType": 0,
  "modelType": 0,
  "isImport": true,
  "toFileContent": 0,
  "assembly": "str",
  "class": "str",
  "fileExtension": "str"
}
Success status: 200
Name (* = required) Data Type Description
id * int
Type Description
TransformId int
Description string description for human eyes, not unique
FileType Common.Enum.TransformFileType
- 0: Edi
- 1: Xml
- 2: Other
ModelType Property.Models.TransformModelType
- 0: Order
- 1: Receiver
- 2: PurchaseOrder
- 3: Adjustment
- 4: Item
- 5: StockStatus
IsImport bool
ToFileContent Common.Enum.ToFileContent? ... only applicable if IsImport is false
- -1: Unspecified
- 0: AdvanceShippingNotice
- 1: RoutingRequest
- 2: ReceiptAdvice
- 3: AdjustmentAdvice
- 4: Invoice
- 5: StockStatus
- 6: ItemDescription
- 7: ReceiverConfirmation
- 8: OrderConfirmation
Assembly string
Class string
FileExtension string only applicable if IsImport is false
Sample content-type: application/hal+json
 
{
  "transformId": 1,
  "description": "str",
  "fileType": 0,
  "modelType": 0,
  "isImport": true,
  "toFileContent": 0,
  "assembly": "str",
  "class": "str",
  "fileExtension": "str"
}
Type Description
TransformId int
Description string description for human eyes, not unique
FileType Common.Enum.TransformFileType
- 0: Edi
- 1: Xml
- 2: Other
ModelType Property.Models.TransformModelType
- 0: Order
- 1: Receiver
- 2: PurchaseOrder
- 3: Adjustment
- 4: Item
- 5: StockStatus
IsImport bool
ToFileContent Common.Enum.ToFileContent? ... only applicable if IsImport is false
- -1: Unspecified
- 0: AdvanceShippingNotice
- 1: RoutingRequest
- 2: ReceiptAdvice
- 3: AdjustmentAdvice
- 4: Invoice
- 5: StockStatus
- 6: ItemDescription
- 7: ReceiverConfirmation
- 8: OrderConfirmation
Assembly string
Class string
FileExtension string only applicable if IsImport is false
Links IList<WebApi.Hal.Link>
- edit
Sample accept: application/hal+json
{
  "transformId": 1,
  "description": "str",
  "fileType": 0,
  "modelType": 0,
  "isImport": true,
  "toFileContent": 0,
  "assembly": "str",
  "class": "str",
  "fileExtension": "str"
}
Success status: 204
Name (* = required) Data Type Description
id * int

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.