Edit

[POST] .../v1/retailcardmigration/settings/edit

Edits a retail card migration task setting. Use this method to update an existing retail card migration rule setting after it has been attached to a task. The request requires id and accepts period_type, period, comparison, value and order; missing period or order defaults to 1 and the response returns row_affected as 1 on success. The method checks the current request user and requires retail card migration edit permission; missing body, missing id, missing setting, denied permission, invalid enum or numeric values and storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
comparison String Optional Comparison type: Larger - greater than, Less - less than, Equal - equal to, EqualLarger - greater than or equal to, EqualLess - less than or equal to. Allowed values: Default, Larger, Less, Equal, EqualLarger, EqualLess.
id Int64 Required Migration task setting ID.
order Int32 Optional Execution order from 1 to 10.
period Int64 Optional Period value. If the period is current month, current quarter or current year, the value is ignored.
period_type String Optional Task period: Month - month before the migration task execution date, Quarter - quarter before the migration task execution date, Year - year before the migration task execution date, Current_Month - current month, Current_Quarter - current quarter, Current_Year - current year. Allowed values: Default, Month, Quarter, Year, Current_Month, Current_Quarter, Current_Year.
value Decimal Optional Value used for comparison.

Request Example

{
  "comparison": "Larger",
  "id": 1,
  "order": 1,
  "period": 1,
  "period_type": "Month",
  "value": 1.0
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "ids": [
      null
    ],
    "row_affected": 1
  }
}