機械翻訳について

ジャンプ先

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

販売実績の更新

patch

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/salesCredits/{SalesCreditPuid}

リクエスト

パス・パラメータ

• SalesCreditPuid(required): string
  販売実績PUID。
• SubscriptionNumber(required): string
  サブスクリプションの代替識別子。
• SubscriptionProductPuid(required): string
  サブスクリプション製品PUID。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• EndDate: 文字列(日付)
  クレジット・カードが無効になる日付。
• パーセント: number
  販売実績のパーセント。
• SalesCreditId: integer (int64)
  販売実績の一意の識別子。
• SalesCreditPuid: string
  最大長: 120

  販売実績PUID。
• SalesCreditTypeId: integer (int64)
  販売実績タイプの一意の識別子。
• SalesPerson: string
  営業担当。
• SalesPersonNumber: string
  タイトル: Salesperson Number

  営業担当の代替識別子。
• SalesrepId: integer (int64)
  営業担当の一意の識別子。
• StartDate: 文字列(日付)
  販売実績が開始する日付。
• SubscriptionId: integer (int64)
  サブスクリプションの一意の識別子。
• SubscriptionProductId: integer (int64)
  サブスクリプション製品ID。

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"The date when the sales credit starts.",
            "format":"date",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage of sales credit.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            }
        },
        "SalesPerson":{
            "type":"string",
            "description":"The sales person.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SalesCreditPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The sales credit PUID.",
            "nullable":false
        },
        "SalesCreditTypeId":{
            "type":"integer",
            "description":"The unique identifier of the sales credit type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "SalesrepId":{
            "type":"integer",
            "description":"The unique identifier of the sales representative.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SalesPersonNumber":{
            "title":"Salesperson Number",
            "type":"string",
            "description":"The alternate identifier of a salesperson.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the credit card becomes invalid.",
            "format":"date",
            "nullable":true
        },
        "SalesCreditId":{
            "type":"integer",
            "description":"The unique identifier of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : subscriptions-products-salesCredits-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  レコードが作成された日付。
• EndDate: 文字列(日付)
  クレジット・カードが無効になる日付。
• LastUpdateDate: string (date-time)
  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• パーセント: number
  販売実績のパーセント。
• QuotaFlag: boolean
  読取り専用: true

  最大長: 1

  販売実績の目標を示します。
• SalesCreditId: integer (int64)
  販売実績の一意の識別子。
• SalesCreditPuid: string
  最大長: 120

  販売実績PUID。
• SalesCreditType: string
  販売実績タイプです。
• SalesCreditTypeId: integer (int64)
  販売実績タイプの一意の識別子。
• SalesPerson: string
  営業担当。
• SalesPersonNumber: string
  タイトル: Salesperson Number

  営業担当の代替識別子。
• SalesrepId: integer (int64)
  営業担当の一意の識別子。
• StartDate: 文字列(日付)
  販売実績が開始する日付。
• SubscriptionId: integer (int64)
  サブスクリプションの一意の識別子。
• SubscriptionProductId: integer (int64)
  サブスクリプション製品ID。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage of sales credit.",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "SalesPerson":{
            "type":"string",
            "description":"The sales person.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SalesCreditTypeId":{
            "type":"integer",
            "description":"The unique identifier of the sales credit type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "SalesrepId":{
            "type":"integer",
            "description":"The unique identifier of the sales representative.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesPersonNumber":{
            "title":"Salesperson Number",
            "type":"string",
            "description":"The alternate identifier of a salesperson.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "QuotaFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the quota of the sales credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesCreditType":{
            "type":"string",
            "description":"The sales credit type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the credit card becomes invalid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the sales credit starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesCreditPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The sales credit PUID.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesCreditId":{
            "type":"integer",
            "description":"The unique identifier of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "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"
    }
}

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

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

「トップに戻る」