すべてのパートナ担当者の取得
get
/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts
リクエスト
パス・パラメータ
- CompanyNumber(required): string
パートナの会社の代替キー識別子。
問合せパラメータ
- 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 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- CompanyNumberAndContactPartyNumberRF : パートナ会社番号およびパーティ番号別にパートナ担当者が検索されます。
ファインダ変数:- PartnerCompanyNumber; string; パートナ会社の一意の識別子。
- PartyNumber; string;パートナ担当者パーティの一意の識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERに基づいて、作成時にシステム生成またはユーザー指定にできます。
- CompanyNumberAndPartyNumberAltKey : 会社番号またはパーティ番号でパートナ担当者を検索します。
ファインダ変数:- PartnerCompanyNumber; string.
- ContactPartyNumberRF : パーティ番号でパートナ担当者を検索します。
ファインダ変数:- PartyNumber; string;パートナ担当者パーティの一意のプライマリ公開識別子。
- PartyNumberAltKey : パーティ番号でパートナ担当者を検索します。
ファインダ変数: - PrimaryKey : パーティ番号でパートナ担当者を検索します。
ファインダ変数:- PartyId; integer;パートナ担当者に関連付けられた「The ID」フィールド
- SourceSystemReferenceAltKey: ソース・システム参照値でパートナ担当者を検索します。
ファインダ変数:- SourceSystem; string; パートナ担当者の外部ソース・システムの名前。
- SourceSystemReferenceValue; string;外部ソース・システムからのパートナ担当者レコードの識別子。
- SourceSystemReferenceRF: ソース・システムおよびソース・システム参照値別にパートナ担当者を検索します。
ファインダ変数:- BindSourceSystem; string; パートナ担当者の外部ソース・システムの名前。
- BindSourceSystemReferenceValue; string;外部ソース・システムからのパートナ担当者レコードの識別子。
- BindSystemDate; string;これは内部属性であり、使用しないでください。
- CompanyNumberAndContactPartyNumberRF : パートナ会社番号およびパーティ番号別にパートナ担当者が検索されます。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AcademicTitle; string;学業資格を表す個人の部分(Dr. Jane Smithなど)。
- AddrElementAttribute1; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddrElementAttribute2; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddrElementAttribute3; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddrElementAttribute4; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddrElementAttribute5; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddressLineFour; string; 担当者の住所の4行目。
- AddressLineOne; string; アドレスの最初の行。
- AddressLineThree; string; addressの3行目。
- AddressLineTwo; string; addressの2行目。
- 建物;文字列;担当者の住所の建物名または番号。
- CertificationLevel; string;担当者の認定レベル。 受け入れられる値のリストは、参照HZ_PARTY_CERT_LEVELで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- CertificationReasonCode; string; 担当者の現在の認定レベル割当の理由を示すコード。 受け入れられる値のリストは、参照HZ_PARTY_CERT_REASONを使用して定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- City; string;住所のcity要素。
- コメント、文字列。担当者に関するテキストによるコメント。
- ContactName; string; 担当者の導出名。
- Country; string;住所の国コード。 地理の管理タスクを使用して、国コードのリストをレビューします。
- CountryName; string;パートナ会社の国名。
- 郡;文字列;住所の郡。
- CreateUserAccountFlag; boolean。ユーザー・アカウントを作成する必要があるかどうかを示します。 現在は使用しないでください。
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string; レコードが作成された日時。
- DateOfBirth; string;個人が生まれた日付。
- DateOfDeath; string;個人が亡くなった日付。
- DeceasedFlag; boolean;個人が死亡しているかどうかを示します。 値がTrueの場合、個人は死亡しています。 デフォルト値は「False」です。
- DeclaredEthnicity; string;個人の宣言されたエスニシティ。
- 部門;文字列;担当者の部門に名前を付けるために使用される自由形式のテキスト。
- DepartmentCode; string; 担当者の部門を示すコード。 受け入れられる値のリストは、参照DEPARTMENT_TYPEで定義されます。 「設定およびメンテナンス」作業領域、「担当者参照の管理」タスクを使用して、この属性の値をレビューおよび更新します。
- DoNotCallFlag; boolean;ユーザーが個人をコールできるかどうかを示します。 値がTrueの場合、ユーザーは個人をコールできません。 デフォルト値は「False」です。 受け入れられる値のリストは、参照YES_NOを使用して定義されます。 「設定およびメンテナンス」作業領域の共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- DoNotContactFlag; boolean;ユーザーが電話、電子メールまたはスネイル・メールで個人に連絡できるかどうかを示します。 値がTrueの場合、ユーザーは個人に連絡できません。 デフォルト値は「False」です。 受け入れられる値のリストは、参照YES_NOを使用して定義されます。 「設定およびメンテナンス」作業領域の共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- DoNotEmailFlag; boolean;ユーザーが個人にEメールを送信できるかどうかを示します。 値がTrueの場合、ユーザーはEメールで個人に連絡できません。 デフォルト値は「False」です。 受け入れられる値のリストは、参照YES_NOを使用して定義されます。 「設定およびメンテナンス」作業領域の共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- DoNotMailFlag; boolean;ユーザーが個人にメールを送信できるかどうかを示します。 値がTrueの場合、ユーザーはメールで個人に連絡してはいけません。 デフォルト値は「False」です。 受け入れられる値のリストは、参照YES_NOを使用して定義されます。 「設定およびメンテナンス」作業領域の共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- EmailAddress; string; パートナ担当者のEメール・アドレス。
- FavoriteContactFlag; boolean;個人がキー・コンタクトかどうかを示します。 値がTrueの場合、個人は主要担当者です。 デフォルト値は「False」です。 この属性は一時フィールドであるため、ファインダとして使用できません。 この属性をファインダとして使用すると、レスポンスはエラーを返します。
- FirstName; string;個人の名。
- FloorNumber; string;アドレスの階数。
- 性別、文字列。男性、女性、不明など、個人の性別。 受け入れられる値のリストは、参照HZ_GENDERで定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- イニシャル、文字列、担当者の名前のイニシャル。
- JobTitle; string; プライマリ担当者のジョブ・タイトル。
- JobTitleCode; string; ジョブ・タイトルを示すコード。
- LastName; string;個人の姓。
- LastNamePrefix; string; De、Vanなど、個人の姓のプレフィクス。 たとえば、個人名がHans De Vriesの場合、姓プリフィクスDeがこの属性を使用して取得されます。
- LastUpdateDate; string;レコードが最後に更新された日付。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン詳細。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- 緯度;数値;担当者の住所の緯度情報。 ロケーションの緯度情報は、空間近接および包含目的で使用されます。
- 経度、数値。担当者の住所の経度情報。 ロケーションの経度情報は、空間的近接性および包含目的で使用されます。
- Mailstop; string;組織内のメール・ドロップ・ポイントを示すユーザー定義コード。
- MaritalStatus; string;個人の婚姻区分。 受け入れられる値のリストは、参照MARITAL_STATUSで定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- MaritalStatusEffectiveDate; string;個人の婚姻区分が変更された日付。
- MiddleName; string;個人のミドル・ネーム。
- MobileAreaCode; string;パートナ担当者の携帯電話の市外局番。
- MobileCountryCode; string;パートナ担当者の国際国コード???s携帯電話番号(フランスの場合は33など)。
- MobileExtension; string; 内部電話システムへの初期接続後に使用される追加番号。
- MobileNumber; string; ローカル形式で書式設定されたパートナ担当者の携帯電話番号。 市外局番や国コード、内線番号を含めないでください。
- NameSuffix; string;ファミリ構造内の場所。 たとえば、「Tom Jones III」では、「III」はサフィクスです。
- NamedFlag; boolean;販売アカウントが指定された販売アカウントであるかどうかを示します。 値がTrueの場合、販売アカウントは指定販売アカウントです。 デフォルト値は「False」です。
- PartnerCompanyNumber; string; パートナ会社の一意の識別子。
- PartnerName; string; 担当者に関連付けられているパートナの名前。
- PartnerPartyId; integer;パートナに関連付けられたパーティの一意の識別子。
- PartyId; integer;作成時にシステムによって生成されたパートナ担当者パーティの一意の識別子。
- PartyNumber; string;パートナ担当者パーティの一意の識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERに基づいて、作成時にシステム生成またはユーザー指定にできます。
- PersonPreNameAdjunct; string; Mr.、Herrなど、担当者のタイトルまたは給与の概要。
- PlaceOfBirth; string;都市や国など、個人が生まれた場所。
- PostalCode; string;正式な国全体の郵便番号システムで定義される郵便番号。
- PostalPlus4Code; string; 住所のアメリカ合衆国郵便番号の4桁の拡張子。
- PreferredContactMethod; string; 個人に連絡するための優先メソッド。 受け入れられる値のリストは、参照HZ_PREFERRED_CONTACT_METHODで定義されます。 「設定およびメンテナンス」作業領域の担当者参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- PreferredFunctionalCurrency; string;担当者の優先通貨。 受理可能な値のリストは、「設定およびメンテナンス」作業領域の通貨の管理タスクを使用して定義します。
- PreviousLastName; string;個人の前の姓または姓。
- PrimaryAddressId; integer; 作成中に内部的に生成されるアドレスの一意の識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
- PrimaryContactPartyId; integer;パートナのプライマリ担当者のパーティ識別子。
- 州;文字列;住所の都道府県。
- RentOrOwnIndicator; string; この担当者が自分の住居を所有しているか賃貸しているかを示します。 賃借料、所有およびリースの有効な値のリストは、参照OWN_RENT_INDで定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- RoleName; string;パートナ担当者のリソース・ロールの名前。
- SalesAffinityCode; string; 当該組織への担当者のアフィニティを示すコード。 受け入れられる値のリストは、参照HZ_SLS_CNTCT_AFFINITY_CODEで定義されます。 「設定およびメンテナンス」作業領域、「担当者参照の管理」タスクを使用して、この属性の値をレビューおよび更新します。
- SalesBuyingRoleCode;文字列。購買プロセスで担当が果たす役割を示すコード。たとえば、ディシジョン者またはサポート・ロールなどです。 受け入れられる値のリストは、参照HZ_SLS_CNTCT_BUY_ROLE_CODEで定義されます。 「設定およびメンテナンス」作業領域の担当者参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- 挨拶;文字列;任意の通信で担当者パーティに住所を設定するために使用されるフレーズ。
- SecondLastName; string;個人の2番目の姓。 受け入れられる値のリストは、参照HZ_PERSON_PROFILESで定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- State; string;アドレスのstate要素。
- Title; string; DonやThe Right Honorableなどのプロまたは家族のタイトル。
- タイプ;文字列;担当者が販売アカウント、見込み客、担当者またはその他のユーザー定義パーティ・タイプのいずれであるかを定義する担当者パーティ・タイプ。 デフォルト値はZCA_CUSTOMERです。 受け入れられる値のリストは、参照ZCA_CONTACT_TYPEで定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- Username; string;パートナ担当者のアカウントのユーザー名。 現在は使用しないでください。
- WorkPhoneAreaCode; string; パートナ担当者の勤務先電話の市外局番。
- WorkPhoneCountryCode; string;パートナ担当者の国際国コード???sの勤務先電話番号(フランスの場合は33など)。
- WorkPhoneExtension; string; 内部電話システムへの初期接続後に使用される追加番号。
- WorkPhoneNumber;文字列;市外局番、国コードまたは内線番号なしでローカル形式で書式設定されたパートナ担当者の勤務先電話番号。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : partners-contacts
タイプ:
ソースを表示
object-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Itemsコレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : partners-contacts-item-response
タイプ:
ソースを表示
object-
AcademicTitle: string
タイトル:
Academic Title最大長:30ジェーン・ス・ミス博士など、学業資格を示す個人の部分です。 -
AddrElementAttribute1: string
タイトル:
Additional Address Element 1最大長:150柔軟な住所書式をサポートするための追加の住所要素。 -
AddrElementAttribute2: string
タイトル:
Additional Address Element 2最大長:150柔軟な住所書式をサポートするための追加の住所要素。 -
AddrElementAttribute3: string
タイトル:
Additional Address Element 3最大長:150柔軟な住所書式をサポートするための追加の住所要素。 -
AddrElementAttribute4: string
タイトル:
Additional Address Element 4最大長:150柔軟な住所書式をサポートするための追加の住所要素。 -
AddrElementAttribute5: string
タイトル:
Additional Address Element 5最大長:150柔軟な住所書式をサポートするための追加の住所要素。 -
AddressLineFour: string
タイトル:
Address Line 4最大長:240担当者の住所の4行目。 -
AddressLineOne: string
タイトル:
Address Line 1最大長:240住所の最初の行。 -
AddressLineThree: string
タイトル:
Address Line 3最大長:240住所の3行目。 -
AddressLineTwo: string
タイトル:
Address Line 2最大長:240住所の2行目。 -
AddressType: string
タイトル:
Address Type請求先住所、出荷先住所など、住所タイプの参照コード。 -
attachments: array Attachments
タイトル:
Attachments添付リソースは、パートナの添付の表示、作成、変更または削除に使用されます。 -
Building: string
タイトル:
Building最大長:240担当者の住所の建物名または番号。 -
CertificationLevel: string
タイトル:
Certification Level最大長:30担当者の認定レベル。 受け入れられる値のリストは、参照HZ_PARTY_CERT_LEVELで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
CertificationReasonCode: string
タイトル:
Certification Reason最大長:30担当者の現在の認定レベル割当の事由を示すコード。 受け入れられる値のリストは、参照HZ_PARTY_CERT_REASONを使用して定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
City: string
タイトル:
City最大長:60住所の市区町村要素。 -
Comments: string
タイトル:
Comments最大長:2000担当者に関するテキストによるコメント。 -
ContactName: string
タイトル:
Name最大長:450担当者の導出名。 -
Country: string
タイトル:
Country最大長:2住所の国コード。 地理の管理タスクを使用して、国コードのリストをレビューします。 -
CountryName: string
読取り専用:
trueパートナ企業の国名。 -
County: string
タイトル:
County最大長:60住所の郡。 -
CreatedBy: string
読取り専用:
true最大長:64レコードを作成したユーザー。 -
CreateUserAccountFlag: boolean
ユーザー・アカウントを作成する必要があるかどうかを示します。 現在は使用しないでください。
-
CreationDate: string (date-time)
読取り専用:
trueレコードが作成された日時。 -
DateOfBirth: 文字列(日付)
タイトル:
Date of Birth個人が生まれた日付。 -
DateOfDeath: 文字列(日付)
タイトル:
Date of Death個人が死亡した日付。 -
DeceasedFlag: boolean
タイトル:
Person Deceased最大長:1個人が死亡しているかどうかを示します。 値がTrueの場合、個人は死亡しています。 デフォルト値は「False」です。 -
DeclaredEthnicity: string
タイトル:
Declared Ethnicity最大長:60個人の宣言済エスニシティです。 -
Department: string
タイトル:
Department最大長:60担当者の部門に名前を付けるために使用する自由形式テキスト。 -
DepartmentCode: string
タイトル:
Department Code最大長:30担当者の部門を示すコード。 受け入れられる値のリストは、参照DEPARTMENT_TYPEで定義されます。 「設定およびメンテナンス」作業領域、「担当者参照の管理」タスクを使用して、この属性の値をレビューおよび更新します。 -
DoNotCallFlag: boolean
タイトル:
Do Not Call最大長:1ユーザーが個人をコールできるかどうかを示します。 値がTrueの場合、ユーザーは個人をコールできません。 デフォルト値は「False」です。 受け入れられる値のリストは、参照YES_NOを使用して定義されます。 「設定およびメンテナンス」作業領域の共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
DoNotContactFlag: boolean
タイトル:
Do Not Contact最大長:1ユーザーが電話、Eメールまたはスネイル・メールを使用して個人に連絡できるかどうかを示します。 値がTrueの場合、ユーザーは個人に連絡できません。 デフォルト値は「False」です。 受け入れられる値のリストは、参照YES_NOを使用して定義されます。 「設定およびメンテナンス」作業領域の共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
DoNotEmailFlag: boolean
タイトル:
Do Not Email最大長:1ユーザーが個人をEメールで送信できるかどうかを示します。 値がTrueの場合、ユーザーはEメールで個人に連絡できません。 デフォルト値は「False」です。 受け入れられる値のリストは、参照YES_NOを使用して定義されます。 「設定およびメンテナンス」作業領域の共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
DoNotMailFlag: boolean
タイトル:
Do Not Mail最大長:1ユーザーが個人にメールを送信できるかどうかを示します。 値がTrueの場合、ユーザーはメールで個人に連絡してはいけません。 デフォルト値は「False」です。 受け入れられる値のリストは、参照YES_NOを使用して定義されます。 「設定およびメンテナンス」作業領域の共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
EmailAddress: string
タイトル:
Email最大長:320パートナ担当者のEメール・アドレス。 -
FavoriteContactFlag: boolean
タイトル:
Favorite最大長:10デフォルト値:false個人が主要担当者かどうかを示します。 値がTrueの場合、個人は主要担当者です。 デフォルト値は「False」です。 この属性は一時フィールドであるため、ファインダとして使用できません。 この属性をファインダとして使用すると、レスポンスはエラーを返します。 -
FirstName: string
タイトル:
First Name最大長:150個人の名。 -
FloorNumber: string
タイトル:
Floor最大長:40住所の階数。 -
FormattedAddress: string
タイトル:
Primary Address読取り専用:trueパートナ担当者の書式付き住所。 -
FormattedMobileNumber: string
タイトル:
Phone Number読取り専用:true書式設定された携帯電話番号情報。 -
FormattedWorkPhoneNumber: string
タイトル:
Phone Number読取り専用:true書式設定された勤務先電話番号情報。 -
Gender: string
タイトル:
Gender最大長:30男性、女性、不明など、個人の性別。 受け入れられる値のリストは、参照HZ_GENDERで定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
Initials: string
タイトル:
Initials最大長:20担当者の名前のイニシャル。 -
IsAccountContactFlag: boolean
デフォルト値:
falseアカウントからの既存の担当者がパートナ担当者に変換されるかどうかを示します。 値Yは、関連アカウントがすでにパートナである場合、既存のアカウント担当者のパーティIDがパートナ担当者に使用されることを示します。 -
isSelfRegistration: string
タイトル:
Self-Registeredパートナ登録承認プロセスが起動されるかどうかを示します。 値がYの場合、プロセスが起動されます。 -
JobTitle: string
タイトル:
Job Title最大長:100プライマリ担当者の肩書。 -
JobTitleCode: string
タイトル:
Job Title Code最大長:30役職を示すコード。 -
LastName: string
タイトル:
Last Name最大長:150個人の姓。 -
LastNamePrefix: string
タイトル:
Last Name Prefix最大長:30個人の姓のプリフィクス(De、Vanなど)。 たとえば、個人名がHans De Vriesの場合、姓プリフィクスDeがこの属性を使用して取得されます。 -
LastUpdateDate: string (date-time)
読取り専用:
trueレコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true最大長:64レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true最大長:32レコードを最後に更新したユーザーのログイン詳細。 -
緯度: number
タイトル:
Latitude担当者の住所の緯度情報。 ロケーションの緯度情報は、空間近接および包含目的で使用されます。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
経度: number
タイトル:
Longitude担当者の住所の経度情報。 ロケーションの経度情報は、空間的近接性および包含目的で使用されます。 -
Mailstop: string
タイトル:
Mail Stop最大長:60組織内のメール・ドロップ・ポイントを示すユーザー定義コード。 -
ManagerName: string
タイトル:
Manager読取り専用:true最大長:255パートナ担当者のマネージャの名前。 -
ManagerPartyId: integer
タイトル:
Manager Party IDパートナ担当者のマネージャ・パーティの一意の識別子。 -
ManagerPartyNumber: string
最大長:
30パートナ担当者のマネージャのパーティ番号。 -
MaritalStatus: string
タイトル:
Marital Status最大長:30個人の婚姻区分。 受け入れられる値のリストは、参照MARITAL_STATUSで定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
MaritalStatusEffectiveDate: 文字列(日付)
タイトル:
Marital Status Effective Date個人の婚姻区分が変更された日付。 -
MiddleName: string
タイトル:
Middle Name最大長:60個人のミドル・ネーム。 -
MobileAreaCode: string
タイトル:
Area Code最大長:20パートナ担当者の携帯電話の市外局番。 -
MobileCountryCode: string
タイトル:
Phone Country Code最大長:10パートナ担当者の国際国コード。フランスの場合は33など、携帯電話番号。 -
MobileExtension: string
タイトル:
Extension最大長:20内部電話システムへの初期接続後に使用される追加番号。 -
MobileNumber: string
タイトル:
Phone最大長:40ローカル書式で書式設定されたパートナ担当者の携帯電話番号。 市外局番や国コード、内線番号を含めないでください。 -
NamedFlag: boolean
タイトル:
Named Contact最大長:1デフォルト値:false販売アカウントが指定された販売アカウントであるかどうかを示します。 値がTrueの場合、販売アカウントは指定販売アカウントです。 デフォルト値は「False」です。 -
NameSuffix: string
タイトル:
Suffix最大長:30ファミリ構造内の場所。 たとえば、「Tom Jones III」では、「III」はサフィクスです。 -
PartnerCompanyNumber: string
タイトル:
Partner Number最大長:30パートナ会社の一意の識別子。 -
PartnerName: string
タイトル:
Name読取り専用:true最大長:360担当者に関連付けられたパートナの名前。 -
PartnerPartyId: integer (int64)
パートナに関連付けられたパーティの一意の識別子。
-
PartyId: integer (int64)
作成中にシステムによって生成されたパートナ担当者パーティの一意の識別子。
-
PartyNumber: string
タイトル:
Registry ID最大長:30パートナ担当者パーティの一意の識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERに基づいて、作成時にシステム生成またはユーザー指定にできます。 -
PersonPreNameAdjunct: string
タイトル:
Prefix最大長:30Mr.、Herrなど、担当者のタイトルまたは給与の概要。 -
PlaceOfBirth: string
タイトル:
Place of Birth最大長:60市区町村や国など、個人の出生地。 -
PostalCode: string
タイトル:
Postal Code最大長:60正式な国全体の郵便番号システムによって定義された郵便番号。 -
PostalPlus4Code: string
タイトル:
Postal Code Extension最大長:20住所の米国郵便番号への4桁の内線番号。 -
PreferredContactMethod: string
タイトル:
Preferred Contact Method最大長:30個人への連絡メソッド。 受け入れられる値のリストは、参照HZ_PREFERRED_CONTACT_METHODで定義されます。 「設定およびメンテナンス」作業領域の担当者参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
PreferredFunctionalCurrency: string
タイトル:
Preferred Functional Currency最大長:15担当者の優先通貨。 受理可能な値のリストは、「設定およびメンテナンス」作業領域の通貨の管理タスクを使用して定義します。 -
PreviousLastName: string
タイトル:
Previous Last Name最大長:150個人の前の姓または姓。 -
PrimaryAddressId: integer (int64)
作成中に内部的に生成される住所の一意の識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
-
PrimaryContactPartyId: integer (int64)
読取り専用:
trueパートナのプライマリ担当者のパーティ識別子。 -
PrimaryFlag: boolean
タイトル:
Primary Contact Indicator最大長:255このパートナ担当者がパートナのプライマリ担当者であるかどうかを示します。 値がTrueの場合、このパートナ担当者はプライマリ担当者です。 -
Province: string
タイトル:
Province最大長:60住所の州。 -
RentOrOwnIndicator: string
タイトル:
Rent or Own Indicator最大長:30この担当者が自分の住居を所有または賃貸するかどうかを示します。 賃借料、所有およびリースの有効な値のリストは、参照OWN_RENT_INDで定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
RoleCode: string
最大長:
30パートナ担当者のロール・コード。 -
RoleId: integer (int64)
タイトル:
Role IDパートナ担当者のリソース・ロールの一意の識別子。 -
RoleName: string
タイトル:
Role読取り専用:true最大長:255パートナ担当者のリソース・ロールの名前。 -
SalesAffinityCode: string
タイトル:
Affinity最大長:30当該組織への担当者のアフィニティを示すコード。 受け入れられる値のリストは、参照HZ_SLS_CNTCT_AFFINITY_CODEで定義されます。 「設定およびメンテナンス」作業領域、「担当者参照の管理」タスクを使用して、この属性の値をレビューおよび更新します。 -
SalesBuyingRoleCode: string
タイトル:
Buying Role最大長:30購買プロセスで担当が果たすロールを示すコードです。たとえば、ディシジョン者またはサポート・ロールです。 受け入れられる値のリストは、参照HZ_SLS_CNTCT_BUY_ROLE_CODEで定義されます。 「設定およびメンテナンス」作業領域の担当者参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
Salutation: string
タイトル:
Salutation最大長:60連絡事項の担当者パーティへの対応に使用するフレーズ。 -
SecondLastName: string
タイトル:
Second Last Name最大長:150個人の2番目の姓。 受け入れられる値のリストは、参照HZ_PERSON_PROFILESで定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
SourceSystem: string
外部ソース・システムの名前。
-
SourceSystemReferenceValue: string
外部ソース・システムからのレコードの識別子。
-
State: string
タイトル:
State最大長:60住所の都道府県要素。 -
Title: string
タイトル:
Title最大長:60DonやThe Right Honorableなどの専門職または家族のタイトル。 -
Type: string
タイトル:
Type最大長:30担当が販売アカウント、見込み客、担当者またはその他のユーザー定義パーティ・タイプのいずれであるかを定義する担当者パーティ・タイプです。 デフォルト値はZCA_CUSTOMERです。 受け入れられる値のリストは、参照ZCA_CONTACT_TYPEで定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
userdetails: array User Account Details
タイトル:
User Account Detailsユーザー・アカウント詳細リソースは、パートナ担当者のユーザー・アカウント詳細の表示、作成、更新および削除に使用されます。 -
Username: string
パートナ担当者の取引先のユーザー名。 現在は使用しないでください。
-
WorkPhoneAreaCode: string
タイトル:
Area Code最大長:20パートナ担当者の勤務先電話の市外局番。 -
WorkPhoneCountryCode: string
タイトル:
Phone Country Code最大長:10パートナ担当者の国際国コード。フランスの場合は33など、勤務先電話番号。 -
WorkPhoneExtension: string
タイトル:
Extension最大長:20内部電話システムへの初期接続後に使用される追加番号。 -
WorkPhoneNumber: string
タイトル:
Phone最大長:40市外局番、国コードまたは内線番号なしでローカル書式で書式設定されたパートナ担当者の勤務先電話番号。
ネストされたスキーマ : ユーザー・アカウント詳細
タイプ:
arrayタイトル:
User Account Detailsユーザー・アカウント詳細リソースは、パートナ担当者のユーザー・アカウント詳細の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : partners-contacts-attachments-item-response
タイプ:
ソースを表示
object-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Idアップロードされたファイルのトラッキングに使用される一意の識別子。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id添付の一意の識別子。 -
CategoryName: string
タイトル:
Category最大長:30添付のカテゴリの名前。 - ContentRepositoryFileShared: boolean
-
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:255添付を作成したユーザー。 -
CreatedByUserName: string
タイトル:
Created By User Name読取り専用:trueイメージをアップロードした個人のユーザー名。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:true添付レコードが作成された日付。 -
DatatypeCode: string
タイトル:
Type最大長:30デフォルト値:FILE添付のデータ型を示すコード。 -
Description: string
タイトル:
Description最大長:255添付の説明。 -
DmDocumentId: string
最大長:
255添付文書の一意の識別子。 -
DmFolderPath: string
タイトル:
Dm Folder Path最大長:1000添付のフォルダ・パス。 -
DmVersionNumber: string
最大長:
255添付の現在のバージョン番号。 -
DownloadInfo: string
タイトル:
DownloadInfo添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。 -
ErrorStatusCode: string
タイトル:
Error Status Code添付のエラー・タイプ(ある場合)を示すコード。 -
ErrorStatusMessage: string
タイトル:
Error Status Message添付のエラー・メッセージ(ある場合)。 -
ExpirationDate: string (date-time)
タイトル:
Expiration Date添付ファイルのコンテンツが失効する日付。 -
FileContents: 文字列(バイト)
タイトル:
File Contents添付ファイルの内容。 -
FileName: string
タイトル:
File Name最大長:2048添付のファイル名。 -
FileUrl: string
タイトル:
File Url添付のURL。 -
FileWebImage: 文字列(バイト)
タイトル:
File Web Image読取り専用:trueソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date読取り専用:trueレコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By読取り専用:true最大長:255レコードを最後に更新したユーザー。 -
LastUpdatedByUserName: string
タイトル:
Last Updated By User読取り専用:trueイメージを最後に更新した個人のユーザー名。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
Title: string
タイトル:
Title添付のタイトル。 -
UploadedFileContentType: string
タイトル:
Uploaded File Content Type添付のコンテンツ・タイプ。 -
UploadedFileLength: integer
タイトル:
File Size添付ファイルの長さ。 -
UploadedFileName: string
タイトル:
Uploaded File Name添付ファイルの名前。 -
UploadedText: string
タイトル:
Uploaded Text添付のテキスト。 -
Uri: string
タイトル:
Uri最大長:4000添付のURI。 -
Url: string
タイトル:
Url最大長:4000添付のURL。 -
UserName: string
タイトル:
User Name読取り専用:true最大長:255添付に関連付けられているログイン。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : partners-contacts-userdetails-item-response
タイプ:
ソースを表示
object-
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
UserAccountStatus: string
タイトル:
User Account Request Status読取り専用:trueパートナ担当者のユーザー・アカウントのステータス。 -
Username: string
タイトル:
User Nameパートナ担当者のユーザー・アカウントの名前。
例:
cURLコマンド
次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべてのパートナ担当者を取得する方法を示しています。
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"OrganizationName":"Stry22.",
"AddressLineOne":"2280 Quimby Road",
"Country":"US",
"contacts":[{
"FirstName":"dd_pc_fn",
"LastName":"dd_pc_ln",
"EmailAddress":"u.m@a.com"
}]}