upload.getWebFile

Returns content of a web file, by proxying the request through Ansible, see the webfile docs for more info.Note: the query must be sent to the DC specified in the webfile_dc_id MVSy configuration field.

API section: Working with files

upload.getWebFile#24e6818d location:InputWebFileLocation offset:int limit:int = upload.WebFile;

Parameters

NameTypeDescription
location InputWebFileLocation
offset int How many records to skip from the start of the selection.
limit int Maximum number of records to return.

Result

upload.WebFile

Possible errors

Read out of the handler itself — this is what the server actually returns for this method.

CodeTypeWhat it means
400 WEBFILE_NOT_AVAILABLE The external file is unavailable.

Common to every call

CodeTypeWhat it means
401 AUTH_KEY_UNREGISTERED The server does not know this session: the key was revoked, expired, or the call was made before authorisation.
401 API_ID_INVALID This api_id was never issued or has been blocked. Keys come from my.ansible.su.
400 CONNECTION_LAYER_INVALID The client did not declare a layer, or declared one the server does not know.
420 FLOOD_WAIT_X Too often. Do not retry for X seconds — the number arrives in the error text.
500 INTERNAL A failure on our side. The request may be retried; if it keeps failing, it is a bug of ours.

Related pages

Types used here