Skip to content

Update collateral

PATCH 
/api/apiGateway/updateCollateral/{collateralId}

Update properties for a specific collateral.

Parameters

collateralId string

The unique identifier of the collateral that you want to update.

Request

Type: application/json

Schema: UpdateCollateralRequestDto

propertiesToUpdates array [ CollateralPropertyUpdateDto ]
property string(enum)

Available enum values: Name, Description, YearRenovated, YearBuilt, FloorAreaRatio, ParkingRatio, AssetClass

value string

Response

Type: application/json

Schema: UpdateResponseDto

success boolean

error ErrorDto

target string

code string(enum)

Available enum values: Duplicated, MissingMandatoryField, InvalidCreateValues, Existing, ValidationError, MissingEntity

message string

details array [ ErrorDto ] 
GET ${BASE_URL}/api/apiGateway/updateCollateral/0b6696e4-7c45-46c2-bb1f-d36d3ee93df7
Accept: */*
Authorization: Bearer eyJz93a...k4laUWw

curl --request GET \
    --url "${BASE_URL}/api/apiGateway/updateCollateral/0b6696e4-7c45-46c2-bb1f-d36d3ee93df7" \
    --header 'Accept: */*' \
    --header 'Authorization: Bearer eyJz93a...k4laUWw'
Response
{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": ["string"]
  }
}