POST ExperimentGroup/GetFilteredExperimentGroupsOnly

Request Information

URI Parameters

None.

Body Parameters

GetFilteredExperimentGroupsOnlyInput
NameDescriptionTypeAdditional information
name

string

None.

years

Collection of integer

None.

cropIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "name": "sample string 1",
  "years": [
    1,
    2
  ],
  "cropIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<ExperimentGroupController.GetFilteredExperimentGroupsOnlyInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pioneer.Trials.Domain.TrialsAPIServices.Controllers">
  <cropIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </cropIds>
  <name>sample string 1</name>
  <years xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </years>
</ExperimentGroupController.GetFilteredExperimentGroupsOnlyInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ExperimentGroup
NameDescriptionTypeAdditional information
ExperimentGroupId

globally unique identifier

None.

GroupName

string

None.

Year

integer

None.

CropId

integer

None.

AddName

string

None.

AddDate

date

None.

LastMaintenanceName

string

None.

LastMaintenanceDate

date

None.

Crop

Crop

None.

ExperimentGrouping

Collection of ExperimentGrouping

None.

ChangeTracker

ObjectChangeTracker

None.

Response Formats

application/json, text/json

Sample:
[
  null,
  {
    "$id": "1",
    "ExperimentGroupId": "4842ad3c-a6be-448c-86a8-ddee184dbf40",
    "GroupName": "sample string 2",
    "Year": 3,
    "CropId": 4,
    "AddName": "sample string 5",
    "AddDate": "2024-12-08T16:01:40.4254275+00:00",
    "LastMaintenanceName": "sample string 7",
    "LastMaintenanceDate": "2024-12-08T16:01:40.4254275+00:00",
    "ExperimentGrouping": [
      {
        "$id": "2",
        "ExperimentId": "359b4453-c0e7-44a2-b8d1-d35a6240e760",
        "ExperimentGroupId": "4842ad3c-a6be-448c-86a8-ddee184dbf40",
        "LastMaintenanceName": "sample string 3",
        "LastMaintenanceDate": "2024-12-08T16:01:40.4254275+00:00",
        "ExperimentGroup": {
          "$ref": "1"
        },
        "ChangeTracker": {
          "$id": "3",
          "State": 2,
          "ObjectsRemovedFromCollectionProperties": {},
          "OriginalValues": {},
          "ExtendedProperties": {},
          "ObjectsAddedToCollectionProperties": {}
        }
      }
    ],
    "ChangeTracker": {
      "$id": "4",
      "State": 2,
      "ObjectsRemovedFromCollectionProperties": {},
      "OriginalValues": {},
      "ExtendedProperties": {},
      "ObjectsAddedToCollectionProperties": {
        "ExperimentGrouping": [
          {
            "$ref": "2"
          }
        ]
      }
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfExperimentGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pioneer.Trials.Domain.Model">
  <ExperimentGroup i:nil="true" />
  <ExperimentGroup z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
    <AddDate>2024-12-08T16:01:40.4254275+00:00</AddDate>
    <AddName>sample string 5</AddName>
    <ChangeTracker z:Id="i2">
      <ExtendedProperties />
      <ObjectsAddedToCollectionProperties>
        <AddedObjectsForProperty>
          <CollectionPropertyName>ExperimentGrouping</CollectionPropertyName>
          <AddedObjects>
            <ObjectValue z:Id="i3" i:type="ExperimentGrouping">
              <ChangeTracker z:Id="i4">
                <ExtendedProperties />
                <ObjectsAddedToCollectionProperties />
                <ObjectsRemovedFromCollectionProperties />
                <OriginalValues />
                <State>Added</State>
              </ChangeTracker>
              <Experiment i:nil="true" />
              <ExperimentGroup z:Ref="i1" />
              <ExperimentGroupId>4842ad3c-a6be-448c-86a8-ddee184dbf40</ExperimentGroupId>
              <ExperimentId>359b4453-c0e7-44a2-b8d1-d35a6240e760</ExperimentId>
              <LastMaintenanceDate>2024-12-08T16:01:40.4254275+00:00</LastMaintenanceDate>
              <LastMaintenanceName>sample string 3</LastMaintenanceName>
            </ObjectValue>
          </AddedObjects>
        </AddedObjectsForProperty>
      </ObjectsAddedToCollectionProperties>
      <ObjectsRemovedFromCollectionProperties />
      <OriginalValues />
      <State>Added</State>
    </ChangeTracker>
    <Crop i:nil="true" />
    <CropId>4</CropId>
    <ExperimentGroupId>4842ad3c-a6be-448c-86a8-ddee184dbf40</ExperimentGroupId>
    <ExperimentGrouping>
      <ExperimentGrouping z:Ref="i3" />
    </ExperimentGrouping>
    <GroupName>sample string 2</GroupName>
    <LastMaintenanceDate>2024-12-08T16:01:40.4254275+00:00</LastMaintenanceDate>
    <LastMaintenanceName>sample string 7</LastMaintenanceName>
    <Year>3</Year>
  </ExperimentGroup>
</ArrayOfExperimentGroup>