Skip to main content

IngestAssetsSuccessResponse

Response containing the list of ingested assets

assets object[]required

List of ingested assets

  • Array [
    • uidstring | nullnullable

    Unique identifier for the asset (typically UUID)

    Default value:
    Example: 519c00c9-29b1-4e16-8ed2-61bb4a8d6249
    externalIds object | null

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

    property name*string
    temporaryIdstring | nullnullable
    typestring | nullnullable

    Type of asset

    Default value:
    Example: BUILDING
    namestring | nullnullable
    deletedAtstring | nullnullable

    Date when the asset was deleted. ISO 8601 format

    Default value:
    Example: 2025-11-19T16:30:00Z
    effectiveDatestring | nullnullable

    Date when the asset is effective. ISO 8601 format

    Default value:
    Example: 2024-11-19
    groupedBy object[]

    List of all assets grouping the current asset

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

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

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

    List of all assets grouped by the current asset

  • Array [
    • uidstring | nullnullable
    externalIds object | null
    property name*string
    temporaryIdstring | nullnullable
  • ]
    • properties object
    oneOf
    sourcestring | nullnullable
    simple object | null
    property name*string
    precise string | null

    Each key represents the code of a property, mapped to its corresponding list of time-based values

    property name* UpsertPublicAssetPrecisePropertiesDatum
    rawValuestringrequired
    startDate object
    oneOf
    valuedaterequired
    isMinSystemDatebooleanrequired
    endDate object
    oneOf
    valuedaterequired
    parent object
    oneOf
    uidstring | nullnullable
    externalIds object | null
    property name*string
    temporaryIdstring | nullnullable
    expirationDatestring | nullnullable
  • ]
    • issues object[]required

    Diagnostics raised while processing the ingest (warnings, errors, info). Empty when there is nothing to report.

  • Array [
    • severitystringrequired

    Severity level of this issue

    Possible values: [WARNING, ERROR]

    Default value:
    asset objectrequired

    Identifiers of the affected input asset, echoed from the request

    uidstring | nullnullable
    externalIds object | null
    property name*string
    temporaryIdstring | nullnullable
    codestringrequired

    Stable machine-readable issue code

    Default value:
    Example: PROPERTY_NOT_APPLICABLE_TO_TYPE
    fieldstring | nullnullable

    JSON-pointer-like path to the offending input field, when applicable

    Default value:
    Example: properties.precise[ADDRESS]
    messagestringrequired

    Human-readable description of the issue

    Default value:
    Example: Property 'ADDRESS' is not applicable to type 'PLAN|INDOOR'
  • ]
    • 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": "",
          "groupingAssetsToAdd": "",
          "groups": "",
          "properties": {
            "source": "string",
            "simple": "Unknown Type: object,null",
            "precise": {
              "TAUX_ROTATION_ANNUEL": [
                {
                  "startDate": "2020-01-02",
                  "endDate": "2024-01-03",
                  "rawValue": "17,00"
                }
              ]
            }
          },
          "parent": {
            "uid": "string",
            "externalIds": "Unknown Type: object,null",
            "temporaryId": "string"
          },
          "expirationDate": "string"
        }
      ],
      "issues": [
        {
          "severity": "WARNING",
          "asset": {
            "uid": "string",
            "externalIds": "Unknown Type: object,null",
            "temporaryId": "string"
          },
          "code": "PROPERTY_NOT_APPLICABLE_TO_TYPE",
          "field": "properties.precise[ADDRESS]",
          "message": "Property 'ADDRESS' is not applicable to type 'PLAN|INDOOR'"
        }
      ]
    }