Definition (aka Integration Definition)
doohickey definition allows you to interact with integration definitions in the Doohickey Cloud environment.
An integration definition represents an integration that is made available to end users via your product.
Arguments
doohickey definition accepts one argument - an alias for the definition
Common Flags
All definition commands use the optional --environment flag for specifying a Doohickey Cloud project workspace.
Create
doohickey definition create creates a definition record in Doohickey Cloud. The UUID for this definition will be saved for
Doohickey CLI to reference later. Details for the definition may be provided via a JSON file (with the --file flag) or via
the individual flags (e.g. --connections, --templates, etc.). Any values not covered by the flags method will be
prompted for interactively.
| flags | type | description |
|---|---|---|
--file (-F) | string | Optional flag to provide filepath for definition body |
--name (-n) | string | Name of the Doohickey Cloud definition object |
--description (-d) | string | Description of the Doohickey Cloud definition object |
--connections (-N) | string | Comma separated list of Doohickey Cloud connection IDs |
--templates (-t) | string | Comma separated list of Doohickey Cloud template IDs |
--environmentId (-i) | string | ID of the Doohickey Cloud environment |
--environmentUser (-u) | string | Name of the Doohickey Cloud environment user |
Prerequisites:
- create a Doohickey Cloud environment, and retrieve its id
- retrieve the id for a user in the selected environment
- create Doohickey Cloud templates, and retrieve their ids
- create Doohickey Cloud connections, and retrieve their ids (optional)
Delete
doohickey definition delete will remove a definition from Doohickey Cloud. The definition must be specified by an alias. If
the definition is not aliased locally you must first run doohickey definition init to add a local alias.
Init
doohickey definition init will provide a list of definitions that currently exist in Doohickey Cloud. You can select one of
these definitions to alias and save to your local doohickey configuration.
Update
doohickey definition update will apply an update to an existing definition. The definition must be specified by an alias. If
the definition is not aliased locally you must first run doohickey definition init to add a local alias.
Details for the definition may be provided via a JSON file (with the --file flag) or via the individual flags (e.g.
--connections, --templates, etc.). Any values not covered by the flags method will be prompted for interactively.
| flags | type | description |
|---|---|---|
--file (-F) | string | Optional flag to provide filepath for definition body |
--name (-n) | string | Name of the Doohickey Cloud definition object |
--description (-d) | string | Description of the Doohickey Cloud definition object |
--connections (-N) | string | Comma separated list of Doohickey Cloud connection IDs |
--templates (-t) | string | Comma separated list of Doohickey Cloud template IDs |
--environmentId (-i) | string | ID of the Doohickey Cloud environment |
--environmentUser (-u) | string | Name of the Doohickey Cloud environment user |
View
You are able to view a single definition as well as viewing all definitions available in Doohickey Cloud.
View One Definition
To view a single definition, run the command doohickey definition view myDefinitionAlias, replacing myDefinitionAlias with
the alias of the definition you would like to view.
View All Definitions
To view all definitions, run the command doohickey definition view and Doohickey Cloud will retrieve all definitions and
return limited information about them. To retrieve additional information, you can pass the --verbose flag.
| flags | type | description |
|---|---|---|
--verbose (-v) | boolean | Verbose mode for view command to list all columns |
--json (-j) | boolean | Output data as JSON |