Identification of Objects in Alloy Navigator

Updated in 8.4

Via the API, Alloy Navigator objects can be referenced by two distinctive types of identifiers:

  • The object identifier (OID) is a string value used to uniquely identify an object. The actual field that holds the object identifier depends on the class of an object. It is either Ticket (the Ticket database field) for Incidents, Service Requests, Problems, Change Requests, and Work Orders or ID (the OID database field) for other object classes.

    Example: Ticket: T000002 (Incident) or ID: C000057 (Computer).

  • The primary key of the database record containing the information about an object is a field that uniquely defines object records in the database. In the Alloy Navigator database, the primary key is the ID field containing the object’s GUID. This is an internal field, hidden from the user interface.

    Example: {EB6D7E24-59CA-4532-B365-451724A7B880}.

In order to retrieve an object, you need to specify its object identifier in the HTTP request as the <oid> parameter value.

For information about object identifiers available for each object class, see the following table.

Object Class Object Identifier Comments

Announcements

OID, ID

 

Approval Requests

OID, ID

 

Approval Stages

OID, ID

 

Assets

OID, ID

 

Change Requests

Ticket, ID

 

Computers

OID, ID

 

Configurations

OID, ID

 

Consumables

OID, ID

 

Contracts

OID, ID

 

Documents

OID, ID

 

Groups

OID, ID

 

Hardware

OID, ID

 

Incidents

Ticket, ID

 

Knowledge Base Articles

OID, ID

 

Library Items

OID, ID

 

Locations

OID, ID

 

Networks

OID, ID

 

Organizations

OID, ID

 

Persons

OID, ID

 

Problems

Ticket, ID

 

Products

OID, ID

 

Projects

OID, ID

 

Purchase Order Items

ID

You can only refer to objects of this class by their primary keys. To obtain the database ID of a specific object record, use GET(POST) /api/v2/<objectClass> request.

For details, see Retrieving Objects (GET).

Purchase Orders

OID, ID

 

Reservations

OID, ID

 

Service Catalog Items

OID, ID

 

Service Level Agreements

OID, ID

 

Service Requests

Ticket, ID

 

Services

OID, ID

 

Software Catalog

ID

You can only refer to objects of this class by their primary keys. To obtain information about a particular object of this class, use GET(POST) /api/v2/<objectClass> requests with filtering.

For details, see Retrieving Objects (GET).

Note that the other API functions cannot be used for objects of this class.

Software Licenses

OID, ID

 

Stock Rooms

ID

You can only refer to objects of this class by their primary keys. To obtain information about a particular object of this class, use GET(POST) /api/v2/<objectClass> requests with filtering.

For details, see Retrieving Objects (GET).

Note that the other API functions cannot be used for objects of this class.

Stock Rules

OID, ID

 

Tasks

OID, ID

 

Tracked Software

OID, ID

 

Vendor Products

ID

You can only refer to objects of this class by their primary keys. To obtain the database ID of a specific object record, use GET(POST) /api/v2/<objectClass> request.

For details, see Retrieving Objects (GET).

Vendors

OID, ID

 

Work Orders

Ticket, ID