Custom API Action

Make a custom, authenticated HTTP request to the DataGrail API.

Options

Field	Definition	Type	Required
Request Type	This is one of the supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods). GET: Retrieves data from a web server based on parameters. This method requests a representation of the specified resource. If a request is successful, a 200 (OK) response message is returned with the requested content. POST: Sends data to a web server based on parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST. Caution should be exercised to avoid sending multiple POST requests unintentionally. If a request is successful, a 200 (OK) response message is returned.	Dropdown	TRUE

Field

Definition

Type

Required

Request Type

This is one of the supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods).

GET: Retrieves data from a web server based on parameters. This method requests a representation of the specified resource. If a request is successful, a 200 (OK) response message is returned with the requested content.
POST: Sends data to a web server based on parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST. Caution should be exercised to avoid sending multiple POST requests unintentionally. If a request is successful, a 200 (OK) response message is returned.

TRUE

Field	Definition	Type	Required
Relative URL	The URL address of the web server that you're attempting to call. Specify the relative URL as /{version}/{insert_remaining_URL}. You can specify query parameters in the relative URL using "?", or specify the query parameters as an object key pair in the Query input. For example, for the DataGrail endpoint: https://api.datagrail.io/v1/privacy_requests the relative URL is: /privacy_requests.	Text	TRUE
Query	Specify any additional query parameters that should be included in object format (key value pairs).	Object	FALSE
Headers	Specify any headers required in addition to authorization or content-type, as this connector already handles these.	Object	FALSE
Body	Specify a request body in JSON format. Only available for POST requests.	Object	FALSE

Field	Definition	Type
Response
Status Code	(Undefined variable: workflows_fields.output-status-code)	Number
Headers	Detailed context for the status code, unrelated to the output body. Response headers depend on your selected HTTP request option. Not all headers are response headers. This is similar to {"Content-type":"application/json"}.	Object
Body	Data returned from your selected HTTP request. For example, the data from a GET request.	Object