REST Web Services Release Notes
Release notes are displayed in descending order from the most recent release to the oldest. Known Issues are listed with the most recent release.
See TIBCO Scribe® Online Connector For REST Web Services for more information.
Note: To access any changes to metadata support, such as new operations, entities, or fields, reset metadata for the Connection. See Resetting Metadata.
Version 1.4.0
Released April 24, 2025
New And Noteworthy
OAS is upgraded to version 3.0.
Closed Issues
SCREST-246
The Connector is not refreshing the Bearer token. (Case # 01898856)
SCREST-236
Response fields from POST calls are not available in Fetch or Lookup blocks for mapping. (Case # 01886084)
SCREST-235
When interpreting body length as content-length = 0, some parameters are not being passed into the REST call. (Case # 01886733)
SCREST-225
When the authentication response includes an unexpected date format, the connector incorrectly parses the token. (Case # 01880994)
SCREST-221
Custom headers configured in the REST Web Services Connection are not sent to the API causing intermittent 401 errors. (Case #01822857, 01843452, 01879214)
SCREST-220
If an array in a REST response is null, the following error is generated: (Case # 01867855, 01888568)
Object reference not set to an instance of an object.
SCREST-202
Configuring a REST Web Services Connection using a large Swagger specification sometimes causes timeout exception errors or metadata is not complete. (Case # 01817752)
SCREST-197
Using a Swagger specification with a reference named responses causes the connection to fail and generates the following error: (Case # 01795485)
An item with the same key has already been added.
SCREST-178
Summary: Configuring a REST Connection that uses a large Swagger specification and OAuth2 Password Grant authorization sometimes generates an error similar to the following:
Connection test failed. Please contact Scribe Support.
SCREST-142
When attempting to upload a Swagger specification in the Connection dialog, if the endpoint requires authentication values and they are not provided on the Authorization tab an exception is generated.
Known Issues
SCREST-291
Summary: When creating a REST Web Services connection, leaving the Specification field empty generates the following error:
Exception thrown while parsing specification. Exception was:Cannot read properties of null (reading 'hasOwnProperty').
Workaround: Provide the Specification before saving the connection.
SCREST-256
Summary: REST Web Services connection might fail with a fatal error. (Case # 01879214, 01921336)
Workaround: None.
SCREST-253
Summary: The Refresh Token URL is optional for OAuth-based authentication.
Workaround: None.
SCREST-251
Summary: If a record is returned containing a child object with a null value and no defined fields, the Connector cannot parse the record and an error similar to the following is returned: (Case # 01952707)
Object reference not set to an instance of an object.
Workaround: None.
SCREST-250
Summary: When a path parameter is referenced but not specifically defined in a method in a Swagger specification, the parameter displays in the Block Properties Fields tab as a virtual field, but is not passed to the URL used to make the API call and the call fails. (Case #01930209)
Workaround: Edit the Swagger specification to include the path parameter in each method as needed.
SCREST-247
Summary: The REST Connect ClientID header configured in the Connection dialog, is not used correctly in Event apps and generates errors similar to the following. (Case # 01912994)
Operation failed. Label: Patch Patch_financeclosedInvoicesid, Name: Patch_financeclosedInvoicesidPatch, Message: An unexpected error occurred.:Exception executing method: RESTConnector.ExecuteOperation| Status: Unauthorized Unauthorized | Content: { "code": "Unauthorized", "message": "Incorrect or disabled client ID" }| Message: Unauthorized
Workaround: Manually add the clientId in all Send blocks in the app.
SCREST-214
Summary: The REST Web Services Connector fails to connect to Plytix API. (Case #01815241)
Workaround: None.
SCREST-211
Summary: When the Swagger specification does not include a method name, you might encounter missing entities.
Workaround: None.
SCREST-206
Summary: A Valid Authorization header configured in the Connection dialog is overwritten if the Swagger specification for that Connection also contains an Authorization header parameter. (Case # 01822844, 01826672, 01846065, 01858708, 01890371)
Workaround: Remove the Authorization header parameter from the Swagger specification.
SCREST-195
Summary: Inline schema definitions are not supported. (Case #01793141)
Workaround: Modify the Swagger specification to define the schema as a reference and use the reference as a source for GET calls.
SCREST-193
Summary: Numeric values are converted based on the regional settings of the server where the agent is installed. For example, if the value of a numeric field is 15.50 and the regional setting of the server is in the EU, that value is converted to 15,50. (Case # 01782641, 01874453)
Workaround: Update the On-Premise Agent Windows service to run under a user account that matches the locale of the REST service.
SCREST-179 / SCREST 180
Summary: If a call to the REST API is redirected, the REST Web Services Connector redirects without an authentication header and could generate a 401 error. The underlying error might actually be a 300 level error, however 300 level errors are not displayed in the User Interface or the logs.
Workaround: In some cases, calls are redirected because the call either omitted or added a trailing slash. Adding or removing the trailing slash such that it matches the redirect location may resolve the issue.
SCREST-154
Summary: Using the REST Web Services Connector to add protected connection properties causes de-serialization.
Workaround: Add protected connection properties through the user interface.
68829
Summary: When using a Delete Block, if no matching record is found in the target REST datastore, a 404 error is generated, and a record error is included in the Execution History for the Solution.
Workaround: This error can be ignored.
68156
Summary: If you include children in a query and one of the child records has a NULL value, a NULL reference exception is generated.
Workaround: None.
Version 1.3.1
Released June 18, 2019.
New And Noteworthy
Added support for the following:
- OAuth2 authentication types: (SCREST-4, SCREST - 87)
- Authorization Code Grant
- Implicit Grant
- Password Grant
- Device Code Grant
- Custom OAuth authentication type that gives the user options to build custom authentication requests if the API does not follow industry standards. (SCREST-5)
- Ability to reset the access token for the Connection on the Connection dialog by selecting Reset to clear the field and then either Test or OK to get a new token. Applies only to Client Credentials Grant and Password Grant authentication types.(SCREST - 119)
- Customizing the Content-Type Header using the RestContentHeaderMediaType virtual field in the Block Properties Fields tab of a target operation Block. (SCREST-3) See Customizing The Content-Type Header for additional information.
- Refined the errors and error messages returned from the API. (SCREST-2)
Closed Issues
SCREST 9 / 74062 / 74547
When testing a REST Web Services connection, the Connector did not handle a null value in the API specification correctly, which generated Object reference not set to an instance of an object errors. (Case # 68817 / 1728937)
SCREST 10 / 71379 / 71547
When making a connection using Oauth2, invalid request errors were generated because the endpoint required application/x-www-form-urlencoded, but the Connector defaulted to application/json and the grant type was not specified. (Case # 67599 / 1727723)
65825 / 63482
If you included query filters that were strings or numbers, the Connector changed the data type and value based on the content. For example, a string that contained the value 2.1 was converted to a DateTime and sent as 2/1/2018 12:00:00 am.
Version 1.2.1
Released October 19, 2018.
New And Noteworthy
- Added support for objects defined within the body parameter to be available in the Include tab. (63233)
- Operation results are now available for the first level of the hierarchy selected in the target operation Block. For example, if in the CreateWith Block you selected a named Country with a related child entity State and a related grandchild entity City, only the fields for Country are available in the operation results for use in subsequent Blocks. (69903)entity
Closed Issues
64696
If the OAS specification used to define the metadata for your REST Connection contained content headers, errors similar to the one below were generated for PUT and POST operations. (Case # 65173)
Unhandled exception caught in RESTConnector.ExecuteQuery: Misused header name. Make sure request headers are used with HttpRequestMessage, response headers with HttpResponseMessage, and content headers with HttpContent objects.
Version 1.1.1
Released August 23, 2018.
New And Noteworthy
There are no new features in this release.
Closed Issues
65448 / 66041
URI parameters were being included erroneously in the body of POST calls instead of in the URL. (Case # 64869, 66415)
65826
When a query sent to a REST endpoint returned fields that were not defined in the OpenAPI Specification used to configure the Connection, the Connector generated errors similar to the following: (Case # 65434, 65286, 66350)
Message : Did not find property 'propertyName' in type 'Get_/endpoint'.
65927 / 66184
Custom headers configured on the Connection dialog were appended to API key headers instead of replacing them, which generated errors similar to the following: (Case # 65239, 66415
Message: Unhandled exception caught in RESTConnector.ExecuteQuery: Internal Server Error.
Version 1.0.0
Released April 9, 2018.
New And Noteworthy
The Connector for REST Web Services has the following features:
- Supports the OpenAPI Specification (OAS) 2.0.
- Supports the following Authentication types:
- None (56581)
- Basic (56582)
- API Key (56585, 56586)
- OAuth 2.0 Client Credentials Grant (58917)
- Supports hierarchical relationships. (58548)
- Custom Headers can be added on the Connection dialog that are then sent with all HttpRequests made by the Connector. (60210)
Closed Issues
There are no Closed Issues in this release.
