機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. アカウント
  4. 連絡先

すべての担当者の取得

get

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint

リクエスト

パス・パラメータ
  • アカウント・パーティの一意の代替識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERがTrueに設定されている場合、値を更新できます。 デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値と一意のシステム生成順序番号を連結した値です。 非アクティブなレコードは更新できません。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 指定された主キーを持つ担当者を検索します。
      ファインダ変数:
      • ContactPointId; integer; 担当者の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ConflictId; integer;競合の一意の識別子。
    • ContactPointId; integer; 担当者の一意の識別子。
    • ContactPointType; string;担当者のタイプ。 有効な担当者タイプのリストは、参照COMMUNICATION_TYPEで定義されます。 設定およびメンテナンス・タスクの担当者参照の管理を使用して、コードをレビューおよび更新できます。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string;レコードが作成された日付。
    • EmailAddress; string; 担当者の電子メール・アドレス。
    • EmailPurpose; string;電子メールの目的。
    • FormattedPhoneNumber; string; 担当者の書式設定された電話番号。
    • LastUpdateDate; string; 担当者が最後に更新された日付。
    • LastUpdateLogin; string; 担当者を最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; 担当者を最後に更新したユーザー。
    • ObjectVersionNumber; integer;ロックの実装に使用される数値。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
    • PartyId; integer;パーティの一意の識別子。
    • PhoneAreaCode; string;電話番号の市外局番。
    • PhoneCountryCode; string;電話番号の国コード。
    • PhoneExtension; string;オフィス・デスク内線番号のような電話回線番号の内線番号。
    • PhoneNumber; string; 担当者の電話番号。
    • PhonePurpose; string; PHONE担当者を使用する目的を定義します。 使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE.Sample値で定義されます: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
    • PhoneType; string;電話機のタイプ。 有効な電話タイプのリストは、参照ORA_HZ_PHONE_TYPEで定義されます。 設定およびメンテナンス・タスクの標準参照の管理を使用して、コードをレビューおよび更新できます。
    • PrimaryFlag; boolean;電話番号が優先されるかどうかを示します。
    • RawPhoneNumber; string; raw形式の電話番号。
    • SocialNetworkId; string;ソーシャル・ネットワークの一意の識別子。
    • SocialNetworkName; string;ソーシャル・ネットワークの名前。
    • SocialNetworkPurpose; string; IM担当者を使用する目的を定義します。 使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE.Sample値で定義されます: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
    • ステータス、文字列、担当者のステータス。
    • URL; string;担当者に関連付けられたURL。
    • VerificationDate; string;電話または電子メールの担当者の検証日。
    • VerificationStatus; string;電話または電子メールの担当者の検証のステータス。 受け入れられる値は、標準参照タイプORA_HZ_VALIDATION_STATUSでORA_VALID、ORA_INVALIDおよびORA_PARTIALLY_VALIDとして定義されます。 値ORA_PARTIALLY_VALIDは、電子メールにのみ適用できます。 デフォルト値は空白で、値が検証されないことを示します。
    • WebPurpose; string; WEB担当者を使用する目的を定義します。 使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE_WEB.Sample値で定義されます: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : accounts-ContactPoint
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : accounts-ContactPoint-item-response
タイプ: object
ソースを表示
  • デフォルト値: 0
    競合の一意の識別子。
  • 読取り専用: true
    担当者の一意の識別子。
  • タイトル: Type
    最大長: 30
    担当者のタイプ。 有効な担当者タイプのリストは、参照COMMUNICATION_TYPEで定義されます。 設定およびメンテナンス・タスクの担当者参照の管理を使用して、コードをレビューおよび更新できます。
  • 読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Created by Application
    デフォルト値: HZ_WS
    モジュールを作成したユーザー。
  • 読取り専用: true
    レコードが作成された日付。
  • タイトル: OK to Contact
    特定の連絡メソッドを使用するかどうかを示します。 デフォルトはfalseです。
  • DNCオプションを示す担当者プリファレンス・フラグ。
  • 担当者プリファレンスの事由コード。
  • 最大長: 255
    担当者の電子メール・アドレス。
  • タイトル: Email Purpose
    最大長: 30
    Eメールの目的。
  • 読取り専用: true
    最大長: 255
    担当者のフォーマット済電話番号。
  • 読取り専用: true
    担当者が最後に更新された日付。
  • 読取り専用: true
    最大長: 64
    担当者を最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    担当者を最後に更新したユーザーのログイン。
  • Links
  • ロックの実装に使用される番号。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
  • パーティの一意識別子
  • パーティ番号。 非アクティブなレコードは更新できません。
  • 住所が関連付けられている取引先、担当者または世帯の外部ソース・システムの名前。 取引先、担当者または世帯レコードの代替キーの一部(PartyourceSystemReferenceValueとも)。 住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。
  • 外部ソース・システムからの関係の一意の識別子。
  • 最大長: 255
    電話番号の市外局番。
  • 最大長: 255
    電話番号の国コード。
  • 最大長: 255
    オフィス・デスク内線番号などの電話回線番号の内線番号。
  • 最大長: 255
    担当者の電話番号。
  • タイトル: Phone Purpose
    最大長: 30
    PHONE担当者を使用する目的を定義します。 使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE.Sample値で定義されます: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
  • 電話のタイプ。 有効な電話タイプのリストは、参照ORA_HZ_PHONE_TYPEで定義されます。 設定およびメンテナンス・タスクの標準参照の管理を使用して、コードをレビューおよび更新できます。
  • タイトル: Preference Requested By
    権限または制限が内部で作成されたか、パーティによってリクエストされたかを示します。 受け入れられる値のリストは、REQUESTED_BY参照で定義されます。
  • タイトル: Primary
    最大長: 1
    デフォルト値: false
    電話番号が優先されるかどうかを示します。
  • 最大長: 255
    未処理形式の電話番号。
  • ソーシャル・ネットワークの一意の識別子。
  • ソーシャル・ネットワークの名前。
  • タイトル: Social Network Purpose
    最大長: 30
    IM担当者を使用する目的を定義します。 使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE.Sample値で定義されます: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
  • システム設定の一部として管理者が定義する外部ソース・システムの名前。 これは、(SourceSystemReferenceとともに)代替キーの一部であり、更新でPKまたはpartyNumberBusinessKeyが渡されない場合は必須です。
  • 属性SourceSystemで指定された外部ソース・システムからのアカウント・パーティの一意の識別子。 これは、(SourceSystemReferenceとともに)代替キーの一部であり、更新でPKまたはpartyNumberBusinessKeyが渡されない場合は必須です。
  • 最大長: 30
    デフォルト値: A
    担当者のステータス。
  • 担当者に関連付けられたURL。
  • タイトル: Verification Date
    電話またはEメールの担当者の検証日。
  • タイトル: Verification Status
    最大長: 30
    電話またはEメールの担当者の検証のステータス。 受け入れられる値は、標準参照タイプORA_HZ_VALIDATION_STATUSでORA_VALID、ORA_INVALIDおよびORA_PARTIALLY_VALIDとして定義されます。 値ORA_PARTIALLY_VALIDは、電子メールにのみ適用できます。 デフォルト値は空白で、値が検証されないことを示します。
  • タイトル: Web Purpose
    最大長: 30
    WEB担当者を使用する目的を定義します。 使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE_WEB.Sample値で定義されます: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべての担当者を取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint

レスポンス本文の例

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

{
    "items": [
        {
            "ContactPointId": 100000015802834,
            "ContactPointType": "EMAIL",
            "PartyId": 100000015957398,
            "PartyNumber": "100000015957397",
            "PartySourceSystem": null,
            "PartySourceSystemReferenceValue": null,
            "EmailAddress": "sendmail-test-discard@oracle.com",
            "EmailPurpose": null,
            "PhoneType": null,
            "PhoneAreaCode": null,
            "PhoneExtension": null,
            "PhoneCountryCode": null,
            "RawPhoneNumber": null,
            "PhoneNumber": null,
            "FormattedPhoneNumber": null,
            "URL": null,
            "PrimaryFlag": true,
            "Status": "A",
            "SourceSystem": null,
            "SourceSystemReferenceValue": null,
            "CreatedBy": "OPERATIONS",
            "CreatedByModule": "ZCM",
            "CreationDate": "2010-01-28T02:38:18.716+00:00",
            "LastUpdateDate": "2010-01-28T02:41:27.471+00:00",
            "LastUpdateLogin": "7E36BAD8F19E8D21E04044987CF00BF0",
            "LastUpdatedBy": "OPERATIONS",
            "ObjectVersionNumber": 1,
            "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": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/ContactPoint/100000015802834",
                    "name": "ContactPoint",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/ContactPoint/100000015802834",
                    "name": "ContactPoint",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397",
                    "name": "accounts",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/ContactPoint/100000015802834/lov/EmailPurposeLookupVA",
                    "name": "EmailPurposeLookupVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/ContactPoint/100000015802834/lov/VerificationStatusLookupVA",
                    "name": "VerificationStatusLookupVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/ContactPoint/100000015802834/lov/PhonePurposeLookupVA",
                    "name": "PhonePurposeLookupVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/ContactPoint/100000015802834/lov/ContactPointTypeLimitedLookUpVO",
                    "name": "ContactPointTypeLimitedLookUpVO",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/ContactPoint/100000015802834/lov/ContactPointPurposeWebLookupVA",
                    "name": "ContactPointPurposeWebLookupVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/ContactPoint/100000015802834/lov/ReasonCodesVA",
                    "name": "ReasonCodesVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/ContactPoint/100000015802834/lov/SocialNetworkPurposeLookupVA",
                    "name": "SocialNetworkPurposeLookupVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/ContactPoint/100000015802834/lov/PhoneTypeLookupVA",
                    "name": "PhoneTypeLookupVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/ContactPoint/100000015802834/lov/PreferenceRequestedByLookupVA",
                    "name": "PreferenceRequestedByLookupVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/ContactPoint/100000015802834/lov/InstantMessengerTypeVOVA",
                    "name": "InstantMessengerTypeVOVA",
                    "kind": "collection"
                }
            ]
        },
        ......
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/ContactPoint",
            "name": "ContactPoint",
            "kind": "collection"
        }
    ]
}
「トップに戻る」