describe-flow¶

Description¶

Gets the details for the specified flow.

Synopsis¶

  describe-flow
--flow-crn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--flow-crn (string)

The flow CRN

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

flowDetail -> (object)

A representation of a versioned data flow.

crn -> (string)

The artifact CRN

name -> (string)

The artifact name.

versionCount -> (integer)

The number of versions uploaded to the catalog.

createdTimestamp -> (integer)

The created timestamp.

author -> (string)

Author of the most recent version

description -> (string)

The artifact description.

modifiedTimestamp -> (integer)

The modified timestamp.

versions -> (array)

The list of artifactDetail versions

item -> (object)

A representation of a flow detail version

crn -> (string)

The flow version CRN

bucketIdentifier -> (string)

The bucketIdentifier of the flow

author -> (string)

The author of the flow

version -> (integer)

The version of the flow

timestamp -> (integer)

The timestamp of the flow

deploymentCount -> (integer)

The number of deployments of the flow

comments -> (string)

Comments about the flow

draftCount -> (integer)

The number of draft flows associated with the version.

tags -> (array)

The list of tags associated with the flow version.

item -> (object)

A representation of an artifact version tag.

tagName -> (string)

The name of the version tag.

tagColor -> (string)

The color of the version tag (optional).

Form Factors¶

public