Frequently Asked Questions

Answers to common questions can be found below.

Q: My search returns empty results. What's wrong?

Check these common causes in order:

1. Wrong TabId. Call GET /api/Tab to verify the correct ID for your item type.

2. Security filtering. If the ‘Apply user security when using the API’ option is enabled in the Application UI, the user may not have access to those items. Try with an admin account to confirm.

3. SearchTerms field names. Column names must match the database exactly (e.g., QUICK_DESCRIPTION, not Description). Use the Dictionary endpoint to get correct column names.

Q: My item creation returned success, but no barcode was generated.

Check the tab's AutoGenerateBarcode setting via GET /api/Tab/{id}. If it's false, you must provide I_BARCODE_STRING in your request. Also, verify the BarcodePrefix and BarcodeLength settings.

Q: My item update created a new item instead of updating.

The most common cause: I_ID was placed in the IRItem.Id property instead of in the columns array. The API only recognizes the ID for updates when it's in the columns array as an IRColumn entry.

Q: I get a "media type not supported" error on every POST.

You're missing the Content-Type: application/json header. This is required on every POST, PUT, and DELETE request that includes a body.

Q: My transfer fails with reason code 5 ("FailedUnknownReason").

Reason code 5 almost always means a security restriction. The user's role doesn't have transfer rights for that item type. Check the user's role permissions in Gimmal Physical, or test with an admin account.

Q: Transfer partially succeeded — what happened to the failed items?

Transfers can partially succeed. Items that transferred are saved; items that failed are not. The overall Result is false if any item failed. Check each entry in the ItemResults array for individual Result and Reason values.

Q: My import job never completes / no email is received.

Verify that:

1. File exists in the correct temp folder ({TempFolder}\Interchange\).

2. Background job service is running on the server.

3. SMTP settings are configured correctly in Gimmal Physical.

4. Windows Event Log on the server for import errors.

5. Spam/junk folder for the notification email.

Q: Can I delete an item that has contents?

No. The API rejects deletion of items that have contents or children. You must move or delete the contents first.

Q: How do I find out what fields are required for creating an item?

Call POST /api/dictionary with SpecialSearch: "quicksearch" and your TabId. The required fields depend on your specific Gimmal Physical configuration — they vary by deployment.

If you do not have a Data Dictionary of your application, please contact support.

Q: Dates in history records seem wrong.

History dates (IH_DATE) are automatically converted to the authenticated user's time zone. If dates look off, verify the user's time zone setting in Gimmal Physical. Dates in search criteria should be sent in UTC (ISO 8601 format).