Update object description using simple_salesforce

pythonsimple-salesforce

I would like to set the description for all object fields that are layoutable but not present in any layout to: "Not used". I found out how to find fields that are layoutable, but I can't find out how to set the description of a Field using simple_salesforce.

I assume it must be done using the Metadata API, but I couldn't find an example anywhere. I couldn't figure it out myself either. I'd like to do it for all types of fields (both from standard and custom objects).

How can I set the description of a field using simple_salesforce?

Example pseudocode:

sf.objects["Account"].fields["AccountNumber"].set_description("Not used")

Best Answer

You can use mdapi as indicated here. I am not an expert in python, ignore any syntax issues.

    mdapi = sf.mdapi
    custom_object = mdapi.CustomObject.read("Account")
    custom_field = mdapi.CustomField(
        fullName = "AccountNumber",
        description = "Not used"
    )
    custom_object.fields = [custom_field]

    mdapi.CustomObject.update(custom_object)

I haven't dry-tested this code, shared here hoping this might help you. Here you can find more details about the list of attributes that we update through metadata API calls in the salesforce.

Related Solutions

Upload products to opportunity using simple_salesforce

Sorry, to spam you here. After trying several options, I found the solution by myself...

When creating the opportunity, you need to assign a price book.

'Pricebook2Id' : '01s0Y0000032iVBQAY'

This price book needs to be assigned to the opportunity, not the opportunityLineItem. I got the error message when creating the opportunityLineItem.

Anyway, Thanks for your support / people who tried to help!

Create custom field type picklist via tooling rest api – which meta information required

After searching and testing two days, finally posting here and searching on I now found the working solution.

So the following code connects to Salesforce Org and adds a new custom field MyNewCustomField__c to an existing custom object MyCustomObject__c as type Picklist with name/label MyNewCustomField with two picklist entries with values TestLabel<i> and API name TestFullName<i>.

import simple_salesforce

# connect to Salesforce
sf = simple_salesforce.Salesforce(
  'username': '[email protected]',
  'password': 'mypersonalpassword',
  'security_token': 'mysecuritytoken',
  'domain': 'test'  # I am running on a sandbox
)

# ingestion setup
url = 'tooling/sobjects/CustomField/'
object_api_name = 'MyCustomObject__c'
field_api_name = 'MyNewCustomField__c'

# meta data for MyNewCustomField
d_meta = {
    'label': 'MyNewCustomField',
    'required': True,
    'type': 'Picklist',
    'inlineHelpText': 'Inline Helptext',  
    'valueSet': {
        'restricted': True,
        'valueSetDefinition': {
            'sorted': False,

            # picklist entries
            'value': [        
                {
                    'fullName': 'TestFullName1',
                    'default': True,
                    'label': 'TestLabel1'
                },{
                    'fullName': 'TestFullName2',
                    'default': False,
                    'label': 'TestLabel2'
                }
            ]
        }
    }
}

# build payload
d_payload = {
    'FullName':'%s.%s' % (object_api_name, field_api_name),
    'Metadata':d_meta,
}

# execute POST request
result = sf.restful(url, method='POST', json=d_payload)

Best Answer

Related Solutions

Upload products to opportunity using simple_salesforce

Create custom field type picklist via tooling rest api – which meta information required

Related Topic