Web API Import Settings


The Web API Import Settings use the standard Import Settings with a few additions:
• Fields/Notes lets you enter a list of Fields Available for Insertion and any Notes
• Fields/Notes lets you Paste sample JSON or XML to extract Fields automatically
• Fields Available for Insertion are listed in Xpath notation
• Web API Imports should be saved with a web-friendly name

This Solution provides details. (6531)






The Web API Import Settings use the standard Import Settings with a few additions:
• Fields/Notes lets you enter a list of Fields Available for Insertion and any Notes
• Fields/Notes lets you Paste sample JSON or XML to extract Fields automatically
• Fields Available for Insertion are listed in Xpath notation
• Web API Imports should be saved with a web-friendly name

To Create a New Web API Import:
1. Click the Web API tool on the Maintenance toolbar
2. Click the Fields/Notes button, paste sample JSON or a field list, and click OK
3. Map the Fields Available to Insertion Order by selecting and clicking Insert
4. Click Save As... to name and save the Import using a web-friendly name

Fields/Notes lets you Paste a sample JSON or XML file to extract Fields Available for Insertion. These are listed in Xpath notation like "/line_items/item/code". You can ignore repeat entries with counters ("/line_items/item[2]/code") unless specifically needed.

When you save your API Import its endpoint uses its web-friendly name. If you name your API Import, "test", it is available at "https://server_address:port/api/import/test". If you Post JSON matching your sample, it will be mapped and imported using the settings saved in "test". And "test" will be listed in the Web API tool if you need to make more changes.



Related:

Alerted (6528)