Custom API Action

Make an authenticated HTTP request to the NetSuite REST Record API.

Options

Field Definition Type Required

Request Type

These are the supported HTTP request methods 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. Exercise caution to avoid sending multiple POST requests unintentionally. If a request is successful, a 200 (OK) response message is returned.

  • PATCH: Applies partial modifications to a resource on a web server based on parameters. PATCH isn't idempotent. Multiple PATCH requests could have unintended consequences. If a PATCH is successful, a 200 (OK) or 204 (No Content) response message is returned.

  • PUT: Sends data to be stored at a specific location on a web server based on parameters (for example, uploading a file). Unlike POST requests, PUT requests are idempotent. For successful requests, the result of a single PUT request is the same as many identical PUT requests. If a request is successful, a 200 (OK), 201 (Created), or 204 (No Content) response message is returned.

  • DELETE: Deletes the specified resource (if it exists) from the web server based on parameters. If a DELETE is successful, a 200 (OK) response message is returned.

 Dropdown TRUE

Input

Field Definition Type Required

Request

Relative URL

The URL address on the web server that you're contacting.

Specify the relative URL as /{insert_remaining_URL}. For example, for the NetSuite REST Record API endpoint: https://{accountid}.suitetalk.api.netsuite.com/services/rest/record/v1/employee, the relative URL is /employee.

You can specify query parameters either in the relative URL using a ? to start the parameter string, or as an object key and value pair in the Query input.

See NetSuite REST Record API.

Text TRUE

Query

Specify any additional query parameters to include in object format (key and value pairs). For example, {"name":"something-urgent"}

Using query parameters with an empty value results in a 401 error.

For example, if you use {"param": ""} or limit= in the Relative URL field.

 Object FALSE

Headers

Specify any headers required, other than the authorization or content-type headers, as the connector already handles these.

For example: {"Content-type":"application/json"}

 Object FALSE

Body

Specify the request body, in JSON format.

This field is unavailable for the GET request type.

 Object FALSE

Output

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