@esri/arcgis-rest-portal/dist/esm/helpers.d.ts

ArcGIS Online and Enterprise content and user helpers for @esri/arcgis-rest-request

import { ISpatialReference } from "@esri/arcgis-rest-request";
/**
 * A Portal [Item](https://developers.arcgis.com/rest/users-groups-and-items/common-parameters.htm) that has not been created yet.
 */
export interface IItemAdd {
    title: string;
    type: string;
    owner?: string;
    orgId?: string;
    typeKeywords?: string[];
    description?: string;
    snippet?: string;
    documentation?: string;
    extent?: number[][];
    categories?: string[];
    spatialReference?: ISpatialReference;
    culture?: string;
    properties?: any;
    url?: string;
    tags?: string[];
    access?: string;
    accessInformation?: string;
    licenseInfo?: string;
    [key: string]: any;
}
/**
 * A Portal [Item](https://developers.arcgis.com/rest/users-groups-and-items/common-parameters.htm) to be updated.
 */
export interface IItemUpdate {
    id: string;
    [key: string]: any;
}
/**
 * Existing Portal [Item](https://developers.arcgis.com/rest/users-groups-and-items/item.htm).
 */
export interface IItem extends IItemAdd {
    id: string;
    owner: string;
    tags: string[];
    created: number;
    modified: number;
    numViews: number;
    size: number;
    protected?: boolean;
}
/**
 * Used for organizing content. See [Create Folder](https://developers.arcgis.com/rest/users-groups-and-items/create-folder.htm) for more details.
 */
export interface IFolder {
    username: string;
    id: string;
    title: string;
    created?: number;
}
/**
 * Params for paging operations
 */
export interface IPagingParams {
    start?: number;
    num?: number;
}
/**
 * Paging properties for paged responses.
 */
export interface IPagedResponse extends IPagingParams {
    /** total number of object across all pages */
    total: number;
    /** next entry index or -1 for the last page */
    nextStart: number;
}
/**
 * Response from the portals/Self/isServiceNameAvailable request
 */
export interface IServiceNameAvailable {
    available: boolean;
}