Configuring job options

This REST service will configure content scan job options, such as adding a Starting URL.

HTTPS method

POST

Service format

/services/folderitems/<fiid>/options/<option>

fiid: folder item id

option: string representing the option to change, for example, "epcsCOTListOfStartingUrls". Here is a list of job options you can configure:
  • epcsCOTListOfStartingUrls
  • ebCOTHttpAuthentication
  • esCOTHttpUser
  • esCOTHttpPassword
  • elCOTScanLimit
  • esCOTAutoFormFillUserNameValue
  • esCOTAutoFormFillPasswordValue
  • epcsCOTUrlExclusions
  • ecsCOTUrlExclusionSpecificExceptions
  • ecsCOTUrlExclusionGlobalExceptions
  • ebCOTEnableSCA

Query string parameters

/services/folderitems/<fiid>/options/<option>?delete=1

If the option is a collection, this parameter will delete the existing collection.

/services/folderitems/<fiid>/options/<option>?put=1

The POST data will be used to overwrite the existing option value or collection.

POST data

Content-Type: application/x-www-form-urlencoded

Enter the 'value=<option value>' in the body of the request. You can have multiple values if necessary.

Example: value=http://http://www.altoromutual.com/&value=http://www.ibm.com

Returns

The value(s) related to the option being set.

Example:
<options>
   <option value="https://demo.testfire.net/"/>
</options>

Refer to documented schema for more details.

Configuration for ecsCOTUrlExclusionSpecificExceptions option

Query string parameters

The delete and put parameters are not applicable for this option.

POST data

Content-Type: application/x-www-form-urlencoded

  • Enter the 'value=<option value>' in the body of the request. You can have multiple values if necessary.

    Example: value=/home.jsp&value=/bank.jsp

  • Enter the 'exclusionid=<exclusion number>' in the body of the request. Exclusion number starts from zero. If there are 3 exclusions then the numbers assigned to exclusions are 0,1,2. Specifying multiple exclusion numbers is not supported. ‘exclusionid’ is optional for this option. If ‘exclusionid’ is not specified, exception value will be added to last exclusion.

    Example: exclusionid=3 (adds the exception value to 4th exclusion)

What to do next

Updating a folder item action