UpdateCustomFields

Inputs (UpdateCustomFieldDto[]) inherits from https://bricknode.atlassian.net/wiki/spaces/API/pages/2857795633

This method takes an array of UpdateCustomFieldDto. It consists of two properties that are vital for updating: BfsEntityBrickId (Guid) and CustomFields (array of CustomField). The BfsEntityBrickId targets the entity you want to update custom fields for, i.e an Account, Legal Entity etc. The CustomFields property is the one you populate the CustomFields to update. How does the system know what custom field to target/update? By looking at the FieldName property on each custom field. The FieldName property should match with the FieldName of the custom field in the database you would like to update.

If the system does not find a matching FieldName (FieldName on custom field in database and FieldName on custom field you attach) it will throw an exception: FieldNameNotFoundException.

Name

Type

Description

Mandatory

Available from version

Name

Type

Description

Mandatory

Available from version

BfsEntityBrickId

Guid

The brick id of the entity.

Yes

2.39

CustomFields

CustomField[]

The collection of custom fields you would like to update.

Yes

2.39

 

Response UpdateCustomFieldResponse inherits from ResponseBase

Name

Type

Description

Available from version

Name

Type

Description

Available from version

Entities

UpdateCustomFieldDto[]

And array of UpdateCustomFieldDto that was passed to the method. Now containing values for IsError and ErrorMessages depending on if everything worked normally or not.

2.39

Message

string

A response message, "OK" if nothing went wrong and otherwise and error message.

2.39

IsError

bool

A bool to describe if the entire request failed to perform any actions. If true then nothing was updated, if false then all CustomFields that could be updated were updated.

2.39


XML - UpdateCustomFields example request

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://tempuri.org/" xmlns:s1="http://microsoft.com/wsdl/types/" xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/"> <soap:Body> <UpdateCustomFields xmlns="http://tempuri.org/"> <request> <Credentials> <UserName>[Username]</UserName> <Password>[Password]</Password> </Credentials> <identify>[Identity]</identify> <Entities> <CreateCustomFieldDto> <BfsEntityBrickId>[Guid of the entity to add Custom Fields to]</BfsEntityBrickId> <CustomFields> <CustomField> <FieldName>[Name of Custom field to update]</FieldName> <Value>[Value of the Custom field to update]</Value> </CustomField> </CustomFields> </CreateCustomFieldDto> </Entities> </request> </UpdateCustomFields> </soap:Body> </soap:Envelope>