POST v1/ExternalApiLogDownload

User roles allowed to make this request: DomainAdministrator PowerUser GlobalDomainManager

Permissions required to make this request: ExternalApiLog.Read ExternalApi.Read

Create a request for the external api logs

Request Information

URI Parameters

None.

Body Parameters

ExternalApiMonitorModel
NameDescriptionTypeAdditional information
StartDate

The start date for the data requested by user.

 string

Required
EndDate

The end date for the data requested by user.

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "StartDate": "2015-11-05",
  "EndDate": "2015-11-05"
}

application/xml, text/xml

Sample: 
<SurveyDownloadDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <EndDate>2015-11-05</EndDate>
  <StartDate>2015-11-05</StartDate>
</SurveyDownloadDataModel>

application/x-www-form-urlencoded

Sample: 
StartDate=sample&EndDate=sample

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Response Message

BackgroundActivityStatus
NameDescriptionTypeAdditional 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>