---
title: API
layout: {{.layout}}
version: {{.version}}
lang: {{.language}}
---

## {{.schemaId}}

{{.resourceDescription}}
{{if or $.writeableFieldMap $.readOnlyFieldMap}}
### Resource Fields
{{if  $.writeableFieldMap}}
#### Writeable Fields

Field | Type | Create | Update | Default | Notes
---|---|---|---|---|---
{{range $key, $value := .writeableFieldMap}}{{$key}} | {{if $value.TypeURL}}{{$value.TypeURL}}{{else}}{{$value.Type}}{{end}} | {{if $value.Create}}{{if $value.Required}}Yes{{else}}Optional{{end}}{{else}}-{{end}} | {{if $value.Update}}Yes{{else}}-{{end}} | {{if $value.Default}}{{$value.Default}}{{else}}-{{end}} | {{$value.Description}}
{{end}}{{end}}
{{if  $.readOnlyFieldMap}}
#### Read Only Fields

Field | Type   | Notes
---|---|---
{{range $key, $value := .readOnlyFieldMap}}{{$key}} | {{if $value.TypeURL}}{{$value.TypeURL}}{{else}}{{$value.Type}}{{end}}  | {{$value.Description}}
{{end}}{{end}}
{{end}}
<br>
