REL documentation
orders batchfile (http://api.3plcentral.com/rels/orders/batchfile)
Resource:
file attached to an order batch
C# Rel Const:
Rels.OrderSvc.BatchFile
URI template:
batches/{id}/files/{name}
Obtain URI from:
/rels/orders/batchfilesummaries
get contents of a file attached to a batch;
set request accept header to application/*, in which case response content-type header will specify actual type
Success status: 200
Name (* = required) Data Type Description
id * int batch id
name * string file name, with "." encoded as "~d~"
Type Description
ContentType string
Content Object
Sample accept: application/hal+json
{
  "contentType": "str",
  "content": {}
}
replace contents of a file attached to a batch; see BatchFiles POST for setting content-type and content
Success status: 204
Name (* = required) Data Type Description
id * int batch id
name * string file name, with "." encoded as "~d~"
Type Description
ContentType string
Content Object
Sample content-type: application/hal+json
 
{
  "contentType": "str",
  "content": {}
}
delete contents of a file attached to a batch but retains history of who attached and who deleted it
Success status: 204
Name (* = required) Data Type Description
id * int batch id
name * string file name, with "." encoded as "~d~"

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.