Update a port

Update a port

curl --request PUT \
  --url http://localhost:3000/api/models/{modelId}/ports/{portId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "partId": "<string>",
  "constraints": [
    "<string>"
  ]
}
'

import requests

url = "http://localhost:3000/api/models/{modelId}/ports/{portId}"

payload = {
    "label": "<string>",
    "partId": "<string>",
    "constraints": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: '<string>', partId: '<string>', constraints: ['<string>']})
};

fetch('http://localhost:3000/api/models/{modelId}/ports/{portId}', 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}/ports/{portId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => '<string>',
    'partId' => '<string>',
    'constraints' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost:3000/api/models/{modelId}/ports/{portId}"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"partId\": \"<string>\",\n  \"constraints\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("http://localhost:3000/api/models/{modelId}/ports/{portId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"partId\": \"<string>\",\n  \"constraints\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/models/{modelId}/ports/{portId}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"partId\": \"<string>\",\n  \"constraints\": [\n    \"<string>\"\n  ]\n}"

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

{
  "label": "<string>",
  "constraints": [
    "<string>"
  ],
  "notes": "<string>"
}

PUT

api

models

{modelId}

ports

{portId}

Update a port

curl --request PUT \
  --url http://localhost:3000/api/models/{modelId}/ports/{portId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "partId": "<string>",
  "constraints": [
    "<string>"
  ]
}
'

import requests

url = "http://localhost:3000/api/models/{modelId}/ports/{portId}"

payload = {
    "label": "<string>",
    "partId": "<string>",
    "constraints": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: '<string>', partId: '<string>', constraints: ['<string>']})
};

fetch('http://localhost:3000/api/models/{modelId}/ports/{portId}', 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}/ports/{portId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => '<string>',
    'partId' => '<string>',
    'constraints' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost:3000/api/models/{modelId}/ports/{portId}"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"partId\": \"<string>\",\n  \"constraints\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("http://localhost:3000/api/models/{modelId}/ports/{portId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"partId\": \"<string>\",\n  \"constraints\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/models/{modelId}/ports/{portId}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"partId\": \"<string>\",\n  \"constraints\": [\n    \"<string>\"\n  ]\n}"

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

{
  "label": "<string>",
  "constraints": [
    "<string>"
  ],
  "notes": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

modelId

string<uuid>

required

ID of the model

portId

string

required

ID of the port

Body

application/json

label

string

The label of the port

partId

string

The ID of the part this port belongs to

constraints

string[]

The constraints on the port

Response

Port updated successfully

A port belonging to a part in the model

label

string

required

The label of the part

constraints

string[]

required

The constraints on the port

notes

string

Additional notes about the port

Get Started

Feature Guides

API Reference

Authorizations

Path Parameters

Body

Response