担当者の作成
post
/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contactPoints
リクエスト
パス・パラメータ
- CompanyNumber(required): string
パートナの会社の代替キー識別子。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
ConflictId: integer (int64)
デフォルト値:
0
競合の一意の識別子。 ノート: これは内部属性であるため、使用しないでください。 -
ContactPointType: string
タイトル:
Type
最大長:30
EMAILやPHONEなどの担当者のタイプ。 -
CreatedByModule: string
タイトル:
Created by Application
デフォルト値:HZ_WS
担当者レコードを作成したモジュール。 -
DoContactPreferenceFlag: boolean
タイトル:
OK to Contact
特定の連絡メソッドを使用するかどうかを示します。 デフォルトはfalseです。 -
DoNotContactPreferenceFlag: boolean
担当者が担当者の優先でないかどうかを示します。
-
DoNotContactReason: string
「連絡しない」プリファレンスの事由を示します。
-
EmailAddress: string
最大長:
255
担当者のEメール・アドレス。 -
EmailPurpose: string
タイトル:
Email Purpose
最大長:30
担当者のEメール・アドレスのEメール目的。 次に例を示します: 「ビジネス」は、Eメール・アドレスの目的を決定します。 -
ObjectVersionNumber: 整数(int32)
オブジェクト・バージョン番号。 (これは内部属性であり、使用しないでください)
-
PartyId: integer (int64)
パートナ会社のパーティの一意の識別子。
-
PartyNumber: string
パートナ会社のパーティ番号。
-
PartySourceSystem: string
外部ソース・システムの名前。
-
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
担当者の電話番号のタイプ。 次に例を示します: 「FAX」または「WORK」によって、電話番号のタイプが決まります。
-
PreferenceRequestedBy: string
タイトル:
Preference 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
外部ソース・システムの名前。
-
SourceSystemReferenceValue: string
外部ソース・システムからのレコードの識別子。
-
Status: string
最大長:
30
デフォルト値:A
担当者のステータス。 -
URL: string
担当者のURL。
-
VerificationDate: 文字列(日付)
タイトル:
Verification Date
電話またはEメールの担当者の検証日。 -
VerificationStatus: string
タイトル:
Verification Status
最大長:30
ソーシャル・ネットワークの目的を示す値リスト。 -
WebPurpose: string
タイトル:
Web Purpose
最大長:30
WEB担当者を使用する目的。 使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE_WEB.Sample値で定義されます: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : partners-contactPoints-item-response
タイプ:
ソースを表示
object
-
ConflictId: integer (int64)
デフォルト値:
0
競合の一意の識別子。 ノート: これは内部属性であるため、使用しないでください。 -
ContactPointId: integer (int64)
読取り専用:
true
担当者の一意の識別子。 -
ContactPointType: string
タイトル:
Type
最大長:30
EMAILやPHONEなどの担当者のタイプ。 -
CreatedBy: string
読取り専用:
true
最大長:64
担当者レコードを作成したユーザー。 -
CreatedByModule: string
タイトル:
Created by Application
デフォルト値:HZ_WS
担当者レコードを作成したモジュール。 -
CreationDate: string (date-time)
読取り専用:
true
担当者レコードが作成された日付。 -
DoContactPreferenceFlag: boolean
タイトル:
OK to Contact
特定の連絡メソッドを使用するかどうかを示します。 デフォルトはfalseです。 -
DoNotContactPreferenceFlag: boolean
担当者が担当者の優先でないかどうかを示します。
-
DoNotContactReason: string
「連絡しない」プリファレンスの事由を示します。
-
EmailAddress: string
最大長:
255
担当者のEメール・アドレス。 -
EmailPurpose: string
タイトル:
Email Purpose
最大長:30
担当者のEメール・アドレスのEメール目的。 次に例を示します: 「ビジネス」は、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
外部ソース・システムの名前。
-
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
担当者の電話番号のタイプ。 次に例を示します: 「FAX」または「WORK」によって、電話番号のタイプが決まります。
-
PreferenceRequestedBy: string
タイトル:
Preference 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
外部ソース・システムの名前。
-
SourceSystemReferenceValue: string
外部ソース・システムからのレコードの識別子。
-
Status: string
最大長:
30
デフォルト値:A
担当者のステータス。 -
URL: string
担当者のURL。
-
VerificationDate: 文字列(日付)
タイトル:
Verification Date
電話またはEメールの担当者の検証日。 -
VerificationStatus: string
タイトル:
Verification Status
最大長:30
ソーシャル・ネットワークの目的を示す値リスト。 -
WebPurpose: string
タイトル:
Web Purpose
最大長:30
WEB担当者を使用する目的。 使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE_WEB.Sample値で定義されます: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- ContactPointPurposeWebLookupVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE_WEB%2CLookupCode%3D{WebPurpose}
webの目的を示す値リスト。 - ファインダ:
- ContactPointTypeLimitedLookUpVO
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DCOMMUNICATION_TYPE%2CLookupCode%3D{ContactPointType}
担当者タイプを示す値リスト。 - ファインダ:
- EmailPurposeLookupVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{EmailPurpose}
Eメールの目的を示す値リスト。 - ファインダ:
- InstantMessengerTypeVOVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE%2CLookupCode%3D{SocialNetworkName}
ソーシャル・ネットワーク名の参照リソース。 - ファインダ:
- PhonePurposeLookupVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{PhonePurpose}
電話の目的を示す値リスト。 - ファインダ:
- PhoneTypeLookupVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_HZ_PHONE_TYPE%2CLookupCode%3D{PhoneType}
電話のタイプを示す値リスト。 - ファインダ:
- PreferenceRequestedByLookupVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupCode%3D{PreferenceRequestedBy}%2CLookupType%3DREQUESTED_BY
リクエストされたプリファレンスを示す値リスト。 - ファインダ:
- ReasonCodesVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DREASON_CODE%2CLookupCode%3D{DoNotContactReason}
連絡禁止事由を示す値リスト。 - ファインダ:
- SocialNetworkPurposeLookupVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{SocialNetworkPurpose}
ソーシャル・ネットワークの目的を示す値リスト。 - ファインダ:
- VerificationStatusLookupVA
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{VerificationStatus}
検証ステータスを示す値リスト。 - ファインダ: