機械翻訳について

ジャンプ先

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

ケース世帯の更新

patch

/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseHouseholds/{CaseHouseholdId}

リクエスト

パス・パラメータ

• CaseHouseholdId(required): integer(int64)
  事例世帯の一意の識別子。
• CaseNumber(required): string
  ケースの代替キー識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• CorpCurrencyCode: string
  タイトル: Corporate Currency Code

  最大長: 15

  事例世帯の企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
• CurcyConvRateType: string
  タイトル: Currency Conversion Rate Type

  最大長: 30

  事例世帯に関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
• CurrencyCode: string
  タイトル: Currency Code

  最大長: 15

  事例世帯に関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
• HouseholdName: string
  タイトル: Household Name

  最大長: 360

  世帯の名前
• PartyId: integer (int64)
  タイトル: Party ID

  パーティの一意識別子

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "HouseholdName":{
            "title":"Household Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the household.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : cases-caseHouseholds-item-response

タイプ: object

ソースを表示

• CaseHouseholdId: integer (int64)
  タイトル: Household ID

  読取り専用: true

  事例世帯の一意の識別子。
• CaseId: integer (int64)
  タイトル: Case ID

  ケースの一意の識別子。
• CaseNumber: string
  タイトル: Case Number

  最大長: 30

  ケースの代替キー識別子。
• CorpCurrencyCode: string
  タイトル: Corporate Currency Code

  最大長: 15

  事例世帯の企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  ケースの世帯を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  ケース世帯が作成された日時。
• CurcyConvRateType: string
  タイトル: Currency Conversion Rate Type

  最大長: 30

  事例世帯に関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
• CurrencyCode: string
  タイトル: Currency Code

  最大長: 15

  事例世帯に関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
• DeleteFlag: boolean
  タイトル: Delete

  読取り専用: true

  レコードを削除できるかどうかを示します。
• HouseholdName: string
  タイトル: Household Name

  最大長: 360

  世帯の名前
• HouseholdPartyNumber: string
  タイトル: Household Party Number

  読取り専用: true

  最大長: 30

  世帯パーティの代替キー識別子。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  ケースの世帯が最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  ケースの世帯を最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  ケースの世帯を最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PartyId: integer (int64)
  タイトル: Party ID

  パーティの一意識別子
• PrimaryFlag: boolean
  タイトル: Primary Household

  読取り専用: true

  世帯がケースのプライマリ世帯かどうかを示します。
• UpdateFlag: boolean
  タイトル: Update

  読取り専用: true

  レコードを更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the household for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the case household was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the household for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary Household",
            "type":"boolean",
            "description":"Indicates whether the household is the primary household for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "HouseholdName":{
            "title":"Household Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the household.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "HouseholdPartyNumber":{
            "title":"Household Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the household party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CaseHouseholdId":{
            "title":"Household ID",
            "type":"integer",
            "description":"The unique identifier of the case household.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the household for the case was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the household for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

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

リンク

HouseholdVO

操作: /crmRestApi/resources/11.13.18.05/households

世帯の作成または更新中に値を格納するために使用される属性を含むオブジェクト。 世帯は、取引先または担当者のいずれかとの関係を持つグループです。

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するパッチ・リクエストを発行することによって、ケース世帯を更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseHouseholds/{CaseHouseholdId}

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

 {
    "CaseHouseholdId": 300100215793300,
    "CaseId": 300100215793299,
    "CorpCurrencyCode": null,
    "CreatedBy": "AUTOUICASE1",
    "CreationDate": "2021-08-23T06:29:08+00:00",
    "CurcyConvRateType": null,
    "CurrencyCode": "USD",
    "LastUpdateLogin": "C9E50EC5A48BEE00E05323EAF40A1FFD",
    "PartyId": 100100035557303
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

  {
    "CaseHouseholdId": 300100215793300,
    "CaseId": 300100215793299,
    "CorpCurrencyCode": null,
    "CreatedBy": "AUTOUICASE1",
    "CreationDate": "2021-08-23T06:29:08+00:00",
    "CurcyConvRateType": null,
    "CurrencyCode": "USD",
    "LastUpdateDate": "2021-08-26T09:21:40.066+00:00",
    "LastUpdateLogin": "CA5FA2C688BDCFA5E05322EAF40A7B58",
    "LastUpdatedBy": "SALES_ADMIN",
    "PartyId": 100100035557303,
    "HouseholdPartyNumber": "IMP_GRP_12_",
    "HouseholdName": "IMP_GRP_34",
    "CaseNumber": "CDRM_4003",
    "PrimaryFlag": false,
    "UpdateFlag": true,
    "DeleteFlag": true,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseHouseholds/300100215793300",
            "name": "caseHouseholds",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseHouseholds/300100215793300",
            "name": "caseHouseholds",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003",
            "name": "cases",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseHouseholds/300100215793300/lov/HouseholdVO",
            "name": "HouseholdVO",
            "kind": "collection"
        }
    ]
}

「トップに戻る」