Difference between revisions of "REST API:field Resource"

From LongJump Support Wiki
imported>Aeric
imported>Aeric
 
(6 intermediate revisions by the same user not shown)
Line 4: Line 4:
;Access Permissions:
;Access Permissions:
{{permission|
{{permission|
*Field visibility based on a user [[Role]] is defined in [[Role Based Permission Control]]}}
*Field-level access can vary, depending on [[Role-Based Field Visibility]]}}


===Retrieve Field Metadata===
===Retrieve Field Metadata===
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 (System-Generated Object)|Lookup Field (System-Generated Object)]]
:*[[REST_API/Payload_Examples#Lookup Field|Lookup Field]]
:*[[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]]
:*[[REST_API/Payload_Examples#Multi Object Lookup|Multi Object Lookup]]
:*[[REST_API/Payload_Examples#Multi Object Lookup|Multi Object Lookup]]

Latest revision as of 22:03, 16 October 2012

Retrieves Field metadata.

Warn.png

Warning: Information on this page is Provisional.

Access Permissions

Lock-tiny.gif

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.