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.
• |
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.
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.
This section provides API usage examples.
• |
{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. |
• |
{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 “https://www.example.com”.
• |
• |
• |
URL: k1000/ams/shared/api/security/login |
• |
• |
◦ |
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. 使用条款 隐私 Cookie Preference Center