Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field

Type

Required

Description

name

string

YES

Name of the worklist.

threshold

integer

YES

Minimum matching score.

Results with lower score than the entered threshold will not be returned in the response.

Default value: 85.

frequency

string

YES

Monitoring frequency.

Possible enum values:

  1. Daily

  2. Weekly

  3. Monthly

  4. HalfAYear

  5. Annual

datasets

array

YES

Datasets to monitor against.

Available datasets are the same as described in AML Search API. They can be found here.

scheduleDayOfTheWeek

string

Note

It is required and allowed only when the frequency is set to weekly.

A day of the week on which screening should be done.

Possible enum values:

  1. Monday

  2. Tuesday

  3. Wednesday

  4. Thursday

  5. Friday

  6. Saturday

  7. Sunday

scheduleDayOfTheMonth

integer

Note

It is required and allowed only when the frequency is set to monthly, HalfAYear or Annual.

A day of the month on which screening should be done.

A value between 1 and 31.

scheduleMonth

string

Note

It is required and allowed only when the frequency is set to halfAYear or annual.

A month on which screening should be done.

Possible enum values:

  1. January

  2. February

  3. March

  4. April

  5. May

  6. June

  7. July

  8. August

  9. September

  10. October

  11. November

  12. December

...