Archiving and Recovering a Fact Sheet

You may need to archive Fact Sheets to remove irrelevant or duplicate data from the Inventory. Archiving does not immediately delete a Fact Sheet but removes it from the default Inventory list. You can recover an archived Fact Sheet within the retention period, after which it is permanently deleted. For more information, see Archive and Recover a Fact Sheet in the user documentation.

You can archive or recover a Fact Sheet by updating the status attribute.

To update a Fact Sheet, use the updateFactSheet mutation. id is a required argument for this mutation. To learn how to get the ID of Fact Sheets, see Retrieving Fact Sheets.

Archiving a Fact Sheet

To archive a Fact Sheet, set the status attribute to ARCHIVED and specify a reason for archiving in comment.

Example mutation:

mutation ($patches: [Patch]!) {
  updateFactSheet(id: "4d121f64-116b-4ccc-a292-eb4e4f8d1b24", comment: "Irrelevant application", patches: $patches) {
    factSheet {
      id
      status
    }
  }
}

Variables:

{
  "patches": [
    {
      "op": "add",
      "path": "/status",
      "value": "ARCHIVED"
    }
  ]
}

Example response:

{
  "data": {
    "updateFactSheet": {
      "factSheet": {
        "id": "4d121f64-116b-4ccc-a292-eb4e4f8d1b24",
        "status": "ARCHIVED"
      }
    }
  }
}

Recovering an Archived Fact Sheet

To recover an archived Fact Sheet, set the status attribute to ACTIVE and specify a reason for restoring in comment. You can recover an archived Fact Sheet within the retention period, after which it is permanently deleted.

Example mutation:

mutation ($patches: [Patch]!) {
  updateFactSheet(id: "4d121f64-116b-4ccc-a292-eb4e4f8d1b24", comment: "Recover the application from archive", patches: $patches) {
    factSheet {
      id
      status
    }
  }
}

Variables:

{
  "patches": [
    {
      "op": "add",
      "path": "/status",
      "value": "ACTIVE"
    }
  ]
}

Example response:

{
  "data": {
    "updateFactSheet": {
      "factSheet": {
        "id": "4d121f64-116b-4ccc-a292-eb4e4f8d1b24",
        "status": "ACTIVE"
      }
    }
  }
}