Maintenance Document

Maintenance documents help refresh identifiers between identity graph releases by providing information about identifiers that have been consolidated or need to be relinked by rerunning them through the API. Calls to the Maintenance endpoint return maintenance documents containing maintenance bundles.

All responses return collections of results. These collections contain the document type, change date, and entity type as well as an array of maintenance objects (relinks or consolidations).

• Calls made to the Maintenance endpoint with the "relink" maintenance type parameter return maintenance documents that contain the relink Bundle, which contains the DocID and Link for the input record which should be rerun through the API.
• Calls made to the Maintenance endpoint with the "consolidation" maintenance type parameter return maintenance documents that contain the consolidation Bundle, which contains the active and retired versions of the DocIDs and the Links that should be consolidated.

Each maintenance record will be a single document object.

Sample

Consumer Consolidation Maintenance Document

{
  "maintenance": {
    "maintenanceMetadata": {
      "changeDate": "20180125",
      "entityType": "nameAndEmail",
      "documentType": "person"
    },
    "consolidation": {
      "activeId": "000000US00L1B0noikGKtihuo7EqGheBndFBF9",
      "retiredId": "000000US00kwqJUnO94yRKQDAte8DKydqSOql4",
      "activeLink": "0000US0103KVJPKN",
      "retiredLink": "0000US0101PP5VTL"
    }
  }
}

Relink Maintenance Document
{
  "maintenance": {
    "maintenanceMetadata": {
      "changeDate": "20180125",
      "entityType": "nameAndEmail",
      "documentType": "person"
    },
    "relink": {
      "retiredId": "000000US00XTyTV38YrtdWYNH5At5L3-K7buf3",
      "retiredLink": "0000US020105ZRLQ"
    }
  }
}

NOTE: Sample documents include sample ids and content, and may not include all possible data attributes. This is for illustration purposes only.