REST API:field Resource

Manage Field metadata using the REST API.

Access Permissions

Field-level access can vary, depending on Field Visibility

Retrieve Field Metadata

Get metadata for a specific object field.

Method

GET

URI

https://{yourDomain}/networking/rest/field/{objectName}/{fieldName}

Response

Metadata structure that defines the field, as described in the REST API/Payload Examples.

Retrieve Metadata for All Fields in an Object

Retrieves an array of metadata for fields within an object

Method

GET

URI

https://{yourDomain}/networking/rest/field/{objectName}

Response

An array of metadata structures containing definitions of all the fields in the object, as described in the REST API/Payload Examples.

See also: JavaDocs for fields

Add a Field

Add metadata for a new object field.

Method

POST

URI

https://{yourDomain}/networking/rest/field/{objectName}/{fieldName}

Request

As described in the REST API/Payload Examples

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
        <id>34813dcd768740ad91dc4f168023a9cc</id>  -- field ID
    </message>
</platform>

Update a Field Definition

Update field metadata.

Method

PUT

URI

https://{yourDomain}/networking/rest/field/{objectName}/{fieldName}

Request

As described in the REST API/Payload Examples

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>

Payload Examples

• Auto Number Field
• CheckBox Field
• Currency Field
• Date Field
• DateTime Field
• Dependent Picklist Field
• Email Address
• Email Field
• File Field
• Formula Field (number)
• Formula Field (date)
• Global Picklist Field
• Image File Field
• Lookup Field
• Multi Checkbox
• Multi Object Lookup
• Number
• Number with Decimals
• Picklist
• Radio Button
• Rich Text Area
• Text Area
• Text Field