{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/equipment","auth":"required","settings":"","results":{"codes":[{"name":"","code":"","language":"json","status":201}]},"params":[{"name":"name","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e5a0"},{"name":"brand","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e59f"},{"name":"model","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e59e"},{"name":"serial_number","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e59d"},{"name":"type_id","type":"int","default":"","desc":"Equipment Type id","required":true,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e59c"},{"name":"group_id","type":"int","default":"","desc":"Group id","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e59b"},{"name":"group_hierarchy","type":"string","default":"","desc":"A pipe delimited group hierarchy. Ex: \"Level 1|Level 2|Level 3\". Where Level 1 is the parent of Level 2, and 2 is the parent of 3. Any missing nodes in the hierarchy will be created.","required":false,"in":"body","ref":"","_id":"6064d0169995660069cee23a"},{"name":"status_id","type":"int","default":"","desc":"Equipment Status id","required":true,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e59a"},{"name":"purchase_vendor_id","type":"int","default":"","desc":"Purchase Vendor id","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e599"},{"name":"purchase_price","type":"float","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e598"},{"name":"purchase_date","type":"yyyy-mm-dd","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e597"},{"name":"in_service_date","type":"yyyy-mm-dd","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e596"},{"name":"estimated_service_life","type":"int","default":"","desc":"Service life in months","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e595"},{"name":"estimated_resale_price","type":"float","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e594"},{"name":"out_of_service_date","type":"yyyy-mm-dd","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e593"},{"name":"linked_vehicle_id","type":"int","default":"","desc":"ID of the vehicle this equipment is linked to","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e592"},{"name":"assignee_id","type":"int","default":"","desc":"ID of the contact this equipment is assigned to","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e591"},{"name":"custom_fields","type":"object","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5fdcefa65e04d9007a15e590"}],"examples":{"codes":[]},"method":"post"},"next":{"description":"","pages":[]},"title":"/equipment","type":"endpoint","slug":"equipments-1","excerpt":"","body":"","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5fdcefa65e04d9007a15e58f","createdAt":"2020-12-18T18:06:30.832Z","user":"54cba76f6d1eee0d00c33dee","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Equipment","slug":"equipment","order":41,"from_sync":false,"reference":false,"_id":"5fdcec63772996007b56bcca","createdAt":"2020-12-18T17:52:35.126Z","version":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","__v":0},"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54f8de4e4339bb1900c8bffc","54f8de4e4339bb1900c8bffd","54f8de4e4339bb1900c8bffe","54f8de4e4339bb1900c8bfff","54f8de4e4339bb1900c8c000","54ff6057563d7419002d666e","55007b6ecfeeea17004717dc","5501d779f2ef1e0d003116eb","55116ef89f7c7619005f853b","554bb366f245703100ddd39f","554d226b374fec0d007e64db","555e09f18ab3180d001ac605","555e0b2b4f5e5a0d00836d77","561d1f8b92a0cc350018b24f","562a956c96b5f40d0026eb60","5654c3378a26202b00c17cb8","5697a94b0b09a41900b24546","5739d89e37b52e3200a3a3cc","57ac94252c0b220e00a94570","57ac97a1ad44fc0e003be066","57ac9a3a8f312d0e00e96c75","57ac9c187ae5c60e004ba3a3","58178bee62e4500f009404f6","581a39711a63870f008b621d","581a3b4f0c65b20f00247fcb","5926e0606c729e0f00595f95","5954033ea5bbca002d27ae91","596ce53e0aeafe00157eb1ba","596ce87a8b79f4001a8f6139","598cad2e96193400190d879a","598cbcd3dc20c6000fdfb9c3","598cbd8496193400190d8955","59fcc7c9591add0026c91457","5a020b7856ea82001c8c9342","5a09bc64a91882001c56c2ed","5a71fa2de9aa84007a8bccdb","5b3a768a8a21dd0003ca080d","5c7030f099eeb6003116a106","5c9553a7b6957d005006fc09","5c955c3d04233b0063c9f450","5cfe73f7823bba005de7e1ed","5d07eb760568e70040d6ae21","5deec6550e90370067139979","5ec5a01754009700689296af","5fdccde14e7e670026bf39e4","5fdcec63772996007b56bcca","5fe965032be3ac0020cfb386","5fe9664242f389001c1c67e8"],"_id":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","releaseDate":"2015-03-05T22:53:02.044Z","createdAt":"2015-03-05T22:53:02.044Z","forked_from":"54f8de14c6cabe23005c02a2","__v":44},"project":"54c0e51215af820d001a38a6","__v":3,"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

name:
required
string
brand:
string
model:
string
serial_number:
string
type_id:
required
integer
Equipment Type id
group_id:
integer
Group id
group_hierarchy:
string
A pipe delimited group hierarchy. Ex: "Level 1|Level 2|Level 3". Where Level 1 is the parent of Level 2, and 2 is the parent of 3. Any missing nodes in the hierarchy will be created.
status_id:
required
integer
Equipment Status id
purchase_vendor_id:
integer
Purchase Vendor id
purchase_price:
float
purchase_date:
yyyy-mm-dd
in_service_date:
yyyy-mm-dd
estimated_service_life:
integer
Service life in months
estimated_resale_price:
float
out_of_service_date:
yyyy-mm-dd
linked_vehicle_id:
integer
ID of the vehicle this equipment is linked to
assignee_id:
integer
ID of the contact this equipment is assigned to
custom_fields:
object

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}