REST API:field Resource
From AgileApps Support Wiki
Revision as of 20:58, 30 March 2012 by imported>Aeric (Text replace - '<tt><nowiki>https://{domain}/networking' to '<tt>{{platformURL}}')
Retrieves Field metadata.
Warning: Information on this page is Provisional.
- Access Permissions
- Field visibility based on a user Role is defined in Role Based Permission Control
Retrieve Field Metadata
Retrieves metadata about a field in an object
- Method
- GET
- URI
- https://{yourDomain}/networking/rest/field/{objectName}/{fieldName}</nowiki>
- Response
- Metadata structure that defines the field
Retrieve an Array of Metadata for Fields in an Object
Retrieves an array of metadata for fields within an object
- Method
- GET
- URI
- https://{yourDomain}/networking/rest/field/{objectName}</nowiki>
- Response
- An array of metadata structures containing definitions of all the fields in the object.
See also: JavaDocs for fields
Payload Examples
Payload examples for the use case: Add Fields of the specified Field Display Types to an Object.
- 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 (System-Generated Object)
- Lookup (to a custom page)
- Multi Checkbox
- Multi Object Lookup
- Picklist
- Radio Button
- Rich Text Area
- Text Area
- Text Field