KACE Systems Management Appliance 14.0 Common Documents - API Reference Guide

Shaping

Shaping

The shaping query parameter limits the amount of returned data is specified. The returned fields for each associated entity is controlled by two query values. The first is the name of the entity, while the second half of the pair is the associated level. Name/value pairs are separated by a comma.

The definition of each shaping level is specific to the entity in question. You can use the following shaping levels:

The default for all non-included sub-entities isnone. There is no need to specify in such calls.

The same syntax can be used to shape the base entity as well as any desired sub-entities. For example, to gather full machine data and limited data for each software title on every machine, use the following call:

Counts

Counts

Two flags are available to dictate whether and how the count value is returned in the payload. The count value indicates the total number of entities in the system that match the query. This can be different than the number of returned records based upon the limit flag, as described above.

The use_count parameter can be used to prevent a field giving the count of available records from being included. Returning the count is the default behavior. To do that, set this flag to false in the fetch request.

If only the count is needed, use the use_count_only parameter. Any value except false forces only the count of matching entities to be returned. This flag can save processing and data transfer time. By default this flag is false.

Examples

Examples

This section provides API usage examples.

The following placeholders appear in these examples. You must replace them in the actual API calls as follows:

Other variables should be replaced with the data you want to write when creating or updating. For example, replace "{website}" with “https://www.example.com”.

Login example

Login example

Syntax:

Example: