GetPackages

Returns a list of packages linked to the given patch. This method does not download content and supports patchv2.dat and wuo data files.

Syntax

Method ID

#define WA_VMOD_PATCH_GET_PACKAGES 50306

JSON Input Structure

{
  "input": {
    "method": 50306,
    "patch_uuid": string,
    "package_limit": string,
    "applicability_mode": string
  }
}

Input Properties

Parameter	Type	Description
`patch_uuid`	string	The Universally Unique Identifier of the patch.
`package_limit`	string	(optional) Controls the maximum number of packages to return. Accepted values are: • `first`: returns only the first package. • `all`: returns all packages. Default value is `first`.
`applicability_mode`	string	(optional) Controls the applicability evaluation and filtering of returned packages. Accepted values are: • `applicable_only`: returns only packages that are applicable to the endpoint. • `no_evaluation`: returns all packages without evaluating applicability. Default value is `applicable_only`.

JSON Output Structure

{
  "result": {
    "method": 50306,
    "code": number,
    "timing": number,
    "timestamp": string,
    "version": string,
    "packages_relationship": string,
    "packages": [
      {
        "package_uuid": string,
        "sha256": string,
        "sha1": string,
        "download_links": [
          string,
          ...
        ],
        "architectures": [
          string,
          ...
        ],
        "languages": [
          string,
          ...
        ],
        "evaluation_status": string
      },
      ...
    ]
  }
}

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.version`	string	(optional) (Third-party patching flow) The version of the patch.
`result.packages_relationship`	string	(optional) (Windows Update Offline patching flow) Indicates whether the returned packages must be installed together. Present only when `package_limit` is `all` and `applicability_mode` is `applicable_only`. Possible values are: • `independent`: each package can be installed independently. • `coupled`: all packages must be installed together, in the order they are returned.
`result.packages`	array<object>	List of packages returned for the patch. May be empty if `applicability_mode` is `applicable_only` and no applicable packages are found.
`result.packages.package_uuid`	string	The Universally Unique Identifier of the package.
`result.packages.sha256`	string	(optional) SHA-256 hash of the package file if available (in some cases, the SDK does not store SHA-256 because the installer's hash changes with each download or for self-update products). This field mainly appears in the third-party flow.
`result.packages.sha1`	string	(optional) SHA-1 hash of the package file. This field mainly appears in the Windows Update Offline patching flow.
`result.packages.download_links`	array<string>	List of download URLs for the package. Multiple URLs may be provided as mirrors or alternative sources. May be empty for self-updating or install-only products.
`result.packages.architectures`	array<string>	(optional) Architectures of the package.
`result.packages.languages`	array<string>	(optional) Languages of the package.
`result.packages.evaluation_status`	string	(optional) The applicability evaluation result for this package. Possible values are: • `not_evaluated`: the package was not evaluated for applicability on this endpoint. • `applicable`: the package is applicable to this endpoint.

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​