Vendor Defined Data Fields
Vendor Defined Data Fields
These API endpoints allow integration vendors to create and share data for their products into the ConnectWise Command Platform. The data can either be shown in the Devices section of the ITSupport Portal or it can be used to store technical/temporary data/information which can later be used for automation purposes.
Use Case Examples
- As an AV product vendor, you want to share the status of the AV for each machine, whether the machine is infected or not, when was the last scan performed on a machine, etc.
- Similarly, as a Backup product vendor, I want to share the status of backups for each machine, the number of backups, size of backup, etc.
How to Push Data
The following steps must be performed to push data:
- The vendor should first define a schema for the fields, this is done via a POST API.
- Currently, we support 5 types of data fields
- String
- Boolean
- Integer
- Datetime
- Enum
- Currently, we support 5 types of data fields
- Once the schema is defined, a PUT can be used to push data for each endpoint at the Client, Site, or Endpoint level.
- Once data is pushed for each endpoint, vendors will have to define whether the field should be UI visible and where it should be displayed in the UI, if so. This needs to be specified while creating a schema for the fields.
- NOTE: It is recommended to create up to 6 data fields for the Devices Summary page. Other fields can be created and added to the Device Details section. The maximum number of fields that can be created is 200 (which can be extended on request).
- Once field definitions are created, a GET can be performed to retrieve a definitions schema with all entity types or by a specific type. To delete definitions, create a schema with an empty list in the request body.
Example
POST to Create Data Fields Schema
{ "entityType": "endpoint", "name": "backup_plan", "description": "some description", "attributeType": "enum", "validationOptions": { "enum": [ "not_specified", "premium", "elite" ] }, "defaultValue": "not_specified", "localizations": [ "description": "dropdown of the attribute", "language": "en_US", "name": "AD" ] "uiOptions": { "display_type": "storage", "views": [ { "columnCropFactor": 1, "order": 1, "view": "portal.device_details_view" } ] }, }
Configuration
id |
|
entityType | controls field mapping to specific entity type (partner/client/site/endpoint) |
attributeType | defines type of the field (string/boolean/integer/datetime/enum) |
name | defines the name of the fields |
description | defines the description of the fields |
defaultValue | optionally defines the default value for the fields |
validationOptions |
"validationOptions": { "regex": ".*" } |
uiOptions |
controls UI-specific behavior. If this configuration is not specified, the field will not be displayed in the UI. If specified location and behavior must be mentioned
|