Interface ItemJson

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 can have associated binary or textual data that's available via the item data resource. For example, an item of type Map Package returns the actual bits corresponding to the map package via the item data resource. The numViews is incremented when an item is opened.

See http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Item/02r30000007w000000/.

interface ItemJson {
    access?: string;
    accessInformation?: string;
    advancedSettings?: unknown;
    appCategories?: string[];
    avgRating?: number;
    banner?: string;
    categories?: string[];
    commentsEnabled?: boolean;
    contentOrigin?: string;
    created?: number;
    culture?: string;
    description?: string;
    documentation?: unknown;
    extent?: number[][];
    groupDesignations?: unknown;
    guid?: string;
    id: string;
    industries?: string[];
    isOrgItem?: boolean;
    itemControl?: "update" | "admin";
    languages?: string[];
    largeThumbnail?: string;
    lastViewed?: number;
    licenseInfo?: string;
    listed?: boolean;
    modified?: number;
    name?: string;
    numComments?: number;
    numRatings?: number;
    numViews?: number;
    orgId?: string;
    owner?: string;
    ownerFolder?: string;
    properties?: string;
    protected?: boolean;
    proxyFilter?: Record<string, unknown>;
    scoreCompleteness?: number;
    screenshots?: string[];
    size?: number;
    snippet?: string;
    spatialReference?: SpatialReferenceJson;
    subInfo?: number;
    tags?: string[];
    thumbnail?: string;
    title?: string;
    type?: string;
    typeKeywords?: string[];
    url?: string;
}

Properties

access? accessInformation? advancedSettings? appCategories? avgRating? banner? categories? commentsEnabled? contentOrigin? created? culture? description? documentation? extent? groupDesignations? guid? id industries? isOrgItem? itemControl? languages? largeThumbnail? lastViewed? licenseInfo? listed? modified? name? numComments? numRatings? numViews? orgId? owner? ownerFolder? properties? protected? proxyFilter? scoreCompleteness? screenshots? size? snippet? spatialReference? subInfo? tags? thumbnail? title? type? typeKeywords? url?

Properties

Optionalaccess

access?: string

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

OptionalaccessInformation

accessInformation?: string

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

OptionaladvancedSettings

advancedSettings?: unknown

.

OptionalappCategories

appCategories?: string[]

An array that primarily applies to a list of categories that the application item is applicable to.

OptionalavgRating

avgRating?: number

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

Optionalbanner

banner?: string

Primarily applies to the banner associated with an application. The URL to the banner used for the application.

Optionalcategories

categories?: string[]

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

OptionalcommentsEnabled

commentsEnabled?: boolean

Indicates if comments are allowed on the item.

OptionalcontentOrigin

contentOrigin?: string

.

Optionalcreated

created?: number

The date the item was created. Shown in UNIX time in milliseconds.

Optionalculture

culture?: string

The item locale information (language and country).

Optionaldescription

description?: string

Item description.

Optionaldocumentation

documentation?: unknown

.

Optionalextent

extent?: number[][]

The bounding rectangle of the item. Should always be in WGS84.

OptionalgroupDesignations

groupDesignations?: unknown

.

Optionalguid

guid?: string

.

id

id: string

The unique ID for this item.

Optionalindustries

industries?: string[]

Primarily applies to industries associated with the application.

OptionalisOrgItem

isOrgItem?: boolean

.

OptionalitemControl

itemControl?: "update" | "admin"

Indicates user's control to the item.

Values: admin (for item owner and org admin) | update (for members of groups with item update capability that the item is shared with).

Optionallanguages

languages?: string[]

Primarily applies to languages associated with the application.

OptionallargeThumbnail

largeThumbnail?: string

Primarily applies to thumbnails associated with an application. The URL to the thumbnail used for the application.

OptionallastViewed

lastViewed?: number

The date/time the item was last accessed in UNIX format (in milliseconds).

OptionallicenseInfo

licenseInfo?: string

Any license information or restrictions.

Optionallisted

listed?: boolean

Primarily applies to the banner associated with an application. The URL to the banner used for the application.

Optionalmodified

modified?: number

The date the item was last modified. Shown in UNIX time in milliseconds.

Optionalname

name?: string

The file name of the item for file types. Read-only.

OptionalnumComments

numComments?: number

Number of comments on the item.

OptionalnumRatings

numRatings?: number

Number of ratings on the item.

OptionalnumViews

numViews?: number

Number of views of the item.

OptionalorgId

orgId?: string

.

Optionalowner

owner?: string

The username of the user who owns this item.

OptionalownerFolder

ownerFolder?: string

The ID of the folder in which the owner has stored the item. The property is only returned to the item owner or the org admin.

Optionalproperties

properties?: string

A JSON object that primarily applies to system requirements, Terms and Conditions, version, supported platforms, YouTube video ID, etc associated with the application.

Optionalprotected

protected?: boolean

Protects the item from deletion. False is the default.

OptionalproxyFilter

proxyFilter?: Record<string, unknown>

A JSON object used to restrict service item response results based on specified filter, i.e. limit results returned from a geocode service based on defined filters.See serviceProxyFilter for object details.

OptionalscoreCompleteness

scoreCompleteness?: number

Item information completeness score based upon item snippet, thumbnail, description, title, tags etc.

Optionalscreenshots

screenshots?: string[]

Primarily applies to screenshots associated with an application. The URL to the screenshots used for the application.

Optionalsize

size?: number

The size of the item.

Optionalsnippet

snippet?: string

A short summary description of the item.

OptionalspatialReference

spatialReference?: SpatialReferenceJson

The coordinate system of the item.

OptionalsubInfo

subInfo?: number

.

Optionaltags

tags?: string[]

User defined tags that describe the item.

Optionalthumbnail

thumbnail?: string

The URL to the thumbnail used for the item.

Optionaltitle

title?: string

The title of the item. This is the name that's displayed to users and by which they refer to the item. Every item must have a title.

Optionaltype

type?: string

The GIS content type of this item. Example types include Web Map, Map Service, Shapefile, and Web Mapping Application. See http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#//02r3000000ms000000.

OptionaltypeKeywords

typeKeywords?: string[]

A set of keywords that further describes the type of this item. Each item is tagged with a set of type keywords that are derived based on its primary type.

Optionalurl

url?: string

The URL for the resource represented by the item. Applies only to items that represent web-accessible resources such as map services.

Settings

Member Visibility

On This Page

Properties