pfx-odata2 Component | Pricefx Knowledge Base

Overview

Deprecated since 1.2.0 — Use pfx-rest for new OData integrations.

The pfx-odata2 component provides CRUD operations against OData v2 endpoints with Basic Auth support. It is deprecated — pfx-rest covers the same use cases with more flexibility.

URI pattern: pfx-odata2:method[?options]

Methods

Method	Description
`create`	POST a new entity
`read`	GET entities (list or single)
`update`	PATCH/PUT an existing entity
`delete`	DELETE an entity

Parameters

Parameter	Type	Default	Description
`serviceUrl`	String	—	OData v2 service root URL
`entity`	String	—	Entity set name (e.g. `Products`)
`id`	String	—	Entity key for single-record operations
`username`	String	—	Basic auth username
`password`	String	—	Basic auth password — use `{{property}}`
`connection`	String	—	Connection reference (uses default if omitted)
`unwrapData`	boolean	`true`	Unwrap `d.results` wrapper from response

OData system query options ($filter, $select, $orderby, $top, $skip, $inlinecount) can be passed as URI parameters.

Output headers set by the component:

Header	Description
`PfxOpenData2.id`	ID of the entity returned/created
`PfxOpenData2.$inlinecount`	Total count (when requested)
`PfxOpenData2.nextLink`	Pagination link for next page
`PfxOpenData2.deltaLink`	Delta link for incremental sync

Migration to pfx-rest

Replace pfx-odata2:read with pfx-rest:get + OData query parameters in the URL:

XML

<!-- Old (deprecated) -->
<to uri="pfx-odata2:read?serviceUrl={{sap.url}}&amp;entity=Products&amp;$top=100"/>

<!-- New (pfx-rest) -->
<to uri="pfx-rest:get?url={{sap.url}}/Products?$top=100&amp;username={{sap.user}}&amp;password={{sap.pass}}"/>
<to uri="pfx-json:unmarshal"/>