NIninjarmm
system

Device Custom Fields

Changed on

Returns list of all custom fields

get/v2/device-custom-fields

Request

Query parameters

scopes'all,node,location,organization'

Comma-separated list of scopes

Response

default response

entityType'USER' | 'NODE' | 'TICKET' | 'DOCUMENT' | 'INPUT_FIELD_FORM'

Entity type that this custom field or operation applies to

scope'NODE_GLOBAL' | 'NODE_ROLE' | 'NODE_CLASS'

Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)

definitionScopestring[]

Definition Scope

type'DROPDOWN' | 'MULTI_SELECT' | 'CHECKBOX' | 'TEXT' | 'TEXT_MULTILINE' | 'TEXT_ENCRYPTED' | 'NUMERIC' | 'DECIMAL' | 'DATE' | 'DATE_TIME' | 'TIME' | 'ATTACHMENT' | 'NODE_DROPDOWN' | 'NODE_MULTI_SELECT' | 'CLIENT_DROPDOWN' | 'CLIENT_MULTI_SELECT' | 'CLIENT_LOCATION_DROPDOWN' | 'CLIENT_LOCATION_MULTI_SELECT' | 'CLIENT_DOCUMENT_DROPDOWN' | 'CLIENT_DOCUMENT_MULTI_SELECT' | 'EMAIL' | 'PHONE' | 'IP_ADDRESS' | 'WYSIWYG' | 'URL' | 'MONETARY' | 'IDENTIFIER' | 'TOTP' | 'HEALTH_STATUS'

The type of custom field that determines how data is stored and displayed

labelstring

Label

descriptionstring

Description

namestring

Name

defaultValuestring

Default Value

endUserPermission'HIDDEN' | 'EDITABLE_OPTIONAL' | 'EDITABLE_REQUIRED' | 'READ_ONLY'

End user access level for custom fields in the UI

technicianPermission'NONE' | 'EDITABLE' | 'READ_ONLY' | 'ROLE_BASED'

Technician access level for custom fields

scriptPermission'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE'

Script access level for custom fields via automation

apiPermission'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE'

Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)

systemboolean

System

activeboolean

Active

createTimenumber double

Create Time

updateTimenumber double

Update Time

Changes

  • 5932b93aea2aRevision changes
    • warning

      added the new CHROMEOS enum value to the //// response property for the response status

    • warning

      added the new HEALTH_STATUS enum value to the / response property for the response status

    • warning

      added the new INPUT_FIELD_FORM enum value to the / response property for the response status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • 753f26d46650Revision changes
    • warning

      added the new AOSP enum value to the //// response property for the response status

    • warning

      added the new GLOBAL enum value to the // response property for the response status

    • warning

      added the new ROLE_BASED enum value to the / response property for the response status