In order to manage an ever growing array of objects in Oomnitza, and provide an even greater degree of control over your Oomnitza instance, Oomnitza supports the creation of Custom Objects to manage structured data of any type. Custom Objects live alongside other Objects in Oomnitza, like Assets, Users, and Software, and can be built from the ground up to support your use cases.
What is a Custom Object?
Oomnitza, at its core, manages objects. Assets in Oomnitza are objects. Users are objects. Software are objects. Contracts are objects.
Custom Objects allow you to manage everything else. From Departments and Cost Centers to Computer Parts and SLAs. Custom Objects provide a place to store other robust pieces of information in a way that can be referenced within other modules in Oomnitza to create complex relationships between objects, and provide a more organized and robust alternatives to dropdown menus.
Creating Custom Objects
Custom Objects are managed through the Oomnitza Configuration page, from the Custom Objects Menu. This will take you to a list of all custom objects, or let you select an individual Custom Object module, in order to create or customize objects of that type.
Creating the Custom Object
To create a Custom Object, complete the following steps:
- Navigate to Configuration>All Custom Objects.
- Click the + button in the upper right. You'll then be prompted to name your Custom Object, optionally give it a description, then specify Stand Alone Object or Lookup Object.
- Stand Alone Object: Similar to Assets, records created in Standalone Custom Objects represent individual items that don't need to be referenced in other objects or modules.
- Lookup Object: Lookup objects act more like Users or Locations, providing the opportunity to add them as a custom lookup on other objects, allowing for relationality. Typically, you'll want to select Lookup Object, because these can be associated to other objects in your Oomnitza system.
- Click Create in the lower right, and your new Custom Object will be created.
Customizing the Custom Object
Once it has been created the information stored in a Custom Object need to be specified by customizing the Custom Object. To do this, select the Custom Objects dropdown from the Configuration page, and select the Object you wish to customize from the list.
From here, you'll be taken to a page that resembles the List View in other modules. From this page, you can create individual records within your custom objects. To customize this object, click the Customization button in the upper right.
This will take you to the Customization page for that custom object. From here, you can add new fields using the + button in the upper right.
- Short Text - Allows the user to enter text up to 256 characters.
- Long Text - Allows the user to enter text up to 1024 characters.
- Numeric - Allows for entry of integers up to 20 digits.
- Decimal - Allows for entry of decimals.
- Date - Allows for entry of dates, gives a date box when clicked.
- Checkbox - Allows for a checkbox or boolean field.
- Users List - Provides a list of users.
- Location - Provides a list of locations.
- Custom Object Lookups - Additionally, any "Lookup" type custom objects that you've created can be created as a custom field to allow you to look up that variety of object. These fields are identified by the name of the custom object.
Creating Custom Object Records
Once you've customized your objects to your liking, you can create individual records within that object. These represent the actual instances of your custom object. For example, a record with a Cost Center Custom Object would represent an individual Cost Center.
To create a record, navigate back to the Custom Object list page and click the + button in the upper right. You'll then be prompted to define that object using the Custom Fields that you've created.
Custom Object APIs
To ensure a full range of flexibility, Custom Objects in Oomnitza also include an API for each object, allowing for a wide degree of manipulation of your objects. The following endpoints allow you to respectively access:
- All Custom Objects
- Individual Custom Objects
- All Records for a specific Custom Object
- Details for a specific Record
https://{instance}.oomnitza.com/api/v3/custom_objects/
https://{instance}.oomnitza.com/api/v3/custom_objects/{custom_object_id}/
https://{instance}.oomnitza.com/api/v3/custom_objects/{custom_object_id}/records
https://{instance}.oomnitza.com/api/v3/custom_objects/{custom_object_id}/records/{custom_object_record_id}
Additionally, the /api/v3/custom_objects/ and /api/v3/custom_objects/{custom_object_id}/records endpoints both support Oomnitza's custom filters, as seen below:
https://{instance}.oomnitza.com/api/v3/custom_objects/{custom_object_id}/records?filter={field_id} eq '{search_term}'
If you have any questions or need assistance with Oomnitza's Custom Objects API, please feel free to reach out to api_support@oomnitza.com or refer to the additional documentation in Oomnitza at Configuration>Integrations>Rest APIs (Swagger docs).
Comments
0 comments
Please sign in to leave a comment.