Create equipment
curl --request POST \
--url http://localhost:3000/v2/equipment/ \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"equipmentTypeId": "<string>",
"objectId": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"serialNumber": "<string>",
"inventoryNumber": 123,
"lastMaintenanceDate": "2023-11-07T05:31:56Z",
"purchaseDate": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"chatName": "<string>"
}
'import requests
url = "http://localhost:3000/v2/equipment/"
payload = {
"equipmentTypeId": "<string>",
"objectId": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"serialNumber": "<string>",
"inventoryNumber": 123,
"lastMaintenanceDate": "2023-11-07T05:31:56Z",
"purchaseDate": "2023-11-07T05:31:56Z",
"tags": ["<string>"],
"chatName": "<string>"
}
headers = {
"x-API-Key": "<api-key>",
"Content-Type": "application/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'},
body: JSON.stringify({
equipmentTypeId: '<string>',
objectId: '<string>',
_id: '<string>',
number: 123,
companyId: '<string>',
status: {
status: 123,
createdAt: '2023-11-07T05:31:56Z',
createdBy: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z',
lastModifiedBy: '<string>'
},
chatId: '<string>',
serialNumber: '<string>',
inventoryNumber: 123,
lastMaintenanceDate: '2023-11-07T05:31:56Z',
purchaseDate: '2023-11-07T05:31:56Z',
tags: ['<string>'],
chatName: '<string>'
})
};
fetch('http://localhost:3000/v2/equipment/', 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/v2/equipment/",
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([
'equipmentTypeId' => '<string>',
'objectId' => '<string>',
'_id' => '<string>',
'number' => 123,
'companyId' => '<string>',
'status' => [
'status' => 123,
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'lastModifiedAt' => '2023-11-07T05:31:56Z',
'lastModifiedBy' => '<string>'
],
'chatId' => '<string>',
'serialNumber' => '<string>',
'inventoryNumber' => 123,
'lastMaintenanceDate' => '2023-11-07T05:31:56Z',
'purchaseDate' => '2023-11-07T05:31:56Z',
'tags' => [
'<string>'
],
'chatName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/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 := "http://localhost:3000/v2/equipment/"
payload := strings.NewReader("{\n \"equipmentTypeId\": \"<string>\",\n \"objectId\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"serialNumber\": \"<string>\",\n \"inventoryNumber\": 123,\n \"lastMaintenanceDate\": \"2023-11-07T05:31:56Z\",\n \"purchaseDate\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n \"<string>\"\n ],\n \"chatName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-API-Key", "<api-key>")
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.post("http://localhost:3000/v2/equipment/")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"equipmentTypeId\": \"<string>\",\n \"objectId\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"serialNumber\": \"<string>\",\n \"inventoryNumber\": 123,\n \"lastMaintenanceDate\": \"2023-11-07T05:31:56Z\",\n \"purchaseDate\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n \"<string>\"\n ],\n \"chatName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/equipment/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"equipmentTypeId\": \"<string>\",\n \"objectId\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"serialNumber\": \"<string>\",\n \"inventoryNumber\": 123,\n \"lastMaintenanceDate\": \"2023-11-07T05:31:56Z\",\n \"purchaseDate\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n \"<string>\"\n ],\n \"chatName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"equipmentTypeId": "<string>",
"objectId": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"serialNumber": "<string>",
"inventoryNumber": 123,
"lastMaintenanceDate": "2023-11-07T05:31:56Z",
"purchaseDate": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"chatName": "<string>"
}Equipment
Create Equipment
Create a new equipment item
POST
/
equipment
/
Create equipment
curl --request POST \
--url http://localhost:3000/v2/equipment/ \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"equipmentTypeId": "<string>",
"objectId": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"serialNumber": "<string>",
"inventoryNumber": 123,
"lastMaintenanceDate": "2023-11-07T05:31:56Z",
"purchaseDate": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"chatName": "<string>"
}
'import requests
url = "http://localhost:3000/v2/equipment/"
payload = {
"equipmentTypeId": "<string>",
"objectId": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"serialNumber": "<string>",
"inventoryNumber": 123,
"lastMaintenanceDate": "2023-11-07T05:31:56Z",
"purchaseDate": "2023-11-07T05:31:56Z",
"tags": ["<string>"],
"chatName": "<string>"
}
headers = {
"x-API-Key": "<api-key>",
"Content-Type": "application/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'},
body: JSON.stringify({
equipmentTypeId: '<string>',
objectId: '<string>',
_id: '<string>',
number: 123,
companyId: '<string>',
status: {
status: 123,
createdAt: '2023-11-07T05:31:56Z',
createdBy: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z',
lastModifiedBy: '<string>'
},
chatId: '<string>',
serialNumber: '<string>',
inventoryNumber: 123,
lastMaintenanceDate: '2023-11-07T05:31:56Z',
purchaseDate: '2023-11-07T05:31:56Z',
tags: ['<string>'],
chatName: '<string>'
})
};
fetch('http://localhost:3000/v2/equipment/', 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/v2/equipment/",
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([
'equipmentTypeId' => '<string>',
'objectId' => '<string>',
'_id' => '<string>',
'number' => 123,
'companyId' => '<string>',
'status' => [
'status' => 123,
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '<string>',
'lastModifiedAt' => '2023-11-07T05:31:56Z',
'lastModifiedBy' => '<string>'
],
'chatId' => '<string>',
'serialNumber' => '<string>',
'inventoryNumber' => 123,
'lastMaintenanceDate' => '2023-11-07T05:31:56Z',
'purchaseDate' => '2023-11-07T05:31:56Z',
'tags' => [
'<string>'
],
'chatName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/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 := "http://localhost:3000/v2/equipment/"
payload := strings.NewReader("{\n \"equipmentTypeId\": \"<string>\",\n \"objectId\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"serialNumber\": \"<string>\",\n \"inventoryNumber\": 123,\n \"lastMaintenanceDate\": \"2023-11-07T05:31:56Z\",\n \"purchaseDate\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n \"<string>\"\n ],\n \"chatName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-API-Key", "<api-key>")
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.post("http://localhost:3000/v2/equipment/")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"equipmentTypeId\": \"<string>\",\n \"objectId\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"serialNumber\": \"<string>\",\n \"inventoryNumber\": 123,\n \"lastMaintenanceDate\": \"2023-11-07T05:31:56Z\",\n \"purchaseDate\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n \"<string>\"\n ],\n \"chatName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/equipment/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"equipmentTypeId\": \"<string>\",\n \"objectId\": \"<string>\",\n \"_id\": \"<string>\",\n \"number\": 123,\n \"companyId\": \"<string>\",\n \"status\": {\n \"status\": 123,\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"<string>\",\n \"lastModifiedAt\": \"2023-11-07T05:31:56Z\",\n \"lastModifiedBy\": \"<string>\"\n },\n \"chatId\": \"<string>\",\n \"serialNumber\": \"<string>\",\n \"inventoryNumber\": 123,\n \"lastMaintenanceDate\": \"2023-11-07T05:31:56Z\",\n \"purchaseDate\": \"2023-11-07T05:31:56Z\",\n \"tags\": [\n \"<string>\"\n ],\n \"chatName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"equipmentTypeId": "<string>",
"objectId": "<string>",
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"serialNumber": "<string>",
"inventoryNumber": 123,
"lastMaintenanceDate": "2023-11-07T05:31:56Z",
"purchaseDate": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"chatName": "<string>"
}Authorizations
API-KeyBearer-Auth
Body
application/json
Equipment data
A single item of equipment that belongs to a specific equipment type
The EquipmentType this Equipment belongs to
The Object (location) this equipment is located at
Unique identifier for the equipment
Unique number of the entity, used for identification
The ID of the company this entity belongs to
Entity Status information
Show child attributes
Show child attributes
ID of the chat associated with this entity
The serial number for this equipment
The inventory number for this exact equipment
Last maintenance date
Purchase date
Tags associated with the equipment
The name shown in notifications
Response
Equipment created successfully
A single item of equipment that belongs to a specific equipment type
The EquipmentType this Equipment belongs to
The Object (location) this equipment is located at
Unique identifier for the equipment
Unique number of the entity, used for identification
The ID of the company this entity belongs to
Entity Status information
Show child attributes
Show child attributes
ID of the chat associated with this entity
The serial number for this equipment
The inventory number for this exact equipment
Last maintenance date
Purchase date
Tags associated with the equipment
The name shown in notifications
Was this page helpful?
⌘I