PortalItem | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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.

See also

Constructors

PortalItem Constructor new PortalItem(properties)

Parameter

properties Object

optional

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

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	Indicates the level of access to this item: `private`, `shared`, `org`, or `public`.	PortalItem
String	Information on the source of the item and its copyright status.	PortalItem
String	An authorization string used to access the portal item.	PortalItem
Object []	Contains an array of objects containing proxy information for premium platform services.	PortalItem
Number	Average rating.	PortalItem
String []	An array of organization categories that are set on the item.	PortalItem
HashMap<any>	The classification information for the item.	PortalItem
Date	The date the item was created.	PortalItem
String	The item's locale information (language and country).	PortalItem
String	The name of the class.	Accessor
String	The detailed description of the item.	PortalItem
Extent	The geographic extent, or bounding rectangle, of the item.	PortalItem
String []	An array of group categories set on the item.	PortalItem
String	The unique id for the item.	PortalItem
Boolean	Indicates whether a layer can be created from this item using Layer.fromPortalItem().	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.	PortalItem
String	Indicates whether an item can be updated and deleted.	PortalItem
String	The URL to the Item page on the portal.	PortalItem
String	The URL to the item.	PortalItem
String	Information on license or restrictions related to the item.	PortalItem
Error	The Error object returned if an error occurred while loading.	PortalItem
String	Represents the status of a load operation.	PortalItem
Object []	A list of warnings which occurred while loading.	PortalItem
Boolean	Indicates whether the item's resources have loaded from the portal.	PortalItem
Date	The date the item was last modified.	PortalItem
String	The name of the item.	PortalItem
Number	Number of comments on the item.	PortalItem
Number	Number of ratings on the item.	PortalItem
Number	Number of views on the item.	PortalItem
String	The username of the user who owns this item.	PortalItem
String	The ID of the folder in which the owner has stored the item.	PortalItem
Portal	The portal that contains the item.	PortalItem
String []	An array of string URLs.	PortalItem
Number	The size of the item (in bytes).	PortalItem
String	A summary description of the item.	PortalItem
Object	The JSON used to create the property values when the `PortalItem` is loaded.	PortalItem
String []	User defined tags that describe the item.	PortalItem
String	The URL to the thumbnail used for the item.	PortalItem
String	The title for the item.	PortalItem
String	The GIS content type of this item.	PortalItem
String []	Type keywords that describe the type of content of this item.	PortalItem
String	The service URL of this item.	PortalItem

Property Details

access Property access String

Indicates the level of access to this item: private, shared, org, or public.

Possible Values:"private" |"shared" |"org" |"public"

accessInformation Property accessInformation String

Information on the source of the item and its copyright status.

apiKey Property apiKey String Since: ArcGIS Maps SDK for JavaScript 4.20 PortalItem since 4.0, apiKey added at 4.20.

An authorization string used to access the portal item. API keys are generated and managed in the portal. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage.

applicationProxies Property applicationProxies Object[]readonly Since: ArcGIS Maps SDK for JavaScript 4.8 PortalItem since 4.0, applicationProxies added at 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.

Properties: sourceUrl String

The URL of the premium map service layer.

proxyUrl String

The proxy URL for the source URL.

proxyId String

The proxy ID registered in ArcGIS Online or ArcGIS Enterprise Portal.

avgRating Property avgRating Number

Average rating. Uses a weighted average called "Bayesian average."

categories Property categories String[] Since: ArcGIS Maps SDK for JavaScript 4.8 PortalItem since 4.0, categories added at 4.8.

An array of organization categories that are set on the item.

classification Property classification HashMap<any> Since: ArcGIS Maps SDK for JavaScript 4.31 PortalItem since 4.0, classification added at 4.31.

The classification information for the item.

created Property created Date

The date the item was created.

culture Property culture String

The item's locale information (language and country).

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

The name of the class. The declared class name is formatted as esri.folder.className.

description Property description String

The detailed description of the item.

extent Property extent Extent

The geographic extent, or bounding rectangle, of the item.

groupCategories Property groupCategories String[] Since: ArcGIS Maps SDK for JavaScript 4.8 PortalItem since 4.0, groupCategories added at 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 Property 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 Property isLayer Booleanreadonly

Indicates whether a layer can be created from this item using Layer.fromPortalItem().

Example

if (item.isLayer) {
  Layer.fromPortalItem({
    portalItem: item
  }).then(addLayerToMap);
}

isOrgItem Property isOrgItem Booleanreadonly Since: ArcGIS Maps SDK for JavaScript 4.26 PortalItem since 4.0, isOrgItem added at 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 Property 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 Property itemPageUrl Stringreadonly Since: ArcGIS Maps SDK for JavaScript 4.25 PortalItem since 4.0, itemPageUrl added at 4.25.

The URL to the Item page on the portal.

itemUrl Property itemUrl Stringreadonly

The URL to the item.

licenseInfo Property licenseInfo String

Information on license or restrictions related to the item.

loadError Property loadError Errorreadonly

The Error object returned if an error occurred while loading.

Default Value:null

loadStatus Property 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"

loadWarnings Property loadWarnings Object[]readonly

A list of warnings which occurred while loading.

loaded Property 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

modified Property modified Date

The date the item was last modified.

name Property name String

The name of the item.

numComments Property numComments Number

Number of comments on the item.

numRatings Property numRatings Number

Number of ratings on the item.

numViews Property numViews Number

Number of views on the item.

owner Property owner String

The username of the user who owns this item.

ownerFolder Property ownerFolder String Since: ArcGIS Maps SDK for JavaScript 4.12 PortalItem since 4.0, ownerFolder added at 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.

portal Property portal Portalautocast

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();

screenshots Property screenshots String[] Since: ArcGIS Maps SDK for JavaScript 4.8 PortalItem since 4.0, screenshots added at 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 Property size Number

The size of the item (in bytes).

snippet Property snippet String

A summary description of the item.

sourceJSON Property sourceJSON Object Since: ArcGIS Maps SDK for JavaScript 4.13 PortalItem since 4.0, sourceJSON added at 4.13.

The JSON used to create the property values when the PortalItem is loaded. Although most commonly used properties are exposed on the PortalItem 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

ArcGIS REST API - Item

tags Property tags String[]

User defined tags that describe the item.

thumbnailUrl Property thumbnailUrl Stringreadonly

The URL to the thumbnail used for the item.

See also

getThumbnailUrl()

title Property 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 Property 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.

Examples

portalItem.type = "Web Map";

portalItem.type = "Web Mapping Application";

typeKeywords Property typeKeywords String[]

Type keywords that describe the type of content of this item.

url Property 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

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Promise<PortalRating>	Adds a rating to an accessible item.	PortalItem
Promise	Adds a new resource to the portal item.	PortalItem
	Cancels a load() operation if it is already in progress.	PortalItem
PortalItem	Creates a clone of this object.	PortalItem
Promise	Deletes a rating for the specified item.	PortalItem
	Destroys the portal item, and any associated resources, including its associated portal.	PortalItem
Promise	Requests a PortalItem in the format specified in `responseType`.	PortalItem
Promise<PortalRating>	Returns the rating (if any) given to the item.	PortalItem
Promise<PortalItem []>	Gets all the related items of a certain relationship type for the portal item.	PortalItem
Promise<FetchResourcesResult>	Retrieves references to all the portal item resources.	PortalItem
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	PortalItem
String	Get the URL to the thumbnail image for the item.	PortalItem
Boolean	Returns true if a named group of handles exist.	Accessor
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).	PortalItem
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected.	PortalItem
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved.	PortalItem
Promise	Loads the resources referenced by this class.	PortalItem
Promise<PortalItem>	Reloads a loaded item's properties from the portal.	PortalItem
Promise	Removes all the resources from the portal item.	PortalItem
	Removes a group of handles owned by the object.	Accessor
Promise	Removes a resource from the portal item.	PortalItem
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	PortalItem
Promise<PortalItem>	Updates the item's properties to the portal, and optionally its data.	PortalItem
Promise<PortalItem>	Updates the item's thumbnail on the portal.	PortalItem
Promise	`when()` may be leveraged once an instance of the class is created.	PortalItem

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key 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 Method addRating(rating){Promise<PortalRating>}

Adds a rating to an accessible item.

Parameter

rating Number|PortalRating

Rating to set for the item. Rating must be a number between 1.0 and 5.0.

Returns

Type	Description
Promise<PortalRating>	When resolved, a PortalRating is returned.

addResource Method addResource(resource, content, options){Promise} Since: ArcGIS Maps SDK for JavaScript 4.16 PortalItem since 4.0, addResource added at 4.16.

Adds a new resource to the portal item.

Parameters

Specification

resource PortalItemResource

The resource to add to the portal item.

content Blob

The resource content.

options Object

optional

An object wih the following properties.

Specification

access String

optional

Default 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 AbortSignal

optional

Signal 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.

Returns

Type	Description
Promise	When resolved, returns the PortalItemResource.

See also

ArcGIS REST API - Add Resources

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 Method cancelLoad()

Cancels a load() operation if it is already in progress.

clone Method clone(){PortalItem} Since: ArcGIS Maps SDK for JavaScript 4.12 PortalItem since 4.0, clone added at 4.12.

Creates a clone of this object. It is a deep clone except for the portal property.

Returns

Type	Description
PortalItem	A clone of the PortalItem instance that invoked this method.

deleteRating Method deleteRating(){Promise}

Deletes a rating for the specified item.

Returns

Type	Description
Promise	Resolved when the rating successfully deletes.

destroy Method destroy() Since: ArcGIS Maps SDK for JavaScript 4.17 PortalItem since 4.0, destroy added at 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();

See also

fetchData Method fetchData(responseType, options){Promise}

Requests a PortalItem in the format specified in responseType.

Parameters

responseType String

optional

Default Value: json

The format of the response.

options Object

optional

An object with the following properties.

Specification

signal AbortSignal

optional

Returns

Type	Description
Promise	When resolved, returns the requested data.

fetchRating Method fetchRating(options){Promise<PortalRating>}

Returns the rating (if any) given to the item.

Parameters

options Object

optional

An object with the following properties.

Specification

signal AbortSignal

optional

Returns

Type	Description
Promise<PortalRating>	When resolved, a PortalRating is returned.

fetchRelatedItems Method 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.

Parameters

params Object

See the object specifications table below for the parameters that may be passed as properties in this object.

Specification

relationshipType String

The type of relationship between the two items. See Relationship types for a complete listing of types.

direction String

The direction of the relationship. Can either be forward (from origin to destination) or reverse (from destination to origin).

Possible Values:"forward"|"reverse"

options Object

optional

An object with the following properties.

Specification

signal AbortSignal

optional

Returns

Type	Description
Promise<PortalItem []>	When resolved, resolves to an array of the related PortalItem.

Example

let queryParam = {
   relationshipType: "Service2Data"
};

portalItem.fetchRelatedItems(queryParam).then(function(results){
   console.log("related portal item", results);
});

fetchResources Method fetchResources(params, options){Promise<FetchResourcesResult>} Since: ArcGIS Maps SDK for JavaScript 4.16 PortalItem since 4.0, fetchResources added at 4.16.

Retrieves references to all the portal item resources.

Parameters

params FetchResourcesParams

optional

The fetch parameters used to retrieve portal item resources.

options Object

optional

Additional options with the following properties.

Specification

signal AbortSignal

optional

Returns

Type	Description
Promise<FetchResourcesResult>	Resolves with an object containing the item resources.

See also

ArcGIS REST API- Item Resources

Example

portalItem.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 Method 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.

Parameter

json Object

A 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.

Returns

Type	Description
*	Returns a new instance of this class.

getThumbnailUrl Method getThumbnailUrl(width){String} Since: ArcGIS Maps SDK for JavaScript 4.4 PortalItem since 4.0, getThumbnailUrl added at 4.4.

Get the URL to the thumbnail image for the item.

Available width sizes: 200, 400, 800 and 2400.

Parameter

width Number

optional

The desired image width.

Returns

Type	Description
String	The URL to the thumbnail image.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	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 Method 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.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected Method 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.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved Method 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.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

load Method 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 a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.

Parameter

signal AbortSignal

optional

Returns

Type	Description
Promise	Resolves when the resources have loaded.

reload Method reload(){Promise<PortalItem>} Since: ArcGIS Maps SDK for JavaScript 4.14 PortalItem since 4.0, reload added at 4.14.

Reloads a loaded item's properties from the portal.

Returns

Type	Description
Promise<PortalItem>	Resolves when the portal item's properties have been reloaded.

removeAllResources Method removeAllResources(options){Promise} Since: ArcGIS Maps SDK for JavaScript 4.16 PortalItem since 4.0, removeAllResources added at 4.16.

Removes all the resources from the portal item.

Parameters

options Object

optional

An object with the following properties.

Specification

signal AbortSignal

optional

Returns

Type	Description
Promise	Resolves when all the resources have been removed successfully.

See also

ArcGIS REST API - Remove Resources

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

removeResource Method removeResource(resource, options){Promise} Since: ArcGIS Maps SDK for JavaScript 4.16 PortalItem since 4.0, removeResource added at 4.16.

Removes a resource from the portal item.

Parameters

resource PortalItemResource

The resource to remove from the portal item.

options Object

optional

An object wih the following properties.

Specification

signal AbortSignal

optional

Returns

Type	Description
Promise	Resolves when the remove operation has completed.

See also

ArcGIS REST API - Remove Resources

toJSON Method toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.

update Method update(params){Promise<PortalItem>}

Updates the item's properties to the portal, and optionally its data.

Parameters

params Object

optional

See the object specifications table below for the parameters that may be passed as properties in this object.

Specification

data String|Object

optional

Optional. The component used to stream the data represented by the item to the client.

Returns

Type	Description
Promise<PortalItem>	Resolves when the portal item's properties have been updated.

updateThumbnail Method updateThumbnail(params){Promise<PortalItem>} Since: ArcGIS Maps SDK for JavaScript 4.5 PortalItem since 4.0, updateThumbnail added at 4.5.

Updates the item's thumbnail on the portal.

Parameters

Specification

params Object

See the object specification table below for the parameters that may be passed as properties in this object.

Specification

thumbnail Blob|String

A URL, Data URI, Blob, or File. The accepted formats are GIF, JPG, and PNG.

filename String

optional

The file name used for the thumbnail in thumbnailUrl.

Returns

Type	Description
Promise<PortalItem>	Resolves when the portal item's thumbnail has been updated.

when Method when(callback, errback){Promise} Since: ArcGIS Maps SDK for JavaScript 4.6 PortalItem since 4.0, when added at 4.6.

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

callback Function

optional

The function to call when the promise resolves.

errback Function

optional

The function to execute when the promise fails.

Returns

Type	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 Type Definition FetchResource

A resource reference returned in the result of fetchResources().

Properties: resource PortalItemResource

Relative path of the resource.

created Date

When the resource was created.

size Number

The size of the resource in bytes.

FetchResourcesParams Type Definition FetchResourcesParams

Parameters used when fetching portal item resources using fetchResources().

Properties: num Number

optional
Default 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 the num property can be used to paginate the search results.

start Number

optional
Default Value:1

The 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 String

optional
Default Value:asc

The 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 String

optional
Default Value:resource

A field to sort the results.

Possible Values:"created"|"size"|"resource"

FetchResourcesResult Type Definition FetchResourcesResult

Object returned when fetchResources() promise resolves.

Properties: resources FetchResource []

The fetched resources.

nextStart Number

The next entry index if the current result set doesn't contain all results.

total Number

The total number of results.