2.76. hammer sync-plan

同期プランを操作します。

Usage:
    hammer sync-plan [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    Subcommand
 [ARG] ...                     Subcommand arguments

Subcommands:
 create                        Create a sync plan
 delete, destroy               Destroy a sync plan
 info, show                    Show a sync plan
 list, index                   List sync plans
 update                        Update a sync plan

Options:
 -h, --help                    Print help

2.76.1. hammer sync-plan create

同期プランを作成します。

Usage:
    hammer sync-plan create [OPTIONS]

Options:
 --cron-expression VALUE       Set this when interval is custom cron
 --description VALUE           Sync plan description
 --enabled BOOLEAN             Enables or disables synchronization
 --interval VALUE              How often synchronization should run
 --name VALUE                  Sync plan name
 --organization VALUE          Organization name to search by
 --organization-id NUMBER      Organization ID
 --organization-label VALUE    Organization label to search by
 --organization-title VALUE    Organization title
 --sync-date DATETIME          Start date and time for the sync plan.Time is optional, if kept blank current
                               system time will be considered
 -h, --help                    Print help

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

2.76.2. hammer sync-plan delete

同期プランを破棄します。

Usage:
    hammer sync-plan <delete|destroy> [OPTIONS]

Options:
 --id NUMBER                   Sync plan numeric identifier
 --name VALUE                  Sync plan name to search by
 --organization VALUE          Organization name to search by
 --organization-id NUMBER      Organization ID
 --organization-label VALUE    Organization label to search by
 --organization-title VALUE    Organization title
 -h, --help                    Print help

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

2.76.3. hammer sync-plan info

同期プランを表示します。

Usage:
    hammer sync-plan <info|show> [OPTIONS]

Options:
 --fields LIST                 Show specified fields or predefined field sets only. (See below)
 --id NUMBER                   Sync plan numeric identifier
 --name VALUE                  Sync plan name to search by
 --organization VALUE          Organization name to search by
 --organization-id NUMBER      Organization ID
 --organization-label VALUE    Organization label to search by
 --organization-title VALUE    Organization title
 -h, --help                    Print help

Predefined field sets:
  -------------------|-----|---------|-----
  FIELDS             | ALL | DEFAULT | THIN
  -------------------|-----|---------|-----
  Id                 | x   | x       | x
  Name               | x   | x       | x
  Start date         | x   | x       |
  Interval           | x   | x       |
  Enabled            | x   | x       |
  Cron expression    | x   | x       |
  Recurring logic id | x   | x       |
  Description        | x   | x       |
  Created at         | x   | x       |
  Updated at         | x   | x       |
  Next sync          | x   | x       |
  Products/id        | x   | x       |
  Products/name      | x   | x       |
  -------------------|-----|---------|-----

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

2.76.4. hammer sync-plan list

同期プランのリストを表示します。

Usage:
    hammer sync-plan <list|index> [OPTIONS]

Options:
 --fields LIST                 Show specified fields or predefined field sets only. (See below)
 --full-result BOOLEAN         Whether or not to show all results
 --interval ENUM               Filter by interval
                               Possible value(s): 'hourly', 'daily', 'weekly', 'custom cron'
 --name VALUE                  Filter by name
 --order VALUE                 Sort field and order, eg. 'id DESC'
 --organization VALUE          Organization name to search by
 --organization-id NUMBER      Organization ID
 --organization-label VALUE    Organization label to search by
 --organization-title VALUE    Organization title
 --page NUMBER                 Page number, starting at 1
 --per-page NUMBER             Number of results per page to return
 --search VALUE                Search string
 --sync-date VALUE             Filter by sync date
 -h, --help                    Print help

Predefined field sets:
  -------------------|-----|---------|-----
  FIELDS             | ALL | DEFAULT | THIN
  -------------------|-----|---------|-----
  Id                 | x   | x       | x
  Name               | x   | x       | x
  Start date         | x   | x       |
  Interval           | x   | x       |
  Enabled            | x   | x       |
  Cron expression    | x   | x       |
  Recurring logic id | x   | x       |
  -------------------|-----|---------|-----

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

Search / Order fields:
  enabled             Values: true, false
  interval            string
  name                string
  organization_id     integer

2.76.5. hammer sync-plan update

同期プランを更新します。

Usage:
    hammer sync-plan update [OPTIONS]

Options:
 --cron-expression VALUE       Add custom cron logic for sync plan
 --description VALUE           Sync plan description
 --enabled BOOLEAN             Enables or disables synchronization
 --id NUMBER                   Sync plan numeric identifier
 --interval VALUE              How often synchronization should run
 --name VALUE                  Sync plan name
 --new-name VALUE              Sync plan name
 --organization VALUE          Organization name to search by
 --organization-id NUMBER      Organization ID
 --organization-label VALUE    Organization label to search by
 --organization-title VALUE    Organization title
 --sync-date DATETIME          Start date and time of the synchronization
 -h, --help                    Print help

Option details:
  Here you can find option types and the value an option can accept:

  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string