SAP Ariba Tool
Run SAP Ariba sourcing operational-reporting jobs and fetch their results.
Tool ID
ariba-report
Credential Required
Yes — a server-refreshed oauth credential (auth mode oauth_user). The InTouch server resolves and refreshes the linked oauth credential and hands the tool a live access token at execution time; the tool never stores or refreshes tokens itself. Mint one with itcli.py /oauth. Every request is sent as Authorization: Bearer <access_token> to the fixed base URL https://openapi.ariba.com/api.
In addition to the OAuth token, every call must carry your SAP Ariba application API key (the aribaApiKey task input, sent as the apikey request header) and your Ariba realm (in the query input, e.g. {"realm": "MYREALM"}).
Credential Properties
| Property | Type | Default | Description |
|---|---|---|---|
client_id |
string | — | OAuth app client ID (your registered SAP Ariba application) |
client_secret |
string | — | OAuth app client secret (if required on refresh) |
token_url |
string | — | Provider OAuth token endpoint — used to refresh |
access_token |
string | — | Required. Current access token — kept fresh by the server; do not edit by hand |
refresh_token |
string | — | Refresh token; enables automatic server-side refresh |
token_type |
string | Bearer |
Token type |
scope |
string | — | Granted OAuth scopes (space-separated) |
expires_at |
string | — | Access-token expiry in epoch seconds (0 = non-expiring) |
Operations
1. submit_report_job — Submit a reporting job
Submits a sourcing operational-reporting job (view template + filters) for asynchronous execution.
Calls POST /sourcing-reporting-job/v1/prod/jobs (JSON body).
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
aribaApiKey |
string | — | Required. SAP Ariba application API key — sent in the apikey header alongside the OAuth token |
query |
string | — | Required. Query params as a JSON object string. realm is REQUIRED on every call, e.g. {"realm": "MYREALM"} |
body |
string | — | Job definition (view template + filters) as a JSON object string |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
2. get_report_job — Get a reporting job's status/result
Reads the status and result metadata of a submitted reporting job.
Calls GET /sourcing-reporting-jobresult/v1/prod/jobs/{jobId}.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
aribaApiKey |
string | — | Required. SAP Ariba application API key — sent in the apikey header alongside the OAuth token |
jobId |
string | — | Required. Reporting job id |
query |
string | — | Required. Query params as a JSON object string. realm is REQUIRED on every call, e.g. {"realm": "MYREALM"} |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
3. get_report_file — Fetch a result file
Fetches one result file produced by a completed reporting job.
Calls GET /sourcing-reporting-jobresult/v1/prod/jobs/{jobId}/files/{fileName}.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
aribaApiKey |
string | — | Required. SAP Ariba application API key — sent in the apikey header alongside the OAuth token |
jobId |
string | — | Required. Reporting job id |
fileName |
string | — | Required. Result file name |
query |
string | — | Required. Query params as a JSON object string. realm is REQUIRED on every call, e.g. {"realm": "MYREALM"} |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
License
Requires a per-tool connector license on Department/Enterprise editions (Personal/Solo/Team editions are unaffected). Apply the license via the tool's Apply License action.
Self-Contained JAR
The jar bundles all runtime dependencies; only intouch-tool-api is provided by the server.
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
completeoperationresultstatuswarning