REL documentation
inventory assemblyfileimportasync (http://api.3plcentral.com/rels/inventory/assemblyfileimportasync)
Resource:
Async: assemblyfileimport
C# Rel Const:
Rels.InventorySvc.AssemblyFileImportAsync
URI template:
assemblies/fileimporter/async{?customerId,facilityId,transformId,skipInvalidAssemblies}
Obtain URI from:
Billboard
Create assemblies from contents of import file asynchronously
Use content-type: text/plain, with the request body being the contents of the file.
Success status: 202
Name (* = required) Data Type Description
customerId * int
facilityId * int
transformId int
skipInvalidAssemblies bool
this object model should not be used directly by the API client, but is assembled by the media formatter from the request's content-type and payload
Type Description
ContentType string obtained from the HTTP "Content-Type" header
Content Object obtained from the HTTP payload
Sample content-type: application/hal+json
 
{
  "contentType": "str",
  "content": {}
}
Type Description
AssemblyCreationsAttempted int? ...
AssembliesToCreate int? ...
AssemblyImportFileCreateResults Inventory.Models.AssemblyImportFileCreateResults Links to each newly created assembly
FaultedAssemblies Generic.Models.Exceptions.ListException container of WmsExceptionBase-derived exceptions occuring during actions on lists, such as import or mass ops
Message string
Faults IList<Generic.Models.Exceptions.ListEntryFault>
EntryNumber int 1-indexed position in the source list
EntryInfo string optional info about the entry in the source list, such as id, sku, ref#, etc.
WmsException Generic.Models.Exceptions.WmsExceptionBase for more details at runtime see which WmsExceptionBase-derived exception it is
ErrorCode string could have been a number, but is a short string for human readability; not to be localized
Hint string helpful word or two if the thrower happens to know more things; not to be localized
Message string
InnerException System.Exception
AssemblyIdentifiers IEnumerable<Generic.Models.AssemblyIdentifier>
Id int
Links IList<WebApi.Hal.Link>
- /rels/inventory/assembly newly created assemblies
Links IList<WebApi.Hal.Link>
- /rels/inventory/assemblyfileimportasyncstatus may be polled until the operation is complete or fails
Sample accept: application/hal+json
{
  "assemblyCreationsAttempted": 1,
  "assembliesToCreate": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/inventory/assemblyfileimport": {
      "faultedAssemblies": {
        "message": "ListException: Faults [{EntryNumber 1, }]",
        "faults": [
          {
            "entryNumber": 1,
            "entryInfo": "str"
          }
        ],
        "data": {},
        "helpLink": "str",
        "source": "str",
        "hResult": 3
      },
      "assemblyIdentifiers": [
        {
          "id": 1
        }
      ]
    }
  }
}

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.