From 35967cc04e92d1823a6258939d33de2aae3e4f98 Mon Sep 17 00:00:00 2001 From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com> Date: Fri, 21 Apr 2023 15:57:20 -0500 Subject: [PATCH] docs: add examples for relationship section --- src/docs/version_002/relationships/example.md | 50 ++++++++++++++++--- 1 file changed, 44 insertions(+), 6 deletions(-) diff --git a/src/docs/version_002/relationships/example.md b/src/docs/version_002/relationships/example.md index c5337aa..096437f 100644 --- a/src/docs/version_002/relationships/example.md +++ b/src/docs/version_002/relationships/example.md @@ -3,7 +3,8 @@ {% code heading="GET GROUP RECORD" defaultLanguage="bash" %} ```bash - +curl --location 'https://api.onspring.com/Records/appId/3/recordId/3' \ +--header 'X-ApiKey: 000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000' ``` {% /code %} @@ -11,7 +12,17 @@ {% code heading="GROUP" defaultLanguage="json" %} ```json - +{ + "appId": 3, + "recordId": 3, + "fieldData": [ + { + "type": "IntegerList", + "fieldId": 21, // Users multi select reference field + "value": [2216] + } + ] +} ``` {% /code %} @@ -19,7 +30,8 @@ {% code heading="GET USERS REFERENCE FIELD" defaultLanguage="bash" %} ```bash - +curl --location 'https://api.onspring.com/Fields/id/21' \ +--header 'X-ApiKey: 000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000' ``` {% /code %} @@ -27,7 +39,17 @@ {% code heading="REFERENCE FIELD" defaultLanguage="json" %} ```json - +{ + "multiplicity": "MultiSelect", + "referencedAppId": 2, // Users app id + "id": 21, + "appId": 3, + "name": "Users", + "type": "Reference", + "status": "Enabled", + "isRequired": false, + "isUnique": false +} ``` {% /code %} @@ -35,7 +57,8 @@ {% code heading="GET USER RECORD" defaultLanguage="bash" %} ```bash - +curl --location 'https://api.onspring.com/Records/appId/2/recordId/2216' \ +--header 'X-ApiKey: 000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000' ``` {% /code %} @@ -43,7 +66,22 @@ {% code heading="USER" defaultLanguage="json" %} ```json - +{ + "appId": 2, + "recordId": 2216, + "fieldData": [ + { + "type": "String", + "fieldId": 36, + "value": "TestUser" + }, + { + "type": "String", + "fieldId": 33, + "value": "stevan.freeborn@onspring.com" + } + ] +} ``` {% /code %}