Get a built component operation
curl --request GET \
--url https://api.extole.io/v1/components/{component_id}/operations/{operation_name}/built \
--header 'Authorization: <api-key>'import requests
url = "https://api.extole.io/v1/components/{component_id}/operations/{operation_name}/built"
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}/built', 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}/built",
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}/built"
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))
}HttpResponse<String> response = Unirest.get("https://api.extole.io/v1/components/{component_id}/operations/{operation_name}/built")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/components/{component_id}/operations/{operation_name}/built")
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>",
"method": "DELETE",
"name": "<string>",
"openapi_spec": {},
"parameters": [
{
"description": "<string>",
"name": "<string>",
"required": true,
"type": "PATH",
"value_schema": {
"default_value": "<string>",
"format": "<string>",
"items": "<unknown>",
"type": "ARRAY",
"values": [
"<string>"
]
}
}
],
"path": "<string>",
"priority": "10",
"request_schema": {},
"response_schema": {},
"tags": [
"<string>"
],
"type": "CONSUMER_TO_EXTOLE"
}Components Operations
Get a built component operation
Returns the specified component operation as it appears on the built component.
GET
https://api.extole.io
/
v1
/
components
/
{component_id}
/
operations
/
{operation_name}
/
built
Get a built component operation
curl --request GET \
--url https://api.extole.io/v1/components/{component_id}/operations/{operation_name}/built \
--header 'Authorization: <api-key>'import requests
url = "https://api.extole.io/v1/components/{component_id}/operations/{operation_name}/built"
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}/built', 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}/built",
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}/built"
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))
}HttpResponse<String> response = Unirest.get("https://api.extole.io/v1/components/{component_id}/operations/{operation_name}/built")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/components/{component_id}/operations/{operation_name}/built")
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>",
"method": "DELETE",
"name": "<string>",
"openapi_spec": {},
"parameters": [
{
"description": "<string>",
"name": "<string>",
"required": true,
"type": "PATH",
"value_schema": {
"default_value": "<string>",
"format": "<string>",
"items": "<unknown>",
"type": "ARRAY",
"values": [
"<string>"
]
}
}
],
"path": "<string>",
"priority": "10",
"request_schema": {},
"response_schema": {},
"tags": [
"<string>"
],
"type": "CONSUMER_TO_EXTOLE"
}Authorizations
HEADERQUERYCOOKIE
Response
Successful response
Explanation of what the operation does, already evaluated.
Human-readable label for the operation, already evaluated.
HTTP method of the operation.
Available options:
DELETE, GET, PATCH, POST, PUT Unique name of the operation within its component.
The path, query, header and cookie parameters the operation accepts, each with the values it accepts.
Show child attributes
Show child attributes
Path of the operation, for example /v5/persons/{person_id}. The host is derived from the operation type: api.extole.io for SERVER_TO_EXTOLE, or the default program domain of the client for CONSUMER_TO_EXTOLE.
Example:
"10"
Freeform labels used for grouping, including category such as ACTION or VIEW.
Freeform labels used for grouping, including category such as ACTION or VIEW.
Which Extole API this operation belongs to. Dictates authentication.
Available options:
CONSUMER_TO_EXTOLE, SERVER_TO_EXTOLE Was this page helpful?