SYNCHRO Link's Administration Server API can be used to open and close project connections, set the API Server settings, set the Web API Server settings, and export the project. SYNCHRO Link processes all API requests with a change list. Pending requests are stored in the change list until they are submitted to Link . On submission Link is processing all the requests. If any of the requests within that submission fails, all the requests fail. If the submission is successful, Link is sending the transaction to SYNCHRO Server. Server will process this transaction but it may be rejected, if there is a conflict. There is no limitation to the number of requests in a submission, nor a limit on the number of submissions. However, there are some practical limits. SYNCHRO Server may be overloaded if a significant number of transactions are sent during a short duration. Also, a large transaction with many changes takes longer to process. A large transaction may slow down SYNCHRO Pro client connection while the transaction is being distributed. When performing data exchanges with large data sets (e.g. updating 1,000,000 user field values), the size of the API submission and number of requests need to be taken into consideration. Consider the two extreme cases: 1 API submission with 1,000,000 requests vs. 1,000,000 API submission with 1 request. In the first case, the large transaction will take longer to process by SYNCHRO Server and in the second case, each transaction is submitted quickly, but the number of transactions is significant and will put a heavy load on the SYNCHRO Server. For this reason, it's recommended to limit the number of requests in an API submission to a maximum of 10,000 - 50,000 requests. For the case of 1,000,000 user field updates, this would be 20-100 transactions, which is reasonable for SYNCHRO Server to process. Developers may choose the delay the rate of submissions for data exchanges (e.g. limit to 10 transactions/minute).
↧