Skip to main content

IngestAssetsSuccessResponse

Response containing the list of ingested assets

assets object[]required

List of ingested assets

  • Array [
    • uidstring

    Unique identifier for the asset (typically UUID)

    Example: 519c00c9-29b1-4e16-8ed2-61bb4a8d6249
    externalIdsstring

    Map of external system identifiers. Values can be null to delete a specific external ID.

    Example: {"CODE":"001"}
    temporaryIdstring
    typestring

    Type of asset

    Example: BUILDING
    namestring
    deletedAtstring

    Date when the asset was deleted. ISO 8601 format

    Example: 2025-11-19T16:30:00Z
    effectiveDatestring

    Date when the asset is effective. ISO 8601 format

    Example: 2024-11-19
    groupedBy object[]

    List of all assets grouping the current asset

  • Array [
    • uidstring
    externalIds object
    property name*string
    temporaryIdstring
  • ]
    • groupingAssetsToAdd object[]

    List of assets to add to list of assets grouping the current asset

  • Array [
    • uidstring
    externalIds object
    property name*string
    temporaryIdstring
  • ]
    • groups object[]

    List of all assets grouped by the current asset

  • Array [
    • uidstring
    externalIds object
    property name*string
    temporaryIdstring
  • ]
    • properties object
    sourcestring
    simple object
    property name*string
    parent object
    uidstring
    externalIds object
    property name*string
    temporaryIdstring
    expirationDatestring
  • ]
    • IngestAssetsSuccessResponse
    {
      "assets": [
        {
          "uid": "519c00c9-29b1-4e16-8ed2-61bb4a8d6249",
          "externalIds": {
            "CODE": "001"
          },
          "temporaryId": "string",
          "type": "BUILDING",
          "name": "string",
          "deletedAt": "2025-11-19T16:30:00Z",
          "effectiveDate": "2024-11-19",
          "groupedBy": [
            {
              "uid": "string",
              "externalIds": {},
              "temporaryId": "string"
            }
          ],
          "groupingAssetsToAdd": [
            {
              "uid": "string",
              "externalIds": {},
              "temporaryId": "string"
            }
          ],
          "groups": [
            {
              "uid": "string",
              "externalIds": {},
              "temporaryId": "string"
            }
          ],
          "properties": {
            "source": "string",
            "simple": {}
          },
          "parent": {
            "uid": "string",
            "externalIds": {},
            "temporaryId": "string"
          },
          "expirationDate": "string"
        }
      ]
    }