report.md

layout	title
default	Report

report

Report entity Schema

https://github.com/StreamlineData/catalog/blob/master/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 entity Properties

Property	Type	Required	Nullable	Defined by
id	string	Required	cannot be null	Report entity
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	Report entity
owner	object	Optional	cannot be null	Report entity
service	object	Required	cannot be null	Report entity
usageSummary	object	Optional	cannot be null	Report entity

id

Unique id used to identify an entity

id

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

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: Report entity

href Type

string

href Constraints

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

owner

Owner of this pipeline

Entity reference that includes entity ID and entity type

owner

• is optional
• Type: object (Details)
• cannot be null
• defined in: Report entity

owner Type

object (Details)

service

Link to service where this report is hosted in

Entity reference that includes entity ID and entity type

service

• is required
• Type: object (Details)
• cannot be null
• defined in: Report entity

service Type

object (Details)

usageSummary

Latest usage information for this database

Type used to return usage details

usageSummary

• is optional
• Type: object (Details)
• cannot be null
• defined in: Report entity

usageSummary Type

object (Details)