- Available Since API Version – 2.0\
The SecAccessFieldSchema type is used to represent security settings for entities. SecAccessFieldSchema objects are sub-properties of the SecAccess2LvlField object type, and will always be present as either the "Read" or "Write" property within a SecAccess2LvlField object in any API request/response.
SecAccessFieldSchema objects contain the following properties:
-
Items - An array of UidObjects representing the users with access to the entity.\
-
DisplayValue - A string value containing the display value of the field.\
Basic Read Request
The following example illustrates the syntax for a request for the default value of a SecAccessFieldSchema in a Read method call.
Request
{
"Write":1
}
Response
{
"Write":[
"VXNlcglNQVNURVI=",
"VXNlcglNQ09SRUxM"
]
}
Detailed Read Request
The following example illustrates the syntax for a request for all properties of a SecAccessFieldSchema in a Read method call.
Request
{
"Write":{
"Items":1,
"DisplayValue":1
}
}
Response
{
"Write":{
"Items":[
"VXNlcglNQVNURVI=",
"VXNlcglNQ09SRUxM"
],
"DisplayValue":"Lou Jones, Miranda Corell"
}
}
Create/Update Request
The following example illustrates the syntax for including a BooleanField in a Create or Update method call.
Request
{
"Write":[
"VXNlcglNQVNURVI=",
"VXNlcglNQ09SRUxM"
]
}
Response
{
"Write":[
"VXNlcglNQVNURVI=",
"VXNlcglNQ09SRUxM"
]
}