FetchRemoteData

Fetch information, such as packages, updates, or other data, from remote sources to ensure the product's data remains current.

Syntax

Method ID

#define WAAPI_MID_FETCH_REMOTE_DATA 1032

JSON Input Structure

{
  "input": {
    "method": 1032,
    "signature": number,
    "timeout": number
  }
}

Input Properties

Parameter	Type	Description
`timeout`	number	(optional) A timeout value in seconds that can be set to this method call. Default value is 1800 seconds (30 minutes).

JSON Output Structure

{
  "result": {
    "method": 1032,
    "code": number,
    "timing": number,
    "timestamp": string,
    "sources": [
      {
        "source": string,
        "url": string,
        "status": string,
        "code": 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.sources`	array<object>	(optional) An array of sources has been fetched.
`result.sources.source`	string	(optional) The name of the source (the repository name, etc.).
`result.sources.url`	string	(optional) The url of the source (the repository url, etc.).
`result.sources.status`	string	(optional) The state of the retrieval: 'success', 'failed', 'invalid', 'unknown'.
`result.sources.code`	number	(optional) The result code of the fetch.

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​