POST v1/Surveys/{surveyId}/SampleDataDownload/{fileName}
User roles allowed to make this request:
DomainAdministrator
PowerUser
RegularUser
LimitedUser
OperationsUser
SampleManager
DemoUser
Permissions required to make this request:
SampleRecord.Read
Survey.Read
Supports survey simulations
Create a request for a sample data download.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
surveyId |
id of the survey |
string |
Required |
fileName |
file name |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
The activity ID can be used with the BackgroundActivities endpoint to request the status and other information.
Response Message
BackgroundActivityStatusName | Description | Type | Additional information |
---|---|---|---|
ActivityId |
The id of the started activity |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ActivityId": "sample string 1" }
application/xml, text/xml
Sample:
<BackgroundActivityStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models"> <ActivityId>sample string 1</ActivityId> </BackgroundActivityStatus>