Domains

Get a dataProduct by name

Get a dataProduct by name.

get/v1/dataProducts/name/{name}

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/dataProducts/name/{name}
  • Auth: HTTP bearer

Path parameters

namestring required

Name of the dataProduct

Query parameters

fieldsstring
Example:domains,owners,reviewers,experts,extension,tags,followers,votes,certification

Fields requested in the returned resource

Response

dataProduct

idstring uuid required
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring required
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
hrefstring uri
lifecycleStage'IDEATION' | 'DESIGN' | 'DEVELOPMENT' | 'TESTING' | 'PRODUCTION' | 'DEPRECATED' | 'RETIRED'
dataProductType'RAW_DATA' | 'DERIVED_DATA' | 'DATASET' | 'REPORTS' | 'ANALYTIC_VIEW' | 'VISUALISATION_3D' | 'ALGORITHM' | 'DECISION_SUPPORT' | 'AUTOMATED_DECISION_MAKING' | 'DATA_ENHANCED_PRODUCT' | 'DATA_DRIVEN_SERVICE' | 'DATA_ENABLED_PERFORMANCE' | 'BI_DIRECTIONAL'
visibility'PRIVATE' | 'INVITATION' | 'ORGANISATION' | 'DATASPACE' | 'PUBLIC'
portfolioPriority'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW'
extensionobject
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'
deletedboolean
sourceHashstring

Changes

No recorded changes to this operation across all 1 revision of this API.