Setting Up the Export Pricing Web Service

Objectives

After completing this lesson, you will be able to:
  • Explain how to configure authentication for the export pricing web service.
  • Explain how to define the responses received from the export pricing web service.

Export Pricing Updates Request

NameDescription
HTTP MethodGET
Authentication

The client must use HTTP Basic Authentication and send the following credentials in an HTTP authorization header, base64 encoded: Basic <base64 encoded myAribaSiteName:password>

Where:

  • myAribaSiteName is your SAP Ariba site name for the SAP Ariba Sourcing solution. If you do not know your site name, you can get it from your SAP Ariba representative.
  • password matches the password value configured on the SAP Ariba Integration Toolkit Security page.
URL

Use the following URL format to request all changes and updates to pricing data within a specific data type in a specified time period to a URL in the following format:

https://mySAPAribaSourcingDomain/dms/extract/v2/objectType?realm=mySAPAribaSiteName&fromdate=startDate&todate=endDate

Export Pricing Updates Web Service Query Parameters

The following are the export pricing updates web service query parameters:

  • myAribaSourcingDomain is the domain you see in your browser's address window when you are logged in to SAP Ariba Strategic Sourcing Suite, such as myCompany.sourcing.ariba.com.
  • The realm where the data is exported from is mandatory.
  • myAribaSiteName is your SAP Ariba site name for the SAP Ariba Strategic Sourcing Suite solution. If you do not know your site name, you can get it from your SAP Ariba representative.
  • The fromdate is the lower boundary of the exported objects and is optional. The timeCreated and timeUpdated timestamp of the object is used for fromdate validation. Objects with timeCreated or timeUpdated greater than or equal to fromdate are exported. If fromdate is omitted, only the todate is validated.

    Note

    The fromdate cannot be a future date.
  • The todate is the upper boundary of the exported objects and is mandatory. The timeCreated and timeUpdated timestamp of the object is used for todate validation. Objects with timeCreated or timeUpdated less than todate are exported.

    Note

    The todate cannot be a future date.

  • The objectType values include:
    • All
    • RFX
    • RFXItem
    • RFXItemSupplier
    • RFXStandardTerm
    • RFXCustomTerm
    • Item
    • ItemPrice
    • ItemAMLSplit
    • Bom
    • ItemAttribute
    • BomSplit
    • ItemPlant
    • ItemProgram
    • Plant
    • Program
    • ItemLeadTime
    • ItemAML
    • CustomFieldsList
    • Summary

Note

The objectType values are not case sensitive in the URL.

Export Pricing Updates Error Response

An export pricing updates response contains a sequence of the following child elements within an ItemInfo element:

  • Error (only if an error occurs)
  • SystemDate
  • RFXList
  • RFXItemList
  • RFXItemSupplierList
  • RFXStandardTermList
  • RFXCustomTermList
  • ItemList
  • ItemPriceList
  • ItemAMLSplitList
  • BomList
  • ItemAttributeList
  • BomSplitList
  • ItemPlantList
  • ItemProgramList
  • PlantList
  • ProgramList
  • ItemLeadTimeList
  • ItemAMLList
  • Summary

If the URL for the export web pricing updates request did not include an object parameter, the SystemDate and all list elements, such as RFXList and ItemList, are included. If an object parameter was included, only the SystemDate and specified list element is included.

Log in to track your progress & complete quizzes