docs: add more docs
This commit is contained in:
@@ -24,18 +24,24 @@
|
||||
max-width: 600px;
|
||||
}
|
||||
|
||||
.container>article:nth-child(2) {
|
||||
position: sticky;
|
||||
top: 0;
|
||||
}
|
||||
|
||||
.container>article>p {
|
||||
margin-top: 20px;
|
||||
color: #c1c9d2;
|
||||
}
|
||||
|
||||
.container>article>p>code {
|
||||
.container>article code {
|
||||
background-color: #0b3766;
|
||||
padding: 0.1rem 0.5rem;
|
||||
border-radius: 5px;
|
||||
}
|
||||
|
||||
.container>article:nth-child(1)>h1 {
|
||||
color: #ee7203;
|
||||
font-size: 40px;
|
||||
font-weight: bold;
|
||||
}
|
||||
@@ -46,7 +52,8 @@
|
||||
}
|
||||
}
|
||||
|
||||
.container>article>h2 {
|
||||
.container>article h2,
|
||||
.container>article h3 {
|
||||
margin-top: 1rem;
|
||||
}
|
||||
|
||||
|
||||
@@ -65,8 +65,8 @@ These are objects representing a field value in a record. They will comprise the
|
||||
---
|
||||
|
||||
- TimeSpan
|
||||
- A time span value.
|
||||
- `string`
|
||||
- A [Time Span](#time-span-value) value.
|
||||
- `object`
|
||||
|
||||
---
|
||||
|
||||
@@ -95,13 +95,13 @@ These are objects representing a field value in a record. They will comprise the
|
||||
---
|
||||
|
||||
- AttachmentList
|
||||
- A list of [Attachment](#attachment) values.
|
||||
- A list of [Attachment](#attachment-value) values.
|
||||
- `object[]`
|
||||
|
||||
---
|
||||
|
||||
- ScoringGroupList
|
||||
- A list of [Scoring Group](#scoring-group) values.
|
||||
- A list of [Scoring Group](#scoring-group-value) values.
|
||||
- `object[]`
|
||||
|
||||
---
|
||||
@@ -109,3 +109,73 @@ These are objects representing a field value in a record. They will comprise the
|
||||
- FileList
|
||||
- A list of file values.
|
||||
- `number[]`
|
||||
|
||||
{% /table %}
|
||||
|
||||
### Time Span Value {% #time-span-value %}
|
||||
|
||||
{% table .propertiesTable %}
|
||||
|
||||
- Property Name
|
||||
- Data Type
|
||||
- Description
|
||||
|
||||
---
|
||||
|
||||
- quantity
|
||||
- number
|
||||
- The number of the specified increment.
|
||||
|
||||
---
|
||||
|
||||
- increment
|
||||
- string
|
||||
- The increment of time. Can be one of the following values: `Years`, `Months`, `Days`, `Hours`, `Minutes`, `Seconds`.
|
||||
|
||||
---
|
||||
|
||||
- recurrence
|
||||
- string
|
||||
- The recurrence of the time span. Can be one of the following values: `None`, `EndByDate`, `EndAfterOccurrences`.
|
||||
|
||||
---
|
||||
|
||||
- endByDate
|
||||
- string
|
||||
- The end date of the time span. Used if `recurrence` is set to `EndByDate`.
|
||||
|
||||
{% /table %}
|
||||
|
||||
### Attachment Value {% #attachment-value %}
|
||||
|
||||
{% table .propertiesTable %}
|
||||
|
||||
- Property Name
|
||||
- Data Type
|
||||
- Description
|
||||
|
||||
---
|
||||
|
||||
- fileId
|
||||
- number
|
||||
- The id of the file.
|
||||
|
||||
---
|
||||
|
||||
- fileName
|
||||
- string
|
||||
- The name of the file.
|
||||
|
||||
---
|
||||
|
||||
- notes
|
||||
- string
|
||||
- The notes for the attachment.
|
||||
|
||||
---
|
||||
|
||||
- storageLocation
|
||||
- string
|
||||
- The storage location of the file. Can be one of the following values: `Internal`, `OneDrive`, `GoogleDrive`.
|
||||
|
||||
{% /table %}
|
||||
|
||||
Reference in New Issue
Block a user