SOAP Web Service API Integration Guide SOAP+web+service+API+integration+guide

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 158 [warning: Documents this large are best viewed by clicking the View PDF Link!]

CONFIDENTIAL
2018-07
SOAP web service API integration guide
SAP Ariba Contracts
SAP Ariba Sourcing
SAP Ariba Strategic Sourcing Suite
SAP Ariba Supplier Information and Performance Management
SAP Ariba Supplier Lifecycle and Performance
Content
Using SOAP Web Service APIs for Data Integration..................................... 5
About SAP Ariba SOAP Web Service APIs...............................................5
SAP Ariba SOAP Web Services Integration Tasks and End Points...............................6
Contract Project Operations......................................................6
Sourcing Event and Sourcing Project Operations....................................... 7
Knowledge Project Operation.....................................................8
Document Operations..........................................................9
User, Organization, and Supplier Operations.......................................... 9
SOAP Web Service APIs Use Cases...................................................10
SAP Ariba Sourcing...........................................................10
SAP Ariba Contracts...........................................................11
Limitations for SOAP Web Service APIs................................................11
Using SOAP web service APIs for supplier data integration with the unied vendor model............ 12
Data ow for supplier data loaded through SOAP web service APIs into the unied vendor model
......................................................................... 13
Supplier organization data synchronization to the unied vendor model...................... 14
Organization ID synchronization to ERP vendor IDs in the unied vendor model.................15
Supplier user synchronization to the unied vendor model................................16
Synchronization of supplier prole questionnaire data to the supplier registration questionnaire
......................................................................... 17
Authentication and Security for SOAP Web Service APIs....................................17
Workow for SOAP Web Service APIs.................................................18
Collecting Access and Security Information for Web Services................................20
Conguring an End Point for SOAP Web Services.........................................20
Enabling a SOAP Integration Task....................................................21
Generating a WSDL File...........................................................22
Enabling External Exports for Workspace IDs............................................22
Enabling External Exports for Contract Terms...........................................23
Enabling External Document Uploads for the User Interface.................................23
Enabling Export RFX Awards Tasks...................................................24
Conguring Email Notications for Outbound Web Services.................................24
About Web Service Email Notications................................................25
Export WorkspaceId Email Notications.............................................25
Export RFX Awards Email Notications.............................................26
Disabling Integration Tasks........................................................26
Web Service Elements and Examples............................................... 27
2CONFIDENTIAL
SOAP web service API integration guide
Content
Common SOAP Web Service Header Elements.......................................... 27
Common SOAP Web Service Body Elements............................................27
Country, Currency, BaseLanguage, and LocaleID Elements...............................28
ContractId and WorkspaceId Elements for Contract Workspaces...........................28
OnBehalfUserId and OnBehalfUserPasswordAdapter Elements............................28
XSD DateTime Elements....................................................... 29
Custom Body Elements for SOAP Web Services......................................... 30
Omitting Custom Web Service Elements for Projects without Custom Fields...................30
Using Custom Web Service Elements for Projects with Custom Fields........................31
SOAP Web Services for Contract Projects..............................................36
Download Contract Header Fields.................................................37
Download Contract Terms......................................................40
Export Contract Terms.........................................................41
Export WorkspaceId...........................................................42
Import CLID using XML........................................................44
Import Contract Line Items Document............................................. 48
Import Internal Contract Workspace...............................................50
Import Procurement Contract Request and Import Procurement Contract Workspace............56
Import Sales Contract Request and Import Sales Contract Workspace.......................61
SOAP Web Services for Sourcing Events and Projects......................................67
DocumentStatusChangeNotication...............................................68
DocumentURLOutBound....................................................... 71
Download RFX Awards.........................................................81
Download RFX Awards with Filters.................................................82
Export RFX Awards...........................................................84
Import Sourcing Event.........................................................85
Import Sourcing Project........................................................90
SOAP Web Service for Knowledge Projects.............................................94
Import Knowledge Project...................................................... 94
SOAP Web Services for Documents.................................................. 97
Download Workspace Documents.................................................97
Download Document IDs.......................................................98
Import Document........................................................... 100
Import Form Document........................................................101
SOAP Web Services for Managing Users, Organizations, and Suppliers.........................101
Add Users to Group.......................................................... 102
remove user from group.......................................................102
Export Organizations.........................................................104
Export Supplier Proles....................................................... 105
Import Organizations.........................................................107
Import Supplier Proles....................................................... 110
SOAP web service API integration guide
Content CONFIDENTIAL 3
Import Users............................................................... 111
Remove Organizations........................................................ 113
Remove Users.............................................................. 114
SOAP Web Service Status and Error Message Values......................................115
Web Service Example: Creating a Procurement Contract Workspace...........................117
Import Procurement Contract Workspace Request Message..............................117
Import Procurement Contract Workspace Response................................... 121
Web Service Examples: Creating Sourcing Events........................................121
Creating a Sourcing Event without a Full Sourcing Project................................122
Creating a Sourcing Event Without a Full Project......................................122
Creating an Event with a Full Sourcing Project........................................125
Creating a Sourcing Event in a Full Project...........................................126
Web Service Example: Creating a Project with Custom Fields................................127
Contract Data File Formats......................................................130
Contract header le format.......................................................130
Contract Terms Export File Format..................................................132
Excel format for contract line items documents.........................................132
Sourcing Data File Formats......................................................137
Sourcing Import File Formats......................................................137
Sourcing Export File Formats......................................................137
Event Data.................................................................138
RFX Award Data.............................................................140
Managing Integration Migration..................................................144
About Integration Migration Management.............................................144
Integration Migration Management Workow........................................ 145
Reviewing and Accepting Changes to Data Denitions.....................................145
Data Denition Change Example.................................................146
Reverting Accepted Changes to Data Denitions.........................................147
Reviewing Data Denitions in the Data Dictionary........................................148
Reviewing Data Denitions in a WSDL................................................149
Site Conguration Options for Integration Services...................................150
Site conguration parameters for synchronization of supplier data with the unied vendor
model......................................................................152
Revision History..............................................................153
4CONFIDENTIAL
SOAP web service API integration guide
Content
Using SOAP Web Service APIs for Data
Integration
In this section:
About SAP Ariba SOAP Web Service APIs [page 5]
SAP Ariba SOAP Web Services Integration Tasks and End Points [page 6]
SOAP Web Service APIs Use Cases [page 10]
Limitations for SOAP Web Service APIs [page 11]
Using SOAP web service APIs for supplier data integration with the unied vendor model [page 12]
Authentication and Security for SOAP Web Service APIs [page 17]
Workow for SOAP Web Service APIs [page 18]
Collecting Access and Security Information for Web Services [page 20]
Conguring an End Point for SOAP Web Services [page 20]
Enabling a SOAP Integration Task [page 21]
Generating a WSDL File [page 22]
Enabling External Exports for Workspace IDs [page 22]
Enabling External Exports for Contract Terms [page 23]
Enabling External Document Uploads for the User Interface [page 23]
Enabling Export RFX Awards Tasks [page 24]
Conguring Email Notications for Outbound Web Services [page 24]
About Web Service Email Notications [page 25]
Disabling Integration Tasks [page 26]
About SAP Ariba SOAP Web Service APIs
SAP Ariba SOAP web service APIs enable you to exchange data between SAP Ariba Strategic Sourcing solutions
and other systems, such as ERP systems, for real-time data integration. In many cases, the SAP Ariba web services
are used between the SAP Ariba solution and an intermediary Enterprise Application Integration (EAI) system that
handles web service communication for an ERP system. For simplicity, the term “ERP” is used in this chapter to
refer to either an EAI or an ERP system.
SAP Ariba SOAP web services use the W3C SOAP messaging framework to exchange messages over HTTP or
HTTPS. If you are using an outbound web service (a service initiated by the SAP Ariba solution), SAP Ariba strongly
recommends that you use SAP Ariba SOAP web services over an HTTPS link to the ERP system. For more
information, see Authentication and Security for Web Services [page 17].
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration CONFIDENTIAL 5
The SAP Ariba Integration Manager generates descriptions of the SAP Ariba SOAP web services operations in the
Web Services Description Language (WSDL), an XML-based language. Typically, developers on the ERP system use
the WSDL descriptions when creating applications to communicate with SAP Ariba SOAP web services. There are
numerous software development packages that can read WSDL les and use them to create web service clients.
SAP Ariba oers integration services to implement an end-to-end solution for you using SAP Ariba web services. If
you are interested in using SAP Ariba integration services, contact your customer support manager or account
manager for more information.
Note
SAP Ariba Supplier Lifecycle and Performance and SAP Ariba Supplier Information and Performance
Management (new architecture) solutions use a unied vendor model instead of the classic supplier
organization model. The integration methods documented in this guide support a limited integration of supplier
data to the unied vendor model. See Using SOAP web service APIs for supplier data integration with the unied
vendor model [page 12] for details.
SAP Ariba SOAP Web Services Integration Tasks and
End Points
SAP Ariba SOAP web services include integration tasks that send and receive SOAP messages for web services. An
integration task requires an end point for the logical communication channel used by the web service. An end point
consists of the URL and authentication information that controls access to the end point. There are two types of
end points: inbound and outbound. Inbound end points are used when the task is initiated by the ERP system.
Outbound end points are used when the task is initiated by the SAP Ariba system.
Contract Project Operations
The following table lists operations for contract projects with the integration task and end point type needed
To perform this operation... Enable this integration
task
With this end point type
Create an internal contract workspace or update
the header elds of an internal contract work
space.
Import Internal Con
tract Workspace
Inbound
Create a procurement contract request or update
the header elds of a procurement contract re
quest.
Import Procurement
Contract Request
Inbound
Create a procurement contract workspace or up
date the header elds of a procurement contract
workspace.
Import Procurement
Contract Workspace
Inbound
Create a sales contract request or update the
header elds of a sales contract request.
Import Sales Contract
Request
Inbound
6CONFIDENTIAL
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration
To perform this operation... Enable this integration
task
With this end point type
Create a sales contract workspace or update the
header elds of a sales contract workspace.
Import Sales Contract
Workspace
Inbound
Download contract header elds to an external
system that sends a web service request. The re
quest can include lters to select contract work
space by ID, date last modied, and status.
Download Contract
Header Fields
Inbound
Automatically export contract workspace IDs to
an external system when a workspace is created
or published.
Export WorkspaceId Outbound; for additional re
quirements, see Enabling
External Exports for Work
space IDs [page 22]. You
can also congure email no
tications if this service
fails, as described in Cong
uring Email Notications for
Outbound Web Services
[page 24].
Download a Contract Terms Excel le containing
pricing terms or Contract Line Items Document
(CLID) to an external system that sends a web
service request; the le can be downloaded in Ex
cel or CSV format.
This feature can also be used to download a docu
ment with the Use As option set to Contract
Content in a contract workspace, such as a pric
ing terms document.
Download Contract
Terms
Inbound
Export a Contract Terms Excel le document con
taining pricing terms or Contract Line Items Docu
ment (CLID) to an external system after a user se
lects the Export External System option
for the document. This feature is available if SAP
Ariba Contracts is integrated with one of the SAP
Ariba Procurement solutions.
Export Contract Terms Outbound; for additional re
quirements, see Enabling
External Exports for Con
tract Terms [page 23]
Import a contract line items document (CLID) into
a specied contract workspace
Import CLID using XML Inbound
Sourcing Event and Sourcing Project Operations
The following table lists operations for sourcing events and sourcing projects with the integration task and end
point type needed.
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration CONFIDENTIAL 7
To perform this operation... Enable this integration
task
With this end point type
Create a sourcing event or update the header
elds of a sourcing event in an existing full sourc
ing project.
Import Sourcing
Event
Inbound
Create a full sourcing project or update the header
elds of a full sourcing project.
Import Sourcing
Project
Inbound
Request results for a sourcing (RFX) award by ID. Download RFX
Awards
Inbound
Request results for all RFX awards created within
a specied date range
Download RFX
Awards with
Filters
Inbound
Send RFX award results to the ERP system. This is
an outbound web service that can be congured
to be executed by a scheduled task.
Export RFX
Awards
Outbound; for additional re
quirements, see Enabling
Export RFX Awards Tasks
[page 24]. You can also
congure email notications
if this service fails, as descri
bed in Conguring Email
Notications for Outbound
Web Services [page 24]
Retrieve values for Document URL line item
terms. The purpose of a Document URL term is to
provide a link (URL) that participants can click to
obtain documents from your site about the item
with a Description.
DocumentURLOutBo
und
Outbound
Send event status update changes so you can
change the availability or state of documents ref
erenced in a Document URL term. You must use
this service with the DocumentURLOutBound
service (the request requires a UniqueId re
turned in a DocumentURLOutBound re
sponse).
DocumentStatusCh
angeNotification
Outbound
RFX award results can include the following data: line item/part information (including the commodity code), bid
details, suppliers, contract terms, standard and custom project header elds.
Knowledge Project Operation
The following table lists the operation for knowledge projects with the integration task and end point type needed
8CONFIDENTIAL
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration
To perform this operation... Enable this integration
task
With this end point type
Create a knowledge project or update the header
elds of a knowledge project.
Import Knowledge
Project
Inbound
Document Operations
The following table lists the operations for documents with the integration task and end point type needed
To perform this operation... Enable this integration
task
With this end point type
Download a document.
This service is supported only for lebased docu
ments.
Download
Document
Inbound
Request the IDs of all documents modied (or cre
ated) within a specied date range.
This service is supported only for order form
documents.
Download
Document IDs
Inbound
Import or update a project document. This feature
cannot be used for form documents, or the follow
ing SAP Ariba Contracts documents: assembled
contract documents, or pricing terms (contract
terms) documents.
Import Document Inbound
Import or update a contract line items document
in an existing SAP Ariba Contracts Professional
procurement contract workspace.
Import Contract
Line Items
Document
Inbound
Update document form header elds in a work
space.
Note
This service is not supported.
Import Form
Document
Inbound
User, Organization, and Supplier Operations
The following table lists operations to manage users, organizations, and suppliers with the integration task and end
point type needed
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration CONFIDENTIAL 9
To perform this operation... Enable this integration
task
With this end point type
Add new users to SAP Ariba or update user infor
mation.
Import Users Inbound
Add existing users to an existing group. Add Users to
Group
Inbound
Delete users from SAP Ariba. Delete Users Inbound
Export Supplier Proles to an external system that
sends a web service request. Requests can in
clude a date range for incremental exports.
Export Supplier Proles Inbound
Import Supplier Proles from an external system. Import Supplier Proles Inbound
Export data about the organizations congured
for your site. Requests can include a date range
for incremental exports; requests can also include
an element to export only active organizations.
Export
Organizations
Inbound
Import Organizations from an external system. Import Organizations Inbound
Delete Organizations from SAP Ariba. Remove
Organizations
Inbound
SOAP Web Service APIs Use Cases
SAP Ariba Sourcing
If you synchronize the commodity codes in your SAP Ariba Sourcing account with the codes on your back-end
system, you will be able to reconcile and track line items in an SAP Ariba Sourcing event or award in your back-end
system. For example, you could use information exported from contracts awarded from an SAP Ariba Sourcing
auction or RFQ to track line item spend on your back-end system.
You can use the Import Commodity Codes task from the Ariba Administrator UI or the Import Master Batch Data
event with the SAP Ariba integration toolkit (ITK) to import code values from your back-end system to SAP Ariba
Sourcing.
You can create an SAP Ariba sourcing event (such as an RFQ or auction) from information in your back-end system.
Export the contents of an existing event of the same type to an Microsoft Excel le to create a template as
described in the Event Management Guide. You can also create CSV templates from the Excel le. Insert data from
your back-end system to the Excel les or CSV les. Specify the appropriate commodity code in the Commodity
column of the Pricing sheet (Excel) or the Pricing.csv le. Create a ZIP le with the Excel le or CSV les.
Use the Import Sourcing Project web service to create a full or quick sourcing project.
Use the Import Sourcing Event web service to create or specify information for your event and include the ZIP
le you created with data for the event.
Use the SAP Ariba interface to monitor the event. When the event is complete, use the SAP Ariba interface to
create awards for the event.
10 CONFIDENTIAL
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration
Use one of the following web services to transfer event award data to your back-end system:
●Download RFX Awards (requires the event ID)
●Download RFX Awards with Filters (run this periodically with time and date lters)
●Export RFX Awards (receive RFX award data when the SAP Ariba system periodically pushes the data)
SAP Ariba Contracts
You can collect information for a contract workspace or request using your front-end system or your own web
service and use an import contract web service (such as Import Procurement Contract Workspace) to
create the workspace or contract request on the SAP Ariba system.
Alternatively, you can use the SAP Ariba interface to create a contract workspace, then push contract header
information to your back-end system for processing. Use the Export WorkspaceId web service to receive the IDs
of workspaces as they are created, then use the Download Contract Header Fields web service to pull
contract header elds of the created workspaces to your back-end system.
If you have SAP Ariba Sourcing and SAP Ariba Contracts you can create a contract workspace after creating an
award from a sourcing event, and the contract workspace can include a pricing terms document or a Contract Line
Items Document (CLID). Use the Export Workspace Id web service to receive the IDs of workspaces as they are
created, then specify the workspace ID in a Download Contract Terms web service request to export the pricing
terms document or the Contract Line Items Document (CLID).
Limitations for SOAP Web Service APIs
●The variant and partition elements in the WSDL descriptions are not used. Do not specify values for these
elements.
●The Import Form Document task is not currently available.
●The Import Document task cannot be used to import assembled contract documents (Main Agreement or
Contract Addendum documents).
●If you use an Import task to create a project, you cannot specify whether or not the project will be a test
project. All projects created using SOAP are non-test projects.
●If you use an Import task to create a project, you cannot specify responses to template questions. (If there is a
default response dened for the question, the default answer is used. If there is no default response dened,
the value for the response will be undened.) SAP Ariba does not support project creation from templates with
questions when using SAP Ariba Web Services.
●If you use an Import task to create or update a project and attempt to set a custom text eld with an
enumerated type to an incorrect value (such as the value from the Display Value column of the
enumeration le instead of a value from the Value column), the web service does not return an error. When
viewing the project attributes in SAP Ariba, the eld appears to be set to the display value. However, if you
attempt to edit the project attributes, you will see that the eld is not set. For more information about setting
values for custom elds with custom enumerated types, see Specifying Values for Custom Fields with
Enumerated Types [page 32].
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration CONFIDENTIAL 11
●If you use an Import task to create or update a project and attempt to set a custom eld with a multiple-select
enumerated type and specify multiple instances of the same value, the web service does not return an error or
remove duplicate values.
●If you use an Import task to create or update a project and attempt to set a custom eld with a single-value
FMD type to an incorrect value (a value that is not a valid unique name for that FMD denition), the web service
does not return an error.
●If you use an Import task to create or update a project and attempt to set a custom eld with a multiple-select
FMD type and specify multiple instances of the same unique name, the web service does not return an error or
remove duplicate values.
●The RFX award CSV les sent by web services (Download RFX Award response AwardDocument elements and
Export RFX Award request Award elements) contain a header line but no award data if the event has no line
items.
Using SOAP web service APIs for supplier data
integration with the unied vendor model
You can use the SOAP web service APIs for integration of a limited amount of supplier data with SAP Ariba Supplier
Lifecycle and Performance and SAP Ariba Supplier Information and Performance Management (new architecture),
which use the unied vendor model.
The SAP Ariba integration toolkit is designed for integration of supplier data to the classic supplier organization
model. SAP Ariba Supplier Lifecycle and Performance and SAP Ariba Supplier Information and Performance
Management (new architecture) use a unied vendor model, which is more ERP-like in structure. If you add one of
those solutions to your existing solution package, you can continue to use your existing SOAP web service API
integration conguration for a limited amount of supplier data.
Prerequisites
SAP Ariba Customer Support must enable the following parameters in your site:
●Application.SM.ITKImportProfileInSM
●Application.SM.VendorContactPushTaskEnabled
●Application.SM.VendorPushTaskEnabled
For ERP suppliers, you must make sure that their ERP vendor IDs are stored as organization IDs in the sap domain
rather than in the SystemID eld [page 15].
Limitations
Use of SOAP web service APIs for supplier data integration only supports outbound synchronization of data
imported from the ERP system. It does not support export of data back to the ERP system.
12 CONFIDENTIAL
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration
The unied vendor model is a very dierent from the classic supplier organization data model SAP Ariba solutions
use for other supplier data. SOAP web service API integration with the unied vendor model works by passing
supplier data through the classic data model as it ows to and from the SAP Ariba Supplier Management solutions
vendor database. Therefore, it only supports integration of data that is used in a specic set of elds in the classic
supplier data model. That set of elds is a subset of the elds that are available in the unied vendor model. See
Supplier organization data synchronization to the unied vendor model [page 14] and Supplier user
synchronization to the unied vendor model [page 16] for details on which elds are synchronized when you use
this integration method.
SOAP web service API integration for supplier prole data is only available for customers who have migrated from
the supplier organization data model and the supplier prole questionnaire to SAP Ariba Supplier Information and
Performance Management (new architecture) or SAP Ariba Supplier Lifecycle and Performance, and have mapped
an existing supplier prole questionnaire to one or more registration questionnaires in the unied vendor model.
See for details on this mapping.
Data ow for supplier data loaded through SOAP web
service APIs into the unied vendor model
If your solution package does not include SAP Ariba Procurement solutions, SOAP web service APIs integrate
supplier data directly with SAP Ariba Strategic Sourcing solutions.
The following diagram illustrates the outbound data ow for supplier data synchronization in this scenario:
In this ow:
●Your ERP system sends supplier organization, supplier user, and extended prole data to the SAP Ariba
Strategic Sourcing solutions supplier organization data model.
●A limited number of supplier organization and supplier user data elds are synchronized to the unied vendor
model underlying your SAP Ariba Supplier Lifecycle and Performance or SAP Ariba Supplier Information and
Performance Management (new architecture) solution.
●If your solution previously used the supplier prole questionnaire and you have mapped its questions to
registration questionnaires, supplier prole data is synchronized to the corresponding mapped questions in
registration questionnaires.
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration CONFIDENTIAL 13
●If you have mapped questions the registration questionnaires to Ariba Network supplier prole elds, when a
supplier updates their prole on Ariba Network, those updates are automatically pushed to the registration
questionnaires.
Supplier organization data synchronization to the unied
vendor model
SAP Ariba supports synchronization of a limited amount of data from the classic supplier organization model to the
new unied vendor model in order to support the use of existing SOAP web service APIs integrations for supplier
data.
Outbound (imported) supplier data sent in CSV les via SOAP web service APIs and then synchronized to SAP
Ariba Supplier Management solutions that use the unied vendor model can either update existing suppliers or
create new suppliers in those SAP Ariba Supplier Management solutions.
If a supplier is private, meaning that it does not have a linked Ariba Network account, you can update the supplier's
name and address elds via synchronization. If the supplier is public, the supplier owns maintaining that data in
their Ariba Network account, and those updates are passed automatically from Ariba Network to questions
mapped to Ariba Network supplier prole elds in SAP Ariba Supplier Management solutions questionnaires. For
more information about mapping questions to Ariba Network supplier prole elds, see Setting up SAP Ariba
Supplier Lifecycle and Performance (for SAP Ariba Supplier Lifecycle and Performance solutions) or Setting up
supplier management (new architecture) (for SAP Ariba Supplier Information and Performance Management (new
architecture) solutions).
Suppliers added to the unied vendor model via synchronization are not agged as legacy suppliers.
The following supplier elds are synchronized between supplier organizations and the unied vendor model:
Supplier organization eld Unied vendor model eld
Organization IDs with a domain of sap; see Organization ID
synchronization to ERP vendor IDs in the unied vendor model
[page 15] for details.
erpVendorId
Organization IDs with a domain of duns vendor.vendorInfo.dunsId
ANID anId.
Name vendor.vendorInfo.name1
CorporateAddress.PostalAddress.Lines vendor.address.line1 and
vendor.addressExt.postalAddress.streetName
CorporateAddress.PostalAddress.City vendor.address.city and
vendor.addressExt.postalAddress.cityName
CorporateAddress.PostallAddress.State vendor.address.state and
vendor.addressExt.postalAddress.regionCode
14 CONFIDENTIAL
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration
Supplier organization eld Unied vendor model eld
CorporateAddress.PostalAddress.PostalCode vendor.address.postalCode and
vendor.addressExt.postalAddress.streetPost
alCode
CorporateAddress.PostalAddress.Country.Uni
queName
vendor.address.countryCode and
vendor.addressExt.postalAddress.countryCod
e
CorporatePhone vendor.address.phone
CorporateFax vendor.address.fax
Active vendor.vendorInfo.active
SystemID S4OrgSystemID, which is only used internally.
Note
Address information is synchronized to both vendor.address. and vendor.addressExt elds. In SAP Ariba
Supplier Management solutions that use the unied vendor model, whether and where address information
from vendor.address elds displays is determined by the conguration of the supplier request and
registration questionnaires. However, address information in vendor.addressExt elds always displays on the
ERP Info tab in supplier 360° proles. Extended address information might also display elsewhere if you use
those elds in supplier request and registration questionnaires. Therefore, synchronization updates both classes
of address elds.
Organization ID synchronization to ERP vendor IDs in the
unied vendor model
When supplier organizations are synchronized to the unied vendor model, SAP Ariba Supplier Management
solutions convert the organization ID with the domain sap into the ERP vendor ID.
ERP vendor ID is a required eld for suppliers in the unied vendor model. When you use a SOAP web service API
integration to update suppliers in the unied vendor model, data for ERP suppliers must include a domain:value
pair with the sap domain and the ID assigned by your ERP system as the value. The sap domain is mandatory
regardless of the originating ERP system, and must be all lowercase. If you are creating suppliers in the unied
vendor model based on existing supplier organizations through an initial synchronization, the value in the
domain:value pair in the sap domain becomes the new supplier's ERP vendor ID in the unied vendor model. If you
are updating an existing supplier via SOAP web service APIs and ongoing synchronization, the sap:value
organization ID must match the ERP vendor ID in the unied vendor model in order for synchronization to succeed.
For suppliers that do not have an organization ID in the sap domain, SAP Ariba Supplier Management solutions
assigns an ERP vendor ID that begins with "VDR" during initial synchronization. If you have organizations that you
have not yet added to your ERP system, and that therefore have not been assigned an ERP vendor ID by it, as long
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration CONFIDENTIAL 15
as they do not have an organization ID in the sap domain, they will be assigned this automatic ID at initial
synchronization.
Note
If you store supplier organization ERP vendor IDs in the SystemID eld, you must add them as organization IDs
in the sap domain before initial synchronization. If you do not do this, when your supplier organizations are rst
synchronized, the ERP vendor ID eld in the unied vendor model will be populated with automatically generated
IDs rather than your ERP vendor IDs.
Supplier user synchronization to the unied vendor model
SAP Ariba supports synchronization of a limited amount of data from supplier users in the classic supplier
organization model to supplier contacts new unied vendor model in order to support the use of SOAP web service
API integrations for supplier data.
Outbound (imported) supplier user data sent in CSV les via SOAP web service APIs, and then synchronized to
SAP Ariba Supplier Management solutions that use the unied vendor model, can either update existing supplier
contacts or create new supplier contacts in those SAP Ariba Supplier Management solutions.
The following supplier user elds are synchronized between supplier organizations and the unied vendor model:
Supplier user eld Unied vendor model supplier contact eld
FullName vendor.contacts.firstName,
vendor.contacts.middleName, and
vendor.contacts.lastName
SAP Ariba Supplier Management solutions identify spaces in
the FullName value and use them to divide it into rst, last,
and middle names. The characters before the rst space go in
the firstName eld, the characters after the last space go in
the lastName eld, and the characters between the rst and
last spaces go in the middleName eld. For example, if the
FullName is Marie Ann Bradford Wright, the firstName is
Marie, the lastName is Wright, and the middleName is Ann
Bradford. On the other hand, if the FullName is Marie Ann
Bradford-Wright, the lastName is Bradford-Wright and the
middleName is Ann.
EmailAddress vendor.contacts.email
Phone vendor.contacts.telephone
Name vendor.contacts.title
DefaultCurrency vendor.contacts.defaultCurrency
16 CONFIDENTIAL
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration
Supplier user eld Unied vendor model supplier contact eld
timeZoneId vendor.contacts.timeZoneID
active vendor.contacts.active
Synchronization of supplier prole questionnaire data to
the supplier registration questionnaire
In sites that have migrated from the supplier prole questionnaire to supplier registrations, SAP Ariba supports
synchronization of supplier prole questionnaire data to the supplier registration questionnaire in order to support
the use of SOAP web service API integrations for extended supplier prole data.
Since each site has its own customized supplier prole questionnaire, this process it not automatic. You must rst:
●Set up and publish the supplier registration project template with at least one external-facing supplier
registration questionnaire. See Setting up SAP Ariba Supplier Lifecycle and Performance (for SAP Ariba
Supplier Lifecycle and Performance) or Setting up supplier management (new architecture) (for SAP Ariba
Supplier Information and Performance Management (new architecture)) for details.
●Create a CSV le that maps content in the supplier prole questionnaire to content in the supplier registration
questionnaire and import the mapping le into your site. See Migrating suppliers to the unied vendor model for
details.
Once you have successfully imported the mapping le, answers from supplier prole questionnaire are
synchronized to their mapped supplier registration questionnaire question on an ongoing basis.
Note
Once Setting up the mapping requires simultaneous access to the supplier prole questionnaire and supplier
registration questionnaires. The only time both are available simultaneously in the same site is during migration
mode. Once SAP Ariba Supplier Lifecycle and Performance or SAP Ariba Supplier Information and Performance
Management (new architecture) is enabled in your site, the supplier prole questionnaire becomes read-only
and the Supplier Knowledge area is no longer visible. Therefore, if you are a new SAP Ariba Supplier Lifecycle
and Performance or SAP Ariba Supplier Information and Performance Management (new architecture)
customer who has not migrated from an existing supplier prole questionnaire, you cannot use SOAP web
service APIs for extended supplier prole integration. This integration option is only available in sites that have
migrated from an existing, working supplier prole questionnaire to the registration questionnaire.
Authentication and Security for SOAP Web Service
APIs
SOAP messages can be sent using the HTTP or HTTPS protocol. HTTPS provides server authentication and an
encrypted communication channel. For inbound end points, SAP Ariba always uses HTTPS. For outbound end
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration CONFIDENTIAL 17
points, the administrator on the EAI system can choose to use HTTP or HTTPS, but SAP Ariba strongly
recommends that you use HTTPS.
In addition, SAP Ariba SOAP web services support the following mechanisms to provide authentication and
security:
●X.509 Web Services Security
X.509 Web Services Security, or WS-Security (X.509) XML Signature & Encryption, is an industrydened
specication for SOAP messaging enhancements that use X.509 security certicates and public-key
encryption. SAP Ariba Web Services use WS-Security to provide message integrity and client message
authentication.
●HTTP Basic Authentication
HTTP basic authentication provides simple authentication using a credential that consists of a user ID and
password. The authentication information is sent in the HTTP header as a basic authorization request header
eld. The eld has the following format:
Authorization : Basic userID:password
The userID and password are separated by a colon and then base64 encoded. These elds are encrypted if
HTTPS is used, but are not encrypted if HTTP is used.
The user ID specied for HTTP basic authentication is used exclusively to control access to the end point. It is
unrelated to any user IDs congured for the SAP Ariba solution and SAP Ariba recommends that you do not
use the same user ID and password as an actual user congured for the SAP Ariba solution.
Although the HTTP basic authentication mechanism provides only authentication (proof of identity) and by
itself not provide authorization (granting access to resources based on identity), the information is sent in an
HTTP authorization request header eld. You could use HTTP basic authentication as part of an authorization
scheme to restrict access to dierent integration tasks by creating a unique end point for each integration task.
Only users with the authentication credentials for a given end point could use the end point to access the
integration task.
Note
The WS-Security and HTTP basic authentication options do not provide message condentiality. If you use
HTTP instead of HTTPS, your data is sent in clear text, even if you use WS-Security and HTTP basic
authentication.
Workow for SOAP Web Service APIs
To use SAP Ariba SOAP web dervices, you perform the following high-level steps:
1. Plan your conguration by determining:
○The integration tasks for the web services you want to use and the types (inbound or outbound) of end
points needed. For a list of integration tasks and end point types, see SAP Ariba SOAP Web Services
Integration Tasks and End Points [page 6].
○The type of security mechanisms (WS-Security or HTTP Basic Authentication) for your end points. You
must congure at least one form of security for a given end point; you can congure both forms of security
for a given end point.
○How many end points you will congure. You can specify only one end point per integration task, but you
can use one end point for multiple integration tasks. For example, you can create the end point My
18 CONFIDENTIAL
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration
Inbound End Point and use this end point for both the Import Sourcing Project task and the Import
Procurement Contract Workspace task.
You can congure only one peer certicate for WS-Security and one set of HTTP authentication credentials
for a given inbound end point. If multiple external systems will connect to an inbound end point, all ERP
systems connecting to the end point must use the same certicate and/or HTTP credentials. (If ERP
systems will use dierent integration tasks, you can create a dierent end point for each integration event.)
2. Collect access and security information from the ERP systems. For a description of this step, see Collecting
Access and Security Information for Web Services [page 20].
3. Create the end points using the Integration Manager. For a description of this procedure, see Conguring an
End Point for Web Services [page 20].
4. Provide security information to the ERP administrator.
○If you created an inbound end point using HTTP authentication, provide the user ID and password.
○If you created an outbound end point using WS-Security, provide the SAP Ariba certicate.
5. Enable the integration tasks and link them to end points using the Integration Manager. For a description of this
procedure, see Enabling a SOAP Integration Task [page 21].
6. Click the View WSDL link from the Edittask_name screen in the Integration Conguration of the Integration
Manager to generate the WSDL le for the service. Transfer the WSDL le to the ERP system and build the
appropriate SOAP requests and process replies.
Note
When you are using the SAP Ariba test environment, the XML namespace (xmlns) in the WSDL will dier
from the XML namespace used when connecting to the SAP Ariba production environment. When migrating
from the SAP Ariba test environment to the SAP Ariba production environment, you must re-generate a new
WSDL from the production environment.
For additional information about SOAP message elements and examples, see Web Service Elements and
Examples [page 27].
7. If you want to automatically export contract workspace IDs when workspaces are created or published, you
must have you must have an SAP Ariba Customer Support Administrator enable a system parameter. For more
information, see Enabling External Exports for Workspace IDs [page 22].
8. If you want to allow users to export Contract Terms Excel le documents to external systems from the
interactive user interface, you must have an SAP Ariba Customer Support Administrator enable a system
parameter. For more information, see Enabling External Exports for Contract Terms [page 23].
9. If you want to allow automatically export RFX awards to external systems, you must have an SAP Ariba
Customer Support Administrator enable a system parameter. For more information, see Enabling Export RFX
Awards Tasks [page 24].
10. (Optional) Congure users to receive notications if the Export WorkspaceId or Export RFX Awards services
fail. For more information, see Conguring Email Notications for Outbound Web Services [page 24].
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration CONFIDENTIAL 19
Collecting Access and Security Information for Web
Services
Before conguring end points, you must collect the access and security information about the ERP system.
Procedure
Collect the following information:
○If you are conguring an inbound end point with WS-Security, get a copy of the ERP system’s certicate. The
certicate must be a signed X.509 certicate encoded using Privacy Enhanced Mail (PEM) base64-encoding
and signed by a Certicate Authority (CA) trusted by SAP Ariba. To get information about the CAs currently
trusted by SAP Ariba or to register a CA to be trusted by SAP Ariba, contact SAP Ariba Support.
The rst line of the certicate must be the following text:
-----BEGIN CERTIFICATE-----
The last line of the certicate must be the following text:
-----END CERTIFICATE-----
○If you are conguring an outbound end point, get the URL for the ERP system.
○If you are conguring an outbound end point with HTTP basic authentication, get the user name and password
required to access the ERP system.
Conguring an End Point for SOAP Web Services
Prerequisites
You must be a member of the Customer Administrator or Integration Admin group, or a group with the
Administrator or Integration Admin role.
Procedure
1. On the Ariba Administrator dashboard, click Manage Administration .
2. Click the expansion arrow for Integration Manager.
3. Select End Point Conguration.
4. Click Create New.
An End Point Conguration - Create End Point page opens.
5. In the Name eld, enter a name for the end point.
6. Select the type (Inbound or Outbound) of end point according to the table in SAP Ariba SOAP Web Services
Integration Tasks and End Points [page 6].
20 CONFIDENTIAL
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration
7. If this is an inbound end point and you are using WS-Security, paste the contents of the certicate le from the
ERP system in the Certicate File eld under Web Services Security.
8. If this is an outbound end point, the system displays a URL eld. Enter the URL for the endpoint on the ERP
system.
9. If this is an outbound end point, the Web Services Security area displays the contents of the SAP Ariba
certicate. To enable WS-Security, select Yes in the Sign with Ariba Private Key eld. For example:
Copy the certicate, beginning with the line -----BEGIN CERTIFICATE----- and ending with the line -----
END CERTIFICATE-----. Provide this certicate to the administrator on the ERP system.
10. To use HTTP Basic Authentication, navigate to the HTTP Authentication area. Enter the user ID in the Login
eld and the password in the Password elds. If this is an inbound end point, provide this information to the
administrator on the ERP system. If this is an outbound end point, this information must match the data
congured on the ERP system.
11. Click Save.
Enabling a SOAP Integration Task
When you enable an SAP Ariba SOAP web services integration task, you also link the task to an end point.
Prerequisites
You must be a member of the Customer Administrator or Integration Admin group, or a group with the
Administrator or Integration Admin role.
Procedure
1. On the Ariba Administrator dashboard, click Manage Administration .
2. Click the expansion arrow for Integration Manager.
3. Choose Integration Conguration.
4. Find the task you want to enable. Select List All or enter search criteria and click Search.
5. Click Actions Edit for the task.
An Edit data import/export task pane opens.
6. For the Status eld, select Enabled.
7. Use the pull-down menu for the End point eld to select an end point.
8. If you are conguring a service that uses an outbound end point, specify the URL for the corresponding
endpoint on the ERP system.
9. Click Save.
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration CONFIDENTIAL 21
Generating a WSDL File
Prerequisites
You must be a member of the Customer Administrator or Integration Admin group, or a group with the
Administrator or Integration Admin role.
Procedure
1. On the Ariba Administrator dashboard, click Manage Administration .
2. Click the expansion arrow for Integration Manager.
3. Select Integration Conguration.
4. Find the task for which you want to generate the WSDL le. Select List All or enter the search criteria and click
Search.
5. Click Actions Edit for the task.
6. Click the View WSDL link.
Results
A new window with the WSDL contents opens. Use the le menu for your browser to save the contents to a le. The
descriptions for each eld in the WSDL are provided in the WSDL itself. The WSDL description also includes the
URL for the end point.
Enabling External Exports for Workspace IDs
Context
In addition to conguring an endpoint for the Export WorkspaceId web service, the following site conguration
options must be set.
Procedure
Have your Designated Support Contact log a service request to enable site conguration options as follows:
22 CONFIDENTIAL
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration
○To enable the Export WorkspaceId service to send a workspace ID when a workspace is created, the
following application parameter must be set to Yes:
Application.ACM.EnableWSWorkspaceIdOnCreatePush
○To enable the Export WorkspaceId service to send a workspace ID when workspace is published, the
following application parameter must be set to Yes:
Application.ACM.EnableWSWorkspaceIdOnPublishPush
Enabling External Exports for Contract Terms
Context
If SAP Ariba Contracts is integrated with one of the SAP Ariba Procurement solutions, users can create Contract
Terms Excel le documents, which are visible in the Documents area of contract workspaces. The Export
Contract Terms web service enables users to export a Contract Terms Excel le document to an ERP or other
external system by choosing the Export External System command in the Actions pull-down menu for the
Contract Terms document.
In addition to conguring an endpoint for the Export Contract Terms web service, the following site
conguration option must be set.
Procedure
Have your Designated Support Contact log a service request to enable the following site conguration option:
Application.ACM.EnableWSContractTermsPush
Enabling External Document Uploads for the User
Interface
Context
On an EAI system, the administrator can build a web page with links that generate and send Import Document
SOAP messages to the SAP Ariba system. SAP Ariba users can navigate to this webpage from the Documents tab
in a project by clicking Actions Upload External Document . When the user navigates to the EAI system,
SAP Ariba appends the parameters, Project ID, user ID, and password adapter to the URL. The EAI system can use
this information when invoking the Import Document task to upload the selected documents to the SAP Ariba
system.
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration CONFIDENTIAL 23
Procedure
Have your Designated Support Contact log a service request to set the following site conguration option to the
URL of the web page on the EAI system:
Application.ACM.ExternalDocumentBrowserURL
Enabling Export RFX Awards Tasks
Context
In addition to conguring an endpoint for the Export RFX Award web service, the following site conguration
option must be set.
Procedure
Have your Designated Support Contact log a service request to enable the following site conguration option:
Application.AQS.RFX.EnableWSAwardPush
Conguring Email Notications for Outbound Web
Services
Context
SAP Ariba can send email notications when the following outbound web services fail:
●Export WorkspaceId
●Export RFX Awards
Procedure
To congure a user to receive email notications when these services fail, add the users to the following system
(global) group:
Integration Notications
24 CONFIDENTIAL
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration
About Web Service Email Notications
For the Export WorkspaceId and Export RFX Awards services, any circumstance in which an outbound message to
the SOAP peer cannot be sent or the message is sent but the SOAP peer does not send back a response with status
set to 0 is a failure. For example, failures can be caused by conguration errors, network connectivity problems, or a
SOAP peer that is not sending the correct response.
The format of the message sent for web service failures is as follows:
Web Service Name: serviceName
Target ID: id
Target Action: action
Notice Type: noticeType
The above Outbound Web Service has failed. This email notification was sent to all
members of the "Integration Notifications” group.
If Notice Type is "Final" there will be no further attempts to re-send the SOAP
message for this Web Service call. Please take any necessary steps to ensure your
endpoint is operational. If necessary, notify appropriate users of any Final
notices and take manual steps to complete the operation.
This email originated from the SAP Ariba system used by my_org and was originally
sent to: someone@example.com
Where:
serviceName is the name of the web service, such as WorkspaceIdExportTask or RFXAwardExportTask.
id is the workspace ID, such as CW1234.
action is the action that triggered the web service (if applicable; for workspaces, possible values are Published
or Created).
noticeType is the type of notice (Warning or Final).
Export WorkspaceId Email Notications
The Export WorkspaceId web service attempts to send a request at the time a workspace is created or published. If
the Export WorkspaceId web service fails for a given request (the web service does not receive a response with
Status = 0 from the SOAP peer), SAP Ariba uses the scheduled task WSWorkspaceIdExportTask to retry the SOAP
request. The WSWorkspaceIdExportTask task operates as follows:
●It is scheduled to run once an hour. There might be slight variations in the actual interval between executions
depending on system load.
●If WSWorkspaceIdExportTask tries to send a request for a given workspace ID three times and still fails,
WSWorkspaceIdExportTask sends a warning email notication (Notice Type: Warning) to members of the
Integration Notications group.
●After three hourly retries, WSWorkspaceIdExportTask tries to re-send the request once every 24 hours for the
next three days.
●If the web service has not succeeded after three daily retries, WSWorkspaceIdExportTask sends a nal email
notication (Notice Type: Final) and stops sending the request.
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration CONFIDENTIAL 25
Export RFX Awards Email Notications
The Export RFX Awards web service uses the scheduled task RFXAwardExportTask to export RFX awards by
sending an RFXAwardExportRequest. The RFXAwardExportTask task operates as follows:
●It is scheduled to run once a day. There might be slight variations in the actual interval between executions
depending on system load.
●If RFXAwardExportTask initially fails for a given day (the web service does not receive a response with Status =
0 from the SOAP peer), RFXAwardExportTask sends a warning email notication (Notice Type: Warning)
to users in the Integration Notications group.
●If RFXAwardExportTask fails after three additional retries, RFXAwardExportTask sends a nal email notication
(Notice Type: Final) and stops sending the request.
Disabling Integration Tasks
Procedure
1. On the dashboard, select Manage Administration .
2. Click the expansion arrow for Integration Manager.
3. Click Integration Conguration.
4. Under Search Filters, search for the enabled tasks.
All the enabled tasks are displayed.
5. For the selected task, click Actions > Disable.
26 CONFIDENTIAL
SOAP web service API integration guide
Using SOAP Web Service APIs for Data Integration
Web Service Elements and Examples
In this section:
Common SOAP Web Service Header Elements [page 27]
Common SOAP Web Service Body Elements [page 27]
Custom Body Elements for SOAP Web Services [page 30]
SOAP Web Services for Contract Projects [page 36]
SOAP Web Services for Sourcing Events and Projects [page 67]
SOAP Web Service for Knowledge Projects [page 94]
SOAP Web Services for Documents [page 97]
SOAP Web Services for Managing Users, Organizations, and Suppliers [page 101]
SOAP Web Service Status and Error Message Values [page 115]
Web Service Example: Creating a Procurement Contract Workspace [page 117]
Web Service Examples: Creating Sourcing Events [page 121]
Web Service Example: Creating a Project with Custom Fields [page 127]
Common SOAP Web Service Header Elements
The following elements are common to SOAP headers for all web service events.
Element Required Description
variant No String. Not used; do not specify a value for this element.
partition No String. Not used; do not specify a value for this element.
Common SOAP Web Service Body Elements
The following body elements are used by multiple web service events:
●Country, Currency, BaseLanguage, and LocaleID Elements [page 28]
●ContractId and WorkspaceId Elements for Contract Workspaces [page 28]
●OnBehalfUserId and OnBehalfUserPasswordAdapter Elements [page 28]
●XSD DateTime Elements [page 29]
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 27
Country, Currency, BaseLanguage, and LocaleID Elements
Use the following export data tasks to determine valid input values for Country, Currency, BaseLanguage, and
LocaleID elements for web services:
●Export Country (CSV)
●Export Currency (CSV)
●Export Language (CSV)
●Export Locale (CSV)
ContractId and WorkspaceId Elements for Contract
Workspaces
All contract workspaces have a workspace ID and a contract ID. The workspace ID is generated by SAP Ariba Spend
Management and usually has the form CWnnnn, where nnnn is a number. If you do not specify a contract ID when
creating a workspace (you use a web service to create a workspace and do not include a ContractId element or
you use interactive user interface to create a workspace), SAP Ariba uses the workspace ID value as the contract ID
value.
When viewing a contract workspace with the interactive user interface, only the contract ID is visible; the
workspace ID is not visible. If you create a contract workspace using a web service and specied a contract ID, the
contract ID and the workspace ID will not match, but you can determine the workspace ID by examining the
WorkspaceId element in the response. SAP Ariba recommends that you retain the value of the workspace ID; if
you use a web service to create a contract workspace that is a subproject or subagreement of another workspace,
you must specify the workspace ID of the predecessor project or master agreement.
OnBehalfUserId and OnBehalfUserPasswordAdapter
Elements
The web services perform actions on behalf of the user specied by the OnBehalfUserId element (not the user in
the HTTP authentication header).
Element Required Type and Description
OnBehalfUserId Yes String. Species the user ID of the user for whom the SAP Ariba web serv
ice will perform the action.
OnBehalfUserPasswordAdap
ter
No String. Species the password adapter to authenticate the user in the
OnBehalfUserId element.
If you are not using a custom password adapter, you can omit this element
or leave the value unspecied and the web service will use the default pass
word adapter (SourcingSupplierUser for suppliers or
PasswordAdapter1 for all other users).
28 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
XSD DateTime Elements
The format for XSD DateTime web service elements is as follows:
YYYY-MM-DDThh:mm:ss
Where:
●YYYY species the year
●MM species the month
●DD species the day
●T is a literal value that species the start of the time section
●hh species the hour
●mm species the minutes
●ss species the seconds
For example:
2011-05-09T12:00:00
The XSD DateTime format also supports the following formats for time osets relative to UTC (Coordinated
Universal Time):
YYYY -MM -DD Thh :mm :ss +hh :mm
YYYY -MM -DD Thh :mm :ss -hh :mm
DateTime Elements Used to Create and Update Projects
The following DateTime elements are used when creating or updating SAP Ariba Contracts projects:
●AgreementDate
●EffectiveDate
●ExpirationDate
In addition, the following DateTime element is used when creating or updating SAP Ariba Sourcing full projects:
●EffectiveDate
These project dates (AgreementDate, EffectiveDate, ExpirationDate, and EffectiveDate) also support
the following XSD DateTime formats for time osets relative to UTC (Coordinated Universal Time):
YYYY -MM -DD Thh :mm :ss +hh :mm
YYYY -MM -DD Thh :mm :ss -hh :mm
If you specify an AgreementDate, EffectiveDate, ExpirationDate, or EffectiveDate with a UTC oset,
SAP Ariba converts the DateTime value in the element to a calendar date in the SAP Ariba OnDemand time zone of
the server used for your site; by default, this is US Pacic time (UTC-08:00).
For example, an AgreementDate element has the following value:
2014-05-01T00:00:00+01:00
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 29
The Agreement Date will be 04/30/2014 (the previous calendar day), because midnight (00:00:00) on
05/01/2014 in the UTC+01:00 time zone is 04/30/2014 in the UTC-08:00 time zone.
Custom Body Elements for SOAP Web Services
The WSDL les for tasks that can create or update projects (such the Import Procurement Contract Workspace
task) contain a custom element that contains placeholders for custom project elds of dierent namespaces, as
shown in the following WSDL excerpt:
<urn:custom>
<!--Zero or more repetitions:-->
<urn:CustomBigDecimal name="?">?</urn:CustomBigDecimal>
<!--Zero or more repetitions:-->
<urn:CustomBoolean name="?">?</urn:CustomBoolean>
<!--Zero or more repetitions:-->
<urn:CustomDate name="?">?</urn:CustomDate>
<!--Zero or more repetitions:-->
<urn:CustomInteger name="?">?</urn:CustomInteger>
<!--Zero or more repetitions:-->
<urn:CustomMoney name="?">
<!--You may enter the following 5 items in any order-->
<!--Optional:-->
<urn:Amount>?</urn:Amount>
<!--Optional:-->
<urn:AmountInReportingCurrency>?</urn:AmountInReportingCurrency>
<!--Optional:-->
<urn:ApproxAmountInBaseCurrency>?</urn:ApproxAmountInBaseCurrency>
<!--Optional:-->
<urn:ConversionDate>?</urn:ConversionDate>
<!--Optional:-->
<urn:Currency>
<!--Optional:-->
<urn:UniqueName>?</urn:UniqueName>
</urn:Currency>
</urn:CustomMoney>
<!--Zero or more repetitions:-->
<urn:CustomString name="?">?</urn:CustomString>
<!--Zero or more repetitions:-->
<urn:CustomUser name="?">
<!--You may enter the following 2 items in any order-->
<!--Optional:-->
<urn:PasswordAdapter>?</urn:PasswordAdapter>
<urn:UniqueName>?</urn:UniqueName>
</urn:CustomUser>
</urn:custom>
Omitting Custom Web Service Elements for Projects
without Custom Fields
If you are creating or updating a project and your conguration does not contain any custom elds, you must
exclude the custom element in the rst level immediately within the ProjectHeaderFields element.
30 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
If the organizations that can be selected for the Aected Parties eld do not contain any custom elds, you must
not include the child custom element in the AffectedParties element. Alternatively, you can omit the entire
AffectedParties element.
Using Custom Web Service Elements for Projects with
Custom Fields
If you are creating or updating a project using a web service, you can specify the value for a custom project eld.
Prerequisites for Using Custom Fields with Web Services
You can specify the value for a custom project eld if the following tasks have been completed. Many of the tasks
are completed for you by your SAP Ariba support team.
●The custom eld is added to the appropriate classes with the External Integration Field option selected.
●The web service is enabled as described in Enabling an Integration Task [page 21].
●The new eld is migrated to the integration web service (the change is reviewed and published) using the
Integration Manager Data Denition operation as described in Managing Integration Migration [page
144].
After these tasks are completed, you can generate a new WSDL le for the appropriate web service.
The WSDL le includes a documentation element within the element of the appropriate type. The
documentation element species the internal eld name, which is formed by removing all characters other than
A-Z, a-z, 0-9, and underscore(_). For example, the system generated the following element in the WSDL for the
custom Needs EU Approval boolean eld with the internal eld name NeedsEUApproval:
<xsd:element maxOccurs="unbounded" minOccurs="0" name="CustomBoolean"
nillable="true">
<xsd:complexType>
<xsd:annotation>
<xsd:documentation>"NeedsEUApproval" is the name of a flex
field that can be imported or exported.</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:extension base="xsd:boolean">
<xsd:attribute name="name" type="xsd:string"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
The SOAP request species the namespace (CustomBoolean), internal eld name (NeedsEUApproval), and
value (true) in the custom element:
<urn:custom>
<urn:CustomBoolean name="NeedsEUApproval">true</urn:CustomBoolean>
</urn:custom>
For an example of a SOAP message body used to create a project with custom elds, see Web Service Example:
Creating a Project with Custom Fields [page 127].
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 31
Specifying Values for Custom Fields with Enumerated Types
Enumerated types are typically used to enable users to select custom values from menus or choosers. The values
for enumerated types are loaded from an enumeration le by your SAP Ariba support team. If you are creating or
updating a project using a web service, you can specify the value for a custom enumeration eld after the
enumerated types are loaded and the prerequisites in Prerequisites for Using Custom Fields with Web Services
[page 31] have been completed.
Custom enumeration elds can contain either a single value or multiple values. The data denition and SOAP
message elements are dierent depending on the eld type (single value or multiple select).
●Single-value enumeration elds are specied using CustomString elements.
●Multiple-value enumeration elds are specied using CustomString_Vector elements.
An object can contain both a single-value eld and a multiple-select eld for the same enumerated type.
An enumeration le includes a Display Value column and a Value column. The value in the Value column is
typically a numerical index value. When specifying the values for a custom eld with an enumerated type, you must
use the value from the Value column of the enumeration le.
Note
Always specify the value from the Value column in the SOAP message. Do not specify the value from the
Display Value column. If you do not know the contents of the Value column for your enumeration, you can
get a copy of your enumeration le. Have your Designated Support Contact log a service request and an SAP
Ariba Customer Support representative will follow up to complete the request.
For example, the enumeration le contains the following entries:
Table 1: Enumeration File
Enumeration Display Value Value
cus_Color Red 101
cus_Color Blue 102
To specify Blue in an Import task for the single-value enumeration eld My Color that uses the enumerated type
cus_Color, the SOAP request includes the following custom and CustomString elements:
<urn:custom>
<urn:CustomString name="MyColor">102</urn:CustomString>
</urn:custom>
To specify Blue and Red in an Import task for a multiple-value enumeration eld Multi Colors that uses the
enumerated type cus_Color, the SOAP request includes the following custom, CustomString_Vector, item,
and CustomString elements:
<urn:custom>
<urn:CustomString_Vector name="MultiColors">
<urn:item>
<urn:CustomString>102</urn:CustomString>
</urn:item>
<urn:item>
<urn:CustomString>101</urn:CustomString>
</urn:item>
</urn:CustomString_Vector>
32 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
</urn:custom>
Using Custom Elements for Flex Master Data Fields
A Flex Master Data (FMD) data type is a custom data structure dened for your installation by your SAP Ariba
support team. Your SAP Ariba support team also adds elds to projects with the FMD type and loads data records
for the FMD type. Each FMD data record has a unique name and other data elds.
For example, you could have a FMD type named AirlineFMD with the data elds Name and Phone Number. Each
record would also have a text eld for the unique name or ID eld that identies the record. Your internal contract
workspaces could have the custom eld Preferred Airline, where the data type for this eld is AirlineFMD.
If you are creating or updating a project using a web service, you can specify the value for a FMD eld if the ex
master data (FMD) template is published, data for the FMD eld is loaded, and the prerequisites in Prerequisites for
Using Custom Fields with Web Services [page 31] have been completed.
The data denition and SOAP message elements are dierent depending on the FMD eld type (single value or
multiple select). An object can contain both a single-value eld and a multiple-select eld for the same FMD data
type.
Single-Value FMD Fields Example
If a eld can contain only one FMD data record, the WSDL le includes denitions for the custom FMD eld and the
FMD data type. In the following example, the eld name is Preferred Airline and the FMD data type is
Airline FMD:
<xsd:element maxOccurs="1" minOccurs="0" name="custom">
:
:
<xsd:element maxOccurs="unbounded" minOccurs="0" name="CustomAirlineFMD"
nillable="true">
<xsd:complexType>
<xsd:annotation>
<xsd:documentation>"PreferredAirline" is the name of a flex field that can be
imported or
exported.</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="typens:AirlineFMD_Reference">
<xsd:attribute name="name" type="xsd:string" />
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
:
:
</xsd:element>
Note that the namespace for the custom eld is CustomAirlineFMD. The CustomAirlineFMD denition contains
a child element of the AirlineFMD_Reference namespace. The WSDL also contains a denition for the
AirlineFMD_Reference namespace with a string element to specify the unique name of the FMD data record:
<xsd:complexType name="AirlineFMD_Reference">
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 33
<xsd:annotation>
<xsd:documentation>Name null, type vrealm_1.fmd_68.AirlineFMD, variant
vrealm_1.</xsd:documentation>
</xsd:annotation>
<xsd:all>
<xsd:element minOccurs="0" name="UniqueName" nillable="true"
type="xsd:string" />
:
:
</xsd:all>
</xsd:complexType>
The SOAP request species the namespace (CustomAirlineFMD), internal eld name (PreferredAirline), and
the unique name (ID eld) for the record you want to specify. In the following example, the unique name is
AlohaAir.
<urn:custom>
<urn:CustomAirlineFMD name="PreferredAirline">
<urn:UniqueName>AlohaAir</urn:UniqueName>
</urn:CustomAirlineFMD>
</urn:custom>
Note that the only valid child element for the CustomAirlineFMD element is UniqueName. You cannot specify or
set data values in the FMD elds.
Multiple-Select FMD Fields Example
In the following example, the eld name is AllowedAirlines and the FMD data type is Airline FMD. The WSDL
le includes the following entries:
<xsd:element maxOccurs="1" minOccurs="0" name="custom">
:
:
<xsd:element maxOccurs="unbounded" minOccurs="0" name="CustomAirlineFMD_Vector"
nillable="true">
<xsd:complexType>
<xsd:annotation>
<xsd:documentation>"AllowedAirlines" is the name of a flex field that can
be imported or
exported.</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="typens:AirlineFMD_Reference_Vector">
<xsd:attribute name="name" type="xsd:string"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
:
:
</xsd:element>
The namespace for the custom eld type is CustomAirlineFMD_Vector. The CustomAirlineFMD_Vector
denition contains a child element with the namespace AirlineFMD_Reference_Vector. The WSDL also
contains a denition for AirlineFMD_Reference_Vector with a sequence of string elements to specify the
unique name of each FMD data record:
<xsd:complexType name="AirlineFMD_Reference_Vector">
34 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
<xsd:annotation>
<xsd:documentation>Name null, type vrealm_1.fmd_68.AirlineFMD, variant
vrealm_1.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="item">
<xsd:complexType>
<xsd:all>
<xsd:element minOccurs="0" name="UniqueName" nillable="true"
type="xsd:string" />
:
:
</xsd:all>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
A SOAP request to set the eld Allowed Airlines includes:
●A custom element with an AllowedAirlines child element of the namespace
AirlineFMD_Reference_Vector.
●The AllowedAirlines element contains one or more item child elements, and each item element species
the unique name (ID eld) for the FMD record.
For example:
<urn:custom>
<urn:CustomAirlineFMD_Vector name="AllowedAirlines">
<urn:item>
<urn:UniqueName>IslandAir</urn:UniqueName>
</urn:item>
<urn:item>
<urn:UniqueName>MahaloAir</urn:UniqueName>
</urn:item>
</urn:CustomAirlineFMD_Vector>
</urn:custom>
Multiple-Select and Single-Value FMD Example
The following example shows a request with both an FMD multiple-select eld and an FMD single-value eld. In this
example:
●The FMD data name is Airline FMD.
●Internal contract workspaces can have the following custom elds:
●Preferred Airline, which can contain a single FMD data record (CustomAirlineFMD namespace).
The value of Preferred Airline is set to the unique name AlohaAir.
●Allowed Airlines, which can contain multiple FMD data records (CustomAirlineFMD_Vector
namespace).
The value of Allowed Airlines is set to the unique names IslandAir and MahaloAir.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:Ariba:Sourcing:vrealm_1">
<soapenv:Header>
<urn:Headers>
<urn:variant></urn:variant>
<urn:partition></urn:partition>
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 35
</urn:Headers>
</soapenv:Header>
<soapenv:Body>
<urn:InternalContractWorkspaceImportRequest partition="?" variant="?">
<urn:WSInternalContractWorkspaceInputBean_Item>
<urn:item>
<urn:Action>Create</urn:Action>
<urn:OnBehalfUserId>molson</urn:OnBehalfUserId>
<urn:OnBehalfUserPasswordAdapter></urn:OnBehalfUserPasswordAdapter>
<urn:ParentAgreementId></urn:ParentAgreementId>
<urn:ParentWorkspaceId></urn:ParentWorkspaceId>
<urn:ProjectHeaderFields>
<urn:AgreementDate>2012-01-01T00:00:00</urn:AgreementDate>
<urn:ContractId></urn:ContractId>
<urn:Description>
<urn:DefaultStringTranslation>Example CW</
urn:DefaultStringTranslation>
</urn:Description>
<urn:EffectiveDate>2012-01-01T00:00:00</urn:EffectiveDate>
<urn:ExpirationDate>2014-01-01T00:00:00</urn:ExpirationDate>
<urn:ExpirationTermType>Fixed</urn:ExpirationTermType>
<urn:HierarchicalType>StandAlone</urn:HierarchicalType>
<urn:Title>
<urn:DefaultStringTranslation>SOAP Internal CW</
urn:DefaultStringTranslation>
</urn:Title>
<urn:custom>
<urn:CustomAirlineFMD name="PreferredAirline">
<urn:UniqueName>AlohaAir</urn:UniqueName>
</urn:CustomAirlineFMD>
<urn:CustomAirlineFMD_Vector name="AllowedAirlines">
<urn:item>
<urn:UniqueName>IslandAir</urn:UniqueName>
</urn:item>
<urn:item>
<urn:UniqueName>MahaloAir</urn:UniqueName>
</urn:item>
</urn:CustomAirlineFMD_Vector>
</urn:custom>
</urn:ProjectHeaderFields>
<urn:TemplateId>CW2272</urn:TemplateId>
<urn:WorkspaceId></urn:WorkspaceId>
</urn:item>
</urn:WSInternalContractWorkspaceInputBean_Item>
</urn:InternalContractWorkspaceImportRequest>
</soapenv:Body>
</soapenv:Envelope>
SOAP Web Services for Contract Projects
A contract project can be either a contract request or a contract workspace. You can use the following web services
to manage contract projects.
●Download Contract Header Fields [page 37]
●Download Contract Terms [page 40]
●Export Contract Terms [page 41]
●Export WorkspaceId [page 42]
●Import CLID using XML [page 44]
●Import Contract Line Items Document [page 48]
36 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
●Import Internal Contract Workspace [page 50]
●Import Procurement Contract Request and Import Procurement Contract Workspace [page 56]
●Import Sales Contract Request and Import Sales Contract Workspace [page 61]
Download Contract Header Fields
Use the Download Contract Header Fields web service to download header eld values for one or more contract
workspaces. The Download Contract Header Fields web service receives ContractHeaderExportRequest
messages and responds with ContractHeaderExportReply messages.
A ContractHeaderExportRequest message must specify the class (type) of contract workspace for which header
elds will be exported. In addition, the request can specify the following lters to restrict the workspaces for which
header elds will be exported:
●ContractIds (a comma-separated list)
●ContractStatus
●FromDate and ToDate (a date range to lter contract workspaces according to the last updated date)
●WorkspaceIds (a comma-separated list)
Each ContractHeaderExportReply message contains a ZIP le that contains the le ContractHeaders.csv with
contract header elds. The ZIP le is base64 encoded. The format of the ContractHeaders.csv le is described
in Contract Data File Formats [page 130].
You can use the Export WorkspaceId web service with the Download Contract Header Fields web services to pull
contract header eld values as contract workspaces are created or published. For example:
1. Use the Export WorkspaceId to automatically send a contract workspace ID to a SOAP peer when a contract is
created or published in SAP Ariba Contracts.
2. The SOAP peer sends a Download Contract Header Fields request with the workspace ID received in the Export
WorkspaceId request to get the contract header eld values.
Alternatively, you can periodically send Download Contract Header Fields with a date range to get contract header
eld values of contract workspaces that have been modied during the specied date range.
ContractHeaderExportRequest Elements
WSContractHeaderExportInputBean
The WSContractHeaderExportInputBean contains optional elements that can be used to lter the contract
workspaces. If you specify multiple lter elements, the web service selects the workspaces that match all the
specied lter elements (the lter elements are logically joined with AND operators).
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 37
Element Required Type and Description
ClassName Yes String. Species the type of workspace headers to be exported.
Valid values:
●ariba.collaborate.contracts.ContractWorkspace (procurement con
tract workspaces)
●ariba.collaborate.contracts.ContractRequest (procurement contract
requests)
●ariba.collaborate.contracts.SalesContractWorkspace (sales contract
workspaces)
●ariba.collaborate.contracts.SalesContractRequest (sales contract re
quests)
●ariba.collaborate.contracts.InternalContractWorkspace (internal con
tract workspaces)
ContractIds No String. List of contract IDs for which the headers will be exported, comma
separated. For example:
CW2005,CW2006
For more information about contract IDs and workspace IDs, see Contrac
tId and WorkspaceId Elements for Contract Workspaces [page 28].
If omitted, the web service exports headers for all contract workspaces
with any contract ID and that meet criteria specied in the other elements.
ContractStatus No String. Species the status of the workspaces that will be exported. This el
ement is ignored if no date range is specied.
Valid values:
●NotCreated
●Draft
●Publishing
●Pending
●Published
●OnHold
●Expired
●Closed
If omitted, the web service exports headers for all contract workspa
ces with any status value and that meet criteria specied in the other
elements.
38 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
FromDate No XSD DateTime. Start date for a date range. By default, the web service con
verts this to a calendar date (it strips the hours, minutes, and seconds) and
exports headers for all workspaces that were last updated after the start of
the FromDate and before the start of the ToDate. Items updated after
the start of the ToDate are excluded.
You can include the hours, minutes, and seconds values for the FromDate
and ToDate elements in the date range by having SAP Ariba set the site
conguration option
Application.Messaging.Channels.WS.IncludeTimePorti
onToParseDate to Yes. For more information, see Site Conguration
Options for Integration Services [page 150].
If a workspace has never been updated, the creation date is considered the
last updated date.
If you include a FromDate element, you must also include a ToDate ele
ment.
ToDate No XSD DateTime. XSD DateTime. End date for a date range. The web service
converts this to a calendar date (it strips the hours, minutes, and seconds)
and exports headers for all workspaces that were last updated after the
start of the FromDate and before the start of the ToDate. Items up
dated after the start of the ToDate are excluded.
If you include a ToDate element, you must also include a FromDate ele
ment.
WorkspaceIds No String. List of workspace IDs for which the headers will be exported,
comma separated. For example:
CW2005,CW2006
For more information about contract IDs and workspace IDs, see Contrac
tId and WorkspaceId Elements for Contract Workspaces [page 28].
If omitted, the web service exports headers for all contract workspaces
with any workspace ID and that meet criteria specied in the other ele
ments.
ContractHeaderExportReply Elements
WSContractHeaderExportOutputBean
Element Type and Description
ErrorMessage String. Message (error or conrmation) returned by the web service.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 39
Element Type and Description
HeaderExportFile XSD base64Binary (string with base64-encoded data). Contains a ZIP le with a Mi
crosoft Excel le. The Excel le contains rows of header elds, one row per workspace.
MimeType String. MIME encoding type used for the header export document.
Status Integer. Return status. 0 indicates success.
Download Contract Terms
Use the Download Contract Terms web service to download Contract Terms Excel le documents. Contract Terms
Excel le documents are supported in environments where SAP Ariba Contracts is integrated with one of the SAP
Ariba Procurement solutions.
This feature can also be used to download a document with the Use As option set to Contract Content in a
contract workspace, such as a pricing terms document or Contract Line Items Document (CLID) in a contract
workspace that was created from a sourcing project.
This web service allows the content to be downloaded in one of two formats:
●Standard CLID Excel Export Format
●A zip le containing the following CSV les:
○Contract Header.csv
○Contract Item Information.csv
○Header Attributes.csv
○Item Attributes.csv
The Download Contract Terms web service receives ContractTermsDownloadRequest messages and responds
with ContractTermsDownloadReply messages.
By default, each ContractTermsDownloadReply message contains a base64-encoded Contract Terms le in Excel
format. To receive the Contract Terms le as a base64-encoded ZIP le with the Contract Terms le in CSV format,
send the ContractTermsDownloadRequest with a CSVZipOutput element set to false.
ContractTermsDownloadRequest Elements
WSContractWorkspaceInputBean
Element Required Type and Description
CSVZipOutput No Boolean. Species the format for the output. Valid values:
●true: base64-encoded ZIP le containing Contract Terms CSV les
●false: base64-encoded Contract Terms le in Excel format
If this element is omitted, the output is a base64-encoded Contract
Terms le in Excel format.
40 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
OnBehalfUserId Yes String. Species the user ID of the user for whom the SAP Ariba web serv
ice will perform the action.
OnBehalfUserPasswordAdap
ter
No String. Species the password adapter to authenticate the user in the
OnBehalfUserId element.
If you are not using a custom password adapter, you can omit this element
or leave the value unspecied and the web service will use the default pass
word adapter.
WorkspaceId Yes String. Species the workspace ID of the project (workspace) that contains
the Contract Terms to be downloaded.
ContractTermsDownloadReply Elements
WSContractTermsDownloadOutputBean
Element Type and Description
ErrorMessage String. Message (error or conrmation) returned by the web service.
Status Integer. Return status. 0 indicates success.
TermsFile XSD base64Binary (string with base64-encoded data). Contents of the Contract
Terms document.
Export Contract Terms
Use the Export Contract Terms web service to export Contract Terms Excel le documents. Contract Terms Excel
le documents such as pricing terms documents or Contract Line Items Document (CLID) are supported in
environments where SAP Ariba Contracts is integrated with one of the SAP Ariba Procurement solutions.
The Export Contract Terms web service sends WSContractTermsExportRequest messages and receives
WSContractTermsExportReply messages.
The Export Contract Terms web service uses an outbound integration end point. Before users can export contract
terms, the parameter Application.ACM.EnableWSContractTermsPush must be enabled as described in
Enabling External Exports for Contract Terms [page 23].
When the Export Contract Terms web service is congured, users can export Contract Terms Excel le documents
by navigating to the Contract Terms Excel le document and choosing Export External System .
SAP Ariba Contracts then initiates an exchange by sending a WSContractTermsExportRequest message to the URL
congured for the outbound endpoint. The request includes a Contract Terms document le, base64 encoded.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 41
WSContractTermsExportRequest Elements
WSContractTermsExportOutputBean
Element Type and Description
PasswordAdapter String. Species the password adapter used to authenticate the user in the User ele
ment.
ProjectInternalId String. Species the system ID of the project (workspace) ID that contains the Contract
Terms document being exported.
TermsFile XSD base64Binary (string with base64-encoded data) Contents of the Contract Terms
document
UserId String. Species the user ID of the user who requested the export operation.
WSContractTermsExportReplyElements
WSContractTermsExportInputBean
Element Required Type and Description
Message Yes String. Message (error or conrmation) returned by the client. Use
Success to indicate that there were no errors.
Status No Integer. Return status. Return 0 to indicate that there were no errors.
Export WorkspaceId
Use the Export WorkspaceId web service to automatically export contract workspace IDs when a contract
workspace is created or published (including administrative amendments that are completed). The actions
(workspace creation, publication, or either) that cause the Export WorkspaceId web service to export IDs is
determined by application parameters set by your SAP Ariba Customer Support representative. For more
information, see Enabling External Exports for Workspace IDs [page 22].
The Export WorkspaceId web service sends WorkspaceIdExportRequest messages and receives
WorkspaceIdExportReply messages.
WorkspaceIdExportRequest Elements
A WorkspaceIdExportRequest contains a WSWorkspaceIdExportOutputBean_Item, which contains a
sequence of an item of the type WSWorkspaceIdExportOutputBean.
42 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
WSWorkspaceIdExportOutputBean
Element Type and Description
ContractId String. Species the workspace’s contract ID.
For more information about contract IDs and workspace IDs, see ContractId and Work
spaceId Elements for Contract Workspaces [page 28].
PasswordAdapter String. Species the password adapter used to verify the identity of the user who per
formed the action that caused the workspace ID to be exported.
UserAction String. Species the user action that caused the workspace ID to be exported.
Valid values:
●Created
●Published
UserId String. Species the identity of the user who performed the action that caused the work
space ID to be exported.
WorkspaceClassName String. Species the type of workspace.
Valid values:
●ariba.collaborate.contracts.ContractWorkspace (procurement
contract workspaces)
●ariba.collaborate.contracts.ContractRequest (procurement con
tract requests)
●ariba.collaborate.contracts.SalesContractWorkspace (sales
contract workspaces)
●ariba.collaborate.contracts.SalesContractRequest (sales con
tract requests)
●ariba.collaborate.contracts.InternalContractWorkspace (in
ternal contract workspaces)
WorkspaceId String. Species the workspace’s unique ID.
For more information about contract IDs and workspace IDs, see ContractId and Work
spaceId Elements for Contract Workspaces [page 28].
WorkspaceIdExportReply
WSWorkspaceIdExportInputBean_Item
Element Required Type and Description
Message Yes String. Message (error or conrmation) returned by the client. Use
Success to indicate that there were no errors.
Status No Integer. Return status. Return 0 to indicate that there were no errors.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 43
Import CLID using XML
The inbound web service Import CLID using XML creates or replaces a contract line items document after
receiving a request from an external system.
The Import CLID using XML request species a workspace ID.
●If the workspace already contains a contract line items document, it is deleted and replaced with a document
using the contents and title specied in the request.
●If the workspace already contains a pricing terms Excel document, the Use As eld is cleared for the Excel
document (the eld is no longer set to Contract Content).
The Import CLID using XML web service receives a ContractContentXMLImportRequest from an external
system and sends a ContractContentXMLImportReply in response.
If you are creating a standard-capacity line items document, a ContractContentXMLImportReply with a
Status element with a 0 value (Success) indicates that the contents of the request were successfully written to
the line items document.
If you are creating a large-capacity line items document, a ContractContentXMLImportReply with a Status
element with a 0 value (Success) indicates that the contents of the request were submitted for processing;
processing can take several minutes. To determine if the contents of the line items document have been processed,
open the document from the Documents area in the workspace.
ContractContentXMLImportRequest
A ContractContentXMLImportRequest contains a WSContractContentXMLImportInputBean_Item, which
contains an item. The item contains the following child elements:
Element Required Type and Description
WorkspaceId Yes String. The ID of the contract workspace in which the contract line items
document will be created or replaced.
Title Yes String. Title for the contract line items document.
ClidImportXMLBean Yes Complex type. Contains contract line item data. See ClidImportXMLBean
[page 45].
IsLargeCapacity Yes Boolean. Species if the contract line items document is a large-capacity
document.
OnBehalfUserId Yes String. ID of the user for whom the web service will import the document.
OnBehalfUserPasswordAdap
ter
No String. Species the password adapter to authenticate the user in the
OnBehalfUserId element. If you are not using a custom password
adapter, you can omit this element or leave the value unspecied and the
web service will use the default password adapter.
44 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
ClidImportXMLBean
A ClidImportXMLBean contains the following child elements:
●ContractItemInformation (one or more occurrences)
●ContractHeader (one optional occurrence
●HeaderAttributes (one optional occurrence)
●ItemAttributes (one optional occurrence)
ContractItemInformation
A ContractItemInformation element contains one or more item child elements; each item element contains
the following child elements:
Element Required Type and Description
Bundle No String. Bundle name, as specied in the event award (for line items docu
ments created from SAP Ariba Sourcing event awards).
ClassificationCode No String. Category or classication code value, such as a commodity code.
ClassificationDomain No String. Domain for the category or classication, such as UNSPSC for com
modities.
Description No String. Item description.
DiscountAmount No String. Discount, specied as a xed amount.
ExtendedDescription No String. Full Description eld for a compliance contract.
ItemNumber No String. Used by SAP Ariba Contracts to identify an item and correlate an
item with item attributes (ItemAttributes child item.
LimitType No String. Species how the limit is regulated--by Amount (cost of items) or
Quantity (number of items).
ManufacturerName No String. Name of manufacturer.
ManufacturerPartNumber No String. Manufacturer's part number.
MaximumAmount No String. Maximum value of the items that can be purchased.
MaximumQuantity No String. Maximum number of items that can be purchased.
MinimumAmount No String. Minimum value of the items that can be purchased.
MinimumQuantity No String. Minimum number of items that can be purchased.
Quantity Yes String. The number of units.
ShortName Yes String. Item name.
SupplierDiscount No String. SAP Ariba does not set or read this eld.
SupplierPartNumber No String. Supplier part number.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 45
Element Required Type and Description
UnitOfMeasure Yes String. Unit of measure for the unit price (Price Unit eld for a compliance
contract).
UnitOfPrice No String. Price per unit.
UnitPriceCurrency No String. Currency type for unit price.
ContractHeader
A ContractHeader element contains an optional item child element; the item element contains the following
child elements:
Element Required Type and Description
AgreementDate No XSD DateTime. Agreement Date, such as the date from the workspace
header.
BuyerContractID No String. The corresponding SAP Ariba Procurement solutions compliance
contract ID.
CompanyName No String. SAP Ariba does not set or read this eld.
ContractCurrency No String. SAP Ariba does not set or read this eld.
ContractSource No String. Species the source of the contract workspace (Ariba).
Description No String. Description for the line items document.
EffectiveDate No XSD DateTime. Eective Date, such as the date from the workspace
header.
EventID No String. Document ID and title (docId - title) of the line items.
ExpirationDate No XSD DateTime. Expiration Date from the workspace header.
LimitType No String. Species how the limit is regulated--by Amount (cost of items) or
Quantity (number of items).
MaximumAmount No String. SAP Ariba does not set or read this eld.
MinimumAmount No String. SAP Ariba does not set or read this eld.
ReferenceDocument No String. If the line items document was created from a contract terms link to
a compliance contract, specify the ID of the contract terms.
Requester No String. ID of the user who created or updated this document.
SupplierIDDomain No String. Domain from which the supplier ID is assigned, such as
buyersystemid or sap. A supplier can have multiple IDs, each as
signed from a dierent domain.
SupplierIDValue No String. Supplier ID.
SupplierName No String. Supplier eld from the project header.
TermType No String. Contract type. If specied, this must be Item.
Title No String. Title of the line items document.
46 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
HeaderAttributes
The following child elements are dened for the HeaderAttributes element but SAP Ariba does not set or read
values for these elements:
●AttributeName
●AttributeValue
●DisplayText
●Type
●Description
●TableSectionColumn
ItemAttributes
An ItemAttributes element contains optional item child elements; each item element contains the following
child elements:
Element Required Type and Description
AttributeName No String. Attribute name.
AttributeValue No String. Attribute value.
Description No String. Description for the attribute.
DisplayText No String. Display text for the attribute.
ItemNumber No String. Used by SAP Ariba Contracts to correlate attributes with an item
(ContractItemInformation child item).
LineType No Used for service item hierarchies. Species the type of service item. Valid
values:
●Service Line (top-most level; all service outlines and service
specications must be contained in a service line)
●Service Outline (optional objects used to organize service
items; can contain child service outlines or service specications)
●Service Specification (species a service to be performed;
cannot contain any children)
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 47
Element Required Type and Description
Number No Used for service item hierarchies. A string with a unique dotted-decimal
value that indicates the item's hierarchy and its position in the hierarchy.
For example, items with Number values 2, 2.1, and 2.1.1 are members
of the same hierarchy. The item with Number 2 is at the highest level of the
hierarchy and the item with Number 2.1.1 is at the lowest level.
Number is used only to dene service item hierarchies and is ignored if
LineType is not Service Line, Service Outline, or Service
Specification. Number has no eect on an item's order in a list, other
than ensuring that the items in the same hierarchy are listed together and
in descending order.
Type No String. Data type for the attribute, such as Text or Money.
ContractContentXMLImportReply
The ContractContentXMLImportReply contains a WSContractContentXMLOutputBean_Item. The
WSContractContentXMLOutputBean_Item contains a sequence of one item. The item contains the following
child elements:
Element Type and Description
DocumentId String. Unique system ID for the created or updated document.
ErrorMessage String. Message (error or conrmation) returned by the web service.
Status Integer. Return status.
If you are creating a standard-capacity line items, 0 indicates that the contents of the
request were successfully written to the line items document.
If you are creating a large-capacity line items document, 0 indicates that the contents
of the request were submitted for processing; processing can take several minutes. To
determine if the contents of the line items document have been processed, open the
document from the Documents area in the workspace and check the status message
for the import.
Import Contract Line Items Document
The inbound web service, Import Contract Line Items Document, creates a contract line items document
after receiving a request from an external system. The contents for the contract line items document are specied
in a pricing terms Excel document, base64 encoded.
To create a pricing terms Excel document for the contents, you can use the information in Excel format for contract
line items documents [page 132] to create an Excel document in the correct format. The document must include a
Contract Item Information worksheet. You can omit the Contract Header and Header Attributes worksheets. If
48 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
you do not need or want to specify terms specic to item master data, you can also omit the Item Attributes
worksheet.
The Import Contract Line Items Document request species a workspace ID.
●If the workspace already contains a contract line items document, it is deleted and replaced with a document
using the contents and title specied in the Import Contract Line Items Document request.
●If the workspace already contains a pricing terms Excel document, the Use As eld is cleared for the Excel
document (the eld is no longer set to Contract Content).
The Import Contract Line Items Document web service receives a
ContractContentDocumentImportRequest from an external system and sends a
ContractContentDocumentImportReply in response.
If you are creating a standard-capacity line items document, a ContractContentDocumentImportReply with a
Status element with a 0 value (Success) indicates that the contents of the request were successfully written to
the line items document.
If you are creating a large-capacity line items document, a ContractContentDocumentImportReply with a
Status element with a 0 value (Success) indicates that the contents of the request were submitted for processing;
processing can take several minutes. To determine if the contents of the line items document have been processed,
open the document from the Documents area in the workspace.
●If the status is The Excel import request has been submitted successfully, the contents have not completed
processing.
●If the status is The Excel import request has been completed successfully, the contents have completed
processing and are ready for use.
ContractContentDocumentImportRequest Elements
The ContractContentDocumentImportRequest contains a
WSContractContentDocumentInputBean_Item. The WSContractContentDocumentInputBean_Item
contains a sequence with one WSContractContentDocumentInputBean.
WSContractContentDocumentInputBean
Element Required Type and Description
Contents Yes XSD base64Binary (string with base64-encoded data). A pricing terms Ex
cel le, base64 encoded.
IsLargeCapacity Yes Boolean. If false, create or update a standard-capacity line items docu
ment; the pricing terms in the Contents cannot contain more than 2000
items. If true, create a large-capacity line items document.
OnBehalfUserId Yes String. Species the user ID of the user for whom the SAP Ariba web serv
ice will perform the action.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 49
Element Required Type and Description
OnBehalfUserPasswordAdap
ter
No String. Species the password adapter to authenticate the user in the
OnBehalfUserId element.
If you are not using a custom password adapter, you can omit this element
or leave the value unspecied and the web service will use the default pass
word adapter.
Title Yes String. Species the document name.
WorkspaceId Yes String. Species the ID of the project (workspace) in which the document
will be created or that contains the document to be replaced. If the work
space already contains a line items document, the document is deleted
and replaced with a document created using the contents of the Title
and Contents elements.
ContractContentDocumentImportReply Elements
The ContractContentDocumentImportReply contains a WSContractContentDocumentOutputBean_Item.
The WSContractContentDocumentOutputBean_Item contains a sequence of one
WSContractContentDocumentOutputBean.
WSContractContentDocumentOutputBean
Element Type and Description
DocumentId String. Unique system ID for the created or updated document.
ErrorMessage String. Message (error or conrmation) returned by the web service.
Status Integer. Return status.
If you are creating a standard-capacity line items, 0 indicates that the contents of the
request were successfully written to the line items document.
If you are creating a large-capacity line items document, 0 indicates that the contents
of the request were submitted for processing; processing can take several minutes. To
determine if the contents of the line items document have been processed, open the
document from the Documents area in the workspace and check the status message
for the Excel import.
Import Internal Contract Workspace
Use the Import Internal Contract Workspace web service to create internal contract workspaces (projects) or to
update internal contract project header elds.
50 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
The Import Internal Contract Workspace web service receives InternalContractWorkspaceImportRequest
messages and responds with InternalContractWorkspaceImportReply messages.
If you are creating a contract project, you must specify the system ID of the template to use for creating the project.
You can also specify a contract ID to use when creating the project. You can use this contract ID to identify the
project when updating the project.
If you are creating or updating a project and your conguration does not contain any custom elds, you must omit
the custom element in the rst level immediately below the ProjectHeaderFields element.
If the organizations that can be selected for the Aected Parties eld do not contain any custom elds, you must
omit the custom element contained in the AffectedParties element. Alternatively, you can omit the entire
AffectedParties element.
The InternalContractRequestWorkspaceReply includes a URL (web jumper) to the created or updated project.
If you are updating a project, the SAP Ariba web service retains the existing values for any project header eld
elements that you do not include or for which you do not specify a value.
InternalContractWorkspaceImportRequest Elements
InternalWSContractWorkspaceInputBean
Element Required Type and Description
Action Yes String. Species the action for the task.
Valid values:
●Create. Creates a new project.
●Update. Update project elds of an existing project. You can update
the elds of a published contract workspace, but this will not create a
new amendment or version.
OnBehalfUserId Yes String. Species the user ID of the user for whom the SAP Ariba web serv
ice will perform the action. When creating a project, the SAP Ariba web
service creates the project with this user as the owner if the Owner ele
ment is not specied.
OnBehalfUserPasswordAdap
ter
No String. Species the password adapter to authenticate the user in the
OnBehalfUserId element.
If you are not using a custom password adapter, you can omit this element
or leave the value unspecied and the web service will use the default pass
word adapter.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 51
Element Required Type and Description
ParentAgreementId Yes String. Specify the internal ID of the master agreement when updating a
subagreement (HierarchicalType is SubAgreement) to validate its
identity. Do not specify a value if the project is not a subagreement
(HierarchicalType is StandAlone or MasterAgreement).
If the master agreement was created with the interactive user interface, its
internal ID and displayed Contract ID values are the same. If the master
agreement was created using a legacy load operation, its internal ID is not
displayed but the
Application.ACM.EvaluateParentAgreementFromParentC
ontractId site conguration option can be set to yes so that the web
service accepts the Contract ID instead of the internal ID. For more infor
mation, see Site Conguration Options for Integration Services [page 150].
ParentWorkspaceId Yes String. The contract ID (for example, CW12345) of the parent project for
the contract project. Specifying a value in this eld creates the workspace
as a subproject of the specied parent.
ProjectHeaderFields No InternalContractWorkspace_WSProjectImport. Project
header elds. See ProjectHeaderFields [page 53].
TemplateId Yes String. System ID that species the template to use to create the project
(for example, SYS0052).
If the Action element is Update, this element is ignored.
WorkspaceId Yes String. Species the workspace ID. When using the service to create a
project, do not specify a value. If the SAP Ariba web service successfully
creates a project, it returns the system-generated workspace ID in the the
WorkspaceId element of the response.
If you are updating a contract project, you must use the WorkspaceId
element or the ContractId element to identify the project you want to
update.
For more information, see ContractId and WorkspaceId Elements for Con
tract Workspaces [page 28].
52 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
ProjectHeaderFields
Element Required Type and Description
AffectedParties No Complex type. Supplier or customer organizations who are involved in the
contract project, but who might not be direct participants. This eld is often
used in contracts referred to as "multi-party contracts."
This element contains a sequence of zero or more items with the following
child elements:
●SystemID (optional string). Species the system ID for the organiza
tion. To determine valid IDs, use the Export Organizations task.
●custom (optional complex type). Custom elds. For more informa
tion, see Custom Body Elements for Web Services [page 30].
AgreementDate No XSD DateTime. The date for the agreement. You can use this eld as de
ned by your organization. For more information, see XSD DateTime Ele
ments [page 29].
Amount No Complex type. The negotiated and approved contract amount for the com
pleted contract project. The amount might dier from any
ProposedAmount value specied at the beginning of the project. This el
ement has the following child elements:
●Amount (optional decimal): Decimal amount.
●Currency (optional complex type): Contains UniqueName (op
tional string). Species the currency type using the ISO 4217 alpha
betic code (for example, USD, EUR, or CNY).
AutoRenewalInterval No Integer. Species the renewal interval, in months. Required if
ExpirationTermType is AutoRenew.
BaseLanguage No Complex type. This element has the following child element:
●UniqueName (optional string): Species the language in which a user
sees the project if there is no translation for the project in the user’s
preferred language. For a list of valid values, see Country, Currency,
BaseLanguage, and LocaleID Elements [page 28].
Client No Complex type. The departments in your company for which the project is
applicable. This element contains a sequence of zero or more of the follow
ing item:
●DepartmentID (optional string): Species the system ID for the de
partment. To determine valid values, use the Export Departments task.
Commodity No Complex type. The commodity for the project. This element contains a se
quence of zero or more items with the following child elements:
●Domain (required string): Species the domain or organization that
denes the values for the commodity code. For most installations, the
value will be unspsc (Universal Standard Products and Services Clas
sication).
●UniqueName (required string): Species the ID for the commodity,
such as the numeric commodity code. To determine the valid com
modity ID values, use the Export Commodity Codes task.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 53
Element Required Type and Description
ContractId No String. Species the contract's unique ID. This can be the unique ID used in
the third-party system. If you are creating a contract project, the system
creates the project and assigns this contract ID if it is not already in use; if
you do not specify a value, the SAP Ariba web service assigns the system-
generated workspace ID as the contract ID.
If you are updating a project, you must use the ContractId element or
the WorkspaceId element to identify the project you want to update.
For more information, see ContractId and WorkspaceId Elements for Con
tract Workspaces [page 28].
Description No Complex type. This element has the following child element:
●DefaultStringTranslation (optional string): Description for
the project.
EffectiveDate Yes XSD DateTime. The date when the terms of the contract go into eect.
ExpirationDate No XSD DateTime. The date on which the contract expires. This eld is ignored
in contract workspaces with a Perpetual expiration term type.
ExpirationTermType Yes String. Controls the behavior of a contract project when it reaches its expi
ration date. Valid values are:
●Fixed. The contract workspace expires when it reaches its expiration
date.
●Perpetual. The contract workspace never expires; also known as an
evergreen contract.
●AutoRenew. The contract workspace is automatically extended past
its expiration date according to the Renewal Interval and the Maximum
Number of Renewals elds.
If no value is specied for this element and the workspace does not al
ready exist (Action is Create), the value Fixed is used; if the
workspace already exists (Action is Update), the current value for
the workspace is retained.
HierarchicalType No String. Species the hiearchical type. Valid values:
●StandAlone
●MasterAgreement
●SubAgreement
If you specify SubAgreement, use the ParentAgreementID ele
ment to specify the contract ID of the master agreement.
If no value is specied for this element and the workspace does not al
ready exist (Action is Create), the value StandAlone is used; if
the workspace already exists (Action is Update), the current value
for the workspace is retained.
MaxAutoRenewalsAllowed No Integer. Maximum number of renewals allowed. Required if
ExpirationTermType is AutoRenew.
54 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
Owner No Complex type. Species the owner for the project. If you are creating a
project and do not include this element, the project is created with the user
specied in the OnBehalfUserId element as the owner. This element
has the following child element:
●UniqueName (optional string): Unique name (for example, jsmith)
of the owner.
ProposedAmount No Complex type. The proposed monetary amount of the contract. This ele
ment has the following child elements:
●Amount (optional decimal): Decimal amount.
●Currency (optional complex type): Contains UniqueName (op
tional string). Species the currency type using the ISO 4217 alpha
betic code (for example, USD, EUR, or CNY).
Region No Complex type. The region for the project. This element contains a sequence
of zero or more items with the following child element:
●Region (optional string): Species the region. To determine valid val
ues, use the Export Regions task.
RelatedId No String. Species any related ID, such as an ID for a related record or docu
ment in an external system.
Title No Complex type. This element has the following child element:
●DefaultStringTranslation (optional string): Workspace title.
custom No Complex type. This element is used for custom project header elds. For
more information, see Custom Body Elements for Web Services [page 30].
InternalContractWorkspaceImportReply Elements
InternalWSContractWorkspaceOutputBean
Element Type and Description
ErrorMessage String. Message (error or conrmation) returned by the web service.
Status Integer. Return status. 0 indicates success.
Url String. URL to the created or updated project.
WorkspaceId String. Unique, system-generated ID for the created or updated project.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 55
Import Procurement Contract Request and Import
Procurement Contract Workspace
Use the Import Procurement Contract Request and Import Procurement Contract Workspace web services to
create procurement contract requests or workspaces. You can also use these web services to update procurement
contract project header elds.
The Import Procurement Contract Request web service receives ContractRequestImportRequest messages
and responds with ContractRequestImportReply messages.
The Import Procurement Contract Workspace web service receives ContractWorkspaceImportRequest
messages and responds with ContractWorkspaceImportReply messages.
If you are creating a contract project, you must specify the system ID of the template to use for creating the project.
You can also specify a contract ID to use when creating the project. You can use this contract ID to identify the
project when updating the project.
If you are creating or updating a project and your conguration does not contain any custom elds, you must omit
the custom element in the rst level immediately below the ProjectHeaderFields element.
If the organizations that can be selected for the Aected Parties eld do not contain any custom elds, you must
omit the custom element contained in the AffectedParties element. Alternatively, you can omit the entire
AffectedParties element.
The ContractRequestImportReply or the ContractRequestWorkspaceReply includes a URL (web jumper) to the
created or updated project.
If you are updating a project, the SAP Ariba web service retains the existing values for any project header eld
elements that you do not include or for which you do not specify a value.
The following project header eld elements are supported for contract workspaces but are not supported for
contract requests:
●HierarchicalType
●RelatedId
For an example of an Import Procurement Contract Workspace request, see Web Service Example: Creating a
Procurement Contract Workspace [page 117].
56 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
ContractRequestImportRequest and
ContractWorkspaceImportRequest Elements
WSContractRequestInputBean or WSContractWorkspaceInputBean
Element Required Type and Description
Action Yes String. Species the action for the task.
Valid values:
●Create. Creates a new project.
●Update. Update project elds of an existing project. You can update
the elds of a published contract workspace, but this will not create a
new amendment or version.
OnBehalfUserId Yes String. Species the user ID of the user for whom the SAP Ariba web serv
ice will perform the action. When creating a project, the SAP Ariba web
service creates the project with this user as the owner if the Owner ele
ment is not specied.
OnBehalfUserPasswordAdap
ter
No String. Species the password adapter to authenticate the user in the
OnBehalfUserId element.
If you are not using a custom password adapter, you can omit this element
or leave the value unspecied and the web service will use the default pass
word adapter.
ParentAgreementId Yes String. Specify the internal ID of the master agreement when updating a
subagreement (HierarchicalType is SubAgreement) to validate its
identity. Do not specify a value if the project is not a subagreement
(HierarchicalType is StandAlone or MasterAgreement).
If the master agreement was created with the interactive user interface, its
internal ID and displayed Contract ID values are the same. If the master
agreement was created using a legacy load operation, its internal ID is not
displayed but the
Application.ACM.EvaluateParentAgreementFromParentC
ontractId site conguration option can be set to yes so that the web
service accepts the Contract ID instead of the internal ID. For more infor
mation, see Site Conguration Options for Integration Services [page 150].
ParentWorkspaceId Yes String. The contract ID (for example, CW12345) of the parent project for
the contract project. Specifying a value in this eld creates the workspace
as a subproject of the specied parent.
ProjectHeaderFields No ContractRequest_WSProjectImport or
ContractWorkspace_WSProjectImport. Project header elds.
See ProjectHeaderFields [page 58].
TemplateId Yes String. System ID that species the template to use to create the project
(for example, SYS0052).
If the Action element is Update, this element is ignored.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 57
Element Required Type and Description
WorkspaceId Yes String. Species the workspace ID. When using the service to create a
project, do not specify a value. If the SAP Ariba web service successfully
creates a project, it returns the system-generated workspace ID in the the
WorkspaceId element of the response.
If you are updating a contract project, you must use the WorkspaceId
element or the ContractId element to identify the project you want to
update.
For more information, see ContractId and WorkspaceId Elements for Con
tract Workspaces [page 28].
ProjectHeaderFields
Element Required Type and Description
AffectedParties No Complex type. Supplier or customer organizations who are involved in the
contract project, but who might not be direct participants. This eld is often
used in contracts referred to as "multi-party contracts."
This element contains a sequence of zero or more items with the following
child elements:
●SystemID (optional string). Species the system ID for the organiza
tion. To determine valid IDs, use the Export Organizations task.
●custom (optional complex type). Custom elds. For more informa
tion, see Custom Body Elements for Web Services [page 30].
AgreementDate No XSD DateTime. The date for the agreement. You can use this eld as de
ned by your organization. For more information, see XSD DateTime Ele
ments [page 29].
Amount No Complex type. The negotiated and approved contract amount for the com
pleted contract project. The amount might dier from any
ProposedAmount value specied at the beginning of the project. This el
ement has the following child elements:
●Amount (optional decimal): Decimal amount.
●Currency (optional complex type): Contains UniqueName (op
tional string). Species the currency type using the ISO 4217 alpha
betic code (for example, USD, EUR, or CNY).
AutoRenewalInterval No Integer. Species the renewal interval, in months. Required if
ExpirationTermType is AutoRenew.
BaseLanguage No Complex type. This element has the following child element:
●UniqueName (optional string): Species the language in which the
project is displayed if there is no translation for the project in the user’s
preferred language. For a list of valid values, see Country, Currency,
BaseLanguage, and LocaleID Elements [page 28].
58 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
Client No Complex type. The departments in your company for which the project is
applicable. This element contains a sequence of zero or more of the follow
ing item:
●DepartmentID (optional string): Species the system ID for the de
partment. To determine valid values, use the Export Departments task.
Commodity No Complex type. The commodity for the project. This element contains a se
quence of zero or more items with the following child elements:
●Domain (required string): Species the domain or organization that
denes the values for the commodity code. For most installations, the
value will be unspsc (Universal Standard Products and Services Clas
sication).
●UniqueName (required string): Species the ID for the commodity,
such as the numeric commodity code. To determine the valid com
modity ID values, use the Export Commodity Codes task.
ContractId No String. Species the contract's unique ID. This can be the unique ID used in
the third-party system. If you are creating a contract project, the system
creates the project and assigns this contract ID if it is not already in use; if
you do not specify a value, the SAP Ariba web service assigns the system-
generated workspace ID as the contract ID.
If you are updating a project, you must use the ContractId element or
the WorkspaceId element to identify the project you want to update.
For more information, see ContractId and WorkspaceId Elements for Con
tract Workspaces [page 28].
Description No Complex type. This element has the following child element:
●DefaultStringTranslation (optional string): Description for
the project.
EffectiveDate Yes XSD DateTime. The date when the terms of the contract go into eect.
ExpirationDate No XSD DateTime. The date on which the contract expires. This eld is ignored
in contract workspaces with a Perpetual expiration term type.
ExpirationTermType Yes String. Controls the behavior of a contract project when it reaches its expi
ration date. Valid values are:
●Fixed. The contract workspace expires when it reaches its expiration
date.
●Perpetual. The contract workspace never expires; also known as an
evergreen contract.
●AutoRenew. The contract workspace is automatically extended past
its expiration date according to the Renewal Interval and the Maximum
Number of Renewals elds.
If no value is specied for this element and the workspace does not al
ready exist (Action is Create), the value Fixed is used; if the
workspace already exists (Action is Update), the current value for
the workspace is retained.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 59
Element Required Type and Description
HierarchicalType No String. Species the hiearchical type. Valid values:
●StandAlone
●MasterAgreement
●SubAgreement
If you specify SubAgreement, use the ParentAgreementID ele
ment to specify the contract ID of the master agreement.
If no value is specied for this element and the workspace does not al
ready exist (Action is Create), the value StandAlone is used; if
the workspace already exists (Action is Update), the current value
for the workspace is retained.
Note
This element is not present in ContractRequestImportRequest
messages.
MaxAutoRenewalsAllowed No Integer. Maximum number of renewals allowed. Required if
ExpirationTermType is AutoRenew.
Owner No Complex type. Species the owner for the project. If you are creating a
project and do not include this element, the project is created with the user
specied in the OnBehalfUserId element as the owner. This element
has the following child element:
●UniqueName (optional string): Unique name (for example, gsun) of
the owner.
ProposedAmount No Complex type. The proposed monetary amount of the contract. This ele
ment has the following child elements:
●Amount (optional decimal): Decimal amount.
●Currency (optional complex type): Contains UniqueName (op
tional string). Species the currency type using the ISO 4217 alpha
betic code (for example, USD, EUR, or CNY).
Region No Complex type. The region for the project. This element contains a sequence
of zero or more items with the following child element:
●Region (optional string): Species the region. To determine valid val
ues, use the Export Regions task
RelatedId No String. Species any related ID, such as an ID for a related record or docu
ment in an external system.
Note
This element is not present in ContractRequestImportRequest mes
sages.
60 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
Supplier No Complex type. Species the supplier. This element has the following child
element:
●SystemID (optional string): Species the system ID of the supplier.
To determine valid values, use the Export Organizations task. You can
also view the supplier in the chooser for the Customer eld of a
project; click on the supplier name to view the details for the name and
use the value displayed in the ID eld.
Title No Complex type. This element has the following child element:
●DefaultStringTranslation (optional string): Workspace title.
custom No Complex type. This element is used for custom project header elds. For
more information, see Custom Body Elements for Web Services [page 30].
ContractRequestImportReply and
ContractWorkspaceImportReplyElements
WSContractRequestOutputBean or WSContractWorkspaceOutputBean
Element Type and Description
ErrorMessage String. Message (error or conrmation) returned by the web service.
Status Integer. Return status. 0 indicates success.
Url String. URL to the created or updated project.
WorkspaceId String. Unique, system-generated ID for the created or updated project.
Import Sales Contract Request and Import Sales Contract
Workspace
Use the Import Sales Contract Request and Import Sales Contract Workspace web services to create sales
contract requests or workspaces. You can also use these web services to update sales contract project header
elds.
The Import Sales Contract Request web service receives SalesContractRequestImportRequest messages
and responds with SalesContractRequestImportReply messages.
The Import Sales Contract Workspace web service receives SalesContractWorkspaceImportRequest
messages and responds with SalesContractWorkspaceImportReply messages.
If you are creating a contract project, you must specify the system ID of the template to use for creating the project.
You can also specify a contract ID to use when creating the project. You can use this contract ID to identify the
project when updating the project.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 61
If you are creating or updating a project and your conguration does not contain any custom elds, you must omit
the custom element in the rst level immediately below the ProjectHeaderFields element.
If the organizations that can be selected for the Aected Parties eld do not contain any custom elds, you must
omit the custom element contained in the AffectedParties element. Alternatively, you can omit the entire
AffectedParties element.
The SalesContractRequestImportReply or the SalesContractRequestWorkspaceReply includes a URL (web jumper)
to the created or updated project.
If you are updating a project, the SAP Ariba web service retains the existing values for any project header eld
elements that you do not include or for which you do not specify a value.
To specify values for the Customer project header eld, use the supplier element.
The following project header eld elements are supported for sales contract workspaces but are not supported for
sales contract requests:
●HierarchicalType
●RelatedId
The following project header eld elements are supported for sales contract requests but are not supported for
sales contract workspaces:
●DealStage
●EstimatedCloseDate
SalesContractRequestImportRequest and
SalesContractWorkspaceImportRequest Elements
WSSalesContractRequestInputBean or WSSalesContractWorkspaceInputBean
Element Required Type and Description
Action Yes String. Species the action for the task.
Valid values:
●Create. Creates a new project.
●Update. Update project elds of an existing project. You can update
the elds of a published contract workspace, but this will not create a
new amendment or version.
OnBehalfUserId Yes String. Species the user ID of the user for whom the SAP Ariba web serv
ice will perform the action. When creating a project, the SAP Ariba web
service creates the project with this user as the owner if the Owner ele
ment is not specied.
62 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
OnBehalfUserPasswordAdap
ter
No String. Species the password adapter to authenticate the user in the
OnBehalfUserId element.
If you are not using a custom password adapter, you can omit this element
or leave the value unspecied and the web service will use the default pass
word adapter.
ParentAgreementId Yes String. Specify the internal ID of the master agreement when updating a
subagreement (HierarchicalType is SubAgreement) to validate its
identity. Do not specify a value if the project is not a subagreement
(HierarchicalType is StandAlone or MasterAgreement).
If the master agreement was created with the interactive user interface, its
internal ID and displayed Contract ID values are the same. If the master
agreement was created using a legacy load operation, its internal ID is not
displayed but the
Application.ACM.EvaluateParentAgreementFromParentC
ontractId site conguration option can be set to yes so that the web
service accepts the Contract ID instead of the internal ID. For more infor
mation, see Site Conguration Options for Integration Services [page 150].
ParentWorkspaceId Yes String. The contract ID (for example, CW12345) of the parent project for
the contract project. Specifying a value in this eld creates the workspace
as a subproject of the specied parent.
ProjectHeaderFields No SalesContractRequest_WSProjectImport or
SalesContractWorkspace_WSProjectImport. Project header
elds. See ProjectHeaderFields [page 64].
TemplateId Yes String. System ID that species the template to use to create the project
(for example, SYS0052).
If the Action element is Update, this element is ignored.
WorkspaceId Yes String. Species the workspace ID. When using the service to create a
project, do not specify a value. If the SAP Ariba web service successfully
creates a project, it returns the system-generated workspace ID in the the
WorkspaceId element of the response.
If you are updating a contract project, you must use the WorkspaceId
element or the ContractId element to identify the project you want to
update.
For more information, see ContractId and WorkspaceId Elements for Con
tract Workspaces [page 28].
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 63
ProjectHeaderFields
Element Required Type and Description
AffectedParties No Complex type. Supplier or customer organizations who are involved in the
contract project, but who might not be direct participants. This eld is often
used in contracts referred to as "multi-party contracts."
This element contains a sequence of zero or more items with the following
child elements:
●SystemID (optional string). Species the system ID for the organiza
tion. To determine valid IDs, use the Export Organizations task.
●custom (optional complex type). Custom elds. For more informa
tion, see Custom Body Elements for Web Services [page 30].
AgreementDate No XSD DateTime. The date for the agreement. You can use this eld as de
ned by your organization. For more information, see XSD DateTime Ele
ments [page 29].
Amount No Complex type. The negotiated and approved contract amount for the com
pleted contract project. The amount might dier from any
ProposedAmount value specied at the beginning of the project. This el
ement has the following child elements:
●Amount (optional decimal): Decimal amount.
●Currency (optional complex type): Contains UniqueName (op
tional string). Species the currency type using the ISO 4217 alpha
betic code (for example, USD, EUR, or CNY).
AutoRenewalInterval No Integer. Species the renewal interval, in months. Required if
ExpirationTermType is AutoRenew.
BaseLanguage No Complex type. This element has the following child element:
●UniqueName (optional string): Species the language in which the
project is displayed if there is no translation for the project in the user’s
preferred language. For a list of valid values, see Country, Currency,
BaseLanguage, and LocaleID Elements [page 28].
Client No Complex type. The departments in your company for which the project is
applicable. This element contains a sequence of zero or more of the follow
ing item:
●DepartmentID (optional string): Species the system ID for the de
partment. To determine valid values, use the Export Departments task.
Commodity No Complex type. The commodity for the project. This element contains a se
quence of zero or more items with the following child elements:
●Domain (required string): Species the domain or organization that
denes the values for the commodity code. For most installations, the
value will be unspsc (Universal Standard Products and Services Clas
sication).
●UniqueName (required string): Species the ID for the commodity,
such as the numeric commodity code. To determine the valid com
modity ID values, use the Export Commodity Codes task.
64 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
ContractId No String. Species the contract's unique ID. This can be the unique ID used in
the third-party system. If you are creating a contract project, the system
creates the project and assigns this contract ID if it is not already in use; if
you do not specify a value, the SAP Ariba web service assigns the system-
generated workspace ID as the contract ID.
If you are updating a project, you must use the ContractId element or
the WorkspaceId element to identify the project you want to update.
For more information, see ContractId and WorkspaceId Elements for Con
tract Workspaces [page 28].
DealStage No Integer. A value from 1 to 10 that indicates the position of the sales contract
in the deal cycle, where 1 is the beginning and 10 is the end.
Description No Complex type. This element has the following child element:
●DefaultStringTranslation (optional string): Description for
the project.
EffectiveDate Yes XSD DateTime. The date when the terms of the contract go into eect.
EstimatedCloseDate No XSD DateTime. The estimated close date for the sales contract that results
from this sales contract request.
ExpirationDate No XSD DateTime. The date on which the contract expires. This eld is ignored
in contract workspaces with a Perpetual expiration term type.
ExpirationTermType Yes String. Controls the behavior of a contract project when it reaches its expi
ration date. Valid values are:
●Fixed. The contract workspace expires when it reaches its expiration
date.
●Perpetual. The contract workspace never expires; also known as an
evergreen contract.
●AutoRenew. The contract workspace is automatically extended past
its expiration date according to the Renewal Interval and the Maximum
Number of Renewals elds.
If no value is specied for this element and the workspace does not al
ready exist (Action is Create), the value Fixed is used; if the
workspace already exists (Action is Update), the current value for
the workspace is retained.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 65
Element Required Type and Description
HierarchicalType No String. Species the hiearchical type. Valid values:
●StandAlone
●MasterAgreement
●SubAgreement
If you specify SubAgreement, use the ParentAgreementID ele
ment to specify the contract ID of the master agreement.
If no value is specied for this element and the workspace does not al
ready exist (Action is Create), the value StandAlone is used; if
the workspace already exists (Action is Update), the current value
for the workspace is retained.
Note
This element is not present in SalesContractRequestImportRequest
messages.
MaxAutoRenewalsAllowed No Integer. Maximum number of renewals allowed. Required if
ExpirationTermType is AutoRenew.
Owner No Complex type. Species the owner for the project. If you are creating a
project and do not include this element, the project is created with the user
specied in the OnBehalfUserId element as the owner. This element
has the following child element:
●UniqueName (optional string): Unique name (for example, jsmith)
of the owner.
Product No Complex type. The products for the project. This element contains a se
quence of zero or more items with the following child element:
●UniqueName (optional string): The product code. To determine valid
values, use the Export Products task.
ProposedAmount No Complex type. The proposed monetary amount of the contract. This ele
ment has the following child elements:
●Amount (optional decimal): Decimal amount.
●Currency (optional complex type): Contains UniqueName (op
tional string). Species the currency type using the ISO 4217 alpha
betic code (for example, USD, EUR, or CNY).
Region No Complex type. The region for the project. This element contains a sequence
of zero or more items with the following child element:
●Region (optional string): Species the region. To determine valid val
ues, use the Export Regions task
RelatedId No String. Species any related ID, such as an ID for a related record or docu
ment in an external system.
Note
This element is not present in SalesContractRequestImportRequest
messages.
66 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
Supplier No Complex type. Species the customer. This element has the following child
element:
●SystemID (optional string): Species the system ID of the customer.
To determine valid values, use the Export Organizations task. You can
also view the customer in the chooser for the Customer eld of a
project; click on the customer name to view the details for the name
and use the value displayed in the ID eld.
Title No Complex type. This element has the following child element:
●DefaultStringTranslation (optional string): Workspace title.
custom No Complex type. This element is used for custom project header elds. For
more information, see Custom Body Elements for Web Services [page 30].
SalesContractRequestImportReply and
SalesContractWorkspaceImportReply Elements
WSSalesContractRequestOutputBean or
WSSalesContractWorkspaceOutputBean
Element Type and Description
ErrorMessage String. Message (error or conrmation) returned by the web service.
Status Integer. Return status. 0 indicates success.
Url String. URL to the created or updated project.
WorkspaceId String. Unique, system-generated ID for the created or updated project.
SOAP Web Services for Sourcing Events and Projects
You can use the following web services to manage sourcing events and sourcing full projects:
●DocumentStatusChangeNotication [page 68] (for Document URL terms)
●DocumentURLOutBound [page 71] (for Document URL terms)
●Download RFX Awards [page 81]
●Download RFX Awards with Filters [page 82]
●Export RFX Awards [page 84]
●Import Sourcing Event [page 85]
●Import Sourcing Project [page 90]
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 67
DocumentStatusChangeNotication
The DocumentStatusChangeNotication service sends event status update changes so you can change the
availability or state of documents referenced in a Document URL term.
You must use the DocumentStatusChangeNotication service with the DocumentURLOutBound [page 71]
service (the request requires a UniqueId returned in a DocumentURLOutBound response).
SAP Ariba sends DocumentStatusChangeNotificationRequest messages and receives
DocumentStatusChangeNotificationReply messages. SAP Ariba sends a
DocumentStatusChangeNotificationRequest message if an event meets the conditions for the
DcoumentURLOutBound service and the event status changes. See Status [page 75] for list of possible status
values.
DocumentStatusChangeNoticationRequest
SAP Ariba sends a DocumentStatusChangeNotificationRequest when the state of an event changes and the
Enable document URL terms event rule is set to Yes.
A DocumentStatusChangeNotificationRequest contains a
WSDocumentStatusChangeNotificationRequest_Item. The
WSDocumentStatusChangeNotificationRequest_Item contains an item element. The item element
includes a Status element with the event status, which the buyer can use to modify the state of the web service
for the URLs.
The item element contains the following elements:
●Realm [page 70] (the realm in which the event is hosted)
●Status [page 78] (the event status)
●Type [page 80] (the event type)
●UniqueId [page 77] (a unique ID for the event; used to correlate DocumentURLOutBound and
DocumentStatusChangeNotification events)
Realm
Element Required Type and Description
Realm Yes String. Species the name of the realm hosting the event.
68 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Status
Element Required Type and Description
Status Yes String. Species the state of the event. The values are relevant to the web
service and might not match the status displayed for the event in the user
interface.
For DocumentURLOutBoundRequest messages, SAP Ariba sends one of
the following values:
●Draft (the event is in the Draft state and is not published)
●RFXDocument:Publish (the event is published)
●RFXDocument:RePublish (a previously published event was
edited and republished)
For DocumentStatusChangeNoticationRequest messages, SAP Ariba
sends one of the following values:
●RFXDocument:MoveToOpen (the preview time for the event has
elapsed and the event is open to receive responses)
●RFXDocument:Reopen (a closed event was reopened)
●RFXDocument:Extend (the event time was extended)
●RFXDocument:Suspend (the event manager suspended the
event)
●RFXDocument:cancel (the event manager canceled the event)
●RFXDocument:close (the event has closed for responses and the
status moved to Pending Selection or Completed)
Type
Element Required Type and Description
Type Yes String. Species the event type.
Use the value RFx for RFI and RFP events.
UniqueId
Element Required Type and Description
UniqueId Yes String. Species a unique ID for the event, used by the DocumentURLOut
Bound and DocumentStatusChangeNotication web services.
Use this value to correlate DocumentURLOutBound and DocumentStatu
sChangeNotication requests.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 69
DocumentStatusChangeNoticationReply
You use a DocumentStatusChangeNotificationReply to send an acknowledgement for a
DocumentStatusChangeNotificationRequest.
A DocumentURLOutBoundReply contains a WSDocumentURLOutBoundResponse_Item. The
WSDocumentURLOutBoundResponse_Item contains an item element. The item element contains the following
elements:
●ErrorMessage [page 77] (error message)
●Realm [page 70] (realm in which the event is hosted)
●Status [page 78] (status for the operation)
●Type [page 80] (type of event)
●UniqueId [page 77] (a unique ID for the event; used to correlate DocumentURLOutBound and
DocumentStatusChangeNotification events)
ErrorMessage
Element Required Type and Description
ErrorMessage Yes String. The error or status message for the entire operation.
The contents of this element are not processed by SAP Ariba are and re
served for future use.
Realm
Element Required Type and Description
Realm Yes String. Species the name of the realm hosting the event.
Status
Element Required Type and Description
String Yes String. Species the status for the entire operation.
The contents of this element are not processed by SAP Ariba are and re
served for future use, such as using the value 0 to indicate success.
70 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Type
Element Required Type and Description
Type Yes String. Species the event type.
Use the value RFx for RFI and RFP events.
UniqueId
Element Required Type and Description
UniqueId Yes String. Species a unique ID for the event, used by the DocumentURLOut
Bound and DocumentStatusChangeNotication web services.
Use this value to correlate DocumentURLOutBound and DocumentStatu
sChangeNotication requests.
DocumentURLOutBound
The DocumentStatusChangeNotication service retrieves values for Document URL line item terms. The purpose
of a Document URL term is to provide a link (URL) that participants can click to obtain documents from your site
about the item with a Description.
SAP Ariba sends DocumentURLOutBoundRequest messages and receives DocumentURLOutBoundReply
messages. You must use the DocumentURLOutBound service with the DocumentStatusChangeNotication [page
68] service.
The workow for using the DocumentURLOutBound and DocumentStatusChangeNotication services is as
follows:
●An administrator or integration team sets up the web services. This includes the following tasks:
○Creating web services on a buyer's server that send responses to DocumentURLOutBound and
DocumentStatusChangeNotication requests sent by SAP Ariba.
○Using the SAP Ariba Integration Manager to congure and enable the DocumentURLOutBound and
DocumentStatusChangeNotication outbound web services. The conguration includes security
parameters and the URL for the buyer's web server.
●A template author sets the Enable document URL terms event rule under Project Owner Actions to Yes.
●(Optional) A template author adds the global term Document URL to the Line Item denition in an RFI or RFX
event template.
●An event manager creates an RFI or RFP that contains line items with a Document URL term. The event
manager invites participants.
●(Optional) The event manager clicks Retrieve document URLs.
○SAP Ariba sends a DocumentURLOutBound request to the buyer's server. The request includes an entry
for each combination of participant and item with a Document URL term and information about the event,
such as the regions. The request also includes a Status element for the event with the value Draft.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 71
○The buyer's web service sends back a reply with URLs. The reply must include an entry for each
combination of participant and item with a Document URL term, and each of these entries must specify a
URL to a buyer document. The buyer can use information in the request (such as the event state, start
time, commodities, or regions, participants) to determine what URLs to send in the response and the state
of the web server for the URLs. The URLs sent in the response do not have to be unique. Multiple
combinations of a participant and item can reference the same URL (the same URL can be used for
multiple participants or multiple items).
○The event manager checks the banner (top) area of the contents page to view the status of the Retrieve
document URLs operation. The event manager also checks the status (Info eld) displayed for each
document URL in the event Content or Summary area.
●The event manager publishes the event. SAP Ariba sends a DocumentURLOutBound request. The request
includes a Status element with the value RFXDocument:Publish.
If an error occurs when sending the DocumentURLOutBound request or processing the response, SAP Ariba
displays a warning but allows the event to be published.
Participants viewing event contents can click the Document URL to view documents hosted on the buyer's
server.
●The preview time for the event elapses and the event is open for participants to send responses.
SAP Ariba sends a DocumentStatusChangeNotication request that includes a Status element with the value
RFXDocument:MoveToOpen.
●When the event closes, SAP Ariba sends a DocumentStatusChangeNotication request that includes a Status
element with the value RFXDocument:close. The buyer can choose to disable the document URLs.
If any Document URL terms have manually entered values, SAP Ariba overwrites them with values from the
DocumentURLOutBoundReply message.
DocumentURLOutBoundRequest elements
SAP Ariba sends a DocumentURLOutBoundRequest when an event manager clicks Retrieve document URLs or
publishes an event and the Enable document URL terms event rule is set to Yes.
A DocumentURLOutBoundRequest contains a WSDocumentURLOutBoundRequest_Item. The
WSDocumentURLOutBoundRequest_Item contains an item element. The item element contains the following
elements, which the buyer can use to determine the URLs to send back in the response:
●Commodities [page 73] (the commodities for the event)
●Departments [page 73] (the departments for the event)
●EndTime [page 73] (the end time for the event)
●Owner [page 73] (the event owner)
●RealmName [page 74] (the SAP Ariba realm in which the event is hosted)
●Regions [page 74] (the regions for the event)
●StartTime [page 74] (the start time for the event)
●Status [page 75] (the event status, such as Open)
●Suppliers [page 75] (contains an entry for each participant who is participating in a line item with a
Document URL term; for each participant, there is an entry for each line item)
●Type [page 76] (type of event)
●UniqueId [page 77] (a unique ID for the event; used to correlate DocumentURLOutBound and
DocumentStatusChangeNotification events)
72 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Commodities
The Commodities element contains one or more item elements. Each item element species a value in the
Commodity eld of the project or event header and contains the following elements:
Element Required Type and Description
CommodityName Yes String. Species the name for the commodity (shown in the Name column
for the commodity in the user interface).
UniqueName Yes String. Species the unique identier for the commodity (shown in the ID
column for the commodity in the user interface).
Departments
The Departments element contains one or more item elements. Each item element species a value in the
Departments eld of the project or event header and contains the following elements:
Element Required Type and Description
DepartmentId Yes String. Species the ID for the department (shown in the ID column for the
department in the user interface).
Description Yes String. Description of the department (shown in the Function column for
the department in the user interface).
EndTime
Element Required Type and Description
EndTime Yes Long. Species the end time for the event using the Unix epoch, in millisec
onds (the number of milliseconds since January 1, 1970 UTC).
Owner
The Owner element species information about the event owner and contains the following elements:
Element Required Type and Description
Email Yes String. The email address of the event owner.
Name Yes String. The name of the event owner.
UserId Yes String. The SAP Ariba ID of the event owner.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 73
RealmName
Species the
Element Required Type and Description
RealmName Yes String. Species the SAP Ariba realm (site) hosting the event.
Regions
The Regions element contains one or more item elements. Each item element species a value in the Regions
eld of the project or event header and contains the following elements:
Element Required Type and Description
Description Yes String. Species the description for the region (shown in the Description
column for the region in the user interface).
Region Yes String. ID for the region (shown in the Region column for the region in the
user interface).
StartTime
Element Required Type and Description
StartTime Yes Long. Species the start time for the event using the Unix epoch, in milli
seconds (the number of milliseconds since January 1, 1970 UTC).
74 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Status
Element Required Type and Description
Status Yes String. Species the state of the event. The values are relevant to the web
service and might not match the status displayed for the event in the user
interface.
For DocumentURLOutBoundRequest messages, SAP Ariba sends one of
the following values:
●Draft (the event is in the Draft state and is not published)
●RFXDocument:Publish (the event is published)
●RFXDocument:RePublish (a previously published event was
edited and republished)
For DocumentStatusChangeNoticationRequest messages, SAP Ariba
sends one of the following values:
●RFXDocument:MoveToOpen (the preview time for the event has
elapsed and the event is open to receive responses)
●RFXDocument:Reopen (a closed event was reopened)
●RFXDocument:Extend (the event time was extended)
●RFXDocument:Suspend (the event manager suspended the
event)
●RFXDocument:cancel (the event manager canceled the event)
●RFXDocument:close (the event has closed for responses and the
status moved to Pending Selection or Completed)
Suppliers
The Suppliers element contains one or more item elements. Each item element species an event participant.
Each item element includes a Materials element, which contains an item element for each line item that the
participant can view and respond to (bid on).
The Suppliers child item element contains the following elements:
Element Required Type and Description
ContactEmailAddress Yes String. Email address of the participant.
Contact Name Yes String. Name of the participant.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 75
Element Required Type and Description
Materials Yes Complex type that contains a sequence of item elements, where each
item species information about a line item that the participant can view
and respond to (bid on). Each Materials child item contains the fol
lowing elements:
●MaterialNumber: Required, String. Unique ID for the material
(item).
●Name: Required, String. Name of the material (item).
●Plant: Required, String. ID of the plant for which the item is being
sourced.
●PurchaseOrg: Required, String. ID of the purchasing organization
for the item.
OrganizationID Yes String. System ID of the supplier organization for the participant.
UniqueName Yes String. Unique name (User ID) of the participant.
VendorKeys Yes Complex type that comprises the vendor compound key (a uniform identi
er across all SAP Ariba solutions) for the participant's organization. It
contains the following elements:
●BusinessSystemId: Required, string. Ariba Network uses the
Business System ID value to determine the correct ERP system to
use when buyers have a multiple ERP system integration.
●LocationId: Required, string. Maps to a eld in Oracle and People
soft ERP systems. Not used in SAP ERP systems.
●SiteId: Required, String. The ID of the vendor location.
●VendorId: Required, string. Ariba Network vendor ID for the sup
plier. The vendor identier in your organization’s backend ERP system,
sometimes called a supplier private ID.
Type
Element Required Type and Description
Type Yes String. Species the event type.
The value is RFx for RFI and RFP events.
76 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
UniqueId
Element Required Type and Description
UniqueId Yes String. Species a unique ID for the event, used by the DocumentURLOut
Bound and DocumentStatusChangeNotication web services.
Use this value to correlate DocumentURLOutBound and DocumentStatu
sChangeNotication requests.
DocumentURLOutBoundReply
You use a DocumentURLOutBoundReply to send document URLs for items in an event. The reply must include an
entry for each combination of participant and item with a Document URL term, and each of these entries must
specify a URL to a buyer document. The buyer can use information in the request (such as the event state, start
time, commodities, or regions, participants) to determine what URLs to send in the response and the state of the
web server for the URLs. The URLs sent in the response do not have to be unique. Multiple combinations of a
participant and item can reference the same URL (the same URL can be used for multiple participants or multiple
items).
A DocumentURLOutBoundReply contains a WSDocumentURLOutBoundResponse_Item. The
WSDocumentURLOutBoundResponse_Item contains an item element. The item element contains the following
elements:
●ErrorMessage [page 77] (error message for the entire operation)
●Status [page 78] (status for the entire operation)
●Suppliers [page 78] (a URL and other information for each combination of participant and item sent in the
request)
●Type [page 80] (type of event)
●UniqueId [page 77] (a unique ID for the event; used to correlate DocumentURLOutBound and
DocumentStatusChangeNotification events)
ErrorMessage
Element Required Type and Description
ErrorMessage Yes String. The error or status message for the entire operation.
The contents of this element are not processed by SAP Ariba are and re
served for future use.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 77
Status
Element Required Type and Description
String Yes String. Species the status for the entire operation.
The contents of this element are not processed by SAP Ariba are and re
served for future use, such as using the value 0 to indicate success.
Suppliers
The Suppliers element contains one or more item elements. Each item element species an event participant.
Each item element includes a Materials element, which contains an item element for each line item that the
participant can view and respond to (bid on) and species the document URL for that combination of participant
and item.
Your response must contain a Materials child item element for each Materials child item element sent in the
request.
78 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
The Suppliers child item element contains the following elements:
Element Required Type and Description
Materials Yes Complex type that contains a sequence of item elements, where each
item species the document URL and other information for a line item
that the participant can view and respond to (bid on). Each Materials
child item contains the following elements:
●DocumentUrl: Required, String. URL that the participant can use to
get documents or information about the material. This URL will be dis
played next to the the item when viewed by this participant and will be
clickable.
If the event owner manually entered a value for the URL in the event
contents, the manually-entered values is replaced by the
DocumentUrl.
●DocumentUrlDescription: Required, String. Description for the
document URL. This description will be displayed below the document
URL when viewed by this participant.
●ErrorMessage: Required, String. Message if an error occurred try
ing to return a document URL for this combination of participant and
material.
If non-empty, this is displayed for the event manager in the Info eld
for the combination of participant and material but is not visible to
participants.
●MaterialNumber: Required, String. Unique ID for the material
(item).
●Status: Required, String. Status for the operation to return a docu
ment URL for this combination of participant and material. If the
ErrorMessage element is empty, this is displayed for the event
manager in the Info eld for the combination of participant and mate
rial but is not visible to participants.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 79
Element Required Type and Description
Supplier Yes Complex type that contains information about the participant. Contains
the following elements:
●ContactEmailAddress: Required, string. Email address of the
participant.
●ContactName: Required, string. Name of the participant.
●OrganizationId: Required, string. System ID of the supplier or
ganization for the participant.
●UniqueName: Required, string. Unique name of the supplier organi
zation for the participant.
●VendorKeys: Required, complex type that comprises the vendor
compound key (a uniform identier across all SAP Ariba solutions) for
the participant's organization. It contains the following elements:
○BusinessSystemId: Required, string. Ariba Network uses the
Business System ID value to determine the correct ERP system
to use when buyers have a multiple ERP system integration.
○LocationId: Required, string. Maps to a eld in Oracle and
Peoplesoft ERP systems. Not used in SAP ERP systems.
○SiteId: Required, String. The ID of the vendor location.
○VendorId: Required, string. Ariba Network vendor ID for the
supplier. The vendor identier in your organization’s backend ERP
system, sometimes called a supplier private ID.
Type
Element Required Type and Description
Type Yes String. Species the event type.
Use the value RFx for RFI and RFP events.
UniqueId
Element Required Type and Description
UniqueId Yes String. Species a unique ID for the event, used by the DocumentURLOut
Bound and DocumentStatusChangeNotication web services.
Use this value to correlate DocumentURLOutBound and DocumentStatu
sChangeNotication requests.
80 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Download RFX Awards
The Download RFX Awards web service is an inbound service that enables you to download an RFX award specied
by its system ID. To download all RFX awards created within a given time period, use the Download RFX Awards with
Filters (Download RFX Awards with Filters [page 82]) web service.
The Download RFX Awards web service receives AwardDownloadRequest messages and responds with
AwardDownloadReply messages. Each AwardDownloadReply message contains an award document CSV le,
base64 encoded.
Site Conguration Options
By default, date elds (Date_Field and CalendarDate_Field type) exported for the RFX award are listed in the
time zone for the SAP Ariba server (such as GMT -8). To adjust the exported date elds for your time zone, your
SAP Ariba Customer Support Administrator can set the following site conguration option:
Application.ACM.TimeZoneIDForExportExcelByWebService
To set this option, please have your Designated Support Contact log a service request and an SAP Ariba Customer
Support representative will follow up to complete the request.
AwardDownloadRequest Elements
WSAwardExportInputBean_Item
A WSAwardExportInputBean_Item element contains an item element, where each item element contains the
following child element:
Element Required Type and Description
RfxInternalId Yes String. Species the system ID of the RFX document to be downloaded. For
example, Doc12345.
RfxName No Deprecated. This value is no longer used.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 81
AwardDownloadReply Elements
WSAwardExportOutputBean
A WSAwardExportOutputBean_Item element contains an item element, where each item element contains the
following child elements:
Element Type and Description
AwardDocument XSD base64Binary (string with base64-encoded data). Contents of the award docu
ment (CSV le), base64 encoded.
ErrorMessage String. Message (error or conrmation) returned by the web service.
MimeType String. MIME encoding type used for the award document.
Status Integer. Return status. 0 indicates success.
Download RFX Awards with Filters
The Download RFX Awards with Filters web service is an inbound service that enables you to download all RFX
awards created within a given time period. To download an RFX award as specied by ID, use the Download RFX
Awards (Download RFX Awards [page 81]) web service.
You can also use this web service to export award and scenario data for partially awarded events if automatic event
completion is disabled (the site conguration option
Application.AQS.AutoEventCompletionWhenAllItemsAwarded is set to No; the default value is Yes) by
sending a request with IncludePendingEvents set to true.
This web service receives RFXAwardExportWSRequest messages and responds with RFXAwardExportWSReply
messages.
RFXAwardExportWSRequest Elements
The RXAwardExportWSRequest contains a WSRFXAwardListExportInputBean_Item, which contains a
WSRFXAwardListExportInputBean.
82 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
WSRFXAwardListExportInputBean
Element Required Type and Description
FromDate No XSD DateTime. Start date for a date range. The web service converts this
to a calendar date (it strips the hours, minutes, and seconds) and exports
all RFX awards created after the start of the FromDate and before the
start of the ToDate. RFX awards created after the start of the ToDate
are excluded.
You can include the hours, minutes, and seconds values for the FromDate
and ToDate elements in the date range by having SAP Ariba set the site
conguration option
Application.Messaging.Channels.WS.IncludeTimePorti
onToParseDate to Yes. For more information, see Site Conguration
Options for Integration Services [page 150].
If this element is not specied, a wildcard (any date) is used as the
FromDate.
All dates are relative to the date in the SAP Ariba OnDemand time zone of
the server used for your site; by default, this is US Pacic time
(UTC-08:00).
IncludePendingEvents No Boolean. If true and automatic event completion is disabled (the site con
guration option
Application.AQS.AutoEventCompletionWhenAllItemsAwa
rded is set to No; the default value is Yes), the response includes sce
nario and award data for all events that have awards created within the
FromDate - ToDate range, even if the events are still in the Pending
Selection state.
If this element is true and automatic event completion is disabled, and
awards are created for an event within multiple date ranges, it is possible to
receive multiple responses with data for the same event.
ToDate No XSD DateTime. End date for a date range. The web service converts this to
a calendar date (it strips the hours, minutes, and seconds) and exports en
tries for all RFX awards that were created after the start of the FromDate
and before the start of the ToDate. RFX awards created after the start of
the ToDate are excluded.
If this element is not specied, a wildcard (any date) is used as the
ToDate.
All dates are relative to the date in the SAP Ariba OnDemand time zone of
the server used for your site; by default, this is US Pacic time
(UTC-08:00).
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 83
RFXAwardExportWSReply Elements
The RXAwardExportWSReply contains a WSRFXAwardListExportOutputBean_Item, which contains a
WSRFXAwardListExportOutputBean.
Element Type and Description
AwardDocumentList Contains a sequence WSRFXAwardSingleOutputBean items. See WSRFXAward
SingleOutputBean [page 84].
ErrorMessage String. Message (error or conrmation) returned by the web service.
MimeType String. MIME encoding type used for the award document.
Status Integer. Return status. 0 indicates success.
WSRFXAwardSingleOutputBean
An WSRFXAwardSingleOutputBean contains one item element for each RFX award. Each item element
contains the following subelements:
Element Type and Description
AwardFile XSD base64Binary (string with base64-encoded data). A ZIP le that contains an award
document le in CSV format (RFXAward_docId.csv), base64 encoded.
DocumentId String. Document ID of the event for the award.
DocumentName String. Document name of the event for the award.
Export RFX Awards
Use the Export RFX Awards web service to export RFX awards.
The Export RFX Awards web service sends RFXAwardExportRequest messages and responds with
RFXAwardExportReply messages. Each RFXAwardExportRequest message contains one award document CSV
le, base64 encoded. SAP Ariba uses this web service for the RFXAwardExport scheduled task to export RFX
awards to an external system. The RFXAwardExport task sends each award in a separate request. This task runs
every 24 hours. The rst time the task runs, it exports all RFX awards that have been awarded since the parameter
was enabled. On subsequent runs, the task exports all RFX awards that have been awarded since the last run.
The Export RFX Awards web service uses an outbound integration end point and requires the site conguration
option Application.AQS.RFX.EnableWSAwardPush to be enabled. For more information, see Enabling Export
RFX Awards Tasks [page 24].
You can congure users to receive email notications when the Export RFX Awards web service fails. For more
information, see Conguring Email Notications for Outbound Web Services [page 24].
84 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
RFXAwardExportRequest Elements
WSRFXAwardExportOutputBean_Item
A WSRFXAwardExportOutputBean_Item element contains an item element, where each item element contains
the following child elements:
Element Type and Description
Award XSD base64Binary (string with base64-encoded data). Contents of the award docu
ment (CSV le), base64 encoded.
DocumentId String. Unique system (document) ID for the event.
DocumentName String. Name of the event.
RFXAwardExportReplyElements
WSRFXAwardExportInputBean
Element Required Type and Description
Message Yes String. Message (error or conrmation) returned by the client. Use
Success to indicate that there were no errors.
Status No Integer. Return status. Return 0 to indicate that there were no errors.
Import Sourcing Event
Use the Import Sourcing Event web service to create or update an event in an existing sourcing project. To create a
sourcing event as a quick project when using SAP Ariba Sourcing Pro or as an event when using SAP Ariba
Sourcing Basic, you must use the Import Sourcing Project web service with the Import Sourcing Event web service.
This procedure is described in Creating a Sourcing Event without a Full Sourcing Project [page 122].
When creating a sourcing event in a full project, you can create the event from an unused Document Choice
document (which acts as a placeholder) or you can create an ad hoc sourcing event (a sourcing event that is not
created from a Document Choice document).
The Import Sourcing Event web service receives EventImportRequest messages and responds with
EventImportReply messages.
If you are creating an event, you must specify the system ID of the document template to use for creating the
project. If you are updating the header elds of an event, the SAP Ariba web service retains the existing values for
any elements that you do not include or for which you do not specify a value.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 85
EventImportRequest Elements
WSRFXDocumentInputBean
Element Required Type and Description
Action Yes String. Species the action for the task.
Valid values:
●Create. Creates an event from an unused Document Choice docu
ment in the full sourcing project
●CreateAdhoc. Create an event without using a Document Choice
document in the full sourcing project.
●Update. Update the contents of an existing event.
Attachments Yes XSD base64Binary (string with base64-encoded data). File attachments
for the event, saved in a ZIP le and base64 encoded.
86 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
Contents Yes XSD base64Binary (string with base64-encoded data). The contents can
be:
●An Excel le
●A ZIP le containing the CSV les that correspond to sheets in an Ex
cel le for an event. The CSV les can be:
○Conditions.csv
○Content.csv
○Item Participants.csv
○Participants.csv
○Participant Initial Values.csv
○Pricing.csv
○Rules.csv
○Terms.csv
The les required depend on the event you are creating. At a mini
mum, the ZIP le must contain a Participants.csv and a
Pricing.csv le; auction events also require a Terms.csv
le.
To create a value for this element, you can export the contents of
an existing event to a Microsoft Excel le and edit the le. If you
want to create CSV les from an Excel event le:
●Remove the instructions in the sheets.
●Save the appropriate Excel sheets as CSV les (one sheet per CSV
le). Use the sheet name to form the CSV le name.
●If you are including a Rules Excel sheet or Rules.csv le and
specifying values for dates (Response start date or Due
date), use the correct syntax for the date.
○In a Rules Excel sheet, use the following custom number syntax
(if you create the Excel le by exporting an existing event, SAP
Ariba creates the date cells with this syntax):
m-d-yyyy h:mm
For example:
4/25/2014 16:00
○In a Rules.csv le, use the following syntax:
yyyy-mm-dd hh:mm:ss
For example:
2014-04-25 16:00:00
Specify the time in the SAP Ariba OnDemand time zone of the
server used for your site; by default, this is US Pacic time
(UTC-08:00). The user time zone and any time zone name ap
pended to the date value are ignored.
●Enclose the CSV les in a ZIP le.
After you have an Excel or ZIP le, encode the le using a base64-en
coding utility.
For more information about exporting the contents of an existing
event to Microsoft Excel, see the .
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 87
Element Required Type and Description
DocumentId Yes String. Species the document ID for the event, such as Doc1234. Spec
ify the value according to the value of the Action element.
●If the Action is Create or CreateAdhoc, do not specify a value
(the web service ignores any value specied).
●If the Action is Update, specify the ID of the event to be updated.
You must specify a value for DocumentId or DocumentName.
DocumentName Yes String. Species the event name. Specify the value according to the value
of the Action element.
●If the Action is Create, specify the name of the existing Document
Choice document to use for creating the event.
●If the Action is CreateAdhoc, specify the name of the event to be
created.
●If the Action is Update, specify the name of the event to update. If
you are updating an event. you identify the event by specifying the
DocumentName and the WorkspaceId. Alternatively, if you know
the document ID (specied in the UI), you can identify the event using
the DocumentId element.
If you are updating an event that is not in a full sourcing project and
the event was created using the Import Sourcing Project web service
and it has not been updated, use the
DefaultStringTranslation child element of the Title ele
ment specied in the Import Sourcing Project request as the
DocumentName. If you are updating an event that has been previ
ously updated with a Title element in the Import Sourcing Event re
quest, use the DefaultStringTranslation child element of
that Title element.
OnBehalfUserId Yes String. Species the user ID of the user for whom the SAP Ariba web serv
ice will perform the action.
OnBehalfUserPasswordAdap
ter
No String. Species the password adapter to authenticate the user in the
OnBehalfUserId element.
If you are not using a custom password adapter, you can omit this element
or leave the value unspecied and the web service will use the default pass
word adapter.
RFXDocumentHeaderFields No RFXDocument_WSProjectImport. Event header elds. See EventHeader
Fields [page 89].
ReplaceEventContent Yes Boolean. Species if the value of the Contents element replaces the ex
isting contents for the event.
TemplateId Yes String. System ID that species the template to use to create the event (for
example, SYS0107). This is the ID of the document template within the
project template (not the ID of the project template). For information about
determining document template IDs, see Web Service Examples: Creating
Sourcing Events [page 121].
If the Action element is Update, this element is ignored.
88 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
WorkspaceId Yes String. Species the sourcing project (workspace) ID in which the event will
be created or updated.
The value for this element can be null if DocumentId is not null.
For information about determining workspace IDs for sourcing projects,
see Web Service Examples: Creating Sourcing Events [page 121].
EventHeaderFields
Element Required Type and Description
BaseLanguage No Complex type. This element has the following child element:
●UniqueName (optional string): Species the language in which the
project is displayed if there is no translation for the project in the user’s
preferred language. For a list of valid values, see Country, Currency,
BaseLanguage, and LocaleID Elements [page 28].
Commodity No Complex type. The commodity for the event. This element contains a se
quence of zero or more items with the following child elements:
●Domain (required string): Species the domain or organization that
denes the values for the commodity code. For most installations, the
value will be unspsc (Universal Standard Products and Services Clas
sication).
●UniqueName (required string): Species the ID for the commodity,
such as the numeric commodity code. To determine the valid com
modity ID values, use the Export Commodity Codes task.
Currency Complex type. The type of currency used in the event. This element has the
following child element:
●UniqueName (required string): Species the currency type using the
ISO 4217 alphabetic code (for example, USD, EUR, or CNY).
Description No Complex type. This element has the following child element:
●DefaultStringTranslation (optional string): Description for
the project.
Title No Complex type. This element has the following child element:
●DefaultStringTranslation (optional string): Event title.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 89
EventImportReply Elements
WSRFXDocumentOutputBean
Element Type and Description
Contents XSD base64Binary (string with base64-encoded data). This element is not sent in Im
port Sourcing Event responses.
ErrorMessage String. Message (error or conrmation) returned by the web service.
Status Integer. Return status. 0 indicates success.
Import Sourcing Project
Use the Import Sourcing Project web services to create a sourcing project or to update the project header elds of
an existing sourcing project. If you are an SAP Ariba Sourcing Basic user, use the Import Sourcing Project web
service to create a sourcing event, then use the Import Sourcing Event web service to add (update) the event
contents, as described in Creating a Sourcing Event without a Full Sourcing Project [page 122].
The Import Sourcing Project web service receives SourcingProjectImportRequest messages and responds
with SourcingProjectImportReply messages.
If you are creating a full sourcing project, you must specify the system ID of the template to use for creating the
project. If you are creating a quick sourcing project or an event, specify the template ID for the document of the
sourcing event.
If you are creating or updating a project and your conguration does not contain any custom elds, you must omit
the custom element in the rst level immediately below the ProjectHeaderFields element.
If the organizations that can be selected for the Aected Parties eld do not contain any custom elds, you must
omit the custom element contained in the AffectedParties element. Alternatively, you can omit the entire
AffectedParties element.
If you create or update a sourcing project, the SourcingProjectImportReply includes a workspace ID and URL (web
jumper) to the created or updated project.
If you are updating a project, the SAP Ariba web service retains the existing values for any project header eld
elements that you do not include or for which you do not specify a value.
90 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
SourcingProjectImportRequest Elements
WSourcingProjectInputBean
Element Required Type and Description
Action Yes String. Species the action for the task.
Valid values:
●Create. Creates a new project.
●Update. Update project elds of an existing project.
OnBehalfUserId Yes String. Species the user ID of the user for whom the SAP Ariba web serv
ice will perform the action. When creating a project, the SAP Ariba web
service creates the project with this user as the owner if the Owner ele
ment is not specied.
OnBehalfUserPasswordAdap
ter
No String. Species the password adapter to authenticate the user in the
OnBehalfUserId element.
If you are not using a custom password adapter, you can omit this element
or leave the value unspecied and the web service will use the default pass
word adapter.
ParentWorkspaceId No String. The workspace ID (for example, CW12345) of the parent project for
the contract project. Specifying a value in this eld creates the workspace
as a subproject of the specied parent.
ProjectHeaderFields No ContractRequest_WSProjectImport or
ContractWorkspace_WSProjectImport. Project header elds.
See ProjectHeaderFields [page 58].
TemplateId Yes String. System ID that species the template to use to create the project,
(for example, SYS0052).
If the Action element is Update, this element is ignored.
WorkspaceId Yes String. Species the workspace ID. When using the service to create a
project, do not specify a value. If the SAP Ariba web service successfully
creates a project, it returns the system-generated workspace ID in the the
WorkspaceId element of the response.
If you are updating a contract project, you must use the WorkspaceId
element or the ContractId element to identify the project you want to
update.
For more information, see ContractId and WorkspaceId Elements for Con
tract Workspaces [page 28].
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 91
ProjectHeaderFields
Element Required Type and Description
BaseLanguage No Complex type. This element has the following child element:
●UniqueName (optional string): Species the language in which the
project is displayed if there is no translation for the project in the user’s
preferred language. For a list of valid values, see Country, Currency,
BaseLanguage, and LocaleID Elements [page 28].
BaselineSpend No Complex type. The amount you expect to spend for all of the goods and
services associated with the project. This element has the following child el
ements:
●Amount (optional decimal): Decimal amount.
●Currency (optional complex type): Contains UniqueName (op
tional string). Species the currency type using the ISO 4217 alpha
betic code (for example, USD, EUR, or CNY).
Client No Complex type. The departments in your company for which the project is
applicable. This element contains a sequence of zero or more of the follow
ing item:
●DepartmentID (optional string): Species the system ID for the de
partment. To determine valid values, use the Export Departments task.
Commodity No Complex type. The commodity for the project. This element contains a se
quence of zero or more items with the following child elements:
●Domain (required string): Species the domain or organization that
denes the values for the commodity code. For most installations, the
value will be unspsc (Universal Standard Products and Services Clas
sication).
●UniqueName (required string): Species the ID for the commodity,
such as the numeric commodity code. To determine the valid com
modity ID values, use the Export Commodity Codes task.
ContractId No String. Species the contract's unique ID. This can be the unique ID used in
the third-party system. If you are creating a contract project, the system
creates the project and assigns this contract ID if it is not already in use; if
you do not specify a value, the SAP Ariba web service assigns the system-
generated workspace ID as the contract ID.
If you are updating a project, you must use the ContractId element or
the WorkspaceId element to identify the project you want to update.
For more information, see ContractId and WorkspaceId Elements for Con
tract Workspaces [page 28].
ContractEffectiveDate Yes XSD DateTime. The date when the terms of the contract go into eect.
Currency Complex type. The type of currency used in the project. This element has
the following child element:
●UniqueName (optional string): Species the currency type using the
ISO 4217 alphabetic code (for example, USD, EUR, or CNY).
92 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
Description No Complex type. This element has the following child element:
●DefaultStringTranslation (optional string): Description for
the project.
ExecutionStrategy No String. Species the strategy for achieving the goals of the sourcing project.
Valid values:
●No Choice
●Online Sourcing
●Offline Sourcing
●Supplier Performance
●Contract
●Low Cost Country Sourcing
●Renewal
Owner No Complex type. Species the owner for the project. If you are creating a
project and do not include this element, the project is created with the user
specied in the OnBehalfUserId element as the owner. This element
has the following child element:
●UniqueName (optional string): Unique name (for example, jsmith)
of the owner.
PlannedEventType No String. A number representing the planned event type, where:
●1 represents RFI
●2 represents RFP
●4 represents Auction
●6 represents ForwardAuction
ProjectReason No String. Species why the project will be executed. It is used for reporting
purposes only.
Valid values:
●No Choice
●Contract Expiring
●Meet Savings Goals
●New Requirement
●New Component/Reengineer
Region No Complex type. The region for the project. This element contains a sequence
of zero or more items with the following child element:
●Region (optional string): Species the region. To determine valid val
ues, use the Export Regions task
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 93
Element Required Type and Description
SourcingMechanism No String. Species the method used to execute the project (the Resourced By
eld).
Valid values:
●No Choice
●SAP Ariba Resources
●Internal Resources
●Other
Title No Complex type. This element has the following child element:
●DefaultStringTranslation (optional string): Project title. If
this is a quick sourcing project or an SAP Ariba Sourcing Basic event,
this is the event (document) name.
custom No Complex type. This element is used for custom project header elds. For
more information, see Custom Body Elements for Web Services [page 30].
SourcingProjectImportReply Elements
WSSourcingProjectOutputBean
Element Type and Description
ErrorMessage String. Message (error or conrmation) returned by the web service.
Status Integer. Return status. 0 indicates success.
Url String. URL to the created or updated project.
WorkspaceId String. Unique, system-generated ID for the created or updated project.
SOAP Web Service for Knowledge Projects
You can use the Import Knowledge Project web service to manage knowledge projects.
Import Knowledge Project
Use the Import Knowledge web service to create knowledge projects or to update knowledge project header elds.
The Import Knowledge Project web service receives KnowledgeProjectImportRequest messages and responds
with KnowledgeProjectImportReply messages.
If you are creating a knowledge project, you must specify the system ID of the template to use for creating the
project.
94 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
The KnowledgeProjectImportReply includes a URL (web jumper) to the created or updated project.
If you are updating a knowledge project, the SAP Ariba web service retains the existing values for any project
header eld elements that you do not include or for which you do not specify a value.
KnowledgeProjectImportRequest Elements
WSKnowledgeInputBean
Element Required Type and Description
Action Yes String. Species the action for the task.
Valid values:
●Create. Creates a new project.
●Update. Update project elds of an existing project.
OnBehalfUserId Yes String. Species the user ID of the user for whom the SAP Ariba web serv
ice will perform the action. When creating a project, the SAP Ariba web
service creates the project with this user as the owner if the Owner ele
ment is not specied.
OnBehalfUserPasswordAdap
ter
No String. Species the password adapter to authenticate the user in the
OnBehalfUserId element.
If you are not using a custom password adapter, you can omit this element
or leave the value unspecied and the web service will use the default pass
word adapter.
ParentWorkspaceId No String. The workspace ID (for example, CW12345) of the parent project for
the knowledge project. Specifying a value in this eld creates the new
project as a subproject of the specied parent.
ProjectHeaderFields No DynamicWorkspace_WSProjectImport. Project header elds. See
ProjectHeaderFields [page 96].
TemplateId Yes String. System ID that species the template to use to create the project
(for example, SYS0052).
If the Action element is Update, this element is ignored.
WorkspaceId Yes String. Species the workspace ID. When using the service to create a
project, do not specify a value. If the SAP Ariba web service successfully
creates a project, it returns the system-generated workspace ID in the the
WorkspaceId element of the response.
If you are updating a project, you must use the WorkspaceId element to
identify the project you want to update.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 95
ProjectHeaderFields
Element Required Type and Description
BaseLanguage No Complex type. This element has the following child element:
●UniqueName (optional string): Species the language in which the
project is displayed if there is no translation for the project in the user’s
preferred language. For a list of valid values, see Country, Currency,
BaseLanguage, and LocaleID Elements [page 28].
Client No Complex type. The departments in your company for which the project is
applicable. This element contains a sequence of zero or more of the follow
ing item:
●DepartmentID (optional string): Species the system ID for the de
partment. To determine valid values, use the Export Departments task.
Commodity No Complex type. The commodity for the project. This element contains a se
quence of zero or more items with the following child elements:
●Domain (required string): Species the domain or organization that
denes the values for the commodity code. For most installations, the
value will be unspsc (Universal Standard Products and Services Clas
sication).
●UniqueName (required string): Species the ID for the commodity,
such as the numeric commodity code. To determine the valid com
modity ID values, use the Export Commodity Codes task.
Description No Complex type. This element has the following child element:
●DefaultStringTranslation (optional string): Description for
the project.
Region No Complex type. The region for the project. This element contains a sequence
of zero or more items with the following child element:
●Region (optional string): Species the region. To determine valid val
ues, use the Export Regions task
Title No Complex type. This element has the following child element:
●DefaultStringTranslation (optional string): Workspace title.
KnowledgeProjectImportReply Elements
WSKnowledgeProjectOutputBean
Element Type and Description
ErrorMessage String. Message (error or conrmation) returned by the web service.
Status Integer. Return status. 0 indicates success.
Url String. URL to the created or updated project.
96 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Type and Description
WorkspaceId String. Unique, system-generated ID for the created or updated project.
SOAP Web Services for Documents
You can use the following web services to manage documents:
●Download Document [page 97] (this web service is supported for lebased documents only)
●Download Document IDs [page 98] (this web service is supported for sales form documents only)
●Import Document [page 100] (this web service is supported for lebased documents only)
●Import Form Document [page 101] (this web service is present but not supported)
Download Workspace Documents
The Download Workspace Documents web service is an inbound web service that enables you to download a
document. The Download Workspace Documents web service is supported for any le document (document
loaded to a project from a le), including:
●Assembled contract documents (Main Agreement and Contract Addendum documents)
●Order forms (order forms do not contain data entered using elds in the SAP Ariba user interface)
The Download Workspace Documents web service is not supported for the following document types:
●Contract Terms
●Form les (any form le with data entered using elds in the SAP Ariba user interface), including savings forms
The Download Workspace Documents web service receives DocumentDownloadRequest messages and responds
with DocumentDownloadReply messages.
DocumentDownloadRequest Elements
The DocumentDownloadRequest contains a WSDocumentDownloadInputBean_Item, which contains a
WSDocumentDownloadInputBean.
WSDocumentDownloadInputBean
Element Required Type and Description
DocumentId Yes String. Document ID of the document to download, such as Doc1234.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 97
DocumentIdsDownloadReply Elements
The DocumentDownloadReply contains a WSDocumentDownloadOutputBean_Item, which contains a
WSDocumentDownloadOutputBean.
WSDocumentDownloadOutputBean
Element Type and Description
DocumentFile XSD base64Binary (string with base64-encoded data). A ZIP le that contains the down
loaded document, base64 encoded.
ErrorMessage String. Message (error or conrmation) returned by the web service.
Status Integer. Return status. 0 indicates success.
Download Document IDs
The Download Document IDs web service is an inbound web service that enables you to download the IDs of all
documents modied or created within a given time period.
Note
The Download Document IDs web service is supported only for order form documents.
The Download Document IDs web service returns a string that contains a comma-separated list of document IDs.
Each document ID can be sent in a Download Document web service request.
DocumentIdsDownloadRequest Elements
The DocumentIdsDownloadRequest contains a WSDocumentIdsDownloadInputBean_Item, which contains a
WSDocumentIdsDownloadInputBean.
WSDocumentIdsDownloadInputBean
Element Required Type and Description
DocumentStatus Yes String. Limits the document IDs downloaded to documents with the speci
ed status.
Valid values: Draft or Published.
98 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
FromDate Yes XSD DateTime. Start date for a date range. The web service converts this
to a calendar date (it strips the hours, minutes, and seconds) and exports
the IDs for all documents modied or created after the start of the
FromDate and before the start of the ToDate. Documents modied or
created after the start of the ToDate are excluded.
You can include the hours, minutes, and seconds values for the
FromDate and ToDate elements in the date range by having SAP Ariba
set the site conguration option
Application.Messaging.Channels.WS.IncludeTimePorti
onToParseDate to Yes. For more information, see Site Conguration
Options for Integration Services [page 150].
All dates are relative to the date in the SAP Ariba OnDemand time zone of
the server used for your site; by default, this is US Pacic time
(UTC-08:00).
ToDate Yes XSD DateTime. End date for a date range. The web service converts this to
a calendar date (it strips the hours, minutes, and seconds) and exports IDs
for all documents created or modied after the start of the FromDate
and before the start of the ToDate. Documents modied or created after
the start of the ToDate are excluded.
All dates are relative to the date in the SAP Ariba OnDemand time zone of
the server used for your site; by default, this is US Pacic time
(UTC-08:00).
Type Yes String. A comma-separated list of document types for which IDs will be
downloaded.
Valid value: OrderForm.
DocumentIdsDownloadReply Elements
The DocumentIdsDownloadReply contains a WSDocumentIdsDownloadOutputBean_Item, which contains a
WSDocumentIdsDownloadOutputBean.
WSDocumentIdsDownloadOutputBean
Element Type and Description
DocumentIDs String. A sequence of document IDs, delimited by commas. If no documents meet the
date range and type criteria, an empty string is returned.
ErrorMessage String. Message (error or conrmation) returned by the web service.
Status Integer. Return status. 0 indicates success.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 99
Import Document
Use the Import Document web service to add documents to existing projects. You can also use this web service to
replace an existing document in a project.
Note
The Import Document web service is supported only for project documents that are not assigned to a specic
subtype or use. For example, you cannot use the Import Document web service for contract Main Agreement or
Contract Addendum documents, and you cannot use this web service for events.
DocumentImportRequest Elements
WSDocumentInputBean
Element Required Type and Description
Action Yes String. Species the action for the task.
Valid values:
●Create. Adds a new document to the project.
●Update. Replaces the contents of an existing document in a project.
Contents Yes XSD base64Binary (string with base64-encoded data). File contents,
base64 encoded.
DocumentId Yes String. Species the ID for the document, such as Doc1234. Specify the
value according to the value of the Action element.
●If the Action is Create, do not specify a value (the web service ig
nores any value specied).
●If the Action is Update, specify the ID of the document to be up
dated. You must specify a value for DocumentId or
DocumentName.
DocumentName Yes String. Species the document name. Specify the value according to the
value of the Action element.
●If the Action is Create, specify the name of the document to be
created.
●If the Action is Update, specify the name of the document to up
date. You must specify a value for DocumentId or DocumentName.
Use a forward slash (/) to delimit folder names. For example,
MyFolder/MyFile.txt creates or updates the le MyFile.txt
in the folder MyFolder under the Documents area for the project. If
MyFolder does not already exist, the web service creates it for you.
OnBehalfUserId Yes String. Species the user ID of the user for whom the SAP Ariba web serv
ice will perform the action.
100 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
OnBehalfUserPasswordAdap
ter
No String. Species the password adapter to authenticate the user in the
OnBehalfUserId element.
If you are not using a custom password adapter, you can omit this element
or leave the value unspecied and the web service will use the default pass
word adapter.
WorkspaceId Yes String. Species the ID of the project (workspace) in which the document
will be created or that contains the document to be updated.
DocumentImportReply Elements
WSDocumentOutputBean
Element Type and Description
DocumentId String. Unique system ID for the created or updated document.
ErrorMessage String. Message (error or conrmation) returned by the web service.
Status Integer. Return status. 0 indicates success.
Import Form Document
This service is not supported.
SOAP Web Services for Managing Users,
Organizations, and Suppliers
You can use the following web services to manage users, organizations, and suppliers:
●Add Users to Group [page 102]
●remove user from group [page 102]
●Export Organizations [page 104]
●Export Supplier Proles [page 105]
●Import Organizations [page 107]
●Import Supplier Proles [page 110]
●Import Users [page 111]
●Remove Organizations [page 113]
●Remove Users [page 114]
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 101
Add Users to Group
Use the Add Users to Group web service to add one or more existing users to one or more system groups.
The Add Users to Group web service receives AddUsersToGroupRequest messages and responds with
AddUsersToGroupReply messages.
AddUsersToGroupRequest Elements
Group_WSAddUsersToGroup_Item
A Group_WSAddUsersToGroup_Item can contain a sequence of one or more item elements, where each item
element contains the following child elements:
Element Required Type and Description
UniqueName Yes String. Unique name of the group, such as Contract Agent.
Users Yes Complex type. This element contains a sequence of zero or more of the
following child elements:
●PasswordAdapter (required string). Species the password
adapter to authenticate the user, such as
SourcingSupplierUser or PasswordAdapter1.
●UniqueName (required string). Unique name of the user to be
added to the group, such as bsmith.
AddUsersToGroupReply Elements
AddUsersToGroupReply
Element Type and Description
Status String. Return status.
remove user from group
remove user from group
Use the remove user from group web service to remove one or more existing users from one or more system
groups.
The remove user from group web service receives RemoveUsersFromGroupRequest messages and responds
with RemoveUsersFromGroupReply messages.
102 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
In this section:
RemoveUsersFromGroupRequest Elements [page 103]
RemoveUsersFromGroupReply Elements [page 103]
RemoveUsersFromGroupRequest Elements
Group_WSRemoveUsersFromGroup_Item
RemoveUsersFromGroupRequest Elements
A Group_WSRemoveUsersFromGroup_Item can contain a sequence of one or more item elements, where each
item element contains the following child elements:
Element Required Type and Description
UniqueName Yes String. Unique name of the group, such as Contract Agent.
Users Yes Complex type. This element contains a sequence of zero or more of the
following child elements:
●PasswordAdapter (required string). Species the password
adapter to authenticate the user, such as
SourcingSupplierUser or PasswordAdapter1.
●UniqueName (required string). Unique name of the user to be re
moved from the group, such as bsmith.
RemoveUsersFromGroupReply Elements
RemoveUsersFromGroupReply
RemoveUsersFromGroupReply Elements
Element Type and Description
Status String. Return status.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 103
Export Organizations
The Export Organizations web service is an inbound service that enables you to export information about the
organizations congured for your site. This web service receives OrganizationExportWSRequest messages and
responds with OrganizationExportWSReply messages.
OrganizationExportWSRequest Elements
The OrganizationExportWSRequest contains a WSOrganizationExportInputBean_Item, which contains a
WSOrganizationExportInputBean.
WSOrganizationExportInputBean
Element Required Type and Description
FromDate No XSD DateTime. Start date for a date range. The web service converts this
to a calendar date (it strips the hours, minutes, and seconds) and exports
all organizations created or updated after the start of the FromDate and
before the start of the ToDate. Organizations created or updated after the
start of the ToDate are excluded.
You can include the hours, minutes, and seconds values for the FromDate
and ToDate elements in the date range by having SAP Ariba set the site
conguration option
Application.Messaging.Channels.WS.IncludeTimePorti
onToParseDate to Yes. For more information, see Site Conguration
Options for Integration Services [page 150].
If this element is not specied, a wildcard (any date) is used as the
FromDate.
All dates are relative to the date in the SAP Ariba OnDemand time zone of
the server used for your site; by default, this is US Pacic time
(UTC-08:00).
IncludeInactive No String. Species if inactive organizations are included in the output.
Valid values: false, true. The default is false (if this element is not
specied, the value false is used).
If true, proles for inactive suppliers are included in the output and the
output contains the following new columns:
●Active (Yes or No)
●DateCreated
●DateUpdated
104 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
ToDate No XSD DateTime. End date for a date range. The web service converts this to
a calendar date (it strips the hours, minutes, and seconds) and exports en
tries for all organizations that were created or last updated after the start
of the FromDate and before the start of the ToDate. Organizations cre
ated or updated after the start of the ToDate are excluded.
If this element is not specied, a wildcard (any date) is used as the
ToDate.
All dates are relative to the date in the SAP Ariba OnDemand time zone of
the server used for your site; by default, this is US Pacic time
(UTC-08:00).
OrganizationExportWSReply Elements
The OrganizationExportWSReply contains a WSOrganizationExportOutputBean_Item, which contains a
WSOrganizationExportOutputBean.
WSOrganizationExportOutputBean
Element Type and Description
ErrorMessage String. Message (error or conrmation) returned by the web service.
MimeType String. MIME encoding type used for the award document.
OrganizationFile XSD base64Binary (string with base64-encoded data). A base64-encoded ZIP le that
contains an Organization.csv le. The Organization.csv le contains one
entry for each organization that meet the lter criteria. The columns are described in the
ExportOrganizations sheet of the Data Dictionary.
Status Integer. Return status. 0 indicates success.
Export Supplier Proles
Use the Export Supplier Proles web service to export supplier proles. This web service responds with a base64-
encoded CSV le that contains all supplier proles. The proles include responses to the Supplier Prole
Questionnaire (SPQ), except responses to questions with the Answer Type set to Attachment.
Note
The number of columns and column positions in the exported CSV might change because of changes to the
SPQ. These data changes bypass integration migration management processing and occur without being
accepted in the integration migration management utility. When processing the exported CSV, use the column
title to determine column contents; do not use the column number to determine column contents.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 105
The Export Supplier Proles web service receives SupplierProfileExportRequest messages and responds
with SupplierProfileExportReply messages.
SupplierProleExportRequest Elements
WSSupplierProleExportInputBean_Item
A WSSupplierProfileExportInputBean_Item element contains an item element, where each item element
contains the following child elements:
Element Required Type and Description
FromDate No XSD DateTime. Start date for a date range. The web service converts this
to a calendar date (it strips the hours, minutes, and seconds) and exports
entries for all supplier proles that were last updated after the start of the
FromDate and before the start of the ToDate. Supplier proles updated
after the start of the ToDate are excluded.
You can include the hours, minutes, and seconds values for the FromDate
and ToDate elements in the date range by having SAP Ariba set the site
conguration option
Application.Messaging.Channels.WS.IncludeTimePorti
onToParseDate to Yes. For more information, see Site Conguration
Options for Integration Services [page 150].
If this element is not specied, a wildcard (any date) is used as the
FromDate.
All dates are relative to the date in the SAP Ariba OnDemand time zone of
the server used for your site; by default, this is US Pacic time
(UTC-08:00).
RealmName Yes Name of your realm (site).
ToDate No XSD DateTime. End date for a date range. The web service converts this to
a calendar date (it strips the hours, minutes, and seconds) and exports en
tries for all supplier proles that were last updated after the start of the
FromDate and before the start of the ToDate. Supplier proles updated
after the start of the ToDate are excluded.
If this element is not specied, a wildcard (any date) is used as the
ToDate.
All dates are relative to the date in the SAP Ariba OnDemand time zone of
the server used for your site; by default, this is US Pacic time
(UTC-08:00).
106 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
SupplierProleExportReply Elements
WSSupplierProleExportOutputBean_Item
A WSSupplierProfileExportOututBean_Item element contains an item element, where each item element
contains the following child elements:
Element Type and Description
ErrorMessage String. Message (error or conrmation) returned by the web service.
MimeType String. MIME encoding type used for the award document.
Status Integer. Return status. 0 indicates success.
SupplierProfileFile XSD base64Binary (string with base64-encoded data). A supplier prole le (CSV
le), base64 encoded.
Import Organizations
Use the Import Organizations web service to add (or update) one or more supplier or customer organizations to
SAP Ariba. If an organization is created as an unapproved organization (the IsOrgApproved element is 0), the
organization approval process is triggered when certain business parameters are met at the web service level and
customer site level.
The Import Organizations web service receives OrganizationImportRequest messages and responds with
OrganizationImportReply messages.
Site Conguration Options for Organization Approvals
The functionality for approving organizations created as unapproved organizations is controlled by the following
site conguration option, which SAP Ariba sets for you.
Application.SIPM.SupplierOrganizationApprovalProcess
The Application.SIPM.SupplierOrganizationApprovalProcess option determines the category of prole
questions that must be answered for an organization created with IsOrgApproved set to 0 (Unapproved) to
initialize the organization approval process. When the organization approval process is initialized, one of the
following events occurs:
●If your site has SAP Ariba Supplier Information Management (SIM) or SAP Ariba Supplier Information and
Performance Management (SIPM) and this is a managed organization, the organization approval task for the
supplier workspace starts (the You need to approve a new organization registration task starts).
●If your site has SIM or SIPM but this is not a managed organization, the Approve button on the organization's
Prole tab is enabled.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 107
●If your site does not have SIM or SIPM, the Approve button on the organization's Prole tab is enabled.
Possible Application.SIPM.SupplierOrganizationApprovalProcess values:
●Manual (default value): When the organization (or supplier workspace) is created, the organization approval
process is initialized.
●Relevant Questions Answered: If OrganizationSource is Internal, the organization approval process
is initialized after all Owner Required questions are answered in the prole questionnaire. If
OrganizationSource is External, the organization approval process is initialized after all Participant
Required questions (questions that must be answered by suppliers) are answered in the prole questionnaire.
If OrganizationSource is null, the organization approval process is initialized after all Owner Required and
Participant Required questions are answered.
●All Required Questions Answered: The organization approval process is initialized after all Owner
Required questions and all Participant Required questions are answered in the prole questionnaire.
OrganizationImportRequest Elements
Organization_WSOrganizationImport_Item
An Organization_WSOrganizationImport_Item element can contain a sequence of one or more item
elements, where each item element contains the following child elements:
Element Required Type and Description
BusinessContacts No Complex type. This element contains a sequence of zero or more of the
following child elements:
●EmailAddress (required string). The user’s business email ad
dress, specied as a user fullyqualied domain name, such as
user1@example.com.
●custom (optional complex type). This element is used for custom
project header elds. For more information, see Custom Body Ele
ments for Web Services [page 30].
Categories No Complex type. This element species commodity codes and contains a
sequence of zero or more of the following child elements:
●Domain (required string). Species the domain or organization that
denes the values for the commodity code. For most installations,
the value will be unspsc (Universal Standard Products and Services
Classication).
●UniqueName (required string). Species the ID for the commodity,
such as the numeric commodity code. To determine the valid com
modity ID values, use the Export Commodity Codes task.
Contacts No Complex type. This element contains a sequence of zero or more of the
following child elements:
●PasswordAdapter (optional string). Species the password
adapter to authenticate the user.
●UniqueName (required string). Species the unique name of the
user. This user must already exist in the system.
108 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
CorporateAddress Yes Complex type. This element contains a sequence of zero or more of the
following child elements:
●Name (optional string). Name used in the mailing address.
●PostalAddress (optional complex type). This element contains
the following child elements:
○City (optional string). Species the city.
○Country (optional complex type). Species the country. This
element contains the UniqueName (optional string) child ele
ment.
○Lines (optional string). Species the street address or postal
box.
○PostalCode (optional string). Species the postal code.
○State (optional string). Species the state or province.
●UniqueName (required string). Unique name to identify the postal
address.
CorporateEmailAddress Yes String. The email address for the organization, specied as a user fully
qualied domain name, such as user1@example.com.
CorporateFax No String. The fax number for the organization.
CorporatePhone No String. The phone number for the organization.
CorporateURL No String. The URL for the organization.
IsCustomer Yes Boolean. Species if the organization is a customer organization.
IsManaged Yes Integer. Species if the supplier is managed (integer). Valid values:
●0: The supplier is not managed.
●1 or any other integer greater than 0: The supplier is managed.
Your conguration must have Ariba Supplier Information Manage
ment or SAP Ariba Supplier Information and Performance Manage
ment and a published template for supplier workspace projects to
create a managed supplier.
IsOrgApproved No Integer. Species the status of the organization. Valid values:
●0: The organization is unapproved.
●1: The organization is rejected.
●2: The organization is approved.
●3: The organization is in the process of being registered.
●null: The organization is approved.
IsSupplier Yes Boolean. Species if the organization is a supplier organization.
Name Yes String. Species the organization name.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 109
Element Required Type and Description
OrganizationSource No String. Species the source of the information about the organization.
Valid values:
●Internal: Buyer.
●External: Supplier.
●null: Source is not specied.
Depending on your site conguration, the OrganizationSource
can aect the category of prole questions that must be answered
before an approval process is started for the organization. For more
information, see Site Conguration Options for Organization Appro
vals [page 107].
OrganizationType No String. Species the type of organization.
PreferredCurrency No Complex type. Contains UniqueName (optional string). Species the
currency type using the ISO 4217 alphabetic code (for example, USD,
EUR, or CNY).
PreferredLanguage No Complex type. This element has the following child element:
UniqueName (optional string): Species the preferred language for the
organization. For a list of valid values, see Country, Currency, BaseLan
guage, and LocaleID Elements [page 28].
StateOfIncorporation No String. Species the US state in which the organization is incorporated.
SystemID Yes String. Species the unique identier for the organization, such as
SID1234. The SystemID is used to index the organizations. If youare up
dating information about an existing organization, you must specify its
current SystemID. If you adding a new organization, do not specify a
SystemID that is assigned to an existing organization; if you do, the in
formation you specify will overwrite the information for the existing organ
ization.
custom No Complex type. This element is used for custom organization elds. For
more information, see Custom Body Elements for Web Services [page
30].
OrganizationImportRequest ElementsI
Element Type and Description
Status String. Return status.
Import Supplier Proles
Use the Import Supplier Proles web service to import supplier proles. This web service replaces all supplier
proles with the contents sent in the request. If you are replacing existing content, use the Export Supplier Prole
web service or the Supplier Prole export task to create a supplier prole CSV le with the existing data. If you are
110 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
loading supplier proles for the rst time, create a template CSV le by choosing the Create Import Template
option in the Supplier Prole export task.
The Import Supplier Proles web service receives SupplierProfileImportRequest messages and responds
with SupplierProfileImportReply messages.
SupplierImportRequest Elements
WSSupplierProleImportInputBean
Element Required Type and Description
Contents Yes XSD base64Binary (string with base64-encoded data). A valid supplier
prole CSV le, base64 encoded.
SupplierImportReply Elements
WSSupplierProleImportOutputBean
Element Type and Description
ErrorMessage String. Message (error or conrmation) returned by the web service.
Status Integer. Return status. 0 indicates success.
Import Users
Use the Import Users web service to add users to existing supplier or customer organizations in SAP Ariba.
The Import Users web service receives UserImportRequest messages and responds with UserImportReply
messages.
Site Conguration Option
By default, users created using the Import Users web service have their time zone set to the time zone for the SAP
Ariba server (such as GMT -8). To specify an alternate time zone, your SAP Ariba Customer Support Administrator
can set the following site conguration option:
Application.Base.PreferredTimeZoneIDForUser
To set this option, please have your Designated Support Contact log a service request and an SAP Ariba Customer
Support representative will follow up to complete the request.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 111
UserImportRequest Elements
User_WSUserImport_Item
A User_WSUserImport_Item element can contain a sequence of one or more item elements, where each item
element contains the following child elements:
Element Required Type and Description
BillingAddresses Yes Complex type. This element contains a sequence of zero or more item
elements, where each item element contains the following child ele
ments:
●Name (optional string). Name of the user for the address.
●Phone (optional string). Phone number for the address.
●PostalAddress (optional complex type). This element contains
the following child elements:
○City (optional string). Species the city.
○Country (optional complex type). Species the country. This
element contains the UniqueName (optional string) child ele
ment.
○Lines (optional string). Species the street address or postal
box.
○PostalCode (optional string). Species the postal code.
○State (optional string). Species the state or province.
●UniqueName (optional string). Unique name to identify the postal
address.
DefaultCurrency No Complex type. Contains UniqueName (optional string). Species the
currency type using the ISO 4217 alphabetic code (for example, USD,
EUR, or CNY).
EmailAddress Yes String. The user’s business email address, specied as a user fully-quali
ed domain name, such as user1@example.com.
Fax No String. The business fax number for the user.
IsTerminated Yes Boolean. Indicates if the user is terminated.
LocaleID No Complex type. This element has the following child element:
●UniqueName (optional string): Species the locale for the user. For
a list of valid values, see Country, Currency, BaseLanguage, and Lo
caleID Elements [page 28].
Name Yes String. Species the name for the user. For example, Ken Moon.
Organization Yes String. Species the unique system ID of the organization to which the
user will be a added. For example, sid1234.
PasswordAdapter Yes String. The password adapter used to authenticate the user. For example,
SourcingSupplierUser.
Phone No String. Business phone number for the user.
112 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
ShipTos Yes Complex type. This element contains a sequence of zero or more item
elements, where each item element contains the following child ele
ments:
●Name (optional string). Name of the user for the address.
●Phone (optional string). Phone number for the address.
●PostalAddress (optional complex type). This element contains
the following child elements:
○City (optional string). Species the city.
○Country (optional complex type). Species the country. This
element contains the UniqueName (optional string) child ele
ment.
○Lines (optional string). Species the street address or postal
box.
○PostalCode (optional string). Species the postal code.
○State (optional string). Species the state or province.
●UniqueName (optional string). Unique name to identify the postal
address.
Supervisor No Complex type. This element contains the following child elements:
●UniqueName (required string). Species the unique name of the
user’s supervisor. The supervisor must already exist in the system.
●PasswordAdapter (required string). Species the password
adapter used to authenticate the supervisor. For example,
SourcingSupplierUser
UniqueName Yes String. Species the unique name for the user.
UserImportReply ElementsI
Element Type and Description
Status String. Return status.
Remove Organizations
Use the Remove Organizations web service to remove one or more organizations from your SAP Ariba
conguration data.
The Remove Organizations web service receives DeleteOrganizationRequest messages and responds with
DeleteOrganizationReply messages.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 113
DeleteOrganizationRequest Elements
Organization_WSDeleteOrganization_Item
A User_WSDeleteUser_Item can contain a sequence of one or more of the following item elements.
Element Required Type and Description
item No Organization_WSDeleteOrganization complex type. This ele
ment contains the following child element:
●SystemID (required string). Species the system ID of the organi
zation to be removed, such as ACM_1234 or sid9999.
DeleteOrganizationReply Elements
Element Type and Description
status String. Return status.
Remove Users
Use the Remove Users web service to remove one or more internal or external users from your SAP Ariba
conguration data.
The Remove Users web service receives DeleteUserRequest messages and responds with DeleteUserReply
messages.
DeleteUserRequest Elements
User_WSDeleteUser_Item
A User_WSDeleteUser_Item can contain a sequence of one or more of the following item elements.
114 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Element Required Type and Description
item No User_WSDeleteUser complex type. This element contains a se
quence of zero or more items with the following child elements:
●PasswordAdapter (required string). Species the password
adapter to authenticate the user, such as
SourcingSupplierUser or PasswordAdapter1.
●UniqueName (required string). Species the unique name of the
user to be removed, such as bsmith.
DeleteUserReply Elements.
Element Type and Description
Status String. Return status.
SOAP Web Service Status and Error Message Values
The following status and error message values can be returned in responses for inbound web services.
Status Error Message
0 The web service method is successfully executed.
-1 Unknown errors occur during processing.
-2 User has no permission to execute the web service method.
-3 The web service method has not been completely executed.
-4 There is no valid data in the imported file. Please refine your
input and try again.
-5 Web service completed but errors occurred when processing the
data in the Contents element. Please refine your input and try
again.
-2001 The specified project does not contain a terms file.
-2004 The specified document cannot be downloaded. The event is still
open and responses cannot be viewed until the event closes. Try
again after the event closes.
-6000 The specified project owner does not exist.
-6001 The specified template is not found in the system.
-6002 Create project has encountered problems.
-6003 Update project has encountered problems.
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 115
Status Error Message
-6004 The specified project is not found in the system.
-6005 The requested action is invalid.
-6006 The specified workspace template name is not valid.
-6007 The specified project name is not valid.
-6008 The created event project is not a sourcing project.
-6009 The specified project type is invalid.
-6010 The specified field xxxxx is not defined for the project type.
-6011 Events are not allowed for this project type.
-6012 A project with this name already exists in the system.
-6013 The value for Error Messge can be one of the following:
●The value xxxxx is not valid for the yyyyy field.
●Invalid value for the yyyyy field.
●The specified field is not found in the system.
-6014 The user does not have the permissions needed to perform this
operation.
-6015 The specified document ID xxxxx is not valid.
-6016 The specified on behalf of user ID does not exist.
-6017 The contract workspace with the specified contract ID already
exists in the system.
-6018 Create document has encountered problems.
-6019 The specified event template name is not valid.
-6020 Invalid Workspace Id.
-6021 Invalid value for fields. xxxxx
-6022 Invalid Parent Workspace Id.
-6023 Error processing xxxxx.
(This error is returned if an error occurs when processing a eld value.)
-6024 The input contract id is not unique
-6025 Cannot find workspace or template
-6026 Invalid Parent Agreement Id (must be set for SubAgreements).
-6027 Invalid Hierarchical Type, must be SubAgreement if
ParentAgreement is specified.
-6028 Assembled Documents can not be updated using Web Services.
-6029 Provided ClassName can not be used in this Web Services.
-6031 Provided DocumentStatus cannot be used in this Web Service
116 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Web Service Example: Creating a Procurement
Contract Workspace
This section describes how to use the Import Procurement Contract Workspace web service to create a
procurement contract workspace.
1. Determine the template ID for the type of procurement workspace you want to create. To determine the
template ID, open the appropriate template. Navigate to the Overview tab. The ID eld in the Properties pane
contains the template ID.
2. View the WSDL le to determine the required elements, which have a non-zero value for minOccurs. View the
documentation tags to determine valid values or use a data export task to create a list of valid values.
Determine values for the contract workspace you want to create, including:
○The eective date. For more information, see EectiveDate [page 120].
○The expiration type and hierarchical type. For more information, see ExpirationTermType [page 120] and
HierarchicalType [page 120].
○The user who will be the owner of the created contract workspace. For more information, see
OnBehalfUserId [page 119].
○The template ID. For more information, see TemplateId [page 120].
Some elements are required but no value is needed for the operation you are performing. For example, the
WorkspaceId element is required, but if you are creating a workspace, no value is needed. You must still
include the element in the SOAP message, but with no value.
3. If the procurement contract workspace for your system contains required custom elds, you must specify
values for these elds in the custom element. For more information, see Web Service Example: Creating a
Project with Custom Fields [page 127].
If the procurement contract workspace for your system does not contain any custom elds, you must omit the
custom element in the rst level immediately below the ProjectHeaderFields element.
4. If the organizations that can be selected for the Aected Parties eld do not contain any custom elds, you
must omit the custom element contained in the AffectedParties element. Alternatively, you can omit the
entire AffectedParties element.
Import Procurement Contract Workspace Request Message
The following is an example of an Import Procurement Contract Workspace request message to create a
procurement contract workspace. This message was generated by a tool or application on the ERP system based
on the WSDL le created by SAP Ariba. See Import Procurement Contract Workspace Response [page 121] for a
sample response.
Elements of interest are shown in bold and described in the notes that follow.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:Ariba:Sourcing:vrealm_10">
<soapenv:Header>
<urn:Headers>
<!--You may enter the following 2 items in any order-->
<!--Optional:-->
<urn:variant></urn:variant>
<!--Optional:-->
<urn:partition></urn:partition>
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 117
</urn:Headers>
</soapenv:Header>
<soapenv:Body><urn:ContractWorkspaceImportRequest partition="?" variant="?">
<!--Optional:-->
<urn:WSContractWorkspaceInputBean_Item>
<!--Optional:-->
<urn:item>
<urn:Action>Create</urn:Action>
<urn:OnBehalfUserId>molson</urn:OnBehalfUserId>
<!--Optional:-->
<urn:OnBehalfUserPasswordAdapter></urn:OnBehalfUserPasswordAdapter>
<urn:ParentAgreementId></urn:ParentAgreementId>
<urn:ParentWorkspaceId></urn:ParentWorkspaceId>
<!--Optional:-->
<urn:ProjectHeaderFields>
<!--Optional:-->
<urn:BaseLanguage>
<!--Optional:-->
<urn:UniqueName>en</urn:UniqueName>
</urn:BaseLanguage>
<urn:Commodity>
<!--Zero or more repetitions:-->
<urn:item>
<!--You may enter the following 2 items in any order-->
<urn:Domain>unspsc</urn:Domain>
<urn:UniqueName>44</urn:UniqueName>
</urn:item>
</urn:Commodity>
<!--Optional:--><
<urn:ContractId>My SOAP Contract</urn:ContractId>
<!--Optional:--><
<urn:Description>
<!--Optional:-->
<urn:DefaultStringTranslation>CW from SOAP</
urn:DefaultStringTranslation>
</urn:Description>
<urn:EffectiveDate>2010-10-14T12:00:00</urn:EffectiveDate>
<urn:ExpirationTermType>Fixed</urn:ExpirationTermType>
<urn:HierarchicalType>StandAlone</urn:HierarchicalType>
<!--Optional:-->
<urn:Supplier>
<urn:SystemID>sid509</urn:SystemID>
</urn:Supplier>
<urn:Title>
<urn:DefaultStringTranslation>Sample CW</
urn:DefaultStringTranslation>
</urn:Title>
</urn:ProjectHeaderFields>
<urn:TemplateId>SYS0052</urn:TemplateId>
<urn:WorkspaceId></urn:WorkspaceId>
</urn:item>
</urn:WSContractWorkspaceInputBean_Item>
</urn:ContractWorkspaceImportRequest>
</soapenv:Body>
</soapenv:Envelope>
118 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
Notes
Action
This required element species the action for the task. The documentation tag in the WSDL le species the valid
values; for this task, the valid values are Create and Update. The Create action creates a new workspace. The
Update action updates the project elds of an existing contract workspace.
OnBehalfUserId
This required element species the user ID of the user for whom the SAP Ariba Web Service will perform the action.
When creating a project, the system creates the project with this user as the owner.
Note
This does not have to match the user specied in the Login eld in the HTTP AUTHENTICATION area for the
end point.
OnBehalfUserPasswordAdapter
Use this optional element to you use a custom password adapter to authenticate the user in the OnBehalfUserId
element. In most cases, you can omit this element or leave the value unspecied.
BaseLanguage
This optional element species the base language for the project. For a list of valid values, see Country, Currency,
BaseLanguage, and LocaleID Elements [page 28].
Commodity
This optional element species the commodity for the project. The Domain child element species the domain or
organization that denes the values for the commodity. For most installations, the Domain value will be unspsc
(Universal Standard Products and Services Classication). The UniqueName child element species the ID for the
commodity. In this example, the commodity ID is 44 (Oce Products).
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 119
ContractId
This optional element can be used to specify the contract ID when you are creating a contract workspace. If you are
updating a contract, you can either use the ContractId element or the WorkspaceId element to identify the
workspace you want to update. For more information, see ContractId and WorkspaceId Elements for Contract
Workspaces [page 28].
EectiveDate
This required element species the eective date for the contract workspace. This value must be specied using
the XML XSD DateTime data type. For a description of the format, see XSD DateTime Elements [page 29].
ExpirationTermType
This required element species the term type. View the documentation tag in the WSDL le for the valid string
values. The value is case sensitive.
HierarchicalType
This optional element species the hierarchical type. View the documentation tag in the WSDL le for the valid
string values. The value is case sensitive.
Supplier
This optional element species the supplier. To determine the system ID for SystemID child element, you can use
the Export Supplier Organizations task. You can also view the supplier in the chooser for the Supplier eld of a
project; click on the supplier name to view the details for the name and use the value displayed in the ID eld.
TemplateId
This required element species the ID of the template to use when creating the workspace. To determine the
template ID, open the appropriate template. Navigate to the Overview tab. The ID eld in the Properties pane
contains the template ID.
120 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
WorkspaceId
This required element species the project (workspace) ID. When using the task to create a project, do not specify
a value. If the web service successfully creates a project, the service returns the workplace ID in the WorkspaceId
element of the response. If you are updating a contract, you can either use the WorkspaceId element or the
ContractId element to identify the workspace you want to update.
For more information, see ContractId and WorkspaceId Elements for Contract Workspaces [page 28].
Import Procurement Contract Workspace Response
The following is a sample SOAP response for a successful Import Procurement Contract Workspace create request.
If the create operation is not successful, the system responds with a SOAP message that contains a non-zero
status value and an error message. Note that the response for a successful create operation includes a Url
element, which contains a webjumper to the created workspace. It also contains a WorkspaceId element with the
ID of the created workspace; you can use the value of the WorkspaceId element to identify the workspace if you
want to update the workspace.
<soap:Header>
<Headers>
<variant>vrealm_10</variant>
<partition>prealm_10</partition>
</Headers>
</soap:Header>
<soap:Body>
<ContractWorkspaceImportReply xmlns="urn:Ariba:Sourcing:vrealm_10">
<WSContractWorkspaceOutputBean_Item>
<item>
<Status>0</Status> <Url>http://
contractsProSourcingProSpmPro.svcdevss-sourcing.ariba.com/ad/webjumper?
itemID=AABkAHFB%21fYo&awcharset=UTF-8</Url>
<ErrorMessage>The web service method is successfully executed.</
ErrorMessage>
<WorkspaceId>CW2169</WorkspaceId>
</item>
</WSContractWorkspaceOutputBean_Item>
</ContractWorkspaceImportReply>
</soap:Body>
</soap:Envelope>
Web Service Examples: Creating Sourcing Events
●Creating a Sourcing Event without a Full Sourcing Project [page 122]
●Creating an Event with a Full Sourcing Project [page 125]
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 121
Creating a Sourcing Event without a Full Sourcing Project
The following procedure describes how to use web services to create a sourcing event as a quick project when
using SAP Ariba Sourcing Pro or as an event when using SAP Ariba Sourcing Basic. To do this, you must use two
web services:
●The Import Sourcing Project web service, to create a quick project or the SAP Ariba Sourcing Basic event. The
event contents are unspecied.
●The Import Sourcing Event web service, to upload the event contents.
Creating a Sourcing Event Without a Full Project
Procedure
1. Determine the template ID for the document of the sourcing event that you want to create. To do this:
1. Open the appropriate sourcing event template.
2. Navigate to the Documents area.
3. Click the document name.
4. Click Action View Details . The ID eld under the Overview tab contains the template ID for the
document. For example:
2. Use the Import Sourcing Project web service to create a quick project or an SAP Ariba Sourcing Basic event.
Specify the template ID from the previous step in the TemplateId element of the Import Sourcing Project
request.
3. Retain the following values from the Import Sourcing Project event:
○the value you specify in the DefaultStringTranslation child element of the Title element of the
request
○the value returned in the WorkspaceId element of the response
4. Create the base64-encoded content for the event. The content can be:
○a Microsoft Excel le
○a ZIP le containing CSV les
To create the content, you can export an existing event to Excel and edit the contents. If you want to use
CSV les, save each sheet of the Excel le in a separate CSV le, then create a ZIP le containing the CSV
122 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
les. Use a base64-encoding utility to create base64-encoded content from the Excel or ZIP le. For more
information about this element, see Import Sourcing Event [page 85]. For more information about
exporting the contents of an existing event to Microsoft Excel, see the SAP Ariba Event Management Guide.
5. Create an Import Sourcing Event request with the following key values:
○Action: Update
○Contents: The contents of the event, created in the previous step.
○DocumentName: the document title. If this is a newly created event, use the
DefaultStringTranslation child element of the Title element specied in the Import Sourcing
Project request. (If this event has been updated with a new title, use the DefaultStringTranslation
child element of the Title element specied in the Import Sourcing Event request.)
○ReplaceEventContent: true
○WorkspaceId: the value returned in the WorkspaceId element of the Import Sourcing Project response.
The DocumentName and WorkspaceId elements are used to identify the event you are updating. If you
know the document ID of the event (as displayed in the UI), you can use the document ID in the
DocumentId element instead of specifying values in the DocumentName and WorkspaceId elds.
Import Sourcing Event Request without a Full Sourcing Project
The following sections show the Import Sourcing Project request and response messages for creating a quick
sourcing event and the Import Sourcing Event request message used to specify (update) the event contents.
Import Sourcing Project Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:Ariba:Sourcing:vrealm_1">
<soapenv:Header>
<urn:Headers>
<!--You may enter the following 2 items in any order-->
<!--Optional:-->
<urn:variant></urn:variant>
<!--Optional:-->
<urn:partition></urn:partition>
</urn:Headers>
</soapenv:Header>
<soapenv:Body>
<urn:SourcingProjectImportRequest partition="?" variant="?">
<!--Optional:-->
<urn:WSSourcingProjectInputBean_Item>
<!--Optional:-->
<urn:item>
<!--You may enter the following 7 items in any order-->
<urn:Action>Create</urn:Action>
<urn:OnBehalfUserId>molson</urn:OnBehalfUserId>
<!--Optional:-->
<urn:OnBehalfUserPasswordAdapter></urn:OnBehalfUserPasswordAdapter>
<urn:ParentWorkspaceId></urn:ParentWorkspaceId>
<!--Optional:-->
<urn:ProjectHeaderFields>
<!--You may enter the following 15 items in any order-->
<urn:Description>
<!--Optional:-->
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 123
<urn:DefaultStringTranslation>Quick Project</
urn:DefaultStringTranslation>
</urn:Description>
<urn:Title>
<!--Optional:-->
<urn:DefaultStringTranslation>My RFI Event</
urn:DefaultStringTranslation>
</urn:Title>
</urn:ProjectHeaderFields>
<urn:TemplateId>SYS0104</urn:TemplateId>
<urn:WorkspaceId></urn:WorkspaceId>
</urn:item>
</urn:WSSourcingProjectInputBean_Item>
</urn:SourcingProjectImportRequest>
</soapenv:Body>
</soapenv:Envelope>
Import Sourcing Project Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance">
<soap:Header>
<Headers>
<variant>vrealm_1</variant>
<partition>prealm_1</partition>
</Headers>
</soap:Header>
<soap:Body>
<SourcingProjectImportReply xmlns="urn:Ariba:Sourcing:vrealm_1">
<WSSourcingProjectOutputBean_Item>
<item>
<Status>0</Status>
<Url>http://s4All.svcqass-sourcing.ariba.com/ad/webjumper?
itemID=AAAKAI6EiuTx&
awcharset=UTF-8</Url>
<ErrorMessage>The web service method is successfully executed.</
ErrorMessage>
<WorkspaceId>WS28424</WorkspaceId>
</item>
</WSSourcingProjectOutputBean_Item>
</SourcingProjectImportReply>
</soap:Body>
</soap:Envelope>
Import Source Event Request
The following is an example Import Sourcing request to create a sourcing event using the previously created quick
sourcing project. The value for the Contents element was truncated for simplicity. Note that the DocumentName
value is the <Title><DefaultStringTranslation> value from the Import Sourcing Project Request and the
WorkspaceId value is the value returned from the Import Sourcing Project Response.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:Ariba:Sourcing:vrealm_10">
<soapenv:Header>
<urn:Headers>
124 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
<!--You may enter the following 2 items in any order-->
<!--Optional:-->
<urn:variant>?</urn:variant>
<!--Optional:-->
<urn:partition>?</urn:partition>
</urn:Headers>
</soapenv:Header>
<soapenv:Body>
<urn:EventImportRequest partition="?" variant="?">
<!--Optional:-->
<urn:WSRFXDocumentInputBean_Item>
<!--Optional:-->
<urn:item>
<!--You may enter the following 11 items in any order-->
<urn:Action>Update</urn:Action>
<urn:Attachments></urn:Attachments>
<urn:Contents>0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAAOwADAP7/
CQAGAAAAAAAAAAAAAAABAAAAaQAAAAAAAAAAEAAA/v///wAAAAD+////AAAAAGoAAAD...
</urn:Contents>
<urn:DocumentId></urn:DocumentId>
<urn:DocumentName>My RFI Event</urn:DocumentName>
<urn:OnBehalfUserId>taikman</urn:OnBehalfUserId>
<!--Optional:-->
<urn:OnBehalfUserPasswordAdapter></urn:OnBehalfUserPasswordAdapter>
<!--Optional:-->
<urn:RFXDocumentHeaderFields>
<urn:Description>
<!--Optional:-->
<urn:DefaultStringTranslation>An RFI created using SOAP </
urn:DefaultStringTranslation>
</urn:Description>
<!--Optional:-->
<urn:Title>
<!--Optional:-->
<urn:DefaultStringTranslation></urn:DefaultStringTranslation>
</urn:Title>
</urn:RFXDocumentHeaderFields>
<urn:ReplaceEventContent>true</urn:ReplaceEventContent>
<urn:TemplateId></urn:TemplateId>
<urn:WorkspaceId>WS28424</urn:WorkspaceId>
</urn:item>
</urn:WSRFXDocumentInputBean_Item>
</urn:EventImportRequest>
</soapenv:Body>
</soapenv:Envelope>
Creating an Event with a Full Sourcing Project
The following procedure describes how to use the Import Sourcing Event web service to create or update a
sourcing event in a full sourcing project. When creating a sourcing event in a full project, you can create the event
from an unused Document Choice document (which acts as a placeholder) or you can create an ad hoc sourcing
event (a sourcing event that is not created from a Document Choice document).
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 125
Creating a Sourcing Event in a Full Project
Procedure
1. If you want to create the sourcing event using a Document Choice document, create a project template for a
full sourcing project that contains a Document Choice document. Add the appropriate sourcing events as
choices for the document.
2. Create a full sourcing project using the appropriate project template. You can do this by using the Import
Sourcing Project web service or by using the UI.
3. Determine the project (workspace) ID of the full sourcing project. You must specify the project ID in the
WorkspaceId element of the Import Sourcing Event request.
There are two ways to determine the project ID:
○Retain the value of the WorkspaceId element from the Import Sourcing Project response.
○Open the project in the UI and view ID in the ID eld under the Overview tab.
4. If you are using a Document Choice document, determine the document name. The system displays this under
the Documents tab in the project and in the template.
You will specify this name in the DocumentName element of the Import Sourcing Event request.
5. Determine the template ID for the document of the sourcing event that you want to create. This step is
described in Creating a Sourcing Event without a Full Sourcing Project [page 122].
6. Create the base64-encoded content for the event. This step is described in Creating a Sourcing Event without a
Full Sourcing Project [page 122].
7. Specify the appropriate values in the Import Sourcing Event request. If you are using a Document Choice
document to create the event, specify Create for the Action element. If you are creating an ad hoc event,
specify CreateAdhoc for the Action element.
Note
If you have already created an event from the Document Choice document, you cannot use the Create
action to create additional events; instead, use the CreateAdhoc action.
Import Sourcing Event Request with a Full Sourcing Project
The following is an example Import Sourcing request to create a sourcing event in an existing full sourcing project
using a Document Choice document. The value for the Contents element was truncated for simplicity. If the
request was used to create an ad hoc sourcing event, the value for the Action element would be CreateAdhoc
and the value of the DocumentName element would be ignored.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:Ariba:Sourcing:vrealm_10">
<soapenv:Header>
<urn:Headers>
<!--You may enter the following 2 items in any order-->
<!--Optional:-->
<urn:variant>?</urn:variant>
<!--Optional:-->
126 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
<urn:partition>?</urn:partition>
</urn:Headers>
</soapenv:Header>
<soapenv:Body>
<urn:EventImportRequest partition="?" variant="?">
<!--Optional:-->
<urn:WSRFXDocumentInputBean_Item>
<!--Optional:-->
<urn:item>
<!--You may enter the following 11 items in any order-->
<urn:Action>Create</urn:Action>
<urn:Attachments></urn:Attachments>
<urn:Contents>0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAAOwADAP7/
CQAGAAAAAAAAAAAAAAABAAAAaQAAAAAAAAAAEAAA/v///wAAAAD+////AAAAAGoAAAD...
</urn:Contents>
<urn:DocumentId></urn:DocumentId>
<urn:DocumentName>My Doc Choice</urn:DocumentName>
<urn:OnBehalfUserId>taikman</urn:OnBehalfUserId>
<!--Optional:-->
<urn:OnBehalfUserPasswordAdapter></urn:OnBehalfUserPasswordAdapter>
<!--Optional:-->
<urn:RFXDocumentHeaderFields>
<urn:Description>
<!--Optional:-->
<urn:DefaultStringTranslation>An RFI created using SOAP </
urn:DefaultStringTranslation>
</urn:Description>
<!--Optional:-->
<urn:Title>
<!--Optional:-->
<urn:DefaultStringTranslation>My RFI</
urn:DefaultStringTranslation>
</urn:Title>
</urn:RFXDocumentHeaderFields>
<urn:ReplaceEventContent>false</urn:ReplaceEventContent>
<urn:TemplateId>SYS0104</urn:TemplateId>
<urn:WorkspaceId>WS14592</urn:WorkspaceId>
</urn:item>
</urn:WSRFXDocumentInputBean_Item>
</urn:EventImportRequest>
</soapenv:Body>
</soapenv:Envelope>
Web Service Example: Creating a Project with
Custom Fields
The WSDL les for tasks that can create or update projects (such the Import Procurement Contract Workspace
task) contain a custom element that contains placeholders for custom project elds of dierent types. The
following WSDL le excerpt shows the rst part of the custom element with the placeholder element for custom
decimal elds:
<xsd:element maxOccurs="1" minOccurs="0" name="custom">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="CustomBigDecimal"
nillable="true">
<xsd:complexType>
<xsd:simpleContent>
<xsd:extension base="xsd:decimal">
<xsd:attribute name="name" type="xsd:string"/>
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 127
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
:
:
</xsd:element>
If your SAP Ariba support team selected the External Integration Field option for your custom eld, the system
includes a documentation element within the element of the appropriate type. The documentation element
species the internal name. For example, the system generated the following element for the custom
Needs EU Approval boolean eld:
<xsd:element maxOccurs="unbounded" minOccurs="0" name="CustomBoolean"
nillable="true">
<xsd:complexType>
<xsd:annotation>
<xsd:documentation>"NeedsEUApproval" is the name of a flex
field that can be imported or exported.</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:extension base="xsd:boolean">
<xsd:attribute name="name" type="xsd:string"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
The SOAP request species the type (CustomBoolean), eld name (NeedsEUApproval), and value (true) in the
custom element:
<urn:custom>
<urn:CustomBoolean name="NeedsEUApproval">true</urn:CustomBoolean>
</urn:custom>
The following listing contains the entire SOAP message:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:Ariba:Sourcing:vrealm_10">
<soapenv:Header>
<urn:Headers>
<!--Optional:-->
<urn:variant></urn:variant>
<!--Optional:-->
<urn:partition></urn:partition>
</urn:Headers>
</soapenv:Header>
<soapenv:Body>
<urn:ContractWorkspaceImportRequest partition="?" variant="?">
<!--Optional:-->
<urn:WSContractWorkspaceInputBean_Item>
<!--Optional:-->
<urn:item>
<urn:Action>Create</urn:Action>
<urn:OnBehalfUserId>molson</urn:OnBehalfUserId>
<urn:OnBehalfUserPasswordAdapter></urn:OnBehalfUserPasswordAdapter>
<urn:ParentAgreementId></urn:ParentAgreementId>
<urn:ParentWorkspaceId></urn:ParentWorkspaceId>
<urn:ProjectHeaderFields>
<urn:AgreementDate>2010-09-14T12:00:00</urn:AgreementDate>
<!--Optional:-->
<urn:Description>
<!--Optional:-->
128 CONFIDENTIAL
SOAP web service API integration guide
Web Service Elements and Examples
<urn:DefaultStringTranslation>My description</
urn:DefaultStringTranslation>
</urn:Description>
<urn:EffectiveDate>2010-09-14T12:00:00</urn:EffectiveDate>
<!--Optional:-->
<urn:ExpirationDate>2011-09-14T12:00:00</urn:ExpirationDate>
<urn:ExpirationTermType>Fixed</urn:ExpirationTermType>
<!--Optional:-->
<urn:HierarchicalType>StandAlone</urn:HierarchicalType>
<urn:Title>
<!--Optional:-->
<urn:DefaultStringTranslation>My project</
urn:DefaultStringTranslation>
</urn:Title>
<!--Optional:-->
<urn:custom>
<urn:CustomBoolean name="NeedsEUApproval">true</
urn:CustomBoolean>
</urn:custom>
</urn:ProjectHeaderFields>
<urn:TemplateId>SYS0052</urn:TemplateId>
<urn:WorkspaceId></urn:WorkspaceId>
</urn:item>
</urn:WSContractWorkspaceInputBean_Item>
</urn:ContractWorkspaceImportRequest>
</soapenv:Body>
</soapenv:Envelope>
For information about specifying values for custom elds for Flex Master Data elds, see Using Custom Elements
for Flex Master Data Fields [page 33].
SOAP web service API integration guide
Web Service Elements and Examples CONFIDENTIAL 129
Contract Data File Formats
In this section:
Contract header le format [page 130]
Contract Terms Export File Format [page 132]
Excel format for contract line items documents [page 132]
Contract header le format
SAP Ariba Contracts exports contract header data to CSV les, which consist of rows of data. The rst row is the
character encoding. For exported les, the character encoding is always set to UTF-8.
The second row is the header row, which lists the column headings. If you have dened custom header elds (ex
elds), and you want them exported, verify with your SAP Ariba representative that they are agged for export on
the Advanced tab of the Field Congurator. Any custom elds are added in columns to the end of the export le as
String types and are labeled cus_xxx, where xxx is the user interface eld label. For example, if a custom eld
Current Status was added to the Contract Workspace page, then the exported column is labeled
cus_CurrentStatus.
The subsequent rows contain the exported data. Each row contains data for one contract, indexed by the Contract
Workspace ID.
●The data in exported CSV les is always in en_US locale format, regardless of user and site default locale
settings.
●Numerical values in exported CSV les do not include the comma (",") separator.
The following table provides a description of the columns in the contract header CSV data export les:
Column Description
Contract ID A unique identier string for the contract.
Last Published The number of the most recently published version of the project.
Title The title of the contract.
Description The userspecied contract description.
Version The most recent contract version.
Access Control A list of access controls applied to the contract, delimited by brackets ([ ]).
Contract Status The status of the contract: Not Created, Draft, Published, Pending, On Hold, Ex
pired, Closed, Draft Amendment.
Owner The user or group who owns this document.
130 CONFIDENTIAL
SOAP web service API integration guide
Contract Data File Formats
Column Description
Time Updated The last updated time of the contract.
Last Modified
By
The last user who modied the contract.
Test Project Indicates if the contract is a test project (or request).
Predecessor The predecessor contract ID.
Hierarchical
Type
Indicates how the contract relates hierarchically to other contracts: as a stand
alone Agreement, Master Agreement or Sub Agreement.
Parent
Agreement
This depends on the Hierarchical type. If the Hierarchical type is Sub Agree
ment, then this is applicable to choose the parent or master agreement. This
option is not applicable if the Hierarchical type is Standalone or Master agree
ment.
Supplier Name The full name of the contract supplier.
Affected
Parties
A list of names of aected parties, delimited by brackets ([ ]).
Affected
Parties IDs
A list of IDs of aected parties, delimited by brackets ([ ]). Each ID contains a
series of domain and value pairs enclosed in parentheses, where the domain
and value are separated by a colon (domain:value). For example, [(duns:
110011811)(buyersystemid:sid803)(internalsystemid:
20003)].
Supplier ID The ID of the contract supplier.
Amount_
Currency
The currency specied in the event, when it is dierent from the project cur
rency. The values in this column are standard ISO currency codes, such as USD
or EUO.
Amount_Amount The contract's total monetary amount.
Contract Type The type of contract chosen. It can be Fixed, Perpetual or Auto-Renew.
Effective Date The date when the terms of the contract go into eect.
Agreement Date The date when the parties agreed to the contract.
Expiration Date The date when the contract will expire and its terms will no longer be in eect, if
it is not renewed.
InternalId Internal ID assigned to the workspace or request by SAP Ariba Contracts .
RelatedId This is an optional eld.
AmendmentReason Reasons entered at the time of choosing the type of Amendment. (Administra
tive, Renewal, Termination, or Amendment)
AmendmentReason
Comment
Comments entered at the time of creating an Amendment.
IsContractReque
st
Indicates a contract workspace is required or not.
CreateDate The creation date for the event's contract project. Dates are in the format EEE,
d MMM, yyyy. For example, Wed, 18 Feb, 2009.
SOAP web service API integration guide
Contract Data File Formats CONFIDENTIAL 131
Column Description
BaseLanguage Base language of the contract.
Contract Terms Export File Format
For information about exported contract terms les, see the SAP Ariba guide for your procurement or invoicing
solution.
Excel format for contract line items documents
An Excel version of a contract line items document contains the following worksheets:
●Contract Header
●Contract Item Information
●Header Attributes
●Item Attributes
All cells in the worksheets are general format cells.
Contract Header Worksheet Columns
A Contract Header worksheet contains the columns shown in the following table. When a line items document is
exported, the values are provided for information only. SAP Ariba does not import values from this worksheet.
Column Description
Event ID Document ID and title (docId - title) of the line items.
Title Title of the line items document.
Description Description for the line items document.
Requester ID of the user who created or updated this document.
Company Name SAP Ariba does not set or read this eld.
Supplier Name Supplier eld from the project header.
SupplierID Domain Domain from which the supplier ID is assigned, such as buyer
systemid or sap. A supplier can have multiple IDs, each as
signed from a dierent domain.
132 CONFIDENTIAL
SOAP web service API integration guide
Contract Data File Formats
Column Description
SupplierID Value Supplier ID.
Contract Source SAP Ariba does not set or read this eld.
Buyer Contract ID The corresponding SAP Ariba procurement or invoicing com
pliance contract ID.
Term Type Contract type. This is always Item.
Limit Type Species how the limit is regulated--by Amount (cost of items)
or Quantity (number of items).
Agreement Date Agreement Date from the workspace header.
Eective Date Eective Date from the workspace header.
Expiration Date Expiration Date from the workspace header.
Contract Currency SAP Ariba does not set or read this eld.
Minimum Amount SAP Ariba does not set or read this eld.
Maximum Amount SAP Ariba does not set or read this eld.
Reference Document If the line items document was created from a contract terms
link to a compliance contract, this is the ID of the contract
terms.
Contract Item Information Worksheet Columns
Column Description
Bundle Bundle name, as specied in the event award (for line items
documents created from SAP Ariba Sourcing event awards).
Item Number Used by SAP Ariba to correlate an item with attributes in the
Item Attributes worksheet and to identify an item.
Short Name Item name.
Description Item description.
Extended Description Full Description eld for a compliance contract.
Supplier Part Number Supplier part number.
SOAP web service API integration guide
Contract Data File Formats CONFIDENTIAL 133
Column Description
Unit of Measure Unit of measure for the unit price (Price Unit eld for a compli
ance contract).
Unit Price Price per unit.
Discount Amount Discount, specied as a xed amount.
Supplier Discount (%) SAP Ariba does not set or read this eld.
Unit Price Currency Currency type for unit price.
Classication Domain Domain for the category or classication, such as UNSPSC for
commodities.
Classication Code Category or classication code, such as a commodity code.
Quantity The number of units.
Minimum Quantity Minimum number of items that can be purchased.
Maximum Quantity Maximum number of items that can be purchased.
Minimum Amount Minimum value of the items that can be purchased.
Maximum Amount Maximum value of the items that can be purchased.
Manufacturer Name Name of manufacturer.
Manufacturer Part Number Manufacturer's part number.
Limit Type Species how the limit is regulated--by Amount (cost of items)
or Quantity (number of items).
Number Used for service item hierarchies. A string with a unique dot
ted-decimal value that indicates the item's hierarchy and its
position in the hierarchy. For example, items with Number val
ues 2, 2.1, and 2.1.1 are members of the same hierarchy.
The item with Number 2 is at the highest level of the hierarchy
and the item with Number 2.1.1 is at the lowest level.
Number is used only to dene service item hierarchies and is
ignored if LineType is not Service Line, Service
Outline, or Service Specification. Number has no
eect on an item's order in a list, other than ensuring that the
items in the same hierarchy are listed together and in descend
ing order.
134 CONFIDENTIAL
SOAP web service API integration guide
Contract Data File Formats
Column Description
LineType Used for service item hierarchies. Species the type of service
item. Valid values:
●Service Line (top-most level; all service outlines and
service specications must be contained in a service line)
●Service Outline (optional objects used to organize
service items; can contain child service outlines or service
specications)
●Service Specification (species a service to be
performed; cannot contain any children)
Header Attributes Worksheet Columns
The following columns are present in the Header Attributes worksheet but SAP Ariba does not set or read values
for these columns:
●Attribute Name
●Attribute Value
●Display Text
●Type
●Description
●Table Section Column
Item Attributes Worksheet Columns
The Item Attributes worksheet contains one row for each term dened for each line item.
Column Description
Item Number Used by SAP Ariba to correlate attributes with an item in the
Contract Item Information worksheet.
Attribute Name Attribute name.
Attribute Value Attribute value.
Display Text Optional display text for the attribute.
Type Data type for the attribute, such as Text or Money.
Description Optional description for the attribute.
Items added from SAP item master data have entries with the following Attribute Name values:
SOAP web service API integration guide
Contract Data File Formats CONFIDENTIAL 135
Attribute Name Column Value Description
Item Category Category to which the material belongs.
Material Group Name of the material group for the item.
Material Number Number (ID) of the material group for the item.
Material Type Material type for the item.
Incoterms International Commercial Terms ID that species Terms of De
livery.
Material Code Material code for the item.
Requisition ID ID of the ERP requisition for the item.
RFQ ID ID of the ERP RFQ for the item.
Requisition Item Number Line number for this item in the ERP requisition.
RFQ Item Number Line number for this item in the ERP RFQ.
Base Unit Of Measure Unit of measure in which the stocks of the item is measured.
Order Unit Unit of measure used when ordering this item.
Plants ERP IDs of plants that may purchase this item. IDs are en
closed by square brackets and delimited by a comma and
space. For example: [1000, 2000].
136 CONFIDENTIAL
SOAP web service API integration guide
Contract Data File Formats
Sourcing Data File Formats
In this section:
Sourcing Import File Formats [page 137]
Sourcing Export File Formats [page 137]
Sourcing Import File Formats
You can import sourcing event data for either quick or full projects from Microsoft Excel les. The le format you
use for event data import is based on a prototype Excel le that you generate from SAP Ariba Sourcing. See the
sections on creating event spreadsheet prototypes and editing spreadsheets for import in the SAP Ariba Event
Management Guide for information on generating a prototype that illustrates the le format you need for importing
event data.
Sourcing Export File Formats
SAP Ariba Sourcing exports event data to CSV les, which contain a standard set of columns, as well as additional
columns for any custom elds in your SAP Ariba Sourcing solution that have been agged for third-party
integration.
Note
Custom elds are only included in data exports from SAP Ariba Sourcing if they have been agged for third-party
integration. To make sure that specic custom elds in your solution are agged for third-party integration,
contact your SAP Ariba representative.
SOAP web service API integration guide
Sourcing Data File Formats CONFIDENTIAL 137
Event Data
The following table describes the columns that are present in CSV data les exported from SAP Ariba Sourcing for
events:
Column Java Data Type Description
Commodity String The commodity or commodities specied for the project. This
column can contain any of the commodities dened for your sol
ution. In cases where there is more than one commodity speci
ed for a project, this column contains a list commodity codes
separated by pipe characters (|).
Contract
Effective Date
Date The contract eective date that the user enters when creating
the SAP Ariba Sourcing project. Dates are in the format EEE, d
MMM, yyyy. For example, Wed, 5 Nov, 2008.
Contract Months Double The number of contract months the user enters when creating
the SAP Ariba Sourcing project.
Creation Date Date The creation date for the event’s SAP Ariba Sourcing project.
Dates are in the format EEE, d MMM, yyyy. For example,
Wed, 5 Nov, 2008.
Project Id String The ID for the event’s SAP Ariba Sourcing project.
Project Owner String The name of the user who owns the SAP Ariba Sourcing project;
for example, Bob Smith.
Regions String The regions specied for the project. This column can contain
any of the region values dened for your solution. In cases where
there is more than one region specied for a project, this column
contains a list of regions separated by pipe characters (|).
Project Title String The title for the SAP Ariba Sourcing project, in the language
specied by the exporting user’s locale settings.
Currency String The currency specied for the event, when it is dierent from the
project currency. The values in this column are standard ISO cur
rency codes, such as USD or EUR.
Event Type String The event type, such as Auction, Forward Auction, or
RFI.
Event Owner String The username of the user who owns the event.
Event Id String The ID for the event.
Event Title String The title for the event, in the language specied by the exporting
user’s locale settings.
Supplier Name String The full name of the bidding supplier as specied in the event; for
example, Mary Jones.
Supplier Phone String The supplier’s phone number.
Supplier
Address
String The supplier’s address.
138 CONFIDENTIAL
SOAP web service API integration guide
Sourcing Data File Formats
Column Java Data Type Description
Supplier
Organization
Name
String The name of the supplier organization associated with the bid
ding supplier.
Supplier
Organization Id
String A list of all organization IDs, separated by pipe characters (|), for
the supplier organization associated with the bidding supplier.
Because the same supplier can have dierent IDs in dierent
third-party systems, SAP Ariba organization IDs are do
main:value pairs for specic systems, and the entire list is ex
ported in this column. For example, ABC Company’s list of organ
ization IDs might look like this:
SAP:1234|Oracle:2345|PeopleSoft:3456
Type String The content type, such as Line Item or Section.
Line Type String Service line type. Species the type for a line item in an SAP
service hierarchy, such as Service Line, Service
Outline, or Service Specification.
Reporting
Savings.reportin
gcurrency
BigDecimal Bid savings. This column is only exported when the event cur
rency and the site’s default reporting currency are dierent; the
value in this column is in the reporting currency. For example, if
the event is in Euros but the default reporting currency is US dol
lars, the header for this column is Reporting
Savings.USD, and the data in the column is in US dollars.
Participant String The bidding supplier’s full name and organization; for example,
ABC Company(Mary Jones).
Score Value BigDecimal The score value for the bid participant.
Bid Id String The ID of the bid.
Savings
Percentage
BigDecimal Percentage of bid savings.
Bid Status String The status of the bid, such as Accepted, Pending
Selection, or Replaced.
Reporting
Extended
Price.reportingc
urrency
BigDecimal The extended price (unit cost times bid quantity) of the bid
items. This column is only exported when the event currency and
the site’s default reporting currency are dierent; the value is al
ways in the reporting currency. For example, if the event is in Eu
ros but the default reporting currency is US dollars, the header
for this column is Reporting Extended Price.USD,
and the data in the column is in US dollars.
Reporting
Price.reportingc
urrency
BigDecimal The bid price. This column is only exported when the event cur
rency and the site’s default reporting currency are dierent; the
value in this column is in the reporting currency. For example, if
the event is in Euros but the default reporting currency is US dol
lars, the header for this column is Reporting PriceS.USD,
and the data in the column is in US dollars.
Quantity BigDecimal The bid quantity.
SOAP web service API integration guide
Sourcing Data File Formats CONFIDENTIAL 139
Column Java Data Type Description
Price BigDecimal The bid price in the event currency.
Savings BigDecimal Bid savings in the event currency.
Rank Integer The supplier’s rank.
Extended Price BigDecimal The extended price (price times quantity) of the bid items in
event currency.
Item Name String The name of the item in the bid.
Section/Lot String The name of the bid’s section or lot.
Award
Allocation
Percentage
BigDecimal The percentage of the total award allocated for the bid.
In addition to the columns described above, the exported CSV le can contain the following data:
●A column of type String for each custom term dened for the event. The header for a custom term column is
the term name.
●A column of type BigDecimal for each scenario. The header for a scenario column is Scenario:
scenarioname, where scenarioname is the name of the scenario dened when the event is created. The
column contains the allocation percentage for the item in the bid.
RFX Award Data
The Download RFX Award, Download RFX Award with Filters, and Export RFX Award web services export a CSV le
for each RFX award. Each row in the le contains data for an item from one of the following sources:
●a bid or response from a participant
●a value entered by the event owner (an initial, historical, or reserve value)
●the leading bid or response for the item
Use the Item Name or Item Number column with the Award Allocation column to nd the bids or responses
rewarded for a given item.
Column Description
Commodity The commodity or commodities specied for the project. This column can contain any of the
commodities dened for your solution. In cases where there is more than one commodity
specied for a project, this column contains a list commodity codes separated by pipe char
acters (|).
Contract
Effective
Date
The contract eective date that the user enters when creating the SAP Ariba Sourcing
project. Dates are in the format EEE, d MMM, yyyy. For example, Wed, 5 Nov, 2008.
Contract
Months
The number of contract months the user enters when creating the SAP Ariba Sourcing
project.
Creation Date The creation date for the event’s SAP Ariba Sourcing project. Dates are in the format EEE,
d MMM, yyyy. For example, Wed, 5 Nov, 2008.
140 CONFIDENTIAL
SOAP web service API integration guide
Sourcing Data File Formats
Column Description
Project Id The ID for the event’s SAP Ariba Sourcing project, such as WS1234.
Project Owner Project owner. For quick projects (standalone events), this is the event owner.
Regions Regions, as specied in the event or project header. In cases where there is more than one
region specied for a project, this column contains a list of regions separated by pipe char
acters (|).
Project Title Project name. For quick (standalone) events, this is the same as the event name.
Company Company code for the event (set if your site is integrated with an external system).
Purchasing
Organization
Purchasing organization for the event (set if your site is integrated with an external system).
Purchasing
Group
Purchasing group for the event (set if your site is integrated with an external system).
Payment Terms Payment terms for the event (set if your site is integrated with an external system).
Document Type Type of document to create on the external system from this data, such as a Purchase
Order or Contract (set if your site is integrated with an external system).
Document
Category
Category of document to create on the external from this data, such as a NB Standard
Purchase Order or WK Value Contract (set if your site is integrated with an external sys
tem).
Currency The currency specied for the event, when it is dierent from the project currency. The val
ues in this column are standard ISO currency codes, such as USD or EUR.
Event Type Event type. Possible values are: RFI, Survey, RFQ, Forward Auction, Auction, and
RFP.
Event Owner The username of the user who owns the event.
Event Id Event ID, such as Doc1234.
Event Title Event title (name).
Supplier Name Name of the supplier user for the data in this row (the user who entered the bid or re
sponse). If blank, the data in this row was entered as content by the event owner (for exam
ple, data could be the initial or historic price for an item).
Supplier
Phone
Phone number of the supplier for the data in this row.
Supplier
Address
Address of the supplier for the data in this row.
Supplier
Organization
Name
Organization name of the supplier for the data in this row.
Supplier
Organization
Id
IDs of the supplier for the data in this row. Each ID is in the format domain:value, and the
IDs are separated by pipe (|) characters. For example: buyersystemid:sid123|
sourcingnetworkid:an70000000123|internalsystemid:1001|duns:
999999999|networkid:an70000000123|oracle:1234|
psoft:share:usa0000123|sap:0000001123
Bid Id Identier for the bid.
SOAP web service API integration guide
Sourcing Data File Formats CONFIDENTIAL 141
Column Description
Bid Status Bid Status.
Participant Source for the data in this row. For bids or responses, this is the participant organization and
user participant. For data entered by the event owner, this column indicates the type of data
(Initial (initial value), Historic, Reserve). For data that indicates the leading bid or
response, the value is Leading.
Section/Lot Section or lot name.
Item Name Name of the line item or lot, as entered by the event owner.
Rank Rank for the bid or response in this row (the bid with the lowest price is ranked 1).
Savings
Percentage
Savings percentage for the bid or response in this row.
Score Value Score calculated for the participant using grading and scoring rules. For more information,
see the Grading and scoring topic.
Type Item type (Line Item, Lot Item, Basket Lot, Cost Item, Biddable Lot,
Item Lot, Single Item Lot).
Line Type Service line type. Species the type for a line item in an SAP service hierarchy, such as
Service Line, Service Outline, or Service Specification.
Submission
Date
Submission date in the format EEE, d MMM, yyyy. For example, Wed, 5 Nov, 2008.
Item Number Number that identies the line item or lot relative to the other content in the RFX or auction.
Price Price for the bid or response in this row.
Reporting
Price.reportin
gcurrency
The bid price in your site’s default reporting currency (reportingcurrency). For example,
if the default reporting currency for you site is US dollars, the header for this column is
Reporting Price.USD, and the data in the column is in US dollars.
Quantity Quantity for the item.
Extended
Price
Extended price (price * quantity).
Savings The savings (amount) for this response or bid.
Reporting
Savings.report
ingcurrency
The savings in your site’s default reporting currency (reportingcurrency). For example, if
the default reporting currency for you site is US dollars, the header for this column is
Reporting Savings.USD, and the data in the column is in US dollars.
Material
Group
Material group for the item. Only present if the item was added from item master data.
Material
Number
Material number for the item. Only present if the item was added from item master data.
Material Type Material type for the item. Only present if the item was added from item master data.
Plant Plant for the item. Only present if the item was added from item master data.
142 CONFIDENTIAL
SOAP web service API integration guide
Sourcing Data File Formats
Column Description
Item Category Category for the item. Only present if the item was added from item master data
Bid Currency Currency type used by the participant.
Bid Savings The savings for this response or bid
Bid Extended
Price
The extended price for this response or bid.
Bid Price The price submitted for this response or bid.
Award
Allocation
Percentage
The amount awarded for this bid, shown as a percentage of the total.
Scenario
scenario_name
The amount allocated for this bid for the given scenario, shown as a percentage of the total.
There will be one Scenario column for each scenario created for the event.
SOAP web service API integration guide
Sourcing Data File Formats CONFIDENTIAL 143
Managing Integration Migration
In this section:
About Integration Migration Management [page 144]
Reviewing and Accepting Changes to Data Denitions [page 145]
Reverting Accepted Changes to Data Denitions [page 147]
Reviewing Data Denitions in the Data Dictionary [page 148]
Reviewing Data Denitions in a WSDL [page 149]
About Integration Migration Management
The integration migration management utility enables you to control when changes to data denitions are adopted
in data export and import operations so that the changes do not cause compatibility problems when exchanging
data with ERP or other external systems.
SAP Ariba introduces new elds in data objects and data export tasks to support newer workows and to send
more information to ERP or other external systems. Any change to the data denition — for example, a new eld
introduced in an export task, or a change to the order of the elds, has the potential to cause compatibility
problems when exchanging data with ERP or other external systems.
To solve this potential problem, the integration migration management feature enables you to review the eld
changes made to data export and import tasks, and if desired, accept the changes. This ensures that the data
denition changes that SAP Ariba makes will not be incorporated into your data export or import tasks until you
explicitly accept those changes.
After accepting changes to the data denitions, if needed, you can revert to the previously accepted data denition.
For the SAP Ariba Web Services, integration migration management is needed for both data imports and data
export operations, because all messages must adhere to the WSDL for the event regardless of whether they are
import or export operations. For the le channel, the Integration Migration Management feature is not needed for
imports operations because import integrations available out of the box in SAP Ariba solutions do not rename
import elds, and are able to handle extra and incorrect elds.
Integration migration management is not applicable when exporting the following items and changes to the data
denitions for these items occur without user intervention:
●Sourcing Projects
●Supplier Prole Questionnaires (SPQs) and data that includes responses to SPQs, such as supplier proles
144 CONFIDENTIAL
SOAP web service API integration guide
Managing Integration Migration
Integration Migration Management Workow
Integration migration management involves the following activities:
1. After a release, whenever eld changes are introduced to an SAP Ariba data export or import task (in a hot x
or service pack), you view these changes in the Integration Manager Data Denition workspace.
2. You can review the changes and accept them. Once accepted, the data export or import task changes take
eect.
You cannot choose specic changes to accept or revert in a given data export or import task. You must accept all
the changes to the task in order for any of the changes to take eect.
Related Information
Reviewing and Accepting Changes to Data Denitions [page 145]
Reverting Accepted Changes to Data Denitions [page 147]
Reviewing Data Denitions in the Data Dictionary [page 148]
Reviewing Data Denitions in a WSDL [page 149]
Reviewing and Accepting Changes to Data
Denitions
Prerequisites
You must be a member of the Integration Admin or Customer Administrator group.
Procedure
1. In Ariba Administrator, click Integration Manager Data Denition .
2. On the right side of the top menu bar, click Advanced.
3. Click Refresh Data Denition:
This ensures that you have the latest data for your installation.
4. In the Data Denition page, check the Status column for tasks with the status Changed. Select the Review
command in the Actions pull-down menu of a data export or import task with the Changed status.
A page opens that lists the les or groups with new or changed elds for that task.
5. Select the le name (if it is a le channel task) or group name (if it is a web services task) with the status Needs
Review.
SOAP web service API integration guide
Managing Integration Migration CONFIDENTIAL 145
6. Review the changes. The New Field column shows the new data denition.
7. If you want to accept the displayed changes, click Accept Changed Fields. If you are not ready to accept the
changes, click Exit.
8. Repeat the Review and Accept Changed Fields actions to review and accept changes for all les with changes.
9. After accepting all changes in the data export or import task, click Publish All Changes.
10. Click OK in the conrmation dialog box to incorporate the changes into this data export or import task.
Results
Note
You must accept all the changes to the data export or import task in order for any of the changes to take eect.
You can revert changes in the data export or import task that you have accepted. You can revert to the most
recently accepted version only.
Data Denition Change Example
Context
A user in the Integration Admin group clicks Integration Manager Data Denition .
In the top menu bar, the user clicks Advanced.
On the Data Denition page, the user clicks Refresh Data Denition.
The Status eld shows the Export Supplier Users and Export Supplier Users and their Organizations have
Changed data denitions. The user clicks Actions Review for the Export Supplier Users task.
The Export Supplier Users page shows the names of all les for the task eld. Select a le with the status Needs
Review. In this example, the task has only one le (NewSupplierExport.xls). The new eld name in this le is
146 CONFIDENTIAL
SOAP web service API integration guide
Managing Integration Migration
IsUserApproved. The user clicks Accept Changed Fields to accept the changes for the
NewSupplierExport.xls le. If multiple les had changes for this task, the user would click each le name to
view the changes, then accept the changes.
The user clicks Publish All Changes in the upper right corner of the page.
Reverting Accepted Changes to Data Denitions
Prerequisites
You must be a member of the Integration Admin or Customer Administrator group.
Procedure
1. In Ariba Administrator, select Integration Manager Data Denition .
2. On the right side of the top menu bar, click Advanced.
3. Click Refresh Data Denition:
This ensures that you have the latest data for your installation.
4. In the Data Denition page, select the Revert command in the Actions pull-down menu of the data export or
import task.
5. Select the le name (if it is a le channel task) or group name (if it is a web services task) with the status Needs
Review.
SOAP web service API integration guide
Managing Integration Migration CONFIDENTIAL 147
Fields that will be reverted are shown in red.
6. Click Accept Changed Fields to revert changes.
7. Repeat steps the steps to review and accept changes for all les or groups to be reverted.
8. After accepting all the changes to revert, click Publish All Changes, and then click OK in the conrmation
dialog box to restore the data export or import task to its previous state.
Results
Note
You must revert all the changes to the data export or import task for any of the changes to be reverted.
Reviewing Data Denitions in the Data Dictionary
Prerequisites
You must be a member of the Integration Admin or Customer Administrator group.
(File channel only) The Data Dictionary reects the data denition for each le channel data export or import task.
Procedure
1. In Ariba Administrator, click Integration Manager Data Denition .
2. Click the Download Data Dictionary link on the Data Denition page.
Results
The contents are color coded as follows:
●deprecated elds are shown in red
●new elds to be accepted are shown in green
The column New File Column Name indicate any new or deprecated elds. The new column shows what the
data denition would be if you accepted the changes. If there are no changes to the event, the columns File
Column Name and New File Column Name have the same contents.
148 CONFIDENTIAL
SOAP web service API integration guide
Managing Integration Migration
Reviewing Data Denitions in a WSDL
Context
(Web Services only) You can preview what the contents of the WSDL would be if you accepted the data denition
changes.
Procedure
1. Use the procedure to generate a WSDL le, as described in Generating a WSDL File [page 22].
2. Copy the destination URL for the WSDL le.
3. Add the latest=true parameter to the URL, as shown in the following example:
http://s1.ariba.com/Buyer/soap/realm/event?wsdl&latest=true
Where:
realm is your realm name
event is your data export or import task name
This generates the WSDL as it would appear if you accepted all of the data denition changes for this event.
SOAP web service API integration guide
Managing Integration Migration CONFIDENTIAL 149
Site Conguration Options for Integration
Services
Site conguration options are set for you by SAP Ariba.
Application.ACM.EnableWSContractTermsPush
Setting this parameter to Yes enables users to export a Contract Terms Excel le document
to an ERP or other external system by clicking the Export External System
command in the Actions pull-down menu for the Contract Terms document. The SAP Ariba
system uses the Export Contract Terms web service to send the Contract Terms le.
The default value is No.
Application.ACM.EnableWSWorkspaceIdOnCreatePush
If the Export WorkspaceId service is congured, setting this parameter to Yes causes
the SAP Ariba system to use the Export WorkspaceId service to send a workspace ID to
the outbound endpoint when an SAP Ariba Contractsworkspace is created. The default
value is No.
Application.ACM.EnableWSWorkspaceIdOnPublishPush
If the Export WorkspaceId service is congured, setting this parameter to Yes causes
the SAP Ariba system to use the Export WorkspaceId service to send a workspace ID to
the outbound endpoint when an SAP Ariba Contracts workspace is published. The default
value is No.
Application.ACM.EvaluateParentAgreementFromParentContractId
Species if the import workspace web services (Import Procurement Contract Workspace,
Import Internal Contract Workspace, Import Sales Contract Workspace) validate the
ParentAgreementIdelement when updating subagreements against the contract ID of
the parent workspace or against the internal ID of the parent workspace. The default value
is No (validate against the internal ID). In most cases, a workspace's contract ID and internal
ID are the same. Setting this parameter to Yes is useful when updating subagreements that
have parent agreements that were created using legacy load operations and the internal ID
does not match the contract ID and is not known.
Application.ACM.ExternalDocumentBrowserURL
If the ERP system has a web page with links that generate and send Import Document
SOAP messages to the SAP Ariba system, set this parameter to the URL for that web page.
SAP Ariba users who click Actions Upload External Document from the
Documents tab in a project will be forwarded to this URL.
Application.ACM.TimeZoneIDForExportExcelByWebService
By default, date elds (Date_Field and CalendarDate_Field type) exported for the
RFX award are listed in the time zone for the SAP Ariba server (such as GMT -8). Use this
parameter to adjust the date elds using a dierent time zone. The value must be a time
zone ID supported by the Java TimeZone class (a value returned by
java.util.TimeZone.getAvailableIDs(), such as Etc/GMT+8, Etc/GMT-9, Asia/
Calcutta, or IST).
150 CONFIDENTIAL
SOAP web service API integration guide
Site Conguration Options for Integration Services
Application.AQS.AutoEventCompletionWhenAllItemsAwarded
Species if an event automatically changes to the Completed state after at least one award
is submitted for each item in the event. The default value is Yes; if set to No, events must be
manually closed.
Application.AQS.EnableWSAwardPush
Setting this parameter to Yes enables the RFXAwardExport scheduled task to use the
Export RFX Awards web service to export RFX awards to an external system. The default
value is No.
Application.Base.PreferredTimeZoneIDForUser
By default, users created using the Import Users web service have their time zone set to the
time zone for the SAP Ariba server (such as GMT -8). Use this parameter to assign a
dierent time zone for users created using the Import Users web service. The value must be
a time zone ID supported by the Java TimeZone class (a value returned by
java.util.TimeZone.getAvailableIDs(), such as Etc/GMT+8, Etc/GMT-9, Asia/
Calcutta, or IST).
Application.Messaging.Channels.WS.IncludeTimePortionToParseDate
Setting this parameter to Yes causes the web services to include the time (hours, minutes,
seconds) portions of XSD DateTime elements that would otherwise be converted to
calendar dates (such as ToDate and FromDate elements used for time lters). The default
value is No.
SOAP web service API integration guide
Site Conguration Options for Integration Services CONFIDENTIAL 151
Site conguration parameters for
synchronization of supplier data with the
unied vendor model
Some of the functionality for this feature is controlled by site conguration options, which SAP Ariba sets for you.
Application.SM.VendorPushTaskEnabled
Species whether or not supplier data is synchronized from the classic supplier
organization model to the new unied vendor data model used by SAP Ariba Supplier
Lifecycle and Performance and SAP Ariba Supplier Information and Performance
Management (new architecture) solutions. The synchronization occurs for a limited
number of elds and is performed by the SMVendorSyncScheduledTask scheduled task.
The default value, No, means that supplier data is not synchronized.
Application.SM.VendorContactPushTaskEnabled
Species whether or not supplier user data is synchronized from the classic supplier
organization model to supplier contacts in the new unied vendor data model used by SAP
Ariba Supplier Lifecycle and Performance and SAP Ariba Supplier Information and
Performance Management (new architecture) solutions. The synchronization occurs for a
limited number of elds and is performed by the SMVendorContactPushScheduledTask.
The default value, No, means that supplier user data is not synchronized.
Application.SM.ITKImportProfileInSM
Species whether or not, in solutions where a customer is migrating from using the supplier
prole questionnaire to supplier registrations, and has imported a data le mapping
between questions in the two questionnaires, extended prole data imported via SAP Ariba
integration toolkit or SOAP web service integration is synchronized from the now-inactive
supplier prole questionnaire to supplier registrations. The default value, No, means that
there is no synchronization for supplier prole questionnaire to supplier registrations.
152 CONFIDENTIAL
SOAP web service API integration guide
Site conguration parameters for synchronization of supplier data with the unied
vendor model
Revision History
The following table provides a brief history of the updates to this guide. SAP Ariba updates the technical
documentation for its cloud solutions if
●software changes delivered in service packs or hot xes require a documentation update to correctly reect the
new or changed functionality;
●the existing content is incorrect or user feedback indicated that important content is missing.
Ariba reserves the right to update its technical documentation without prior notication. Most documentation
updates will be made available the same week the software service packs are released, but critical documentation
updates may be released at any time.
Month/Year of
Update
Updated Topic Short Description of Change
July 2018 Sourcing Export File Formats Added Line Type.
March 2018 ●Sourcing Event and
Sourcing Project Opera
tions
Corrected formatting.
January 2018 ●Sourcing Event and
Sourcing Project Opera
tions
●DocumentStatusChange
Notication
●DocumentURLOutBound
New web services.
November 2017 ●Import CLID using XML
●Contract Data File For
mats
Added Number and LineType elements and columns for service
items.
About SAP Ariba SOAP Web
Service APIs
Updated the information about the applicability of the integration
methods in this guide to SAP Ariba Supplier Lifecycle and Per
formance and SAP Ariba Supplier Information and Performance
Management (new architecture).
SOAP web service API integration guide
Revision History CONFIDENTIAL 153
Month/Year of
Update
Updated Topic Short Description of Change
●Using SOAP web service
APIs for supplier data in
tegration with the unied
vendor model
●Data ow for supplier
data loaded through
SOAP web service APIs
into the unied vendor
model
●Supplier organization
data synchronization to
the unied vendor model
●Organization ID synchro
nization to ERP vendor
IDs in the unied vendor
model
●Supplier user synchroni
zation to the unied ven
dor model
●Synchronization of sup
plier prole questionnaire
data to the supplier regis
tration questionnaire
●Site conguration param
eters for synchronizing
supplier data to the uni
ed vendor model
Added topics about using SOAP web service APIs for limited sup
plier data integration with SAP Ariba Supplier Lifecycle and Per
formance and SAP Ariba Supplier Information and Performance
Management (new architecture), which use the unied vendor
model.
August 2017 ●Import Contract Line
Items Document
●Excel format for contract
line items documents
Information about the new Import Contract Line Items Docu
ment service.
July 2017 ●Download Contract
Header Fields
●Download RFX Awards
with Filters
●Download Document IDs
●Export Organizations
●Export Supplier Proles
●Site Conguration Op
tions for Integration Serv
ices
Added information about the
Application.Messaging.Channels.WS.IncludeTi
mePortionToParseDate site conguration parameter.
154 CONFIDENTIAL
SOAP web service API integration guide
Revision History
Month/Year of
Update
Updated Topic Short Description of Change
Download RFX Awards with
Filters
Added information about the IncludePendingEvents ele
ment and the site conguration option
Application.AQS.AutoEventCompletionWhenAllI
temsAwarded.
●Site Conguration Op
tions for Integration Serv
ices
Added information about the site conguration option
Application.AQS.AutoEventCompletionWhenAllI
temsAwarded.
About SAP Ariba SOAP Web
Service APIs
The information in this guide is not applicable to the SAP Ariba
Supplier Lifecycle and Performance and SAP Ariba Supplier In
formation and Performance Management (new architecture) sol
utions.
February 2017 ●Download Contract
Terms
●Export Contract Terms
Added information about support for extracting Contract Line
Items Document (CLID) using standard web services.
SOAP web service API integration guide
Revision History CONFIDENTIAL 155
Important Disclaimers and Legal Information
Hyperlinks
Some links are classied by an icon and/or a mouseover text. These links provide additional information.
About the icons:
●Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your agreements
with SAP) to this:
●The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
●SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
●Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such links, you
agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this information.
Beta and Other Experimental Features
Experimental features are not part of the ocially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by SAP at
any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use the
experimental features in a live operating environment or with data that has not been suciently backed up.
The purpose of experimental features is to get feedback early on, allowing customers and partners to inuence the future product accordingly. By providing your feedback
(e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax and
phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of example
code unless damages have been caused by SAP's gross negligence or willful misconduct.
Gender-Related Language
We try not to use genderspecic word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.
156 CONFIDENTIAL
SOAP web service API integration guide
Important Disclaimers and Legal Information
SOAP web service API integration guide
Important Disclaimers and Legal Information CONFIDENTIAL 157
www.ariba.com
© 2018 SAP SE or an SAP aliate company. All rights reserved.
No part of this publication may be reproduced or transmitted in any
form or for any purpose without the express permission of SAP SE
or an SAP aliate company. The information contained herein may
be changed without prior notice.
Some software products marketed by SAP SE and its distributors
contain proprietary software components of other software vendors.
National product specications may vary.
These materials are provided by SAP SE or an SAP aliate company
for informational purposes only, without representation or warranty
of any kind, and SAP or its aliated companies shall not be liable for
errors or omissions with respect to the materials. The only
warranties for SAP or SAP aliate company products and services
are those that are set forth in the express warranty statements
accompanying such products and services, if any. Nothing herein
should be construed as constituting an additional warranty.
SAP and other SAP products and services mentioned herein as well
as their respective logos are trademarks or registered trademarks of
SAP SE (or an SAP aliate company) in Germany and other
countries. All other product and service names mentioned are the
trademarks of their respective companies.
Please see https://www.sap.com/about/legal/trademark.html for
additional trademark information and notices.

Navigation menu