| External API Connection Information (SOAREST) page | |
Use the External API Connection Information to create and maintain the external API server connection codes and login data.
| Fields | Descriptions |
|---|---|
| Code | External API information code and description. |
| Username | Username used to log in to the API server connection. |
| Password | Password used to log in to the API server connection.
When a record is copied on this page, you need to supply a password. The password is not automatically copied. The field allows for a maximum of 30 characters. Passwords that are larger than 30 characters are truncated. Masking is used, so any truncation is not visible. Data entry is prevented after 30 characters have been entered. The Item Properties information for the field indicates a maximum of 128 characters. However, that number accounts for the password encryption when the record is saved. |
| URL | URL for the API server connection.
The field allows for a maximum of 2,000 characters. URLs that are larger than 2,000 characters are truncated. Masking is not used, so any truncation is visible. The field does not expand to show the entire 2,000 character display, but this can be viewed in the SOBREST table. Enter the following for the URL: serverURL:serverPort/DWPath/api/plans |
| Timeout | Controls timeout until a connection is established or when waiting for data to be retrieved.
When set to 0 or Null, the timeout is not used. In this case there is no limit on SOAREST, so the selected browser's default timeout is used. |