POST api/HeritageStudy/search-download-csv

No documentation available.

Request Information

Parameters

Name	Description	Additional information
request	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "Filters": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "<Field>k__BackingField": "sample string 1",
        "<Operator>k__BackingField": "sample string 2",
        "<Value>k__BackingField": {
          "$id": "4"
        },
        "<Logic>k__BackingField": "sample string 4",
        "<Filters>k__BackingField": {
          "$id": "5",
          "$values": [
            {
              "$ref": "3"
            },
            {
              "$ref": "3"
            },
            {
              "$ref": "3"
            }
          ]
        }
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "Page": 1,
  "PageSize": 2,
  "Sort": {
    "$id": "6",
    "Field": "sample string 1",
    "Dir": "sample string 2",
    "SecondaryField": "sample string 3",
    "SecondaryDir": "sample string 4",
    "ThirdField": "sample string 5",
    "ThirdDir": "sample string 6"
  },
  "PreviousPageSize": 3
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DataSearchRequest'.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "$id": "2",
    "HeritageStudyId": 1,
    "Title": "sample string 2",
    "StudyCode": "sample string 3",
    "StudyTypeLovId": 1,
    "StudyTypeLovIdDescription": "sample string 4",
    "Year": 1,
    "OrganizationId": 1,
    "OrganizationName": "sample string 5",
    "Author": "sample string 6",
    "StakeholderId": 1,
    "Sites": "sample string 7",
    "ItemId": 1
  },
  {
    "$ref": "2"
  },
  {
    "$ref": "2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSvwHeritageStudyCSV xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SvwHeritageStudyCSV>
    <HeritageStudyId>1</HeritageStudyId>
    <Title>sample string 2</Title>
    <StudyCode>sample string 3</StudyCode>
    <StudyTypeLovId>1</StudyTypeLovId>
    <StudyTypeLovIdDescription>sample string 4</StudyTypeLovIdDescription>
    <Year>1</Year>
    <OrganizationId>1</OrganizationId>
    <OrganizationName>sample string 5</OrganizationName>
    <Author>sample string 6</Author>
    <StakeholderId>1</StakeholderId>
    <Sites>sample string 7</Sites>
    <ItemId>1</ItemId>
  </SvwHeritageStudyCSV>
  <SvwHeritageStudyCSV>
    <HeritageStudyId>1</HeritageStudyId>
    <Title>sample string 2</Title>
    <StudyCode>sample string 3</StudyCode>
    <StudyTypeLovId>1</StudyTypeLovId>
    <StudyTypeLovIdDescription>sample string 4</StudyTypeLovIdDescription>
    <Year>1</Year>
    <OrganizationId>1</OrganizationId>
    <OrganizationName>sample string 5</OrganizationName>
    <Author>sample string 6</Author>
    <StakeholderId>1</StakeholderId>
    <Sites>sample string 7</Sites>
    <ItemId>1</ItemId>
  </SvwHeritageStudyCSV>
  <SvwHeritageStudyCSV>
    <HeritageStudyId>1</HeritageStudyId>
    <Title>sample string 2</Title>
    <StudyCode>sample string 3</StudyCode>
    <StudyTypeLovId>1</StudyTypeLovId>
    <StudyTypeLovIdDescription>sample string 4</StudyTypeLovIdDescription>
    <Year>1</Year>
    <OrganizationId>1</OrganizationId>
    <OrganizationName>sample string 5</OrganizationName>
    <Author>sample string 6</Author>
    <StakeholderId>1</StakeholderId>
    <Sites>sample string 7</Sites>
    <ItemId>1</ItemId>
  </SvwHeritageStudyCSV>
</ArrayOfSvwHeritageStudyCSV>