Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

担当者の更新

patch

/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/ContactPoint/{ContactPointId}

リクエスト

パス・パラメータ

ContactPointId(required): integer(int64)

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

世帯パーティの一意のプライマリ識別子。プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、属性値をシステム生成にできるか、作成中にユーザー指定にできるかを制御します。「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。非アクティブなレコードは更新できません。

ヘッダー・パラメータ

Metadata-Context:

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

application/json

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

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

タイプ: object

ソースを表示

ConflictId: integer (int64)

デフォルト値: 0

担当者レコードの競合の一意の識別子。この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
CreatedByModule: string

タイトル: Created by Application

デフォルト値: HZ_WS

この担当者レコードを作成したアプリケーション・モジュール。すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。設定およびメンテナンス・タスクの取引先コミュニティ共通参照の管理を使用して、コードをレビューおよび更新できます。
DoContactPreferenceFlag: boolean

タイトル: OK to Contact

特定の連絡メソッドを使用するかどうかを示します。デフォルトはfalseです。
DoNotContactPreferenceFlag: boolean

レコードを連絡できるかどうかを示します。
DoNotContactReason: string

担当者プリファレンスの事由コード。
EmailAddress: string

最大長: 255

Eメール・タイプの担当者レコードのEメール・アドレス。
EmailPurpose: string

タイトル: Email Purpose

最大長: 30

EMAIL担当者を使用する目的。受け入れられる値は、参照タイプCONTACT_POINT_PURPOSEで定義されます。値は、ASSISTANT、PERSONAL、HOME_BUSINESS、BUSINESSなどになります。
ObjectVersionNumber: 整数(int32)

担当者レコードに対するオプティミスティック・ロックの実装に使用される番号。この番号は、行を更新するたびに増分されます。問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
PartyId: integer (int64)

担当者の関連パーティ・レコードの一意の識別子。
PartyNumber: string

関連パーティ・レコードの公開一意識別子。
PartySourceSystem: string

担当者が関連付けられているアカウント、担当者または世帯の外部ソース・システムの名前。 PartyourceSystemReferenceValueとともに、取引先、担当者または世帯レコードの代替キーの一部。住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。
PartySourceSystemReferenceValue: string

住所が関連付けられているアカウント、担当者または世帯の外部ソース・システムの一意の識別子。代替キーの一部とPartySourceSystem。住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
PhoneAreaCode: string

最大長: 255

電話番号の市外局番。
PhoneCountryCode: string

最大長: 255

電話番号の国コード。
PhoneExtension: string

最大長: 255

オフィス・デスク内線番号などの電話回線番号の内線番号。
PhoneNumber: string

最大長: 255

担当者の電話番号。
PhonePurpose: string

タイトル: Phone Purpose

最大長: 30

PHONE担当者を使用する目的を定義します。使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE.Sample値で定義されます: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
PhoneType: string

電話担当者のタイプ。受け入れられる値は、参照タイプORA_HZ_PHONE_TYPEで定義されます。値は、WORK、HOME、FAXなどになります。
PreferenceRequestedBy: string

タイトル: Preference Requested By

権限または制限が内部で作成されたか、パーティによってリクエストされたかを示します。受け入れられる値のリストは、REQUESTED_BY参照で定義されます。
PrimaryFlag: boolean

タイトル: Primary

最大長: 1

デフォルト値: false

これが関連オブジェクトのプライマリ担当者かどうかを示します。値がTrueの場合、これがプライマリ担当者です。デフォルト値は「False」です。この属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。
RawPhoneNumber: string

最大長: 255

電話タイプの担当者レコードの未処理電話番号。
SocialNetworkId: string

ソーシャル・ネットワークの一意の識別子。
SocialNetworkName: string

ソーシャル・ネットワークの名前。
SocialNetworkPurpose: string

タイトル: Social Network Purpose

最大長: 30

IM担当者を使用する目的を定義します。使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE.Sample値で定義されます: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
SourceSystem: string

システム設定の一部として管理者が定義する外部ソース・システムの名前。これは、SourceSystemReferenceとともに代替キーの一部であり、PKまたはpartyNumberBusinessKeyが更新で渡されない場合は必須です。
SourceSystemReferenceValue: string

属性SourceSystemで指定された外部ソース・システムからの担当者パーティの一意の識別子。これは、SourceSystemReferenceとともに代替キーの一部であり、PKまたはpartyNumberBusinessKeyが更新で渡されない場合は必須です。
Status: string

最大長: 30

デフォルト値: A

担当者のステータスを示します。ステータス・コードは、参照HZ_STATUSで定義されます。デフォルト値はAです。
URL: string

担当者のURL。
VerificationDate: 文字列(日付)

タイトル: Verification Date

電話またはEメールの担当者の検証日。
VerificationStatus: string

タイトル: Verification Status

最大長: 30

電話またはEメールの担当者の検証のステータス。受け入れられる値は、標準参照タイプORA_HZ_VALIDATION_STATUSでORA_VALID、ORA_INVALIDおよびORA_PARTIALLY_VALIDとして定義されます。値ORA_PARTIALLY_VALIDは、電子メールにのみ適用できます。デフォルト値は空白で、値が検証されないことを示します。
WebPurpose: string

タイトル: Web Purpose

最大長: 30

WEB担当者を使用する目的を定義します。使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE_WEB.Sample値で定義されます: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.

{
    "type":"object",
    "properties":{
        "VerificationStatus":{
            "title":"Verification Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the verification for phone or email contact points. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. The value ORA_PARTIALLY_VALID is applicable only for email. Default value is blank which indicates that values aren't verified.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VerificationDate":{
            "title":"Verification Date",
            "type":"string",
            "description":"The date of verification of the phone or email contact point.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VerificationStatus"
                ]
            }
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this is the primary contact point of the associated object. If the value is True, then this is the primary contact point. The default value is False. If this attribute isn't explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "nullable":true,
            "default":false
        },
        "SocialNetworkId":{
            "type":"string",
            "description":"The unique identifier of the social network.",
            "nullable":true,
            "x-hints":{
                "Property":"Social Network Account"
            }
        },
        "URL":{
            "type":"string",
            "description":"The URL of the contact point.",
            "nullable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict for the contact point record. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key along with PartySourceSystem. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneAreaCode":{
            "maxLength":255,
            "type":"string",
            "description":"The area code for the phone number.",
            "nullable":true
        },
        "PhoneCountryCode":{
            "maxLength":255,
            "type":"string",
            "description":"The country code of the phone number.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking for contact point record. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "type":"string",
            "description":"The application module that created this contact point record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the contact point. The status codes are defined in the lookup HZ_STATUS. The default value is A.",
            "nullable":false,
            "default":"A"
        },
        "SocialNetworkPurpose":{
            "title":"Social Network Purpose",
            "maxLength":30,
            "type":"string",
            "description":"Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"The name of external source system of the account, contact or household with which the contact point is associated. Part of alternate key for the account, contact or household record along with PartyourceSystemReferenceValue. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-queryable":false
        },
        "DoNotContactReason":{
            "type":"string",
            "description":"The reason code for the contact preference.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhonePurpose":{
            "title":"Phone Purpose",
            "maxLength":30,
            "type":"string",
            "description":"Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PreferenceRequestedBy":{
            "title":"Preference Requested By",
            "type":"string",
            "description":"Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DoContactPreferenceFlag":{
            "title":"OK to Contact",
            "type":"boolean",
            "description":"Indicates whether to use a particular contact method. Defaulted to false.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "maxLength":255,
            "type":"string",
            "description":"The email address of the contact point record of type email.",
            "nullable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the contacts party from the external source system specified in the attribute SourceSystem. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't passed in update.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneExtension":{
            "maxLength":255,
            "type":"string",
            "description":"The extension number of the phone line number like office desk extension.",
            "nullable":true
        },
        "PartyNumber":{
            "type":"string",
            "description":"The public unique identifier of the associated party record.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the associated party record for contact point.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PhoneType":{
            "type":"string",
            "description":"The type of phone contact point. The accepted values are defined in the lookup type ORA_HZ_PHONE_TYPE. The values can be WORK, HOME, FAX, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DoNotContactPreferenceFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be contacted.",
            "nullable":true,
            "x-queryable":false
        },
        "WebPurpose":{
            "title":"Web Purpose",
            "maxLength":30,
            "type":"string",
            "description":"Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EmailPurpose":{
            "title":"Email Purpose",
            "maxLength":30,
            "type":"string",
            "description":"The purpose of using the EMAIL contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE. The values can be ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhoneNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The phone number of the contact point.",
            "nullable":true
        },
        "SocialNetworkName":{
            "type":"string",
            "description":"The name of the social network.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "Property":"Social Network"
            }
        },
        "RawPhoneNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The raw phone number on the contact point record of type phone.",
            "nullable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system, which is defined by an administrator as part of system setup. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't passed in update.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : households-ContactPoint-item-response

タイプ: object

ソースを表示

ConflictId: integer (int64)

デフォルト値: 0

担当者レコードの競合の一意の識別子。この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
ContactPointId: integer (int64)

読取り専用: true

担当者の一意の識別子。
ContactPointType: string

タイトル: Type

最大長: 30

担当者レコードのタイプ。受け入れられる値は、参照タイプCOMMUNICATION_TYPEで定義されます。値はPHONE、EMAIL、WEBなどです。
CreatedBy: string

読取り専用: true

最大長: 64

担当者レコードを作成したユーザー。
CreatedByModule: string

タイトル: Created by Application

デフォルト値: HZ_WS

この担当者レコードを作成したアプリケーション・モジュール。すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。設定およびメンテナンス・タスクの取引先コミュニティ共通参照の管理を使用して、コードをレビューおよび更新できます。
CreationDate: string (date-time)

読取り専用: true

レコードが作成された日付。
DoContactPreferenceFlag: boolean

タイトル: OK to Contact

特定の連絡メソッドを使用するかどうかを示します。デフォルトはfalseです。
DoNotContactPreferenceFlag: boolean

レコードを連絡できるかどうかを示します。
DoNotContactReason: string

担当者プリファレンスの事由コード。
EmailAddress: string

最大長: 255

Eメール・タイプの担当者レコードのEメール・アドレス。
EmailPurpose: string

タイトル: Email Purpose

最大長: 30

EMAIL担当者を使用する目的。受け入れられる値は、参照タイプCONTACT_POINT_PURPOSEで定義されます。値は、ASSISTANT、PERSONAL、HOME_BUSINESS、BUSINESSなどになります。
FormattedPhoneNumber: string

読取り専用: true

最大長: 255

担当者のフォーマット済電話番号。
LastUpdateDate: string (date-time)

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

担当者レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

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

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectVersionNumber: 整数(int32)

担当者レコードに対するオプティミスティック・ロックの実装に使用される番号。この番号は、行を更新するたびに増分されます。問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
PartyId: integer (int64)

担当者の関連パーティ・レコードの一意の識別子。
PartyNumber: string

関連パーティ・レコードの公開一意識別子。
PartySourceSystem: string

担当者が関連付けられているアカウント、担当者または世帯の外部ソース・システムの名前。 PartyourceSystemReferenceValueとともに、取引先、担当者または世帯レコードの代替キーの一部。住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。
PartySourceSystemReferenceValue: string

住所が関連付けられているアカウント、担当者または世帯の外部ソース・システムの一意の識別子。代替キーの一部とPartySourceSystem。住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
PhoneAreaCode: string

最大長: 255

電話番号の市外局番。
PhoneCountryCode: string

最大長: 255

電話番号の国コード。
PhoneExtension: string

最大長: 255

オフィス・デスク内線番号などの電話回線番号の内線番号。
PhoneNumber: string

最大長: 255

担当者の電話番号。
PhonePurpose: string

タイトル: Phone Purpose

最大長: 30

PHONE担当者を使用する目的を定義します。使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE.Sample値で定義されます: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
PhoneType: string

電話担当者のタイプ。受け入れられる値は、参照タイプORA_HZ_PHONE_TYPEで定義されます。値は、WORK、HOME、FAXなどになります。
PreferenceRequestedBy: string

タイトル: Preference Requested By

権限または制限が内部で作成されたか、パーティによってリクエストされたかを示します。受け入れられる値のリストは、REQUESTED_BY参照で定義されます。
PrimaryFlag: boolean

タイトル: Primary

最大長: 1

デフォルト値: false

これが関連オブジェクトのプライマリ担当者かどうかを示します。値がTrueの場合、これがプライマリ担当者です。デフォルト値は「False」です。この属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。
RawPhoneNumber: string

最大長: 255

電話タイプの担当者レコードの未処理電話番号。
SocialNetworkId: string

ソーシャル・ネットワークの一意の識別子。
SocialNetworkName: string

ソーシャル・ネットワークの名前。
SocialNetworkPurpose: string

タイトル: Social Network Purpose

最大長: 30

IM担当者を使用する目的を定義します。使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE.Sample値で定義されます: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
SourceSystem: string

システム設定の一部として管理者が定義する外部ソース・システムの名前。これは、SourceSystemReferenceとともに代替キーの一部であり、PKまたはpartyNumberBusinessKeyが更新で渡されない場合は必須です。
SourceSystemReferenceValue: string

属性SourceSystemで指定された外部ソース・システムからの担当者パーティの一意の識別子。これは、SourceSystemReferenceとともに代替キーの一部であり、PKまたはpartyNumberBusinessKeyが更新で渡されない場合は必須です。
Status: string

最大長: 30

デフォルト値: A

担当者のステータスを示します。ステータス・コードは、参照HZ_STATUSで定義されます。デフォルト値はAです。
URL: string

担当者のURL。
VerificationDate: 文字列(日付)

タイトル: Verification Date

電話またはEメールの担当者の検証日。
VerificationStatus: string

タイトル: Verification Status

最大長: 30

電話またはEメールの担当者の検証のステータス。受け入れられる値は、標準参照タイプORA_HZ_VALIDATION_STATUSでORA_VALID、ORA_INVALIDおよびORA_PARTIALLY_VALIDとして定義されます。値ORA_PARTIALLY_VALIDは、電子メールにのみ適用できます。デフォルト値は空白で、値が検証されないことを示します。
WebPurpose: string

タイトル: Web Purpose

最大長: 30

WEB担当者を使用する目的を定義します。使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE_WEB.Sample値で定義されます: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VerificationStatus":{
            "title":"Verification Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the verification for phone or email contact points. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. The value ORA_PARTIALLY_VALID is applicable only for email. Default value is blank which indicates that values aren't verified.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VerificationDate":{
            "title":"Verification Date",
            "type":"string",
            "description":"The date of verification of the phone or email contact point.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VerificationStatus"
                ]
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this is the primary contact point of the associated object. If the value is True, then this is the primary contact point. The default value is False. If this attribute isn't explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SocialNetworkId":{
            "type":"string",
            "description":"The unique identifier of the social network.",
            "nullable":true,
            "x-hints":{
                "Property":"Social Network Account"
            },
            "x-queryable":true
        },
        "URL":{
            "type":"string",
            "description":"The URL of the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict for the contact point record. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key along with PartySourceSystem. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneAreaCode":{
            "maxLength":255,
            "type":"string",
            "description":"The area code for the phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":255,
            "type":"string",
            "description":"The country code of the phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking for contact point record. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ContactPointId":{
            "type":"integer",
            "description":"The unique identifier of the contact point.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The formatted phone number of the contact point.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "type":"string",
            "description":"The application module that created this contact point record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contact point record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the contact point. The status codes are defined in the lookup HZ_STATUS. The default value is A.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "SocialNetworkPurpose":{
            "title":"Social Network Purpose",
            "maxLength":30,
            "type":"string",
            "description":"Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the contact point record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"The name of external source system of the account, contact or household with which the contact point is associated. Part of alternate key for the account, contact or household record along with PartyourceSystemReferenceValue. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-queryable":false
        },
        "DoNotContactReason":{
            "type":"string",
            "description":"The reason code for the contact preference.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhonePurpose":{
            "title":"Phone Purpose",
            "maxLength":30,
            "type":"string",
            "description":"Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PreferenceRequestedBy":{
            "title":"Preference Requested By",
            "type":"string",
            "description":"Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DoContactPreferenceFlag":{
            "title":"OK to Contact",
            "type":"boolean",
            "description":"Indicates whether to use a particular contact method. Defaulted to false.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "maxLength":255,
            "type":"string",
            "description":"The email address of the contact point record of type email.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the contacts party from the external source system specified in the attribute SourceSystem. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't passed in update.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneExtension":{
            "maxLength":255,
            "type":"string",
            "description":"The extension number of the phone line number like office desk extension.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "type":"string",
            "description":"The public unique identifier of the associated party record.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the associated party record for contact point.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PhoneType":{
            "type":"string",
            "description":"The type of phone contact point. The accepted values are defined in the lookup type ORA_HZ_PHONE_TYPE. The values can be WORK, HOME, FAX, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DoNotContactPreferenceFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be contacted.",
            "nullable":true,
            "x-queryable":false
        },
        "WebPurpose":{
            "title":"Web Purpose",
            "maxLength":30,
            "type":"string",
            "description":"Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EmailPurpose":{
            "title":"Email Purpose",
            "maxLength":30,
            "type":"string",
            "description":"The purpose of using the EMAIL contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE. The values can be ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The phone number of the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "SocialNetworkName":{
            "type":"string",
            "description":"The name of the social network.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "Property":"Social Network"
            },
            "x-queryable":true
        },
        "ContactPointType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of contact point record. The accepted values are defined in the lookup type COMMUNICATION_TYPE. The values can be PHONE, EMAIL, WEB, and so on.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RawPhoneNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The raw phone number on the contact point record of type phone.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system, which is defined by an administrator as part of system setup. It's part of alternate key along with SourceSystemReference, and is mandatory if PK or partyNumberBusinessKey isn't passed in update.",
            "nullable":true,
            "x-queryable":false
        },
        "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."
        }
    }
}

リンク

ContactPointPurposeWebLookupVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE_WEB%2CLookupCode%3D{WebPurpose}

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: WebPurpose;ターゲット属性: LookupCode
表示属性: 意味

ContactPointTypeLimitedLookUpVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DCOMMUNICATION_TYPE%2CLookupCode%3D{ContactPointType}

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ContactPointType;ターゲット属性: LookupCode
表示属性: 意味

EmailPurposeLookupVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{EmailPurpose}

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: EmailPurpose;ターゲット属性: LookupCode
表示属性: 意味

InstantMessengerTypeVOVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE%2CLookupCode%3D{SocialNetworkName}

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: SocialNetworkName;ターゲット属性: LookupCode
表示属性: LookupCode

PhonePurposeLookupVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{PhonePurpose}

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: PhonePurpose;ターゲット属性: LookupCode
表示属性: 意味

PhoneTypeLookupVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_HZ_PHONE_TYPE%2CLookupCode%3D{PhoneType}

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: PhoneType;ターゲット属性: LookupCode
表示属性: 意味

PreferenceRequestedByLookupVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupCode%3D{PreferenceRequestedBy}%2CLookupType%3DREQUESTED_BY

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: PreferenceRequestedBy;ターゲット属性: LookupCode
表示属性: 意味

ReasonCodesVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DREASON_CODE%2CLookupCode%3D{DoNotContactReason}

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: DoNotContactReason;ターゲット属性: LookupCode
表示属性: 意味

SocialNetworkPurposeLookupVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{SocialNetworkPurpose}

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: SocialNetworkPurpose;ターゲット属性: LookupCode
表示属性: 意味

VerificationStatusLookupVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{VerificationStatus}

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: VerificationStatus;ターゲット属性: LookupCode
表示属性: 意味

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行して、担当者を更新する方法を示しています。

cURLコマンド

curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households/CDRM_896786/child/ContactPoint/300100186878972

リクエスト本文の例

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

{  
"PhoneNumber": "0129837268"
}

レスポンス本文の例

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

{
    "ContactPointId": 300100186878972,
    "ContactPointType": "PHONE",
    "PartyId": 300100186868998,
    "PartyNumber": "CDRM_896786",
    "PartySourceSystem": null,
    "PartySourceSystemReferenceValue": null,
    "EmailAddress": null,
    "EmailPurpose": null,
    "PhoneType": "LAND",
    "PhoneAreaCode": null,
    "PhoneExtension": null,
    "PhoneCountryCode": "1",
    "RawPhoneNumber": "1-7849272947",
    "PhoneNumber": "0129837268",
    "FormattedPhoneNumber": "+1 (012) 983-7268",
    "URL": null,
    "PrimaryFlag": true,
    "Status": "A",
    "SourceSystem": null,
    "SourceSystemReferenceValue": null,
    "CreatedBy": "SALES_ADMIN",
    "CreatedByModule": "HZ_WS",
    "CreationDate": "2021-03-05T05:41:42.001+00:00",
    "LastUpdateDate": "2021-03-05T05:43:33+00:00",
    "LastUpdateLogin": "BCAA665F95288116E0533AFDF40AD64C",
    "LastUpdatedBy": "SALES_ADMIN",
    "ObjectVersionNumber": 2,
    "DoContactPreferenceFlag": false,
    "DoNotContactPreferenceFlag": false,
    "DoNotContactReason": null,
    "ConflictId": 0,
    "SocialNetworkName": null,
    "SocialNetworkId": null,
    "PhonePurpose": null,
    "WebPurpose": null,
    "SocialNetworkPurpose": null,
    "links": [
...
}

「トップに戻る」