Welcome to your RESTful Web Service


Data-Centric Service Examples (OData)

When you create a new Harmony Core project we provide a sample repository and data set, and we pre-configure the environment with sample endpoints that provide examples of how those endpoints can be used. The entities in the sample data set are as follows:

Each customer can have zero or more orders, each order has one or more order items, each order item is associated with an item (inventory) and each item is supplied by a vendor.

The links below can be used to explore various capabilities of the sample API. Once you are ready to remove the sample content and add your own, follow the instructions here.


Customer Data

Primary Key Endpoint

Alternate Key Endpoints

OData Queries

$select

constrains returned properties

$filter

constrains returned entities

$orderby

alters entity sequence

$top

determines how many entities are returned

$expand

joins to related entities

Complex Queries

combine $select, $filter, $orderby and $expand

Item Data

Primary Key Endpoint

Alternate Key Endpoints

OData Queries

$select

constrains returned properties

$filter

constrains returned entities

$orderby

alters entity sequence

$top

determines how many entities are returned

$expand

joins to related entities

Complex Queries

combine $select, $filter, $orderby and $expand

Order Data

Primary Key Endpoint

Alternate Key Endpoints

OData Queries

$select

constrains returned properties

$filter

constrains returned entities

$orderby

alters entity sequence

$top

determines how many entities are returned

$expand

joins to related entities

Complex Queries

combine $select, $filter, $orderby and $expand

Order Item Data

Primary Key Endpoint

Alternate Key Endpoints

OData Queries

$select

constrains returned properties

$filter

constrains returned entities

$orderby

alters entity sequence

$top

determines how many entities are returned

$expand

joins to related entities

Complex Queries

combine $select, $filter, $orderby and $expand

Vendor Data

Primary Key Endpoint

Alternate Key Endpoints

OData Queries

$select

constrains returned properties

$filter

constrains returned entities

$orderby

alters entity sequence

$top

determines how many entities are returned

$expand

joins to related entities

Complex Queries

combine $select, $filter, $orderby and $expand

Code-Centric Service Examples (Traditional Bridge)

We also provide a simple pre-configured example of how to use Traditional Bridge to incorporate traditional Synergy subroutines and functions in a Harmony Core service.


Customizing the Services

When you are ready to get started with your own data files and structures, the basic procedure that you will need to follow is: