GetProductPatchLevel

Will query if product updates exist along with information on the current patch level of the product.

Syntax

Method ID

#define WAAPI_MID_GET_PRODUCT_PATCH_LEVEL 50500

JSON Input Structure

{
  "input": {
    "method": 50500,
    "signature": number,
    "tolerance": number,
    "online": number,
    "instance_id": string
  }
}

Input Properties

Parameter	Type	Description
`tolerance`	number	(optional) A tolerance factor that can be used to loosen the 'is_current' metric. The default tolerance value is '1'.
`online`	number	(optional) Whether to use online database or not. Value 0 will disable online mode, value 1 will enable it. Default value is 0.
`instance_id`	string	(optional) (macOS and Linux) Specify the id of the target instance. If not specify, the engine will try to target the first detected instance.

JSON Output Structure

{
  "result": {
    "method": 50500,
    "code": number,
    "timing": number,
    "timestamp": string,
    "is_current": boolean,
    "details": {
      "feed_id": number,
      "count_behind": number,
      "version": string
    },
    "source_timestamp": number
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.is_current`	boolean	True if this product's patch level is current, defaults to true.
`result.details`	object	Object containing detailed patch information.
`result.details.feed_id`	number	The remote feed ID used to determine patch level.
`result.details.count_behind`	number	The number of patches behind of the installed product.
`result.details.version`	string	The current version of the product in the remote feed.
`result.source_timestamp`	number	(optional) The timestamp of cloud data being used for method with online mode.

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​