Skip to main content

PeaTypeDto

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

namestringnullable

The display name of the PEA Type

versionstringnullable

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

descriptionstringnullable

This optional string contains detailed information about the PEA Type

iduuid

A unique identifier of this instance

vendor object

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

namestringnullable

The display name of the vendor

websitestringnullable

The official website of the vendor

commentstringnullable

An optional comment about the vendor

iduuid

A unique identifier of this instance

mtpProject object

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

iduuid

A unique identifier of this instance

namestringnullable

The display name of the MTP project

descriptionstringnullable

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 [
  • versionstringnullable

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

    namestringnullable

    The display name of the revision

    commentstringnullable

    An optional comment about the revision

    iduuid

    A unique identifier of this instance

    uploadTimeUtcdate-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 [
  • namestringnullable

    The display name of the PEA Instance

    versionstringnullable

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

    descriptionstringnullable

    This optional string contains detailed information about the PEA Instance

    location object

    A abstract parent class of all locations

    iduuid

    A unique identifier of this instance

    namestringnullable

    The display name for the location

    locationTypeLocationType (string)

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

    mtpRevision object

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

    versionstringnullable

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

    namestringnullable

    The display name of the revision

    commentstringnullable

    An optional comment about the revision

    iduuid

    A unique identifier of this instance

    uploadTimeUtcdate-time

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

    iduuid

    A unique identifier of this instance

    creationDateUtcdate-time

    A timestamp of the creation date (UTC)

    currentOpcUaEndpointstringnullable

    The OPC UA endpoint for this PEA Instance

    currentStateNE187State (string)

    enum for pea state according to NE187 standard

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

    lastChangeUtcdate-time

    A timestamp for the last change commit (UTC)

  • ]
  • creationDateUtcdate-time

    A timestamp of the creation date (UTC)

    lastChangeUtcdate-time

    A timestamp for the last change commit (UTC)

    PeaTypeDto
    {
    "name": "string",
    "version": "string",
    "description": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "vendor": {
    "name": "string",
    "website": "string",
    "comment": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "mtpProject": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "revisions": [
    {
    "version": "string",
    "name": "string",
    "comment": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "uploadTimeUtc": "2024-07-29T15:51:28.071Z"
    }
    ]
    },
    "instances": [
    {
    "name": "string",
    "version": "string",
    "description": "string",
    "location": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "locationType": "ProcessCell"
    },
    "mtpRevision": {
    "version": "string",
    "name": "string",
    "comment": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "uploadTimeUtc": "2024-07-29T15:51:28.071Z"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "creationDateUtc": "2024-07-29T15:51:28.071Z",
    "currentOpcUaEndpoint": "string",
    "currentState": "InPool",
    "lastChangeUtc": "2024-07-29T15:51:28.071Z"
    }
    ],
    "creationDateUtc": "2024-07-29T15:51:28.071Z",
    "lastChangeUtc": "2024-07-29T15:51:28.071Z"
    }