RetentionLabel

A retention label for records management

ComplianceData CatalogData ClassificationData GovernanceData Loss PreventionInformation Protection

Properties

Name	Type	Description
id	string
displayName	string
descriptionForAdmins	string
descriptionForUsers	string
isInUse	boolean
retentionTrigger	string
behaviorDuringRetentionPeriod	string
actionAfterRetentionPeriod	string
retentionDuration	object
defaultRecordBehavior	string
labelToBeApplied	string
createdDateTime	string
lastModifiedDateTime	string
createdBy	object
lastModifiedBy	object
retentionEventType	object
descriptors	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RetentionLabel",
  "title": "RetentionLabel",
  "type": "object",
  "description": "A retention label for records management",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "displayName": {
      "type": "string"
    },
    "descriptionForAdmins": {
      "type": "string"
    },
    "descriptionForUsers": {
      "type": "string"
    },
    "isInUse": {
      "type": "boolean",
      "readOnly": true
    },
    "retentionTrigger": {
      "type": "string",
      "enum": [
        "dateLabeled",
        "dateCreated",
        "dateModified",
        "dateOfEvent"
      ]
    },
    "behaviorDuringRetentionPeriod": {
      "type": "string",
      "enum": [
        "doNotRetain",
        "retain",
        "retainAsRecord",
        "retainAsRegulatoryRecord"
      ]
    },
    "actionAfterRetentionPeriod": {
      "type": "string",
      "enum": [
        "none",
        "delete",
        "startDispositionReview"
      ]
    },
    "retentionDuration": {
      "type": "object",
      "properties": {
        "@odata.type": {
          "type": "string"
        },
        "days": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "defaultRecordBehavior": {
      "type": "string",
      "enum": [
        "startLocked",
        "startUnlocked"
      ]
    },
    "labelToBeApplied": {
      "type": "string"
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "createdBy": {
      "$ref": "#/components/schemas/IdentitySet"
    },
    "lastModifiedBy": {
      "$ref": "#/components/schemas/IdentitySet"
    },
    "retentionEventType": {
      "$ref": "#/components/schemas/RetentionEventType"
    },
    "descriptors": {
      "type": "object",
      "properties": {
        "authorityTemplate": {
          "$ref": "#/components/schemas/AuthorityTemplate"
        },
        "categoryTemplate": {
          "$ref": "#/components/schemas/CategoryTemplate"
        },
        "citationTemplate": {
          "$ref": "#/components/schemas/CitationTemplate"
        },
        "departmentTemplate": {
          "$ref": "#/components/schemas/DepartmentTemplate"
        },
        "filePlanReferenceTemplate": {
          "$ref": "#/components/schemas/FilePlanReferenceTemplate"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/microsoft-purview-retentionlabel"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.