POST {version}/GetEntitiesFromExpression
Get Entities From Expression
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
FilterName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
Name | string |
None. |
|
ExpressionId | globally unique identifier |
None. |
|
Description | string |
None. |
|
Internal | boolean |
None. |
|
Inactive | boolean |
None. |
|
CreatedOn | date |
None. |
|
UpdatedOn | date |
None. |
|
LastModifiedOn | date |
None. |
|
ToBeDeleted | boolean |
None. |
|
SubOptions | Collection of FilterOptionDefinitionSubOption |
None. |
|
Columns | Collection of FilterColumnAssociation |
None. |
|
DataFilter | string |
None. |
|
SortCol | string |
None. |
|
SortAsc | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": "26692b27-c386-4fda-a2eb-b5866840c8f2", "Name": "sample string 2", "ExpressionId": "0959fb20-50c9-496e-b189-66bbecc1de91", "Description": "sample string 3", "Internal": true, "Inactive": true, "CreatedOn": "10/16/2024", "UpdatedOn": "10/16/2024", "LastModifiedOn": "10/16/2024", "ToBeDeleted": true, "SubOptions": [ { "Id": "c8b3a331-c1b6-4531-8fca-395cf045e9de", "DefId": "802ec92b-c3dc-43df-93b0-0b1aa8f1a115", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 }, { "Id": "c8b3a331-c1b6-4531-8fca-395cf045e9de", "DefId": "802ec92b-c3dc-43df-93b0-0b1aa8f1a115", "Type": "sample string 3", "Text": "sample string 4", "SelectedValue": "sample string 5", "Order": 6 } ], "Columns": [ { "Id": "5052d527-0b75-4831-980d-846e8bec2b81", "FilterId": "f79435e5-c5be-4e73-adb4-6cf2e2f38403", "ColumnId": "331fe2c3-0f91-4e4d-ae31-7fcc45a9edf3", "Order": 4, "DynamicId": "sample string 5" }, { "Id": "5052d527-0b75-4831-980d-846e8bec2b81", "FilterId": "f79435e5-c5be-4e73-adb4-6cf2e2f38403", "ColumnId": "331fe2c3-0f91-4e4d-ae31-7fcc45a9edf3", "Order": 4, "DynamicId": "sample string 5" } ], "DataFilter": "sample string 8", "SortCol": "sample string 9", "SortAsc": true }
application/xml, text/xml
Sample:
<Filter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model.Contact"> <Columns> <FilterColumnAssociation> <ColumnId>331fe2c3-0f91-4e4d-ae31-7fcc45a9edf3</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>f79435e5-c5be-4e73-adb4-6cf2e2f38403</FilterId> <Id>5052d527-0b75-4831-980d-846e8bec2b81</Id> <Order>4</Order> </FilterColumnAssociation> <FilterColumnAssociation> <ColumnId>331fe2c3-0f91-4e4d-ae31-7fcc45a9edf3</ColumnId> <DynamicId>sample string 5</DynamicId> <FilterId>f79435e5-c5be-4e73-adb4-6cf2e2f38403</FilterId> <Id>5052d527-0b75-4831-980d-846e8bec2b81</Id> <Order>4</Order> </FilterColumnAssociation> </Columns> <CreatedOn>2024-10-16T12:22:00.8548212-04:00</CreatedOn> <DataFilter>sample string 8</DataFilter> <Description>sample string 3</Description> <ExpressionId>0959fb20-50c9-496e-b189-66bbecc1de91</ExpressionId> <Id>26692b27-c386-4fda-a2eb-b5866840c8f2</Id> <Inactive>true</Inactive> <Internal>true</Internal> <Name>sample string 2</Name> <SortAsc>true</SortAsc> <SortCol>sample string 9</SortCol> <SubOptions> <FilterOptionDefinitionSubOption> <DefId>802ec92b-c3dc-43df-93b0-0b1aa8f1a115</DefId> <Id>c8b3a331-c1b6-4531-8fca-395cf045e9de</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> <FilterOptionDefinitionSubOption> <DefId>802ec92b-c3dc-43df-93b0-0b1aa8f1a115</DefId> <Id>c8b3a331-c1b6-4531-8fca-395cf045e9de</Id> <Order>6</Order> <SelectedValue>sample string 5</SelectedValue> <Text>sample string 4</Text> <Type>sample string 3</Type> </FilterOptionDefinitionSubOption> </SubOptions> <ToBeDeleted>true</ToBeDeleted> <UpdatedOn>2024-10-16T12:22:00.8548212-04:00</UpdatedOn> </Filter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Get Entities From Expression
Collection of globally unique identifierResponse Formats
application/json, text/json
Sample:
[ "49a707ad-025c-431f-99ae-baf4a81a75bf", "3ebce698-5035-4abd-b391-4bf55b63837e" ]
application/xml, text/xml
Sample:
<ArrayOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <guid>49a707ad-025c-431f-99ae-baf4a81a75bf</guid> <guid>3ebce698-5035-4abd-b391-4bf55b63837e</guid> </ArrayOfguid>