Difference between revisions of "REST API:field Resource"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| Line 38: | Line 38: | ||
:*[[REST_API/Payload_Examples#Global Picklist Field|Global Picklist Field]] | :*[[REST_API/Payload_Examples#Global Picklist Field|Global Picklist Field]] | ||
:*[[REST_API/Payload_Examples#Image File Field|Image File Field]] | :*[[REST_API/Payload_Examples#Image File Field|Image File Field]] | ||
:*[[REST_API/Payload_Examples#Lookup Field ( | :*[[REST_API/Payload_Examples#Lookup Field (Built-in or CRM Object)|Lookup Field (Built-in or CRM Object)]] | ||
:*[[REST_API/Payload_Examples#Lookup (to a custom page)|Lookup (to a custom page)]] | :*[[REST_API/Payload_Examples#Lookup (to a custom page)|Lookup (to a custom page)]] | ||
:*[[REST_API/Payload_Examples#Multi Checkbox|Multi Checkbox]] | :*[[REST_API/Payload_Examples#Multi Checkbox|Multi Checkbox]] | ||
Revision as of 22:47, 25 April 2012
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}
- 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}
- 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 (Built-in or CRM Object)
- Lookup (to a custom page)
- Multi Checkbox
- Multi Object Lookup
- Number
- Number with Decimals
- Picklist
- Radio Button
- Rich Text Area
- Text Area
- Text Field