すべての活動担当者の取得
get
/crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityContact
リクエスト
パス・パラメータ
- ActivityNumber(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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- ActivityContactNumberAltKeyFinder : 代替キーを持つアクティビティ担当者を検索します。
ファインダ変数:- ActyActivityNumber; string;アクティビティ担当者の代替キー識別子。
- ContactPartyNumber; string;アクティビティ担当者の代替キー識別子。
- ActivityContactViewAltKey : 代替キーを持つアクティビティ担当者を検索します。
ファインダ変数:- ActivityId; integer; 親アクティビティの一意の識別子。
- ContactId; integer;アクティビティに関連付けられた担当者の一意の識別子。
- PrimaryKey : 指定した主キー識別子を持つアクティビティ担当者を検索します。
ファインダ変数:- ActivityId; integer;親アクティビティの一意の識別子。
- ContactId; integer;アクティビティに関連付けられた担当者の一意の識別子。
- ActivityContactNumberAltKeyFinder : 代替キーを持つアクティビティ担当者を検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AccountId; integer;アカウントの一意の識別子。
- ActivityContactId; integer; サロゲート・アクティビティ担当の一意の識別子。
- ActivityId; integer; 目標の親アクティビティの一意の識別子。
- ActivityNumber; string; アクティビティの一意の番号。 外部ソースから番号を生成することもできます。
- ActyActivityNumber; string; アクティビティの一意の番号。 外部ソースから番号を生成することもできます。
- AttendeeFlag; boolean。担当者がアクティビティに参加したかどうかを示します。 Trueの場合、担当者は出席しました。
- BuyingRole; string; 購買プロセスのアクティビティ担当者が果たす役割(ディシジョン者、サポート・ロールなど)。 受け入れられる値のリストは、参照HZ_SLS_CNTCT_BUY_ROLE_CODEで定義されます。 「設定およびメンテナンス」作業領域の担当者参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- ConflictId; integer; この値は、異なるデータベース(つまり、モバイル・データベースまたはサーバー)で重複が作成される場合に、行の一意性を保証するために使用されます。 この属性は廃止されています。
- ContactAccount; string; アクティビティ担当者に関連付けられたアカウント。
- ContactAccountId; integer;アクティビティ担当者に関連付けられたアカウントの一意の識別子。
- ContactAccountType; string; 担当者のアカウント・タイプ。
- ContactCustomer; string;活動の顧客担当者。
- ContactEmail; string; アクティビティ担当者のEメール・アドレス。
- ContactId; integer;アクティビティに関連付けられた担当者の一意の識別子。
- ContactJobTitle; string;アクティビティ担当者のジョブ・タイトル。
- ContactLovSwitcher; string;コンタクトLOVスイッチャを示します(パブリック使用用ではありません)。
- ContactPartyNumber; string;アクティビティ担当者の代替キー識別子。
- ContactPhone; string; アクティビティ担当者の電話番号。
- CorpCurrencyCode;文字列。活動担当者が使用する企業通貨。
- CreatedBy; string; アクティビティ担当者を作成したユーザー。
- CreationDate; string; アクティビティ・コンタクトが作成された日時。
- CurcyConvRateType; string;アクティビティ担当者の通貨換算率。
- CurrencyCode; string; アクティビティ担当者に使用される通貨。
- EmailContactPreferenceFlag; string;電子メール担当者プリファレンスを示します。
- ExternalContactEmail; string; 外部担当者の電子メール・アドレス。
- ExternalContactFlag; boolean;アクティビティが外部コンタクトによって所有されていることを示すフラグ。
- ExternalContactName; string;外部担当者の名前。
- LastUpdateDate; string; アクティビティ担当者が最後に更新された日時。
- LastUpdateLogin; string; アクティビティ目標を最後に更新したユーザーのログイン詳細。
- LastUpdatedBy; string; アクティビティ担当者を最後に更新したユーザーの一意の識別子。 これはシステムによってデフォルト設定されます。
- 名前、文字列、アクティビティの担当者名。
- PhoneContactPreferenceFlag; string;電話担当者のプリファレンスを示します。
- PrimaryFormattedAddress; string; アクティビティ担当者の書式付き住所情報。
- RecurSeriesId; integer; シリーズのインスタンスをリンクする一意の識別子。
- RelationshipId; integer; 担当者の関係の一意の識別子。
- UpgSourceObjectId; integer; Rel9アクティビティ・レコードにアップグレードされるソース表内のレコードの主キー値。
- UpgSourceObjectType; string;ソース・オブジェクト・タイプは、アップグレードされたレコードのソースを示すアポイントメント、タスクまたはインタラクションです。
- UserLastUpdateDate; string;切断モードでユーザーが担当者を最後に更新した日時。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : activities-ActivityContact
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : activities-ActivityContact-item-response
タイプ:
ソースを表示
object
-
AccountId: integer
アカウントの一意の識別子。
-
ActivityContactId: integer (int64)
タイトル:
Activity Contact ID
サロゲート・アクティビティ担当者の一意の識別子。 -
ActivityId: integer (int64)
タイトル:
Activity ID
目標の親アクティビティの一意の識別子。 -
ActivityNumber: string
最大長:
64
アクティビティの一意の番号。 外部ソースから番号を生成することもできます。 -
ActyActivityNumber: string
タイトル:
Activity Number
最大長:64
アクティビティの一意の番号。 外部ソースから番号を生成することもできます。 -
Affinity: string
読取り専用:
true
当該組織に対するアクティビティ担当者の親和性。 受け入れられる値のリストは、参照HZ_SLS_CNTCT_AFFINITY_CODEで定義されます。 「設定およびメンテナンス」作業領域、「担当者参照の管理」タスクを使用して、この属性の値をレビューおよび更新します。 -
AttendeeFlag: boolean
タイトル:
Attendance
最大長:1
デフォルト値:true
担当者が活動に出席したかどうかを示します。 Trueの場合、担当者は出席しました。 -
BuyingRole: string
タイトル:
Buying Role
読取り専用:true
購買プロセスのアクティビティ担当が果たすロール(ディシジョン者、サポート・ロールなど)。 受け入れられる値のリストは、参照HZ_SLS_CNTCT_BUY_ROLE_CODEで定義されます。 「設定およびメンテナンス」作業領域の担当者参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
ConflictId: integer (int64)
デフォルト値:
0
この値は、異なるデータベース(モバイル・データベースまたはサーバー)で重複が作成される場合に、行の一意性を保証するために使用されます。 この属性は廃止されています。 -
ContactAccount: string
タイトル:
Account
活動担当者に関連付けられた取引先。 -
ContactAccountId: integer
活動担当者に関連付けられた取引先の一意の識別子。
-
ContactAccountType: string
担当者の取引先タイプ。
-
ContactCustomer: string
タイトル:
Contact Customer
活動の顧客担当者。 -
ContactEmail: string
タイトル:
Email
アクティビティ担当者のEメール・アドレス。 -
ContactId: integer (int64)
タイトル:
Contact ID
活動に関連付けられた担当者の一意の識別子。 -
ContactJobTitle: string
タイトル:
Title
活動担当者の肩書。 -
ContactLovSwitcher: string
担当者値リスト・スイッチャを示します(パブリック使用用ではありません)。
-
ContactName: string
タイトル:
Name
活動の担当者の名前。 -
ContactPartyNumber: string
タイトル:
Contact Number
読取り専用:true
最大長:30
アクティビティ担当者の代替キー識別子。 -
ContactPhone: string
タイトル:
Phone
活動担当者の電話番号。 -
CorpCurrencyCode: string
最大長:
15
活動担当者によって使用される企業通貨。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
活動担当者を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
活動担当者が作成された日時。 -
CurcyConvRateType: string
最大長:
30
活動担当者の通貨換算率。 -
CurrencyCode: string
最大長:
15
活動担当者に使用される通貨。 -
DoNotCallFlag: boolean
読取り専用:
true
担当者をコールする必要があるかどうかを示します。 デフォルト値はfalseです。 -
DoNotContactFlag: boolean
読取り専用:
true
アクティビティ担当者に連絡する必要があるかどうかを示します。 デフォルト値はfalseです。 -
DoNotEmailFlag: boolean
読取り専用:
true
担当者にEメールを送信する必要があるかどうかを示します。 デフォルト値はfalseです。 -
EmailContactPreferenceFlag: string
Eメール担当者プリファレンスを示します。
-
ExternalContactEmail: string
タイトル:
External Contact Email
最大長:320
外部担当者のEメール・アドレス。 -
ExternalContactFlag: boolean
タイトル:
External Contact
最大長:1
デフォルト値:false
活動が外部担当者によって所有されていることを示すフラグ。 -
ExternalContactName: string
タイトル:
External Contact Name
最大長:360
外部担当者の名前。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
活動担当者が最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
活動担当者を最後に更新したユーザーの一意の識別子。 これはシステムによってデフォルト設定されます。 -
LastUpdateLogin: string
タイトル:
Last Updated Login
読取り専用:true
最大長:32
アクティビティ目標を最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Name: string
タイトル:
Name
読取り専用:true
アクティビティ担当者名。 -
PhoneContactPreferenceFlag: string
電話担当者プリファレンスを示します。
-
PrimaryContactFlag: boolean
タイトル:
Primary
この担当者がプライマリ担当者であるかどうかを示します。 -
PrimaryFormattedAddress: string
活動担当者の書式設定された住所情報。
-
RecurSeriesId: integer (int64)
シリーズのインスタンスをリンクする一意の識別子。
-
RelationshipId: integer (int64)
タイトル:
Relationship ID
担当者の関係の一意の識別子。 -
UpgSourceObjectId: integer (int64)
読取り専用:
true
Rel9アクティビティ・レコードにアップグレードされるソース表内のレコードの主キー値。 -
UpgSourceObjectType: string
読取り専用:
true
最大長:30
ソース・オブジェクト・タイプは、アップグレードされたレコードのソースを示すアポイントメント、タスクまたは顧客対応です。 -
UserLastUpdateDate: string (date-time)
タイトル:
User Last Update Date
切断モードでユーザーがコンタクトを最後に更新した日時。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのアクティビティ担当者を取得する方法を示しています。
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [1] 0: { "ActivityId": 300100091331368 "ContactId": 300100007475829 "RelationshipId": null "ActivityNumber": null "CreatedBy": "SALES_ADMIN" "CreationDate": "2016-08-24T00:31:27-07:00" "LastUpdateDate": "2016-08-24T00:31:27-07:00" "LastUpdateLogin": "3ACBFC03100C5FB5E053780CF10AE876" "LastUpdatedBy": "SALES_ADMIN" "ObjectVersionNumber": 1 "ConflictId": 0 "UserLastUpdateDate": null "PrimaryContactFlag": true "ContactName": "Mike Rabatin" "CorpCurrencyCode": "EUR" "CurcyConvRateType": "Corporate" "CurrencyCode": "EUR" "ContactEmail": null "ContactPhone": "+1 (703) 930-3456" "ContactJobTitle": null "EmailContactPreferenceFlag": null "PhoneContactPreferenceFlag": null "ContactCustomer": null "ContactAccount": null "AccountId": null "ContactLovSwitcher": "LOV_ContactName" "ActivityContactId": 300100091331387 "DoNotContactFlag": false "DoNotCallFlag": false "DoNotEmailFlag": false "ContactAccountId": null "ContactAccountType": null "UpgSourceObjectId": null "UpgSourceObjectType": null "RecurSeriesId": null "AttendeeFlag": true "Affinity": "" "BuyingRole": "" "PrimaryFormattedAddress": null "ContactPartyNumber": "CDRM_575" "links": [6] 0: { "rel": "self" "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact/00020000000EACED00057708000110F07F5743280000000EACED00057708000110F07A57BA75" "name": "ActivityContact" "kind": "item" "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" }- }- 1: { "rel": "canonical" "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact/00020000000EACED00057708000110F07F5743280000000EACED00057708000110F07A57BA75" "name": "ActivityContact" "kind": "item" }- 2: { "rel": "parent" "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275" "name": "activities" "kind": "item" }- 3: { "rel": "lov" "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact/00020000000EACED00057708000110F07F5743280000000EACED00057708000110F07A57BA75/lov/ContactListVA" "name": "ContactListVA" "kind": "collection" }- 4: { "rel": "lov" "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact/00020000000EACED00057708000110F07F5743280000000EACED00057708000110F07A57BA75/lov/YesNoAttendeeFlagLookup" "name": "YesNoAttendeeFlagLookup" "kind": "collection" }- 5: { "rel": "lov" "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact/00020000000EACED00057708000110F07F5743280000000EACED00057708000110F07A57BA75/lov/RatedCurrenciesVA" "name": "RatedCurrenciesVA" "kind": "collection" }- - }- - "count": 1 "hasMore": false "limit": 25 "offset": 0 "links": [1] 0: { "rel": "self" "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact" "name": "ActivityContact" "kind": "collection" }- - }