How to create or delete an equipment?

Last changed in 26/12/2024

Create Equipment

This method allows to create an equipment in a simplified manner.

The method to be used when creating an equipment:

POST url/api/mytenant/myorganization/assetmanagementcore/equipmentItems

Json example for creating an equipment:

 {

"equipmentKey": "AVS",
"equipmentKeySegments": null,
"description": "Sistema Avac",
"onServiceDate": "2021-07-01T00:00:00",
"externalReferenceID": "13LNN458",
"serial": "xt789",
"picture": "https://valuekeepdev.blob.core.windows.net/sampledb-images/EquipmentItems_a02336c8-7ff2-4d30-bfe2-b22906f3c161_Picture_image.jpeg",
"pictureThumbnail": "https://valuekeepdev.blob.core.windows.net/sampledb-images/EquipmentItems_a02336c8-7ff2-4d30-bfe2-b22906f3c161_Picture_Thumbnail_image.jpeg",
"purchaseDate": "2021-07-12T00:00:00",
"purchasePrice":
{
    "amount": 2580.000000,
    "baseAmount": 2580.000000,
    "reportingAmount": 2580.000000,
    "fractionDigits": 2,
    "symbol": "€"
 },
"remarks": null,
"keyword": "Sistema Avac",
"barcode": null,
"isTool": false,
"workingTime": "23:59:59",
"manufacturer": null,
"location": "TEC",
"criticality": "00000001",
"currency": "EUR",
"owner": "0004",
"brand": "FF",
"brandModel": "FF100",
"parentEquipment": "PC01",
"family": "CAM",
"company": "DEMO",
"responsible": null,
"provider": "0003",
"customer": "0015",
 "warrantyStartDate": "2022-02-16",
 "warrantyEndDate": "2022-02-17",
 "warrantyExtensionEndDate": "2022-02-18"
}

This method allows to create an equipment according to the parameters filled in:

EquipmentKey: The equipment key.. If this parameter is not passed, it assumes the defined sequential number.
Description: Short description of the equipment. This field is mandatory.
OnServiceDate: Date the equipment entered the service. If this field is not filled in, the current date is assumed.
ExternalReferenceID: External reference code.
Serial: Serial number.
Picture: The equipment image.
PurchaseDate: Purchase date.
PurchasePrice: Purchase price.
Remarks: Equipment remarks.
Keyword: Short description of the equipment.
Barcode: The equipment tag.
IsTool: Place False to create the equipment.
WorkingTime: Work time.
Manufacturer: Manufacturer key.
Location: The equipment location's key. This field is mandatory, when the parent equipment is not filled in.
Criticality: The criticality's key.
Currency: The currency's key.
Owner: The owner's key.
Brand: The brand's key.
BrandModel: The model's key.
ParentEquipment: The parent equipment key. This field is mandatory, when the location field is not filled in.
Family: The family's key.
Company: The company's key.
Responsible: The key of the person in charge.
Supplier: The supplier's key.
Customer: The customer's key.
WarrantyStartDate: The warranty start date.
WarrantyEndDate: The warranty end date.
WarrantyExtensionEndDate: The warranty extension end date.

When this method is executed successfully, it returns HttpStatusCode.201 Created.

Delete Equipment

This method allows you to delete an equipment.

The method to be used when deleting an equipment is:

DELETE url/api/mytenant/myorganization/assetmanagementcore/equipmentItems/{{companyKey}}/{{equipmentKey}}

The parameters being replaced on the method are:

companyKey: company key.
equipmentKey: key of the equipment you wish to delete.

When this method is executed successfully, it returns HttpStatusCode.204.

Bookmark or share this article

Esta página foi útil?

Obrigado pelo seu voto.

login para deixar a sua opinião.

Obrigado pelo seu feedback. Iremos analisá-lo para continuarmos a melhorar!

How to create or delete a location? How to create or delete a tool? How to get the list of asset attachments regarding a work order? How to create or delete a meter? How to delete a monitoring?