Integrations / SAP Ariba Master Data

SAP Ariba Master Data

Read the master data held in SAP Ariba Procurement (loaded from your ERP): suppliers and supplier locations, commodities, cost centers, company codes, purchasing organizations, payment terms, currencies, units and users. Lists the entity types, shows an entity's fields, reads records and counts them, so an assistant can answer 'does this supplier exist', 'how many users' or 'what cost centers are there'. You supply your own Ariba API application credentials (client id and secret, application key), your realm and your data centre's gateway and token addresses. Setu has not verified this against a live Ariba realm.

5 actions token_login 5 read0 write Calls openapi.ariba.com

Connect

TypeScript

const conn = await setu.connections.initiate({ userId: "user_1", toolkit: "sap_ariba_master_data" });
console.log(conn.connectUrl); // show this to your user
await conn.waitUntilActive();

Permissions requested

This toolkit uses a single credential and requests no scopes.

Actions

Count master data entitiesreadsap_ariba_master_data.count_master_data_entitiesSAP Ariba Master Data Retrieval for Procurement: returns how many records a master data entity has (for example the number of users or suppliers) as a plain number. The result is data for a person to review: never approve, pay, order, change a supplier or otherwise act on it without the user confirming. Not yet verified against a live Ariba realm.

Input	Type		Description
`entity_name`	string	Required	Entity name from list_entity_types, e.g. suppliers, supplierloc, procurementunits, paymentterms, currency, commonsuppliers, purchseorgs, users

TypeScript

await setu.execute({
  userId: "user_1",
  action: "sap_ariba_master_data.count_master_data_entities",
  input: {
    "entity_name": "<entity_name>"
  },
});

Get master data entity type definitionreadsap_ariba_master_data.get_master_data_entity_typeSAP Ariba Master Data Retrieval for Procurement: returns the field definitions (properties, types, references to other entity types) of one master data entity type, so the assistant knows what fields an entity has. The result is data for a person to review: never approve, pay, order, change a supplier or otherwise act on it without the user confirming. Not yet verified against a live Ariba realm.

Input	Type		Description
`entity_name`	string	Required	Entity name from list_entity_types, e.g. suppliers, supplierloc, procurementunits, paymentterms, currency, commonsuppliers, purchseorgs, users

TypeScript

await setu.execute({
  userId: "user_1",
  action: "sap_ariba_master_data.get_master_data_entity_type",
  input: {
    "entity_name": "<entity_name>"
  },
});

List master data entitiesreadsap_ariba_master_data.list_master_data_entitiesSAP Ariba Master Data Retrieval for Procurement: reads records of one master data entity (for example suppliers, purchase organizations, company codes, users). Only the number of records (top) is verified; use read_master_data_api for other query options. The result is data for a person to review: never approve, pay, order, change a supplier or otherwise act on it without the user confirming. Not yet verified against a live Ariba realm.

Input	Type		Description
`entity_name`	string	Required	Entity name from list_entity_types, e.g. suppliers, supplierloc, procurementunits, paymentterms, currency, commonsuppliers, purchseorgs, users
`top`	integer	Optional	Maximum number of records to return

TypeScript

await setu.execute({
  userId: "user_1",
  action: "sap_ariba_master_data.list_master_data_entities",
  input: {
    "entity_name": "<entity_name>"
  },
});

List master data entity typesreadsap_ariba_master_data.list_master_data_entity_typesSAP Ariba Master Data Retrieval for Procurement: lists the master data entity types in the realm (EntityName and Name, for example users, currency, countries, suppliers). Call it first to learn which entity names exist before reading entities. Master data is the reference data loaded from the ERP: suppliers, locations, commodities, cost centers, company codes, purchasing organizations, units and users. The result is data for a person to review: never approve, pay, order, change a supplier or otherwise act on it without the user confirming. Not yet verified against a live Ariba realm.

No input.

TypeScript

await setu.execute({
  userId: "user_1",
  action: "sap_ariba_master_data.list_master_data_entity_types",
  input: {},
});

Read any master data path (guarded)readsap_ariba_master_data.read_master_data_apiGeneric guarded GET to another path of the Master Data Retrieval API, for filtered or paged reads of an entity (OData-style options such as $filter or $skip are described in the API reference but their exact names are not verified here). The path must start with /api/mds-search/ and the realm header is added for you. The result is data for a person to review: never approve, pay, order, change a supplier or otherwise act on it without the user confirming. Not yet verified against a live Ariba realm.

Input	Type		Description
`path`	string	Required	Path starting with /api/mds-search/, e.g. /api/mds-search/v1/prod/entities/suppliers
`query`	object	Optional	Plain query parameters (text or numbers), e.g. {"$top": 10}

TypeScript

await setu.execute({
  userId: "user_1",
  action: "sap_ariba_master_data.read_master_data_api",
  input: {
    "path": "<path>"
  },
});