Assets

Updates a custom asset. Send only the fields you want to change.

An omitted field is left alone, and re-sending a value the asset already holds is a no-op rather than an error. Sending nothing at all is a 400.

Description, ContactId, WarrantyEndDate, WarrantyStartDate, Manufacturer, Model, IpAddress and SerialNumber are cleared by sending them as null. WarrantyStartDate, Manufacturer and Model are kept for API callers only: the Gorelo app does not show them, and changing only those records nothing on the asset’s timeline. Name, LocationId and HardwareTypeId cannot be cleared; null leaves them unchanged.

A new ClientId moves the asset to that client. The asset’s location and contact must belong to the new client, so send a LocationId of the new client, and a ContactId of it or null, unless the ones the asset holds already belong to it.

The primary contact is also listed under the asset’s related items: assigning a contact adds it there, and replacing or clearing it removes the previous one.

PATCH

assets

custom

{customAssetId}

Updates a custom asset. Send only the fields you want to change.

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/assets/custom/{customAssetId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Name": "Reception printer",
  "ClientId": 3521,
  "LocationId": 4410,
  "HardwareTypeId": 118,
  "Description": "HP LaserJet on the front desk",
  "ContactId": 7962,
  "WarrantyEndDate": "2027-03-31",
  "LocalIPAddress": "192.168.1.20",
  "IpAddress": "192.168.1.20",
  "SerialNumber": "CNB1K23456",
  "WarrantyStartDate": "2024-03-31",
  "Manufacturer": "Ubiquiti",
  "Model": "UniFi Dream Machine Pro"
}
'

import requests

url = "https://api.usw.gorelo.io/v1/assets/custom/{customAssetId}"

payload = {
    "Name": "Reception printer",
    "ClientId": 3521,
    "LocationId": 4410,
    "HardwareTypeId": 118,
    "Description": "HP LaserJet on the front desk",
    "ContactId": 7962,
    "WarrantyEndDate": "2027-03-31",
    "LocalIPAddress": "192.168.1.20",
    "IpAddress": "192.168.1.20",
    "SerialNumber": "CNB1K23456",
    "WarrantyStartDate": "2024-03-31",
    "Manufacturer": "Ubiquiti",
    "Model": "UniFi Dream Machine Pro"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Name: 'Reception printer',
    ClientId: 3521,
    LocationId: 4410,
    HardwareTypeId: 118,
    Description: 'HP LaserJet on the front desk',
    ContactId: 7962,
    WarrantyEndDate: '2027-03-31',
    LocalIPAddress: '192.168.1.20',
    IpAddress: '192.168.1.20',
    SerialNumber: 'CNB1K23456',
    WarrantyStartDate: '2024-03-31',
    Manufacturer: 'Ubiquiti',
    Model: 'UniFi Dream Machine Pro'
  })
};

fetch('https://api.usw.gorelo.io/v1/assets/custom/{customAssetId}', 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.usw.gorelo.io/v1/assets/custom/{customAssetId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'Name' => 'Reception printer',
    'ClientId' => 3521,
    'LocationId' => 4410,
    'HardwareTypeId' => 118,
    'Description' => 'HP LaserJet on the front desk',
    'ContactId' => 7962,
    'WarrantyEndDate' => '2027-03-31',
    'LocalIPAddress' => '192.168.1.20',
    'IpAddress' => '192.168.1.20',
    'SerialNumber' => 'CNB1K23456',
    'WarrantyStartDate' => '2024-03-31',
    'Manufacturer' => 'Ubiquiti',
    'Model' => 'UniFi Dream Machine Pro'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/assets/custom/{customAssetId}"

	payload := strings.NewReader("{\n  \"Name\": \"Reception printer\",\n  \"ClientId\": 3521,\n  \"LocationId\": 4410,\n  \"HardwareTypeId\": 118,\n  \"Description\": \"HP LaserJet on the front desk\",\n  \"ContactId\": 7962,\n  \"WarrantyEndDate\": \"2027-03-31\",\n  \"LocalIPAddress\": \"192.168.1.20\",\n  \"IpAddress\": \"192.168.1.20\",\n  \"SerialNumber\": \"CNB1K23456\",\n  \"WarrantyStartDate\": \"2024-03-31\",\n  \"Manufacturer\": \"Ubiquiti\",\n  \"Model\": \"UniFi Dream Machine Pro\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.usw.gorelo.io/v1/assets/custom/{customAssetId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Name\": \"Reception printer\",\n  \"ClientId\": 3521,\n  \"LocationId\": 4410,\n  \"HardwareTypeId\": 118,\n  \"Description\": \"HP LaserJet on the front desk\",\n  \"ContactId\": 7962,\n  \"WarrantyEndDate\": \"2027-03-31\",\n  \"LocalIPAddress\": \"192.168.1.20\",\n  \"IpAddress\": \"192.168.1.20\",\n  \"SerialNumber\": \"CNB1K23456\",\n  \"WarrantyStartDate\": \"2024-03-31\",\n  \"Manufacturer\": \"Ubiquiti\",\n  \"Model\": \"UniFi Dream Machine Pro\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/assets/custom/{customAssetId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"Name\": \"Reception printer\",\n  \"ClientId\": 3521,\n  \"LocationId\": 4410,\n  \"HardwareTypeId\": 118,\n  \"Description\": \"HP LaserJet on the front desk\",\n  \"ContactId\": 7962,\n  \"WarrantyEndDate\": \"2027-03-31\",\n  \"LocalIPAddress\": \"192.168.1.20\",\n  \"IpAddress\": \"192.168.1.20\",\n  \"SerialNumber\": \"CNB1K23456\",\n  \"WarrantyStartDate\": \"2024-03-31\",\n  \"Manufacturer\": \"Ubiquiti\",\n  \"Model\": \"UniFi Dream Machine Pro\"\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

Autorizações

X-API-Key

string

header

obrigatório

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Parâmetros de caminho

customAssetId

string<uuid>

obrigatório

Custom asset to update.

Corpo

Fields to change.

Request body for updating a custom asset. Every field is optional - send only what should change. An omitted field keeps the value the asset already holds.

Name

string | null

Display name of the asset. Max 300 characters, cannot be blank. Null leaves it unchanged.

Exemplo:

"Reception printer"

ClientId

integer<int64> | null

Identifier of the client the asset belongs to; must be an active client. A different client moves the asset, and its location and contact must then belong to the new client. Null leaves it unchanged.

Exemplo:

3521

LocationId

integer<int64> | null

Identifier of the client location the asset sits at; must be an active location of the asset's client. Null leaves it unchanged.

Exemplo:

4410

HardwareTypeId

integer<int64> | null

Identifier of the asset's hardware type, one of the service provider's active custom asset types. Null leaves it unchanged.

Exemplo:

118

Description

string | null

Free-text description, max 1000 characters. Send null to clear it.

Exemplo:

"HP LaserJet on the front desk"

ContactId

integer<int64> | null

Identifier of the contact the asset is assigned to; must be an active contact of the asset's client. Send null to unassign it.

Exemplo:

7962

WarrantyEndDate

string<date> | null

Date the warranty ends, a calendar date in the form yyyy-MM-dd. A value with a time or a time zone is rejected. Send null to clear it.

Exemplo:

"2027-03-31"

LocalIPAddress

string | null

IPv4 address of the asset, such as 192.168.1.20. Send null to clear it. The same name an agent asset publishes.

Exemplo:

"192.168.1.20"

IpAddress

string | null

obsoleto

IPv4 address of the asset. Send null to clear it. Deprecated: use LocalIPAddress. Still accepted; sending both with different values is a 400.

Exemplo:

"192.168.1.20"

SerialNumber

string | null

Hardware serial number, max 250 characters. Send null to clear it.

Exemplo:

"CNB1K23456"

WarrantyStartDate

string<date> | null

Date the warranty starts, a calendar date in the form yyyy-MM-dd. A value with a time or a time zone is rejected. Send null to clear it.

Exemplo:

"2024-03-31"

Manufacturer

string | null

Manufacturer, max 300 characters. Send null to clear it.

Exemplo:

"Ubiquiti"

Model

string | null

Model, max 300 characters. Send null to clear it.

Exemplo:

"UniFi Dream Machine Pro"

Resposta

StatusCode

enum<integer>

Opções disponíveis:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object

The identifier of the updated custom asset.

Show child attributes

DataContext

object | null

Exemplo:

null

Notifications

object[]

Show child attributes

⌘I

Updates a custom asset. Send only the fields you want to change.

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/assets/custom/{customAssetId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Name": "Reception printer",
  "ClientId": 3521,
  "LocationId": 4410,
  "HardwareTypeId": 118,
  "Description": "HP LaserJet on the front desk",
  "ContactId": 7962,
  "WarrantyEndDate": "2027-03-31",
  "LocalIPAddress": "192.168.1.20",
  "IpAddress": "192.168.1.20",
  "SerialNumber": "CNB1K23456",
  "WarrantyStartDate": "2024-03-31",
  "Manufacturer": "Ubiquiti",
  "Model": "UniFi Dream Machine Pro"
}
'

import requests

url = "https://api.usw.gorelo.io/v1/assets/custom/{customAssetId}"

payload = {
    "Name": "Reception printer",
    "ClientId": 3521,
    "LocationId": 4410,
    "HardwareTypeId": 118,
    "Description": "HP LaserJet on the front desk",
    "ContactId": 7962,
    "WarrantyEndDate": "2027-03-31",
    "LocalIPAddress": "192.168.1.20",
    "IpAddress": "192.168.1.20",
    "SerialNumber": "CNB1K23456",
    "WarrantyStartDate": "2024-03-31",
    "Manufacturer": "Ubiquiti",
    "Model": "UniFi Dream Machine Pro"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Name: 'Reception printer',
    ClientId: 3521,
    LocationId: 4410,
    HardwareTypeId: 118,
    Description: 'HP LaserJet on the front desk',
    ContactId: 7962,
    WarrantyEndDate: '2027-03-31',
    LocalIPAddress: '192.168.1.20',
    IpAddress: '192.168.1.20',
    SerialNumber: 'CNB1K23456',
    WarrantyStartDate: '2024-03-31',
    Manufacturer: 'Ubiquiti',
    Model: 'UniFi Dream Machine Pro'
  })
};

fetch('https://api.usw.gorelo.io/v1/assets/custom/{customAssetId}', 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.usw.gorelo.io/v1/assets/custom/{customAssetId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'Name' => 'Reception printer',
    'ClientId' => 3521,
    'LocationId' => 4410,
    'HardwareTypeId' => 118,
    'Description' => 'HP LaserJet on the front desk',
    'ContactId' => 7962,
    'WarrantyEndDate' => '2027-03-31',
    'LocalIPAddress' => '192.168.1.20',
    'IpAddress' => '192.168.1.20',
    'SerialNumber' => 'CNB1K23456',
    'WarrantyStartDate' => '2024-03-31',
    'Manufacturer' => 'Ubiquiti',
    'Model' => 'UniFi Dream Machine Pro'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/assets/custom/{customAssetId}"

	payload := strings.NewReader("{\n  \"Name\": \"Reception printer\",\n  \"ClientId\": 3521,\n  \"LocationId\": 4410,\n  \"HardwareTypeId\": 118,\n  \"Description\": \"HP LaserJet on the front desk\",\n  \"ContactId\": 7962,\n  \"WarrantyEndDate\": \"2027-03-31\",\n  \"LocalIPAddress\": \"192.168.1.20\",\n  \"IpAddress\": \"192.168.1.20\",\n  \"SerialNumber\": \"CNB1K23456\",\n  \"WarrantyStartDate\": \"2024-03-31\",\n  \"Manufacturer\": \"Ubiquiti\",\n  \"Model\": \"UniFi Dream Machine Pro\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.usw.gorelo.io/v1/assets/custom/{customAssetId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Name\": \"Reception printer\",\n  \"ClientId\": 3521,\n  \"LocationId\": 4410,\n  \"HardwareTypeId\": 118,\n  \"Description\": \"HP LaserJet on the front desk\",\n  \"ContactId\": 7962,\n  \"WarrantyEndDate\": \"2027-03-31\",\n  \"LocalIPAddress\": \"192.168.1.20\",\n  \"IpAddress\": \"192.168.1.20\",\n  \"SerialNumber\": \"CNB1K23456\",\n  \"WarrantyStartDate\": \"2024-03-31\",\n  \"Manufacturer\": \"Ubiquiti\",\n  \"Model\": \"UniFi Dream Machine Pro\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/assets/custom/{customAssetId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"Name\": \"Reception printer\",\n  \"ClientId\": 3521,\n  \"LocationId\": 4410,\n  \"HardwareTypeId\": 118,\n  \"Description\": \"HP LaserJet on the front desk\",\n  \"ContactId\": 7962,\n  \"WarrantyEndDate\": \"2027-03-31\",\n  \"LocalIPAddress\": \"192.168.1.20\",\n  \"IpAddress\": \"192.168.1.20\",\n  \"SerialNumber\": \"CNB1K23456\",\n  \"WarrantyStartDate\": \"2024-03-31\",\n  \"Manufacturer\": \"Ubiquiti\",\n  \"Model\": \"UniFi Dream Machine Pro\"\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}