Extension Services

See Managing Extensions, for more details.

Extension

Endpoint: http(s)://[hostname]:[port]/[context]/service/[version]/extension/[environment]

Method: POST

Content-Type: application/json or application/xml

Accept: application/json or application/xml

Path Parameters

Parameter	Description
hostname	Cantara worker hostname
port	Cantara worker listening port (only required if non-standard HTTP/s port
context	Cantara worker web application context
version	Cantara worker API version
environment	Cantara access environment. Refer to the Managing Environments topic for more information.(Example - E1DEV)

Execute Extension

Example for executing Extension service

Example Endpoint: https://us.cantara.cloud/cantara/service/50/extension/E1DEV

Example Request

JS

{
	"echoPayload":"TEST",
	"name":"Echo",
	"cantaraVersion":"5.1",
	"tenantId":"",
	"apiKey":""
}

Example Response

JS

{
    "Message": {
        "value": "Transaction Successful",
        "origin": "Worker24@af746ad838d3",
        "type": 0,
        "cantaraSid": ""
    },
    "name": "Echo",
    "cantaraVersion": "5.1",
    "EchoPayload": "TEST"
}

Extension Attachment

Endpoint: http(s)://[hostname]:[port]/[context]/service/[version]/extension/attach/[environment]

Method: POST

Content-Type: application/json or application/xml

Accept: application/json or application/xml

Path Parameters

Parameter	Description
hostname	Cantara worker hostname
port	Cantara worker listening port (only required if non-standard HTTP/s port
context	Cantara worker web application context
version	Cantara worker API version
environment	Cantara access environment. Refer to the Managing Environments topic for more information.(Example - E1DEV)

Execute Extension Attachment

Example for executing Extension Attachment service

Example Endpoint: https://us.cantara.cloud/cantara/service/50/extension/attach/E1DEV