Versions Compared

Old Version 19

changes.mady.by.user Robin Rielley

Saved on

compared with

New Version 20

changes.mady.by.user Robin Rielley

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Description

namespace-id

Namespace ID

entity-details

Hierarchical key-value representation of the entity

app-id

Name of the application

program-type

One of mapreduce, spark, workflows, services, or workers

program-id

Name of the program

artifact-id

Name of the artifact

artifact-version

Version of the artifact

dataset-id

Name of the dataset

field-name

Name of the field

scope

Optional scope filter. If not specified, properties in the user and system scopes are returned. Otherwise, only properties in the specified scope are returned.

Example

To get the creation time for a deployed data pipeline called POS_SALES, issue the following GET request:

Code Block
GET /v3/namespaces/default/apps/POS_SALES/metadata/properties

The result is:

Code Block
{
  "Workflow:DataPipelineWorkflow": "DataPipelineWorkflow",
  "plugin:csv:validatingOutputFormat": "csv:validatingOutputFormat",
  "entity-name": "POS_SALES",
  "plugin:GCSFile:batchsource": "GCSFile:batchsource",
  "plugin:GCS:batchsink": "GCS:batchsink",
  "creation-time": "1613569893556",
  "description": "Data Pipeline Application",
  "plugin:text:validatingInputFormat": "text:validatingInputFormat",
  "version": "-SNAPSHOT",
  "schedule:dataPipelineSchedule": "dataPipelineSchedule:Data pipeline schedule",
  "Spark:phase-1": "phase-1",
  "plugin:Wrangler:transform": "Wrangler:transform"
}

HTTP Responses

Status Codes

Description

200 OK

The properties requested were returned as a JSON string in the body of the response which can be empty if there are no properties associated with the entity, or the entity does not exist

...