Ingested Objects

A list of all objects (ACOMs) supported by the Matrix42 AI capabilities.

+ More

Table of Contents

ACOMs Announcement Application Appointment Asset Catalog Category ChangeTemplate CloudResource Contract ContractItem Device EmailSignature EmailTemplate Holiday KnowledgeBaseArticle License LicenseDemand Notes Order Peripheral QuickCall Service ServiceBooking ServiceCategory ServiceDeskChangeRequest ServiceDeskTicket ServiceLevelAgreement ServiceTimeProfile SmartCard SoftwareProduct TaskTemplate Secondary Data Types AssetStatusHistory BaseContract BaseDataObject CloudResourceRelation ContractRelation Cost DeviceMemory Display DigitalCertificate GraphicalUnit KBaComment KeyValue LicenseAllOfCounters MemoryModule Metadata NetworkInterface Payment PCIDevice ProcessorUnit Reference RelationEnum ServiceBookingComment ServiceDependencies ServiceDeskTicketComment ServiceDeskTicketStatusHistory ServiceOperationalPeriod SoftwareProductAllOfCounters Storage StatusEnum Volume

Ingestion is the process of uploading data from ESM deployments to the M42Next cloud platform. M42Next uses Aurora Common Object Models (ACOMs) to store and process data.

ACOMs cannot be uploaded if they have fields marked as Required that are not present.

 

You can find all the data types that can be ingested in the lists below.

ACOMs

Announcement

Extends information from BaseDataObject.

Field Description Data Type Required
Title Title of the announcement String Yes
Content Content or message of the announcement String Yes
Category Category of the announcement Reference? No
Author Author of the announcement Reference Yes
RelatedTickets List of related ticket IDs associated with the announcement List<Guid> No
Url Url related to the announcement, if applicable String No
Visibility Defines the visibility of the announcement AnnouncementVisibility (Enum) No

Application

Extends information from BaseDataObject.

Field Description Data Type Required
Name Application name String Yes
Version Application version String Yes
Manufacturer Application manufacturer String No
Description Application description String No
Department Department responsible for the contract Reference? No
SoftwareProduct Detected software product Guid? No
Assets A list of assets on which the software product has been detected List<Guid> No
Count Number of detected software products Int? No
ScanType Nature of the scan (manual, using software) String No
State State of the application String Yes
Reason Reason providing more information about the state String No
CreatedBy Who created the application (user or software) Reference? No

Appointment

Extends information from BaseDataObject.

Field Description Data Type Required
Title Brief title or subject of the appointment String Yes
Description Detailed information about the appointment String? No
StartTime Scheduled start date and time of the appointment DateTimeOffset Yes
EndTime Scheduled end date and time of the appointment DateTimeOffset? No
AllDayEvent Indicate if event takes the full day bool? No
Location Physical or virtual location of the appointment String? No
Category Reference to the Category organizing the appointment Reference Yes
Organizer Reference to the user organizing the appointment Reference Yes
ParticipantIDs List of references for participants List<Reference> No
Status Current status (e.g., Scheduled, Cancelled, Completed) String Yes
Type Type of the appointment (e.g., Reminder, Meeting) String? No

Asset

Extends information from BaseDataObject.

Field Description Data Type Required
Name Asset name String Yes
Manufacturer Asset manufacturer String No
Owner Asset owner Reference? No
Department Department responsible for the asset Reference? No
CostCenter Cost center associated with the asset Reference? No
Location Current physical location of the asset Reference? No
Workplace Workplace associated with the asset Reference? No
Type Asset type (computer, monitor, peripheral, printer, etc.) String Yes
Category Asset category (e.g., server, client, application) Reference? No
SerialNumber Serial number of the asset String No
Status Asset status String Yes
StatusHistory A list of status changes that have occured for the asset List<AssetStatusHistory> No
InventoryNumber Inventory number assigned to the asset String No
Model Asset model String No
EndOfLife ISO-8601 format of the end-of-life date of the asset DateTimeOffset No
PurchasDate ISO-8601 format of date when the asset was purchased DateTimeOffset No
WarrantyExpirationDate ISO-8601 format of expiration date of the warranty for the asset DateTimeOffset No
MaintenanceContract Maintenance contract details for the asset String No
DepreciationDate ISO-8601 format of date when the asset started depreciating DateTimeOffset No
Discovery Gets or sets asset disovery AssetDiscovery No
BusinessImpact Gets or Sets BusinessImpact AssetBusinessImpact No
Attachments A list of attachments associated with the Asset. Attachments can be used to store additional information. List<Guid> No

Catalog

Extends information from BaseDataObject.

Field Description Data Type Required
Name Brief title for Catalog String Yes
Description Detailed information about the Catalog or the Activity assigned to ticket String? No
ResponsibleRole Unique identifier of the Role responsible for the ticket Reference? No
ResponsiblePerson Unique identifier of the User responsible for the ticket Reference? No
Status Current status (e.g., Released) String Yes
ActiveFrom Start date and time of the Catalog DateTimeOffset? No
ActiveUntil End date and time of the Catalog DateTimeOffset? No
Currency Default catalog currency Currency Yes

Category

Extends information from BaseDataObject.

Field Description Data Type Required
Name Brief title for category String Yes
Description Detailed information about the category or activity assigned to ticket String? No
ParentCategory Reference to the parent category Reference? No
Summary Summary for activity String Yes
ResponsibleRole Unique identifier of the Role responsible for the ticket Reference? No
ResponsiblePerson Unique identifier of the User responsible for the ticket Reference? No
Impact Type of the Impact (e.g., Workgroup, User) String Yes
Urgency Type of the Urgency (e.g., Malfunction) String Yes
Priority Priority (e.g., Middle) String? No

ChangeTemplate

Extends information from BaseDataObject.

Field Description Data Type Required
Name Brief title for the template String Yes
Description Detailed information about the template String? No
Summary Summary for the template String Yes
Workflow Reference to Workflow Reference Yes
ServiceLevelAgreement Reference to SLA Reference? No
ResponsibleRole Unique identifier of the Role responsible for the change Reference? No
ResponsiblePerson Unique identifier of the User responsible for the change Reference? No
Impact Type of the Impact (e.g., Workgroup, User) String Yes
Urgency Type of the Urgency (e.g., Malfunction) String Yes
Category Reference to the Category for change Reference? No
Type Type of the change (e.g., Standard) String Yes
Classification Type of the change (e.g., Minor) String? No

CloudResource

Extends information from BaseDataObject.

Field Description Data Type Required
Name Asset name String Yes
Provider Service cloud provider Reference Yes
Subscription Cloud subscription name and id Reference Yes
Region Cloud region Reference Yes
ResourceType Cloud resource type Reference Yes
ResourceGroup Cloud resource group Reference Yes
Status Status of the asset (e.g., in use, in maintenance, decommissioned) String No
State State of the resource String No
Reason Reason providing more information about the state String No
Department Department responsible for the resource Reference? No
CostCenter Cost center associated with the resource Reference? No
Location Current physical location of the resource Reference? No
ParentCloudResource Unique UUID identifying the parent cloud resource Guid? No
RelatedCloudResources Other cloud resources related to this resource List<CloudResourceRelation> No
Assets Assets under this resource (VM device, etc.) List<Reference> No

Contract

Extends information from BaseContract.

Field Description Data Type Required
Type Type of the contract (Master or Contract) TypeEnum Yes
RelatedContracts A list of contracts under this contract List<ContractRelation> No
ContractItems A list of contract items under this contract List<Guid> No
ContractVolume The total volume of the contract Currency? No
EffectiveDate ISO-8601 format of the date when the contract becomes effective DateTimeOffset? No
ExpirationDate ISO-8601 format of the date when the contract expires DateTimeOffset? No
ClosingDate ISO-8601 format of the date when the contract was closed DateTimeOffset? No
AutomaticRenewal Automatic renewal of the contract at expiration Object No
CancellationNotice Notice period for contract cancellation Object No
FirstCancellation ISO-8601 format of the date when the contract can be first cancelled DateTimeOffset? No
CancelledOn ISO-8601 format of the date when the contract was cancelled DateTimeOffset? No

ContractItem

Extends information from BaseContract.

Field Description Data Type Required
Contract The unique UUID which identifies the contract linked to this contract item Guid? No
Orders A list of orders associated with this contract item List<Guid> No
Price Price information associated with this contract item Price? No

Device

Field Description Data Type Required
DeviceType Device type DeviceType (Enum) Yes
SystemId Unique identifier assigned at OS installation, from hardware or controlled by hypervisor  (Wmi ComputerSystemProduct, property UUID) Guid No
OperatingSystem Operating system installed on the device OperatingSystem No
Motherboard Moderboar of the device Motherboard No
Processors A list of network interfaces List<ProcessorUnit> No
Memory Device memory DeviceMemory No
Graphics List of graphical processing units List<GraphicalUnit> No
Displays List of integrated displays (e.g., laptop, mobile) List<Display> No
Storages List of storage devices List<Storage> No
NetworkInterfaces List of network interfaces List<NetworkInterface> No
Peripherals List of related peripheral IDs List<Guid> No
Sims List of SIM SmartCard IDs List<Guid> No
Capabilities List of capabilities (WebServer, Printer, Scanner, Domain, etc.) and associated ports List<KeyValue> No
Coordinates Device Coordinates GeoPinpoint No
Cpe Common Platform Enumeration value String No

EmailSignature

Extends information from BaseDataObject.

Field Description Data Type Required
Signature Email signature String Yes
Name Email name String Yes
Enabled Yes | No Yes | No Yes

EmailTemplate

Extends information from BaseDataObject.

Field Description Data Type Required
Subject Brief title for the email String Yes
Message Message for the email String? No
Name Name fo the Email Template String Yes
Status Current status (e.g., Draft) String Yes

Holiday

Extends information from BaseDataObject.

Field Description Data Type Required
Name Brief title for the holiday String Yes
Country Country for the holiday String Yes
StartTime Scheduled start date and time of the holiday DateTimeOffset Yes
EndTime Scheduled end date and time of the holiday DateTimeOffset? No
Type Type of holiday String Yes

KnowledgeBaseArticle

Extends information from BaseDataObject.

Field Description Data Type Required
SourceObjectIds The unique UUIDs which identifies the source objects this KBA originated from, for example, one or more Service Desk Tickets List<Reference> No
Title Article title String Yes
Description Article description; this is only text but can include markdown notation. Attachment ACOM objects, such as images, should be included as a special notation as follows: ??attachmentId??, where attachmentId is the unique identifier of the attachment ACOM object referenced in the article. Attachments only need to be included if they cannot be referenced by a URL accessible by the consuming application. String Yes
Attachments List of unique IDs of related attachments List<Guid> No
Url Article url; this can be a link to a website or some other resource such as the DWP application link String No
Version Gets or sets VarVersion KbaVersion No
Status Article status String No
Categories A list of references of categories that can be used to group articles together List<Reference> No
RelatedArticles Unique UUIDs which identify related articles List<Guid> No
RelatedTickets Unique UUIDs which identify related tickets List<Guid> No
Type Type of the KB article (General, Known Error,...) Type No
Rating Rating of the article; this can be a number between 0 and 5 Int [Range (0,5)] No
Expiration ISO-8601 format of the date and time when the article will expire DateTimeOffset No
Author Unique Identifier or External Reference of the author of the KBA Reference? No
Visibility Visibility setting for the KBA, indicating how its accessible KbaVisibility No
Comments Chronologically ordered list of comments made on the article List<KbaComment> No

License

Extends information from Asset.

Field Description Data Type Required
State License State String No
Reason Reason providing more information about the state String No
LicenseType License type LicenseType Yes
Pool License pool referring to a collection or grouping of licenses managed together Reference? No
ManufacturerOrderNumber Manufacturer order number String No
ValidFrom ISO-8601 format of date when the contract becomes valid DateTimeOffset? No
ValidUntil ISO-8601 format of date when the contract expires DateTimeOffset? No
SoftwareProduct Associated software product Guid? No
InternalContact The internal contact person for the license Reference? No
Contract The unique UUID which identifies the purchase contract Guid?  
ContractItems A list of contract items associated with the license List<Guid> No
Reservations A list of entities associated with the license (user, asset, department, etc.) List<Reference> No
LicenseDemands A list of license demands associated with the software products List<Guid> No
StockKeepingUnitCode Stock keeping unit code String No
PurchasedCount Limit for purchased licenses; unlimited if not set LicenseLimit? No
Counters Key–value (integer) counters reporting usage such as used, unused, upgraded licenses List<LicenseAllOfCounters> No

LicenseDemand

Extends information from BaseDataObject.

Field Description Data Type Required
Name Contract name String Yes
SoftwareProduct Detected software product String Yes
Consumer Consumer String No
State License demand state String No
Reason Reason providing more information about the state String No
Description Description or notes regarding the license demand String No
Licenses A list of licenses related to the license demand List<Guid> No
Count Number of licenses requested int? No
AssignedLicensesCount Number of assigned licenses int? No
MissingLicensesCount Number of missing licenses int? No
Department Department responsible for the contract Reference? No
CostCenter Cost center associated with the contract Reference? No
Location Current location of the contract Reference? No
PreventConsolidation Prevent consolidation of license demands Bool? No
IgnoreReason Explanation why the license demand is ignored String No
BaseDemand Parent license demand Guid? No
ChildDemands A list of child license demands related to this license demand List<Guid>? No
Sources A list of related sources to the license demand List<Reference> No

Notes

Extends information from BaseDataObject.

Field Description Data Type Required
Title Brief title or subject of the notes String Yes
Description Detailed information about the note String? No
EffectiveTime Effective date and time of the note DateTimeOffset Yes
Category Unique identifier of the Category organizing the note Reference Yes
Author Unique identifier of the user creating the note Reference Yes
InternalParticipantIDs List of unique identifiers for participants (internal) List<Reference> No
ExternalParticipantIDs List of unique identifiers for participants (external) List<Reference> No
Status Current status (e.g., Draft) String Yes
UpdatedAt Timestamp when the note was updated DateTimeOffset Yes
Type Type of the note (e.g., Minutes of Meeting) String? No

Order

Extends information from BaseDataObject.

Field Description Data Type Required
Status Current status of the order String Yes
Type Order type String Yes
Requester Reference of the user who requested the order Reference? No
Recipient Reference of the user who is the recipient of the order Reference No
CostCenter Reference of the cost center associated with the booking Reference No
Department Reference of the Department associated with the booking Reference No
Location Reference of the Location associated with the booking Reference? No
Bookings List of bookings that are part of the order List<Guid> Yes
Attachments List of unique IDs of related attachments List<Guid> No

Peripheral

Field Description Data Type Required
Revision Revision identifier of the asset String No
Displays Information for monitors List<Display> No
Storages List of storage components List<Storage> No
NetworkInterfaces List of network interfaces, including embedded interfaces in composite peripherals (e.g., docking stations) List<NetworkInterface> No
Sims List of SIM SmartCard IDs List<Guid> No
Capabilities List of supported capabilities (e.g., Storage, Printer, Scanner, Camera) List<String> No
PciDevices Technical information about PCI devices List<PCIDevice> No

QuickCall

Extends information from BaseDataObject.

Field Description Data Type Required
Title Brief title for the Quick Call String Yes
Description Detailed information about the Ticket String? No
Name Summary for Ticket String Yes
Solution Detailed information about the Ticket solution String? No
ResponsibleRole Unique identifier of the Role responsible for the Ticket Reference? No
ResponsiblePerson Unique identifier of the User responsible for the Ticket Reference? No
Impact Type of the Impact (e.g., Workgroup, User) String Yes
Urgency Type of the Urgency (e.g., Malfunction) String Yes
Category Unique identifiers of the Categories for Ticket Reference? No
Asset Unique identifiers for Asset Reference? No
Service Unique identifiers for Service Reference? No
Status Current status (e.g., Draft) String Yes
ErrorType Error Type of the ticket (e.g., User) String Yes
Classification Type of the ticket (e.g., ticket, incident) String Yes
EntryBy How ticket was reported (e.g., Phone) String Yes

Service

Extends information from BaseDataObject.

Field Description Data Type Required
Url Url for the service String No
Title Service title String Yes
Description A clear and brief description of the service, including its purpose and value proposition. This can include markdown notation. String Yes
Type Service type (Software, Hardware, etc.) String No
Status Current service status (Active, Inactive, etc.). String Yes
OperationalPeriods Gets or Sets OperationalPeriods List<ServiceOperationalPeriod> No
Classification Service categorization based on their relationship with the business (Business, Supporting, etc.) String No
Rating The rating of the service; this can be a number between 0 and 5 Int [Range (0,5)] No
BundlingType Service bundling type (e.g., Single, Multiple, etc.) String No
Services List of services that are part of this service, used to define the hierarchy of services List<ServiceDependencies> No
Categories List of categories the service belongs to, used for grouping and discovery List<Reference> No
SLAs List of service level agreements associated with the service List<Reference> No
Owner Unique identifier or external reference of the person who is the owner of the service Reference? No
InternalContact Unique identifier or external reference of the person who is the internal contact for the service Reference? No
TargetAudience Primary users or beneficiaries of the service, as unique identifiers or external references List<Reference> No
Dependencies List of other services or systems that this service depends on List<Guid> No
DocumentationLink URL linking to more detailed documentation or user guides for the service String No
Costs Gets or Sets Costs ServiceCosts? No

ServiceBooking

Extends information from BaseDataObject.

Field Description Data Type Required
Name Name of the requested Service String Yes
Service Unique identifier for the booked Service Guid No
Consumer The consumer for the Service Reference? No
Order Unique identifier for the order the booking belongs to Guid No
CostCenter Cost center associated to the booking Reference? No
Department Department associated to the booking Reference? No
Location Location associated to the booking Reference? No
Status Booking status String Yes
Costs Ges or sets booking costs ServiceBookingCosts Yes
Attachments List of unique IDs of related attachments List<Guid> No
Comments Chronologically ordered list of comments made on the booking List<ServiceBookingComment> No

ServiceCategory

Extends information from BaseDataObject.

Field Description Data Type Required
Name ServiceCategory name String Yes
Description Detailed information about ServiceCategory  String Yes
ParentCategory Unique identifiers of the parent category for the service Reference? No

ServiceDeskChangeRequest

Extends information from ServiceDeskTicket.

Field Description Data Type Required
ChangeType Type of change (Standard, Emergency, etc.) String No
ChangeReason Reason or justification for the change String No
ScheduledStartTime ISO-8601 format of the scheduled start time for implementing the change DateTimeOffset No
ScheduledEndTime ISO-8601 format of the scheduled end time for implementing the change DateTimeOffset No
ActualStartTime ISO-8601 format of the actual start time of the change implementation DateTimeOffset No
ActualEndTime ISO-8601 format of the actual end time of the change implementation DateTimeOffset No
TotalCosts Total costs associated with implementing the change ServiceDeskTicketChangeRequestTotalCosts No

ServiceDeskTicket

Extends information from BaseDataObject.

Field Description Data Type Required
Type Type of the ticket (e.g., Ticket, Incident, Service Request, Problem) String No
Priority Priority level of the ticket (e.g., Low, Medium, High, Critical) String No
Status Current status of the ticket (e.g., Open, In Progress, Resolved, Closed) String No
StatusHistory List of status changes that have occurred for the ticket List<ServiceDeskTicketStatusHistory> No
CreatedBy Identifier or a reference of the user who created the ticket Reference No
EntryBy What channel was used to initiate this ticket (email, phone, portal, etc.) String No
CausedBy Causes of the problem List<Guid> No
AssignedTo Identifier or reference of the user to whom the ticket is assigned Reference No
AssignedToRole Identifier or reference of the role to whom the ticket is assigned Reference No
AffectedUsers Identifiers or References of the users who are affected by the issue List<Reference> No
AffectedAssets List of assets affected by the change List<Guid> No
AffectedServices List of services affected by the change List<Guid> No
Title Short title of the ticket String Yes
Description

Detailed description of the issue or request. This can include markdown notation.

Attachment ACOM objects, such as images, should be included as a special notation as follows: ??attachmentId??, where attachmentId is the unique identifier of the attachment ACOM object referenced in the article. Attachments only need to be included if they cannot be referenced by a URL accessible by the consuming application.

 String Yes
Attachments Gets or sets attachments List<Guid> No
Category Category of the ticket (e.g., Hardware, Software, Network) Reference No
Subcategory Subcategory for more specific classification (e.g., Printer, Email, Router) Reference No
Impact Impact level of the ticket (e.g., Low, Medium, High) String No
Urgency Impact level of the ticket (e.g., Low, Medium, High) String No
SLA Service Level Agreement that applies to the ticket Reference No
Resolution Resolution details if the ticket is resolved String No
ResolutionDate ISO-8601 format of the date and time when the ticket was resolved DateTimeOffset No
RelatedTickets List of related ticket IDs for tracking linked issues List<Guid> No
RelatedKBAs List of related Knowledge Base Article IDs for tracking linked issues List<Guid> No
Comments List<ServiceDeskTicketComment> List<ServiceDeskTicketComment> No

ServiceLevelAgreement

Extends information from BaseDataObject.

Field Description Data Type Required
Title Brief title or subject of the SLA String Yes
Description Detailed information about the SLA String? No
ContractNumber Contract Number for the SLA String? No
FullfilmentRole Unique identifier of the Role responsible for the SLA Reference? No
ResponsiblePerson Unique identifier of the User responsible for the Role Reference? No
Categories List of unique identifiers of the Categories for SLA List<Reference> No
Tickets List of unique identifiers for tickets List<Reference> No
Status Current status (e.g., Draft) String Yes
Type Type of the note (e.g., SLA, OLA) String Yes

ServiceTimeProfile

Extends information from BaseDataObject.

Field Description Data Type Required
Name Brief title for the profile String Yes
Country Country for the profile String Yes
Status Current status (e.g., Draft) String Yes

SmartCard

Field Description Data Type Required
Sim SIM card information associated with the smart card SIM No
Certificates List of digital certificates associated with the smart card List<DigitalCertificate> No

SoftwareProduct

Extends information from BaseDataObject.

Field Description Data Type Required
Name Name of the software product. String Yes
Version Version of the software product. String No
Manufacturer Manufacturer of the software product. String No
Description Description of the software product. String No
State State of the software product. String No
Reason Reason providing more information about the state. String No
Price The reference price of the software product. Currency? No
IsUsed Indicates whether the software product is used. Bool? No
IsReported Indicates whether the software product must appear in reports. Bool? No
AutomaticApproval Indicates whether the software product is automatically approved. Bool? No
LicenseProvider License provider. Reference? No
DemandCount Number of license demands. Int? No
AssignedCount Number of assigned licenses. Int? No
UnlicensedCount Number of unlicensed software products. Int? No
Counters Key–value integer counters for reporting purposes. List<SoftwareProductAllOfCounters> No
ReviewedAt ISO-8601 date and time when the object was last reviewed. DateTimeOffset? No
ReviewdBy The user who last reviewed the object. Reference? No
ReleaseDate Date when the software product was released. DateTimeOffset? No
Discontinued Indicates whether the software product is discontinued. Bool? No
EndOfSupport Date marking the end of all support services. DateTimeOffset? No
IsLibrary Indicates whether the software product is a library. Bool? No
EclassCategory ECLASS category. Reference? No
UnspscCategory UNSPSC category. Reference? No
Eccn Export Control Classification Number (ECCN). String No
Contracts Contracts associated with the software product. List<Guid> No
ContractItems Contract items associated with the software product. List<Guid> No
Licenses Licenses associated with the software product. List<Guid> No
LicenseDemands License demands associated with the software product. List<Guid> No
Articles Articles associated with the software product. List<Guid> No
Attachments Attachments associated with the software product. List<Guid> No

TaskTemplate

Extends information from BaseDataObject.

Field Description Data Type Required
Title Brief title for the Task template String Yes
Description Detailed information about the Task String? No
Name Task summary String Yes
Solution Detailed information about the Ticket solution String? No
ResponsibleRole Unique identifier of the Role responsible for the Task Reference? No
ResponsiblePerson Unique identifier of the User responsible for the Task Reference? No
Priority Priority (e.g., Middle) String Yes
TypeOfTask Type of the Task (e.g., Analysis) String Yes
Category Unique identifiers of the Categories for Ticket Reference? No

Secondary Data Types

AssetStatusHistory

Field Description Data Type Required
Status The status of the asset String No
Date ISO-8601 format of the date and time when the status change occurred DateTimeOffset? No
Description A description of the status change String? No
ChangedBy Gets or sets ChangedBy Reference? No

BaseContract

Extends information from BaseDataObject.

Field Description Data Type Required
Name Name of the contract String Yes
Description A clear and brief description of the contract, including its purpose. Markdown is supported String No
Department Department responsible for the contract Reference? No
CostCenter Cost center associated with the contract Reference? No
Location Current location of the contract Reference? No
Status Status of the contract String Yes
State State of the contract String Yes
ValidFrom ISO-8601 format of date when the contract becomes valid DateTimeOffset? No
ValidUntil ISO-8601 format of date when the contract expires DateTimeOffset? No
Attachments Attachments associated with the contract List<Guid> No
LegalSystem The country or legal system where the contract is valid Reference? No
Jurisdiction The jurisdiction for which the contract is valid Reference? No
Supplier The supplier of the goods or services defined by the contract Reference? No
Signer The person who signed the contract Reference? No
InternalContact The internal contact person for the contract Reference? No
MainContract The unique UUID identifying the main or master contract Guid? No
Assets Assets associated with this contract List<Guid> No
Costs Costs under this contract, taking depreciation into account List<Cost> No
Payments Payments under this contract List<Payment> No

BaseDataObject

Relates to Metadata.

Field Description Data Type Required
Metadata Metadata associated with the object Metadata Yes
Id Unique UUID identifying this object Guid Yes
AliasIdentifier Human-readable identifier of the object String No
SubscriptionId Unique UUID identifying the subscriber this object belongs to Guid Yes
LastUpdatedAt ISO-8601 format for the  date and time when the object was last updated DateTimeOffset Yes
CreatedAt ISO-8601 format for the date and time when the object was created DateTimeOffset Yes
KeyValues Key value pairs associated to this object, and used to store additional metadata. Key value pairs are application-specific. List<KeyValue> No
Tags List of tags used to label the object List<String> No

CloudResourceRelation

Field Description Data Type Required
Relation Relation type RelationEnum Yes
Id The unique UUID for all referenceable objects Guid Yes

ContractRelation

Field Description Data Type Required
relation Relation type RelationEnum Yes
id The unique UUID for all referenceable objects Guid Yes

Cost

Field Description Data Type Required
Title Title String Yes
Category Cost's category (Hardware, Software, etc.) Reference No
Recurrency Recurrency of the cost Enum (Month, Quarter, Semester, Year) No
Occurencies Number of occurencies Integer No
First ISO-8601 format of date of the first payment DateTimeOffset No
Last ISO-8601 format of date of the last payment DateTimeOffset No

DeviceMemory

Field Description Data Type Required
Type Memory type (e.g., DDR4, DDR5) String Yes
Size Memory size (in Mb) Int Yes
Modules Memory modules List<MemoryModule> No

Display

Field Description Data Type Required
Type Display type (OLED, IPS, etc.) String No
Resolution Display resolution DisplayResolution Yes
Size Measured diagonally in inches Decimal No
Ratio Aspect ratio of the screen (e.g., 16:9, 21:9) String No
RefreshRate Screen refresh rate measured in Hertz (Hz) Decimal No
ResponseTime Pixel response time measured in milliseconds (ms) Decimal No

DigitalCertificate

Field Description Data Type Required
Id The unique UUID which identifies this object Guid Yes
Issuer Issuer of the certificate String Yes
SerialNumber Serial number for the certificate String Yes
Subject Subject of the certificate String Yes
ValidFromDate Start date of the certificate's validity DateTimeOffset No
ValidUntilDate End date of the certificate's validity DateTimeOffset No
Status Status of the certificate (e.g., active, expired, revoked) String Yes
PublicKey Public key of the certificate String No
Thumbprints A list of thumbprints List<Hash> No
Algorithm OID referencing algorithm String No
Usages A list of OID referencing usages List<String> No

GraphicalUnit

Field Description Data Type Required
Name GPU name String Yes
BoardManufacturer GPU manufacturer String No
Codename GPU codename String No
Revision GPU revision String No
Cores Number of cores Int No
MemorySize Memory size (in MB) Int Yes
PciDevice Technical information about the PCI device PCIDevice No

KBaComment

Field Description Data Type Required
Author Author of the comment, Unique identifier or reference Reference No
CommentAt ISO-8601 format of the date and time when the comment was made DateTimeOffset No
Content Text content of the comment. This can include markdown notation and attachment references. String No
Visibility Visibility setting for the comment String No

KeyValue

Field Description Data Type Required
Key The key String Yes
Value The value for the key String Yes

LicenseAllOfCounters

Field Description Data Type Required
Key The key String Yes
Value The value for the key String Yes

MemoryModule

Field Description Data Type Required
Type Memory type String Yes
Format Memory module format String No
Size Memory size (in MB) Int Yes
Bandwidth Memory bandwidth (MB/s, e.g., 3200 for a DDR4-3200) Int No
Manufacturer Module manufacturer String No
MemoryManufacturer DRAM memory manufacturer String No
PartNumber Number identifying the model of memory module String No
SerialNumber Unique number identifying the memory module String No
Week Week of production Int No
Year Year of production Int No
Slot Memory slot used by the module Int No

Metadata

Field Description Data Type Required
Type Type of the object (e.g., ServiceDeskTicket, ServiceDeskAnnouncement) String Yes
Version Version of the object schema String Yes
Origin Gets or sets the origin of the object Origin (Enum) No

NetworkInterface

Field Description Data Type Required
Name The name of the network interface String No
Description The description of the network interface String No
MacAddress The MAC address of the network interface String No
Ipv4Address IPv4 address in CIDR notation String No
Ipv4Gateway IPv4 gateway addresses List<String> No
Ipv4DnsServers IPv4 DNS servers List<String> No
Ipv4FullyQualifiedDomainNames IPv4 fully qualified domain names List<String> No
Ipv4Mtu Maximum transmission unit for IPv4 Int No
IsIpv4Primary Indicates if IPv4 interface is primary Bool No
IsIpv4Virtual Indicates if IPv4 interface is virtual Bool No
IsIpv4Wireless Indicates if IPv4 interface is wireless Bool No
IsIpv4DhcpEnabled Indicates if IPv4 DHCP is enabled Bool No
IsIpv4DnsEnabled Indicates if IPv4 DNS is enabled Bool No
Ipv6Addresses IPv6 addresses in CIDR notation List<String> No
Ipv6Gateway IPv6 gateway addresses List<String> No
Ipv6DnsServers IPv6 DNS servers List<String> No
Ipv6FullyQualifiedDomainNames IPv6 fully qualified domain names List<String> No
Ipv6Mtu Maximum transmission unit for IPv6 Long? No
IsIpv6Primary Indicates if IPv6 interface is primary Bool No
IsIpv6Virtual Indicates if IPv6 interface is virtual Bool No
Ipv6Wireless Indicates if IPv6 interface is wireless Bool No
IsIpv6AutoConfigEnabled Indicates if IPv6 auto configuration is enabled Bool No
IsIpv6DnsEnabled Indicates if IPv6 DNS is enabled Bool No
Ipv4SubNetMask Subnet mask for the network interface String No

Payment

Field Description Data Type Required
Title Title for the payment String Yes
Category Cost's category (Hardware, Software, etc.) Reference No
Status Status of the payment (Pending, Paid, Overdue, etc.) String Yes
Due ISO-8601 format of date of the first payment DateTimeOffset Yes
Value The total price of the contract item Currency Yes
Conterparty Counterparty of the payment Reference No

PCIDevice

Field Description Data Type Required
VendorId Vendor ID String Yes
ModelId Model ID String Yes
SubSystem SubSystem ID String No
Revision Revision String Yes
UniqueId Unique ID of the device String No
HardwareId Device hardware ID String No
InstancePath Device hardware ID String No

ProcessorUnit

Field Description Data Type Required
Architecture Architecture of the CPU PlatformArchitecture Yes
Name Processor model name String No
Codename Processor name or generation String No
Package Processor package String No
Cores Number of CPU cores Int No
Threads Number of CPU threads Int No
Slot Slot information when motherboard has multiple CPUs Int No

Reference

Field Description Data Type Required
Id The unique internal UUID which identifies this reference. Required if Origin is Internal or null. Guid? Conditional
Identifier The unique identifier for the external object. Required if Origin is not Internal or null. String? Conditional
AliasIdentifier Human readable identifier for the object String? No
Type Type of the referenced object (e.g., User, UserGroup, Role) String? No
Origin Specifies the origin of the reference. If Internal or null, Id is required; otherwise Identifier is required. String? No
DisplayValue The display value or description of the object being referenced String Yes

RelationEnum 

Value Name Description
Child Child Indicates a child relationship
DependsOn DependsOn Indicates this object depends on another
Dependent Dependent Indicates another object depends on this one

ServiceBookingComment

Field Description Data Type Required
Author Reference of the user who made the comment Reference No
CommentAt ISO-8601 format of the date and time when the comment was made DateTimeOffset No
Content Text content of the comment. This can include markdown notation. Attachment ACOM objects, such as images, should be included as a special notation as follows: ??attachmentId??, where attachmentId is the unique identifier of the attachment ACOM object referenced in the article. Attachments only need to be included if they cannot be referenced by a URL accessible by the consuming application. String No
Visibility Visibility setting for the comment String No

ServiceDependencies

Field Description Data Type Required
Id The unique identifier for the service Guid? No
Bundling Gets or Sets Bundling ServiceBundling? No

ServiceDeskTicketComment

Field Description Data Type Required
Author Reference of the user who made the comment Reference No
CommentAt ISO-8601 format of the date and time when the comment was made DateTimeOffset No
Content Text content of the comment. This can include markdown notation. Attachment ACOM objects, such as images, should be included as a special notation as follows: ??attachmentId??, where attachmentId is the unique identifier of the attachment ACOM object referenced in the article. Attachments only need to be included if they cannot be referenced by a URL accessible by the consuming application. String No
Visibility Visibility setting for the comment String No

ServiceDeskTicketStatusHistory

Field Description Data Type Required
Status The status of the ticket String No
Date ISO-8601 format of the date and time when the status change occurred DateTimeOffset? No
Description A description of the status change String? No
ChangedBy Identifier or reference of the user who changed the status Reference? No

ServiceOperationalPeriod

Field Description Data Type Required
StartDate ISO-8601 format of the start date of the operational period DateTimeOffset? No
EndDate ISO-8601 format of the end date of the operational period DateTimeOffset? No

SoftwareProductAllOfCounters

Field Description Data Type Required
Key The key String Yes
Value The value for the key String Yes

Storage

Field Description Data Type Required
Capacity Capacity in MB Decimal? No
Volumes A list of volumes List<Volume> No
Status Current storage status StatusEnum No

StatusEnum

Value Description
Uninitialized Storage is not initialized
Ready Storage is ready for use
Degraded Storage is operational but degraded
Rebuilding Storage is currently rebuilding
Failed Storage has failed

Volume

Field Description Data Type Required
RaidMode Raid mode (none, jbod, 0, 1, 5, 10, 6, etc.) String No
Capacity Capacity in MB Decimal No
Disks A list of disks List<Disk> Yes
FileSystem File system assigned to the volume FileSystem No
Status Gets or Sets Status StatusEnum Yes
acom ai search aiops m42next

Related Articles