Home » API » Documentation » API » Scraping Engine API » scrapeableFile

addPOSTHTTPParameter

void scrapeableFile.addPOSTHTTPParameter ( String key, String value ) (professional and enterprise editions only)
void scrapeableFile.addPOSTHTTPParameter ( String key, String value, int sequence )(professional and enterprise editions only)

Description

Dynamically adds a POST parameter to the existing set of POST parameters. If a parameter with the given sequence already exists, it will be replaced by the one created from this method call. If the method call is used that doesn't take a sequence, the new POST parameter will carry a sequence just higher than the highest existing sequence. Calling this method is the equivalent in the workbench of adding a parameter under the "Parameters" tab, and designating the type as POST. Once the scraping session is completed the original HTTP parameters (those under the "Parameters" tab in the workbench) will be restored.

Parameters

  • key The key portion of the parameter. For example, if the parameter were foo=bar, the key portion would be "foo".
  • value The value portion of the parameter. For example, if the parameter were foo=bar, the value portion would be "bar".
  • sequence The sequence the parameter (equivalent to the value under the "Sequence" column in the workbench).

Return Values

None

Change Log

Version Description
5.5.32a Available in Professional and Enterprise editions.

Examples

Add a POST HTTP parameter to a scrapeable file

// Adds a POST parameter to the end of the existing set.
scrapeableFile.addPOSTHTTPParameter( "EVENTTARGET", session.getv( "EVENTTARGET" ) );

// Replaces the existing POST parameter with a sequence of 2 with a new one.
scrapeableFile.addPOSTHTTPParameter( "VIEWSTATE", session.getv( "VIEWSTATE" ), 2 );

todd on 03/07/2012 at 4:31 pm