機械翻訳について

ジャンプ先

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

webアクティビティの取得

get

/crmRestApi/resources/11.13.18.05/webActivities/{WebActivityNumber}

リクエスト

パス・パラメータ

• WebActivityNumber(required): string
  webアクティビティの公開一意識別子。

問合せパラメータ

• 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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : webActivities-item-response

タイプ: object

ソースを表示

• ActivityReferenceId: number
  タイトル: Activity Reference ID

  webアクティビティのアクティビティ参照識別子。
• CampaignId: integer (int64)
  タイトル: Campaign ID

  webアクティビティに関連付けられたキャンペーン識別子。
• ContactId: integer (int64)
  タイトル: Contact ID

  webアクティビティに関連付けられた担当者パーティ識別子。
• ContactName: string
  読取り専用: true

  最大長: 360

  webアクティビティに関連付けられている担当者名。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  webアクティビティを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  webアクティビティが作成された日付。
• ElqActivityDate: string (date-time)
  タイトル: Eloqua Activity Date

  webアクティビティの日付。
• ElqActivityId: integer (int64)
  タイトル: Eloqua Activity ID

  マーケティング・システムからのwebアクティビティのアクティビティ識別子。
• ElqActivityType: string
  タイトル: Eloqua Activity Type

  最大長: 100

  webアクティビティのタイプ。
• ElqAssetId: integer (int64)
  タイトル: Eloqua Asset ID

  webアクティビティに関連付けられたマーケティング・アセット識別子。
• ElqAssetName: string
  タイトル: Eloqua Asset Name

  最大長: 100

  webアクティビティに関連付けられたマーケティング・アセット名。
• ElqAssetType: string
  タイトル: Eloqua Asset Type

  最大長: 100

  webアクティビティに関連付けられたマーケティング・アセット・タイプ。
• ElqCampaignId: integer (int64)
  タイトル: Eloqua Campaign ID

  webアクティビティに関連付けられたマーケティング・キャンペーン識別子。
• ElqContactId: integer (int64)
  タイトル: Eloqua Contact ID

  webアクティビティに関連付けられた担当者のマーケティング担当者識別子。
• ElqDeploymentId: integer (int64)
  タイトル: Eloqua Deployment ID

  webアクティビティに関連付けられたマーケティングEメール・デプロイメント識別子。
• ElqDuration: string
  タイトル: Eloqua Duration

  最大長: 100

  web訪問アクティビティの期間。
• ElqEmailAddress: string
  タイトル: Eloqua Email Address

  最大長: 400

  webアクティビティに関連付けられている担当者またはリードのEメール・アドレス。
• ElqEmailClickedThruLink: string
  タイトル: Eloqua Email Clicked Through Link

  最大長: 1000

  webアクティビティに関連付けられたEメールのクリックスル・リンク。
• ElqEmailRecipientId: string
  タイトル: Eloqua Email Recipient ID

  最大長: 38

  webアクティビティのEメール受信者識別子。
• ElqEmailSendType: string
  タイトル: Eloqua Email Send Type

  最大長: 100

  webアクティビティに関連付けられたマーケティングEメール送信タイプ。
• ElqEmailWebLink: string
  タイトル: Eloqua Email Web Link

  最大長: 1000

  webアクティビティに関連付けられた電子メールWebリンク。
• ElqExternalId: string
  タイトル: Eloqua External ID

  最大長: 20

  マーケティング・システムからのwebアクティビティの外部識別子。
• ElqFirstPageViewURL: string
  タイトル: Eloqua First Page View URL

  最大長: 1000

  web訪問アクティビティの最初のページ・ビュー・アクティビティのURL。
• ElqNumberOfPages: integer (int64)
  タイトル: Eloqua Number of Pages

  web訪問タイプのWebアクティビティで表示されたページ数。
• ElqSubjectLine: string
  タイトル: Eloqua Subject Line

  最大長: 500

  webアクティビティに関連付けられたEメール件名。
• ElqURL: string
  タイトル: Eloqua URL

  最大長: 1000

  ページ・ビュー・アクティビティのURL。
• ElqURLDescription: string
  タイトル: Eloqua URL Description

  最大長: 150

  webアクティビティのURLの説明。
• ElqWebVisitId: integer (int64)
  タイトル: Eloqua Web Visit ID

  ページ・ビュー・アクティビティに関連付けられたweb訪問識別子。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  webアクティビティが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  webアクティビティを遅延更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  webアクティビティを最後に更新したユーザーのログイン。
• LeadId: integer (int64)
  タイトル: Lead ID

  webアクティビティに関連付けられたリード識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  webアクティビティのバージョン番号。
• WebActivityId: integer (int64)
  タイトル: Web Activity ID

  webアクティビティの一意の識別子。
• WebActivityNumber: string
  タイトル: Web Activity Number

  最大長: 64

  webアクティビティの公開一意識別子。

{
    "type":"object",
    "properties":{
        "ElqAssetType":{
            "title":"Eloqua Asset Type",
            "maxLength":100,
            "type":"string",
            "description":"The marketing asset type associated with the web activity.",
            "nullable":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the web activity was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ElqCampaignId":{
            "title":"Eloqua Campaign ID",
            "type":"integer",
            "description":"The marketing campaign identifier associated with the web activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ElqAssetId":{
            "title":"Eloqua Asset ID",
            "type":"integer",
            "description":"The marketing asset identifier associated with the web activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ElqExternalId":{
            "title":"Eloqua External ID",
            "maxLength":20,
            "type":"string",
            "description":"The external identifier for web activity from the marketing system.",
            "nullable":false,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ElqDeploymentId":{
            "title":"Eloqua Deployment ID",
            "type":"integer",
            "description":"The marketing email deployment identifier associated with the web activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "WebActivityId":{
            "title":"Web Activity ID",
            "type":"integer",
            "description":"The unique identifier of the web activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ElqContactId":{
            "title":"Eloqua Contact ID",
            "type":"integer",
            "description":"The marketing contact identifier of the contact associated with the web activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ActivityReferenceId":{
            "title":"Activity Reference ID",
            "type":"number",
            "description":"The activity reference identifier for the web activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The contact party identifier associated with the web activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ElqEmailWebLink":{
            "title":"Eloqua Email Web Link",
            "maxLength":1000,
            "type":"string",
            "description":"The email web link associated with the web activity.",
            "nullable":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ElqDuration":{
            "title":"Eloqua Duration",
            "maxLength":100,
            "type":"string",
            "description":"The duration of web visit activity.",
            "nullable":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ElqURLDescription":{
            "title":"Eloqua URL Description",
            "maxLength":150,
            "type":"string",
            "description":"The URL description of the web activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ElqWebVisitId":{
            "title":"Eloqua Web Visit ID",
            "type":"integer",
            "description":"The web visit identifier associated with the page view activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The campaign identifier associated with the web activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The Version number of the web activity.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ElqActivityId":{
            "title":"Eloqua Activity ID",
            "type":"integer",
            "description":"The activity identifier for web activity from the marketing system.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The lead identifier associated with the web activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "WebActivityNumber":{
            "title":"Web Activity Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier for web activity.",
            "nullable":false,
            "x-queryable":true
        },
        "ElqEmailRecipientId":{
            "title":"Eloqua Email Recipient ID",
            "maxLength":38,
            "type":"string",
            "description":"The email recipient identifier of the web activity.",
            "nullable":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who late updated the web activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ElqURL":{
            "title":"Eloqua URL",
            "maxLength":1000,
            "type":"string",
            "description":"The URL of the page view activity.",
            "nullable":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ElqEmailAddress":{
            "title":"Eloqua Email Address",
            "maxLength":400,
            "type":"string",
            "description":"The email address of the contact or lead associated with the web activity.",
            "nullable":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ElqEmailSendType":{
            "title":"Eloqua Email Send Type",
            "maxLength":100,
            "type":"string",
            "description":"The marketing email send type associated with the web activity.",
            "nullable":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the web activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ElqActivityDate":{
            "title":"Eloqua Activity Date",
            "type":"string",
            "description":"The date of the web activity.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ElqNumberOfPages":{
            "title":"Eloqua Number of Pages",
            "type":"integer",
            "description":"The number of pages viewed in a web activity of type web visit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ElqAssetName":{
            "title":"Eloqua Asset Name",
            "maxLength":100,
            "type":"string",
            "description":"The marketing asset name associated with the web activity.",
            "nullable":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ElqEmailClickedThruLink":{
            "title":"Eloqua Email Clicked Through Link",
            "maxLength":1000,
            "type":"string",
            "description":"The email click through link associated with the web activity.",
            "nullable":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ElqActivityType":{
            "title":"Eloqua Activity Type",
            "maxLength":100,
            "type":"string",
            "description":"The type for web activity.",
            "nullable":false,
            "x-queryable":true
        },
        "ElqFirstPageViewURL":{
            "title":"Eloqua First Page View URL",
            "maxLength":1000,
            "type":"string",
            "description":"The URL of the first page view activity of a web visit activity.",
            "nullable":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "ContactName":{
            "maxLength":360,
            "type":"string",
            "description":"The contact name associated with the web activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the web activity was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the web activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElqSubjectLine":{
            "title":"Eloqua Subject Line",
            "maxLength":500,
            "type":"string",
            "description":"The email subject line associated with the web activity.",
            "nullable":true,
            "x-hints":{
                "webActivityRules":"true"
            },
            "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."
        }
    }
}

「トップに戻る」