TIBCO Scribe® Online Connector For OData

The TIBCO Scribe® Online Connector for OData (Open Data Protocol) enables you to interact with data via REST interfaces and provides a uniform way to describe the data and the data model.

Connector Specifications

This Connector supports up to and including OData protocol version 4.0.


Agent Types

On Premise X
Cloud X

Replication Services


Integration Services

Source X
Target X

Migration Services

Source X
Target X


Integration X

Note:  This Connector is available from the TIBCO Scribe® Online Marketplace. See Marketplace TIBCO Scribe® Certified Connectors for more information.

This Connector supports OData protocols up to and including version 4.0. Some documented features may not be supported by the protocol of your OData endpoint. For information on the features supported by each OData protocol version, see Odata website.

OData Requirements

If the data source to which you are connecting requires basic authentication, you must provide that authentication when configuring the Connection in TIBCO Scribe® Online. If your OData service does not require authentication, the OData Connector configuration in TIBCO Scribe® Online does not require authentication either. For more information on authentication, contact your OData service administrator.

For more information on the OData protocol, see the OData website.

Selecting An Agent Type For OData

Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.

Connecting To OData

Note: Best practice is to create Connections with credentials that limit permissions in the target system, following the principle of least privilege. Using Administrator level credentials in a Connection provides Administrator level access to the target system for TIBCO Scribe® Online users. Depending on the entities supported, a TIBCO Scribe® Online user could alter user accounts in the target system.

  1. Select More > Connections from the menu.
  2. From the Connections page select Add to open the Add a New Connection dialog.
  3. Select the Connector from the drop-down list in the Connection Type field, and then enter the following information for this Connection:
    • Name — This can be any meaningful name, up to 25 characters.
    • Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
    • OData Service URL — Address of any acceptable URL where the OData service is located.
    • User — Name of the user with rights to access OData, if your OData service requires authentication.
    • Password — Password for User, if your OData service requires authentication.

      For more information on OData, see your endpoint provider.

  4. Select Test to ensure that the Agent can connect to your database. Be sure to test the Connection against all Agents that use this Connection. See Testing Connections.
  5. Select OK to save the Connection.

Metadata Notes

OData Metadata

Only supported OData data types appear in TIBCO Scribe® Online. The following data types are not supported by this Connector:


Connection metadata must have unique entity, relationship, and field names. If your Connection metadata has duplicate names, review the source system to determine if the duplicates can be renamed.

Endpoint Support

Data Types

Supported Blocks

Note: Not all Blocks supported by this Connector are supported by all OData endpoint protocols.

This Connector supports the following Blocks:


A singleton represents a single entity in an entity model.


Note: For this Connector, only one level of relationship, Parent/Child, is supported for the entity selected in the Query or Fetch Block. For records with multiple levels of relationships, such as Parent, Child, Grandchild, only the selected Parent entity and related Child entities can be retrieved. Additional levels beneath Child entities, such as Grandchildren, cannot be accessed for this Connector using the Include tab. See Block Properties Include Tab — Relational Data.

OData Queries

Update Operations

Update Replace

Update Patch And Update Merge



When a datetime is configured on the Query Block on the Block Properties Net Change Tab to query for new and updated records, that configuration is treated as an additional filter. The Net Change datetime filter is applied as an AND after any other filters specified on the Block Properties Filter Tab. TIBCO Scribe® Online builds a query combining both the Net Change filter and the filters on the Filter tab. See Net Change And Filters for an example.

Some Connectors for TIBCO Scribe® Online only support one filter. For those Connectors you can use either Net Change or one filter on the Filter tab, not both.

Note: The Net Change date is ignored when previewing data on the Preview tab. Filters on the Block Properties Filters tab are used to filter the data on the Preview tab.

Batch Processing

Optimistic Concurrency

Conditional Success

When you Insert or Update a record, some services may indicate success but also return error information in the response. When this occurs, refer to your OData service documentation for further information, and review the record for accuracy.

For example, if a record is inserted without providing a required field, an OData service may return a successful status code but the response will have error information stating that the field is required. The OData service has committed the record but it could be inaccurate and possibly unusable. In this case, the TIBCO Scribe® Online Solution execution will yield a record error. However, the corresponding records in the actual application may still need values for the required fields.

TIBCO Scribe® Online API Considerations

You must define a Connection Name and Connection Alias for each OData endpoint.

Connector Name


Connector ID


TIBCO Scribe® Online Connection Properties

In addition, this Connector uses the Connection properties shown in the following table.

Note: Connection property names are case-sensitive.

Name Data Type Required Secured Usage





















More Information

For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.