addedOutput schema / properties / family
Added value: +{
+ "additionalProperties": false,
+ "properties": {
+ "applicationCount": {
+ "description": "Accessible saved application records in this group, including the selected record",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "coverage": {
+ "const": "unverified",
+ "type": "string"
+ },
+ "groupingKey": {
+ "description": "Representative accessible document key for grouping saved records; can change with links or access, not a global family ID",
+ "type": "string"
+ },
+ "members": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "applicationNumber": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "applicationType": {
+ "type": "string"
+ },
+ "documentId": {
+ "type": "string"
+ },
+ "filingDate": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "publicationNumber": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "recordedStatus": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "refNum": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "region": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "relationship": {
+ "enum": [
+ "self",
+ "parent",
+ "child",
+ "other_related"
+ ],
+ "type": "string"
+ },
+ "title": {
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "documentId",
+ "title",
+ "refNum",
+ "applicationType",
+ "region",
+ "applicationNumber",
+ "publicationNumber",
+ "filingDate",
+ "recordedStatus",
+ "relationship"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "membersTruncated": {
+ "type": "boolean"
+ },
+ "priorityDate": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priorityDateSource": {
+ "enum": [
+ "imported",
+ "earliest_saved_priority_filing",
+ "unknown"
+ ],
+ "type": "string"
+ },
+ "recordedPublicationCount": {
+ "description": "Distinct publication numbers recorded on these applications, not all publications or inventions",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "refresh": {
+ "additionalProperties": false,
+ "properties": {
+ "ambiguousReferenceCount": {
+ "anyOf": [
+ {
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "assessment": {
+ "description": "Read-only assessment of this record’s stored references. Missing links have accessible saved matches. Unresolved references need investigation; unknown and no_known_gap do not establish complete coverage.",
+ "enum": [
+ "missing_links",
+ "unresolved_references",
+ "unknown",
+ "no_known_gap",
+ "unsupported"
+ ],
+ "type": "string"
+ },
+ "eligible": {
+ "description": "Whether this own record has a usable publication number; does not establish write permission",
+ "type": "boolean"
+ },
+ "lastRefreshedAt": {
+ "description": "Last recorded explicit provider family refresh; null means the refresh date is unknown",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "missingLinkCount": {
+ "anyOf": [
+ {
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "references": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "applicationNumber": {
+ "type": "string"
+ },
+ "direction": {
+ "enum": [
+ "parent",
+ "child"
+ ],
+ "type": "string"
+ },
+ "documentId": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "publicationNumber": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "status": {
+ "enum": [
+ "linked",
+ "missing_link",
+ "unmatched",
+ "ambiguous"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "direction",
+ "applicationNumber",
+ "publicationNumber",
+ "status",
+ "documentId"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "referencesAvailable": {
+ "type": "boolean"
+ },
+ "referencesTruncated": {
+ "type": "boolean"
+ },
+ "unmatchedReferenceCount": {
+ "anyOf": [
+ {
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": [
+ "eligible",
+ "assessment",
+ "referencesAvailable",
+ "lastRefreshedAt",
+ "missingLinkCount",
+ "unmatchedReferenceCount",
+ "ambiguousReferenceCount",
+ "references",
+ "referencesTruncated"
+ ],
+ "type": "object"
+ },
+ "regions": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "scope": {
+ "const": "accessible_saved_records",
+ "type": "string"
+ }
+ },
+ "required": [
+ "groupingKey",
+ "scope",
+ "applicationCount",
+ "recordedPublicationCount",
+ "regions",
+ "priorityDate",
+ "priorityDateSource",
+ "members",
+ "membersTruncated",
+ "coverage",
+ "refresh"
+ ],
+ "type": "object"
+}