Skip to main content

PeaTypeDto

This class provides a lightweight DTO to return a PEA Type instance

    name stringnullable

    The display name of the PEA Type

    version stringnullable

    The version string of this PEA Type. It should follow the syntax of major.minor.patch

    description stringnullable

    This optional string contains detailed information about the PEA Type

    id uuid

    A unique identifier of this instance

    vendor

    object

    A class to return a subset of the information of a vendor object

    name stringnullable

    The display name of the vendor

    website stringnullable

    The official website of the vendor

    comment stringnullable

    An optional comment about the vendor

    id uuid

    A unique identifier of this instance

    mtpProject

    object

    A class to return a subset of the information of an MTP.Project object

    id uuid

    A unique identifier of this instance

    name stringnullable

    The display name of the MTP project

    description stringnullable

    This optional string contains detailed information about the project

    revisions

    object[]

    nullable

    This list contains all MTP.Revision IDs which are part of this project

  • Array [

    • version stringnullable

    The version string. The format should be Major.Minor.Patch

    name stringnullable

    The display name of the revision

    comment stringnullable

    An optional comment about the revision

    id uuid

    A unique identifier of this instance

    uploadTimeUtc date-time

    This date time specify the time when the MTP.Revision was initialized

  • ]

    • instances

    object[]

    nullable

    List of all PEA Instances belonging to this type

  • Array [

    • name stringnullable

    The display name of the PEA Instance

    version stringnullable

    The version string of this PEA Instance. It should follow the syntax of major.minor.patch

    description stringnullable

    This optional string contains detailed information about the PEA Instance

    location

    object

    A abstract parent class of all locations

    id uuid

    A unique identifier of this instance

    name stringnullable

    The display name for the location

    locationType LocationType (string)

    Possible values: [ProcessCell, Area, Site, Enterprise, Unset]

    mtpRevision

    object

    A class to return a subset of the information of an MTP.Revision object

    version stringnullable

    The version string. The format should be Major.Minor.Patch

    name stringnullable

    The display name of the revision

    comment stringnullable

    An optional comment about the revision

    id uuid

    A unique identifier of this instance

    uploadTimeUtc date-time

    This date time specify the time when the MTP.Revision was initialized

    id uuid

    A unique identifier of this instance

    creationDateUtc date-time

    A timestamp of the creation date (UTC)

    currentOpcUaEndpoint stringnullable

    The OPC UA endpoint for this PEA Instance

    currentState NE187State (string)

    Possible values: [InPool, Disconnected, Connected, Mounted, Active, Uncertain, NotAvailable, NotSet, Invalid]

    enum for pea state according to NE187 standard

    lastChangeUtc date-time

    A timestamp for the last change commit (UTC)

  • ]

    • creationDateUtc date-time

    A timestamp of the creation date (UTC)

    lastChangeUtc date-time

    A timestamp for the last change commit (UTC)