担当者の取得
get
/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactPoint/{ContactPointId}
リクエスト
パス・パラメータ
- ContactPointId(required): integer(int64)
担当者の一意の識別子。
- PartyNumber(required): string
担当者パーティの代替キー識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、属性値をシステム生成にできるか、作成中にユーザー指定にできるかを制御します。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。 非アクティブなレコードは更新できません。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- 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.
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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}
検証ステータスを示す値リスト。 - ファインダ: