docs: add records section to version 1
This commit is contained in:
@@ -103,6 +103,12 @@ export const versionOne: DocsStructure = {
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Records',
|
||||
folder: 'records',
|
||||
copy: 'copy.md',
|
||||
example: 'example.md',
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# Records {% #records %}
|
||||
|
||||
These are objects representing a content record in your instance. You can create new records in your instance, retrieve existing records to see the data that has been entered into a record, you can update a record to change the data in it, and you can delete a record to remove it from the instance.
|
||||
|
||||
## Record Properties
|
||||
|
||||
{% table %}
|
||||
|
||||
- Property Name
|
||||
- Data Type
|
||||
- Description
|
||||
|
||||
---
|
||||
|
||||
- AppId
|
||||
- `number`
|
||||
- The id of the app or survey.
|
||||
|
||||
---
|
||||
|
||||
- RecordId
|
||||
- `number`
|
||||
- The id of the record.
|
||||
|
||||
---
|
||||
|
||||
- FieldData
|
||||
- `object[]`
|
||||
- An array of [Field Value](#field-values) objects.
|
||||
|
||||
{% /table %}
|
||||
@@ -0,0 +1,19 @@
|
||||
# The Record Object
|
||||
|
||||
{% code heading="RECORD" defaultLanguage="json" %}
|
||||
|
||||
```json
|
||||
{
|
||||
"AppId": 130,
|
||||
"RecordId": 11,
|
||||
"FieldData": [
|
||||
{
|
||||
"Type": 1,
|
||||
"FieldId": 4745,
|
||||
"Value": 11
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
{% /code %}
|
||||
Reference in New Issue
Block a user