Get a component operation - Extole Documentation

Get a component operation

curl --request GET \
  --url https://api.extole.io/v1/components/{component_id}/operations/{operation_name} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.extole.io/v1/components/{component_id}/operations/{operation_name}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v1/components/{component_id}/operations/{operation_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v1/components/{component_id}/operations/{operation_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v1/components/{component_id}/operations/{operation_name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v1/components/{component_id}/operations/{operation_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "description": "<string>",
  "display_name": "<string>",
  "name": "<string>",
  "request_schema": {},
  "response_schema": {}
}

GET

/

v1

/

components

/

{component_id}

/

operations

/

{operation_name}

Get a component operation

curl --request GET \
  --url https://api.extole.io/v1/components/{component_id}/operations/{operation_name} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.extole.io/v1/components/{component_id}/operations/{operation_name}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v1/components/{component_id}/operations/{operation_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v1/components/{component_id}/operations/{operation_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v1/components/{component_id}/operations/{operation_name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v1/components/{component_id}/operations/{operation_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "description": "<string>",
  "display_name": "<string>",
  "name": "<string>",
  "request_schema": {},
  "response_schema": {}
}

Authorizations

Authorization

string

header

required

Path Parameters

component_id

string

required

operation_name

string

required

Response

Successful response

Stored component operation definition. Fields display_name, description, request_schema, and response_schema are unevaluated and appear in buildtime-evaluatable form.

description

required

Explanation of what the operation does. Buildtime expressions use CampaignBuildtimeContext.

display_name

required

Human-readable label for the operation, shown in authoring surfaces. Buildtime expressions use CampaignBuildtimeContext.

name

string

required

Unique name of the operation within its component. Lowercase letters, digits, underscores and dashes only.

request_schema

required

The request schema as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use CampaignBuildtimeContext.

response_schema

required

The response schema as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use CampaignBuildtimeContext.

⌘I