POST api/ItemHeritageStudy/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",
    "ItemHeritageStudieId": 1,
    "ItemId": 2,
    "HeritageStudyId": 3,
    "Title": "sample string 4",
    "Year": 1,
    "Author": "sample string 5",
    "InspectedBy": "sample string 6",
    "DisplayGuidelinesFlag": "sample string 7",
    "OrganisationId": 1,
    "OrganisationName": "sample string 8",
    "CreatedByUser": "sample string 9",
    "CreatedDate": "2025-10-28T19:22:55.3873571+11:00",
    "ModifiedByUser": "sample string 10",
    "ModifiedDate": "2025-10-28T19:22:55.3873571+11:00",
    "InspectedDate": "2025-10-28T19:22:55.3873571+11:00",
    "RecommendedToStateSignificanceFlag": true,
    "ItemName": "sample string 11",
    "ItemTypeLovId": 1,
    "ItemTypeDescription": "sample string 12",
    "AddressSummary": "sample string 13",
    "GroupName": "sample string 14",
    "ParentItemId": 1,
    "StudyCode": "sample string 15",
    "StudyTypeLovId": 1,
    "StudyTypeDescription": "sample string 16"
  },
  {
    "$ref": "2"
  },
  {
    "$ref": "2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSvwItemHeritageStudyCSV xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SvwItemHeritageStudyCSV>
    <ItemHeritageStudieId>1</ItemHeritageStudieId>
    <ItemId>2</ItemId>
    <HeritageStudyId>3</HeritageStudyId>
    <Title>sample string 4</Title>
    <Year>1</Year>
    <Author>sample string 5</Author>
    <InspectedBy>sample string 6</InspectedBy>
    <DisplayGuidelinesFlag>sample string 7</DisplayGuidelinesFlag>
    <OrganisationId>1</OrganisationId>
    <OrganisationName>sample string 8</OrganisationName>
    <CreatedByUser>sample string 9</CreatedByUser>
    <CreatedDate>2025-10-28T19:22:55.3873571+11:00</CreatedDate>
    <ModifiedByUser>sample string 10</ModifiedByUser>
    <ModifiedDate>2025-10-28T19:22:55.3873571+11:00</ModifiedDate>
    <InspectedDate>2025-10-28T19:22:55.3873571+11:00</InspectedDate>
    <RecommendedToStateSignificanceFlag>true</RecommendedToStateSignificanceFlag>
    <ItemName>sample string 11</ItemName>
    <ItemTypeLovId>1</ItemTypeLovId>
    <ItemTypeDescription>sample string 12</ItemTypeDescription>
    <AddressSummary>sample string 13</AddressSummary>
    <GroupName>sample string 14</GroupName>
    <ParentItemId>1</ParentItemId>
    <StudyCode>sample string 15</StudyCode>
    <StudyTypeLovId>1</StudyTypeLovId>
    <StudyTypeDescription>sample string 16</StudyTypeDescription>
  </SvwItemHeritageStudyCSV>
  <SvwItemHeritageStudyCSV>
    <ItemHeritageStudieId>1</ItemHeritageStudieId>
    <ItemId>2</ItemId>
    <HeritageStudyId>3</HeritageStudyId>
    <Title>sample string 4</Title>
    <Year>1</Year>
    <Author>sample string 5</Author>
    <InspectedBy>sample string 6</InspectedBy>
    <DisplayGuidelinesFlag>sample string 7</DisplayGuidelinesFlag>
    <OrganisationId>1</OrganisationId>
    <OrganisationName>sample string 8</OrganisationName>
    <CreatedByUser>sample string 9</CreatedByUser>
    <CreatedDate>2025-10-28T19:22:55.3873571+11:00</CreatedDate>
    <ModifiedByUser>sample string 10</ModifiedByUser>
    <ModifiedDate>2025-10-28T19:22:55.3873571+11:00</ModifiedDate>
    <InspectedDate>2025-10-28T19:22:55.3873571+11:00</InspectedDate>
    <RecommendedToStateSignificanceFlag>true</RecommendedToStateSignificanceFlag>
    <ItemName>sample string 11</ItemName>
    <ItemTypeLovId>1</ItemTypeLovId>
    <ItemTypeDescription>sample string 12</ItemTypeDescription>
    <AddressSummary>sample string 13</AddressSummary>
    <GroupName>sample string 14</GroupName>
    <ParentItemId>1</ParentItemId>
    <StudyCode>sample string 15</StudyCode>
    <StudyTypeLovId>1</StudyTypeLovId>
    <StudyTypeDescription>sample string 16</StudyTypeDescription>
  </SvwItemHeritageStudyCSV>
  <SvwItemHeritageStudyCSV>
    <ItemHeritageStudieId>1</ItemHeritageStudieId>
    <ItemId>2</ItemId>
    <HeritageStudyId>3</HeritageStudyId>
    <Title>sample string 4</Title>
    <Year>1</Year>
    <Author>sample string 5</Author>
    <InspectedBy>sample string 6</InspectedBy>
    <DisplayGuidelinesFlag>sample string 7</DisplayGuidelinesFlag>
    <OrganisationId>1</OrganisationId>
    <OrganisationName>sample string 8</OrganisationName>
    <CreatedByUser>sample string 9</CreatedByUser>
    <CreatedDate>2025-10-28T19:22:55.3873571+11:00</CreatedDate>
    <ModifiedByUser>sample string 10</ModifiedByUser>
    <ModifiedDate>2025-10-28T19:22:55.3873571+11:00</ModifiedDate>
    <InspectedDate>2025-10-28T19:22:55.3873571+11:00</InspectedDate>
    <RecommendedToStateSignificanceFlag>true</RecommendedToStateSignificanceFlag>
    <ItemName>sample string 11</ItemName>
    <ItemTypeLovId>1</ItemTypeLovId>
    <ItemTypeDescription>sample string 12</ItemTypeDescription>
    <AddressSummary>sample string 13</AddressSummary>
    <GroupName>sample string 14</GroupName>
    <ParentItemId>1</ParentItemId>
    <StudyCode>sample string 15</StudyCode>
    <StudyTypeLovId>1</StudyTypeLovId>
    <StudyTypeDescription>sample string 16</StudyTypeDescription>
  </SvwItemHeritageStudyCSV>
</ArrayOfSvwItemHeritageStudyCSV>