Delete URL (script step reference)

Troi URL Plug-in > Script steps reference > Delete URL
Troi URL Plug-in for FileMaker Pro

Delete URL

Sends request to delete an item at a specified place on the web server, using the DELETE method.

SyntaxScript step badge

Delete URL [ Select ; Result ; Switches ; URL ]

Options

Select entire contentsreplaces the entire contents of a field with the result. If not checked the result replaces the currently selected portion of the field
Resultthe raw data returned (or an error code)
Switchesthis determines the behavior of the plug-in
URLthe url of the resource to delete (on the server)

Switches

Switches can be one or more of these:

-NoDialogdon’t display a progress dialog
-TimeoutTicks=xspecify the connect timeout time in x ticks (1/60th of a second)
-ReturnHeaderinclude the header in the returned text (at the beginning)
-Portnumber=yspecify the port number to use
-DontAutoRedirectthe plug-in will not go to a redirected page but return the original page
-AllowAnyRootCertificate(for HTTPS) allow root certificates from unrecognized certification authorities. Note that this is less secure!
-AlwaysSendUserPasswordwill directly send the username + password, even when this might not be necessary
-DontTryWithUserPassworddon’t send username + password when the web server requests authorization

Returned Result

Data type returned

Text

Result

If successful it returns the data of the URL. If unsuccessful it returns an error code starting with $$ and the error code. Returned error codes can be:

$$-1genericErrthe user cancelled
$$-4230timeoutErrthe connection timed out
$$-3242protocolErrthis protocol is not supported (use only http and https)
$$-30776authnErrauthentication error, you need to supply a correct user name and password
$$-92ddpLenErrservername part of the url is too long
$$-2110pathTooLongErrpath part of the url is too long

Other errors may be returned, specifically errors in the range 300 to 599, which are HTTP Status Codes.

Originated in

Troi URL Plug-in 5.0

Compatibility

FileMaker Pro 16

Considerations

Not every web server supports the DELETE method.
Secure connections (HTTPS) using SSL are also supported.
If you don’t specify a timeout, a default timeout of 15 seconds is used.

On Mac OS a progress dialog can be displayed. On this platform you can also cancel a long operation with an ESC or a Command-Period.

The length of the URL is limited, by both the plug-in and receiving web servers. A lot of web servers don’t support URLs longer than 2048 characters. Note that the plug-in has higher limits of 32867 characters for the URL.

Example

Delete URL [ Select ; $Result ; "http://www.example.com/data/user123/mydata.txt" ]

This will send the request to the web server to delete the file at the location /data/user123/mydata.txt.

Example 2

We assume that in your FileMaker file the following field is defined:

 ImageName         		Text

The field ImageName should contain the name of the image, for example “img123.jpg”.

In a script add the following script steps:

Set Variable [ $thebaseURL ; "http://www.photos.com/images/" ]
Delete URL [ Select ; $ResultText ; "-noDialog" ; $thebaseURL & ImageName ]

This will ask the web server to delete the image at the specified location on the web server: “http://www.photos.com/images/img123.jpg”. Note that web servers might not support the DELETE method or refuse this DELETE request.

Related functionFunction badge

TURL_Delete

Online Help Page for Troi URL Plug-in for 12 to 16 –> Delete URL (urlp7419) 2017-0626 13:55:31