Creates a custom asset. - Gorelo Documentation

POST

assets

custom

Creates a custom asset.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/assets/custom \
  --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"

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.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  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', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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"

	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("POST", 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.post("https://api.usw.gorelo.io/v1/assets/custom")
  .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")

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

request = Net::HTTP::Post.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>"
    }
  ]
}

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.

Corpo

Custom asset details.

Request body for creating a custom asset. The owning service provider is resolved from the request context, not from the body.

Name

string

Display name of the asset. Required, max 300 characters, cannot be blank.

Exemplo:

"Reception printer"

ClientId

integer<int64>

Identifier of the client the asset belongs to. Required; the client must be active.

Exemplo:

3521

LocationId

integer<int64>

Identifier of the client location the asset sits at. Required; must be an active location of ClientId.

Exemplo:

4410

HardwareTypeId

integer<int64>

Identifier of the asset's hardware type, one of the service provider's active custom asset types. Required.

Exemplo:

118

Description

string | null

Free-text description. Optional, max 1000 characters.

Exemplo:

"HP LaserJet on the front desk"

ContactId

integer<int64> | null

Identifier of the contact the asset is assigned to. Optional; must be an active contact of ClientId.

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. Optional.

Exemplo:

"2027-03-31"

LocalIPAddress

string | null

IPv4 address of the asset, such as 192.168.1.20. Optional. The same name an agent asset publishes.

Exemplo:

"192.168.1.20"

IpAddress

string | null

obsoleto

IPv4 address of the asset. Optional. Deprecated: use LocalIPAddress. Still accepted; sending both with different values is a 400.

Exemplo:

"192.168.1.20"

SerialNumber

string | null

Hardware serial number. Optional, max 250 characters.

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. Optional. Not shown in the Gorelo app.

Exemplo:

"2024-03-31"

Manufacturer

string | null

Manufacturer. Optional, max 300 characters. Not shown in the Gorelo app.

Exemplo:

"Ubiquiti"

Model

string | null

Model. Optional, max 300 characters. Not shown in the Gorelo app.

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 created custom asset.

Show child attributes

DataContext

object | null

Exemplo:

null

Notifications

object[]

Show child attributes

⌘I

Creates a custom asset.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/assets/custom \
  --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"

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.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  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', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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"

	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("POST", 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.post("https://api.usw.gorelo.io/v1/assets/custom")
  .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")

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

request = Net::HTTP::Post.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>"
    }
  ]
}