diff --git a/src/docs/version_002/docsStructure.ts b/src/docs/version_002/docsStructure.ts index 1c3a411..dff82e0 100644 --- a/src/docs/version_002/docsStructure.ts +++ b/src/docs/version_002/docsStructure.ts @@ -104,6 +104,13 @@ export const versionTwo: DocsStructure = { }, ], }, + { + title: 'Fields', + folder: 'fields', + copy: 'copy.md', + example: 'example.md', + children: [], + }, { title: 'Records', folder: 'records', diff --git a/src/docs/version_002/resources/fields/copy.md b/src/docs/version_002/resources/fields/copy.md new file mode 100644 index 0000000..5f64c38 --- /dev/null +++ b/src/docs/version_002/resources/fields/copy.md @@ -0,0 +1,55 @@ +# Fields {% #fields %} + +These are objects representing a field in an app or survey in your instance. You can retrieve a list of fields in an app or survey or retrieve a specific field to see the properties of the field(s). + +## Field Properties + +{% table %} + +- Property Name +- Data Type +- Description + +--- + +- id +- `number` +- The id of the field. + +--- + +- appId +- `number` +- The id of the app or survey. + +--- + +- name +- `string` +- The name of the field. + +--- + +- type +- `string` +- The type of the field. Possible values are: `Attachment`, `AutoNumber`, `Date`, `Formula`, `Image`, `List`, `Number`, `Reference`, `SurveyCampaign`, `SurveyGroupScoring`, `SurveyReference`, `SurveyUnifiedAnswer`,`Text`, or `TimeSpan`. + +--- + +- status +- `string` +- The status of the field. Possible values are: `Enabled` or `Disabled`. + +--- + +- isRequired +- `boolean` +- Indicates whether the field is configured to be required. + +--- + +- isUnique +- `boolean` +- Indicates whether the field is configured to be unique. + +{% /table %} diff --git a/src/docs/version_002/resources/fields/example.md b/src/docs/version_002/resources/fields/example.md new file mode 100644 index 0000000..f0ccbcf --- /dev/null +++ b/src/docs/version_002/resources/fields/example.md @@ -0,0 +1,17 @@ +# The Field Object + +{% code heading="FIELD" defaultLanguage="json" %} + +```json +{ + "id": 6983, + "appId": 195, + "name": "Name", + "type": "Text", + "status": "Enabled", + "isRequired": false, + "isUnique": false +} +``` + +{% /code %}