@jpdlm/node-red-contrib-sap-service-layer 0.1.2
Unofficial Module SAP Service Layer for Node-Red
Unofficial SAP Business One Service Layer Nodes for Node-RED.
This module provides a set of nodes for Node-RED to quickly create integration flows with SAP Business One Service Layer.
Installation
You can install the nodes using node-red's "Manage palette" in the side bar.
Or run the following command in the root directory of your Node-RED installation
npm install @jpdlm/node-red-sap-service-layer --save
Changes can be followed here.
Usage
Basics
Authenticate (node authenticateSap)
Use this node to authenticate with a valid SAP service layer API access
The node requires the following:
- host
- company
- user
- password
Additionally the following can also be used if needed:
- port
- url prefix (used for reverse proxies)
Retrieve a list of entities (node listSap)
Use this node to retrieve a list of entities
- Select the type of entity you want to retrieve as a list
- If you want to add filter/options use oData params optional
Query options on entities:
| option | description |
|---|---|
| $filter | Restrict the set of business objects returned. |
| $orderby | Specify the order in which business objects are returned from the service. |
| $select | Restrict the service to return only the properties requested by the client. |
| $skip | Specify that the result excludes the first n entities. |
| $top | Specify that only the first n records should be returned. |
Get single entity (node getSap)
Use this node to get a single entity by providing the primary key
- Select the type of entity you want to retrieve
- Use objectId as primary key of entity
- Use oData to filter the response fields optional\
Query options on single entity:
| option | description |
|---|---|
| $select | Restrict the service to return only the properties requested by the client. |
Create a new entity (node createSap)
Use this node to create a new entity.
- Select the type of entity you want to create
- Use msg.bodyPost to provide the entity's fields
- Use msg.createParams to provide object params
Update an object
Use this node to update an object.
- Select the type of object you want to update
- Use objectId as primary key of object
- Use msg.updateParams to provide object params
Delete an Object
Use this node to delete an object.
- Select the type of object you want to delete
- Use objectId as primary key of object
Count the number of objects per type
Use this node to count the number of objects per type.
- Select the type of object you want to count
