Get a specific interface
curl --request GET \
--url http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId}",
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: Bearer <token>"
],
]);
$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 := "http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"source": "<string>",
"target": "<string>",
"data": {
"label": "<string>",
"connections": [
{
"id": "<string>",
"type": "Matter",
"direction": "in",
"subType": "Fixed",
"variableId": "<string>",
"propertyIds": [
"<string>"
],
"matterState": "solid",
"name": "<string>",
"colorGroup": "<string>",
"referenceEdgeId": "<string>"
}
],
"notes": "<string>"
},
"modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sourceId": "<string>",
"targetId": "<string>",
"name": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Models/Interfaces
Get a specific interface
Retrieves a specific interface by ID
GET
/
api
/
models
/
{modelId}
/
interfaces
/
{interfaceId}
Get a specific interface
curl --request GET \
--url http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId}",
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: Bearer <token>"
],
]);
$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 := "http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/models/{modelId}/interfaces/{interfaceId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"source": "<string>",
"target": "<string>",
"data": {
"label": "<string>",
"connections": [
{
"id": "<string>",
"type": "Matter",
"direction": "in",
"subType": "Fixed",
"variableId": "<string>",
"propertyIds": [
"<string>"
],
"matterState": "solid",
"name": "<string>",
"colorGroup": "<string>",
"referenceEdgeId": "<string>"
}
],
"notes": "<string>"
},
"modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sourceId": "<string>",
"targetId": "<string>",
"name": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the model
ID of the interface
Response
Interface details
An interface between parts in the model consisting of connections
The id of the edge
The type of the edge
The source node id
The target node id
The data associated with the edge
Show child attributes
Show child attributes
ID of the model this interface belongs to
ID of the source part
ID of the target part
Name of the interface
Description of the interface
Creation timestamp
Last update timestamp