ON-43626 # Added docs for submission data developer keys

docs/README.md

@@ -37,7 +37,7 @@ The majority of actions in this SDK require that your developer key has particul
 
 ### Developer Key & Role
 
-Actions that require a developer key with a minimum role permission will have the following in the function definition:
+Actions that allow a developer key with a minimum role permission will have the following in the function definition:
 
 **Minimum Role Permission**
 
@@ -56,6 +56,10 @@ In the case of any actions relating to forms, the assigned app must be associate
 - For _Tiles_ or _Forms List_ type apps, the form can be assigned to an action in a _Scheduled task_.
 - For _Approvals_ type apps, the form can be an _Approval form_.
 
+**Submission Data Key Supported**
+
+In the case of any actions relating to retrieving form submission data, a Submission Data developer key can be used so long as the developer key has been assigned to the form that is being actioned.
+
 ## Clients
 
 - [FormsClient](./forms-client.md)

docs/approvals-client.md

@@ -61,6 +61,10 @@ GetFormSubmissionAdministrationApprovalsResponse response = await approvalsClien
 
 A `GetFormSubmissionAdministrationApprovalsResponse` Object
 
+**Submission Data Key Supported**
+
+Results will be restricted to approvals associated with forms that have been assigned to the Key.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_
@@ -89,6 +93,10 @@ GetFormSubmissionApprovalResponse response = await approvalsClient.GetFormSubmis
 
 A `GetFormSubmissionApprovalResponse` Object
 
+**Submission Data Key Supported**
+
+Key must be assigned to the form that was submitted for approval.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_
@@ -117,6 +125,10 @@ GetFormApprovalFlowInstanceResponse response = await approvalsClient.GetFormAppr
 
 A `GetFormApprovalFlowInstanceResponse` Object
 
+**Submission Data Key Supported**
+
+Key must be assigned to the form that was submitted for approval.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_

docs/data-manager-client.md

@@ -46,6 +46,10 @@ FormStoreDefinition response = await approvalsClient.GetFormDefinition(formId);
 
 A `FormStoreDefinition` Object
 
+**Submission Data Key Supported**
+
+Key must be assigned to the form that submission data is being requested for.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_
@@ -89,6 +93,10 @@ FormStoreSearchResult<SubmissionResult> response = await dataManagerClient.Searc
 
 A `FormStoreSearchResult<T>` Object
 
+**Submission Data Key Supported**
+
+Key must be assigned to the form that is being requested.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_

docs/forms-client.md

@@ -121,6 +121,10 @@ Console.WriteLine("Submission as JSON string: " + formSubmission.submission);
 
 A `FormSubmission<T>` class or `null`
 
+**Submission Data Key Supported**
+
+Key must be assigned to the form that was submitted
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_
@@ -194,6 +198,10 @@ OneBlink.SDK.Model.FormSubmissionSearchResult response = await formsClient.Searc
 
 A `FormSubmissionSearchResult` class
 
+**Submission Data Key Supported**
+
+Results will be restricted to forms that have been assigned to the Key.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_
@@ -242,6 +250,10 @@ OneBlink.SDK.Model.FormSubmissionSearchResult response = await formsClient.Searc
 
 A `FormSubmissionSearchResult` class
 
+**Submission Data Key Supported**
+
+Results will be restricted to forms that have been assigned to the Key.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_
@@ -282,6 +294,10 @@ OneBlink.SDK.Model.FormSubmissionSearchResult response = await formsClient.Searc
 
 A `FormSubmissionSearchResult` class
 
+**Submission Data Key Supported**
+
+Results will be restricted to forms that have been assigned to the Key.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_
@@ -320,6 +336,10 @@ OneBlink.SDK.Model.FormSubmissionSearchResult response = await formsClient.Searc
 
 A `FormSubmissionSearchResult` class
 
+**Submission Data Key Supported**
+
+Results will be restricted to forms that have been assigned to the Key.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_
@@ -511,6 +531,10 @@ SubmissionDataUrl submissionDataUrl = await formsClient.GenerateSubmissionDataUr
 
 A `OneBlink.SDK.Model.SubmissionDataUrl` class
 
+**Submission Data Key Supported**
+
+Key must be assigned to the form that was submitted.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_
@@ -539,6 +563,10 @@ Stream attachmentStream = await formsClient.GetFormSubmissionAttachment(formId,
 
 A `System.IO.Stream` class
 
+**Submission Data Key Supported**
+
+Key must be assigned to the form that the attachment was uploaded for.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_
@@ -567,6 +595,10 @@ FormAttachmentMeta meta = await formsClient.GetFormSubmissionAttachmentMeta(form
 
 A `FormAttachmentMeta` class
 
+**Submission Data Key Supported**
+
+Key must be assigned to the form that the attachment was uploaded for.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_
@@ -629,6 +661,10 @@ SubmissionDataUrl submissionDataUrl = await formsClient.GenerateSubmissionAttach
 
 A `OneBlink.SDK.Model.SubmissionDataUrl` class
 
+**Submission Data Key Supported**
+
+Key must be assigned to the form that the attachment was uploaded for.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_
@@ -659,6 +695,10 @@ SubmissionDataUrl submissionDataUrl = await formsClient.GenerateWorkflowAttachme
 
 A `OneBlink.SDK.Model.SubmissionDataUrl` class
 
+**Submission Data Key Supported**
+
+Key must be assigned to the form that the attachment was uploaded for.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_
@@ -720,6 +760,10 @@ OneBlink.SDK.Model.FormSubmissionMetadataResponse formSubmissionMetadataResponse
 
 A `FormSubmissionMetadataResponse` class
 
+**Submission Data Key Supported**
+
+Key must be assigned to the form that was submitted.
+
 **Minimum Role Permission**
 
 Submission Data: _Read Only_

docs/pdf-client.md

@@ -59,9 +59,13 @@ Stream response = await pdfClient.GetSubmissionPdf(formId, submissionId);
 
 A `Stream` object
 
+**Submission Data Key Supported**
+
+Key must be assigned to the form that was submitted.
+
 **Minimum Role Permission**
 
-PDF Generation: _On_
+Submission Data: _Read Only_
 
 ## `GeneratePdf()`
 
@@ -128,4 +132,4 @@ A `Stream` object
 
 **Minimum Role Permission**
 
-Submission Data: _Read Only_
+PDF Generation: _On_