IBM Support

Using Extension Attribute for OrderBy element in an API Call

Question & Answer


Question

How do you use an Extension Attribute for OrderBy element in an API Call in IBM Sterling Selling and Fulfillment Suite?

Cause

You are unable to access the extended attributes.

Answer

Extended attributes have to be part of Extn element. Else they cannot be accessed. So, in this case, inside Orderby element, you need an Extn element and inside that you need Attribute element.

Please find below a sample input xml with various kinds of OrderBy clauses
-----------------------------------
<Page  PageSize="10" PaginationStrategy="NEXTPAGE">
    <API Name="getItemListForOrdering">
        <Input>
            <Item CallingOrganizationCode="DEFAULT"
IgnoreInvalidItems="N" InheritAttributesFromClassification="Y"
ItemGroupCode="PROD" ItemIDQryType="FLIKE">
                <ItemAttributeGroupTypeList>
                    <ItemAttributeGroupType
ClassificationPurposeCode="DISPLAY_ATTRIBUTES"/>
                </ItemAttributeGroupTypeList>
                <OrderBy>
                    <Attribute Desc="Y" Name="ShortDescription"/>
                    <Attribute Desc="Y" Name="Description"/>
                     <Extn>
                    <Attribute Desc="Y" Name="ExtnReturnPolicy"/>
                     </Extn>
                </OrderBy>
            </Item>
        </Input>
    <Template>
            <ItemList TotalItemList="" TotalNumberOfRecords="">
                <Item CanUseAsServiceTool="" GlobalItemID=""
InheritAttributesFromClassification="" IsItemSuperseded=""
ItemGroupCode="" ItemID="" ItemKey="" MaxModifyTS=""
OrganizationCode="Required" SubCatalogOrganizationCode=""
UnitOfMeasure="">
                    <Extn/>
                    <PrimaryInformation Description=""
ShortDescription=""/>
                </Item>
            </ItemList>
        </Template>
    </API>
</Page>
-----------------------------------

[{"Product":{"code":"SS6PEW","label":"IBM Sterling Order Management"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Component":"Distributed Order Management","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All","Edition":"","Line of Business":{"code":"LOB59","label":"Sustainability Software"}}]

Document Information

Modified date:
16 June 2018

UID

swg21984342