CreateCustomFields

Inputs (CreateCustomFieldDto[]) inherits from DtoBase

This method takes an array of CreateCustomFieldDto. It consists of two properties that are vital for creating: BfsEntityBrickId (Guid) and CustomFields (array of CustomField). The BfsEntityBrickId targets the entity you want to create custom fields for, i.e an Account, Legal Entity etc. The CustomFields property is the one you populate with the CustomFields to create.

There is a check in the backend validating the FieldName property. If there exist a CustomField with the same FieldName as the one you attach, it will throw an exception, saying that a CustomField with the same FieldName already exist.

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 create.	Yes	2.39

Response CreateCustomFieldResponse inherits from ResponseBase

Name	Type	Description	Available from version

Name	Type	Description	Available from version
Entities	CreateCustomFieldDto[]	And array of CreateCustomFieldDto 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 created, if false then all CustomFields that could be created were created.	2.39

XML - CreateCustomFields example request

<?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>
        <CreateCustomFields 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 the Custom field to create]</FieldName>
                                <Value>[Value of the Custom field]</Value>
                            </CustomField>
                        </CustomFields>
                    </CreateCustomFieldDto>
                </Entities>
            </request>
        </CreateCustomFields>
    </soap:Body>
</soap:Envelope>

BFS API

CreateCustomFields

Inputs (CreateCustomFieldDto[]) inherits from DtoBase

Response CreateCustomFieldResponse inherits from ResponseBase

XML - CreateCustomFields example request

Related pages