Get Data from an External Webservice

get

https://{environment}.origamirisk.com/OrigamiApi/api/Webservices/Lookup

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint retrieves data from an External Webservice. All credentials, headers, and configuration associated with the Webservice are applied automatically by Origami; callers do not supply them. The client specifies which Webservice to invoke and provides only the payload defined by that service’s schema. Origami merges the payload with the preconfigured settings and issues the outbound request to the external API.

The Webservice must be preconfigured by the Services team. See this resource for more information.

Query Params

name

string

required

This is the name of the Webservice Lookup as depicted here in the Manage Webservice Lookups page of Origami.

parameterJson

json

required

The parameterJson input is a JSON object string containing the key-value pairs for all inputs required by the remote Webservice.

Origami does not interpret or restructure these fields; it simply forwards them. The external Webservice then parses the object according to its own schema and maps each field to its expected location, which could be a query parameter, path element, XML node, or another structure. The only requirement is that each key matches the parameter name expected by the Webservice.

This JSON object is URL‑encoded and supplied as the parametersJson query parameter:

GET /api/Webservices/Lookup?parametersJson={url-encoded-json}

Example JSON:
{
"webserviceName": "AddressValidation",
"zipCode": "60601"
}

Example (URL‑encoded) cURL request:
curl --location 'https://preprod.origamirisk.com/OrigamiApi/api/Webservices/Lookup?parametersJson=%7B%22webserviceName%22%3A%22AddressValidation%22%2C%22zipCode%22%3A%2260601%22%7D'
--header 'Token: {your-token}'

In short: construct a flat JSON object using the parameter names defined by the Webservice, URL‑encode it, and pass it as parametersJson. Origami handles the rest.

headers

string

authentication configured for the webservice host.

The value must be a JSON string representing a dictionary of header name-value pairs. Example:
{"Content-Type": "application/json","X-Custom-Header": "custom-value","Accept": "application/json"}

See this resource for more information.

Response

200