diff --git a/src/docs/version_001/docsStructure.ts b/src/docs/version_001/docsStructure.ts index ff87354..7dc7e6f 100644 --- a/src/docs/version_001/docsStructure.ts +++ b/src/docs/version_001/docsStructure.ts @@ -103,6 +103,12 @@ export const versionOne: DocsStructure = { }, ], }, + { + title: 'Records', + folder: 'records', + copy: 'copy.md', + example: 'example.md', + }, ], }, ], diff --git a/src/docs/version_001/resources/records/copy.md b/src/docs/version_001/resources/records/copy.md new file mode 100644 index 0000000..270511b --- /dev/null +++ b/src/docs/version_001/resources/records/copy.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 %} diff --git a/src/docs/version_001/resources/records/example.md b/src/docs/version_001/resources/records/example.md new file mode 100644 index 0000000..6428efb --- /dev/null +++ b/src/docs/version_001/resources/records/example.md @@ -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 %}