機械翻訳について

ジャンプ先

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

選択した販売メソッドの営業ステージの作成

post

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

リクエスト

パス・パラメータ

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

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

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

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

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

タイプ: object

ソースを表示

• DeletedFlag: boolean
  最大長: 2

  デフォルト値: false

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

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

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

  デフォルト値: QUALIFICATION-DISCOVERY

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

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

  デフォルト値: OPEN

  営業ステージのステータスを示すコード。
• StgId: integer
  営業ステージの一意の識別子。
• 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"
            }
        },
        "StgId":{
            "type":"integer",
            "description":"The unique identifier of the sales stage.",
            "nullable":false
        },
        "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
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : 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"
    }
}

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

タイプ: 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."
        }
    }
}

「トップに戻る」