OpenMetadata/docs/openmetadata-apis/schemas/entities/report.md

Report Entity

report

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json

Entity that represents a Report

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Allowed	none	report.json

Report entity Type

object [Report entity](report.md)

Report entity Properties

Property	Type	Required	Nullable	Defined by
id	string	Required	cannot be null	Basic type
name	string	Required	cannot be null	Report entity
fullyQualifiedName	string	Optional	cannot be null	Report entity
description	string	Optional	cannot be null	Report entity
href	string	Optional	cannot be null	Basic type
owner	object	Optional	cannot be null	Entity Reference type
service	object	Required	cannot be null	Entity Reference type
usageSummary	object	Optional	cannot be null	Usage Details type

id

Unique id used to identify an entity

id

• is required
• Type: string
• cannot be null
• defined in: Basic type

id Type

string

id Constraints

UUID: the string must be a UUID, according to RFC 4122

name

Name that identifies the this report instance uniquely.

name

• is required
• Type: string
• cannot be null
• defined in: Report entity

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1

fullyQualifiedName

Unique name that identifies a report in the format 'ServiceName.ReportName'

fullyQualifiedName

• is optional
• Type: string
• cannot be null
• defined in: Report entity

fullyQualifiedName Type

string

fullyQualifiedName Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1

description

Description of this report instance.

description

• is optional
• Type: string
• cannot be null
• defined in: Report entity

description Type

string

href

Link to the resource corresponding to this report

Link to the resource

href

• is optional
• Type: string
• cannot be null
• defined in: Basic type

href Type

string

href Constraints

URI: the string must be a URI, according to RFC 3986

owner

Entity reference that includes entity ID and entity type

owner

• is optional
• Type: object [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)
• cannot be null
• defined in: Entity Reference type

owner Type

object [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)

service

Entity reference that includes entity ID and entity type

service

• is required
• Type: object [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)
• cannot be null
• defined in: Entity Reference type

service Type

object [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)

usageSummary

Type used to return usage details of an entity

usageSummary

• is optional
• Type: object [Type used to return usage details of an entity](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/usagedetails.md)
• cannot be null
• defined in: Usage Details type

usageSummary Type

object [Type used to return usage details of an entity](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/usagedetails.md)

report-properties-description

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json#/properties/description

Description of this report instance.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	report.json*

description Type

string

report-properties-fullyqualifiedname

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json#/properties/fullyQualifiedName

Unique name that identifies a report in the format 'ServiceName.ReportName'

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	report.json*

fullyQualifiedName Type

string

fullyQualifiedName Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1

report-properties-name

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json#/properties/name

Name that identifies the this report instance uniquely.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	report.json*

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1