Application Programming Interface Guide > Web Services Operations > Operations Reference > updateDataSourceChildInfosWithFilter
 
updateDataSourceChildInfosWithFilter
Unsupported in API version 6.0. Instead use introspectResourcesTask with an introspection plan.
Updates the introspection state for child resources based upon the specified filter criterion.
Invocation of this procedure adds or removes resources that match the filter set on the path and childInfo path depending on the value passed by introspectState.
Filters created with the API are persistent and they are applied to future introspections (programmatic or manual), so that new tables or directories that match the filter criterion are added or ignored based on those filters and their respective introspection states.
Accessing data source childInfo is relatively expensive. If multiple calls to this operation and/or getDataSourceChildResources are going to be made, filtering the request and making them all on one transaction improves performance.
Location
/services/webservices/system/admin/resource/operations/
Request Elements
path: Path to the data source.
childInfos: List of dataSourceChildInfos to update. For each childInfo:
path: The path within the data source. The childInfo paths are paths relative to the data source.
type: The type of resource within the data source. Legal type values are: CONTAINER and TABLE.
introspectState: The new state to set. Legal introspect state values are:
IGNORED: Causes the resource to be removed (or stay removed).
SELF: Causes the resource to be added (or stay added).
SELF_AND_CHILDREN: Causes the resource to be added along with all of its children.
attributes (optional): Optional values to be used for the resource. These might be required to specify login information if such information is not persisted with the data source definition. See Attributes Element.
filter: Wild-card character used by the specific datasource to represent any trailing characters.
Response Elements
N/A
Faults
DataSourceError: Given if a data source connection cannot be established or if a data source request returns an error.
IllegalArgument: If the path element or any path in a childInfo is malformed, or if any type or introspect state on a childInfo is illegal.
NotFound: If the data source or any portion of path do not exist.
NotFound: If any of the childInfo paths do not exist and the introspect state is not being set to IGNORED.
Security: If the user does not have READ access on all items in path other than the last one.
Security: If the user does not have WRITE access to the last item in path.
Security: If the user does not have the ACCESS_TOOLS right.
Example
Introspect the data source ds_orders and any other table that starts with the letter “o.” Run the webservice API and set parameters as follows:
updateDataSourceChildInfosWithFilter
  path="/shared/examples/ds_orders"
  childInfos
    childInfo
      path=o %
      type=TABLE
      introspectState=SELF
        filter="%"
 
In a programmatic invocation of this procedure, the changes made are applied when the transaction is committed, or discarded when the transaction is rolled back. Studio invocation of this procedure implies commit on execution.
Changes are additive. Existing table selections remain selected even if they do not match the current filter, unless the introspectState value is IGNORED.
Datasource filters created with the API are persistent, but the introspectState can be reversed with a separate invocation, or the Studio API can be used to delete the filter while retaining currently introspected tables.
Also see getDataSourceChildResources and reintrospectDataSource.