webapi_swagger_documentation
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
webapi_swagger_documentation [2020/02/10 10:28 (4 years ago)] – kevin | webapi_swagger_documentation [2022/02/23 13:40 (2 years ago)] (current) – kevin | ||
---|---|---|---|
Line 2: | Line 2: | ||
===== Summary ===== | ===== Summary ===== | ||
- | The s5webAPI solution runs as a 32 bit service and provides a doorway to push and pull information from a System Five database. | + | The s5webAPI solution runs as a 32-bit service and provides a doorway to push and pull information from a System Five database. |
- | The following is an explanation for retrieving and using the Swagger 2.0 documentation from all available endpoints of the Windward S5WebAPI. | + | The following is an explanation for retrieving and using the Swagger 2.0 documentation from all available endpoints of the Windward S5WebAPI. |
- | As a developer, keep in mind since this is a 32 bit service, it will not be able to access more than [[https:// | + | As a developer, keep in mind since this is a 32-bit service, it will not be able to access more than [[https:// |
<note important> | <note important> | ||
+ | |||
+ | < | ||
Line 59: | Line 61: | ||
===== Known Limitations ===== | ===== Known Limitations ===== | ||
- | Prior to 6.2.2.175 released versions of the Web API had a maximum limit of 32 concurrent connections. This limit has been removed and is now limited by how much available memory (max 4GB as this is a 32 bit service) running the API. | + | Prior to 6.2.2.175 released versions of the Web API had a maximum limit of 32 concurrent connections. This limit has been removed and is now limited by how much available memory (max 4GB as this is a 32-bit service) running the API. |
- | <note tip> | + | The Swagger 2.0 interface is only supported via HTTP, it is not supported via HTTPS. The other methods described below can be used when HTTPS is the only protocol configured. |
- | Due to the JSON parser that the Windward Web API uses, any ' | + | |
- | </note> | + | ===== Setup and Configuration Details ===== |
+ | |||
+ | Configuring both HTTP and HTTPS is not required, but in order to support HTTPS communication and allow the use of the Swagger interface, both need to be configured. | ||
+ | |||
+ | Azure Hosting - Network Security - Both the HTTP Port 80 and the HTTPS Port 443 need to be opened in order to allow external communication. The use of other Ports can be supported, but it is recommended that the standard HTTP - 80 and/or HTTPS - 443 be used to eliminate confusion. | ||
+ | |||
+ | Azure VM - Firewall Rules - Inbound rules for the same HTTP Port 80 and/or HTTPS port 440 need to be added. | ||
+ | |||
+ | The specific instance of the S5WebAPISvc.exe needs to have UDP and TCP Inbound rules to allow communication. | ||
+ | |||
+ | Azure Environment Variables on the VM - A System Environment Variable named S5INIPATH must exists and contain the path to the SystemFive_SaaS.ini file that is used by System Five SaaS to launch the application. This INI file should already exists and be in use by the installation of SystemFiveSaaS.exe. The API now uses this same INI file to obtain required settings. | ||
===== Retrieving The Documentation ===== | ===== Retrieving The Documentation ===== | ||
Line 70: | Line 82: | ||
* http:// | * http:// | ||
- | The contents of the response from the calls is the Swagger 2.0 documentation, | + | The contents of the response from the calls are the Swagger 2.0 documentation, |
You can also turn on " | You can also turn on " | ||
Line 109: | Line 121: | ||
- In the Swagger 2.0 documentation dialog Right click and choose Paste from your clipboard | - In the Swagger 2.0 documentation dialog Right click and choose Paste from your clipboard | ||
- Click on ' | - Click on ' | ||
- | - The list of available methods | + | - The list of available methods |
{{: | {{: | ||
Line 115: | Line 127: | ||
===== Samples | ===== Samples | ||
+ | <note tip> | ||
* [[webapi: | * [[webapi: | ||
* [[webapi: | * [[webapi: | ||
Line 122: | Line 135: | ||
===== What Version are you using? ===== | ===== What Version are you using? ===== | ||
Depending on the feature you may be looking for in an endpoint you may need to know what version you are running. | Depending on the feature you may be looking for in an endpoint you may need to know what version you are running. | ||
- | It is not uncommon | + | It is common |
* http:// | * http:// | ||
Line 129: | Line 142: | ||
" | " | ||
</ | </ | ||
+ | |||
+ | |||
+ | ===== Release 6.2.4.x History ===== | ||
+ | * Review Further [[https:// | ||
+ | * Version 6.2.4.185 - December 7, 2020 | ||
+ | * [ TFS 41605 / 58429 ] - The Inventory Changes end point has been enhanced to include changes in the stock level, not just the changes inventory records. The End Point will now include the changes made by Purchase Orders and Sales Invoices. | ||
+ | * Version 6.2.4.141 - October 2, 2020 | ||
+ | * [ TFS 40116 ] - Web API: Added Logging information to the Web API Service to help determine the root cause of some runaway processes on the cloud. | ||
+ | * Version 6.2.4.113 - August 14, 2020 | ||
+ | * [ TFS 36512 ] - The / | ||
+ | * Version 6.2.4.80 - July 6, 2020 | ||
+ | * [ TFS 37259 ] - Web API Fix: to Inventory Changes endpoint to ensure proper functionality with pages. | ||
+ | * Version 6.2.4.65 - June 19, 2020 | ||
+ | * [ TFS 31992 / 58075 ] Web API Fix: to include an email in the / | ||
+ | * Version 6.2.4.10 – April 2, 2020 | ||
+ | * [ TFS 33670 / 58200 ] Web API Fix: eCommerceExport=Y filter was not working for / | ||
+ | |||
===== Release 6.2.2.x History ===== | ===== Release 6.2.2.x History ===== | ||
+ | * Review further [[https:// | ||
+ | * Version 6.2.2.636 – March 12, 2020 | ||
+ | * [ TFS 32447 / 58176 ] The Inventory/ End Point methods now accepts a Department Parameter to reduce the volume of data returned by the API by limiting Stock, Price, and Sale Date information to the requested Department. Also matched the contents of the Returned Pricing to the object listed in the Swagger documentation. | ||
+ | * Version 6.2.2.632 – March 12, 2020 | ||
+ | * TFS 32056 / 58157 ] Corrected the Insert of new Inventory by the S5WebAPISvc to deal with situations where the Item, Part and Supplier Part are all different in a data set. This is not a typical configuration and the system was not handling the lookup of the Virtual Warehouse records correctly in this specific configuration. | ||
+ | * Version 6.2.2.631 – March 3, 2020 | ||
+ | * TFS 31638 Updated S5WebAPI Invoice endpoint to accept invoice line comments. | ||
* Version 6.2.2.596 – January 30, 2020 | * Version 6.2.2.596 – January 30, 2020 | ||
* [ TFS 17171 / 57749 ] Fix on / | * [ TFS 17171 / 57749 ] Fix on / | ||
Line 139: | Line 176: | ||
* [BZ 57751 / TFS 19694] Corrected the cause of the crashing by preventing the API from returning all of the invoices when the ZERO parameter is passed. The API now returns nothing in that case. Added 2 new methods to address the need to obtain more than one invoice from the API in a single call. | * [BZ 57751 / TFS 19694] Corrected the cause of the crashing by preventing the API from returning all of the invoices when the ZERO parameter is passed. The API now returns nothing in that case. Added 2 new methods to address the need to obtain more than one invoice from the API in a single call. | ||
* Version 6.2.2.535 – November 20, 2019 | * Version 6.2.2.535 – November 20, 2019 | ||
- | * [57691/TFS 19695] Two new end points | + | * [57691/TFS 19695] Two new endpoints |
* GET [[webapi: | * GET [[webapi: | ||
- | * GET [[webapi: | + | * GET [[webapi: |
* Version 6.2.2.517 – October 29, 2019 | * Version 6.2.2.517 – October 29, 2019 | ||
* [TFS 20705] Fix for S5WebAPISvc that was broken due to new data collector list load. | * [TFS 20705] Fix for S5WebAPISvc that was broken due to new data collector list load. | ||
Line 149: | Line 186: | ||
* [57690] Updated the logging to Log Analytics to better report the start and finish of each API call. | * [57690] Updated the logging to Log Analytics to better report the start and finish of each API call. | ||
* Version 6.2.2.441 – July 15, 2019 | * Version 6.2.2.441 – July 15, 2019 | ||
- | * [57554] Corrected a problem in the \addInvoice method of the S5WebAPISvc' | + | * [57554] Corrected a problem in the \addInvoice method of the S5WebAPISvc' |
* Version 6.2.2.400 – June 10, 2019 | * Version 6.2.2.400 – June 10, 2019 | ||
- | * [57332] Added KitType, Weight, Instock by Dept, SaleStart, SaleEnd, AltSuply, and Barcodes information to the GET / | + | * [57332] Added KitType, Weight, Instock by Dept, SaleStart, SaleEnd, AltSuply, and Barcodes information to the GET / |
- | * [56751] The ability to populate Alt Supply records and Barcode records is now supported in the GET / | + | * [56751] The ability to populate Alt Supply records and Barcode records is now supported in the GET / |
* AltSupply: | * AltSupply: | ||
* Barcodes: This is a structure that must be populated in order to create the desired record and association with the Inventory record. The Swagger documentation contains a complete and detailed model of the required fields and their purposes. | * Barcodes: This is a structure that must be populated in order to create the desired record and association with the Inventory record. The Swagger documentation contains a complete and detailed model of the required fields and their purposes. | ||
* Version 6.2.2.395 – June 4, 2019 | * Version 6.2.2.395 – June 4, 2019 | ||
- | * [57350] The S5WebAPI / | + | * [57350] The S5WebAPI / |
- | * [57267] An e-Commerce filter has been added to the / | + | * [57267] An e-Commerce filter has been added to the / |
* [56767] Virtual Warehouse is now considered by the S5WebAPI and the behavior is consistent with System Five. | * [56767] Virtual Warehouse is now considered by the S5WebAPI and the behavior is consistent with System Five. | ||
* Version 6.2.2.369 – May 7, 2019 | * Version 6.2.2.369 – May 7, 2019 | ||
Line 164: | Line 201: | ||
* [56852] Added support for billing and shipping account lookup by account details with Invoice-AddInvoice endpoint for S5WebAPI. | * [56852] Added support for billing and shipping account lookup by account details with Invoice-AddInvoice endpoint for S5WebAPI. | ||
* Version 6.2.2.269 – February 14, 2019 | * Version 6.2.2.269 – February 14, 2019 | ||
- | * [56999] Added pagination to the Inventory, Virtual Inventory, Customer and A/P Bill end points | + | * [56999] Added pagination to the Inventory, Virtual Inventory, Customer and A/P Bill endpoints |
* Version 6.2.2.214 – November 30, 2018 | * Version 6.2.2.214 – November 30, 2018 | ||
* [56482] Found and solved a problem when the API is passed an invalid Department value. | * [56482] Found and solved a problem when the API is passed an invalid Department value. | ||
Line 170: | Line 207: | ||
* [56750] Removed the duplicate error from the Free Form information in the WebAPI for Polaris Integration. | * [56750] Removed the duplicate error from the Free Form information in the WebAPI for Polaris Integration. | ||
* Version 6.2.2.188 - September 4, 2018 | * Version 6.2.2.188 - September 4, 2018 | ||
- | * [56391] WebAPI: Fixed fields not geting | + | * [56391] WebAPI: Fixed fields not getting |
* [56404] WebAPI: Fixed errors when calling Insert_Invoice_Lines and Delete_Full_Invoice. | * [56404] WebAPI: Fixed errors when calling Insert_Invoice_Lines and Delete_Full_Invoice. | ||
* Version 6.2.2.183 | * Version 6.2.2.183 | ||
Line 181: | Line 218: | ||
* [56349] WebAPI: Fixed Get_Superseding_Parts to properly return an array of superseding parts. | * [56349] WebAPI: Fixed Get_Superseding_Parts to properly return an array of superseding parts. | ||
* Version 6.2.2.180 | * Version 6.2.2.180 | ||
- | * [56191] WebAPI: Added the Swagger-Publishing | + | * [56191] WebAPI: Added the Swagger-Publishing |
* Version 6.2.2.179 | * Version 6.2.2.179 | ||
* [56335] WebAPI: Port System Five WebAPI service (S5WebAPISvc) to Release. | * [56335] WebAPI: Port System Five WebAPI service (S5WebAPISvc) to Release. | ||
Line 188: | Line 225: | ||
* [56242] WebAPI: Added support to the Invoice endpoint for Keywords on Invoice Lines. | * [56242] WebAPI: Added support to the Invoice endpoint for Keywords on Invoice Lines. | ||
* [56268] WebAPI: Added Big Rock Quantity lookup to Part Find. | * [56268] WebAPI: Added Big Rock Quantity lookup to Part Find. | ||
- | * [55003] WebAPI: Solved the problems with the Change_Invoice_Type and Perform_Stock_Adjustment | + | * [55003] WebAPI: Solved the problems with the Change_Invoice_Type and Perform_Stock_Adjustment |
* Version 6.2.2.175 - August 08, 2018 | * Version 6.2.2.175 - August 08, 2018 | ||
* [56297] WebAPI: Get_Part_Prices call would now acknowledge the set Effective Date. | * [56297] WebAPI: Get_Part_Prices call would now acknowledge the set Effective Date. | ||
- | * Prior to 6.2.2.175 the Web API has a maximum limit of 32 concurrent connections. This limit has been removed and is now limited by how much available memory (max 4GB as this is a 32 bit service) running the API. | + | * Prior to 6.2.2.175 the Web API has a maximum limit of 32 concurrent connections. This limit has been removed and is now limited by how much available memory (max 4GB as this is a 32-bit service) running the API. |
* Version 6.2.2.172 - July 24, 2018 | * Version 6.2.2.172 - July 24, 2018 | ||
* [55894] Web API: Fixed the Get_Customer_By_Email POST method. | * [55894] Web API: Fixed the Get_Customer_By_Email POST method. | ||
Line 198: | Line 235: | ||
* [54703] Web API: Fixed the Get_Parts POST method to return the list of linked Free Form Comments. | * [54703] Web API: Fixed the Get_Parts POST method to return the list of linked Free Form Comments. | ||
* Version 6.2.2.163 | * Version 6.2.2.163 | ||
- | * [55777] WebAPI: The Part Image fetch is now constrained to accept a single part unique at a time. This is required to prevent the API running out of memory trying to build a JSON object that contains 500KB of encoded data for the entire inventory file. It simply is not possible to create a JSON document that large. | + | * [55777] WebAPI: The Part Image fetch is now constrained to accept a single part unique at a time. This is required to prevent the API from running out of memory trying to build a JSON object that contains 500KB of encoded data for the entire inventory file. It simply is not possible to create a JSON document that large. |
* Version 6.2.2.161 | * Version 6.2.2.161 | ||
- | * [55898] WebAPI: The Customer, Supplier and Invoice List end points | + | * [55898] WebAPI: The Customer, Supplier, and Invoice List endpoints |
* Version 6.2.2.160 | * Version 6.2.2.160 | ||
* [55895] WebAPI: Fixed the Get_Parts POST method to return the list of linked Lookup Words. | * [55895] WebAPI: Fixed the Get_Parts POST method to return the list of linked Lookup Words. | ||
Line 215: | Line 252: | ||
===== Beta 6.2.7.x History ===== | ===== Beta 6.2.7.x History ===== | ||
There can be functionality available in our beta that will not be present in our released product. | There can be functionality available in our beta that will not be present in our released product. | ||
+ | * Version 6.2.7.696 - December 9, 2020 | ||
+ | * [ TFS 41605 / 58429 ] - The Inventory Changes end point has been enhanced to include changes in the stock level, not just the changes inventory records. The End Point will now include the changes made by Purchase Orders and Sales Invoices. | ||
+ | * Version 6.2.7.615 - August 14, 2020 | ||
+ | * [ TFS 36512 ] - The / | ||
+ | * Version 6.2.7.562 – April 28, 2020 | ||
+ | * [ TFS 34807 ] Fix for / | ||
+ | * Version 6.2.7.530 – March 25, 2020 | ||
+ | * [ TFS 33670 / 58200 ] Web API Fix: eCommerceExport=Y filter was not working for / | ||
+ | * Version 6.2.7.524 – March 17, 2020 | ||
+ | * TFS 31638 Updated S5WebAPI Invoice endpoint to accept invoice line comments. | ||
+ | * Version 6.2.7.517 – March 11, 2020 | ||
+ | * [ TFS 32056 / 58157 ] Corrected the Insert of new Inventory by the S5WebAPISvc to deal with situations where the Item, Part and Supplier Part are all different in a data set. This is not a typical configuration and the system was not handling the lookup of the Virtual Warehouse records correctly in this specific configuration. | ||
+ | * [ TFS 32447 / 58176 ] The Inventory/ End Point methods now accepts a Department Parameter to reduce the volume of data returned by the API by limiting Stock, Price, and Sale Date information to the requested Department. It also matched the contents of the Returned Pricing to the object listed in the Swagger documentation. | ||
* Version 6.2.7.425 – December 2, 2019 | * Version 6.2.7.425 – December 2, 2019 | ||
- | * [TFS 22644 / 57862] Corrected the way Tax Areas are assigned when using the deprecated / | + | * [TFS 22644 / 57862] Corrected the way Tax Areas are assigned when using the deprecated / |
* Version 6.2.7.396 – October 29, 2019 | * Version 6.2.7.396 – October 29, 2019 | ||
* [TFS 20705] Fix for S5WebAPISvc that got broken due to new data collector list load. | * [TFS 20705] Fix for S5WebAPISvc that got broken due to new data collector list load. | ||
Line 222: | Line 272: | ||
* [TFS 19490 / BZ 57767] Added Web Comment support to the / | * [TFS 19490 / BZ 57767] Added Web Comment support to the / | ||
* Version 6.2.7.415 – November 21, 2019 | * Version 6.2.7.415 – November 21, 2019 | ||
- | * [57691/TFS 19695] Two new end points | + | * [57691/TFS 19695] Two new endpoints |
* GET [[webapi: | * GET [[webapi: | ||
- | * GET [[webapi: | + | * GET [[webapi: |
* Version 6.2.7.414 – November 21, 2019 | * Version 6.2.7.414 – November 21, 2019 | ||
* [BZ 57751 / TFS 19694] Corrected the cause of the crashing by preventing the API from returning all of the invoices when the ZERO parameter is passed. The API now returns nothing in that case. Added 2 new methods to address the need to obtain more than one invoice from the API in a single call. | * [BZ 57751 / TFS 19694] Corrected the cause of the crashing by preventing the API from returning all of the invoices when the ZERO parameter is passed. The API now returns nothing in that case. Added 2 new methods to address the need to obtain more than one invoice from the API in a single call. | ||
* Version 6.2.7.396 – October 29, 2019 | * Version 6.2.7.396 – October 29, 2019 | ||
- | * [TFS 20705] Fix for S5WebAPISvc that was broken due to new data collector list load. | + | * [TFS 20705] Fix for S5WebAPISvc that was broken due to a new data collector list load. |
* Version 6.2.7.360 – September 11, 2019 | * Version 6.2.7.360 – September 11, 2019 | ||
* [57680] Corrected a problem that prevented the pagination from working correctly in the Inventory End Point with S5WebAPI service. | * [57680] Corrected a problem that prevented the pagination from working correctly in the Inventory End Point with S5WebAPI service. | ||
Line 234: | Line 284: | ||
* [57690] Updated the logging to Log Analytics to better report the start and finish of each API call. | * [57690] Updated the logging to Log Analytics to better report the start and finish of each API call. | ||
* Version 6.2.7.309 – July 15, 2019 | * Version 6.2.7.309 – July 15, 2019 | ||
- | * [57554] Corrected a problem in the \addInvoice method of the S5WebAPISvc' | + | * [57554] Corrected a problem in the \addInvoice method of the S5WebAPISvc' |
* **Version 6.2.7.297 – July 4, 2019** | * **Version 6.2.7.297 – July 4, 2019** | ||
* [[: | * [[: | ||
* Version 6.2.7.265 – June 6, 2019 | * Version 6.2.7.265 – June 6, 2019 | ||
- | * [57332] Added KitType, Weight, Instock by Dept, SaleStart, SaleEnd, AltSuply, and Barcodes information to the GET / | + | * [57332] Added KitType, Weight, Instock by Dept, SaleStart, SaleEnd, AltSuply, and Barcodes information to the GET / |
- | * [56751] The ability to populate Alt Supply records and Barcode records is now supported in the GET / | + | * [56751] The ability to populate Alt Supply records and Barcode records is now supported in the GET / |
* AltSupply: | * AltSupply: | ||
* Barcodes: This is a structure that must be populated in order to create the desired record and association with the Inventory record. The Swagger documentation contains a complete and detailed model of the required fields and their purposes. | * Barcodes: This is a structure that must be populated in order to create the desired record and association with the Inventory record. The Swagger documentation contains a complete and detailed model of the required fields and their purposes. | ||
* Version 6.2.7.261 – June 4, 2019 | * Version 6.2.7.261 – June 4, 2019 | ||
- | * [57350] The S5WebAPI / | + | * [57350] The S5WebAPI / |
- | * [57267] An e-Commerce filter has been added to the / | + | * [57267] An e-Commerce filter has been added to the / |
* [56767] Virtual Warehouse is now considered by the S5WebAPI and the behavior is consistent with System Five. | * [56767] Virtual Warehouse is now considered by the S5WebAPI and the behavior is consistent with System Five. | ||
* Version 6.2.7.251 – May 28, 2019 | * Version 6.2.7.251 – May 28, 2019 | ||
Line 253: | Line 303: | ||
* [57327] Added " | * [57327] Added " | ||
* Version 6.2.7.157 – February 28, 2019 | * Version 6.2.7.157 – February 28, 2019 | ||
- | * [56999] Added pagination to the Inventory, Virtual Inventory, Customer and A/P Bill end points | + | * [56999] Added pagination to the Inventory, Virtual Inventory, Customer and A/P Bill endpoints |
+ | |||
+ | ===== Common Errors/ | ||
+ | Best practices when troubleshooting errors or issues for escalation with engineering or another technician. | ||
+ | * Check the logs and capture the specific error message text (with an export of the logs or screenshot) | ||
+ | * Capture the complete S5webapi INI file settings | ||
+ | * Any other relevant information such as the operating systems (Are windows updates applied) | ||
+ | |||
+ | |||
+ | ** Getting POS Failure! {" | ||
+ | |||
+ | Reasons : | ||
+ | The JSON that is being used is invalid. | ||
+ | |||
+ | Only 1 InvoiceLines Array is allowed. | ||
+ | The Description must only have 255 characters MAXIMUM! The database will throw away anything longer. | ||
+ | The Invoice Comment must not contain invalid characters. (Carriage Returns and Line Feeds) | ||
+ | |||
+ | Additional information: | ||
+ | You do not need to include the InvoiceCustomer / InvoiceShipTo unique numbers AND the InvoiceShipping / InvoiceBilling | ||
+ | One or the other is all that is required. If you know the Unique Numbers, use them. The system will ignore InvoiceShipping and InvoiceBilling data. | ||
+ | If you don’t, then use the InvoiceShipping and InvoiceBilling. The system will look-up the Account records or create them. | ||
+ | |||
+ | Here is what it should look like: | ||
+ | < | ||
+ | { | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | You can prevent all of these problems by simply checking the JSON payload in a JSON editor like: | ||
+ | https:// | ||
+ | |||
+ | |||
+ | ** Adding Newline Feed on Invoice Comment ** | ||
+ | |||
+ | In /addInvoice method, you can add Invoice Comment. In the parameter, look for this field " | ||
+ | |||
+ | To add a new line feed, add this \\n in the comment. | ||
+ | |||
+ | ** Access Violation when making API call ** | ||
+ | |||
+ | When troubleshooting the s5webAPI if receiving an access violation when making an API call, XML may require re-installation. | ||
+ | |||
+ | |||
+ | **Getting a User Security Error on WordsToo.btr** | ||
+ | |||
+ | If you are presented with a "User # Security Error on WordsToo.btr. User Record has been tampered with" message. | ||
+ | |||
+ | The reason for this error message is due to the user account being locked out or expired and the S5webapi is trying to login using those credentials. | ||
+ | |||
+ | To resolve this issue: | ||
+ | - Go to Setup Wizard > Users and Security > Go to user # (It is the WEB API log in) | ||
+ | - Uncheck the lockout tick box or reset the password | ||
+ | - Ensure the password is the same in the WebAPI.INI configuration | ||
+ | - Restart the S5WebAPI | ||
+ | - Optionally test the S5WebAPI using swagger if configured | ||
+ | |||
+ | |||
+ | **LogAnaylytics: | ||
+ | |||
+ | This happens when the Log Analytics workspace is unreachable. The API service keeps trying to connect to the workspace which causes it to use too much CPU on the client' | ||
+ | |||
+ | As a workaround, we removed the Log Analytics argument from the ini file. | ||
+ | |||
+ | {{: | ||
+ | Once it is removed, CPU usage goes back to normal. | ||
webapi_swagger_documentation.1581359301.txt.gz · Last modified: 2020/02/10 10:28 (4 years ago) by kevin