AgileApps Support Wiki Pre Release

Difference between revisions of "REST API:field Resource"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 4: Line 4:
;Access Permissions:
;Access Permissions:
{{permission|
{{permission|
*Field visibility based on a user [[Role]] is defined using [[Role-Based Field Visibility]]}}
*Field visibility depends on [[Role-Based Field Visibility]]}}


===Retrieve Field Metadata===
===Retrieve Field Metadata===

Revision as of 22:02, 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://{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.