Batch update object parameters

POST 
/ObjectParameters/BatchActions

Batch update object parameters

Request

application/json

Body

The batch actions request containing details of the actions to be performed.

objectParametersList object[]nullable
The list of object parameters to create.
Array [
id int32required
The unique identifier of this record.
paramName stringnullablerequired
The internal name of the parameter.
paramType stringnullablerequired
The data type of the parameter.
paramTitle stringnullablerequired
The display title of the parameter.
lang stringnullablerequired
The language code for localized parameter content.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
updatedDate date-timerequired
The date and time when the parameter was last updated.
showFlag booleanrequired
Indicates whether this parameter should be visible in the UI.
]
objectParametersEditList object[]nullable
The list of object parameters to update.
Array [
id int32required
The unique identifier of this record.
paramName stringnullablerequired
The internal name of the parameter.
paramType stringnullablerequired
The data type of the parameter.
paramTitle stringnullablerequired
The display title of the parameter.
lang stringnullablerequired
The language code for localized parameter content.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
updatedDate date-timerequired
The date and time when the parameter was last updated.
]
objectParametersDeleteList int32[]nullablerequired

The list of object parameter IDs to delete.

Responses

200

The updated collection of Object Parameters after batch actions are applied.

application/json

Schema

Schema

• Array [
id int32required

The unique identifier of this record.

paramName stringnullablerequired

The internal name of the parameter.

paramType stringnullablerequired

The data type of the parameter.

paramTitle stringnullablerequired

The display title of the parameter.

lang stringnullablerequired

The language code for localized parameter content.

updatedBy stringnullablerequired

The username or identifier of the user who last updated this record.

updatedDate date-timerequired

The date and time when the parameter was last updated.

showFlag booleanrequired

Indicates whether this parameter should be visible in the UI.

• ]

Example (from schema)

[
  {
    "id": 0,
    "paramName": "string",
    "paramType": "string",
    "paramTitle": "string",
    "lang": "string",
    "updatedBy": "string",
    "updatedDate": "2024-07-29T15:51:28.071Z",
    "showFlag": true
  }
]

400

Bad Request if the batch actions request contains invalid data.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...