require(["esri/portal/PortalItem"], (PortalItem) => { /* code goes here */ });
import PortalItem from "@arcgis/core/portal/PortalItem.js";
esri/portal/PortalItem
An item (a unit of content) in the Portal. Each item has a unique identifier and a well known URL that is independent of the user owning the item. An item may have associated binary or textual data which is available via the item data resource. View the ArcGIS portal API REST documentation for the item for more details.
Constructors
-
new PortalItem(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example// Typical usage let item = new PortalItem({ id: "affa021c51944b5694132b2d61fe1057" }); item.load();
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | Indicates the level of access to this item: | PortalItem | |
String | Information on the source of the item and its copyright status. more details | PortalItem | |
String | An authorization string used to access the portal item. more details | PortalItem | |
Object[] | Contains an array of objects containing proxy information for premium platform services. more details | PortalItem | |
Number | Average rating. more details | PortalItem | |
String[] | An array of organization categories that are set on the item. more details | PortalItem | |
Date | The date the item was created. more details | PortalItem | |
String | The item's locale information (language and country). more details | PortalItem | |
String | The name of the class. more details | Accessor | |
String | The detailed description of the item. more details | PortalItem | |
Extent | The geographic extent, or bounding rectangle, of the item. more details | PortalItem | |
String[] | An array of group categories set on the item. more details | PortalItem | |
String | The unique id for the item. more details | PortalItem | |
Boolean | Indicates whether a layer can be created from this item using Layer.fromPortalItem(). more details | PortalItem | |
Boolean | Indicates whether this item and the user whose credential was used to fetch this item belong to the same ArcGIS Enterprise Portal or ArcGIS Online Organization. more details | PortalItem | |
String | Indicates whether an item can be updated and deleted. more details | PortalItem | |
String | The URL to the Item page on the portal. more details | PortalItem | |
String | The URL to the item. more details | PortalItem | |
String | Information on license or restrictions related to the item. more details | PortalItem | |
Boolean | Indicates whether the item's resources have loaded from the portal. more details | PortalItem | |
Error | The Error object returned if an error occurred while loading. more details | PortalItem | |
String | Represents the status of a load operation. more details | PortalItem | |
Object[] | A list of warnings which occurred while loading. more details | PortalItem | |
Date | The date the item was last modified. more details | PortalItem | |
String | The name of the item. more details | PortalItem | |
Number | Number of comments on the item. more details | PortalItem | |
Number | Number of ratings on the item. more details | PortalItem | |
Number | Number of views on the item. more details | PortalItem | |
String | The username of the user who owns this item. more details | PortalItem | |
String | The ID of the folder in which the owner has stored the item. more details | PortalItem | |
Portal | The portal that contains the item. more details | PortalItem | |
String[] | An array of string URLs. more details | PortalItem | |
Number | The size of the item (in bytes). more details | PortalItem | |
String | A summary description of the item. more details | PortalItem | |
Object | The JSON used to create the property values when the | PortalItem | |
String[] | User defined tags that describe the item. more details | PortalItem | |
String | The URL to the thumbnail used for the item. more details | PortalItem | |
String | The title for the item. more details | PortalItem | |
String | The GIS content type of this item. more details | PortalItem | |
String[] | Type keywords that describe the type of content of this item. more details | PortalItem | |
String | The service URL of this item. more details | PortalItem |
Property Details
-
access String
-
Indicates the level of access to this item:
private
,shared
,org
, orpublic
.Possible Values:"private"|"shared"|"org"|"public"
-
accessInformation String
-
Information on the source of the item and its copyright status.
-
apiKey StringSince: ArcGIS Maps SDK for JavaScript 4.20
-
An authorization string used to access the portal item. API keys are generated and managed in the ArcGIS Developer dashboard. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage.
-
Since: ArcGIS Maps SDK for JavaScript 4.8
-
Contains an array of objects containing proxy information for premium platform services. This is most widely seen in registered applications that work with premium and subscriber services, e.g. routing and analysis services.
-
avgRating Number
-
Average rating. Uses a weighted average called "Bayesian average."
-
Since: ArcGIS Maps SDK for JavaScript 4.8
-
An array of organization categories that are set on the item.
-
created Date
-
The date the item was created.
-
culture String
-
The item's locale information (language and country).
-
Since: ArcGIS Maps SDK for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
description String
-
The detailed description of the item.
-
extent Extent
-
The geographic extent, or bounding rectangle, of the item.
-
Since: ArcGIS Maps SDK for JavaScript 4.8
-
An array of group categories set on the item. This varies slightly from
categories
as it only returns categories in the group content returned from PortalGroup.queryItems.
-
id String
-
The unique id for the item. You can typically find the id for an item in its url.
Example// to access the portal item at this url // http://www.arcgis.com/home/item.html?id=d7892b3c13b44391992ecd42bfa92d01 let item = new PortalItem({ id: "d7892b3c13b44391992ecd42bfa92d01" });
-
isLayer Booleanreadonly
-
Indicates whether a layer can be created from this item using Layer.fromPortalItem().
Exampleif (item.isLayer) { Layer.fromPortalItem({ portalItem: item }).then(addLayerToMap); }
-
isOrgItem BooleanreadonlySince: ArcGIS Maps SDK for JavaScript 4.26
-
Indicates whether this item and the user whose credential was used to fetch this item belong to the same ArcGIS Enterprise Portal or ArcGIS Online Organization.
-
itemControl Stringreadonly
-
Indicates whether an item can be updated and deleted.
Possible Value Description admin The item can be updated or deleted. update The item can be updated, but not deleted. null The item cannot be updated nor deleted. Possible Values:"admin"|"update"|"null"
-
itemPageUrl StringreadonlySince: ArcGIS Maps SDK for JavaScript 4.25
-
The URL to the Item page on the portal.
-
itemUrl Stringreadonly
-
The URL to the item.
-
licenseInfo String
-
Information on license or restrictions related to the item.
-
loaded Booleanreadonly
-
Indicates whether the item's resources have loaded from the portal. When
true
, all the properties of the object can be accessed.- Default Value:false
-
loadError Errorreadonly
-
The Error object returned if an error occurred while loading.
- Default Value:null
-
loadStatus Stringreadonly
-
Represents the status of a load operation.
Value Description not-loaded The object's resources have not loaded. loading The object's resources are currently loading. loaded The object's resources have loaded without errors. failed The object's resources failed to load. See loadError for more details. Possible Values:"not-loaded"|"loading"|"failed"|"loaded"
- Default Value:not-loaded
-
A list of warnings which occurred while loading.
-
modified Date
-
The date the item was last modified.
-
name String
-
The name of the item.
-
numComments Number
-
Number of comments on the item.
-
numRatings Number
-
Number of ratings on the item.
-
numViews Number
-
Number of views on the item.
-
owner String
-
The username of the user who owns this item.
-
ownerFolder StringSince: ArcGIS Maps SDK for JavaScript 4.12
-
The ID of the folder in which the owner has stored the item. This is only returned to the item owner or the org administrator.
-
The portal that contains the item. It uses Portal.getDefault(). This, in turn, obtains the URL from config.portalUrl. It's suggested to use config.portalUrl instead of this property. If needing to work with multiple portal instances, either set the portal's url directly within the PortalItem or create separate portal instances before passing them into the PortalItem.portal property. Both examples are shown below.
Layer.fromPortalItem({ portalItem: { id: "e691172598f04ea8881cd2a4adaa45ba", // autocastable to Portal portal: { url: "https://thePortalUrl" } } });
let portalA = new Portal({ url: "https://www.exampleA.com/arcgis" // First instance }); let portalB = new Portal({ url: "https://www.exampleB.com/arcgis" // Second instance }); let item = new PortalItem({ id: "e691172598f04ea8881cd2a4adaa45ba", portal: portalA // This loads the first portal instance set above }); item.load();
-
Since: ArcGIS Maps SDK for JavaScript 4.8
-
An array of string URLs. These URLs should point to screenshots (i.e. screen captures) associated with an application.
An example value could be something similar to
"screenshots/Basic.png"
.- Default Value:null
-
size Number
-
The size of the item (in bytes).
-
snippet String
-
A summary description of the item.
-
sourceJSON ObjectSince: ArcGIS Maps SDK for JavaScript 4.13
-
The JSON used to create the property values when the
PortalItem
is loaded. Although most commonly used properties are exposed on thePortalItem
class directly, this provides access to all information returned by the portal item. This property is useful if working in an application built using an older version of the API which requires access to a portal's item properties from a more recent version.- See also
-
User defined tags that describe the item.
-
thumbnailUrl Stringreadonly
-
The URL to the thumbnail used for the item.
- See also
-
title String
-
The title for the item. This is the name that is displayed to users and used to refer to the item. Every item must have a title.
-
type String
-
The GIS content type of this item. Example types include Web Map, Map Service, Shapefile, and Web Mapping Application. See the ArcGIS REST API Items and Items Types Reference to get an understanding of the item type hierarchy.
ExamplesportalItem.type = "Web Map";
portalItem.type = "Web Mapping Application";
-
Type keywords that describe the type of content of this item.
-
url String
-
The service URL of this item. Only certain layer item types such as "Feature Service", "Map Service", "Image Service", "Scene Service", "WMS" and "KML" have service URLs.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Promise<PortalRating> | Adds a rating to an accessible item. more details | PortalItem | |
Promise | Adds a new resource to the portal item. more details | PortalItem | |
Cancels a load() operation if it is already in progress. more details | PortalItem | ||
PortalItem | Creates a clone of this object. more details | PortalItem | |
Promise | Deletes a rating for the specified item. more details | PortalItem | |
Destroys the portal item, and any associated resources, including its associated portal. more details | PortalItem | ||
Promise | Requests a PortalItem in the format specified in | PortalItem | |
Promise<PortalRating> | Returns the rating (if any) given to the item. more details | PortalItem | |
Promise<PortalItem[]> | Gets all the related items of a certain relationship type for the portal item. more details | PortalItem | |
Promise<FetchResourcesResult> | Retrieves references to all the portal item resources. more details | PortalItem | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | PortalItem | |
String | Get the URL to the thumbnail image for the item. more details | PortalItem | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Boolean |
| PortalItem | |
Boolean |
| PortalItem | |
Boolean |
| PortalItem | |
Promise | Loads the resources referenced by this class. more details | PortalItem | |
Promise<PortalItem> | Reloads a loaded item's properties from the portal. more details | PortalItem | |
Promise | Removes all the resources from the portal item. more details | PortalItem | |
Removes a group of handles owned by the object. more details | Accessor | ||
Promise | Removes a resource from the portal item. more details | PortalItem | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | PortalItem | |
Promise<PortalItem> | Updates the item's properties to the portal, and optionally its data. more details | PortalItem | |
Promise<PortalItem> | Updates the item's thumbnail on the portal. more details | PortalItem | |
Promise |
| PortalItem |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
addRating(rating){Promise<PortalRating>}
-
Adds a rating to an accessible item.
Parameterrating Number|PortalRatingRating to set for the item. Rating must be a number between 1.0 and 5.0.
ReturnsType Description Promise<PortalRating> When resolved, a PortalRating is returned.
-
addResource(resource, content, options){Promise}Since: ArcGIS Maps SDK for JavaScript 4.16
-
Adds a new resource to the portal item.
ParametersSpecificationresource PortalItemResourceThe resource to add to the portal item.
content BlobThe resource content.
options ObjectoptionalAn object wih the following properties.
Specificationaccess StringoptionalDefault Value: "inherit"Indicates the level of access to the resource. The default is "inherit" which causes the resource to have the same access level as the owning item.
Possible Values:"inherit"|"private"
signal AbortSignaloptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise When resolved, returns the PortalItemResource. - See also
Example// The following snippet assumes you have an existing portal item instance // that you are allowed to modify // An example of an object that we would like to store as a resource const definition = { type: "world", description: "A world definition" }; const resource = new PortalItemResource({ path: "definitions/world.json" }); // Resource content is always passed as a blob. Define a blob that contains our definition // in JSON encoding const content = new Blob([JSON.stringify(definition)], { type: "application/json" }); portalItem.addResource(resource, content) .then(function () { console.log("Successfully added resource", resource.url); }) .catch(function (error) { console.error("Failed to add resource", error); });
-
cancelLoad()
-
Cancels a load() operation if it is already in progress.
-
clone(){PortalItem}Since: ArcGIS Maps SDK for JavaScript 4.12
-
Creates a clone of this object. It is a deep clone except for the
portal
property.ReturnsType Description PortalItem A clone of the PortalItem instance that invoked this method.
-
deleteRating(){Promise}
-
Deletes a rating for the specified item.
ReturnsType Description Promise Resolved when the rating successfully deletes.
-
destroy()Since: ArcGIS Maps SDK for JavaScript 4.17
-
Destroys the portal item, and any associated resources, including its associated portal. These can no longer be used once the portal item has been destroyed. To prevent these objects from being destroyed, remove them from the portal item before calling
destroy()
.// unset the portal from the portal item so that it is not destroyed const portal = portalItem.portal; portalItem.portal = null; // destroy the portal item and any remaining associated resources portalItem.destroy();
-
fetchData(responseType, options){Promise}
-
Requests a PortalItem in the format specified in
responseType
.ParametersresponseType StringoptionalDefault Value: jsonThe format of the response.
Possible Values:"json"|"xml"|"text"|"blob"|"array-buffer"|"document"
options ObjectoptionalAn object with the following properties.
Specificationsignal AbortSignaloptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise When resolved, returns the requested data.
-
fetchRating(options){Promise<PortalRating>}
-
Returns the rating (if any) given to the item.
Parametersoptions ObjectoptionalAn object with the following properties.
Specificationsignal AbortSignaloptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise<PortalRating> When resolved, a PortalRating is returned.
-
fetchRelatedItems(params, options){Promise<PortalItem[]>}
-
Gets all the related items of a certain relationship type for the portal item. An optional direction can be specified if the direction of the relationship is ambiguous. Otherwise, the service will try to infer it.
Parametersparams ObjectSee the object specifications table below for the parameters that may be passed as properties in this object.
SpecificationrelationshipType StringThe type of relationship between the two items. See Relationship types for a complete listing of types.
direction StringThe direction of the relationship. Can either be
forward
(from origin to destination) orreverse
(from destination to origin).Possible Values:"forward"|"reverse"
options ObjectoptionalAn object with the following properties.
Specificationsignal AbortSignaloptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise<PortalItem[]> When resolved, resolves to an array of the related PortalItem. Examplelet queryParam = { relationshipType: "Service2Data" }; portalItem.fetchRelatedItems(queryParam).then(function(results){ console.log("related portal item", results); });
-
fetchResources(params, options){Promise<FetchResourcesResult>}Since: ArcGIS Maps SDK for JavaScript 4.16
-
Retrieves references to all the portal item resources.
Parametersparams FetchResourcesParamsoptionalThe fetch parameters used to retrieve portal item resources.
options ObjectoptionalAdditional options with the following properties.
Specificationsignal AbortSignaloptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise<FetchResourcesResult> Resolves with an object containing the item resources. - See also
ExampleportalItem.fetchResources().then(function(result) { console.log("next start index: ", result.nextStart); result.resources.forEach(function(item) { console.log("resource:", item.resource.path, "size:", item.size); }); });
-
fromJSON(json){*}static
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input
json
parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameterjson ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
ReturnsType Description * Returns a new instance of this class.
-
getThumbnailUrl(width){String}Since: ArcGIS Maps SDK for JavaScript 4.4
-
Get the URL to the thumbnail image for the item.
Available width sizes: 200, 400, 800 and 2400.
Parameterwidth NumberoptionalThe desired image width.
ReturnsType Description String The URL to the thumbnail image.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
isFulfilled(){Boolean}
-
isFulfilled()
may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected(){Boolean}
-
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved(){Boolean}
-
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
load(signal){Promise}
-
Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.
This method must be called by the developer when accessing a resource that will not be loaded in a View.
The
load()
method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.It's possible to provide a
signal
to stop being interested into aLoadable
instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.Parametersignal AbortSignaloptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise Resolves when the resources have loaded.
-
reload(){Promise<PortalItem>}Since: ArcGIS Maps SDK for JavaScript 4.14
-
Reloads a loaded item's properties from the portal.
ReturnsType Description Promise<PortalItem> Resolves when the portal item's properties have been reloaded.
-
removeAllResources(options){Promise}Since: ArcGIS Maps SDK for JavaScript 4.16
-
Removes all the resources from the portal item.
Parametersoptions ObjectoptionalAn object with the following properties.
Specificationsignal AbortSignaloptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise Resolves when all the resources have been removed successfully. - See also
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
removeResource(resource, options){Promise}Since: ArcGIS Maps SDK for JavaScript 4.16
-
Removes a resource from the portal item.
Parametersresource PortalItemResourceThe resource to remove from the portal item.
options ObjectoptionalAn object wih the following properties.
Specificationsignal AbortSignaloptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise Resolves when the remove operation has completed. - See also
-
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.
-
update(params){Promise<PortalItem>}
-
Updates the item's properties to the portal, and optionally its data.
Parametersparams ObjectoptionalSee the object specifications table below for the parameters that may be passed as properties in this object.
Specificationoptional Optional. The component used to stream the data represented by the item to the client.
ReturnsType Description Promise<PortalItem> Resolves when the portal item's properties have been updated.
-
updateThumbnail(params){Promise<PortalItem>}Since: ArcGIS Maps SDK for JavaScript 4.5
-
Updates the item's thumbnail on the portal.
ParametersSpecificationparams ObjectSee the object specification table below for the parameters that may be passed as properties in this object.
SpecificationA URL, Data URI, Blob, or File. The accepted formats are
GIF
,JPG
, andPNG
.filename StringoptionalThe file name used for the thumbnail in thumbnailUrl.
ReturnsType Description Promise<PortalItem> Resolves when the portal item's thumbnail has been updated.
-
when(callback, errback){Promise}Since: ArcGIS Maps SDK for JavaScript 4.6
-
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.Parameterscallback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
ReturnsType Description Promise Returns a new promise for the result of callback
that may be used to chain additional functions.Example// Although this example uses MapView, any class instance that is a promise may use when() in the same way let view = new MapView(); view.when(function(){ // This function will execute once the promise is resolved }, function(error){ // This function will execute if the promise is rejected due to an error });
Type Definitions
-
FetchResource
-
A resource reference returned in the result of fetchResources().
- Properties
-
resource PortalItemResource
The fetched resources.
created DateWhen the resource was created.
size NumberThe size of the resource in bytes.
-
FetchResourcesParams
-
Parameters used when fetching portal item resources using fetchResources().
- Properties
-
num NumberDefault Value:10
The maximum number of results to be included in the result set response. The maximum value allowed is
100
. The start property combined with thenum
property can be used to paginate the search results.start NumberDefault Value:1The index of the first entry in the result set response. The index is 1-based. The start property, along with the num property can be used to paginate the search results.
sortOrder StringDefault Value:ascThe order in which to sort the results.
Possible Value Description asc Sort the results in ascending order. desc Sort the results in descending order. Possible Values:"asc"|"desc"
sortField StringDefault Value:createdA field to sort the results.
Possible Values:"created"|"size"|"type"
-
FetchResourcesResult
-
Object returned when fetchResources() promise resolves.
- Properties
-
resources FetchResource[]
The fetched resources.
nextStart NumberThe next entry index if the current result set doesn't contain all results.
total NumberThe total number of results.