blob: 80c1ac15c455959548da4da988a129b715a99f77 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="coordinate_v1.html">Google Maps Coordinate API</a> . <a href="coordinate_v1.customFieldDef.html">customFieldDef</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(teamId)</a></code></p>
<p class="firstline">Retrieves a list of custom field definitions for a team.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(teamId)</code>
<pre>Retrieves a list of custom field definitions for a team.
Args:
teamId: string, Team ID (required)
Returns:
An object of the form:
{ # Collection of custom field definitions for a team.
"items": [ # Collection of custom field definitions in a team.
{ # Custom field definition.
"kind": "coordinate#customFieldDef", # Identifies this object as a custom field definition.
"enumitems": [ # List of enum items for this custom field. Populated only if the field type is enum. Enum fields appear as 'lists' in the Coordinate web and mobile UI.
{ # Enum Item definition.
"active": True or False, # Whether the enum item is active. Jobs may contain inactive enum values; however, setting an enum to an inactive value when creating or updating a job will result in a 500 error.
"kind": "coordinate#enumItemDef", # Identifies this object as an enum item definition.
"value": "A String", # Custom field value.
},
],
"name": "A String", # Custom field name.
"enabled": True or False, # Whether the field is enabled.
"requiredForCheckout": True or False, # Whether the field is required for checkout.
"type": "A String", # Custom field type.
"id": "A String", # Custom field id.
},
],
"kind": "coordinate#customFieldDefList", # Identifies this object as a collection of custom field definitions in a team.
}</pre>
</div>
</body></html>