Update object

PUT 
/Objects/:objectCode

Update object

Request

Path Parameters

objectCode stringrequired

The object Code.

application/json

Body

The object to update.

objectName stringnullablerequired

The display name of the AML object.

objectType stringnullablerequired

The type classification of the AML object.

objectDescription stringnullablerequired

A textual description of the AML object's purpose.

sqlObject stringnullablerequired

The SQL expression used to evaluate this object.

objectErrorMessage stringnullablerequired

The error message recorded if object evaluation fails.

updatedBy stringnullablerequired

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

createdBy stringnullablerequired

The username or identifier of the user who created this record.

objectVersion int32nullablerequired

The version number of the object definition.

Responses

200

The object was updated.

application/json

Schema

Schema

objectName stringnullablerequired

The display name of the AML object.

objectType stringnullablerequired

The type classification of the AML object.

objectDescription stringnullablerequired

A textual description of the AML object's purpose.

sqlObject stringnullablerequired

The SQL expression used to evaluate this object.

objectErrorMessage stringnullablerequired

The error message recorded if object evaluation fails.

updatedBy stringnullablerequired

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

createdBy stringnullablerequired

The username or identifier of the user who created this record.

objectVersion int32nullablerequired

The version number of the object definition.

objectCode stringnullablerequired

The unique code identifying the AML object.

Example (from schema)

{
  "objectName": "string",
  "objectType": "string",
  "objectDescription": "string",
  "sqlObject": "string",
  "objectErrorMessage": "string",
  "updatedBy": "string",
  "createdBy": "string",
  "objectVersion": 0,
  "objectCode": "string"
}

400

The object is invalid.

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"
    }
  ]
}

404

An object with the specified object code could not be found.

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"
    }
  ]
}

406

Incorrect JSON format.

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...