introspectResourcesResult
Get the results from
introspectResourcesTask. The number of results returned is limited by page size and total number of known fields.
Results are in the form of introspection change entries, which contain the path, type, and subtype of the resource that was introspected, the introspection action that occurred, and a message, if available, regarding introspection of that resource.
Subsequent calls to this operation incrementally return the full set of results.
If the block element is set and TRUE, this operation blocks until the task is complete. Otherwise, this operation does not block.
The page size controls the maximum number of change entries that are returned from this call.
The page start determines which result is returned first. This can be used to jump ahead in the result list. This jump is relative to the current position. Providing a non-zero page start with every call to this operation has the effect of skipping a page-size number of results each time.
Specifying the page start sets the position where you would like to start receiving results. Subsequent calls to this operation start from that point. If an insufficient number of results have been found during a call to this operation, this operation either times out or returns with COMPLETED set to TRUE. In either case, an empty list of results is returned.
This operation returns a taskId that can be used to get results using , or canceled using
cancelServerTask.
This operation returns the total number of results in the totalResults element. If it is not known what the total number of results is, this element is unset.
This operation returns a completed element that indicates whether or not processing has completed and these are the last results the caller receives. If TRUE, a subsequent call to getIntrospectableResourceFieldsResult generates a NotFound fault.
This operation returns the introspection status in the status element based on the value specified in the detail element:
• NONE: Minimal information is returned to indicate the running state of the task.
• SIMPLE: Overall status and counts are returned.
• FULL: List of introspection change entries is returned.
The status startTime element is set only after introspection has started. The status endTime element is set only when introspected has completed.
The list of introspection change entries contains only entries for newly added messages or resource identifiers since the last call to
introspectResourcesResult.
Location
/services/webservices/system/admin/resource/operations/
Request Elements
taskId: The server task ID associated with the original call.
block (optional): Whether or not to block until processing is complete. Default is FALSE.
page (optional):
• size: The number of resource identifiers to return in the result.
• start: The page number to start retrieving data from. Defaults to 0.
detail: The level of detail about the resources to include in the response. Valid values are NONE, SIMPLE, and FULL.
Response Elements
taskId: The server task ID associated with the original call.
totalResults (optional): If known, the total result set size. Otherwise this element does not exist.
completed: TRUE if processing is completed and the result set has been exhausted.
status: The introspection status report. See
Introspection Report Status Element.
Faults
DataSourceError: If a data source connection cannot be established or if a data source request returns an error.
IllegalArgument: If the taskId, page, or detailLevel is malformed.
IllegalState: If the data source is disabled.
NotFound: If the taskId does not exist or has completed.
Security: If the user does not have the ACCESS_TOOLS right.
Security: If a different TDV session was used to create the server task.