Application Programming Interface Guide > Web Services Operations > Operations Reference > getIntrospectableResourceIdsResult
 
getIntrospectableResourceIdsResult
Get the results from getIntrospectableResourceIdsTask. The number of resources returned is limited by page size and total number of known resources. Subsequent calls to this operation incrementally return the full list of native resource identifiers available within the data source.
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 resource identifiers that are returned from this call.
The page start determines which resource is returned first. This can be used to jump ahead in the resource 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 oeach time. Specifying the page start sets the position that you would like to start receiving resource identifiers. Subsequent calls to this operation start from that point.
If an insufficient number of resource identifiers have been found during a call to this operation, this operation either times out or returns with COMPLETED equal TRUE. In either case, an empty list of identifiers is returned.
This operation returns a taskId that can be used to get results using getIntrospectableResourceIdsResult, or canceled using cancelServerTask.
This operation returns the total number of known resource identifiers in the totalResults element. The totalResults element does not exist until the full total is known. If this number is not known or only partial results are available, this element is empty.
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 getIntrospectableResourceIdsResult generates a NotFound fault.
The lastUpdate return element indicates when the cache associated with this resource identifier list was last updated. If the result set is currently being updated due to the original getIntrospectableResourceIdsTask, lastUpdate reflects when the server task was initiated.
The resourceIdentifiers element provides the list of native resources paths, types, and subtypes. Paths are relative to the containing data source.
This operation must be run within the same explicit transaction that the original call to getIntrospectableResourceIdsTask was invoked. Otherwise the taskId is reported as NotFound.
Location
/services/webservices/system/admin/resource/operations/
Request Elements
taskId: The server task ID associated with the original call.
block: Whether or not to block until processing is complete. Defaults is FALSE.
page:
size: The number of resource identifiers to return in the result.
start: The page number to start retrieving data from. Defaults to 0.
Response Elements
taskId: The server task ID associated with the original call.
totalResults: 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.
lastUpdate: The date and time the resource cached was last created.
resourceIdentifiers: List of native resource paths and types available within a data source.
Faults
DataSourceError: If a data source connection cannot be established or if a data source request returns an error.
IllegalArgument: If the taskId, or page 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.