Method Endpoint

GET

/cxf/bpc-httpproxy/httpProxy/{instanceId}\{targetPath: (/.*)?}

Description

Perform an HTTP GET on the 'httpproxy' backend connection.

Path Parameter

instanceId

the id of the 'httpproxy' backend connections instance to use

targetPath

the path to call on the target system

Query Parameter

targetUrl

optional URL Parameter. Function equals targetPath

forceJson

if set to true, the content will be converted to JSON. Only XML can be converted at the moment.

Deprecated Parameter. This option will be removed with BPC 4.2. Default is false.

Returns

The response of the called backend connection

HTTP Status Code

  • 200 : OK

  • 404 : One of the used services is not available

  • 404 : The backend connections module is not available

  • 404 : The backend connections module instance is not available

  • 500 : General problem with the backend system

  • 503 : Connection to backend system refused

  • 504 : Connection to backend system timed out

Required Access Rights

A logged in user or API Key is required.

/cxf/bpc-httpproxy/httpProxy/{instanceId}\{targetPath: (/.*)?}

Description

Perform an HTTP POST on the 'httpproxy' backend connection.

Path Parameter

instanceId

the id of the 'httpproxy' backend connections instance to use

targetPath

the path to call on the target system

Query Parameter

targetUrl

optional URL Parameter. Function equals targetPath

forceJson

if set to true, the content will be converted to JSON. Only XML can be converted at the moment.

Deprecated Parameter. This option will be removed with BPC 4.2. Default is false.

Returns

The response of the called backend connection

HTTP Status Code

  • 200 : OK

  • 404 : One of the used services is not available

  • 404 : The backend connections module is not available

  • 404 : The backend connections module instance is not available

  • 500 : General problem with the backend system

  • 503 : Connection to backend system refused

  • 504 : Connection to backend system timed out

Required Access Rights

A logged in user or API Key is required.

PUT

/cxf/bpc-httpproxy/httpProxy/{instanceId}\{targetPath: (/.*)?}

Description

Perform an HTTP PUT on the 'httpproxy' backend connection.

Path Parameter

instanceId

the id of the 'httpproxy' backend connections instance to use

targetPath

the path to call on the target system

Query Parameter

targetUrl

optional URL Parameter. Function equals targetPath

forceJson

if set to true, the content will be converted to JSON. Only XML can be converted at the moment.

Deprecated Parameter. This option will be removed with BPC 4.2. Default is false.

Returns

The response of the called backend connection

HTTP Status Code

  • 200 : OK

  • 404 : One of the used services is not available

  • 404 : The backend connections module is not available

  • 404 : The backend connections module instance is not available

  • 500 : General problem with the backend system

  • 503 : Connection to backend system refused

  • 504 : Connection to backend system timed out

Required Access Rights

A logged in user or API Key is required.

/cxf/bpc-httpproxy/httpProxy/{instanceId}\{targetPath: (/.*)?}

Description

Perform an HTTP DELETE on the 'httpproxy' backend connection.

Path Parameter

instanceId

the id of the 'httpproxy' backend connections instance to use

targetPath

the path to call on the target system

Query Parameter

targetUrl

optional URL Parameter. Function equals targetPath

forceJson

if set to true, the content will be converted to JSON. Only XML can be converted at the moment.

Deprecated Parameter. This option will be removed with BPC 4.2. Default is false.

Returns

The response of the called backend connection

HTTP Status Code

  • 200 : OK

  • 404 : One of the used services is not available

  • 404 : The backend connections module is not available

  • 404 : The backend connections module instance is not available

  • 500 : General problem with the backend system

  • 503 : Connection to backend system refused

  • 504 : Connection to backend system timed out

Required Access Rights

A logged in user or API Key is required.