Tchater maintenant avec le support
Tchattez avec un ingénieur du support

KACE Systems Management Appliance 12.1 Common Documents - API Reference Guide



To apply paging, use the paging query parameter.

To limit the number of records returned, use the limit parameter. For example:

To indicate the index of the first returned record, use theoffset parameter. For example:

To use these parameters together, separate them with a space:

These two values are useful for consumers that display the records in a paged format. The values can appear in either order.

If no limit is specified, the default is 50. To force the server to return every record, set the limit to zero '0' or ALL. For example:

If no offset is given, the default is zero '0'.



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:

LIMITED: ID and name.
STANDARD: The expected set of fields that a typical user consumer requires. This is the default for any entity if shaping parameters are not specified.
EXTENDED: Most data.
ALL: All data, including foreign keys and similar information.

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:



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 can set to false and sent.

If only the count is needed, use the use_count 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.



This section provides API usage examples.

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

{host} represents the appliance host name or IP address.
{username} and {password} are the administrator user's credentials for logging in to the appliance Administration Console.
{token} is the x-kace-csrf-token returned by login.
{id} is the ID of the item being updated.

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

Documents connexes

The document was helpful.

Sélectionner une évaluation

I easily found the information I needed.

Sélectionner une évaluation