Articles in this section

See more

Overview of Equipment Register using the Assure Customer API

  • Updated

This article explains how to use the Assure Customer API (a secure RESTful API that enables automated integration with Assure) to create, update, and delete Equipment Register records (the register used to track physical assets and equipment within an organisation) in Assure. It covers what the API can and cannot do, the minimum required fields for each operation, the optional fields available, what is currently out of scope, and the steps to set up the API.

The Customer API functionality must be enabled by Evotix before use and requires a level of technical expertise, typically handled by a company's IT function. This article applies to the Equipment Register module within the Asset Management area of Assure.

 

Prerequisites

Before using the Customer API to manage Equipment Register records, confirm the following are in place:
  • API access is enabled - The Customer API functionality must be activated by the Evotix team. Contact your Customer Development Manager (CDM) or Customer Success Manager (CSM) to request access.
  • API authentication keys are generated - API keys must be created and managed in Assure before making any API requests. Refer to the API Key Management article for instructions.

  • Technical resource is available - The Customer API requires a level of technical expertise to configure and operate. Implementation is typically handled by a company's IT function.

     

What is the Assure Customer API?

The Assure Customer API can be used to automate the processes of managing Equipment Register records in Assure. The API is accessed via the internet as a secure RESTful API, which is widely supported by integration platforms, ETL tools, and all programming and scripting languages, making it straightforward to integrate with external systems.

 

What Can the Customer API Do?

With the Customer API, an administrator can perform the following operations on Equipment Register records:
  • Create new Equipment Register records
  • Update existing Equipment Register records
  • Delete Equipment Register records
Each of these operations requires the caller to submit a request to the Customer API. Full details of the API methods, request structure, field types, and data validation rules are documented in two places:
  • Equipment Register API User Guide (Guide 7) - the step-by-step implementation guide covering how to construct requests for Equipment Register records. Download the guide here: Customer API User Guide - Equipment Register API
  • Assure Customer API OpenAPI Schema - the master definition of all API methods, JSON object structures, required fields, field types, maximum data lengths, and string patterns. The schema is hosted on GitHub and is updated automatically as new functionality is released: https://github.com/Evotix/public-assure-customerapi
     

What Details Must Be Provided?

Minimum Required Fields

The following fields must be included in every API request to create or update an Equipment Register record:
  • Organisational Unit (Org Unit) Reference - the Organisational Unit the record belongs to
  • Reference
  • Equipment Name
  • Description
  • Any other fields configured as mandatory via Equipment Register Caption Maintenance (the module-level field configuration set by the customer)

Optional Fields (Defaulted if Not Supplied):

  • Is this confidential
  • Model
  • Serial Number
  • Asset Number
  • Equipment Type
  • Equipment Category
  • Equipment Sub Category
  • CE Marked
  • Purchase Date
  • Location
  • Locality
  • Equipment Value
  • Equipment Notes

  • Information Log

     

Out of Scope

The following elements are not currently supported by the Equipment Register API:
  • The Equipment Register reference field cannot be changed via the API. The API can only create new records with a unique reference, or update records where an existing record for the provided reference already exists.
  • The Equipment Register reference field cannot be automatically assigned by the system. When creating or updating records, the reference must be explicitly provided in every request.
  • Supporting items cannot be added via the API. This includes Actions, attachments, notes, reviews, and links to policies and guidance.
  • Default reviewers and approvers configured in Assure are automatically applied on record creation via the API.
  • Default values set within Caption Maintenance are not taken into consideration by the API. Any default values configured at the module level do not apply to records created or updated through API requests.

 

Setting Up the API

Follow these steps in order to configure the Equipment Register API.

Step 1: Request Access

Contact your Customer Development Manager (CDM) or Customer Success Manager (CSM) to request that the Customer API functionality is enabled on your Assure account.

Step 2: Create and Manage API Authentication Keys

Create and manage your API authentication keys in Assure at any time. Full instructions are available in the API Key Management article: Creating and managing your API keys

Step 3: Configure the Customer API (Getting Started)

Set up the Customer API by following the Getting Started user guide: Assure Customer API User Guide - Getting Started

Step 4: Configure the Equipment Register API

Set up the Equipment Register API by following the dedicated user guide: Customer API User Guide - Equipment Register API

 

AI Metadata

  • Product Area: Customer API Management, Asset Management (Equipment Register)
  • User Role: IT Administrator / Integration Engineer (technical implementation); Assure System Administrator (access request)
  • Tags: Customer API, Equipment Register, Asset Register, create equipment record, update equipment record, delete equipment record, RESTful API, integration, automation, ETL, caption maintenance, API key, Org Unit
  • Version/Region: All Assure versions; all regions
  • Important Synonyms:
    • Equipment Register = Asset Register (see Data Extraction API URL: /equipment)
    • Customer API = Assure Customer API = RESTful API
    • Organisational Unit = Org Unit = Org Unit Reference
    • Caption Maintenance = field configuration = module field setup
    • CDM = Customer Development Manager
    • CSM = Customer Success Manager
    • Supporting items = actions, attachments, notes, reviews, policy links
  • Suggested Embedding Keywords: Equipment Register API, Assure Customer API equipment, create equipment record API, update equipment register Assure, delete equipment record API, automate equipment register, Assure RESTful API asset, ETL equipment register, caption maintenance API, equipment register reference, API key management Assure
  • Relevant Modules and Cross-Module Implications: This article is scoped to the Equipment Register module (part of the Asset Management area) and the Customer API Management area of Assure. The Equipment Register Organisational Unit (Org Unit) field links records to the broader organisational structure, which underpins record categorisation and access control across all Assure modules. Caption Maintenance configuration (mandatory fields set per customer) applies at the module level and affects what the API requires at runtime. Default reviewers and approvers configured in Assure are applied automatically on record creation via the API. Supporting items such as Actions, which are managed in the core Actions area, cannot be added via this API.

 

 

Return to top

Related articles