機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

担当者のロールアップの取得

get

/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactRollup/{PersonProfileId}

リクエスト

パス・パラメータ

• PartyNumber(required): string
  担当者パーティの代替キー識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、属性値をシステム生成にできるか、作成中にユーザー指定にできるかを制御します。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。 非アクティブなレコードは更新できません。
• PersonProfileId(required): integer(int64)
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=

問合せパラメータ

• 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-ContactRollup-item-response

タイプ: object

ソースを表示

• CallsMade: number
  タイトル: Calls Made

  読取り専用: true

  担当者に対して行われたコールの合計数。
• CorpCurrencyCode: string
  タイトル: Corporate Currency

  読取り専用: true

  最大長: 15

  担当者ロールアップに関連付けられた企業通貨コード(USD、INRなど)。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  担当者ロールアップを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  担当者のロールアップが作成された日付。
• EmailsSent: number
  タイトル: Emails Sent

  読取り専用: true

  担当者に送信されたEメールの合計数。
• LastCallMadeDate: string (date-time)
  タイトル: Last Call Made

  読取り専用: true

  担当者に最終訪問が行われた日付。
• LastCompletedActivity: string (date-time)
  タイトル: Last Completed Activity

  読取り専用: true

  担当者の活動が最後に完了した日付。 活動には、タスク、ポイント、およびコール・レポートが含まれます。
• LastEmailSentDate: string (date-time)
  タイトル: Last Email Sent

  読取り専用: true

  担当者に最終Eメールが送信された日付。
• LastResponse: string (date-time)
  タイトル: Last Response Date

  読取り専用: true

  担当者から最終電子メールまたは通話を受信した日付。
• LastTouchDate: string (date-time)
  タイトル: Last Touch

  読取り専用: true

  担当者に対して最終電子メールが送信されたか、またはコールされた日付。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  担当者のロールアップが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  担当者ロールアップを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  担当者のロールアップを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• NextTaskDue: 文字列(日付)
  タイトル: Next Task Due

  読取り専用: true

  担当者がいるタスクの期日。
• NumberOfOpenActivities: number
  タイトル: Number of Open Activities

  読取り専用: true

  担当者に対してオープンしているアクティビティの合計数。
• NumberOfOpenCriticalServiceRequests: number
  タイトル: Critical Open Service Requests

  読取り専用: true

  担当者に関連付けられている重大度が1であるオープン・サービス・リクエストの数。
• NumberOfOpenHotLeads: number
  タイトル: Hot Leads

  読取り専用: true

  オープン中でホットにランク付けされたリードの数。
• NumberOfOpenLeads: number
  タイトル: Open Leads

  読取り専用: true

  担当者に対してオープンしているリードの合計数。
• NumberOfOpenOpportunities: number
  タイトル: Open Opportunities

  読取り専用: true

  担当者に関連付けられたオープン商談の数。
• NumberOfOpenServiceRequests: number
  タイトル: Open Service Requests

  読取り専用: true

  担当者に関連付けられたオープン・サービス・リクエストの数。
• NumberOfResponses: number
  タイトル: Responses

  読取り専用: true

  担当者から受信したコールまたは電子メールの合計数。
• NumberOfTouches: number
  タイトル: Touches

  読取り専用: true

  担当者に対して送信または行われた電子メールの合計数。
• PersonProfileId: integer (int64)
  タイトル: Person Profile Identifier

  読取り専用: true

  個人プロファイルの一意の識別子。
• SumOfOpenOpportunitiesRevenue: number
  タイトル: Open Opportunities Revenue

  読取り専用: true

  担当者に関連付けられたオープン商談からの売上の累積合計。

{
    "type":"object",
    "properties":{
        "NumberOfOpenLeads":{
            "title":"Open Leads",
            "type":"number",
            "description":"The total number of leads that are open for the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Count of leads that are open for the contact."
            },
            "x-queryable":true
        },
        "NumberOfOpenHotLeads":{
            "title":"Hot Leads",
            "type":"number",
            "description":"The number of leads that are open and are ranked hot.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Count of leads that are open and are ranked hot."
            },
            "x-queryable":true
        },
        "NextTaskDue":{
            "title":"Next Task Due",
            "type":"string",
            "description":"The due date of the task with a contact.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when a task is due with a contact."
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the contact rollup was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the date of the creation of the row."
            },
            "x-queryable":true
        },
        "LastCompletedActivity":{
            "title":"Last Completed Activity",
            "type":"string",
            "description":"The date when the activity was last completed with a contact. Activity includes task, appointment, and call report.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date of last completed activity with a contact. Activity includes task, appointment, and call report."
            },
            "x-queryable":true
        },
        "CallsMade":{
            "title":"Calls Made",
            "type":"number",
            "description":"The total number of calls made to a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The total number of calls made to a contact."
            },
            "x-queryable":true
        },
        "LastCallMadeDate":{
            "title":"Last Call Made",
            "type":"string",
            "description":"The date when last call was made to a contact.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when last call was made to a contact."
            },
            "x-queryable":true
        },
        "NumberOfResponses":{
            "title":"Responses",
            "type":"number",
            "description":"The total number of calls or emails received from a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Number of responses received from a contact."
            },
            "x-queryable":true
        },
        "EmailsSent":{
            "title":"Emails Sent",
            "type":"number",
            "description":"The total number of emails sent to a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The total number of emails sent to a contact."
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PersonProfileId":{
            "title":"Person Profile Identifier",
            "type":"integer",
            "description":"The unique identifier of the person profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "description":"The unique identifier of the person profile."
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the contact rollup such as USD or INR.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "description":"The corporate currency code associated with the account rollup such as USD or INR."
            }
        },
        "NumberOfOpenActivities":{
            "title":"Number of Open Activities",
            "type":"number",
            "description":"The total number of activities that are open for a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Count of activities that are open for a contact."
            },
            "x-queryable":true
        },
        "LastEmailSentDate":{
            "title":"Last Email Sent",
            "type":"string",
            "description":"The date when last email was sent to a contact.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when last email was sent to a contact."
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contact rollup.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"User",
                "description":"Who column: indicates the user who last updated the row."
            },
            "x-queryable":true
        },
        "LastResponse":{
            "title":"Last Response Date",
            "type":"string",
            "description":"The date when a last email or call was received from a contact.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when last response was received from a contact."
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the contact rollup.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"User",
                "description":"Who column: indicates the user who created the row."
            },
            "x-queryable":true
        },
        "LastTouchDate":{
            "title":"Last Touch",
            "type":"string",
            "description":"The date when the last email was sent or call was made to a contact.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The date when the last touch was made with a contact."
            },
            "x-queryable":true
        },
        "SumOfOpenOpportunitiesRevenue":{
            "title":"Open Opportunities Revenue",
            "type":"number",
            "description":"The cumulative total of revenues from open opportunities associated with a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The cumulative total of revenues from open opportunities associated with a contact.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "NumberOfTouches":{
            "title":"Touches",
            "type":"number",
            "description":"The total number of emails sent or calls made to a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The total number of touches with a contact. Touches refer to outbound communications such as email, phone, and so on."
            },
            "x-queryable":true
        },
        "NumberOfOpenOpportunities":{
            "title":"Open Opportunities",
            "type":"number",
            "description":"The number of open opportunities associated with a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Count on open opportunities with a contact."
            },
            "x-queryable":true
        },
        "NumberOfOpenCriticalServiceRequests":{
            "title":"Critical Open Service Requests",
            "type":"number",
            "description":"The number of open service requests with severity equal to one that are associated with a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The number of open service requests for the contact that have severity equal to one."
            },
            "x-queryable":true
        },
        "NumberOfOpenServiceRequests":{
            "title":"Open Service Requests",
            "type":"number",
            "description":"The number of open service requests associated with a contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The number of open service requests for a contact."
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the contact rollup was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the date of the last update of the row."
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the contact rollup.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the session login associated to the user who last updated the row."
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

「トップに戻る」