Difference between revisions of "REST API:field Resource"

Revision as of 20:58, 30 March 2012

Retrieves Field metadata.

Warning: Information on this page is Provisional.

Field visibility based on a user Role is defined in Role Based Permission Control

Retrieves metadata about a field in an object

Method: GET
URI: https://{yourDomain}/networking/rest/field/{objectName}/{fieldName}</nowiki>

Retrieves an array of metadata for fields within an object

Response: An array of metadata structures containing definitions of all the fields in the object.

Payload examples for the use case: Add Fields of the specified Field Display Types to an Object.

@@ Line 9: / Line 9: @@
 Retrieves metadata about a field in an object
 ;Method:GET
-;URI:<tt><nowiki>https://{domain}/networking/rest/field/{objectName}/{fieldName}</nowiki></tt>
+;URI:<tt>{{platformURL}}/rest/field/{objectName}/{fieldName}</nowiki></tt>
 ;Response:Metadata structure that defines the field
@@ Line 16: / Line 16: @@
 Retrieves an array of metadata for fields within an object
 ;Method:GET
-;URI:<tt><nowiki>https://{domain}/networking/rest/field/{objectName}</nowiki></tt>
+;URI:<tt>{{platformURL}}/rest/field/{objectName}</nowiki></tt>
 ;Response:An array of metadata structures containing definitions of all the fields in the object.