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

機械翻訳について

担当者の更新

patch

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

リクエスト

パス・パラメータ

ContactPointId(required): integer(int64)

担当者の一意の識別子。
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

モジュールを作成したユーザー。
DoContactPreferenceFlag: boolean

タイトル: OK to Contact

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

DNCオプションを示す担当者プリファレンス・フラグ。
DoNotContactReason: string

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

最大長: 255

担当者の電子メール・アドレス。
EmailPurpose: string

タイトル: Email Purpose

最大長: 30

Eメール・アドレスの目的。
ObjectVersionNumber: 整数(int32)

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

パーティの一意識別子
PartyNumber: string

担当者の代替一意識別子。
PartySourceSystem: string

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

外部ソース・システムからのレコードの識別子。
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で定義されます。設定およびメンテナンス・タスクの標準参照の管理を使用して、コードをレビューおよび更新できます。
PreferenceRequestedBy: string

タイトル: Preference Requested By

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

タイトル: Primary

最大長: 1

デフォルト値: false

電話番号が優先されるかどうかを示します。
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

担当者のステータス。
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 the phone number is preferred.",
            "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 associated with the contact point.",
            "nullable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict. 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 identifier for the record from an external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneAreaCode":{
            "maxLength":255,
            "type":"string",
            "description":"The area code for the telephone 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. 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 user who created the module.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the contact point.",
            "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 address 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.",
            "nullable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the contacts party from the external source system specified in the attribute SourceSystem. It  is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not 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 alternate unique identifier of the contact point.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PhoneType":{
            "type":"string",
            "description":"The type of the phone. A list of valid phone types is defined in the lookup ORA_HZ_PHONE_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Standard Lookups.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DoNotContactPreferenceFlag":{
            "type":"boolean",
            "description":"The contact preference flag that indicates DNC option.",
            "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 the email address.",
            "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 phone number in raw format.",
            "nullable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not 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のデフォルト・バージョンを選択します。

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

タイプ: object

ソースを表示

ConflictId: integer (int64)

デフォルト値: 0

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

読取り専用: true

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

タイトル: Type

最大長: 30

担当者のタイプ。担当者のタイプ。有効な担当者タイプのリストは、参照COMMUNICATION_TYPEで定義されます。設定およびメンテナンス・タスクの担当者参照の管理を使用して、コードをレビューおよび更新できます。
CreatedBy: string

読取り専用: true

最大長: 64

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

タイトル: Created by Application

デフォルト値: HZ_WS

モジュールを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

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

タイトル: OK to Contact

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

DNCオプションを示す担当者プリファレンス・フラグ。
DoNotContactReason: string

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

最大長: 255

担当者の電子メール・アドレス。
EmailPurpose: string

タイトル: Email Purpose

最大長: 30

Eメール・アドレスの目的。
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

外部ソース・システムからのレコードの識別子。
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で定義されます。設定およびメンテナンス・タスクの標準参照の管理を使用して、コードをレビューおよび更新できます。
PreferenceRequestedBy: string

タイトル: Preference Requested By

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

タイトル: Primary

最大長: 1

デフォルト値: false

電話番号が優先されるかどうかを示します。
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

担当者のステータス。
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 the phone number is preferred.",
            "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 associated with the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict. 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 identifier for the record from an external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneAreaCode":{
            "maxLength":255,
            "type":"string",
            "description":"The area code for the telephone 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. 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 user who created the module.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contact point.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the contact point.",
            "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 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 address 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.",
            "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  is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not 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 alternate unique identifier of the contact point.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PhoneType":{
            "type":"string",
            "description":"The type of the phone. A list of valid phone types is defined in the lookup ORA_HZ_PHONE_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Standard Lookups.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DoNotContactPreferenceFlag":{
            "type":"boolean",
            "description":"The contact preference flag that indicates DNC option.",
            "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 the email address.",
            "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 the contact point. The type of contact point. A list of valid contact point types is defined in the lookup COMMUNICATION_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Contact Point Lookups.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RawPhoneNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The phone number in raw format.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the contact point 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 contact point.",
            "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}

webの目的を示す値リスト。

ContactPointTypeLimitedLookUpVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

担当者タイプを示す値リスト。

EmailPurposeLookupVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

Eメールの目的を示す値リスト。

InstantMessengerTypeVOVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

ソーシャル・ネットワーク名の参照リソース。

PhonePurposeLookupVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

電話の目的を示す値リスト。

PhoneTypeLookupVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

電話のタイプを示す値リスト。

PreferenceRequestedByLookupVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

リクエストされたプリファレンスを示す値リスト。

ReasonCodesVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

連絡禁止事由を示す値リスト。

SocialNetworkPurposeLookupVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

ソーシャル・ネットワークの目的を示す値リスト。

VerificationStatusLookupVA

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

検証ステータスを示す値リスト。

トップに戻る

例:

次の例は、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/contacts/CONTACT-1033/child/ContactPoint/300100207305498

リクエスト本文の例

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

{ 
"PhoneNumber":"8860432989"
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "ContactPointId": 300100207305498,
    "ContactPointType": "PHONE",
    "PartyId": -1,
    "PartyNumber": "CONTACT-1033",
    "PartySourceSystem": null,
    "PartySourceSystemReferenceValue": null,
    "EmailAddress": null,
    "EmailPurpose": null,
    "PhoneType": "LAND",
    "PhoneAreaCode": null,
    "PhoneExtension": null,
    "PhoneCountryCode": "1",
    "RawPhoneNumber": "1-12345678",
    "PhoneNumber": "8860432989",
    "FormattedPhoneNumber": "+1 (886) 043-2989",
    "URL": null,
    "PrimaryFlag": false,
    "Status": "A",
    "SourceSystem": null,
    "SourceSystemReferenceValue": null,
    "CreatedBy": "SALES_ADMIN",
    "CreatedByModule": "HZ_WS",
    "CreationDate": "2021-02-26T08:08:47.007+00:00",
    "LastUpdateDate": "2021-02-26T08:11:12+00:00",
    "LastUpdateLogin": "BC29FF8BC3BF3066E0533BFDF40A5839",
    "LastUpdatedBy": "SALES_ADMIN",
    "ObjectVersionNumber": 2,
    "DoContactPreferenceFlag": false,
    "DoNotContactPreferenceFlag": false,
    "DoNotContactReason": null,
    "ConflictId": 0,
    "SocialNetworkName": null,
    "SocialNetworkId": null,
    "PhonePurpose": null,
    "WebPurpose": null,
    "SocialNetworkPurpose": null,
    "VerificationStatus": null,
    "VerificationDate": null,
    "PreferenceRequestedBy": null,
    "links": [

「トップに戻る」