Maximo API Client - v0.9.01
    Preparing search index...

    Interface Location

    Interface for location-specific attributes Represents a physical location in Maximo (buildings, rooms, etc.)

    interface Location {
        location: string;
        description?: string;
        type?: string;
        siteid?: string;
        orgid?: string;
        status?: string;
        address?: {
            streetaddress?: string;
            addressline2?: string;
            addressline3?: string;
            city?: string;
            stateprovince?: string;
            postalcode?: string;
            country?: string;
        };
        gpsCoordinates?: {
            latitudey?: number;
            longitudex?: number;
            altitude?: number;
        };
        systems?: string[];
        parent?: string;
        assets?: { assetnum: string; description?: string; status?: string }[];
        children?: Location[];
        locationspec?: {
            assetattrid: string;
            alnvalue?: string;
            numvalue?: number;
            datevalue?: string;
        }[];
        classstructure?: { classstructureid: string; description?: string };
        geoData?: { areaid?: string; zoneid?: string; regionid?: string };
        serviceaddress?: {
            addresscode: string;
            addresstype?: string;
            description?: string;
        };
        isstore?: boolean;
        isinventory?: boolean;
        isrepairfacility?: boolean;
        isoperating?: boolean;
        creationdate?: string;
        createdby?: string;
        changedate?: string;
        changeby?: string;
        href?: string;
        "rdf:about"?: string;
        "dcterms:title"?: string;
        "dcterms:identifier"?: string;
        allowedactions?: AllowedActions;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    location description? type? siteid? orgid? status? address? gpsCoordinates? systems? parent? assets? children? locationspec? classstructure? geoData? serviceaddress? isstore? isinventory? isrepairfacility? isoperating? creationdate? createdby? changedate? changeby? href? rdf:about? dcterms:title? dcterms:identifier? allowedactions?

    Properties

    location: string

    Location identifier

    description?: string

    Description of the location

    type?: string

    Type of location Examples: OPERATING, STORAGE, REPAIR, etc.

    siteid?: string

    Site identifier where the location belongs

    orgid?: string

    Organization identifier that owns the location

    status?: string

    Status of the location Examples: OPERATING, DECOMMISSIONED, etc.

    address?: {
        streetaddress?: string;
        addressline2?: string;
        addressline3?: string;
        city?: string;
        stateprovince?: string;
        postalcode?: string;
        country?: string;
    }

    Physical address of the location

    Type Declaration

    • Optionalstreetaddress?: string

      Street address

    • Optionaladdressline2?: string

      Address line 2

    • Optionaladdressline3?: string

      Address line 3

    • Optionalcity?: string

      City

    • Optionalstateprovince?: string

      State or province

    • Optionalpostalcode?: string

      Postal code

    • Optionalcountry?: string

      Country

    gpsCoordinates?: { latitudey?: number; longitudex?: number; altitude?: number }

    GPS coordinates of the location

    Type Declaration

    • Optionallatitudey?: number

      Latitude coordinate

    • Optionallongitudex?: number

      Longitude coordinate

    • Optionalaltitude?: number

      Altitude or elevation

    systems?: string[]

    Systems at this location

    parent?: string

    Parent location identifier

    assets?: { assetnum: string; description?: string; status?: string }[]

    Assets at this location

    Type Declaration

    • assetnum: string

      Asset identifier

    • Optionaldescription?: string

      Asset description

    • Optionalstatus?: string

      Asset status

    children?: Location[]

    Child locations

    locationspec?: {
        assetattrid: string;
        alnvalue?: string;
        numvalue?: number;
        datevalue?: string;
    }[]

    Location specification attributes

    Type Declaration

    • assetattrid: string

      Attribute name

    • Optionalalnvalue?: string

      Attribute value

    • Optionalnumvalue?: number

      Numeric attribute value

    • Optionaldatevalue?: string

      Date attribute value

    classstructure?: { classstructureid: string; description?: string }

    Location classifications

    Type Declaration

    • classstructureid: string

      Classification ID

    • Optionaldescription?: string

      Classification description

    geoData?: { areaid?: string; zoneid?: string; regionid?: string }

    Geographical information for mapping

    Type Declaration

    • Optionalareaid?: string

      Geographic area code

    • Optionalzoneid?: string

      Zone within the area

    • Optionalregionid?: string

      Geographic region code

    serviceaddress?: {
        addresscode: string;
        addresstype?: string;
        description?: string;
    }

    Service address information

    Type Declaration

    • addresscode: string

      Service address identifier

    • Optionaladdresstype?: string

      Type of service address

    • Optionaldescription?: string

      Description of service address

    isstore?: boolean

    Flag indicating if this is a storeroom location

    isinventory?: boolean

    Flag indicating if this is an inventory location

    isrepairfacility?: boolean

    Flag indicating if this is a repair facility

    isoperating?: boolean

    Flag indicating if this is a operating location

    creationdate?: string

    Creation date of the record

    createdby?: string

    User who created the record

    changedate?: string

    Last modification date

    changeby?: string

    User who last modified the record

    href?: string

    URI that identifies the resource

    "rdf:about"?: string
    "dcterms:title"?: string
    "dcterms:identifier"?: string
    allowedactions?: AllowedActions

    Settings

    Member Visibility

    On This Page

    Properties