General: System Interaction via HTTP (REST API).

You can search, add, modify and delete partners via HTTP.

Each request requires authentication via Basic Authentication (username and password of a Lobster_data user with user right Administrator or Administration via REST). As an alternative to Basic Authentication, the user credentials can be passed in the URL with &user=myuser&passwd=mypassword.

Logs for requests of this kind can be found in the Server Logs under internal / message.log .

Searching Partner

Via the name of a partner its ID is returned.

URL (HTTP GET):

http://<IP or URL of Integration Server>/dw/auth/v1/relationSearch?name=<partner_name>

https://<IP or URL of Integration Server>/dw/auth/v1/relationSearch?name=<partner_name>

Note: See section Adding an HTTPS Listener.

Example Response

The structure of the response is identical for each successful partner operation.

The id is the partner ID.

{
    "response": {
        "status": "ok",
        "id": "1554894544117000"
    }
}

Adding Partner

URL (HTTP POST with JSON):

http://<IP or URL of Integration Server>/dw/auth/v1/relation

https://<IP or URL of Integration Server>/dw/auth/v1/relation

JSON:

{
	"operation": "add",
	"id": 0,
	"name": "My partner",
	"active": true
}

You can either specify 0 for the id or omit the line altogether, since the ID will be generated during this operation.

Parameter name specifies the name of the partner to be created.

Parameter active allows you to set the partner active or inactive.

Updating Partner

URL (HTTP POST with JSON):

http://<IP or URL of Integration Server>/dw/auth/v1/relation

https://<IP or URL of Integration Server>/dw/auth/v1/relation

JSON:

{
    "operation": "update",
    "id": 1616381046459001,
	"name": "My partner updated",
	"active": false
}

Deleting Partner

URL (HTTP POST with JSON):

http://<IP or URL of Integration Server>/dw/auth/v1/relation

https://<IP or URL of Integration Server>/dw/auth/v1/relation

JSON:

{
    "operation": "delete",
    "id": 1616381046459001
}