機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

設定タスクの更新

patch

/crmRestApi/resources/11.13.18.05/setupAssistants/{Name}

リクエスト

パス・パラメータ

• Name(required): string
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• AccountingCalendars: array Accounting Calendars
  タイトル: Accounting Calendars

  会計カレンダ・リソースは、会計カレンダの作成に使用されます。
• AdaptiveSearch: array Adaptive Searches
  タイトル: Adaptive Searches

  適応型検索リソースは、適応型検索の構成を表示、作成および更新するために使用されます。 この構成は、適応検索公開タスクを発行するために使用されます。
• CompanyProfiles: array Company Profiles
  タイトル: Company Profiles

  企業プロファイル・リソースは、企業情報の作成に使用されます。
• Competitors: array Competitors
  タイトル: Competitors

  競合相手リソースは、競合相手の作成に使用されます。
• データ: 文字列(バイト)
  設定タスクの完了に必要なデータ。
• Geographies: array Geographies
  タイトル: Geographies

  地理リソースは、地理のインポートとジオコーディングの有効化に使用されます。
• Opportunities: array Opportunities
  タイトル: Opportunities

  商談リソースは、商談設定の作成、表示および更新に使用されます。
• ProductGroups: array Product Groups
  タイトル: Product Groups

  製品グループ・リソースは、ルート製品グループの作成に使用されます。
• RoleMappings: array Role Mappings
  タイトル: Role Mappings

  リソース・ロール・マッピング・リソースは、リソース・ロールとロール・マッピングの作成に使用されます。
• SalesForecastings: array Sales Forecasts
  タイトル: Sales Forecasts

  売上予測リソースは、所有者ベースの売上予測を設定するために使用されます。
• SalesStages: array Sales Stages
  タイトル: Sales Stages

  営業ステージ・リソースは、選択した販売メソッドの営業ステージを作成、表示および更新するために使用されます。
• SetupHistory: array Setup Histories
  タイトル: Setup Histories

  設定履歴リソースは、設定アシスタントによって取得された設定データの表示に使用されます。
• SetupProgress: array Setup Progress
  タイトル: Setup Progress

  Setup Progress(設定進捗)リソースは、設定アシスタントによって開始された設定タスクの進捗をモニターするために使用されます。
• SetupUsers: array Setup Users
  タイトル: Setup Users

  設定ユーザーの作成には、設定ユーザー・リソースが使用されます。
• Status: string
  最大長: 80

  設定タスクのステータス。
• TopSalesUsers: array Top Sales Users
  タイトル: Top Sales Users

  最上位営業ユーザー・リソースは、最上位営業ユーザーを作成し、営業階層の最上位にユーザーを設定するために使用されます。

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the setup task.",
            "nullable":true
        },
        "SalesForecastings":{
            "title":"Sales Forecasts",
            "type":"array",
            "description":"The Sales Forecasting resource is used to setup owner based sales forecasting.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SalesForecastings-item-patch-request"
            }
        },
        "CompanyProfiles":{
            "title":"Company Profiles",
            "type":"array",
            "description":"The Company Profile resource is used to create the enterprise information.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-CompanyProfiles-item-patch-request"
            }
        },
        "RoleMappings":{
            "title":"Role Mappings",
            "type":"array",
            "description":"The Resource Role Mapping resource is used to create resource roles and role mappings.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-RoleMappings-item-patch-request"
            }
        },
        "SetupProgress":{
            "title":"Setup Progress",
            "type":"array",
            "description":"The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SetupProgress-item-patch-request"
            }
        },
        "Data":{
            "type":"string",
            "description":"The data required to complete the setup task.",
            "format":"byte",
            "nullable":false
        },
        "AdaptiveSearch":{
            "title":"Adaptive Searches",
            "type":"array",
            "description":"The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-AdaptiveSearch-item-patch-request"
            }
        },
        "Opportunities":{
            "title":"Opportunities",
            "type":"array",
            "description":"The Opportunities resource is used to create, view and update opportunity setup.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Opportunities-item-patch-request"
            }
        },
        "SetupHistory":{
            "title":"Setup Histories",
            "type":"array",
            "description":"The setup history resource is used to view setup data captured by the Setup Assistant.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SetupHistory-item-patch-request"
            }
        },
        "Geographies":{
            "title":"Geographies",
            "type":"array",
            "description":"The Geographies resource is used to import geographies and enable geocoding.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Geographies-item-patch-request"
            }
        },
        "SalesStages":{
            "title":"Sales Stages",
            "type":"array",
            "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SalesStages-item-patch-request"
            }
        },
        "AccountingCalendars":{
            "title":"Accounting Calendars",
            "type":"array",
            "description":"The Accounting Calendar resource is used to create accounting calendar.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-AccountingCalendars-item-patch-request"
            }
        },
        "TopSalesUsers":{
            "title":"Top Sales Users",
            "type":"array",
            "description":"The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-TopSalesUsers-item-patch-request"
            }
        },
        "Competitors":{
            "title":"Competitors",
            "type":"array",
            "description":"The Competitors resource is used to create competitors.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Competitors-item-patch-request"
            }
        },
        "SetupUsers":{
            "title":"Setup Users",
            "type":"array",
            "description":"The Setup Users resource is used to create setup users.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SetupUsers-item-patch-request"
            }
        },
        "ProductGroups":{
            "title":"Product Groups",
            "type":"array",
            "description":"The Product Group resource is used to create the root product group.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-ProductGroups-item-patch-request"
            }
        }
    }
}

ネストされたスキーマ : 会計カレンダ

タイプ: array

タイトル: Accounting Calendars

会計カレンダ・リソースは、会計カレンダの作成に使用されます。

ソースを表示

• Array of: object schema

{
    "title":"Accounting Calendars",
    "type":"array",
    "description":"The Accounting Calendar resource is used to create accounting calendar.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-AccountingCalendars-item-patch-request"
    }
}

ネストされたスキーマ : 適応検索

タイプ: array

タイトル: Adaptive Searches

適応型検索リソースは、適応型検索の構成を表示、作成および更新するために使用されます。 この構成は、適応検索公開タスクを発行するために使用されます。

ソースを表示

• Array of: object setupAssistants-AdaptiveSearch-item-patch-request

{
    "title":"Adaptive Searches",
    "type":"array",
    "description":"The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-AdaptiveSearch-item-patch-request"
    }
}

ネストされたスキーマ : 会社プロファイル

タイプ: array

タイトル: Company Profiles

企業プロファイル・リソースは、企業情報の作成に使用されます。

ソースを表示

• Array of: object setupAssistants-CompanyProfiles-item-patch-request

{
    "title":"Company Profiles",
    "type":"array",
    "description":"The Company Profile resource is used to create the enterprise information.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-CompanyProfiles-item-patch-request"
    }
}

ネストされたスキーマ : 競合

タイプ: array

タイトル: Competitors

競合相手リソースは、競合相手の作成に使用されます。

ソースを表示

• Array of: object setupAssistants-Competitors-item-patch-request

{
    "title":"Competitors",
    "type":"array",
    "description":"The Competitors resource is used to create competitors.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Competitors-item-patch-request"
    }
}

ネストされたスキーマ : 地理

タイプ: array

タイトル: Geographies

地理リソースは、地理のインポートとジオコーディングの有効化に使用されます。

ソースを表示

• Array of: object setupAssistants-Geographies-item-patch-request

{
    "title":"Geographies",
    "type":"array",
    "description":"The Geographies resource is used to import geographies and enable geocoding.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Geographies-item-patch-request"
    }
}

ネストされたスキーマ : 商談

タイプ: array

タイトル: Opportunities

商談リソースは、商談設定の作成、表示および更新に使用されます。

ソースを表示

• Array of: object setupAssistants-Opportunities-item-patch-request

{
    "title":"Opportunities",
    "type":"array",
    "description":"The Opportunities resource is used to create, view and update opportunity setup.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Opportunities-item-patch-request"
    }
}

ネストされたスキーマ : 製品グループ

タイプ: array

タイトル: Product Groups

製品グループ・リソースは、ルート製品グループの作成に使用されます。

ソースを表示

• Array of: object setupAssistants-ProductGroups-item-patch-request

{
    "title":"Product Groups",
    "type":"array",
    "description":"The Product Group resource is used to create the root product group.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-ProductGroups-item-patch-request"
    }
}

ネストされたスキーマ : ロール・マッピング

タイプ: array

タイトル: Role Mappings

リソース・ロール・マッピング・リソースは、リソース・ロールとロール・マッピングの作成に使用されます。

ソースを表示

• Array of: object setupAssistants-RoleMappings-item-patch-request

{
    "title":"Role Mappings",
    "type":"array",
    "description":"The Resource Role Mapping resource is used to create resource roles and role mappings.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-RoleMappings-item-patch-request"
    }
}

ネストされたスキーマ : 販売予測

タイプ: array

タイトル: Sales Forecasts

売上予測リソースは、所有者ベースの売上予測を設定するために使用されます。

ソースを表示

• Array of: object setupAssistants-SalesForecastings-item-patch-request

{
    "title":"Sales Forecasts",
    "type":"array",
    "description":"The Sales Forecasting resource is used to setup owner based sales forecasting.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SalesForecastings-item-patch-request"
    }
}

ネストされたスキーマ : 営業ステージ

タイプ: array

タイトル: Sales Stages

営業ステージ・リソースは、選択した販売メソッドの営業ステージを作成、表示および更新するために使用されます。

ソースを表示

• Array of: object setupAssistants-SalesStages-item-patch-request

{
    "title":"Sales Stages",
    "type":"array",
    "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SalesStages-item-patch-request"
    }
}

ネストされたスキーマ : 設定履歴

タイプ: array

タイトル: Setup Histories

設定履歴リソースは、設定アシスタントによって取得された設定データの表示に使用されます。

ソースを表示

• Array of: object setupAssistants-SetupHistory-item-patch-request

{
    "title":"Setup Histories",
    "type":"array",
    "description":"The setup history resource is used to view setup data captured by the Setup Assistant.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SetupHistory-item-patch-request"
    }
}

ネストされたスキーマ : 進捗の設定

タイプ: array

タイトル: Setup Progress

Setup Progress(設定進捗)リソースは、設定アシスタントによって開始された設定タスクの進捗をモニターするために使用されます。

ソースを表示

• Array of: object setupAssistants-SetupProgress-item-patch-request

{
    "title":"Setup Progress",
    "type":"array",
    "description":"The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SetupProgress-item-patch-request"
    }
}

ネストされたスキーマ : 設定ユーザー

タイプ: array

タイトル: Setup Users

設定ユーザーの作成には、設定ユーザー・リソースが使用されます。

ソースを表示

• Array of: object schema

{
    "title":"Setup Users",
    "type":"array",
    "description":"The Setup Users resource is used to create setup users.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SetupUsers-item-patch-request"
    }
}

ネストされたスキーマ : 上位営業ユーザー

タイプ: array

タイトル: Top Sales Users

最上位営業ユーザー・リソースは、最上位営業ユーザーを作成し、営業階層の最上位にユーザーを設定するために使用されます。

ソースを表示

• Array of: object schema

{
    "title":"Top Sales Users",
    "type":"array",
    "description":"The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-TopSalesUsers-item-patch-request"
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

• Description: string
  最大長: 255

  会計カレンダの摘要。
• Name: string
  最大長: 15

  デフォルト値: Sales Calendar

  会計カレンダの名前。
• PeriodFrequency: string
  最大長: 25

  デフォルト値: MONTH

  会計カレンダの頻度。
• PeriodNameFormat: string
  最大長: 25

  デフォルト値: MMMYYCY

  会計カレンダに関連付けられた期間書式です。
• PeriodStartMonth: string
  最大長: 20

  デフォルト値: 01

  会計カレンダの開始月。
• PeriodStartYear: string
  最大長: 4

  会計カレンダの開始年。

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the accounting calendar.",
            "nullable":true
        },
        "PeriodStartYear":{
            "maxLength":4,
            "type":"string",
            "description":"The start year for the accounting calendar.",
            "nullable":true
        },
        "PeriodFrequency":{
            "maxLength":25,
            "type":"string",
            "description":"The frequency of the accounting calendar.",
            "nullable":true,
            "default":"MONTH",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PeriodNameFormat":{
            "maxLength":25,
            "type":"string",
            "description":"The period format associated with the accounting calendar.",
            "nullable":true,
            "default":"MMMYYCY"
        },
        "PeriodStartMonth":{
            "maxLength":20,
            "type":"string",
            "description":"The start month for the accounting calendar.",
            "nullable":true,
            "default":"01",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Name":{
            "maxLength":15,
            "type":"string",
            "description":"The name of the accounting calendar.",
            "nullable":false,
            "default":"Sales Calendar"
        }
    }
}

ネストされたスキーマ : setupAssistants-AdaptiveSearch-item-patch-request

タイプ: object

ソースを表示

• Account: string
  最大長: 80

  デフォルト値: Y

  アカウントが適応型検索公開用に選択されているかどうかを示します。
• Activity: string
  最大長: 80

  デフォルト値: Y

  適応検索公開にアクティビティが選択されているかどうかを示します。
• Contact: string
  最大長: 80

  デフォルト値: Y

  適応型検索公開に担当者が選択されているかどうかを示します。
• Lead: string
  最大長: 80

  デフォルト値: Y

  リードがアダプティブ検索公開用に選択されているかどうかを示します。
• Opportunity: string
  最大長: 80

  デフォルト値: Y

  商談が適応型検索公開用に選択されているかどうかを示します。
• Partner: string
  最大長: 80

  デフォルト値: N

  パートナが適応型検索公開用に選択されているかどうかを示します。
• PartnerContact: string
  最大長: 80

  デフォルト値: N

  パートナ担当者がアダプティブ検索公開用に選択されているかどうかを示します。
• Product: string
  最大長: 80

  デフォルト値: N

  適応型検索公開に対して製品が選択されているかどうかを示します。
• ProductGroup: string
  最大長: 80

  デフォルト値: N

  適応型検索公開に対して製品グループが選択されているかどうかを示します。
• ServiceRequest: string
  最大長: 80

  デフォルト値: N

  アダプティブ検索公開のサービス・リクエストが選択されているかどうかを示します。

{
    "type":"object",
    "properties":{
        "Account":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the account has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "ProductGroup":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether Product Group has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "Opportunity":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the opportunity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Lead":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the lead has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Activity":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the activity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Product":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether Product has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "Partner":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the partner has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "PartnerContact":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the partner contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "ServiceRequest":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the service request has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "Contact":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        }
    }
}

ネストされたスキーマ : setupAssistants-CompanyProfiles-item-patch-request

タイプ: object

ソースを表示

• Addressline: string
  最大長: 100

  組織住所の最初の行。
• BusinessUnit: string
  最大長: 80

  ビジネス・ユニット
• CorporateCurrency: string
  最大長: 80

  デフォルト値: USD

  デフォルトの企業通貨コード。
• Country: string
  最大長: 80

  デフォルト値: US

  企業の国。
• EnterpriseName: string
  最大長: 100

  エンタープライズの名前。
• IsDataExisting: string
  最大長: 80

  企業設定データが設定アシスタントの実行前に作成されたかどうかを示します。
• LegalEntity: string
  最大長: 80

  法的エンティティ
• TaxRegNumber: string
  最大長: 80

  企業税務登録番号

{
    "type":"object",
    "properties":{
        "LegalEntity":{
            "maxLength":80,
            "type":"string",
            "description":"Legal Entity",
            "nullable":true
        },
        "TaxRegNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Enterprise Tax Registration Number",
            "nullable":true
        },
        "Addressline":{
            "maxLength":100,
            "type":"string",
            "description":"The first line of the organization address.",
            "nullable":true
        },
        "CorporateCurrency":{
            "maxLength":80,
            "type":"string",
            "description":"The default corporate currency code.",
            "nullable":false,
            "default":"USD",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnterpriseName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the enterprise.",
            "nullable":true
        },
        "IsDataExisting":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates if the enterprise setup data was created before running the Setup Assistant.",
            "nullable":true
        },
        "BusinessUnit":{
            "maxLength":80,
            "type":"string",
            "description":"Business Unit",
            "nullable":true
        },
        "Country":{
            "maxLength":80,
            "type":"string",
            "description":"The country of the enterprise.",
            "nullable":true,
            "default":"US",
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

ネストされたスキーマ : setupAssistants-Competitors-item-patch-request

タイプ: object

ソースを表示

• LineOfBusiness: string
  最大長: 240

  競合会社の事業分野。
• Name: string
  最大長: 360

  競合会社の名前。
• NameSuffix: string
  最大長: 540

  競合会社の名前サフィクス。
• OrganizationSize: string
  最大長: 80

  収益、従業員数などに基づく組織の規模。
• ThreatLevel: string
  最大長: 80

  競争上のリスクを示す脅威のレベル。

{
    "type":"object",
    "properties":{
        "LineOfBusiness":{
            "maxLength":240,
            "type":"string",
            "description":"The line of business of the competitor.",
            "nullable":true
        },
        "NameSuffix":{
            "maxLength":540,
            "type":"string",
            "description":"The name suffix of the competitor.",
            "nullable":true
        },
        "OrganizationSize":{
            "maxLength":80,
            "type":"string",
            "description":"The size of the organization based on its revenue, number of employees, and others.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ThreatLevel":{
            "maxLength":80,
            "type":"string",
            "description":"The level of threat to signify the competitive risk.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Name":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the competitor.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : setupAssistants-Geographies-item-patch-request

タイプ: object

ソースを表示

• CountryFirst: string
  最大長: 80

  地理データをインポートする必要がある最初の国。
• CountrySecond: string
  最大長: 80

  地理データをインポートする必要がある2番目の国。
• CountryThird: string
  最大長: 80

  地理データをインポートする必要がある3番目の国。
• EnableGeoEncoding: string
  最大長: 5

  デフォルト値: N

  インポートされた国に対して地理エンコーディングを使用可能にする必要があるかどうかを示します。

{
    "type":"object",
    "properties":{
        "CountryThird":{
            "maxLength":80,
            "type":"string",
            "description":"The third country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CountrySecond":{
            "maxLength":80,
            "type":"string",
            "description":"The second country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnableGeoEncoding":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates if the geography encoding has to be enabled for the imported countries.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CountryFirst":{
            "maxLength":80,
            "type":"string",
            "description":"The first country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

ネストされたスキーマ : setupAssistants-Opportunities-item-patch-request

タイプ: object

ソースを表示

• OptyCloseDate: string
  最大長: 1000

  デフォルト値: 20

  商談がクローズされるデフォルトの日付。
• RequireCloseOptyCompetitor: string
  最大長: 1

  デフォルト値: Y

  商談をクローズする前に競合相手の詳細を入力する必要があるかどうかを示します。
• RequireOptyCloseReason: string
  最大長: 1

  デフォルト値: Y

  商談をクローズする前に受注または失注事由を指定する必要があるかどうかを示します。
• SalesMethodNumber: string
  最大長: 64

  デフォルトの販売メソッド番号(指定されていない場合)。
• SalesStages: array Sales Stages
  タイトル: Sales Stages

  営業ステージ・リソースは、選択した販売メソッドの営業ステージを作成、表示および更新するために使用されます。

{
    "type":"object",
    "properties":{
        "RequireOptyCloseReason":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if you need to indicate the win or loss reason before closing an opportunity.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesMethodNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The default sales method number if one isn't provided.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequireCloseOptyCompetitor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if you need to enter competitor details before closing an opportunity.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OptyCloseDate":{
            "maxLength":1000,
            "type":"string",
            "description":"The default date on which the opportunity will be closed.",
            "nullable":false,
            "default":"20"
        },
        "SalesStages":{
            "title":"Sales Stages",
            "type":"array",
            "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Opportunities-SalesStages-item-patch-request"
            }
        }
    }
}

ネストされたスキーマ : 営業ステージ

タイプ: array

タイトル: Sales Stages

営業ステージ・リソースは、選択した販売メソッドの営業ステージを作成、表示および更新するために使用されます。

ソースを表示

• Array of: object setupAssistants-Opportunities-SalesStages-item-patch-request

{
    "title":"Sales Stages",
    "type":"array",
    "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Opportunities-SalesStages-item-patch-request"
    }
}

ネストされたスキーマ : setupAssistants-Opportunities-SalesStages-item-patch-request

タイプ: object

ソースを表示

• DeletedFlag: boolean
  最大長: 2

  デフォルト値: false

  販売メソッドを削除できるかどうかを示します。
• DescriptionText: string
  最大長: 255

  営業ステージの摘要。
• Name: string
  最大長: 50

  セールス・ステージの名前。
• PhaseCd: string
  最大長: 30

  デフォルト値: QUALIFICATION-DISCOVERY

  営業ステージのフェーズのコード。
• RcmndWinProb: string
  最大長: 22

  営業ステージの受注確度。
• StageStatusCd: string
  最大長: 30

  デフォルト値: OPEN

  営業ステージのステータスを示すコード。
• StgOrder: string
  最大長: 22

  セールス・ステージが表示される順序。

{
    "type":"object",
    "properties":{
        "StageStatusCd":{
            "maxLength":30,
            "type":"string",
            "description":"A code indicating the status of the sales stage.",
            "nullable":false,
            "default":"OPEN",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RcmndWinProb":{
            "maxLength":22,
            "type":"string",
            "description":"The win probability of sales stage.",
            "nullable":true
        },
        "DeletedFlag":{
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates if the sales method can be deleted.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhaseCd":{
            "maxLength":30,
            "type":"string",
            "description":"The code for phase of sales stage.",
            "nullable":false,
            "default":"QUALIFICATION-DISCOVERY",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DescriptionText":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the sales stage.",
            "nullable":true
        },
        "StgOrder":{
            "maxLength":22,
            "type":"string",
            "description":"The order in which the sales stage will be displayed.",
            "nullable":false
        },
        "Name":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the sales stage.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : setupAssistants-ProductGroups-item-patch-request

タイプ: object

ソースを表示

• Description: string
  最大長: 1000

  製品グループの摘要。
• DisplayName: string
  最大長: 150

  製品グループの名前。
• InternalName: string
  最大長: 150

  製品グループの内部名。

{
    "type":"object",
    "properties":{
        "DisplayName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the product group.",
            "nullable":false
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"A description for the product group.",
            "nullable":true
        },
        "InternalName":{
            "maxLength":150,
            "type":"string",
            "description":"The internal name of the product group.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : setupAssistants-RoleMappings-item-patch-request

タイプ: object

ソースを表示

• ResourceRoleName: string
  最大長: 60

  リソースのロール名。
• RoleCommonNameCode: string
  リソース・ロールがマップされるコード値アプリケーション・ジョブ・ロール。

{
    "type":"object",
    "properties":{
        "ResourceRoleName":{
            "maxLength":60,
            "type":"string",
            "description":"The role name of the resource.",
            "nullable":false
        },
        "RoleCommonNameCode":{
            "type":"string",
            "description":"The code value application job role to which resource role will be mapped.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

ネストされたスキーマ : setupAssistants-SalesForecastings-item-patch-request

タイプ: object

ソースを表示

• EnableForecasting: string
  最大長: 1

  デフォルト値: N

  販売予測設定を実行する必要があるかどうかを示します。

{
    "type":"object",
    "properties":{
        "EnableForecasting":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if sales forecast setup has to be done.",
            "nullable":false,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

ネストされたスキーマ : setupAssistants-SalesStages-item-patch-request

タイプ: object

ソースを表示

• DeletedFlag: boolean
  最大長: 2

  デフォルト値: false

  販売メソッドを削除できるかどうかを示します。
• DescriptionText: string
  最大長: 255

  営業ステージの摘要。
• Name: string
  最大長: 50

  セールス・ステージの名前。
• PhaseCd: string
  最大長: 30

  デフォルト値: QUALIFICATION-DISCOVERY

  営業ステージのフェーズのコード。
• RcmndWinProb: string
  最大長: 22

  営業ステージの受注確度。
• StageStatusCd: string
  最大長: 30

  デフォルト値: OPEN

  営業ステージのステータスを示すコード。
• StgOrder: string
  最大長: 22

  セールス・ステージが表示される順序。

{
    "type":"object",
    "properties":{
        "StageStatusCd":{
            "maxLength":30,
            "type":"string",
            "description":"A code indicating the status of the sales stage.",
            "nullable":false,
            "default":"OPEN",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RcmndWinProb":{
            "maxLength":22,
            "type":"string",
            "description":"The win probability of sales stage.",
            "nullable":true
        },
        "DeletedFlag":{
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates if the sales method can be deleted.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhaseCd":{
            "maxLength":30,
            "type":"string",
            "description":"The code for phase of sales stage.",
            "nullable":false,
            "default":"QUALIFICATION-DISCOVERY",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DescriptionText":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the sales stage.",
            "nullable":true
        },
        "StgOrder":{
            "maxLength":22,
            "type":"string",
            "description":"The order in which the sales stage will be displayed.",
            "nullable":false
        },
        "Name":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the sales stage.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : setupAssistants-SetupHistory-item-patch-request

タイプ: object

ソースを表示

{
    "type":"object",
    "properties":{
    }
}

ネストされたスキーマ : setupAssistants-SetupProgress-item-patch-request

タイプ: object

ソースを表示

{
    "type":"object",
    "properties":{
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

• Email: string
  最大長: 320

  更新の送信先となる設定ユーザーのEメール。
• FirstName: string
  最大長: 150

  設定ユーザーの名。
• LastName: string
  最大長: 150

  設定ユーザーの姓。

{
    "type":"object",
    "properties":{
        "Email":{
            "maxLength":320,
            "type":"string",
            "description":"The email of the setup user to whom updates will be sent.",
            "nullable":false
        },
        "LastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the setup user.",
            "nullable":false
        },
        "FirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the setup user.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

• EMail: string
  最大長: 320

  上位営業ユーザーのEメール。
• FirstName: string
  最大長: 150

  最上位営業ユーザーの名。
• LastName: string
  最大長: 150

  最上位営業ユーザーの姓。
• ResourceOrganization: string
  最大長: 240

  営業ユーザーが属するリソース組織。

{
    "type":"object",
    "properties":{
        "LastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the top sales user.",
            "nullable":false
        },
        "ResourceOrganization":{
            "maxLength":240,
            "type":"string",
            "description":"The resource organization to which the sales user belongs.",
            "nullable":false
        },
        "EMail":{
            "maxLength":320,
            "type":"string",
            "description":"The email of the top sales user.",
            "nullable":false
        },
        "FirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the top sales user.",
            "nullable":false
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : setupAssistants-item-response

タイプ: object

ソースを表示

• AccountingCalendars: array Accounting Calendars
  タイトル: Accounting Calendars

  会計カレンダ・リソースは、会計カレンダの作成に使用されます。
• AdaptiveSearch: array Adaptive Searches
  タイトル: Adaptive Searches

  適応型検索リソースは、適応型検索の構成を表示、作成および更新するために使用されます。 この構成は、適応検索公開タスクを発行するために使用されます。
• CompanyProfiles: array Company Profiles
  タイトル: Company Profiles

  企業プロファイル・リソースは、企業情報の作成に使用されます。
• Competitors: array Competitors
  タイトル: Competitors

  競合相手リソースは、競合相手の作成に使用されます。
• データ: 文字列(バイト)
  設定タスクの完了に必要なデータ。
• Geographies: array Geographies
  タイトル: Geographies

  地理リソースは、地理のインポートとジオコーディングの有効化に使用されます。
• Id: string
  設定タスクの一意の識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Name: string
  最大長: 30

  設定タスクの一意の名前。
• Opportunities: array Opportunities
  タイトル: Opportunities

  商談リソースは、商談設定の作成、表示および更新に使用されます。
• ProductGroups: array Product Groups
  タイトル: Product Groups

  製品グループ・リソースは、ルート製品グループの作成に使用されます。
• RoleMappings: array Role Mappings
  タイトル: Role Mappings

  リソース・ロール・マッピング・リソースは、リソース・ロールとロール・マッピングの作成に使用されます。
• SalesForecastings: array Sales Forecasts
  タイトル: Sales Forecasts

  売上予測リソースは、所有者ベースの売上予測を設定するために使用されます。
• SalesStages: array Sales Stages
  タイトル: Sales Stages

  営業ステージ・リソースは、選択した販売メソッドの営業ステージを作成、表示および更新するために使用されます。
• SetupHistory: array Setup Histories
  タイトル: Setup Histories

  設定履歴リソースは、設定アシスタントによって取得された設定データの表示に使用されます。
• SetupProgress: array Setup Progress
  タイトル: Setup Progress

  Setup Progress(設定進捗)リソースは、設定アシスタントによって開始された設定タスクの進捗をモニターするために使用されます。
• SetupUsers: array Setup Users
  タイトル: Setup Users

  設定ユーザーの作成には、設定ユーザー・リソースが使用されます。
• Status: string
  最大長: 80

  設定タスクのステータス。
• TopSalesUsers: array Top Sales Users
  タイトル: Top Sales Users

  最上位営業ユーザー・リソースは、最上位営業ユーザーを作成し、営業階層の最上位にユーザーを設定するために使用されます。

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the setup task.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesForecastings":{
            "title":"Sales Forecasts",
            "type":"array",
            "description":"The Sales Forecasting resource is used to setup owner based sales forecasting.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SalesForecastings-item-response"
            }
        },
        "CompanyProfiles":{
            "title":"Company Profiles",
            "type":"array",
            "description":"The Company Profile resource is used to create the enterprise information.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-CompanyProfiles-item-response"
            }
        },
        "RoleMappings":{
            "title":"Role Mappings",
            "type":"array",
            "description":"The Resource Role Mapping resource is used to create resource roles and role mappings.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-RoleMappings-item-response"
            }
        },
        "SetupProgress":{
            "title":"Setup Progress",
            "type":"array",
            "description":"The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SetupProgress-item-response"
            }
        },
        "Data":{
            "type":"string",
            "description":"The data required to complete the setup task.",
            "format":"byte",
            "nullable":false,
            "x-queryable":true
        },
        "AdaptiveSearch":{
            "title":"Adaptive Searches",
            "type":"array",
            "description":"The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-AdaptiveSearch-item-response"
            }
        },
        "Opportunities":{
            "title":"Opportunities",
            "type":"array",
            "description":"The Opportunities resource is used to create, view and update opportunity setup.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Opportunities-item-response"
            }
        },
        "SetupHistory":{
            "title":"Setup Histories",
            "type":"array",
            "description":"The setup history resource is used to view setup data captured by the Setup Assistant.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SetupHistory-item-response"
            }
        },
        "Geographies":{
            "title":"Geographies",
            "type":"array",
            "description":"The Geographies resource is used to import geographies and enable geocoding.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Geographies-item-response"
            }
        },
        "Name":{
            "maxLength":30,
            "type":"string",
            "description":"A unique name for the setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "SalesStages":{
            "title":"Sales Stages",
            "type":"array",
            "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SalesStages-item-response"
            }
        },
        "AccountingCalendars":{
            "title":"Accounting Calendars",
            "type":"array",
            "description":"The Accounting Calendar resource is used to create accounting calendar.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-AccountingCalendars-item-response"
            }
        },
        "TopSalesUsers":{
            "title":"Top Sales Users",
            "type":"array",
            "description":"The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-TopSalesUsers-item-response"
            }
        },
        "Competitors":{
            "title":"Competitors",
            "type":"array",
            "description":"The Competitors resource is used to create competitors.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Competitors-item-response"
            }
        },
        "SetupUsers":{
            "title":"Setup Users",
            "type":"array",
            "description":"The Setup Users resource is used to create setup users.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-SetupUsers-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of a setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductGroups":{
            "title":"Product Groups",
            "type":"array",
            "description":"The Product Group resource is used to create the root product group.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-ProductGroups-item-response"
            }
        }
    }
}

ネストされたスキーマ : 会計カレンダ

タイプ: array

タイトル: Accounting Calendars

会計カレンダ・リソースは、会計カレンダの作成に使用されます。

ソースを表示

• Array of: object setupAssistants-AccountingCalendars-item-response

{
    "title":"Accounting Calendars",
    "type":"array",
    "description":"The Accounting Calendar resource is used to create accounting calendar.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-AccountingCalendars-item-response"
    }
}

ネストされたスキーマ : 適応検索

タイプ: array

タイトル: Adaptive Searches

適応型検索リソースは、適応型検索の構成を表示、作成および更新するために使用されます。 この構成は、適応検索公開タスクを発行するために使用されます。

ソースを表示

• Array of: object setupAssistants-AdaptiveSearch-item-response

{
    "title":"Adaptive Searches",
    "type":"array",
    "description":"The adaptive search resource is used to view, create and update configuration for adaptive search. This configuration will be used to submit the adaptive search publish task.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-AdaptiveSearch-item-response"
    }
}

ネストされたスキーマ : 会社プロファイル

タイプ: array

タイトル: Company Profiles

企業プロファイル・リソースは、企業情報の作成に使用されます。

ソースを表示

• Array of: object setupAssistants-CompanyProfiles-item-response

{
    "title":"Company Profiles",
    "type":"array",
    "description":"The Company Profile resource is used to create the enterprise information.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-CompanyProfiles-item-response"
    }
}

ネストされたスキーマ : 競合

タイプ: array

タイトル: Competitors

競合相手リソースは、競合相手の作成に使用されます。

ソースを表示

• Array of: object setupAssistants-Competitors-item-response

{
    "title":"Competitors",
    "type":"array",
    "description":"The Competitors resource is used to create competitors.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Competitors-item-response"
    }
}

ネストされたスキーマ : 地理

タイプ: array

タイトル: Geographies

地理リソースは、地理のインポートとジオコーディングの有効化に使用されます。

ソースを表示

• Array of: object setupAssistants-Geographies-item-response

{
    "title":"Geographies",
    "type":"array",
    "description":"The Geographies resource is used to import geographies and enable geocoding.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Geographies-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : 商談

タイプ: array

タイトル: Opportunities

商談リソースは、商談設定の作成、表示および更新に使用されます。

ソースを表示

• Array of: object setupAssistants-Opportunities-item-response

{
    "title":"Opportunities",
    "type":"array",
    "description":"The Opportunities resource is used to create, view and update opportunity setup.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Opportunities-item-response"
    }
}

ネストされたスキーマ : 製品グループ

タイプ: array

タイトル: Product Groups

製品グループ・リソースは、ルート製品グループの作成に使用されます。

ソースを表示

• Array of: object setupAssistants-ProductGroups-item-response

{
    "title":"Product Groups",
    "type":"array",
    "description":"The Product Group resource is used to create the root product group.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-ProductGroups-item-response"
    }
}

ネストされたスキーマ : ロール・マッピング

タイプ: array

タイトル: Role Mappings

リソース・ロール・マッピング・リソースは、リソース・ロールとロール・マッピングの作成に使用されます。

ソースを表示

• Array of: object setupAssistants-RoleMappings-item-response

{
    "title":"Role Mappings",
    "type":"array",
    "description":"The Resource Role Mapping resource is used to create resource roles and role mappings.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-RoleMappings-item-response"
    }
}

ネストされたスキーマ : 販売予測

タイプ: array

タイトル: Sales Forecasts

売上予測リソースは、所有者ベースの売上予測を設定するために使用されます。

ソースを表示

• Array of: object setupAssistants-SalesForecastings-item-response

{
    "title":"Sales Forecasts",
    "type":"array",
    "description":"The Sales Forecasting resource is used to setup owner based sales forecasting.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SalesForecastings-item-response"
    }
}

ネストされたスキーマ : 営業ステージ

タイプ: array

タイトル: Sales Stages

営業ステージ・リソースは、選択した販売メソッドの営業ステージを作成、表示および更新するために使用されます。

ソースを表示

• Array of: object setupAssistants-SalesStages-item-response

{
    "title":"Sales Stages",
    "type":"array",
    "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SalesStages-item-response"
    }
}

ネストされたスキーマ : 設定履歴

タイプ: array

タイトル: Setup Histories

設定履歴リソースは、設定アシスタントによって取得された設定データの表示に使用されます。

ソースを表示

• Array of: object setupAssistants-SetupHistory-item-response

{
    "title":"Setup Histories",
    "type":"array",
    "description":"The setup history resource is used to view setup data captured by the Setup Assistant.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SetupHistory-item-response"
    }
}

ネストされたスキーマ : 進捗の設定

タイプ: array

タイトル: Setup Progress

Setup Progress(設定進捗)リソースは、設定アシスタントによって開始された設定タスクの進捗をモニターするために使用されます。

ソースを表示

• Array of: object setupAssistants-SetupProgress-item-response

{
    "title":"Setup Progress",
    "type":"array",
    "description":"The Setup Progress resource is used to monitor the progress of the setup tasks started by the Setup Assistant.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SetupProgress-item-response"
    }
}

ネストされたスキーマ : 設定ユーザー

タイプ: array

タイトル: Setup Users

設定ユーザーの作成には、設定ユーザー・リソースが使用されます。

ソースを表示

• Array of: object setupAssistants-SetupUsers-item-response

{
    "title":"Setup Users",
    "type":"array",
    "description":"The Setup Users resource is used to create setup users.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-SetupUsers-item-response"
    }
}

ネストされたスキーマ : 上位営業ユーザー

タイプ: array

タイトル: Top Sales Users

最上位営業ユーザー・リソースは、最上位営業ユーザーを作成し、営業階層の最上位にユーザーを設定するために使用されます。

ソースを表示

• Array of: object setupAssistants-TopSalesUsers-item-response

{
    "title":"Top Sales Users",
    "type":"array",
    "description":"The Top Sales User resource is used to create the top sales user and set the user at the top of the sales hierarchy.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-TopSalesUsers-item-response"
    }
}

ネストされたスキーマ : setupAssistants-AccountingCalendars-item-response

タイプ: object

ソースを表示

• Description: string
  最大長: 255

  会計カレンダの摘要。
• Id: string
  会計カレンダ設定タスクの一意の識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Name: string
  最大長: 15

  デフォルト値: Sales Calendar

  会計カレンダの名前。
• PeriodFrequency: string
  最大長: 25

  デフォルト値: MONTH

  会計カレンダの頻度。
• PeriodNameFormat: string
  最大長: 25

  デフォルト値: MMMYYCY

  会計カレンダに関連付けられた期間書式です。
• PeriodStartMonth: string
  最大長: 20

  デフォルト値: 01

  会計カレンダの開始月。
• PeriodStartYear: string
  最大長: 4

  会計カレンダの開始年。

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the accounting calendar.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodStartYear":{
            "maxLength":4,
            "type":"string",
            "description":"The start year for the accounting calendar.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of an accounting calendar setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodFrequency":{
            "maxLength":25,
            "type":"string",
            "description":"The frequency of the accounting calendar.",
            "nullable":true,
            "default":"MONTH",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PeriodNameFormat":{
            "maxLength":25,
            "type":"string",
            "description":"The period format associated with the accounting calendar.",
            "nullable":true,
            "default":"MMMYYCY",
            "x-queryable":true
        },
        "PeriodStartMonth":{
            "maxLength":20,
            "type":"string",
            "description":"The start month for the accounting calendar.",
            "nullable":true,
            "default":"01",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "maxLength":15,
            "type":"string",
            "description":"The name of the accounting calendar.",
            "nullable":false,
            "default":"Sales Calendar",
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : setupAssistants-AdaptiveSearch-item-response

タイプ: object

ソースを表示

• Account: string
  最大長: 80

  デフォルト値: Y

  アカウントが適応型検索公開用に選択されているかどうかを示します。
• Activity: string
  最大長: 80

  デフォルト値: Y

  適応検索公開にアクティビティが選択されているかどうかを示します。
• Contact: string
  最大長: 80

  デフォルト値: Y

  適応型検索公開に担当者が選択されているかどうかを示します。
• Id: string
  最大長: 80

  アダプティブ検索設定タスクの一意の識別子。
• Lead: string
  最大長: 80

  デフォルト値: Y

  リードがアダプティブ検索公開用に選択されているかどうかを示します。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Opportunity: string
  最大長: 80

  デフォルト値: Y

  商談が適応型検索公開用に選択されているかどうかを示します。
• Partner: string
  最大長: 80

  デフォルト値: N

  パートナが適応型検索公開用に選択されているかどうかを示します。
• PartnerContact: string
  最大長: 80

  デフォルト値: N

  パートナ担当者がアダプティブ検索公開用に選択されているかどうかを示します。
• Product: string
  最大長: 80

  デフォルト値: N

  適応型検索公開に対して製品が選択されているかどうかを示します。
• ProductGroup: string
  最大長: 80

  デフォルト値: N

  適応型検索公開に対して製品グループが選択されているかどうかを示します。
• ServiceRequest: string
  最大長: 80

  デフォルト値: N

  アダプティブ検索公開のサービス・リクエストが選択されているかどうかを示します。

{
    "type":"object",
    "properties":{
        "Account":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the account has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "ProductGroup":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether Product Group has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "Opportunity":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the opportunity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Lead":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the lead has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Activity":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the activity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Product":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether Product has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the adaptive search setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "Partner":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the partner has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "PartnerContact":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the partner contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ServiceRequest":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the service request has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "Contact":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : setupAssistants-CompanyProfiles-item-response

タイプ: object

ソースを表示

• Addressline: string
  最大長: 100

  組織住所の最初の行。
• BusinessUnit: string
  最大長: 80

  ビジネス・ユニット
• CorporateCurrency: string
  最大長: 80

  デフォルト値: USD

  デフォルトの企業通貨コード。
• Country: string
  最大長: 80

  デフォルト値: US

  企業の国。
• EnterpriseName: string
  最大長: 100

  エンタープライズの名前。
• Id: string
  最大長: 80

  会社プロファイル設定タスクの一意の識別子。
• IsDataExisting: string
  最大長: 80

  企業設定データが設定アシスタントの実行前に作成されたかどうかを示します。
• LegalEntity: string
  最大長: 80

  法的エンティティ
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• TaxRegNumber: string
  最大長: 80

  企業税務登録番号

{
    "type":"object",
    "properties":{
        "LegalEntity":{
            "maxLength":80,
            "type":"string",
            "description":"Legal Entity",
            "nullable":true,
            "x-queryable":true
        },
        "TaxRegNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Enterprise Tax Registration Number",
            "nullable":true,
            "x-queryable":true
        },
        "Addressline":{
            "maxLength":100,
            "type":"string",
            "description":"The first line of the organization address.",
            "nullable":true,
            "x-queryable":true
        },
        "CorporateCurrency":{
            "maxLength":80,
            "type":"string",
            "description":"The default corporate currency code.",
            "nullable":false,
            "default":"USD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EnterpriseName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the enterprise.",
            "nullable":true,
            "x-queryable":true
        },
        "IsDataExisting":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates if the enterprise setup data was created before running the Setup Assistant.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "maxLength":80,
            "type":"string",
            "description":"Business Unit",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":80,
            "type":"string",
            "description":"The country of the enterprise.",
            "nullable":true,
            "default":"US",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the company profile setup task.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : setupAssistants-Competitors-item-response

タイプ: object

ソースを表示

• Id: string
  最大長: 80

  競合相手の一意の識別子。
• LineOfBusiness: string
  最大長: 240

  競合会社の事業分野。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Name: string
  最大長: 360

  競合会社の名前。
• NameSuffix: string
  最大長: 540

  競合会社の名前サフィクス。
• OrganizationSize: string
  最大長: 80

  収益、従業員数などに基づく組織の規模。
• ThreatLevel: string
  最大長: 80

  競争上のリスクを示す脅威のレベル。

{
    "type":"object",
    "properties":{
        "OrganizationSize":{
            "maxLength":80,
            "type":"string",
            "description":"The size of the organization based on its revenue, number of employees, and others.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ThreatLevel":{
            "maxLength":80,
            "type":"string",
            "description":"The level of threat to signify the competitive risk.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LineOfBusiness":{
            "maxLength":240,
            "type":"string",
            "description":"The line of business of the competitor.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "maxLength":540,
            "type":"string",
            "description":"The name suffix of the competitor.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of a competitor.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the competitor.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : setupAssistants-Geographies-item-response

タイプ: object

ソースを表示

• CountryFirst: string
  最大長: 80

  地理データをインポートする必要がある最初の国。
• CountrySecond: string
  最大長: 80

  地理データをインポートする必要がある2番目の国。
• CountryThird: string
  最大長: 80

  地理データをインポートする必要がある3番目の国。
• EnableGeoEncoding: string
  最大長: 5

  デフォルト値: N

  インポートされた国に対して地理エンコーディングを使用可能にする必要があるかどうかを示します。
• Id: string
  地理設定タスクの一意の識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。

{
    "type":"object",
    "properties":{
        "CountryThird":{
            "maxLength":80,
            "type":"string",
            "description":"The third country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountrySecond":{
            "maxLength":80,
            "type":"string",
            "description":"The second country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of geography setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "EnableGeoEncoding":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates if the geography encoding has to be enabled for the imported countries.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CountryFirst":{
            "maxLength":80,
            "type":"string",
            "description":"The first country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : setupAssistants-Opportunities-item-response

タイプ: object

ソースを表示

• Id: string
  商談設定タスクの一意の識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OptyCloseDate: string
  最大長: 1000

  デフォルト値: 20

  商談がクローズされるデフォルトの日付。
• RequireCloseOptyCompetitor: string
  最大長: 1

  デフォルト値: Y

  商談をクローズする前に競合相手の詳細を入力する必要があるかどうかを示します。
• RequireOptyCloseReason: string
  最大長: 1

  デフォルト値: Y

  商談をクローズする前に受注または失注事由を指定する必要があるかどうかを示します。
• SalesMethodNumber: string
  最大長: 64

  デフォルトの販売メソッド番号(指定されていない場合)。
• SalesStages: array Sales Stages
  タイトル: Sales Stages

  営業ステージ・リソースは、選択した販売メソッドの営業ステージを作成、表示および更新するために使用されます。

{
    "type":"object",
    "properties":{
        "RequireOptyCloseReason":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if you need to indicate the win or loss reason before closing an opportunity.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesMethodNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The default sales method number if one isn't provided.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequireCloseOptyCompetitor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if you need to enter competitor details before closing an opportunity.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OptyCloseDate":{
            "maxLength":1000,
            "type":"string",
            "description":"The default date on which the opportunity will be closed.",
            "nullable":false,
            "default":"20",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of opportunity setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "SalesStages":{
            "title":"Sales Stages",
            "type":"array",
            "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
            "items":{
                "$ref":"#/components/schemas/setupAssistants-Opportunities-SalesStages-item-response"
            }
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : 営業ステージ

タイプ: array

タイトル: Sales Stages

営業ステージ・リソースは、選択した販売メソッドの営業ステージを作成、表示および更新するために使用されます。

ソースを表示

• Array of: object setupAssistants-Opportunities-SalesStages-item-response

{
    "title":"Sales Stages",
    "type":"array",
    "description":"The Sales Stages resource is used to create, view and update sales stages for the selected sales method.",
    "items":{
        "$ref":"#/components/schemas/setupAssistants-Opportunities-SalesStages-item-response"
    }
}

ネストされたスキーマ : setupAssistants-Opportunities-SalesStages-item-response

タイプ: object

ソースを表示

• DeletedFlag: boolean
  最大長: 2

  デフォルト値: false

  販売メソッドを削除できるかどうかを示します。
• DescriptionText: string
  最大長: 255

  営業ステージの摘要。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Name: string
  最大長: 50

  セールス・ステージの名前。
• PhaseCd: string
  最大長: 30

  デフォルト値: QUALIFICATION-DISCOVERY

  営業ステージのフェーズのコード。
• RcmndWinProb: string
  最大長: 22

  営業ステージの受注確度。
• StageNumber: string
  読取り専用: true

  最大長: 64

  デフォルト値: -1

  ステージの代替の一意の識別子。
• StageStatusCd: string
  最大長: 30

  デフォルト値: OPEN

  営業ステージのステータスを示すコード。
• StgId: integer
  営業ステージの一意の識別子。
• StgOrder: string
  最大長: 22

  セールス・ステージが表示される順序。

{
    "type":"object",
    "properties":{
        "StageNumber":{
            "maxLength":64,
            "type":"string",
            "description":"An alternate unique identifier of the stage.",
            "nullable":true,
            "readOnly":true,
            "default":"-1",
            "x-queryable":true
        },
        "StageStatusCd":{
            "maxLength":30,
            "type":"string",
            "description":"A code indicating the status of the sales stage.",
            "nullable":false,
            "default":"OPEN",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StgId":{
            "type":"integer",
            "description":"The unique identifier of the sales stage.",
            "nullable":false,
            "x-queryable":true
        },
        "RcmndWinProb":{
            "maxLength":22,
            "type":"string",
            "description":"The win probability of sales stage.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates if the sales method can be deleted.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PhaseCd":{
            "maxLength":30,
            "type":"string",
            "description":"The code for phase of sales stage.",
            "nullable":false,
            "default":"QUALIFICATION-DISCOVERY",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DescriptionText":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the sales stage.",
            "nullable":true,
            "x-queryable":true
        },
        "StgOrder":{
            "maxLength":22,
            "type":"string",
            "description":"The order in which the sales stage will be displayed.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the sales stage.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : setupAssistants-ProductGroups-item-response

タイプ: object

ソースを表示

• Description: string
  最大長: 1000

  製品グループの摘要。
• DisplayName: string
  最大長: 150

  製品グループの名前。
• Id: string
  製品グループの一意の識別子。
• InternalName: string
  最大長: 150

  製品グループの内部名。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。

{
    "type":"object",
    "properties":{
        "DisplayName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the product group.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of the product group.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"A description for the product group.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalName":{
            "maxLength":150,
            "type":"string",
            "description":"The internal name of the product group.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : setupAssistants-RoleMappings-item-response

タイプ: object

ソースを表示

• Id: string
  リソース・ロールおよびマッピング設定詳細の一意の識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ResourceRoleName: string
  最大長: 60

  リソースのロール名。
• RoleCommonNameCode: string
  リソース・ロールがマップされるコード値アプリケーション・ジョブ・ロール。

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourceRoleName":{
            "maxLength":60,
            "type":"string",
            "description":"The role name of the resource.",
            "nullable":false,
            "x-queryable":true
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of resource role and mapping setup details.",
            "nullable":false,
            "x-queryable":true
        },
        "RoleCommonNameCode":{
            "type":"string",
            "description":"The code value application job role to which resource role will be mapped.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : setupAssistants-SalesForecastings-item-response

タイプ: object

ソースを表示

• EnableForecasting: string
  最大長: 1

  デフォルト値: N

  販売予測設定を実行する必要があるかどうかを示します。
• Id: string
  販売予測設定タスクの一意の識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。

{
    "type":"object",
    "properties":{
        "EnableForecasting":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if sales forecast setup has to be done.",
            "nullable":false,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of the sales forecast setup task.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : setupAssistants-SalesStages-item-response

タイプ: object

ソースを表示

• DeletedFlag: boolean
  最大長: 2

  デフォルト値: false

  販売メソッドを削除できるかどうかを示します。
• DescriptionText: string
  最大長: 255

  営業ステージの摘要。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Name: string
  最大長: 50

  セールス・ステージの名前。
• PhaseCd: string
  最大長: 30

  デフォルト値: QUALIFICATION-DISCOVERY

  営業ステージのフェーズのコード。
• RcmndWinProb: string
  最大長: 22

  営業ステージの受注確度。
• StageNumber: string
  読取り専用: true

  最大長: 64

  デフォルト値: -1

  ステージの代替の一意の識別子。
• StageStatusCd: string
  最大長: 30

  デフォルト値: OPEN

  営業ステージのステータスを示すコード。
• StgId: integer
  営業ステージの一意の識別子。
• StgOrder: string
  最大長: 22

  セールス・ステージが表示される順序。

{
    "type":"object",
    "properties":{
        "StageNumber":{
            "maxLength":64,
            "type":"string",
            "description":"An alternate unique identifier of the stage.",
            "nullable":true,
            "readOnly":true,
            "default":"-1",
            "x-queryable":true
        },
        "StageStatusCd":{
            "maxLength":30,
            "type":"string",
            "description":"A code indicating the status of the sales stage.",
            "nullable":false,
            "default":"OPEN",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StgId":{
            "type":"integer",
            "description":"The unique identifier of the sales stage.",
            "nullable":false,
            "x-queryable":true
        },
        "RcmndWinProb":{
            "maxLength":22,
            "type":"string",
            "description":"The win probability of sales stage.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates if the sales method can be deleted.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PhaseCd":{
            "maxLength":30,
            "type":"string",
            "description":"The code for phase of sales stage.",
            "nullable":false,
            "default":"QUALIFICATION-DISCOVERY",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DescriptionText":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the sales stage.",
            "nullable":true,
            "x-queryable":true
        },
        "StgOrder":{
            "maxLength":22,
            "type":"string",
            "description":"The order in which the sales stage will be displayed.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the sales stage.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : setupAssistants-SetupHistory-item-response

タイプ: object

ソースを表示

• History: string
  読取り専用: true

  設定タスクの設定データ履歴。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• TaskCode: string
  読取り専用: true

  設定アシスタントの設定タスクのコード値。

{
    "type":"object",
    "properties":{
        "History":{
            "type":"string",
            "description":"The setup data history of the setup task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TaskCode":{
            "type":"string",
            "description":"The code value of the setup task in the Setup Assistant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : setupAssistants-SetupProgress-item-response

タイプ: object

ソースを表示

• Active: string
  読取り専用: true

  最大長: 255

  この設定タスクがアクティブかどうかを示します。
• ErrorMessage: string
  読取り専用: true

  失敗した設定タスクに関連付けられたエラー・メッセージ。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• TaskCode: string
  読取り専用: true

  設定アシスタントの設定タスクのコード値。
• TaskName: string
  読取り専用: true

  設定アシスタントの設定タスクの名前。
• TaskOrder: string
  読取り専用: true

  最大長: 255

  設定タスクが表示される順序。
• TaskStatus: string
  読取り専用: true

  設定アシスタントでの設定タスクのステータス。
• TaskStatusCode: string
  読取り専用: true

  設定アシスタントのステータス・ページに表示される設定タスク・ステータスのコード値。

{
    "type":"object",
    "properties":{
        "TaskOrder":{
            "maxLength":255,
            "type":"string",
            "description":"The order in which setup task will be displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskCode":{
            "type":"string",
            "description":"The code value of the setup task in the Setup Assistant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Active":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates if the this setup task is active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskName":{
            "type":"string",
            "description":"The name of the setup task in the Setup Assistant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskStatusCode":{
            "type":"string",
            "description":"The code value of setup task status displayed in the Status page of the Setup Assistant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TaskStatus":{
            "type":"string",
            "description":"The status of the setup task in the Setup Assistant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "type":"string",
            "description":"The error message associated with a failed setup task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : setupAssistants-SetupUsers-item-response

タイプ: object

ソースを表示

• Email: string
  最大長: 320

  更新の送信先となる設定ユーザーのEメール。
• FirstName: string
  最大長: 150

  設定ユーザーの名。
• Id: string
  最大長: 80

  設定ユーザー設定タスクの一意の識別子。
• LastName: string
  最大長: 150

  設定ユーザーの姓。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of a setup user setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "Email":{
            "maxLength":320,
            "type":"string",
            "description":"The email of the setup user to whom updates will be sent.",
            "nullable":false,
            "x-queryable":true
        },
        "LastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the setup user.",
            "nullable":false,
            "x-queryable":true
        },
        "FirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the setup user.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : setupAssistants-TopSalesUsers-item-response

タイプ: object

ソースを表示

• EMail: string
  最大長: 320

  上位営業ユーザーのEメール。
• FirstName: string
  最大長: 150

  最上位営業ユーザーの名。
• Id: string
  最上位営業ユーザー設定詳細の一意の識別子。
• LastName: string
  最大長: 150

  最上位営業ユーザーの姓。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ResourceOrganization: string
  最大長: 240

  営業ユーザーが属するリソース組織。

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of top sales user setup details.",
            "nullable":false,
            "x-queryable":true
        },
        "LastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the top sales user.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceOrganization":{
            "maxLength":240,
            "type":"string",
            "description":"The resource organization to which the sales user belongs.",
            "nullable":false,
            "x-queryable":true
        },
        "EMail":{
            "maxLength":320,
            "type":"string",
            "description":"The email of the top sales user.",
            "nullable":false,
            "x-queryable":true
        },
        "FirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the top sales user.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

リンク

AccountingCalendars

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AccountingCalendars

パラメータ:

• 名前: $request.path.Name

会計カレンダ・リソースは、会計カレンダの作成に使用されます。

AdaptiveSearch

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AdaptiveSearch

パラメータ:

• 名前: $request.path.Name

適応型検索リソースは、適応型検索の構成を表示、作成および更新するために使用されます。 この構成は、適応検索公開タスクを発行するために使用されます。

CompanyProfiles

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/CompanyProfiles

パラメータ:

• 名前: $request.path.Name

企業プロファイル・リソースは、企業情報の作成に使用されます。

競合相手

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Competitors

パラメータ:

• 名前: $request.path.Name

競合相手リソースは、競合相手の作成に使用されます。

地理

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Geographies

パラメータ:

• 名前: $request.path.Name

地理リソースは、地理のインポートとジオコーディングの有効化に使用されます。

商談

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Opportunities

パラメータ:

• 名前: $request.path.Name

商談リソースは、商談設定の作成、表示および更新に使用されます。

ProductGroups

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/ProductGroups

パラメータ:

• 名前: $request.path.Name

製品グループ・リソースは、ルート製品グループの作成に使用されます。

RoleMappings

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/RoleMappings

パラメータ:

• 名前: $request.path.Name

リソース・ロール・マッピング・リソースは、リソース・ロールとロール・マッピングの作成に使用されます。

SalesForecastings

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SalesForecastings

パラメータ:

• 名前: $request.path.Name

売上予測リソースは、所有者ベースの売上予測を設定するために使用されます。

SalesStages

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SalesStages

パラメータ:

• 名前: $request.path.Name

営業ステージ・リソースは、選択した販売メソッドの営業ステージを作成、表示および更新するために使用されます。

SetupHistory

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupHistory

パラメータ:

• 名前: $request.path.Name

設定履歴リソースは、設定アシスタントによって取得された設定データの表示に使用されます。

SetupProgress

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupProgress

パラメータ:

• 名前: $request.path.Name

Setup Progress(設定進捗)リソースは、設定アシスタントによって開始された設定タスクの進捗をモニターするために使用されます。

SetupUsers

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/SetupUsers

パラメータ:

• 名前: $request.path.Name

設定ユーザーの作成には、設定ユーザー・リソースが使用されます。

TopSalesUsers

操作: /crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/TopSalesUsers

パラメータ:

• 名前: $request.path.Name

最上位営業ユーザー・リソースは、最上位営業ユーザーを作成し、営業階層の最上位にユーザーを設定するために使用されます。

「トップに戻る」