sked artifacts custom-field

Overview

Manage the retrieval and deployment of custom fields.

$ sked artifact custom-field <command>

Commands

Command Description
Create Create a CustomField from a state file [deprecated, use upsert instead]
Delete Delete a custom field from a parent object (standard or custom).
Get Get the state of a custom field.
List List the existing CustomField
Update Update a CustomField from a state file [deprecated, use upsert instead]
Upsert Create or Update a CustomField from a state file

Create

Description

Create a custom field attached to a parent object (standard or custom).

Usage 

$ sked artifacts custom-field create [--json] [-a <value>] [-f <value>] [-w <value>] [--name <value>] [--objectName <value>]

Flags

Flag Description Required
-f, --filename= The state file. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No
--name=<value> The name of the custom field. No
--objectName=<value> The name of the parent object. No

Global flags

Flag Description Required
--json Format output as json. No

Delete

Description

Delete a custom field from a parent object (standard or custom).

Usage 

$ sked artifacts custom-field delete [--json] [-a <value>] [-w <value>] [--objectName <value>] [--name <value>]

Flags

Flag Description Required
--name=<value> The name of the custom field. Yes
--objectName=<value> The name of the parent object. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No

Global flags

Flag Description Required
--json Format output as json. No

Get

Description

Get the state of a CustomField

Usage 

  $ sked artifacts custom-field get --objectName <value> --name <value> [--json] [-o <value>] [-a <value>]

Flags

Flag Description Required
--name The name of the custom field. Yes
--objectName The name of the parent object. Yes
-a, --alias The alias to use to authenticate. No
-o, --outputdir The output directory. No

Global flags

Flag Description Required
--json Format output as json. No

List

Description

List the existing CustomField

Usage 

$ sked artifacts custom-field list --objectName <value> [--json] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv |
    --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>] [-a <value>]

Flags

Flag Description Required
--objectName=<value> The name of the parent object. Yes
-a, --alias=<value> The alias to use to authenticate. No
-x, --extended Show extra columns. No
--columns=<value> Only show provided columns (comma-separated). No
--csv Output is CSV format [alias: --output=csv]. No
--filter=<value> Filter property by partial string matching, ex: name=foo. No
--no-header Hide table header from output. No
--no-truncate Do not truncate output to fit screen. No
--output=<option> Output in a more machine-friendly format. <options: csv|json|yaml>. No
--sort=<value> Property to sort by (prepend ‘-’ for descending). No

Global flags

Flag Description Required
--json Format output as json. No

Update

Description

Update a CustomField from a state file [deprecated, use upsert instead]

Usage 

$ sked artifacts custom-field update -f <value> [--json] [-a <value>] [-w <value>] [--objectName <value>] [--name <value>]

Flags

Flag Description Required
-f, --filename=<value> The state file. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No
--name=<value> The name of the custom field. No
--objectName=<value> The name of the parent object. No

Global flags

Flag Description Required
--json Format output as json. No

Upsert

Description

Create or Update a CustomField from a state file

Usage 

  $ sked artifacts custom-field upsert -f <value> [--json] [-a <value>] [-w <value>] [--objectName <value>] [--name <value>]

Flags

Flag Description Required
-f, --filename=<value> The state file. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No
--name=<value> The name of the custom field. No
--objectName=<value> The name of the parent object. No

Global flags

Flag Description Required
--json Format output as json. No