Connectors
ERP & Enterprise Systems
SAP Ariba
Procurement: sourcing projects, events, contracts, suppliers, and reporting jobs
- Signs in with
- OAuth 2.0 sign-in
- Runs on
- Cloud or On-Prem Worker
- Operations
- 435
- Ready-made triggers
- 0
Connect SAP Ariba
- In Neblex open Connect › Connections and click New Connection.
- Search for SAP Ariba and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
For services offered under Connect a Service you only sign in and approve access. Otherwise use Connect with OAuth2 with your own OAuth app. See Authorize with OAuth.
| Field | What to enter |
|---|---|
| API runtime URLRequired | The production or test runtime URL of the API this application is approved for, from the Environment Details of the API on the SAP Ariba Developer Portal, without https://.Example: openapi.ariba.com/api/<api>/v1/prod |
| Token endpointRequired | The OAuth Server URL Prefix from the same Environment Details followed by /v2/oauth/token. |
| OAuth client IDRequired | The OAuth client ID SAP Ariba issued when it approved the application. |
| OAuth secretRequiredSecret | The OAuth secret generated for that client. |
| Application keyRequiredSecret | The application key of the application, sent as the apiKey header on every request. |
| RealmOptional | The site (realm) name, for APIs that take a realm. Leave empty for SAP Business Network APIs. |
| SAP Business Network IDOptional | The ANID sent as X-ARIBA-NETWORK-ID, for SAP Business Network APIs. |
| Refresh tokenOptionalSecret | Optional. A refresh token from an earlier token request; SAP Ariba returns a new one on every refresh and the connection keeps it. |
Use it in a flow
- Open a flow, open the node library and search for SAP Ariba.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from SAP Ariba without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if SAP Ariba can send webhooks, a Webhook trigger receives them at its own URL.
Operations
435 operations in 71 groups. Each one is a step you can add to a flow.
Analytical Reporting API for Strategic Procurement and Operational Procurement10
Create a new (custom) view templateanalyticalReportingPostViewTemplates | POST | Create a new (custom) view template. |
Find out how many records would be included in the results set for the view template and filters.analyticalReportingGetViewsCount | GET | Find out how many records would be included in the results set for the view template and filters (described only in the procedure sections, not in the endpoint table). |
Request a list of supported facts and dimensions, or a list of filter and selection fields by.analyticalReportingGetMetadata | GET | Request a list of supported facts and dimensions, or a list of filter and selection fields by fact/dimension, usable to create custom view templates. |
Request the status of the specified asynchronous analytical reporting jobanalyticalReportingGetJobs | GET | Request the status of the specified asynchronous analytical reporting job. |
Request ZIP files from the specified completed asynchronous analytical reporting job, one ZIP file.analyticalReportingGetJobsFiles | GET | Request ZIP files from the specified completed asynchronous analytical reporting job, one ZIP file at a time. |
Submit a job for asynchronous processing using a view template; retrieve output with the Job.analyticalReportingPostJobs | POST | Submit a job for asynchronous processing using a view template; retrieve output with the Job Results API. |
Synchronously request output satisfying the view template criteria; JSON results are returned one.analyticalReportingGetViews | GET | Synchronously request output satisfying the view template criteria; JSON results are returned one page at a time (up to 5,000 records per batch). |
Update the specified custom view template (system templates cannot be modified); pass status in the.analyticalReportingPostViewTemplatesPatch | POST | Update the specified custom view template (system templates cannot be modified); pass status in the body to change its status. |
View all view templates for a realm, optionally by document type and statusanalyticalReportingGetViewTemplates2 | GET | View all view templates for a realm, optionally by document type and status. |
View the details (fields and filters) of the specified view templateanalyticalReportingGetViewTemplates | GET | View the details (fields and filters) of the specified view template. |
Ariba Network Invoice Header Data Extraction1
Gets the header information of one or more invoices associated with the calling SAP Business.networkInvoiceGetInvoices | GET | Gets the header information of one or more invoices associated with the calling SAP Business Network ID based on filter criteria. |
Ariba Network Purchase Orders2
Provides order header data matching the buyer, the supplier, and the OrderIDnetworkPurchaseGetOrders | GET | Provides order header data matching the buyer, the supplier, and the OrderID. |
Provides order item data matching the buyer, the supplier, and the OrderIDnetworkPurchaseGetItems | GET | Provides order item data matching the buyer, the supplier, and the OrderID. |
Ariba Network Supplier Profile3
Gets a certificate file using the relative URL from certDataFilenetworkSupplierGetProfilesCertificates | GET | Gets a certificate file using the relative URL from certDataFile.certFileUrl in the profile response (shown only by example). |
Gets an attachment file using the relative URL from attachmentsnetworkSupplierGetProfilesAttachments | GET | Gets an attachment file using the relative URL from attachments.url in the profile response (path pattern inferred from the example relative URL; the guide writes GET {{runtime... |
Retrieve the supplier profile associated with the specified ANID (SAP Business Network registered.networkSupplierGetProfiles | GET | Retrieve the supplier profile associated with the specified ANID (SAP Business Network registered public suppliers). |
Asset Management3
Get requisitions consisting of asset line items that are in the In Progress state in the Asset.assetManagementGetRequisitions | GET | Get requisitions consisting of asset line items that are in the In Progress state in the Asset Workbench in the buying solution (moved there after asset managers finish approval). |
Get the total count of requisitions consisting of asset line itemsassetManagementGetRequisitionsCount | GET | Get the total count of requisitions consisting of asset line items. |
Update the Asset field for asset items on requisitions with unique asset values fetched from the.assetManagementPostRequisitionsBatchAssets | POST | Update the Asset field for asset items on requisitions with unique asset values fetched from the external system; requisitions with all asset items assigned move to the Completed tab and... |
Asynchronous Requests Management2
Downloads the error file generated for the specified job IDasynchronousRequestsGetJobsErrors | GET | Downloads the error file generated for the specified job ID. |
Queries the status of the asynchronous job request initiated by an API (such as the Contract Line.asynchronousRequestsGetJobs | GET | Queries the status of the asynchronous job request initiated by an API (such as the Contract Line Items Import API or Contract Workspace State Change API) for the specified job ID. |
Bill of Materials Import1
Accepts the CSV file that contains the BOM data in the form data element of this endpoint and.billMaterialsPostBoms | POST | Accepts the CSV file that contains the BOM data in the form data element of this endpoint and uploads the file to Ariba Sourcing. |
Catalog Connectivity Service1
FUNCTION=INITIALIZE: sends a request for an initial handshake as a backend call to guided buying.catalogConnectivityPostSecureOci | POST | FUNCTION=INITIALIZE: sends a request for an initial handshake as a backend call to guided buying through the connectivity service; returns a SessionId and SessionTransmissionId. |
Configuration Parameter Review2
View a single parameter and its informationconfigurationParameterGetParametersByParameterName | GET | View a single parameter and its information |
View all parameters and their informationconfigurationParameterGetParameters | GET | View all parameters and their information |
Content Lookup2
Fetches the status of lookups from the content management system (CMS) in your solution; checks.contentLookupGetLookup | GET | Fetches the status of lookups from the content management system (CMS) in your solution; checks whether a lookup file was activated or failed parsing or validation. |
Updates existing lookups in the content management system (CMS) in your solution by uploading a new.contentLookupPostLookup | POST | Updates existing lookups in the content management system (CMS) in your solution by uploading a new lookup file; does not create new lookups. |
Contract Compliance25
Adds line items to the specified contract request with line item details imported from the client.contractCompliancePostContractRequestsLineitems | POST | Adds line items to the specified contract request with line item details imported from the client application. |
Creates a contract request in the SAP Ariba solution with header details imported from the client.contractCompliancePostContractRequests | POST | Creates a contract request in the SAP Ariba solution with header details imported from the client application; set to composing status; responds with its ID. |
Deletes all the pricing terms of specified contract request line items from the relevant contract.contractComplianceDeleteContractRequestsLineitemsPricingTerms | DELETE | Deletes all the pricing terms of specified contract request line items from the relevant contract request. |
Deletes specified contract request line items from the relevant contract requestcontractComplianceDeleteContractRequestsLineitems | DELETE | Deletes specified contract request line items from the relevant contract request. |
Imports advanced pricing details of a specified contract request (overview text says it 'deletes.contractCompliancePostContractRequestsLineitemsAdvancedPricing | POST | Imports advanced pricing details of a specified contract request (overview text says it 'deletes them from the relevant contract request', apparently an error; procedure lists it among... |
Imports advanced pricing details of specified contract request line items and updates themcontractCompliancePutContractRequestsLineitemsAdvancedPricing | PUT | Imports advanced pricing details of specified contract request line items and updates them. |
Imports discounted pricing details of specified contract request line items and adds them to the.contractCompliancePostContractRequestsLineitemsDiscountedPricing | POST | Imports discounted pricing details of specified contract request line items and adds them to the relevant contract request line items. |
Imports discounted pricing details of specified contract request line items and updates themcontractCompliancePutContractRequestsLineitemsDiscountedPricing | PUT | Imports discounted pricing details of specified contract request line items and updates them. |
Imports formula pricing details of specified contract request line items and adds them to the.contractCompliancePostContractRequestsLineitemsFormulaPricing | POST | Imports formula pricing details of specified contract request line items and adds them to the relevant contract request line items. |
Imports formula pricing details of specified contract request line items and updates themcontractCompliancePutContractRequestsLineitemsFormulaPricing | PUT | Imports formula pricing details of specified contract request line items and updates them. |
Imports range pricing details of specified contract request line items and adds them to the.contractCompliancePostContractRequestsLineitemsRangePricing | POST | Imports range pricing details of specified contract request line items and adds them to the relevant contract request line items. |
Imports range pricing details of specified contract request line items and updates themcontractCompliancePutContractRequestsLineitemsRangePricing | PUT | Imports range pricing details of specified contract request line items and updates them. |
Imports term-based pricing details of specified contract request line items and adds them to the.contractCompliancePostContractRequestsLineitemsTermBasedPricing | POST | Imports term-based pricing details of specified contract request line items and adds them to the relevant contract request line items. |
Imports term-based pricing details of specified contract request line items and updates themcontractCompliancePutContractRequestsLineitemsTermBasedPricing | PUT | Imports term-based pricing details of specified contract request line items and updates them. |
Imports tiered pricing details of specified contract request line items and adds them to the.contractCompliancePostContractRequestsLineitemsTieredPricing | POST | Imports tiered pricing details of specified contract request line items and adds them to the relevant contract request line items. |
Imports tiered pricing details of specified contract request line items and updates themcontractCompliancePutContractRequestsLineitemsTieredPricing | PUT | Imports tiered pricing details of specified contract request line items and updates them. |
Retrieves header details of all contract requests that match the search criteriacontractComplianceGetContractRequests | GET | Retrieves header details of all contract requests that match the search criteria. |
Retrieves header details of all contracts that match the search criteria (returned along with the.contractComplianceGetContracts | GET | Retrieves header details of all contracts that match the search criteria (returned along with the associated contract request IDs). |
Retrieves header details of the specified contractcontractComplianceGetContractsByContractId | GET | Retrieves header details of the specified contract. |
Retrieves header details of the specified contract requestcontractComplianceGetContractRequestsByContractRequestId | GET | Retrieves header details of the specified contract request. |
Retrieves the line items of the specified contractcontractComplianceGetContractsLineItems | GET | Retrieves the line items of the specified contract. |
Retrieves the line items of the specified contract requestcontractComplianceGetContractRequestsLineItems | GET | Retrieves the line items of the specified contract request. |
Updates and validates contract accumulators based on the imported documentscontractCompliancePutAccumulationRequests | PUT | Updates and validates contract accumulators based on the imported documents. |
Updates the specified contract request with header details imported from the client application.contractCompliancePatchContractRequests | PATCH | Updates the specified contract request with header details imported from the client application; for a contract change creates a new version of the contract request; responds with its ID. |
Updates the specified line items with line item details imported from the client application.contractCompliancePatchContractRequestsLineitems | PATCH | Updates the specified line items with line item details imported from the client application; responds with the contract request ID. |
Contract Terms Management15
Creates a CLID in the specified contract workspacecontractTermsPostContractWorkspacesContractLineItemDocuments | POST | Creates a CLID in the specified contract workspace. |
Creates a contract term in the specified contract workspace and a contract request for compliance.contractTermsPostContractWorkspacesContractTerms | POST | Creates a contract term in the specified contract workspace and a contract request for compliance contracts in the specified buyer realm. |
Creates a contract workspace using the ContractWorkspace Model Object that contains Contract Header.contractTermsPostContractworkspaces | POST | Creates a contract workspace using the ContractWorkspace Model Object that contains Contract Header fields metadata. |
Deletes a contract workspace in SAP Ariba ContractscontractTermsDeleteContractWorkspaces | DELETE | Deletes a contract workspace in SAP Ariba Contracts. |
Downloads the CLID corresponding to the specified document ID and contract workspace IDcontractTermsGetContractWorkspacesContractLineItemDocumentsFiles | GET | Downloads the CLID corresponding to the specified document ID and contract workspace ID. |
Gets contract workspaces matching the provided criteriacontractTermsGetContractWorkspaces | GET | Gets contract workspaces matching the provided criteria. |
Imports line item data to the CLID of a contract workspace; also deletes or deactivates line items.contractTermsPostContractWorkspacesContractLineItemDocumentsFiles | POST | Imports line item data to the CLID of a contract workspace; also deletes or deactivates line items, and imports deactivated line items from an integrated ERP system. |
Modifies the attributes of an existing CLID in the specified contract workspacecontractTermsPatchContractWorkspacesContractLineItemDocuments | PATCH | Modifies the attributes of an existing CLID in the specified contract workspace. |
Publishes the contract line items document (CLID) associated with a procurement contract workspacecontractTermsPostContractWorkspacesContractLineItemDocumentsState | POST | Publishes the contract line items document (CLID) associated with a procurement contract workspace. |
Retrieves details including contract term ID, contract request ID, and contract ID for the.contractTermsGetContractWorkspacesContractTerms | GET | Retrieves details including contract term ID, contract request ID, and contract ID for the specified contract workspace ID. |
Retrieves the document and the metadata associated with the specified document ID and contract ID.contractTermsGetContractWorkspacesContractLineItemDocuments | GET | Retrieves the document and the metadata associated with the specified document ID and contract ID, including all versions of the CLID except Not Created. |
Returns the single contract workspace matching the provided contract workspace IDcontractTermsGetContractWorkspacesContractId | GET | Returns the single contract workspace matching the provided contract workspace ID. |
Synchronizes the contract line item information of a contract workspace with the linked compliance.contractTermsPostContractWorkspacesContractTermsState | POST | Synchronizes the contract line item information of a contract workspace with the linked compliance contract by specifying the IDs of the contract workspace and the contract terms... |
Updates an existing contract workspace by using the provided contract workspace fields for updating.contractTermsPatchContractworkspaces | PATCH | Updates an existing contract workspace by using the provided contract workspace fields for updating the contract. |
Updates the status of a published procurement contract workspace to DraftAmendment (action =.contractTermsPostContractWorkspacesState | POST | Updates the status of a published procurement contract workspace to DraftAmendment (action = amend); with action set to complete amendment triggers publishing for Administrative or... |
Contract Workspace Management APIs15
Changes the state of a procurement contract workspace with action amend, completeAmendment.contractWorkspaceManagementPostContractWorkspacesState | POST | Changes the state of a procurement contract workspace with action amend, completeAmendment, putOnHold, resume or close (amend moves a published workspace to DraftAmendment;... |
Creates a CLID in the specified contract workspace and returns the details of the CLID createdcontractWorkspaceManagementPostContractWorkspacesContractLineItemDocuments | POST | Creates a CLID in the specified contract workspace and returns the details of the CLID created. |
Creates a contract terms document in the specified contract workspace and a corresponding contract.contractWorkspaceManagementPostContractWorkspacesContractTerms | POST | Creates a contract terms document in the specified contract workspace and a corresponding contract request for compliance contracts in the specified buyer realm. |
Creates a contract workspace using the ContractWorkspace Model Object that contains Contract Header.contractWorkspaceManagementPostContractworkspaces | POST | Creates a contract workspace using the ContractWorkspace Model Object that contains Contract Header fields metadata, from a system template ID, by copying an existing contract... |
Deletes a procurement contract workspace in SAP Ariba Contracts that is in the Draft state and has.contractWorkspaceManagementDeleteContractWorkspaces | DELETE | Deletes a procurement contract workspace in SAP Ariba Contracts that is in the Draft state and has no started or completed tasks. |
Downloads the CLID corresponding to the specified document ID and contract workspace ID in the.contractWorkspaceManagementGetContractWorkspacesContractLineItemDocumentsFiles | GET | Downloads the CLID corresponding to the specified document ID and contract workspace ID in the standard Excel format. |
Gets contract workspaces matching the provided criteria, with select, filter, top, skip, count and.contractWorkspaceManagementGetContractWorkspaces | GET | Gets contract workspaces matching the provided criteria, with select, filter, top, skip, count and expand query options. |
Imports line item data from an Excel file to the CLID of a contract workspace (add, replace), and.contractWorkspaceManagementPostContractWorkspacesContractLineItemDocumentsFiles | POST | Imports line item data from an Excel file to the CLID of a contract workspace (add, replace), and deletes or deactivates line items or imports deactivated ERP line items (update). |
Modifies the attributes of an existing CLID in the specified contract workspace and returns the.contractWorkspaceManagementPatchContractWorkspacesContractLineItemDocuments | PATCH | Modifies the attributes of an existing CLID in the specified contract workspace and returns the details of the updated CLID. |
Publishes the contract line items document (CLID) associated with a procurement contract workspace.contractWorkspaceManagementPostContractWorkspacesContractLineItemDocumentsState | POST | Publishes the contract line items document (CLID) associated with a procurement contract workspace; returns a jobId. |
Retrieves details including contract term ID, contract request ID, and contract ID for the.contractWorkspaceManagementGetContractWorkspacesContractTerms | GET | Retrieves details including contract term ID, contract request ID, and contract ID for the specified contract workspace ID. |
Retrieves the CLID and its metadata (standard and custom fields, task IDs and names, line item.contractWorkspaceManagementGetContractWorkspacesContractLineItemDocuments | GET | Retrieves the CLID and its metadata (standard and custom fields, task IDs and names, line item types including hierarchical and pricing-condition items, translations) and all versions... |
Returns the single contract workspace matching the provided contract workspace IDcontractWorkspaceManagementGetContractWorkspacesByContractId | GET | Returns the single contract workspace matching the provided contract workspace ID. |
Synchronizes the contract line item information of a contract workspace with the linked compliance.contractWorkspaceManagementPostContractWorkspacesContractTermsState | POST | Synchronizes the contract line item information of a contract workspace with the linked compliance contract; initiates an asynchronous job and returns the job ID. |
Updates an existing contract workspace by using the provided contract workspace fields (OOTB and.contractWorkspaceManagementPatchContractworkspaces | PATCH | Updates an existing contract workspace by using the provided contract workspace fields (OOTB and custom header fields as applicable to the amendment type). |
Contract Workspace Retrieval2
Gets contract workspaces matching the provided criteria (search with select, filter, top, skip.contractWorkspaceRetrievalGetContractWorkspaces | GET | Gets contract workspaces matching the provided criteria (search with select, filter, top, skip, count and expand). |
Returns the single contract workspace matching the provided contract workspace IDcontractWorkspaceRetrievalGetContractWorkspacesByContractId | GET | Returns the single contract workspace matching the provided contract workspace ID. |
Cost Breakdown Data Extraction2
Returns the cost components and the associated cost group terms from the specified documentcostBreakdownGetCostgroupDocuments | GET | Returns the cost components and the associated cost group terms from the specified document. |
Returns the list of cost group document IDs for line items for which awards or PIRs are created.costBreakdownGetRfxCostgroups | GET | Returns the list of cost group document IDs for line items for which awards or PIRs are created during a specified date range. |
Create Procurement Workspace1
Creates a new procurement workspace project in guided buying (an empty project, the same as one.createProcurementPostProcurementWorkspaces | POST | Creates a new procurement workspace project in guided buying (an empty project, the same as one created in the guided buying user interface). |
Data Replication Status for Multi-ERP Configurations2
Queries the status of all replications in a site (realm in query), or of a specific set of.dataReplicationGetStatuses | GET | Queries the status of all replications in a site (realm in query), or of a specific set of replications when a query filter is added. |
Retrieves a list of all the subscriptions (data objects configured for replication) by sitedataReplicationGetSubscriptions | GET | Retrieves a list of all the subscriptions (data objects configured for replication) by site. |
Discovery RFx Publication FROM External Marketplace2
Create an SAP Business Network Discovery user that will represent your company (the marketplace.discoveryRFxPublicationFROMPostBuyer | POST | Create an SAP Business Network Discovery user that will represent your company (the marketplace buyer). |
Optionally check the status of events created from quote request cXML; this endpoint belongs to the.discoveryRFxPublicationFROMGetEvents | GET | Optionally check the status of events created from quote request cXML; this endpoint belongs to the Discovery RFx Publication TO External Marketplace API (its Swagger is on that API's... |
Discovery RFx Publication TO External Marketplace5
Download attachment data associated with the specified RFx (GetRfxAttachment); the attachment CID.discoveryRFxPublicationTOGetSiteEventsAttachment | GET | Download attachment data associated with the specified RFx (GetRfxAttachment); the attachment CID comes from the events response. |
Endpoint table: check the status of the eventdiscoveryRFxPublicationTOGetSiteEvents | GET | Endpoint table: check the status of the event. |
Endpoint table: retrieve the RFx event from the site-specific queuediscoveryRFxPublicationTOGetEvents | GET | Endpoint table: retrieve the RFx event from the site-specific queue. |
For use when bidding will not take place within SAP Ariba Sourcing; identifies the bidding site URI.discoveryRFxPublicationTOPutSiteEvents | PUT | For use when bidding will not take place within SAP Ariba Sourcing; identifies the bidding site URI (UpdateRfxEvent). |
For use when bidding will take place within SAP Ariba Sourcing; removes the message about the event.discoveryRFxPublicationTOPostSiteEventsAcknowledge | POST | For use when bidding will take place within SAP Ariba Sourcing; removes the message about the event from the queue (Acknowledge API). |
Document Approval8
Change the state of the specified approvable and/or add a commentdocumentApprovalPatch | PATCH | Change the state of the specified approvable and/or add a comment. |
Provide details of the specified approvabledocumentApprovalGetByApprovableTypeApprovableId | GET | Provide details of the specified approvable. |
Return a list of all approvables pending approval; use $filter to filter by approvable type or userdocumentApprovalGetPendingApprovables | GET | Return a list of all approvables pending approval; use $filter to filter by approvable type or user. |
Return a list of all groups, or with $filter the group matching uniqueName; used to get a group's.documentApprovalGetGroups | GET | Return a list of all groups, or with $filter the group matching uniqueName; used to get a group's groupId. |
Return a list of all pending approvables of the specified approvable type, or with $filter the.documentApprovalGet | GET | Return a list of all pending approvables of the specified approvable type, or with $filter the approvable matching the uniqueName. |
Return the list of all approvables whose state has changed (including delegation and reassignment.documentApprovalGetChanges | GET | Return the list of all approvables whose state has changed (including delegation and reassignment events if tracked); with $filter on changeSequenceId, return those changed since the last... |
Return the list of users with membership in the specified groupdocumentApprovalGetGroupsMembers | GET | Return the list of users with membership in the specified group. |
Return the specified attachmentdocumentApprovalGetAttachments | GET | Return the specified attachment. |
Dynamic Lookup Table2
Retrieves the status of a dynamic lookup table upload based on the job ID you received in response.dynamicLookupGetJobs | GET | Retrieves the status of a dynamic lookup table upload based on the job ID you received in response to the POST request. |
Uploads dynamic lookup tables as Excel files and returns a job ID that you can use for checking the.dynamicLookupPostJobs | POST | Uploads dynamic lookup tables as Excel files and returns a job ID that you can use for checking the status. |
Engagement Risk Assessment External Response Import2
For a given assessment name, retrieve the set of suppliers for which the assessment is in status.engagementRiskGetAssessments | GET | For a given assessment name, retrieve the set of suppliers for which the assessment is in status Waiting for Response and ready for responses to be imported. |
Post a JSON request that imports a supplier's responses to the questions in the assessment from the.engagementRiskPostQuestionnaireResponses | POST | Post a JSON request that imports a supplier's responses to the questions in the assessment from the external system (Control type Vendor). |
ETendering Notice Management3
Retrieve notice details of the specified notice ID; the notice details are in XML format and.eTenderingNoticeGetV1PublicprocurementNotices | GET | Retrieve notice details of the specified notice ID; the notice details are in XML format and encrypted (workflow says Base64 encoded). |
Retrieve the list of notices which are in PendingPublish stateeTenderingNoticeGetPublicprocurementNoticesPages | GET | Retrieve the list of notices which are in PendingPublish state. |
Send the portal submission status of the specified notice ID to SAP Ariba SourcingeTenderingNoticePostPublicprocurementNoticesState | POST | Send the portal submission status of the specified notice ID to SAP Ariba Sourcing. |
Event Management67
Add (invite) a supplier user in an event for a specific item (for example to add back a previously.eventManagementPostEventsItemsSupplierInvitationsByEventIdItemId | POST | Add (invite) a supplier user in an event for a specific item (for example to add back a previously uninvited supplier). |
Add (invite) suppliers to an eventeventManagementPostEventsSupplierInvitations | POST | Add (invite) suppliers to an event. |
Add items to an event (lots, line items, questions, prerequisites, requirements); also used for.eventManagementPostEventsItems | POST | Add items to an event (lots, line items, questions, prerequisites, requirements); also used for multi-currency events and to create restricted questions in guided sourcing events. |
Add multiple suppliers to multiple items in an eventeventManagementPostEventsItemsSupplierInvitations | POST | Add multiple suppliers to multiple items in an event. |
Create a manual award scenario that specifies the items and suppliers to awardeventManagementPostEventsScenarios | POST | Create a manual award scenario that specifies the items and suppliers to award. |
Create a new bidding round in an event (guided sourcing with multi-round bidding enabled); publish.eventManagementPostEventsRounds | POST | Create a new bidding round in an event (guided sourcing with multi-round bidding enabled); publish it with the EVENT PUBLISH ROUND job. |
Create an event (createEvent body) from an event template, optionally with header values, content.eventManagementPostEvents | POST | Create an event (createEvent body) from an event template, optionally with header values, content items and suppliers; also used to create multi-currency events, restricted questions in... |
Delete (uninvite) suppliers from an eventeventManagementDeleteEventsSupplierInvitationsByEventIdInvitationId | DELETE | Delete (uninvite) suppliers from an event. |
Delete a scenarioeventManagementDeleteEventsScenarios | DELETE | Delete a scenario. |
Delete a specific item in an eventeventManagementDeleteEventsItems | DELETE | Delete a specific item in an event. |
Delete an attachment that is a value for a requirementeventManagementDeleteEventsItemsAttachmentsByEventIdItemIdAttachmentId | DELETE | Delete an attachment that is a value for a requirement. |
Delete attachments for a specified item and term in an eventeventManagementDeleteEventsItemsAttachments | DELETE | Delete attachments for a specified item and term in an event. |
Delete items in an event (also deletes restricted questions from guided sourcing events)eventManagementDeleteEventsItemsByEventId | DELETE | Delete items in an event (also deletes restricted questions from guided sourcing events). |
Download an attachment added by a buyer user (reference document for a term or requirement value)eventManagementGetItemsAttachmentsContent | GET | Download an attachment added by a buyer user (reference document for a term or requirement value). |
Download an attachment submitted as a response by a supplier (a term with valueTypeName.eventManagementGetSupplierBidsAttachmentsContent | GET | Download an attachment submitted as a response by a supplier (a term with valueTypeName Attachment); with alternativeId, fetch attachments of earlier bid revisions one at a time. |
Download attachments from a specific message in an eventeventManagementGetMessagesAttachmentsContent | GET | Download attachments from a specific message in an event. |
Get a count of the supplier (participant) bids or responses for the event (participants who intend.eventManagementGetEventsBidSummary | GET | Get a count of the supplier (participant) bids or responses for the event (participants who intend to bid, declined to bid, and have bid). |
Get a list of all terms (and formulas) available for all items in an event, already defined and.eventManagementGetEventsTerms | GET | Get a list of all terms (and formulas) available for all items in an event, already defined and addable to items. |
Get a list of all terms for a specific item in an event; with unassignedTerms=true, get the terms.eventManagementGetEventsItemsTerms | GET | Get a list of all terms for a specific item in an event; with unassignedTerms=true, get the terms defined for the item that can be added (not already assigned a value). |
Get a list of events and event IDs based on query filters (internalId, or.eventManagementGetEvents | GET | Get a list of events and event IDs based on query filters (internalId, or externalSystemCorrelationId which is the SAP RFP ID / cXML QuoteRequest RequestID sent by the external system);... |
Get all actions available for each resource (events, scenarios and supplier invitations) and data.eventManagementGetMetadataJobs | GET | Get all actions available for each resource (events, scenarios and supplier invitations) and data models for request bodies (written GET /metatdata/jobs on page 230). |
Get all bids (responses) for the event submitted by the specified supplier; with bidHistory=True.eventManagementGetEventsSupplierBidsByEventIdInvitationId | GET | Get all bids (responses) for the event submitted by the specified supplier; with bidHistory=True all bid revisions; source of alternativeId. |
Get all supplier bids (responses) for the event; by default bids in accepted status, with.eventManagementGetEventsSupplierBids | GET | Get all supplier bids (responses) for the event; by default bids in accepted status, with bidHistory=True all bid revisions. |
Get details about a specific supplier invited for a specific item in an eventeventManagementGetEventsItemsSupplierInvitationsByEventIdItemIdInvitationId | GET | Get details about a specific supplier invited for a specific item in an event. |
Get details about the specified supplier invitation, including information about the supplier user.eventManagementGetEventsSupplierInvitationsByEventIdInvitationId | GET | Get details about the specified supplier invitation, including information about the supplier user and organization such as address and contact information. |
Get information about a scenarioeventManagementGetEventsScenariosByEventIdScenarioId | GET | Get information about a scenario. |
Get information about a specific item in an event (also returns restricted questions in guided.eventManagementGetEventsItems | GET | Get information about a specific item in an event (also returns restricted questions in guided sourcing events). |
Get information about all award scenarios for the event; the response includes an availableActions.eventManagementGetEventsScenarios | GET | Get information about all award scenarios for the event; the response includes an availableActions array with the actions the user in the user query parameter can perform. |
Get information about all items in an event (also items in multi-currency events and restricted.eventManagementGetEventsItemsByEventId | GET | Get information about all items in an event (also items in multi-currency events and restricted questions); recommended instead of $expand=all or items for events with many items, with... |
Get information about all suppliers (supplier invitations) invited for a specific item; an empty.eventManagementGetEventsItemsSupplierInvitations | GET | Get information about all suppliers (supplier invitations) invited for a specific item; an empty response indicates that all suppliers invited to the event are invited for the item. |
Get information about the specified event, including state, header information and contents; also.eventManagementGetEventsByEventId | GET | Get information about the specified event, including state, header information and contents; also used to retrieve a specific multi-currency event and the structure of custom header fields. |
Get invitation IDs and detailed supplier information (such as contact information) for all.eventManagementGetEventsSupplierInvitations | GET | Get invitation IDs and detailed supplier information (such as contact information) for all suppliers invited to the event; with $select returns bid status and last submission date per... |
Get supplier bids for the specific supplier in an event based on the pagination details specifiedeventManagementGetEventsSupplierBidsPagesByEventIdInvitationIdPageNumber | GET | Get supplier bids for the specific supplier in an event based on the pagination details specified. |
Get the award data for the eventeventManagementGetEventsAwards | GET | Get the award data for the event. |
Get the award data for the event (specific award)eventManagementGetEventsAwardsByEventIdAwardId | GET | Get the award data for the event (specific award). |
Get the list of event IDs (internalId), event template IDs and parent project IDs of events.eventManagementGetEventsIdentifiers | GET | Get the list of event IDs (internalId), event template IDs and parent project IDs of events created, modified, or both created and modified within a time period given in $filter as Unix... |
Get the supplier bids for the specified event based on the pagination details specifiedeventManagementGetEventsSupplierBidsPages | GET | Get the supplier bids for the specified event based on the pagination details specified. |
Get values and definitions for one or more quick sourcing (single-event) project templateseventManagementGetEventsTemplates | GET | Get values and definitions for one or more quick sourcing (single-event) project templates. |
Perform a validation on the data being submitted for event publisheventManagementPostEventsState | POST | Perform a validation on the data being submitted for event publish. |
Remove (uninvite) a supplier for a specific item in an eventeventManagementDeleteEventsItemsSupplierInvitationsByEventIdItemIdInvitationId | DELETE | Remove (uninvite) a supplier for a specific item in an event. |
Remove (uninvite) suppliers for a specific item in an eventeventManagementDeleteEventsItemsSupplierInvitations | DELETE | Remove (uninvite) suppliers for a specific item in an event. |
Remove (uninvite) suppliers from the eventeventManagementDeleteEventsSupplierInvitations | DELETE | Remove (uninvite) suppliers from the event. |
Remove all current suppliers in the event and add the suppliers specified in the request bodyeventManagementPutEventsSupplierInvitations | PUT | Remove all current suppliers in the event and add the suppliers specified in the request body. |
Retrieve all supplier bids for a specified bidding round in an eventeventManagementGetEventsRoundsSupplierBids | GET | Retrieve all supplier bids for a specified bidding round in an event. |
Retrieve all terms and formulas that are already defined for an item in a bidding round in an eventeventManagementGetRoundsItemsTerms | GET | Retrieve all terms and formulas that are already defined for an item in a bidding round in an event. |
Retrieve attachment details associated with a specific message in an eventeventManagementGetEventsMessagesAttachments | GET | Retrieve attachment details associated with a specific message in an event. |
Retrieve details of a specific bidding round in an event (shown here as a procedure step; main.eventManagementGetEventsRoundsByEventIdRoundNumber | GET | Retrieve details of a specific bidding round in an event (shown here as a procedure step; main section is on page 186). |
Retrieve details of a specific item of a specific bidding round in an eventeventManagementGetEventsRoundsItemsByEventIdRoundNumberItemId | GET | Retrieve details of a specific item of a specific bidding round in an event. |
Retrieve details of bidding rounds in an event (shown here as a procedure step; main section is on.eventManagementGetEventsRounds | GET | Retrieve details of bidding rounds in an event (shown here as a procedure step; main section is on page 186). |
Retrieve details of event rules, including current values, valid values and the fieldNameeventManagementGetEventsRules | GET | Retrieve details of event rules, including current values, valid values and the fieldName. |
Retrieve event history or audit logs for an event present in the Log tab, including bid history.eventManagementGetEventsAuditLogs | GET | Retrieve event history or audit logs for an event present in the Log tab, including bid history information. |
Retrieve event messages from the Messages tabeventManagementGetEventsMessages | GET | Retrieve event messages from the Messages tab. |
Retrieve information about a specific rule in an eventeventManagementGetEventsRulesByEventIdRuleName | GET | Retrieve information about a specific rule in an event. |
Retrieve item details for a bidding round; referenced in this part only as the source of itemId.eventManagementGetEventsRoundsItems | GET | Retrieve item details for a bidding round; referenced in this part only as the source of itemId values (detailed on guide page 197). |
Retrieve items (including restricted questions) in the specified event based on the pagination.eventManagementGetEventsItemsPages | GET | Retrieve items (including restricted questions) in the specified event based on the pagination details requested. |
Retrieve participant grades in the specified eventeventManagementGetEventsGrades | GET | Retrieve participant grades in the specified event. |
Retrieve supplier bid information for a specific supplier user for a specified bidding round in an.eventManagementGetEventsRoundsSupplierBidsByEventIdRoundNumberInvitationId | GET | Retrieve supplier bid information for a specific supplier user for a specified bidding round in an event. |
Retrieve supplier invitation details for a bidding round; referenced in this part only as the.eventManagementGetEventsRoundsSupplierInvitations | GET | Retrieve supplier invitation details for a bidding round; referenced in this part only as the source of supplierInvitationId values (detailed on guide page 208). |
Retrieve supplier invitation details for a specific supplier user for a bidding round in an eventeventManagementGetEventsRoundsSupplierInvitationsByEventIdRoundNumberInvitationId | GET | Retrieve supplier invitation details for a specific supplier user for a bidding round in an event. |
Submits an asynchronous job; the request body names the resource type and actioneventManagementPostJobs | POST | Submits an asynchronous job; the request body names the resource type and action. |
Update (edit) items in an event; also used to edit items in multi-currency eventseventManagementPutEventsItems | PUT | Update (edit) items in an event; also used to edit items in multi-currency events. |
Update a scenario (for example a copy created with the SCENARIO COPY job)eventManagementPutEventsScenarios | PUT | Update a scenario (for example a copy created with the SCENARIO COPY job). |
Update an event; the event specification can include a sourcingProjectCustomFields array to set.eventManagementPutEvents | PUT | Update an event; the event specification can include a sourcingProjectCustomFields array to set custom field values (custom field portion only in this range). |
Update information in the specified supplier invitation: replace a contact with another contact.eventManagementPutEventsSupplierInvitationsByEventIdInvitationId | PUT | Update information in the specified supplier invitation: replace a contact with another contact configured in SAP Ariba Supplier Management for the same supplier organization, or change... |
Update rule values for one or more event rules (for example estimated award date, rule choice.eventManagementPutEventsRules | PUT | Update rule values for one or more event rules (for example estimated award date, rule choice, bidding rules). |
Update the last unpublished bidding round in an event (suppliers and items)eventManagementPutEventsRounds | PUT | Update the last unpublished bidding round in an event (suppliers and items). |
Upload a file as an attachment for the specified item and term in an event, as a reference document.eventManagementPostEventsItemsAttachments | POST | Upload a file as an attachment for the specified item and term in an event, as a reference document for a line item term or as a requirement value. |
External Approval API for Sourcing and Supplier Management9
Determines the user IDs of group members by group ID (described as the GET /groups/{group_id}.externalApprovalGetGroupsMembers | GET | Determines the user IDs of group members by group ID (described as the GET /groups/{group id} endpoint). |
Determines the user IDs of group members by group name (described as the GET.externalApprovalGetUsergroupsMembers | GET | Determines the user IDs of group members by group name (described as the GET /usergroups/{group name} endpoint). |
Downloads an attachmentexternalApprovalGetDocumentAttachments | GET | Downloads an attachment. |
Optionally downloads an attachment associated with the document (workflow step 5)externalApprovalGetAttachments | GET | Optionally downloads an attachment associated with the document (workflow step 5). |
Posts the action to be taken for the approval task on behalf of the user in the approval flow.externalApprovalPostAction | POST | Posts the action to be taken for the approval task on behalf of the user in the approval flow: approve, deny, and include comments. |
Retrieves details about the specified approvable document, event or project; if supplier-inviter.externalApprovalGet | GET | Retrieves details about the specified approvable document, event or project; if supplier-inviter mapping is available, retrieves that information too. |
Retrieves details about the specified external approval task (written both /task/{entity_id} and.externalApprovalGetTask | GET | Retrieves details about the specified external approval task (written both /task/{entity id} and /Task/{entity id}). |
Returns a list of external approval tasks that are active and pending approval, optionally filtered.externalApprovalGetPendingApprovables | GET | Returns a list of external approval tasks that are active and pending approval, optionally filtered by user ID or document type. |
Returns a list of external approval tasks that have changed state (for example submitted, or.externalApprovalGetChanges | GET | Returns a list of external approval tasks that have changed state (for example submitted, or approval flow completed). |
Finding and Event Collaboration Integration API for Supplier Risk3
Posts a JSON request that returns the internal users assigned to the specified finding roles for.findingEventPostUserDataRequests | POST | Posts a JSON request that returns the internal users assigned to the specified finding roles for the specified combinations of commodities, regions, and departments. |
Posts a JSON request that specifies supplier contacts to invite to a findingfindingEventPostInvites | POST | Posts a JSON request that specifies supplier contacts to invite to a finding. |
Updates fields in the specified finding (status, creation and due date, residual risk information)findingEventPutFindings | PUT | Updates fields in the specified finding (status, creation and due date, residual risk information). |
Flow Extension8
Acknowledge receipt of an Event retrieved using the Get Next Event API, preventing the service from.flowExtensionPostFlowextensionsEventsAcknowledge | POST | Acknowledge receipt of an Event retrieved using the Get Next Event API, preventing the service from returning the same events again; later calls for these events do not function until... |
Complete the flow extension and allow the document to continue with its normal processing flow.flowExtensionPostFlowextensionsEventsResume | POST | Complete the flow extension and allow the document to continue with its normal processing flow (simple and halt flow extension use cases). |
Complete the flow extension and reject the document by returning it to the sender in 'FAILED'.flowExtensionPostFlowextensionsEventsHalt | POST | Complete the flow extension and reject the document by returning it to the sender in 'FAILED' status (halt flow extension use case). |
For flow extensions in the non-suspend use case, indicate completion of the flow extension.flowExtensionPostFlowextensionsEventsComplete | POST | For flow extensions in the non-suspend use case, indicate completion of the flow extension processing for the event. |
Post a comment or attachments to a document event (enrich the intercepted document); not supported.flowExtensionPostFlowextensionsEvents | POST | Post a comment or attachments to a document event (enrich the intercepted document); not supported in the non-suspend use case; maximum attachment size is 20 mb. |
Retrieve document attachment data based on the document contentid (cid) for a specific event; with.flowExtensionGetEventsEventdataAttachment | GET | Retrieve document attachment data based on the document contentid (cid) for a specific event; with cid returns a single attachment, without cid and Accept multipart/mixed returns all... |
Retrieve relevant document data from SAP Business Network for a specific event that the external.flowExtensionGetFlowextensionsEventsEventdata | GET | Retrieve relevant document data from SAP Business Network for a specific event that the external party has received a notification for; output structure is defined by the Outbound... |
Retrieve the most recent events from the Extension QueueflowExtensionGetFlowextensionsEvents | GET | Retrieve the most recent events from the Extension Queue. |
Guided Buying Functional Documents2
(Optional) gets the details of an externally managed form from guided buying, for example to.guidedBuyingGetExternalDocuments | GET | (Optional) gets the details of an externally managed form from guided buying, for example to refresh client data. |
Updates the status of an externally managed form in guided buying; may be called multiple times as.guidedBuyingPatchExternalDocuments | PATCH | Updates the status of an externally managed form in guided buying; may be called multiple times as the form status changes. |
Integration Event Monitoring Query API for Procurement1
Retrieves a list of all available integration events for a particular product type; the tenantID.integrationEventGetProductsEvents | GET | Retrieves a list of all available integration events for a particular product type; the tenantID and time period are passed as filter parameters. |
Integration Monitoring API for Procurement1
Returns the current running status of the specified integration event (data import or export task).integrationMonitoringProcurementGetEventsStatuses | GET | Returns the current running status of the specified integration event (data import or export task), or the last run status if not running; with histcount the status history; with uid the... |
Integration Monitoring API for Strategic Sourcing1
Return the current running status of the specified integration event (data import or export task).integrationMonitoringStrategicGetEventsStatus | GET | Return the current running status of the specified integration event (data import or export task), or the last run status if not running; with histcount the status history; with uid the... |
Internal Catalogs Shop3
Initiates the typeahead search feature and retrieves the list of matching search suggestionsinternalCatalogsGetShopsShopIDAutoComplete | GET | Initiates the typeahead search feature and retrieves the list of matching search suggestions. |
Retrieves the list of all the items and facets from the catalogs in SAP Ariba Catalog; the sample.internalCatalogsGetShopsShopID | GET | Retrieves the list of all the items and facets from the catalogs in SAP Ariba Catalog; the sample requests all items matching the search term and the related facets. |
Returns the list of all the items and their details from the catalogs in SAP Ariba CataloginternalCatalogsGetShopsShopIDItems | GET | Returns the list of all the items and their details from the catalogs in SAP Ariba Catalog. |
Item Volume Import1
Adds material volume data to the product sourcing databaseitemVolumePostV1Itemvolumes | POST | Adds material volume data to the product sourcing database. |
Master Data Retrieval API for Procurement4
Retrieves a list of all available master data entities in a site (including custom flex master data.masterDataRetrievalProcurementGetEntityTypes | GET | Retrieves a list of all available master data entities in a site (including custom flex master data entities); locale and realm are passed as header parameters. |
Retrieves details (records) related to the specified master data entity using OData query optionsmasterDataRetrievalProcurementGetEntities | GET | Retrieves details (records) related to the specified master data entity using OData query options. |
Retrieves the metadata of the specified master data entity as a JSON schema, including custom or.masterDataRetrievalProcurementGetEntityTypesByEntityName | GET | Retrieves the metadata of the specified master data entity as a JSON schema, including custom or flex fields. |
Retrieves the number of records corresponding to the specified master data entitymasterDataRetrievalProcurementGetEntitiesCount | GET | Retrieves the number of records corresponding to the specified master data entity. |
Master Data Retrieval API for Sourcing4
Retrieves a list of all available master data entities in a site; locale and realm are passed as.masterDataRetrievalSourcingGetEntityTypes | GET | Retrieves a list of all available master data entities in a site; locale and realm are passed as header parameters. |
Retrieves details related to the specified master data entity, filtered with OData query optionsmasterDataRetrievalSourcingGetEntities | GET | Retrieves details related to the specified master data entity, filtered with OData query options. |
Retrieves the metadata of the specified master data entity; returns a JSON schema representing the.masterDataRetrievalSourcingGetEntityTypesByEntityName | GET | Retrieves the metadata of the specified master data entity; returns a JSON schema representing the metadata of the entity, including custom or flex fields. |
Retrieves the number of records corresponding to the specified master data entitymasterDataRetrievalSourcingGetEntitiesCount | GET | Retrieves the number of records corresponding to the specified master data entity. |
Materials and BOM Tag Management3
Adds tags to the specified materials or BOMsmaterialsBOMPostTags | POST | Adds tags to the specified materials or BOMs. |
Deletes tags associated with the specified materials or BOMsmaterialsBOMDeleteTags | DELETE | Deletes tags associated with the specified materials or BOMs. |
Returns a list of tags associated with the specified materials or BOMsmaterialsBOMGetTags | GET | Returns a list of tags associated with the specified materials or BOMs. |
NDA Data Export8
Creates a view template containing filter criteria for a specified document typendaDataPostNdasViewTemplates | POST | Creates a view template containing filter criteria for a specified document type. |
Deletes the specified view templatendaDataDeleteNdasViewTemplates | DELETE | Deletes the specified view template. |
Downloads the exported data of a specific document typendaDataGetNdasFiles | GET | Downloads the exported data of a specific document type. |
Exports the filtered data of a specific document typendaDataGetNdasPages | GET | Exports the filtered data of a specific document type. |
Fetches the details of all the available view templatesndaDataGetNdasViewTemplates2 | GET | Fetches the details of all the available view templates. |
Fetches the details of the specified view templatendaDataGetNdasViewTemplates | GET | Fetches the details of the specified view template. |
Retrieves the metadata of the specified document typendaDataGetNdasMetadata | GET | Retrieves the metadata of the specified document type. |
Updates the content of the specified view templatendaDataPutNdasViewTemplates | PUT | Updates the content of the specified view template. |
Network Catalog Management5
Adds a new product to your network catalog, staged (UNPUBLISHED, default) or published online.networkCatalogPostProducts | POST | Adds a new product to your network catalog, staged (UNPUBLISHED, default) or published online (PUBLISHED with at least one price). |
Deletes a product from your network catalog; returns 204 No Content on successnetworkCatalogDeleteProducts | DELETE | Deletes a product from your network catalog; returns 204 No Content on success. |
Edits details about a product (including publishing a staged product by setting publishedStatus to.networkCatalogPatchProducts | PATCH | Edits details about a product (including publishing a staged product by setting publishedStatus to PUBLISHED). |
Retrieves a product list and information on each product using the OData protocol, with filter.networkCatalogGetProducts | GET | Retrieves a product list and information on each product using the OData protocol, with filter, sort, search and pagination. |
Retrieves information on a single productnetworkCatalogGetProductsByProductId | GET | Retrieves information on a single product. |
Operational Reporting API for Procurement12
Create a new view template; name the custom view template in the URL and provide field and filter.operationalReportingProcurementPostViewTemplates | POST | Create a new view template; name the custom view template in the URL and provide field and filter data in the request body. |
Find out how many records will be included in the results set for a query using the specified view.operationalReportingProcurementGetViewsCount | GET | Find out how many records will be included in the results set for a query using the specified view template and filters. |
For documents retrieved before the uniqueAttachmentId field was implemented; requests a single.operationalReportingProcurementGetAttachments | GET | For documents retrieved before the uniqueAttachmentId field was implemented; requests a single attachment based on its query type, approvable ID and attachment ID. |
Request a list of all supported document types or a list of all filter and selection fields, for a.operationalReportingProcurementGetMetadata | GET | Request a list of all supported document types or a list of all filter and selection fields, for a single document type or for all document types, usable to create custom view templates. |
Request the status of the specified asynchronous operational reporting job; when completed, returns.operationalReportingProcurementGetJobs | GET | Request the status of the specified asynchronous operational reporting job; when completed, returns file IDs and paging fields. |
Request ZIP files from the specified completed asynchronous operational reporting job, one ZIP file.operationalReportingProcurementGetJobsFiles | GET | Request ZIP files from the specified completed asynchronous operational reporting job, one ZIP file at a time. |
Retrieves a single attachment, based on its unique attachment ID from the Attachments section of.operationalReportingProcurementGetAttachment | GET | Retrieves a single attachment, based on its unique attachment ID from the Attachments section of reporting results. |
Submit a job for asynchronous processing using a view template; retrieve output with the Job.operationalReportingProcurementPostJobs | POST | Submit a job for asynchronous processing using a view template; retrieve output with the Job Results API. |
Synchronously request output that satisfies the criteria in the specified view template; output is.operationalReportingProcurementGetViews | GET | Synchronously request output that satisfies the criteria in the specified view template; output is batched and paginated and JSON results are returned one page at a time. |
Update the specified custom view template; provide field and filter modifications (or status, for.operationalReportingProcurementPostViewTemplatesPatch | POST | Update the specified custom view template; provide field and filter modifications (or status, for example deactivated) in the request body. |
View all view templates for a realm; list names and details of reporting views for a particular.operationalReportingProcurementGetViewTemplates2 | GET | View all view templates for a realm; list names and details of reporting views for a particular document type. |
View the details of the specified view template (system or custom)operationalReportingProcurementGetViewTemplates | GET | View the details of the specified view template (system or custom). |
Operational Reporting API for Strategic Sourcing10
Create a new (custom) view templateoperationalReportingStrategicPostViewTemplates | POST | Create a new (custom) view template. |
Find out how many records would be included in the results set for the view template and filters.operationalReportingStrategicGetViewsCount | GET | Find out how many records would be included in the results set for the view template and filters (described only in the procedure sections, not in the endpoint table). |
Request a list of all supported document types or of all filter and selection fields, for one or.operationalReportingStrategicGetMetadata | GET | Request a list of all supported document types or of all filter and selection fields, for one or all document types, usable to create custom view templates. |
Request the status of the specified asynchronous operational reporting joboperationalReportingStrategicGetJobs | GET | Request the status of the specified asynchronous operational reporting job. |
Request ZIP files from the specified completed asynchronous job, one ZIP file at a timeoperationalReportingStrategicGetJobsFiles | GET | Request ZIP files from the specified completed asynchronous job, one ZIP file at a time. |
Submit a job for asynchronous processing using a view template; retrieve output with the Job.operationalReportingStrategicPostJobs | POST | Submit a job for asynchronous processing using a view template; retrieve output with the Job Results API. |
Synchronously request output satisfying the view template criteria; JSON results are returned one.operationalReportingStrategicGetViews | GET | Synchronously request output satisfying the view template criteria; JSON results are returned one page at a time. |
Update the specified custom view template (system templates cannot be modified); pass status in the.operationalReportingStrategicPostViewTemplatesPatch | POST | Update the specified custom view template (system templates cannot be modified); pass status in the body to change its status. |
View all view templates for a realm, optionally for a document type and statusoperationalReportingStrategicGetViewTemplates2 | GET | View all view templates for a realm, optionally for a document type and status. |
View the details of the specified view templateoperationalReportingStrategicGetViewTemplates | GET | View the details of the specified view template. |
Order Change Requests API for Buyers5
Retrieves information from change requests sent to a specified supplierorderChangeRequestsBuyersGetChangeRequests | GET | Retrieves information from change requests sent to a specified supplier. |
Retrieves information from confirmations to change requests that were sent by a specified buyerorderChangeRequestsBuyersGetChangeRequestConfirmations | GET | Retrieves information from confirmations to change requests that were sent by a specified buyer. |
Retrieves information from responses to change requests that were sent by a specified supplierorderChangeRequestsBuyersGetChangeRequestResponses | GET | Retrieves information from responses to change requests that were sent by a specified supplier. |
Sends information from confirmations to change requests that were sent to a specified supplierorderChangeRequestsBuyersPostChangeRequestConfirmations | POST | Sends information from confirmations to change requests that were sent to a specified supplier. |
Sends information of change requests that were sent to a specified supplierorderChangeRequestsBuyersPostChangeRequests | POST | Sends information of change requests that were sent to a specified supplier. |
Order Change Requests API for Suppliers4
Retrieves information from change requests sent by a specified buyerorderChangeRequestsSuppliersGetChangeRequests | GET | Retrieves information from change requests sent by a specified buyer. |
Retrieves information from confirmations to change requests that were sent to a specified supplierorderChangeRequestsSuppliersGetChangeRequestConfirmations | GET | Retrieves information from confirmations to change requests that were sent to a specified supplier. |
Retrieves information from responses to change requests that were sent to a specified buyerorderChangeRequestsSuppliersGetChangeRequestResponses | GET | Retrieves information from responses to change requests that were sent to a specified buyer. |
Sends information from responses to change requests that were sent to a specified buyerorderChangeRequestsSuppliersPostChangeRequestResponses | POST | Sends information from responses to change requests that were sent to a specified buyer. |
Planning Collaboration Buyer3
Retrieves planning information such as supplier commitments, planned replenishment and projected.planningCollaborationBuyerGetSupplierManagedInventory | GET | Retrieves planning information such as supplier commitments, planned replenishment and projected stock at a location, expressed as key figure time series. |
Retrieves supplier forecast and commitment dataplanningCollaborationBuyerGetForecast | GET | Retrieves supplier forecast and commitment data. |
Retrieves total stock on hand data and a breakdown across the different stock types it contains.planningCollaborationBuyerGetSupplierInventory | GET | Retrieves total stock on hand data and a breakdown across the different stock types it contains (supplier inventory data export). |
Planning Collaboration Supplier3
Enables suppliers to make commitments to deliver quantities of goods to supply upcoming demands.planningCollaborationSupplierGetSupplierInventory | GET | Enables suppliers to make commitments to deliver quantities of goods to supply upcoming demands forecast by buyers; suppliers share their inventory data with buyers. |
Retrieves forecast data the buyer has shared and forecast commitment data the supplier has changedplanningCollaborationSupplierGetForecast | GET | Retrieves forecast data the buyer has shared and forecast commitment data the supplier has changed. |
Retrieves inventory data about supplier-managed goods that are in their customers' warehouses.planningCollaborationSupplierGetSupplierManagedInventory | GET | Retrieves inventory data about supplier-managed goods that are in their customers' warehouses, matched to buyer demand on each date. |
Pricing API for Product Sourcing Price Information2
Named only in the workflow (step 5) for retrieving item pricing changes for a time period.pricingProductGetObjectsItemPrice | GET | Named only in the workflow (step 5) for retrieving item pricing changes for a time period, specifying fromDate and toDate filter expressions; the accompanying examples actually call... |
Returns the changes and additions to the pricing database used for product sourcing within a.pricingProductGetObjects | GET | Returns the changes and additions to the pricing database used for product sourcing within a specified time range (active and inactive data). |
Procurement Transfer of Ownership3
Initiate the process of ownership transfer for a list of documentsprocurementTransferPostDocumentOwnershipTransfers | POST | Initiate the process of ownership transfer for a list of documents. |
Retrieve the documents eligible for transfer of ownership for a userprocurementTransferGetDocuments | GET | Retrieve the documents eligible for transfer of ownership for a user. |
Retrieve the status of a transfer requestprocurementTransferGetDocumentOwnershipTransfersStatus | GET | Retrieve the status of a transfer request. |
Product Hierarchy Management45
Add a new attachmentproductHierarchyPostAttachments | POST | Add a new attachment. |
Add a new product questionnaireproductHierarchyPostProductQuestionnaires | POST | Add a new product questionnaire. |
Add a new questionproductHierarchyPostQuestions | POST | Add a new question. |
Add a new requirementproductHierarchyPostRequirements | POST | Add a new requirement. |
Add a new ruleproductHierarchyPostRules | POST | Add a new rule. |
Add a new sectionproductHierarchyPostSections | POST | Add a new section. |
Add a new termproductHierarchyPostTerms | POST | Add a new term. |
Add a new visibility conditionproductHierarchyPostVisibilityConditions | POST | Add a new visibility condition. |
Delete a attachment by ID, optionally with associated or referencing objects (removeAssociation)productHierarchyDeleteAttachments | DELETE | Delete a attachment by ID, optionally with associated or referencing objects (removeAssociation). |
Delete a product questionnaire by ID, optionally with associated or referencing objects.productHierarchyDeleteProductQuestionnaires | DELETE | Delete a product questionnaire by ID, optionally with associated or referencing objects (removeAssociation). |
Delete a question by ID, optionally with associated or referencing objects (removeAssociation)productHierarchyDeleteQuestions | DELETE | Delete a question by ID, optionally with associated or referencing objects (removeAssociation). |
Delete a requirement by ID, optionally with associated or referencing objects (removeAssociation)productHierarchyDeleteRequirements | DELETE | Delete a requirement by ID, optionally with associated or referencing objects (removeAssociation). |
Delete a rule by ID, optionally with associated or referencing objects (removeAssociation)productHierarchyDeleteRules | DELETE | Delete a rule by ID, optionally with associated or referencing objects (removeAssociation). |
Delete a section by ID, optionally with associated or referencing objects (removeAssociation)productHierarchyDeleteSections | DELETE | Delete a section by ID, optionally with associated or referencing objects (removeAssociation). |
Delete a term by ID, optionally with associated or referencing objects (removeAssociation)productHierarchyDeleteTerms | DELETE | Delete a term by ID, optionally with associated or referencing objects (removeAssociation). |
Delete a visibility condition by ID, optionally with associated or referencing objects.productHierarchyDeleteVisibilityConditions | DELETE | Delete a visibility condition by ID, optionally with associated or referencing objects (removeAssociation). |
Download an attachment by IDproductHierarchyGetAttachmentsFiles | GET | Download an attachment by ID. |
Partially update a product questionnaire (update specific attributes without resending all data)productHierarchyPatchProductQuestionnaires | PATCH | Partially update a product questionnaire (update specific attributes without resending all data). |
Partially update a question (update specific attributes without resending all data)productHierarchyPatchQuestions | PATCH | Partially update a question (update specific attributes without resending all data). |
Partially update a requirement (update specific attributes without resending all data)productHierarchyPatchRequirements | PATCH | Partially update a requirement (update specific attributes without resending all data). |
Partially update a section (update specific attributes without resending all data)productHierarchyPatchSections | PATCH | Partially update a section (update specific attributes without resending all data). |
Partially update a term (update specific attributes without resending all data)productHierarchyPatchTerms | PATCH | Partially update a term (update specific attributes without resending all data). |
Retrieve a product questionnaire by IDproductHierarchyGetProductQuestionnaires | GET | Retrieve a product questionnaire by ID. |
Retrieve a question by IDproductHierarchyGetQuestions | GET | Retrieve a question by ID. |
Retrieve a requirement by IDproductHierarchyGetRequirements | GET | Retrieve a requirement by ID. |
Retrieve a rule by IDproductHierarchyGetRules | GET | Retrieve a rule by ID. |
Retrieve a section by IDproductHierarchyGetSections | GET | Retrieve a section by ID. |
Retrieve a term by IDproductHierarchyGetTerms | GET | Retrieve a term by ID. |
Retrieve a visibility condition by IDproductHierarchyGetVisibilityConditions | GET | Retrieve a visibility condition by ID. |
Retrieve all attachmentsproductHierarchyGetAttachments2 | GET | Retrieve all attachments. |
Retrieve all product questionnairesproductHierarchyGetProductQuestionnaires2 | GET | Retrieve all product questionnaires. |
Retrieve all questionsproductHierarchyGetQuestions2 | GET | Retrieve all questions. |
Retrieve all requirementsproductHierarchyGetRequirements2 | GET | Retrieve all requirements. |
Retrieve all rulesproductHierarchyGetRules2 | GET | Retrieve all rules. |
Retrieve all sectionsproductHierarchyGetSections2 | GET | Retrieve all sections. |
Retrieve all termsproductHierarchyGetTerms2 | GET | Retrieve all terms. |
Retrieve all visibility conditionsproductHierarchyGetVisibilityConditions2 | GET | Retrieve all visibility conditions. |
Retrieve information about an attachment by IDproductHierarchyGetAttachments | GET | Retrieve information about an attachment by ID. |
Update a product questionnaire by IDproductHierarchyPutProductQuestionnaires | PUT | Update a product questionnaire by ID. |
Update a question by IDproductHierarchyPutQuestions | PUT | Update a question by ID. |
Update a requirement by IDproductHierarchyPutRequirements | PUT | Update a requirement by ID. |
Update a rule by IDproductHierarchyPutRules | PUT | Update a rule by ID. |
Update a section by IDproductHierarchyPutSections | PUT | Update a section by ID. |
Update a term by IDproductHierarchyPutTerms | PUT | Update a term by ID. |
Update a visibility condition by IDproductHierarchyPutVisibilityConditions | PUT | Update a visibility condition by ID. |
Project Document Management6
Change the state of a Main Agreement, Contract Addendum or standard document in a contract workspaceprojectDocumentPostProjectDocumentsState | POST | Change the state of a Main Agreement, Contract Addendum or standard document in a contract workspace. |
Create a folder or a project document of type Standard Document, Main Agreement, or Contract.projectDocumentPostProjectDocuments | POST | Create a folder or a project document of type Standard Document, Main Agreement, or Contract Addendum in a Contract Workspace (Procurement). |
Download the document that matches the specified documentId (or the signed document by its signed.projectDocumentGetProjectDocumentsFiles | GET | Download the document that matches the specified documentId (or the signed document by its signed document ID). |
Retrieve the list of documents that match the search criteria (document title, document type, last.projectDocumentGetProjectDocuments | GET | Retrieve the list of documents that match the search criteria (document title, document type, last modified date). |
Retrieve the list of documents with metadata associated with the specified project ID or folder ID.projectDocumentGetProjectDocumentsByDocumentId | GET | Retrieve the list of documents with metadata associated with the specified project ID or folder ID, or the metadata of a document if a document ID is given. |
Update a folder or a project document of type Standard Document, Main Agreement, or Contract.projectDocumentPutProjectDocuments | PUT | Update a folder or a project document of type Standard Document, Main Agreement, or Contract Addendum in a Contract Workspace (Procurement). |
Proof of Service API for Buyers4
Downloads the attachment corresponding to the specified content IDproofServiceBuyersGetProofOfServicesAttachments | GET | Downloads the attachment corresponding to the specified content ID. |
Gets the details of the PoS belonging to the user specified in the request header parameter X-UserIdproofServiceBuyersGetProofOfServices | GET | Gets the details of the PoS belonging to the user specified in the request header parameter X-UserId. |
Retrieves the list of PoS that belong to the user specified in the request header parameter.proofServiceBuyersGetProofOfServicesPages | GET | Retrieves the list of PoS that belong to the user specified in the request header parameter X-UserId, optionally filtered. |
Updates a PoS (approve or reject by updating the PoS status, or update the accounting name).proofServiceBuyersPatchProofOfServices | PATCH | Updates a PoS (approve or reject by updating the PoS status, or update the accounting name), depending on user role and PoS status. |
Proof of Service API for Suppliers7
Create a PoS; this request posts a create job to the queue and the status of the create operation.proofServiceSuppliersPostProofOfServices | POST | Create a PoS; this request posts a create job to the queue and the status of the create operation is returned. |
Download the attachment corresponding to the specified content ID; error details are returned on.proofServiceSuppliersGetProofOfServicesAttachments | GET | Download the attachment corresponding to the specified content ID; error details are returned on failure. |
Get all users of an organization with the specified role (contractor, reviewer or approver)proofServiceSuppliersGetUsers | GET | Get all users of an organization with the specified role (contractor, reviewer or approver). |
Get the details of the PoS belonging to the user specified in the header X-UserIdproofServiceSuppliersGetProofOfServices | GET | Get the details of the PoS belonging to the user specified in the header X-UserId. |
Retrieve the list of PoS that belong to the user specified in the header X-UserId, optionally.proofServiceSuppliersGetProofOfServicesPages | GET | Retrieve the list of PoS that belong to the user specified in the header X-UserId, optionally filtered by $filter. |
Update a PoS based on the status of the PoS and the role of the user; the status of the update.proofServiceSuppliersPatchProofOfServices | PATCH | Update a PoS based on the status of the PoS and the role of the user; the status of the update operation is returned. |
Upload an attachment to the specified PoS (against the parameter file); the status of the operation.proofServiceSuppliersPostProofOfServicesAttachments | POST | Upload an attachment to the specified PoS (against the parameter file); the status of the operation is returned. |
Public Catalogs Shop3
Initiate the typeahead search feature and retrieve the list of matching search suggestionspublicCatalogsGetShopsShopIDAutoComplete | GET | Initiate the typeahead search feature and retrieve the list of matching search suggestions. |
Retrieve the details of all the catalog items and facets from public catalogs from suppliers on SAP.publicCatalogsGetShopsShopID | GET | Retrieve the details of all the catalog items and facets from public catalogs from suppliers on SAP Business Network (items matching the search term and related facets). |
Return the list of all the catalog items and their details from public catalogs on SAP Business.publicCatalogsGetShopsShopIDItems | GET | Return the list of all the catalog items and their details from public catalogs on SAP Business Network. |
Public Procurement Notices Export2
Retrieve the details of a particular notice associated with the public procurement event, based on.publicProcurementGetV2EventsNoticesByEventIdNoticeId | GET | Retrieve the details of a particular notice associated with the public procurement event, based on the notice ID and the event ID. |
Retrieve the list of notices associated with the given public procurement event, based on the event.publicProcurementGetV2EventsNotices | GET | Retrieve the list of notices associated with the given public procurement event, based on the event ID. |
Purchase Orders Supplier2
Retrieve order header data matching the specified buyer, supplier and order ID (purchase orders.purchaseOrdersGetOrders | GET | Retrieve order header data matching the specified buyer, supplier and order ID (purchase orders, scheduling agreements, scheduling agreement releases). |
Retrieve order item data matching the specified buyer, supplier and order IDpurchaseOrdersGetItems | GET | Retrieve order item data matching the specified buyer, supplier and order ID. |
Risk Category Information API for Supplier Risk Exposure3
Adds compliance data for a single supplier: creates it if the supplier has none, otherwise updates.riskCategoryPatchSuppliersCompliances | PATCH | Adds compliance data for a single supplier: creates it if the supplier has none, otherwise updates it. |
Deletes (empty body) or replaces (replacement data in body) all compliance data for a single.riskCategoryPutSuppliersCompliances | PUT | Deletes (empty body) or replaces (replacement data in body) all compliance data for a single supplier. |
Imports values specified in the query body into the custom fields configured in SAP Ariba Supplier.riskCategoryPatchSuppliers | PATCH | Imports values specified in the query body into the custom fields configured in SAP Ariba Supplier Risk (up to 100 suppliers per request). |
Risk Exposure2
Retrieves the overall residual risk and inherent risk exposure for a single supplier monitored in.riskExposureGetSuppliersExposures | GET | Retrieves the overall residual risk and inherent risk exposure for a single supplier monitored in SAP Ariba Supplier Risk. |
Retrieves the overall residual risk and inherent risk exposure for up to 500 suppliers monitored in.riskExposurePostSuppliersExposureRequestPages | POST | Retrieves the overall residual risk and inherent risk exposure for up to 500 suppliers monitored in SAP Ariba Supplier Risk; the paginated results include 100 suppliers per page. |
SAP Ariba Catalog Content4
Fetch all or a filtered subset of items in a catalog, returning the selected fieldscatalogContentGetCatalognameSupplieridItems | GET | Fetch all or a filtered subset of items in a catalog, returning the selected fields. |
Fetch attribute-based faceted catalog data from an individual catalog: a list of facets and their.catalogContentGetFacets | GET | Fetch attribute-based faceted catalog data from an individual catalog: a list of facets and their counts (hierarchical fields include parent codes with aggregated child counts). |
Fetch catalog subscriptions that have been activated after a specified date and time; optionally.catalogContentGetCatalogs | GET | Fetch catalog subscriptions that have been activated after a specified date and time; optionally all statuses, with status and comments, filtered by subscription name. |
Fetch metadata of the standard catalog fields, such as type and descriptioncatalogContentGetItemsSchema | GET | Fetch metadata of the standard catalog fields, such as type and description. |
SAP Ariba Custom Forms6
Downloads the report file of a completed job as a ZIP file named {Form name}-{jobId}customFormsGetJobsFiles | GET | Downloads the report file of a completed job as a ZIP file named {Form name}-{jobId}.zip containing CSV or JSON, up to 10 MB. |
Gets data from submitted form documents associated with a particular form design (form design ID.customFormsPostDocuments | POST | Gets data from submitted form documents associated with a particular form design (form design ID required). |
Gets information about published form designs created using the forms builder, primarily form.customFormsGetForms | GET | Gets information about published form designs created using the forms builder, primarily form design IDs; returns all versions ever published unless filtered. |
Optionally requests a list of all reporting jobs for a site, specifying a filtercustomFormsGetJobs2 | GET | Optionally requests a list of all reporting jobs for a site, specifying a filter. |
Posts a reporting job to the job queue for filtered form document data and returns the job IDcustomFormsPostJobs | POST | Posts a reporting job to the job queue for filtered form document data and returns the job ID. |
Queries the status of a reporting jobcustomFormsGetJobs | GET | Queries the status of a reporting job. |
SAP Ariba SCIM12
Changes only some of the attributes of the specified group, as indicated in the requestscimPatchGroups | PATCH | Changes only some of the attributes of the specified group, as indicated in the request. |
Changes only some of the attributes of the specified user, as indicated in the requestscimPatchUsers | PATCH | Changes only some of the attributes of the specified user, as indicated in the request. |
Creates a group with the specified attributesscimPostGroups | POST | Creates a group with the specified attributes. |
Creates a user with the specified attributesscimPostUsers | POST | Creates a user with the specified attributes. |
Deletes the specified groupscimDeleteGroups | DELETE | Deletes the specified group. |
Deletes the specified userscimDeleteUsers | DELETE | Deletes the specified user. |
Returns a list of all groups, or uses filter to identify groups based on filter parametersscimGetGroups | GET | Returns a list of all groups, or uses filter to identify groups based on filter parameters. |
Returns details of the specified group; supports multi-valued attribute pagination of membersscimGetGroupsByGroupId | GET | Returns details of the specified group; supports multi-valued attribute pagination of members. |
Returns details of the specified userscimGetUsersByUserId | GET | Returns details of the specified user. |
Returns the list of all users, or uses filter to identify users based on filter parameters; use.scimGetUsers | GET | Returns the list of all users, or uses filter to identify users based on filter parameters; use startIndex and count to control pagination. |
Updates all attributes of the specified group; overwrites all information for the groupscimPutGroups | PUT | Updates all attributes of the specified group; overwrites all information for the group. |
Updates all attributes of the specified user; overwrites all information for the userscimPutUsers | PUT | Updates all attributes of the specified user; overwrites all information for the user. |
SAP Build Work Zone CDM Content API for Procurement1
Returns data regarding the roles and the Joule deep links they are mapped to, in Common Data Model.buildWorkZoneCDMContentProcurementGetCdmForJoule | GET | Returns data regarding the roles and the Joule deep links they are mapped to, in Common Data Model (CDM) format. |
SAP Build Work Zone CDM Content API for Sourcing1
Retrieve Common Data Model (CDM) data regarding roles and the Joule deep links they are mapped to.buildWorkZoneCDMContentSourcingGetCdmForJoule | GET | Retrieve Common Data Model (CDM) data regarding roles and the Joule deep links they are mapped to, in CDM format. |
Ship Notice API for Buyers2
Retrieves information on ship-notice itemsshipNoticeBuyersGetItems | GET | Retrieves information on ship-notice items. |
Retrieves ship-notice header informationshipNoticeBuyersGetShipNotices | GET | Retrieves ship-notice header information. |
Ship Notice API for Suppliers2
Retrieve information on ship-notice itemsshipNoticeSuppliersGetItems | GET | Retrieve information on ship-notice items. |
Retrieve ship-notice header informationshipNoticeSuppliersGetShipNotices | GET | Retrieve ship-notice header information. |
Sourcing Project Management15
Add users to a project group; works only when the project, event or contract is in an editable statesourcingProjectPostProjectsTeamsUsers | POST | Add users to a project group; works only when the project, event or contract is in an editable state. |
Download a specified document from a sourcing project; only file-based documents can be downloaded.sourcingProjectGetProjectsDocumentsContent | GET | Download a specified document from a sourcing project; only file-based documents can be downloaded (error 10119 otherwise). |
Download attachments associated with a task history or commentsourcingProjectGetCommentsAttachmentsContent | GET | Download attachments associated with a task history or comment. |
Retrieve a list of groups (project groups and their users) associated with a projectsourcingProjectGetProjectsTeams | GET | Retrieve a list of groups (project groups and their users) associated with a project. |
Retrieve a list of users and global or system groups associated with a project groupsourcingProjectGetProjectsTeamsByProjectIdTeamId | GET | Retrieve a list of users and global or system groups associated with a project group. |
Retrieve details (header fields) of the sourcing project associated with a specified project IDsourcingProjectGetProjectsByProjectId | GET | Retrieve details (header fields) of the sourcing project associated with a specified project ID. |
Retrieve details (header information including document IDs) of documents present in a sourcing.sourcingProjectGetProjectsDocuments | GET | Retrieve details (header information including document IDs) of documents present in a sourcing project. |
Retrieve details of a specific document in a sourcing projectsourcingProjectGetProjectsDocumentsByProjectIdDocumentId | GET | Retrieve details of a specific document in a sourcing project. |
Retrieve information about all task history and comments associated with a specified tasksourcingProjectGetProjectsTasksComments | GET | Retrieve information about all task history and comments associated with a specified task. |
Retrieve project history details displayed in the History tab of a sourcing projectsourcingProjectGetProjectsHistoryRecords | GET | Retrieve project history details displayed in the History tab of a sourcing project. |
Retrieve task details (all tasks and phases) from a sourcing full projectsourcingProjectGetProjectsTasks | GET | Retrieve task details (all tasks and phases) from a sourcing full project. |
Retrieve the list of projects created or modified or both in a time period given in $filter as Unix.sourcingProjectGetProjects | GET | Retrieve the list of projects created or modified or both in a time period given in $filter as Unix epoch millisecond ranges; returns project IDs (internalId), created dates and last... |
Update details (header fields) of a specific sourcing full project; values in the body overwrite.sourcingProjectPutProjects | PUT | Update details (header fields) of a specific sourcing full project; values in the body overwrite existing values; no partial updates. |
Update existing user information in a project group; all existing users are replaced with the users.sourcingProjectPutProjectsTeamsUsers | PUT | Update existing user information in a project group; all existing users are replaced with the users in the request (can replace a user with one configured in SAP Ariba Supplier Management... |
Update project groups in a sourcing project and groups within a project group; all existing groups.sourcingProjectPutProjectsTeamsGroups | PUT | Update project groups in a sourcing project and groups within a project group; all existing groups are replaced with the groups in the request. |
Supplier Data API with Pagination28
Creates the process for one supplier at a time using the specified process type (new process if the.supplierDataPaginationPostProcessesProcessCreateRequests | POST | Creates the process for one supplier at a time using the specified process type (new process if the matrix combination does not exist; error if an undecided process exists; renewal if a... |
Fetches process creation status for one or more suppliers using the job ID returned by.supplierDataPaginationGetJobs | GET | Fetches process creation status for one or more suppliers using the job ID returned by processCreateRequests. |
Gets all modular questionnaire data for the specified suppliersupplierDataPaginationGetVendorsWorkspacesQuestionnaires | GET | Gets all modular questionnaire data for the specified supplier. |
Gets all modular questionnaire data in the specified project (workspace) for the specified suppliersupplierDataPaginationGetVendorsWorkspacesQuestionnairesByVendorIdWorkspaceId | GET | Gets all modular questionnaire data in the specified project (workspace) for the specified supplier. |
Gets all question and answer data in all questionnaires for the specified suppliersupplierDataPaginationGetWorkspacesQuestionnairesQna | GET | Gets all question and answer data in all questionnaires for the specified supplier. |
Gets all question and answer data in all questionnaires in the specified project (workspace) for.supplierDataPaginationGetWorkspacesQuestionnairesQnaBySmVendorIdWorkspaceId | GET | Gets all question and answer data in all questionnaires in the specified project (workspace) for the specified supplier. |
Gets all supplier management projects (workspaces) for the specified supplier (supplier request.supplierDataPaginationGetVendorsWorkspaces | GET | Gets all supplier management projects (workspaces) for the specified supplier (supplier request, registration, qualification, disqualification, preferred supplier management, modular... |
Gets certificate question (header-level) data for the specified vendor, including the workspace ID.supplierDataPaginationGetVendorsCertificates | GET | Gets certificate question (header-level) data for the specified vendor, including the workspace ID of the project containing the question. |
Gets data for the specified modular questionnaire for the specified suppliersupplierDataPaginationGetVendorsWorkspacesQuestionnairesByVendorIdQuestionnaireId | GET | Gets data for the specified modular questionnaire for the specified supplier. |
Gets question and answer data in the specified questionnaire for the specified suppliersupplierDataPaginationGetWorkspacesQuestionnairesQnaBySmVendoridQuestionnaireId | GET | Gets question and answer data in the specified questionnaire for the specified supplier. |
Gets question and answer data in the specified questionnaire in the specified project (workspace).supplierDataPaginationGetWorkspacesQuestionnairesQnaBySmVendoridWorkspaceIdQuestionnaireId | GET | Gets question and answer data in the specified questionnaire in the specified project (workspace) for the specified supplier. |
Gets the specified supplier management project (workspace) for the specified suppliersupplierDataPaginationGetVendorsWorkspacesBySmVendorIdWorkspaceId | GET | Gets the specified supplier management project (workspace) for the specified supplier. |
Posts answers to questions in the specified questionnaire in the specified project for the.supplierDataPaginationPostWorkspacesQuestionnairesAnswers | POST | Posts answers to questions in the specified questionnaire in the specified project for the specified supplier (registration, qualification, modular questionnaires and process intake forms). |
processCancellationRequest: cancels a specific process that is in In Progress status for a specific.supplierDataPaginationPatchVendorsProcesses | PATCH | processCancellationRequest: cancels a specific process that is in In Progress status for a specific supplier from an external system (initiates cancellation only). |
Retrieves all the process types defined in your site (see Process Type Data Import)supplierDataPaginationGetProcessesProcessTypes | GET | Retrieves all the process types defined in your site (see Process Type Data Import). |
Retrieves header field information about all processes of a suppliersupplierDataPaginationGetVendorsProcesses | GET | Retrieves header field information about all processes of a supplier. |
Retrieves header field information and decision history of a specific process (also used to get the.supplierDataPaginationGetVendorsProcessesByVendorIdWid | GET | Retrieves header field information and decision history of a specific process (also used to get the intake form or questionnaire document ID). |
Retrieves process intake form details or questionnaire details in a specific version (431 Version.supplierDataPaginationGetQuestionnairesQnaVersionsByVendorIdQuestionnaireIdVersionId | GET | Retrieves process intake form details or questionnaire details in a specific version (431 Version not found if absent). |
Retrieves process intake form details or questionnaire details in the latest versionsupplierDataPaginationGetQuestionnairesQnaVersions | GET | Retrieves process intake form details or questionnaire details in the latest version. |
Retrieves the data of inactive suppliers in your site (all inactive suppliers, or specific ones by.supplierDataPaginationPostInactiveVendorDataRequests | POST | Retrieves the data of inactive suppliers in your site (all inactive suppliers, or specific ones by SM or ERP vendor IDs). |
Retrieves the intake form for the process typesupplierDataPaginationGetProcessesTemplates | GET | Retrieves the intake form for the process type. |
Retrieves the overall score and section-level scores of a single modular questionnaire in the.supplierDataPaginationGetWorkspacesQuestionnairesScores | GET | Retrieves the overall score and section-level scores of a single modular questionnaire in the specified project for the specified supplier, with weight, importance, target, band and range. |
Returns the contact details specified in request body filters for suppliers whose IDs are specifiedsupplierDataPaginationPostVendorContactsRequests | POST | Returns the contact details specified in request body filters for suppliers whose IDs are specified. |
Returns the data specified in request body filters for all suppliers, with or without IDs for their.supplierDataPaginationPostVendorDataRequests | POST | Returns the data specified in request body filters for all suppliers, with or without IDs for their associated questionnaires. |
Returns the list of all active modular questionnaire templates (including mandatory templates) for.supplierDataPaginationPostProcessesModularQuestionnairesRequests | POST | Returns the list of all active modular questionnaire templates (including mandatory templates) for the process type and matrix combination. |
Updates expiration dates or due dates of modular questionnaires for a suppliersupplierDataPaginationPatchVendorsWorkspacesQuestionnaires | PATCH | Updates expiration dates or due dates of modular questionnaires for a supplier. |
Updates qualification or preferred category status for the specified combination of commodities.supplierDataPaginationPatchVendors | PATCH | Updates qualification or preferred category status for the specified combination of commodities, regions, and departments for the specified suppliers. |
Updates the regions or status decisions of a process (process project feature SM-16798 only); one.supplierDataPaginationPatchWorkspacesHeaderFields | PATCH | Updates the regions or status decisions of a process (process project feature SM-16798 only); one request cannot do both. |
Supplier Data Extraction2
Runs the specified job to retrieve the supplier datasupplierDataExtractionGetJobs | GET | Runs the specified job to retrieve the supplier data. |
Submits the job to search and retrieve supplier data from the specified realm ID for the specified.supplierDataExtractionPostJobs | POST | Submits the job to search and retrieve supplier data from the specified realm ID for the specified supplier IDs. |
Supplier Information1
Retrieves the relationship status of a given buyer, supplier and collaboration type on SAP Business.supplierInformationGetBuyersSuppliers | GET | Retrieves the relationship status of a given buyer, supplier and collaboration type on SAP Business Network. |
Supplier Invite1
Create a vendor record in SAP Business Network (posts a create job), optionally triggering the.supplierInvitePostVendors | POST | Create a vendor record in SAP Business Network (posts a create job), optionally triggering the trading relationship request; can also extend an existing AN Fulfillment vendor with... |
Supplier Risk Engagements6
Gets the details for the engagement issuessupplierRiskGetIssuesByWorkspaceId | GET | Gets the details for the engagement issues. |
Gets the details for the engagement projectssupplierRiskGetEngagementsByWorkspaceId | GET | Gets the details for the engagement projects. |
Gets the details for the modular and inherent risk screening questionnaires; provide the modular or.supplierRiskGetQuestionnairesByWorkspaceId | GET | Gets the details for the modular and inherent risk screening questionnaires; provide the modular or inherent questionnaire workspace ID, or the engagement workspace ID to retrieve both. |
Searches for the engagement issuessupplierRiskGetIssues | GET | Searches for the engagement issues. |
Searches for the engagement projects (by last updated date or date range); results include.supplierRiskGetEngagements | GET | Searches for the engagement projects (by last updated date or date range); results include workspace IDs for engagements and related issue and modular questionnaire projects. |
Searches for the modular and inherent risk screening questionnairessupplierRiskGetQuestionnaires | GET | Searches for the modular and inherent risk screening questionnaires. |
Surrogate Bid3
Download the bid response sheet (or an attachment from a download_attachment_response job) once the.surrogateBidGetJobsFiles | GET | Download the bid response sheet (or an attachment from a download attachment response job) once the job status is Success. |
Post a job that generates (export), imports, submits a bid response sheet or adds, deletes.surrogateBidPostJobs | POST | Post a job that generates (export), imports, submits a bid response sheet or adds, deletes, downloads or replaces an attachment response on behalf of a participant. |
Retrieve the status of a job (export, import, attachment or submit) and the fileId of its outputsurrogateBidGetJobs | GET | Retrieve the status of a job (export, import, attachment or submit) and the fileId of its output. |
Trading Partner Profile Certification2
Downloads a specific certification filetradingPartnerGetCertificationsVersionsAttachment | GET | Downloads a specific certification file. |
Retrieves the list of certifications of the specified supplier from their company profiletradingPartnerGetV1Certifications | GET | Retrieves the list of certifications of the specified supplier from their company profile. |
User Qualification2
Create user qualification data records for usersuserQualificationPostQualifications | POST | Create user qualification data records for users. |
Modify existing user qualification data records for users; all values in the records for the.userQualificationPutQualifications | PUT | Modify existing user qualification data records for users; all values in the records for the specified users are deleted and replaced with the specified values. |