GetRelatedLotsFilterInformation response message
- Last UpdatedOct 24, 2024
- 3 minute read
This is an example of the full structure of a GetRelatedLotsFilterInformation response message.
<GetRelatedLotsFilterInformationResponse>
<Context>
<Localization/>
</Context>
<StartingFilters>
<FilterDetails>
<Filter>
<Name />
<DisplayName />
<LocalizedDisplayName" />
<ClrType />
<DisplayOrder />
<Category />
<SubCategory />
<AllowedValues />
<UsageType />
</Filter>
</FilterDetails>
</StartingFilters>
<ResultFilters>
<FilterDetails>
<Filter>
<Name />
<DisplayName />
<LocalizedDisplayName" />
<ClrType />
<DisplayOrder />
<Category />
<SubCategory />
<AllowedValues />
<UsageType />
</Filter>
</FilterDetails>
</ResultFilters>
</GetRelatedLotsFilterInformationResponse>
Response parameters: Localization section
The Localization section contains parameters that are relevant to localizing the data for display.
<Localization>
<Language>fr-FR</Language>
< /Localization>
|
Parameter |
Description |
|---|---|
|
Language |
The Windows regional setting to determine the language display of data in the client. This can be any Windows regional setting value, for example, en-AU, en-GB, fr-FR. If no language is specified, the default en-US is used. |
Response parameters: StartingFilters section
Contains the subset of starting filters.
<StartingFilters>
<FilterDetails>
<Filter>
<Name />
<DisplayName />
<LocalizedDisplayName" />
<ClrType />
<DisplayOrder />
<Category />
<SubCategory />
<AllowedValues />
<UsageType />
</Filter>
</FilterDetails>
</StartingFilters>
|
Parameter |
Description |
|---|---|
|
FilterDetails |
Contains the filter details. |
|
Filter |
Contains the details about an individual filter. |
|
Name |
The name given to identify an item in Studio. |
|
DisplayName |
The display name that appears in Production Analyst. |
|
LocalizedDisplayName |
The localized name that appears in Production Analyst. |
|
ClrType |
This value specifies the Common Language Runtime (CLR) type; it is much like a data type. For example, System.Int32, System.String, System.DateTime. |
|
DisplayOrder |
This value is a calculation that reflects the combined values of the DisplayOrderGroup and the DisplayOrderIndex to determine the order of display. |
|
Category |
The name of the category to group fields in, when displayed in user input forms. This is a string value. |
|
SubCategory |
The subcategory to group fields in, when displayed in user input forms. This is a string value. |
|
AllowedValues |
A string collection of values that are allowed for the field. |
|
UsageType |
This is a hidden field for standard fields only. It holds metadata about the usage of the field. For example, Material, Location, MovementDirection, AdjustmentMethod, EquipmentId. |
|
AssociatedModel |
The associated model type for this field. Valid values are: None, Equipment, Personnel, Material. |
Response parameters: ResultFilters section
Contains the subset of result filters.
<ResultFilters>
<FilterDetails>
<Filter>
<Name/>
<DisplayName/>
<LocalizedDisplayName"/>
<ClrType/>
<DisplayOrder/>
<Category/>
<SubCategory/>
<AllowedValues/>
<UsageType/>
</Filter>
</FilterDetails>
</ResultFilters>
|
Parameter |
Description |
|---|---|
|
FilterDetails |
Contains the filter details. |
|
Filter |
Contains the details about an individual filter. |
|
Name |
The name given to identify an item in Studio. |
|
DisplayName |
The display name that appears in Production Analyst. |
|
LocalizedDisplayName |
The localized name that appears in Production Analyst. |
|
ClrType |
This value specifies the Common Language Runtime (CLR) type; it is much like a data type. For example, System.Int32, System.String, System.DateTime. |
|
DisplayOrder |
This value is a calculation that reflects the combined values of the DisplayOrderGroup and the DisplayOrderIndex to determine the order of display. |
|
Category |
The name of the category to group fields in, when displayed in user input forms. This is a string value. |
|
SubCategory |
The subcategory to group fields in, when displayed in user input forms. This is a string value. |
|
AllowedValues |
A string collection of values that are allowed for the field. |
|
UsageType |
This is a hidden field for standard fields only. It holds metadata about the usage of the field. For example, Material, Location, MovementDirection, AdjustmentMethod, EquipmentId. |
|
AssociatedModel |
The associated model type for this field. Valid values are: None, Equipment, Personnel, Material. |