SubmitSpecificPathSupplementaryData

Submit supplementary scan data for a specific path (recursively) to Metadefender without performing the actual scan. If case of directory, it is important to end directory paths with a slash in order to indicate that the path points to a directory, rather than a file.

Syntax

Method ID

#define WAAPI_MID_SUBMIT_SPECIFIC_PATH_SUPPLEMENTARY_DATA 80014

JSON Input Structure

{
  "input": {
    "method": 80014,
    "target_path": [
      string,
      ...
    ],
    "no_sample_sharing": boolean
  }
}

Input Properties

Parameter	Type	Description
`target_path`	array<string>	Array of absolute paths to files and folders which need to be scanned. Directory paths must be terminated with a slash in order to indicate that the path refers to a directory.
`no_sample_sharing`	boolean	(optional) If no_file_upload is set to true, then this value is ignored. Otherwise, if this value is set to true - the file will be saved on Metadefender Server, with intention of sharing samples with antimalware vendors for research. Default value is 'false'

JSON Output Structure

{
  "result": {
    "method": 80014,
    "code": number,
    "timing": number,
    "timestamp": string,
    "data_submission_details": [
      {
        "file_path": string
      },
      ...
    ],
    "supplementary_data_details": {
      "sha1": string,
      "submission_succeed": boolean,
      "submission_rc": 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.data_submission_details`	array<object>	An array containing a collection of details regarding the submission
`result.data_submission_details.file_path`	string	Path of the file being submitted
`result.supplementary_data_details.sha1`	string	File's SHA-1 hash value
`result.supplementary_data_details.submission_succeed`	boolean	If true, the submission was successful. If false, the submission failed.
`result.supplementary_data_details.submission_rc`	number	Integer return code of the submission method.

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​