List of operations and diagram of the WSDL

This topic provides a diagram and lists the operations available in the Data Ingest Web Service.

Diagram of the Data Ingest Web Service WSDL

The following diagram provides a visual representation of the tree of operations in the Data Ingest Web Service WSDL.

Note: The structure of this guide does not follow the structure of the WSDL for this web service. In the WSDL, one of the operations — ingestChanges — contains many sub-operations, used for various different tasks. By comparison, this guide is broken into sections for adding records, updating records, deleting and replacing records, and adding managed attributes. When reading this guide, use the diagram in this section to locate a particular operation in the WSDL of the Data Ingest Web Service.

visualization of the Data Ingest Web Service WSDL.

This diagram illustrates the Data Ingest Web Service structure:
  • The Data Ingest Web Service contains four major operations: ingestChanges, ingestManagedAttributeValues, clearDataStore, and provisionDataStore.
  • Inside ingestChanges, the following elements represent sub-operations: addRecords, updateRecords, addOrUpdateRecords, deleteRecords, and replaceRecords. Note that unlike ingestChanges, which contains many sub-elements, other top-level operations do not contain sub-elements representing operations.
  • Further, inside the updateRecods element, the following elements are included, each of which also represents an operation of this web service: addAssignments, deleteAssignments, wildcardDeleteAssignments, and replaceAssignments.
To summarize, the operations in the Data Ingest Web Service are the following:
Ingest operation Description
ingestChanges Performs these functions via its five sub-operations:
  • addRecords only creates new records.
  • addOrUpdateRecords either creates new records (if the specified record specifier does not exist) or adds assignments to an existing records (if the specified record specifier does exist in the index for the data domain).
  • updateRecords updates existing records by adding, deleting, wildcard-deleting, and replacing value assignments on attributes. Can rename a standard attribute.
  • replaceRecords replaces existing records.
  • deleteRecords deletes existing records.
ingestManagedAttributeValues Adds and updates assignment values for managed attributes.
clearDataStore Deletes the data records and schema records from the data domain, indicating the number of records deleted. This operation must be followed by the provisionDataStore operation.
provisionDataStore Provisions the primordial schema records in the data domain. This operation (which is typically run after the clearDataStore operation) adds the system records (such as PDRs and DDRs), and resets these records to their default values.