Difference between revisions of "REST API:field Resource"
From LongJump Support Wiki
imported>Aeric |
imported>Aeric |
||
| (10 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
;Access Permissions: | ;Access Permissions: | ||
{{permission| | {{permission| | ||
*Field | *Field-level access can vary, depending on [[Role-Based Field Visibility]]}} | ||
===Retrieve Field Metadata=== | ===Retrieve Field Metadata=== | ||
Retrieves metadata about a field in an object | Retrieves metadata about a field in an object | ||
;Method:GET | ;Method:GET | ||
;URI:<tt> | ;URI:<tt>{{platformURL}}/rest/field/{objectName}/{fieldName}</tt> | ||
;Response:Metadata structure that defines the field | ;Response:Metadata structure that defines the field | ||
| Line 16: | Line 16: | ||
Retrieves an array of metadata for fields within an object | Retrieves an array of metadata for fields within an object | ||
;Method:GET | ;Method:GET | ||
;URI:<tt> | ;URI:<tt>{{platformURL}}/rest/field/{objectName}</tt> | ||
;Response:An array of metadata structures containing definitions of all the fields in the object. | ;Response:An array of metadata structures containing definitions of all the fields in the object. | ||
| 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|Lookup Field]] | ||
:*[[REST_API/Payload_Examples#Multi Checkbox|Multi Checkbox]] | :*[[REST_API/Payload_Examples#Multi Checkbox|Multi Checkbox]] | ||
:*[[REST_API/Payload_Examples#Multi Object Lookup|Multi Object Lookup]] | :*[[REST_API/Payload_Examples#Multi Object Lookup|Multi Object Lookup]] | ||
:*[[REST_API/Payload_Examples#Number | Number]] | |||
:*[[REST_API/Payload_Examples#Number with Decimals| Number with Decimals]] | |||
:*[[REST_API/Payload_Examples#Picklist|Picklist]] | :*[[REST_API/Payload_Examples#Picklist|Picklist]] | ||
:*[[REST_API/Payload_Examples#Radio Button|Radio Button]] | :*[[REST_API/Payload_Examples#Radio Button|Radio Button]] | ||
Latest revision as of 22:03, 16 October 2012
Retrieves Field metadata.
Warning: Information on this page is Provisional.
- Access Permissions
- Field-level access can vary, depending on Role-Based Field Visibility
Retrieve Field Metadata
Retrieves metadata about a field in an object
- Method
- GET
- URI
- https://na.longjump.com/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://na.longjump.com/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
- Multi Checkbox
- Multi Object Lookup
- Number
- Number with Decimals
- Picklist
- Radio Button
- Rich Text Area
- Text Area
- Text Field