Endpoints Included in the Operational Reporting API for Procurement
The Operational Reporting API for Procurement includes endpoints for view template management, asynchronous and synchronous reporting, and attachment retrieval.
The Operational Reporting API for Procurement includes the following sets of endpoints, each of which has its own discovery page on the SAP Ariba Developer Portal:
- Operational Reporting for Procurement - View Management API
-
Allows you to work with reporting view templates, which are used to specify the filters that determine what data will be returned in response to an API request using the Operational Reporting API for Procurement. A reporting view template specifies the type of records to report on, the reporting fields to be included in the API response, and selection filters to select relevant records for inclusion.
Endpoint
Description
POST /viewTemplates/{viewTemplateName}
Create a new view template.
GET /viewTemplates/{viewTemplateName}
View the details of the specified view template.
GET /viewTemplates
View all view templates for a realm.
POST /viewTemplates/{viewTemplateName}/patch
Update the specified view template.
GET /metadata
Request a list of all supported document types or a list of all filter and selection fields, either for a single document type or for all document types, that can be used to create custom view templates.
- Operational Reporting for Procurement - Job Submission API
-
Allows you to submit larger jobs for asynchronous processing, using reporting view templates.
Endpoint
Description
POST /jobs
Submit a job for asynchronous processing. To retrieve the output, use the Operational Reporting for Procurement - Job Results API.
- Operational Reporting for Procurement - Job Results API
-
Allows you to request output from asynchronous jobs posted using the Operational Reporting for Procurement - Job submission API. Requested output is batched into ZIP files containing 1000 records per file, and these can be downloaded one at a time.
Endpoint
Description
GET /jobs/{jobId}/files/{fileId}
Request ZIP files from the specified completed asynchronous operational reporting job, one ZIP file at a time.
GET /jobs/{jobId}
Request the status of the specified asynchronous operational reporting job.
- Operational Reporting for Procrement - Synchronous API
-
Allows you to submit smaller requests and receive results synchronously. In the synchronous usage, requested output is batched and paginated, and results are returned one page at a time.
Endpoint
Description
GET /views/{viewTemplateName}
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.
- Operational Reporting for Procrement - Attachment API
-
Allows you to retrieve attachment documents that are part of procurement approvables.
Endpoint
Description
GET /attachment/{uniqueAttachmentId}
Retrieves a single attachment, based on its unique attachment ID.
GET /{queryType}/{approvableId}/attachments/{attachmentId}
For documents retrieved before the uniqueAttachmentId field was implemented. Requests a single attachment based on its query type, approvable ID, and attachment ID.