Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

キャンペーンの作成

post

/crmRestApi/resources/11.13.18.05/campaigns

リクエスト

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
Upsert-Mode:

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

ActualCost: number

タイトル: Actual Cost

キャンペーンの実際の費用。
BudgetedCost: number

タイトル: Budgeted Cost

キャンペーンの予算費用。
CampaignAccountAttributionCriteria: array Campaign Account Attribution Criteria

タイトル: Campaign Account Attribution Criteria

キャンペーン・アカウント属性基準リソースは、販売ターゲット・キャンペーンに関連付けられたキャンペーン・アカウント属性基準を表示、作成、更新および削除するために使用されます。
CampaignAccounts: array Campaign Accounts

タイトル: Campaign Accounts

キャンペーン・アカウント・リソースは、販売ターゲット・キャンペーンに関連付けられたアカウントの表示、作成、更新および削除に使用されます。
CampaignCategory: string

タイトル: Category

最大長: 30

デフォルト値: ORA_MARKETING

キャンペーンのカテゴリ。
CampaignCreatedBy: string

タイトル: Campaign Created By

最大長: 64

キャンペーン・レコードを作成したユーザー。
CampaignCreationDate: string (date-time)

タイトル: Campaign Creation Date

キャンペーン・レコードが作成された日付。
CampaignId: integer (int64)

タイトル: Campaign ID

キャンペーンの一意の識別子。
CampaignLastUpdateDate: string (date-time)

タイトル: Campaign Last Update Date

キャンペーン・レコードが最後に更新された日付。
CampaignLastUpdatedBy: string

タイトル: Campaign Last Updated By

最大長: 64

キャンペーン・レコードを最後に更新したユーザー。
CampaignName(required): string

タイトル: Name

最大長: 100

キャンペーンの名前。
CampaignNumber: string

タイトル: Campaign Number

最大長: 30

キャンペーンの代替キー識別子。
CampaignOrigin: string

タイトル: Origin

最大長: 30

デフォルト値: MKT_CAMPAIGN

キャンペーンの発生元。
CampaignProducts: array Campaign Products

タイトル: Campaign Products

キャンペーン製品リソースは、販売ターゲット・キャンペーンに関連付けられている製品または製品グループを表示、作成、更新および削除するために使用されます。
CampaignRollup: array Campaign Rollups

タイトル: Campaign Rollups

キャンペーン・ロールアップ・リソースは、キャンペーン・ロールアップの表示に使用されます。
CampaignTeam: array Campaign Teams

タイトル: Campaign Teams

キャンペーン・チーム・リソースは、販売ターゲット・キャンペーンに関連付けられたリソースを表示、作成、更新および削除するために使用されます。
CampaignType: string

タイトル: Type

最大長: 30

キャンペーンのタイプ。
CreatedByModule: string

タイトル: Created by Module

最大長: 60

デフォルト値: ORA_WS

キャンペーンの作成に使用されたモジュール。
CurrencyCode: string

タイトル: Currency

最大長: 15

USDやGBPなど、キャンペーンに関連付けられた通貨を示すコード。
Description: string

タイトル: Description

最大長: 2000

キャンペーンの簡単な説明。
EndDate: string (date-time)

タイトル: End Date

キャンペーンが終了した日付。
MktCampaignMembers: array Campaign Members

タイトル: Campaign Members

キャンペーン・メンバー・リソースは、営業キャンペーンに関連付けられているメンバーを表示するために使用されます。
NumberOfAssociatedAccounts: number

タイトル: Number of Accounts

販売ターゲット・キャンペーンに関連付けられているアカウントの数。
NumberOfLeadsErrored: number

タイトル: Number of Lead Generation Errors

特定の営業ターゲット・キャンペーンでエラーが発生したリードの数。
NumberOfLeadsGenerated: number

タイトル: Number of Leads Generated

特定の販売ターゲット・キャンペーンに対して生成されたリードの数。
OwnerId: integer (int64)

タイトル: Owner ID

キャンペーンの所有者の一意の識別子。
OwnerPartyName: string

タイトル: Owner

最大長: 360

キャンペーン所有者に関連付けられたパーティの名前。
ParentCampaignId: integer (int64)

タイトル: Parent Campaign ID

親キャンペーンの一意の識別子。
ProductDescription: string

タイトル: Product Description

最大長: 100

キャンペーンの製品の簡単な説明。
RegionCode: string

タイトル: Region Code

最大長: 100

キャンペーンのリージョンを示すコード。
SalesContents: array Sales Contents

タイトル: Sales Contents

販売コンテンツ・リソースは、販売ターゲット・キャンペーンに関連付けられている販売コンテンツの表示、作成、更新および削除に使用されます。
SalesTargetCampaignDaysToVerify: 整数(int32)

タイトル: Validation Period in Days

生成された営業ターゲット・リードを検証する必要がある期間(日数)。
SalesTargetCampaignEloquaSyncDate: string (date-time)

タイトル: Last Sync to Marketing Date

この営業ターゲット・キャンペーンが初めてEloquaに同期される日付。
SalesTargetCampaignStage: string

タイトル: Stage

最大長: 32

営業ターゲット・キャンペーンのステージを示すコード。
SalesTargetLeadsCreationDate: string (date-time)

タイトル: Last Lead Generation Date

このキャンペーンのセールス・ターゲット見込み客が最後に生成された日付。
smartActions: array Smart Actions

タイトル: Smart Actions

スマート・アクション・リソースは、スマート・アクションの名前、セキュリティ、コンテキスト・オブジェクト、REST操作、確認メッセージおよびその他のグローバル・プロパティを表示するために使用されます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
SourceSystemCampaignId: string

タイトル: Source System Campaign ID

最大長: 100

ソース・システム内のキャンペーンの一意の識別子。
SourceSystemEmailId: integer (int64)

ソース・システム内のEメールの一意の識別子。
SourceSystemLandingPageId: integer (int64)

ソース・システム内のランディング・ページの一意の識別子。
SourceSystemSegmentId: integer (int64)

ソース・システム内のセグメントの一意の識別子。
SourceSystemSharedListId: integer (int64)

ソース・システム内の共有リストの一意の識別子。
StartDate: string (date-time)

タイトル: Start Date

キャンペーンが開始された日付。
Status: string

タイトル: Status

最大長: 30

デフォルト値: ORA_DRAFT

キャンペーンのステータス。

{
    "required":[
        "CampaignName"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"A brief description of the campaign.",
            "nullable":true,
            "x-queryable":false
        },
        "RegionCode":{
            "title":"Region Code",
            "maxLength":100,
            "type":"string",
            "description":"The code indicating the region of the campaign.",
            "nullable":true
        },
        "NumberOfAssociatedAccounts":{
            "title":"Number of Accounts",
            "type":"number",
            "description":"The number of accounts associated to sales target campaign.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemLandingPageId":{
            "type":"integer",
            "description":"The unique identifier of the Landing Page in the source system.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SalesTargetCampaignDaysToVerify":{
            "title":"Validation Period in Days",
            "type":"integer",
            "description":"The period in days during which the generated sales target leads should be validated.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "CampaignName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the campaign.",
            "nullable":false
        },
        "SalesTargetCampaignEloquaSyncDate":{
            "title":"Last Sync to Marketing Date",
            "type":"string",
            "description":"The date on which this sales target campaign is synced to Eloqua for the first time.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignCreationDate":{
            "title":"Campaign Creation Date",
            "type":"string",
            "description":"The date when the campaign record was created.",
            "format":"date-time",
            "nullable":true
        },
        "CampaignCategory":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the campaign.",
            "nullable":true,
            "default":"ORA_MARKETING",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/campaigns-smartActions-item-post-request"
            }
        },
        "CampaignCreatedBy":{
            "title":"Campaign Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the campaign record.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the currency associated with the campaign, such as USD or GBP.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the campaign started.",
            "format":"date-time",
            "nullable":true
        },
        "SourceSystemSegmentId":{
            "type":"integer",
            "description":"The unique identifier of the Segment in the source system.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SalesTargetLeadsCreationDate":{
            "title":"Last Lead Generation Date",
            "type":"string",
            "description":"The date on which the sales target leads for this campaign was last generated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"resources"
            }
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign.",
            "nullable":false
        },
        "ParentCampaignId":{
            "title":"Parent Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the parent campaign.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignLastUpdatedBy":{
            "title":"Campaign Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the campaign record.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "MktCampaignMembers":{
            "title":"Campaign Members",
            "type":"array",
            "description":"The campaign members resource is used to view the members associated with a sales campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-MktCampaignMembers-item-post-request"
            }
        },
        "CreatedByModule":{
            "title":"Created by Module",
            "maxLength":60,
            "type":"string",
            "description":"The module through which the campaign was created.",
            "nullable":false,
            "default":"ORA_WS",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceSystemCampaignId":{
            "title":"Source System Campaign ID",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the campaign in the source system.",
            "nullable":true
        },
        "NumberOfLeadsGenerated":{
            "title":"Number of Leads Generated",
            "type":"number",
            "description":"The number of leads generated for a given sales target campaign.",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignProducts":{
            "title":"Campaign Products",
            "type":"array",
            "description":"The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignProducts-item-post-request"
            }
        },
        "BudgetedCost":{
            "title":"Budgeted Cost",
            "type":"number",
            "description":"The budgeted cost of the campaign.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":2
            }
        },
        "CampaignType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the campaign.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the campaign.",
            "nullable":false,
            "default":"ORA_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesContents":{
            "title":"Sales Contents",
            "type":"array",
            "description":"The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-SalesContents-item-post-request"
            }
        },
        "CampaignOrigin":{
            "title":"Origin",
            "maxLength":30,
            "type":"string",
            "description":"The origin of the campaign.",
            "nullable":true,
            "default":"MKT_CAMPAIGN",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CampaignRollup":{
            "title":"Campaign Rollups",
            "type":"array",
            "description":"The campaign rollup resource is used to view a campaign rollup.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignRollup-item-post-request"
            },
            "x-cardinality":"1"
        },
        "OwnerPartyName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party associated with the campaign owner.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NumberOfLeadsErrored":{
            "title":"Number of Lead Generation Errors",
            "type":"number",
            "description":"The number of leads errored for a given sales target campaign.",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignAccountAttributionCriteria":{
            "title":"Campaign Account Attribution Criteria",
            "type":"array",
            "description":"The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignAccountAttributionCriteria-item-post-request"
            }
        },
        "SalesTargetCampaignStage":{
            "title":"Stage",
            "maxLength":32,
            "type":"string",
            "description":"The code indicating the stage of sales target campaign.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceSystemSharedListId":{
            "type":"integer",
            "description":"The unique identifier of the Shared List in the source system.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ActualCost":{
            "title":"Actual Cost",
            "type":"number",
            "description":"The actual cost of the campaign.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":2
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when campaign ended.",
            "format":"date-time",
            "nullable":true
        },
        "CampaignAccounts":{
            "title":"Campaign Accounts",
            "type":"array",
            "description":"The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignAccounts-item-post-request"
            }
        },
        "SourceSystemEmailId":{
            "type":"integer",
            "description":"The unique identifier of the Email in the source system.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignLastUpdateDate":{
            "title":"Campaign Last Update Date",
            "type":"string",
            "description":"The date when the campaign record was last updated.",
            "format":"date-time",
            "nullable":true
        },
        "CampaignTeam":{
            "title":"Campaign Teams",
            "type":"array",
            "description":"The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignTeam-item-post-request"
            }
        },
        "ProductDescription":{
            "title":"Product Description",
            "maxLength":100,
            "type":"string",
            "description":"A brief description of the product of the campaign.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : キャンペーン・アカウント属性基準

タイプ: array

タイトル: Campaign Account Attribution Criteria

キャンペーン・アカウント属性基準リソースは、販売ターゲット・キャンペーンに関連付けられたキャンペーン・アカウント属性基準を表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object campaigns-CampaignAccountAttributionCriteria-item-post-request

{
    "title":"Campaign Account Attribution Criteria",
    "type":"array",
    "description":"The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignAccountAttributionCriteria-item-post-request"
    }
}

ネストされたスキーマ : キャンペーン・アカウント

タイプ: array

タイトル: Campaign Accounts

キャンペーン・アカウント・リソースは、販売ターゲット・キャンペーンに関連付けられたアカウントの表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object schema

{
    "title":"Campaign Accounts",
    "type":"array",
    "description":"The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignAccounts-item-post-request"
    }
}

ネストされたスキーマ : キャンペーン製品

タイプ: array

タイトル: Campaign Products

キャンペーン製品リソースは、販売ターゲット・キャンペーンに関連付けられている製品または製品グループを表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object schema

{
    "title":"Campaign Products",
    "type":"array",
    "description":"The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignProducts-item-post-request"
    }
}

ネストされたスキーマ : キャンペーン・ロールアップ

タイプ: array

タイトル: Campaign Rollups

キャンペーン・ロールアップ・リソースは、キャンペーン・ロールアップの表示に使用されます。

ソースを表示

Array of: object campaigns-CampaignRollup-item-post-request

{
    "title":"Campaign Rollups",
    "type":"array",
    "description":"The campaign rollup resource is used to view a campaign rollup.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignRollup-item-post-request"
    },
    "x-cardinality":"1"
}

ネストされたスキーマ : キャンペーン・チーム

タイプ: array

タイトル: Campaign Teams

キャンペーン・チーム・リソースは、販売ターゲット・キャンペーンに関連付けられたリソースを表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object campaigns-CampaignTeam-item-post-request

{
    "title":"Campaign Teams",
    "type":"array",
    "description":"The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignTeam-item-post-request"
    }
}

ネストされたスキーマ : キャンペーン・メンバー

タイプ: array

タイトル: Campaign Members

キャンペーン・メンバー・リソースは、営業キャンペーンに関連付けられているメンバーを表示するために使用されます。

ソースを表示

Array of: object campaigns-MktCampaignMembers-item-post-request

{
    "title":"Campaign Members",
    "type":"array",
    "description":"The campaign members resource is used to view the members associated with a sales campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-MktCampaignMembers-item-post-request"
    }
}

ネストされたスキーマ : 販売コンテンツ

タイプ: array

タイトル: Sales Contents

販売コンテンツ・リソースは、販売ターゲット・キャンペーンに関連付けられている販売コンテンツの表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object schema

{
    "title":"Sales Contents",
    "type":"array",
    "description":"The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-SalesContents-item-post-request"
    }
}

ネストされたスキーマ : スマートなアクション

タイプ: array

タイトル: Smart Actions

スマート・アクション・リソースは、スマート・アクションの名前、セキュリティ、コンテキスト・オブジェクト、REST操作、確認メッセージおよびその他のグローバル・プロパティを表示するために使用されます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。

ソースを表示

Array of: object campaigns-smartActions-item-post-request

{
    "title":"Smart Actions",
    "type":"array",
    "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/campaigns-smartActions-item-post-request"
    }
}

ネストされたスキーマ : campaigns-CampaignAccountAttributionCriteria-item-post-request

タイプ: object

ソースを表示

CampaignAccountAttrCriteriaId: integer (int64)

タイトル: Campaign Attribution Criteria ID

キャンペーン・アカウント属性基準の一意の識別子。
CampaignAccountAttrCriteriaNumber: string

タイトル: Campaign Attribution Criteria Number

最大長: 30

アカウント属性基準の代替キー識別子。
CampaignId: integer (int64)

タイトル: Campaign Identifier

キャンペーン・アカウントの一意の識別子。
CriteriaExpression: 文字列(バイト)

タイトル: Criteria Expression

これには、UIで選択した基準の問合せ式が含まれます。
CriteriaType: string

タイトル: Criteria Type

最大長: 30

定義されている基準が包含か除外かを示します。
ExclusionCriteriaFlag: boolean

タイトル: Is Exclusion Criteria

最大長: 1

デフォルト値: false

アカウント属性基準がアカウントを除外するかどうかを示します。
SourceObjectAttr: string

タイトル: Source Object Attribute

最大長: 150

ソース・オブジェクトID値を保持する属性。
SourceObjectCode: string

タイトル: Source Object

最大長: 30

オブジェクト名の言語非依存コード。

{
    "type":"object",
    "properties":{
        "CampaignAccountAttrCriteriaNumber":{
            "title":"Campaign Attribution Criteria Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the account attribution criterion.",
            "nullable":false
        },
        "CampaignId":{
            "title":"Campaign Identifier",
            "type":"integer",
            "description":"The unique identifier of the campaign account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SourceObjectCode":{
            "title":"Source Object",
            "maxLength":30,
            "type":"string",
            "description":"The language independent code for an object name.",
            "nullable":false
        },
        "ExclusionCriteriaFlag":{
            "title":"Is Exclusion Criteria",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the Account Attribution criteria is for excluding any account or not.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "CriteriaType":{
            "title":"Criteria Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the criteria defined is inclusion or exclusion.",
            "nullable":false
        },
        "CriteriaExpression":{
            "title":"Criteria Expression",
            "type":"string",
            "description":"This contains the query expression of criteria chosen on UI.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "SourceObjectAttr":{
            "title":"Source Object Attribute",
            "maxLength":150,
            "type":"string",
            "description":"The attribute that holds source object Id value.",
            "nullable":false
        },
        "CampaignAccountAttrCriteriaId":{
            "title":"Campaign Attribution Criteria ID",
            "type":"integer",
            "description":"The unique identifier of the campaign account attribution criterion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

タイプ: object

ソースを表示

AccountId: integer (int64)

タイトル: Campaign Account Party ID

キャンペーン・アカウントに関連付けられたアカウントの一意の識別子。
CampaignAccountId: integer (int64)

タイトル: Campaign Account ID

キャンペーン・アカウントの一意の識別子。
CampaignAccountNumber: string

タイトル: Campaign Account Number

最大長: 30

キャンペーン・アカウントの代替キー識別子。
CampaignId: integer (int64)

タイトル: Campaign Identifier

キャンペーンの一意の識別子。
CampaignNumber: string

タイトル: Campaign Number

最大長: 30

キャンペーン・アカウントが属するキャンペーンの一意の識別子。
ErrorDescription: string

タイトル: Error Description

最大長: 2000

このアカウントのリード生成中に生成されたエラー・メッセージが含まれています。
LeadId: integer (int64)

タイトル: Lead ID

キャンペーン・アカウントに関連付けられたリードの一意の識別子。
LeadNumber: string

タイトル: Lead Number

最大長: 30

キャンペーン・アカウントに関連付けられたリードの一意の代替識別子。
QueryCriteriaType: string

タイトル: Query Criteria Type

最大長: 10

デフォルト値: MANUAL

これは、アカウントが問合せビルダーによって追加されたか、手動で追加されたかを示します。

{
    "type":"object",
    "properties":{
        "ErrorDescription":{
            "title":"Error Description",
            "maxLength":2000,
            "type":"string",
            "description":"This contains the error message generated during lead generation of this account.",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignAccountNumber":{
            "title":"Campaign Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign account.",
            "nullable":false
        },
        "AccountId":{
            "title":"Campaign Account Party ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the campaign account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignId":{
            "title":"Campaign Identifier",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign account belongs to.",
            "nullable":false
        },
        "CampaignAccountId":{
            "title":"Campaign Account ID",
            "type":"integer",
            "description":"The unique identifier of the campaign account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique alternate identifier of the lead associated with the campaign account.",
            "nullable":false
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the lead associated with the campaign account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "QueryCriteriaType":{
            "title":"Query Criteria Type",
            "maxLength":10,
            "type":"string",
            "description":"This indicates whether the account is added by query builder or manually.",
            "nullable":false,
            "default":"MANUAL",
            "x-queryable":false
        }
    }
}

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

タイプ: object

ソースを表示

CampaignId: integer (int64)

タイトル: Campaign ID

キャンペーンの一意の識別子。
CampaignNumber: string

タイトル: Campaign Number

最大長: 30

キャンペーン製品が属するキャンペーンの一意の識別子。
CampaignProductId: integer (int64)

タイトル: Campaign Product ID

キャンペーン製品の一意の識別子。
CampaignProductNumber: string

タイトル: Campaign Product Number

最大長: 30

キャンペーン製品の代替キー識別子。
InventoryItemId: integer (int64)

タイトル: Campaign Inventory Item ID

キャンペーン製品に関連付けられた一意の在庫品目識別子。
InventoryOrgId: integer (int64)

タイトル: Campaign Inventory Org ID

このキャンペーン製品に関連付けられた一意の在庫組織識別子。
ProductGroupId: integer (int64)

タイトル: Campaign Product Group ID

製品グループの一意の識別子。
ProductGroupNumber: string

タイトル: Reference Number

最大長: 50

参照製品グループの代替キー。
ProductType: string

タイトル: Product Type

製品のタイプ(品目または製品グループなど)。

{
    "type":"object",
    "properties":{
        "ProductGroupId":{
            "title":"Campaign Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"CRMProductGroup"
            }
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign product belongs to.",
            "nullable":false
        },
        "InventoryItemId":{
            "title":"Campaign Inventory Item ID",
            "type":"integer",
            "description":"The unique inventory item identifier associated with the campaign product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"CRMProduct"
            }
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the product, such as item or product group.",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignProductId":{
            "title":"Campaign Product ID",
            "type":"integer",
            "description":"The unique identifier of the campaign product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignProductNumber":{
            "title":"Campaign Product Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign product.",
            "nullable":false
        },
        "InventoryOrgId":{
            "title":"Campaign Inventory Org ID",
            "type":"integer",
            "description":"The unique inventory organization identifier associated with this campaign product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProductGroupNumber":{
            "title":"Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The alternate key for referenced product group.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : campaigns-CampaignRollup-item-post-request

タイプ: object

ソースを表示

{
    "type":"object",
    "properties":{
    }
}

ネストされたスキーマ : campaigns-CampaignTeam-item-post-request

タイプ: object

ソースを表示

AccessLevelCode: string

タイトル: Campaign Team Member Access Level Code

最大長: 30

デフォルト値: 300

チーム・メンバーのアクセス・レベルを示すコード。
ApproverFlag: boolean

タイトル: Is Approver

最大長: 1

デフォルト値: false

チーム・メンバーがキャンペーンの承認者であるかどうかを示します。
CampaignId: integer (int64)

タイトル: Campaign ID

キャンペーンの一意の識別子。
CampaignNumber: string

タイトル: Campaign Number

最大長: 30

キャンペーン・リソースが属するキャンペーンの一意の識別子。
CampaignTeamId: integer (int64)

タイトル: Campaign Team Member ID

キャンペーン・リソースの一意の識別子。
CampaignTeamNumber: string

タイトル: Campaign Team Member Number

最大長: 30

キャンペーン・リソースの代替キー識別子。
MemberFunctionCode: string

タイトル: Campaign Team Member Function Code

最大長: 30

このキャンペーンのコンテキストにおけるリード担当者のロール。
OwnerFlag: boolean

タイトル: Owner

このリソースがこのキャンペーンのプライマリ・リソースかどうかを示します。
ResourceId: integer (int64)

タイトル: Campaign Team Member Party ID

この営業キャンペーン・リソースに関連付けられた一意の識別子。

{
    "type":"object",
    "properties":{
        "AccessLevelCode":{
            "title":"Campaign Team Member Access Level Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the access level of a team member.",
            "nullable":false,
            "default":"300",
            "x-queryable":false
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceId":{
            "title":"Campaign Team Member Party ID",
            "type":"integer",
            "description":"The unique identifier associated with this sales campaign resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"resources"
            }
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign resource belongs to.",
            "nullable":false
        },
        "ApproverFlag":{
            "title":"Is Approver",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the team member is approver of the campaign.",
            "nullable":true,
            "default":false
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether this resource is a primary resource for this campaign.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "MemberFunctionCode":{
            "title":"Campaign Team Member Function Code",
            "maxLength":30,
            "type":"string",
            "description":"The role of lead contact in the context of this campaign.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CampaignTeamId":{
            "title":"Campaign Team Member ID",
            "type":"integer",
            "description":"The unique identifier of the campaign resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignTeamNumber":{
            "title":"Campaign Team Member Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign resource.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : campaigns-MktCampaignMembers-item-post-request

タイプ: object

ソースを表示

CampaignCampaignNumber: string

タイトル: Campaign Number

最大長: 30

キャンペーン・メンバーが属するキャンペーンの一意の識別子。
CampaignId: integer (int64)

タイトル: Campaign Identifier

キャンペーン・メンバーの一意の識別子。
CampaignMemberId: integer (int64)

タイトル: Campaign Member ID

キャンペーンの一意の識別子。
CampaignMemberNumber: string

タイトル: Campaign Member Number

最大長: 30

キャンペーン・メンバーの代替キー識別子。
ContactId: integer (int64)

タイトル: Contact ID

キャンペーン・メンバーに関連付けられたパーティの一意の識別子。
CreatedByModule: string

タイトル: Created by Module

最大長: 60

デフォルト値: ORA_WS

キャンペーン・メンバーを作成できるモジュール。
CurrencyCode: string

タイトル: Currency

最大長: 15

USDやGBPなど、キャンペーン・メンバーに関連付けられた通貨を示すコード。
EmailAddress: string

タイトル: Email

最大長: 320

キャンペーン・メンバーの電子メール・アドレス。
LeadId: integer (int64)

タイトル: Lead ID

キャンペーン・メンバーに関連付けられたリードの一意の識別子。
LeadLeadNumber: string

タイトル: Lead Number

最大長: 30

キャンペーン・メンバーに関連付けられたリードの一意の代替識別子。
MemberResponseDate: string (date-time)

タイトル: Response Date

キャンペーン・メンバーのレスポンスを受信した日付。
MemberStatus: string

タイトル: Member Status

最大長: 30

デフォルト値: ORA_SENT

キャンペーン・メンバーのステータス。
SourceSystemCampMemberId: string

タイトル: Source System Campaign Member ID

最大長: 100

ソース・システム内のキャンペーン・メンバーの一意の識別子。

{
    "type":"object",
    "properties":{
        "SourceSystemCampMemberId":{
            "title":"Source System Campaign Member ID",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the campaign member in the source system.",
            "nullable":true
        },
        "CampaignMemberId":{
            "title":"Campaign Member ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with the campaign member.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"contacts"
            }
        },
        "MemberResponseDate":{
            "title":"Response Date",
            "type":"string",
            "description":"The date when the response is received for the campaign member.",
            "format":"date-time",
            "nullable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the campaign member.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the currency associated with the campaign member, such as USD or GBP.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CampaignMemberNumber":{
            "title":"Campaign Member Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign member.",
            "nullable":false
        },
        "CampaignId":{
            "title":"Campaign Identifier",
            "type":"integer",
            "description":"The unique identifier of the campaign member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignCampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign member belongs to.",
            "nullable":false
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the lead associated with the campaign member.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"leads"
            }
        },
        "LeadLeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique alternate identifier of the lead associated with the campaign member.",
            "nullable":false
        },
        "CreatedByModule":{
            "title":"Created by Module",
            "maxLength":60,
            "type":"string",
            "description":"The module through which the campaign member can be created.",
            "nullable":false,
            "default":"ORA_WS",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MemberStatus":{
            "title":"Member Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the campaign member.",
            "nullable":true,
            "default":"ORA_SENT",
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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

タイプ: object

ソースを表示

ContentItemId: string

タイトル: Content ID

最大長: 64

ソース・システムからの内部コンテンツ・アイテム識別子。
ContentItemName: string

タイトル: Content Name

最大長: 4000

販売コンテンツ・アイテムの名前。
ContentSourceSystem: string

最大長: 50

デフォルト値: OCE

コンテンツ・アイテムのソース元を示します。
DeletedInSourceFlag: boolean

タイトル: Content Deleted in Source

最大長: 1

デフォルト値: false

参照販売コンテンツ・アイテムがソース・システムで削除されるかどうかを示します。
DisplaySequence: 整数(int32)

タイトル: Display Sequence

販売コンテンツがページに表示される順序を示します。
ParentObjectId: integer (int64)

タイトル: Parent Object ID

販売コンテンツ行に関連付けられたオブジェクトの一意の識別子。
ParentObjectType: string

最大長: 128

販売コンテンツ行に関連付けられた親オブジェクト・タイプ。たとえば、アカウント、担当者、リードなどです。
PublicContentItemId: string

タイトル: Public Content ID

最大長: 64

ソース・システムからの公開コンテンツ・アイテム識別子。
PublicContentItemName: string

タイトル: Public Content Name

最大長: 4000

公開販売コンテンツ・アイテムの名前。
PublicCustomerName: string

タイトル: Customer Name

最大長: 4000

公開コンテンツが公開された顧客の名前。
PublicPublishedDate: string (date-time)

タイトル: Publish Date

公開コンテンツ・アイテムが公開された日付。
PublicStoryLink: string

タイトル: Public URL

最大長: 4000

公開コンテンツ・アイテムのリンク。

{
    "type":"object",
    "properties":{
        "ContentSourceSystem":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates from where the content item is sourced.",
            "nullable":true,
            "default":"OCE"
        },
        "ContentItemName":{
            "title":"Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the sales content item.",
            "nullable":false
        },
        "PublicCustomerName":{
            "title":"Customer Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the customer for which the public content was published.",
            "nullable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Indicates the sequence in which the sales content should appear in a page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "PublicContentItemId":{
            "title":"Public Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The public content item identifier from the source system.",
            "nullable":true
        },
        "ParentObjectType":{
            "maxLength":128,
            "type":"string",
            "description":"The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on.",
            "nullable":false
        },
        "ContentItemId":{
            "title":"Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The internal content item identifier from the source system.",
            "nullable":false
        },
        "PublicPublishedDate":{
            "title":"Publish Date",
            "type":"string",
            "description":"The date on which the public content item was published.",
            "format":"date-time",
            "nullable":true
        },
        "PublicStoryLink":{
            "title":"Public URL",
            "maxLength":4000,
            "type":"string",
            "description":"The link of the public content item.",
            "nullable":true
        },
        "PublicContentItemName":{
            "title":"Public Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the public sales content item.",
            "nullable":true
        },
        "ParentObjectId":{
            "title":"Parent Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated to the sales content row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DeletedInSourceFlag":{
            "title":"Content Deleted in Source",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether referred sales content item is deleted in source system.",
            "nullable":true,
            "default":false
        }
    }
}

ネストされたスキーマ : campaigns-smartActions-item-post-request

タイプ: object

ソースを表示

ActionIntent: 文字列(バイト)

タイトル: Action Intent

アクションの実行内容、およびアクションに渡すことができるコンテキスト・データを記述するJSONオブジェクト。
ConfirmationMessage: string

タイトル: Confirmation Message

最大長: 1024

実行中のアクションの確認を求めるメッセージ。
ContentType: string

タイトル: Content Type

最大長: 50

RESTエンドポイントの呼出し時に使用するコンテンツ・タイプ。
DisplayLabel(required): string

タイトル: Action Name

最大長: 256

コンシューマ・フレンドリなアクション名。
Entity(required): string

タイトル: Parent Entity

最大長: 150

アクションが属するRESTリソース。
Href: string

タイトル: REST Endpoint

最大長: 150

アクションを実行するRESTエンドポイント。
IncludedInApplication: string

タイトル: Included in Application

最大長: 512

このアクションを使用できるアプリケーションのリスト。
Method: string

タイトル: HTTP Method

最大長: 15

スマート・アクションREST操作のHTTPメソッド。
ObjectFunctionName: string

タイトル: Object Function

最大長: 64

スマート・アクションに関連付けられたオブジェクト関数。
PageType: string

タイトル: Page Type

最大長: 256

このアクションを使用できるページのリスト。
SmartSuggestFlag: boolean

タイトル: Smart Suggest

最大長: 1

処理に対してスマート提案が使用可能かどうかを示します。
SystemActionFlag: boolean

タイトル: System Action

最大長: 1

処理がシード済かカスタムかを示します。
UpdateOfAttributes: string

タイトル: Attributes to Update

最大長: 512

処理UIの起動時に更新される属性。
UserActionId: integer (int64)

タイトル: User Action ID

スマート処理定義の一意のシステム割当識別子。
UserActionName(required): string

タイトル: Action Name

最大長: 256

名前を持つ処理を一意に識別します。内部使用。
UserActionNavigation: array Smart Action User Interface Definitions

タイトル: Smart Action User Interface Definitions

アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。
UserActionRank: integer (int64)

タイトル: Priority

処理の優先度を示す番号。
UserActionRequestPayload: array Smart Action REST Payload Definitions

タイトル: Smart Action REST Payload Definitions

リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。
UserActionURLBinding: array Smart Action User Interface Definitions

タイトル: Smart Action User Interface Definitions

URL内の変数のメタデータをバインドします。

{
    "required":[
        "DisplayLabel",
        "Entity",
        "UserActionName"
    ],
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether smart suggest is enabled for the action.",
            "nullable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The REST Resources the Action belongs to.",
            "nullable":false
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/campaigns-smartActions-UserActionURLBinding-item-post-request"
            }
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The list of applications that this action can be used in.",
            "nullable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/campaigns-smartActions-UserActionNavigation-item-post-request"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":150,
            "type":"string",
            "description":"The REST endpoint to perform the Action.",
            "nullable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The consumer friendly Action Name.",
            "nullable":false
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Uniquely identifies the Action with name. For internal use.",
            "nullable":false
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique system assigned identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action is seeded or custom.",
            "nullable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":1024,
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/campaigns-smartActions-UserActionRequestPayload-item-post-request"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The attributes to be updated when the Actions UI is launched.",
            "nullable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : スマート処理ユーザー・インタフェース定義

タイプ: array

タイトル: Smart Action User Interface Definitions

アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。

ソースを表示

Array of: object campaigns-smartActions-UserActionNavigation-item-post-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/campaigns-smartActions-UserActionNavigation-item-post-request"
    }
}

ネストされたスキーマ : スマート・アクションのRESTペイロード定義

タイプ: array

タイトル: Smart Action REST Payload Definitions

リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。

ソースを表示

Array of: object campaigns-smartActions-UserActionRequestPayload-item-post-request

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/campaigns-smartActions-UserActionRequestPayload-item-post-request"
    }
}

ネストされたスキーマ : スマート処理ユーザー・インタフェース定義

タイプ: array

タイトル: Smart Action User Interface Definitions

URL内の変数のメタデータをバインドします。

ソースを表示

Array of: object campaigns-smartActions-UserActionURLBinding-item-post-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/campaigns-smartActions-UserActionURLBinding-item-post-request"
    }
}

ネストされたスキーマ : campaigns-smartActions-UserActionNavigation-item-post-request

タイプ: object

ソースを表示

SystemActionFlag: boolean

タイトル: System Action

最大長: 1

デフォルト値: false

スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。値は、smartActions.SystemActionFlagから自動的に導出されます。
UserActionNavAppUsage: string

タイトル: Application Usage

最大長: 50

UserActionNavIdで識別されるスマート・アクション・ユーザー・インタフェース・エンドポイント定義に関連付けられたクライアント・アプリケーション。
UserActionNavBody: string

タイトル: Navigation Metadata

最大長: 1000

スマート・アクションのユーザー・インタフェース・エンドポイントのメタデータ定義。
UserActionNavId: integer (int64)

タイトル: Primary Key

スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。値は、smartActions.SystemActionFlagから自動的に導出されます。
UserActionNavType: string

タイトル: Navigation Type

最大長: 100

起動するユーザー・インタフェースを決定するためにアプリケーションで使用されるテキスト値。

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : campaigns-smartActions-UserActionRequestPayload-item-post-request

タイプ: object

ソースを表示

Binding: string

タイトル: Payload Value Binding Type

最大長: 64

名前と値のペアの値プロパティの分類。バインディング値RUNTIMEは、割り当てられる値がオブジェクト属性の実行時値であることを示します。値STATICは、割り当てられる値が単純な文字列であることを示します。 NULL値は、値タイプがJSON_ARRAY_STRINGであることを示します。
MandatoryFlag: boolean

タイトル: Mandatory

最大長: 1

RESTペイロード本文のパラメータ値が必須かどうかを示します。 Trueの場合、ランタイム検証によって値が確実に定義されます。
RequestPayloadId: integer (int64)

スマート・アクションRESTペイロード本文パラメータの名前と値のペア定義の一意のシステム割当識別子。
RequestPayloadName: string

タイトル: Request Payload Attribute Name

最大長: 256

名前と値のペアの名前プロパティに割り当てられた値。
SmartSuggestPath: string

タイトル: Smart Suggest Path

最大長: 2048

スマート候補に使用されるパス。
SystemActionFlag: boolean

タイトル: System Action

最大長: 1

デフォルト値: false

スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。値は、smartActions.SystemActionFlagから自動的に導出されます。
Value: string

タイトル: Request Payload Attribute Value

最大長: 250

名前と値のペアの値プロパティに割り当てられた値。
ValueStruct: string

タイトル: Payload Value Structure

最大長: 20

値JSON_ARRAY_STRINGは、名前と値のペアの値プロパティが、オブジェクト属性名や単純なテキスト文字列などの単一エンティティではなく、データの配列を表すことを示します。配列文字列は、名前と値のペア、およびバインディングと必須プロパティの定義です。配列文字列は、[{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]などの特定のパターンに従います。 null値は、値プロパティが、オブジェクト属性名や単純なテキスト文字列などの単純な単一エンティティを表すことを示します。

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":250,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : campaigns-smartActions-UserActionURLBinding-item-post-request

タイプ: object

ソースを表示

Binding: string

タイトル: URL Binding Type

最大長: 64

名前と値のペアの値プロパティの分類。 UserActionURLBindingインスタンスのバインディング値は、RUNTIMEである必要があります。バインディング値RUNTIMEは、割り当てられる値がオブジェクト属性の実行時値であることを示します。
SystemActionFlag: boolean

タイトル: System Action

最大長: 1

デフォルト値: false

スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。値は、smartActions.SystemActionFlagから自動的に導出されます。
URLBindingId: integer (int64)

スマート・アクションRESTパス・パラメータの名前と値のペア定義の一意のシステム割当識別子。
URLBindingName: string

タイトル: URL Binding Parameter Name

最大長: 50

名前と値のペアの名前プロパティに割り当てられた値。
Value: string

タイトル: URL Binding Parameter Value

最大長: 80

名前と値のペアの値プロパティに割り当てられた値。

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":80,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST path parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":50,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

タイプ: object

ソースを表示

ActualCost: number

タイトル: Actual Cost

キャンペーンの実際の費用。
BudgetedCost: number

タイトル: Budgeted Cost

キャンペーンの予算費用。
CampaignAccountAttributionCriteria: array Campaign Account Attribution Criteria

タイトル: Campaign Account Attribution Criteria

キャンペーン・アカウント属性基準リソースは、販売ターゲット・キャンペーンに関連付けられたキャンペーン・アカウント属性基準を表示、作成、更新および削除するために使用されます。
CampaignAccounts: array Campaign Accounts

タイトル: Campaign Accounts

キャンペーン・アカウント・リソースは、販売ターゲット・キャンペーンに関連付けられたアカウントの表示、作成、更新および削除に使用されます。
CampaignCategory: string

タイトル: Category

最大長: 30

デフォルト値: ORA_MARKETING

キャンペーンのカテゴリ。
CampaignCreatedBy: string

タイトル: Campaign Created By

最大長: 64

キャンペーン・レコードを作成したユーザー。
CampaignCreationDate: string (date-time)

タイトル: Campaign Creation Date

キャンペーン・レコードが作成された日付。
CampaignId: integer (int64)

タイトル: Campaign ID

キャンペーンの一意の識別子。
CampaignLastUpdateDate: string (date-time)

タイトル: Campaign Last Update Date

キャンペーン・レコードが最後に更新された日付。
CampaignLastUpdatedBy: string

タイトル: Campaign Last Updated By

最大長: 64

キャンペーン・レコードを最後に更新したユーザー。
CampaignName: string

タイトル: Name

最大長: 100

キャンペーンの名前。
CampaignNumber: string

タイトル: Campaign Number

最大長: 30

キャンペーンの代替キー識別子。
CampaignOrigin: string

タイトル: Origin

最大長: 30

デフォルト値: MKT_CAMPAIGN

キャンペーンの発生元。
CampaignProducts: array Campaign Products

タイトル: Campaign Products

キャンペーン製品リソースは、販売ターゲット・キャンペーンに関連付けられている製品または製品グループを表示、作成、更新および削除するために使用されます。
CampaignRollup: array Campaign Rollups

タイトル: Campaign Rollups

キャンペーン・ロールアップ・リソースは、キャンペーン・ロールアップの表示に使用されます。
CampaignTeam: array Campaign Teams

タイトル: Campaign Teams

キャンペーン・チーム・リソースは、販売ターゲット・キャンペーンに関連付けられたリソースを表示、作成、更新および削除するために使用されます。
CampaignType: string

タイトル: Type

最大長: 30

キャンペーンのタイプ。
CampaignTypeMeaning: string

タイトル: Type

読取り専用: true

最大長: 80

キャンペーンのタイプの表示値。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

キャンペーンを作成したユーザー。
CreatedByModule: string

タイトル: Created by Module

最大長: 60

デフォルト値: ORA_WS

キャンペーンの作成に使用されたモジュール。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

キャンペーンが作成された日付。
CurrencyCode: string

タイトル: Currency

最大長: 15

USDやGBPなど、キャンペーンに関連付けられた通貨を示すコード。
DeleteFlag: boolean

タイトル: Can Be Deleted

読取り専用: true

ログイン・ユーザーがキャンペーンを削除できるかどうかを示します。
Description: string

タイトル: Description

最大長: 2000

キャンペーンの簡単な説明。
EndDate: string (date-time)

タイトル: End Date

キャンペーンが終了した日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated

読取り専用: true

キャンペーンが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

キャンペーンを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Updated Login

読取り専用: true

最大長: 32

キャンペーンを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
MktCampaignMembers: array Campaign Members

タイトル: Campaign Members

キャンペーン・メンバー・リソースは、営業キャンペーンに関連付けられているメンバーを表示するために使用されます。
NumberOfAssociatedAccounts: number

タイトル: Number of Accounts

販売ターゲット・キャンペーンに関連付けられているアカウントの数。
NumberOfLeadsErrored: number

タイトル: Number of Lead Generation Errors

特定の営業ターゲット・キャンペーンでエラーが発生したリードの数。
NumberOfLeadsGenerated: number

タイトル: Number of Leads Generated

特定の販売ターゲット・キャンペーンに対して生成されたリードの数。
OwnerId: integer (int64)

タイトル: Owner ID

キャンペーンの所有者の一意の識別子。
OwnerPartyName: string

タイトル: Owner

最大長: 360

キャンペーン所有者に関連付けられたパーティの名前。
OwnerPartyNumber: string

タイトル: Owner Number

読取り専用: true

最大長: 30

キャンペーンの所有者の一意の代替識別子。
ParentCampaignId: integer (int64)

タイトル: Parent Campaign ID

親キャンペーンの一意の識別子。
ParentCampaignName: string

タイトル: Parent Campaign Name

読取り専用: true

最大長: 100

キャンペーンの親の名前。
ParentCampaignNumber: string

タイトル: Parent Campaign Number

読取り専用: true

最大長: 30

キャンペーンの親の一意の代替識別子。
ProductDescription: string

タイトル: Product Description

最大長: 100

キャンペーンの製品の簡単な説明。
RegionCode: string

タイトル: Region Code

最大長: 100

キャンペーンのリージョンを示すコード。
SalesContents: array Sales Contents

タイトル: Sales Contents

販売コンテンツ・リソースは、販売ターゲット・キャンペーンに関連付けられている販売コンテンツの表示、作成、更新および削除に使用されます。
SalesTargetCampaignDaysToVerify: 整数(int32)

タイトル: Validation Period in Days

生成された営業ターゲット・リードを検証する必要がある期間(日数)。
SalesTargetCampaignEloquaSyncDate: string (date-time)

タイトル: Last Sync to Marketing Date

この営業ターゲット・キャンペーンが初めてEloquaに同期される日付。
SalesTargetCampaignStage: string

タイトル: Stage

最大長: 32

営業ターゲット・キャンペーンのステージを示すコード。
SalesTargetLeadsCreationDate: string (date-time)

タイトル: Last Lead Generation Date

このキャンペーンのセールス・ターゲット見込み客が最後に生成された日付。
smartActions: array Smart Actions

タイトル: Smart Actions

スマート・アクション・リソースは、スマート・アクションの名前、セキュリティ、コンテキスト・オブジェクト、REST操作、確認メッセージおよびその他のグローバル・プロパティを表示するために使用されます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
SourceSystemCampaignId: string

タイトル: Source System Campaign ID

最大長: 100

ソース・システム内のキャンペーンの一意の識別子。
SourceSystemEmailId: integer (int64)

ソース・システム内のEメールの一意の識別子。
SourceSystemLandingPageId: integer (int64)

ソース・システム内のランディング・ページの一意の識別子。
SourceSystemSegmentId: integer (int64)

ソース・システム内のセグメントの一意の識別子。
SourceSystemSharedListId: integer (int64)

ソース・システム内の共有リストの一意の識別子。
StartDate: string (date-time)

タイトル: Start Date

キャンペーンが開始された日付。
Status: string

タイトル: Status

最大長: 30

デフォルト値: ORA_DRAFT

キャンペーンのステータス。
StatusLookupMeaning: string

タイトル: Status

読取り専用: true

最大長: 80

キャンペーンのステータスの表示ラベル。
UpdateFlag: boolean

タイトル: Can Be Updated

読取り専用: true

ログイン・ユーザーがキャンペーンを更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RegionCode":{
            "title":"Region Code",
            "maxLength":100,
            "type":"string",
            "description":"The code indicating the region of the campaign.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfAssociatedAccounts":{
            "title":"Number of Accounts",
            "type":"number",
            "description":"The number of accounts associated to sales target campaign.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemLandingPageId":{
            "type":"integer",
            "description":"The unique identifier of the Landing Page in the source system.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignCreationDate":{
            "title":"Campaign Creation Date",
            "type":"string",
            "description":"The date when the campaign record was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/campaigns-smartActions-item-response"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the currency associated with the campaign, such as USD or GBP.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the campaign started.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemSegmentId":{
            "type":"integer",
            "description":"The unique identifier of the Segment in the source system.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ParentCampaignName":{
            "title":"Parent Campaign Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the parent of the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesTargetLeadsCreationDate":{
            "title":"Last Lead Generation Date",
            "type":"string",
            "description":"The date on which the sales target leads for this campaign was last generated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "title":"Created by Module",
            "maxLength":60,
            "type":"string",
            "description":"The module through which the campaign was created.",
            "nullable":false,
            "default":"ORA_WS",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceSystemCampaignId":{
            "title":"Source System Campaign ID",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the campaign in the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "CampaignProducts":{
            "title":"Campaign Products",
            "type":"array",
            "description":"The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignProducts-item-response"
            }
        },
        "BudgetedCost":{
            "title":"Budgeted Cost",
            "type":"number",
            "description":"The budgeted cost of the campaign.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":2
            },
            "x-queryable":true
        },
        "CampaignType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the campaign.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ParentCampaignNumber":{
            "title":"Parent Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique alternate identifier of the parent of the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the campaign.",
            "nullable":false,
            "default":"ORA_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesContents":{
            "title":"Sales Contents",
            "type":"array",
            "description":"The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-SalesContents-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignRollup":{
            "title":"Campaign Rollups",
            "type":"array",
            "description":"The campaign rollup resource is used to view a campaign rollup.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignRollup-item-response"
            },
            "x-cardinality":"1"
        },
        "OwnerPartyName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party associated with the campaign owner.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NumberOfLeadsErrored":{
            "title":"Number of Lead Generation Errors",
            "type":"number",
            "description":"The number of leads errored for a given sales target campaign.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemSharedListId":{
            "type":"integer",
            "description":"The unique identifier of the Shared List in the source system.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignAccounts":{
            "title":"Campaign Accounts",
            "type":"array",
            "description":"The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignAccounts-item-response"
            }
        },
        "DeleteFlag":{
            "title":"Can Be Deleted",
            "type":"boolean",
            "description":"Indicates whether the campaign can be deleted by the logged in user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignTeam":{
            "title":"Campaign Teams",
            "type":"array",
            "description":"The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignTeam-item-response"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"A brief description of the campaign.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique alternate identifier of the owner of the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignTypeMeaning":{
            "title":"Type",
            "maxLength":80,
            "type":"string",
            "description":"The display value of the type of the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesTargetCampaignDaysToVerify":{
            "title":"Validation Period in Days",
            "type":"integer",
            "description":"The period in days during which the generated sales target leads should be validated.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "CampaignName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the campaign.",
            "nullable":false,
            "x-queryable":true
        },
        "SalesTargetCampaignEloquaSyncDate":{
            "title":"Last Sync to Marketing Date",
            "type":"string",
            "description":"The date on which this sales target campaign is synced to Eloqua for the first time.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignCategory":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the campaign.",
            "nullable":true,
            "default":"ORA_MARKETING",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CampaignCreatedBy":{
            "title":"Campaign Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the campaign record.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Be Updated",
            "type":"boolean",
            "description":"Indicates whether the campaign can be updated by the logged in user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentCampaignId":{
            "title":"Parent Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the parent campaign.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignLastUpdatedBy":{
            "title":"Campaign Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the campaign record.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "MktCampaignMembers":{
            "title":"Campaign Members",
            "type":"array",
            "description":"The campaign members resource is used to view the members associated with a sales campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-MktCampaignMembers-item-response"
            }
        },
        "StatusLookupMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The display label of the status of the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfLeadsGenerated":{
            "title":"Number of Leads Generated",
            "type":"number",
            "description":"The number of leads generated for a given sales target campaign.",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignOrigin":{
            "title":"Origin",
            "maxLength":30,
            "type":"string",
            "description":"The origin of the campaign.",
            "nullable":true,
            "default":"MKT_CAMPAIGN",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CampaignAccountAttributionCriteria":{
            "title":"Campaign Account Attribution Criteria",
            "type":"array",
            "description":"The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignAccountAttributionCriteria-item-response"
            }
        },
        "SalesTargetCampaignStage":{
            "title":"Stage",
            "maxLength":32,
            "type":"string",
            "description":"The code indicating the stage of sales target campaign.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActualCost":{
            "title":"Actual Cost",
            "type":"number",
            "description":"The actual cost of the campaign.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":2
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when campaign ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemEmailId":{
            "type":"integer",
            "description":"The unique identifier of the Email in the source system.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignLastUpdateDate":{
            "title":"Campaign Last Update Date",
            "type":"string",
            "description":"The date when the campaign record was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ProductDescription":{
            "title":"Product Description",
            "maxLength":100,
            "type":"string",
            "description":"A brief description of the product of the campaign.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date when the campaign was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : キャンペーン・アカウント属性基準

タイプ: array

タイトル: Campaign Account Attribution Criteria

ソースを表示

Array of: object campaigns-CampaignAccountAttributionCriteria-item-response

{
    "title":"Campaign Account Attribution Criteria",
    "type":"array",
    "description":"The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignAccountAttributionCriteria-item-response"
    }
}

ネストされたスキーマ : キャンペーン・アカウント

タイプ: array

タイトル: Campaign Accounts

ソースを表示

Array of: object campaigns-CampaignAccounts-item-response

{
    "title":"Campaign Accounts",
    "type":"array",
    "description":"The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignAccounts-item-response"
    }
}

ネストされたスキーマ : キャンペーン製品

タイプ: array

タイトル: Campaign Products

ソースを表示

Array of: object campaigns-CampaignProducts-item-response

{
    "title":"Campaign Products",
    "type":"array",
    "description":"The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignProducts-item-response"
    }
}

ネストされたスキーマ : キャンペーン・ロールアップ

タイプ: array

タイトル: Campaign Rollups

キャンペーン・ロールアップ・リソースは、キャンペーン・ロールアップの表示に使用されます。

ソースを表示

Array of: object campaigns-CampaignRollup-item-response

{
    "title":"Campaign Rollups",
    "type":"array",
    "description":"The campaign rollup resource is used to view a campaign rollup.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignRollup-item-response"
    },
    "x-cardinality":"1"
}

ネストされたスキーマ : キャンペーン・チーム

タイプ: array

タイトル: Campaign Teams

ソースを表示

Array of: object campaigns-CampaignTeam-item-response

{
    "title":"Campaign Teams",
    "type":"array",
    "description":"The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignTeam-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

ネストされたスキーマ : キャンペーン・メンバー

タイプ: array

タイトル: Campaign Members

キャンペーン・メンバー・リソースは、営業キャンペーンに関連付けられているメンバーを表示するために使用されます。

ソースを表示

Array of: object campaigns-MktCampaignMembers-item-response

{
    "title":"Campaign Members",
    "type":"array",
    "description":"The campaign members resource is used to view the members associated with a sales campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-MktCampaignMembers-item-response"
    }
}

ネストされたスキーマ : 販売コンテンツ

タイプ: array

タイトル: Sales Contents

ソースを表示

Array of: object campaigns-SalesContents-item-response

{
    "title":"Sales Contents",
    "type":"array",
    "description":"The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-SalesContents-item-response"
    }
}

ネストされたスキーマ : スマートなアクション

タイプ: array

タイトル: Smart Actions

ソースを表示

Array of: object campaigns-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/campaigns-smartActions-item-response"
    }
}

ネストされたスキーマ : campaigns-CampaignAccountAttributionCriteria-item-response

タイプ: object

ソースを表示

CampaignAccountAttrCriteriaId: integer (int64)

タイトル: Campaign Attribution Criteria ID

キャンペーン・アカウント属性基準の一意の識別子。
CampaignAccountAttrCriteriaNumber: string

タイトル: Campaign Attribution Criteria Number

最大長: 30

アカウント属性基準の代替キー識別子。
CampaignCampaignNumber: string

タイトル: Campaign Number

読取り専用: true

最大長: 30

キャンペーン・アカウント属性基準が属するキャンペーンの一意の識別子。
CampaignId: integer (int64)

タイトル: Campaign Identifier

キャンペーン・アカウントの一意の識別子。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

キャンペーン・アカウント属性基準を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

キャンペーン・アカウント属性基準が作成された日付。
CriteriaExpression: 文字列(バイト)

タイトル: Criteria Expression

これには、UIで選択した基準の問合せ式が含まれます。
CriteriaType: string

タイトル: Criteria Type

最大長: 30

定義されている基準が包含か除外かを示します。
ExclusionCriteriaFlag: boolean

タイトル: Is Exclusion Criteria

最大長: 1

デフォルト値: false

アカウント属性基準がアカウントを除外するかどうかを示します。
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

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

タイトル: Source Object Attribute

最大長: 150

ソース・オブジェクトID値を保持する属性。
SourceObjectCode: string

タイトル: Source Object

最大長: 30

オブジェクト名の言語非依存コード。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the campaign account attribution criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign account attribution criteria was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the campaign account attribution criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignAccountAttrCriteriaNumber":{
            "title":"Campaign Attribution Criteria Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the account attribution criterion.",
            "nullable":false,
            "x-queryable":true
        },
        "ExclusionCriteriaFlag":{
            "title":"Is Exclusion Criteria",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the Account Attribution criteria is for excluding any account or not.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "CriteriaExpression":{
            "title":"Criteria Expression",
            "type":"string",
            "description":"This contains the query expression of criteria chosen on UI.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "CampaignId":{
            "title":"Campaign Identifier",
            "type":"integer",
            "description":"The unique identifier of the campaign account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Source Object",
            "maxLength":30,
            "type":"string",
            "description":"The language independent code for an object name.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignCampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign account attribution criterion belongs to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaType":{
            "title":"Criteria Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the criteria defined is inclusion or exclusion.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceObjectAttr":{
            "title":"Source Object Attribute",
            "maxLength":150,
            "type":"string",
            "description":"The attribute that holds source object Id value.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignAccountAttrCriteriaId":{
            "title":"Campaign Attribution Criteria ID",
            "type":"integer",
            "description":"The unique identifier of the campaign account attribution criterion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the campaign account attribution criteria was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

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

ネストされたスキーマ : campaigns-CampaignAccounts-item-response

タイプ: object

ソースを表示

AccountCountry: string

タイトル: Country

読取り専用: true

取引先の国。
AccountId: integer (int64)

タイトル: Campaign Account Party ID

キャンペーン・アカウントに関連付けられたアカウントの一意の識別子。
AccountIndustryClassCode: string

タイトル: Primary Industry

読取り専用: true

アカウントのプライマリ産業区分コード。
AccountName: string

タイトル: Name

読取り専用: true

最大長: 360

キャンペーン・アカウントに関連付けられているアカウント・パーティの名前。
AccountPartyNumber: string

タイトル: Registry ID

読取り専用: true

最大長: 30

キャンペーン・アカウントに関連付けられたアカウントの一意の代替識別子。
AccountState: string

タイトル: State

読取り専用: true

最大長: 60

取引先の状態。
AccountTotalEmployees: number

タイトル: Company Size

読取り専用: true

取引先の従業員の合計数。
CampaignAccountId: integer (int64)

タイトル: Campaign Account ID

キャンペーン・アカウントの一意の識別子。
CampaignAccountNumber: string

タイトル: Campaign Account Number

最大長: 30

キャンペーン・アカウントの代替キー識別子。
CampaignId: integer (int64)

タイトル: Campaign Identifier

キャンペーンの一意の識別子。
CampaignNumber: string

タイトル: Campaign Number

最大長: 30

キャンペーン・アカウントが属するキャンペーンの一意の識別子。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

キャンペーン・アカウントを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

キャンペーン・アカウントが作成された日付。
ErrorDescription: string

タイトル: Error Description

最大長: 2000

このアカウントのリード生成中に生成されたエラー・メッセージが含まれています。
LastUpdateDate: string (date-time)

タイトル: Last Updated

読取り専用: true

キャンペーン・アカウントが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

キャンペーン・アカウントを最後に更新したユーザー。
LeadId: integer (int64)

タイトル: Lead ID

キャンペーン・アカウントに関連付けられたリードの一意の識別子。
LeadName: string

タイトル: Lead Name

読取り専用: true

最大長: 250

キャンペーン取引先に関連付けられた見込み客の名前。
LeadNumber: string

タイトル: Lead Number

最大長: 30

キャンペーン・アカウントに関連付けられたリードの一意の代替識別子。
links: array Links

タイトル: Links

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

タイトル: Query Criteria Type

最大長: 10

デフォルト値: MANUAL

これは、アカウントが問合せビルダーによって追加されたか、手動で追加されたかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the campaign account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorDescription":{
            "title":"Error Description",
            "maxLength":2000,
            "type":"string",
            "description":"This contains the error message generated during lead generation of this account.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign account was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountCountry":{
            "title":"Country",
            "type":"string",
            "description":"The country of the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AccountCountryCode"
                ]
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the campaign accounts.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountId":{
            "title":"Campaign Account Party ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the campaign account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique alternate identifier of the lead associated with the campaign account.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountState":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        },
        "QueryCriteriaType":{
            "title":"Query Criteria Type",
            "maxLength":10,
            "type":"string",
            "description":"This indicates whether the account is added by query builder or manually.",
            "nullable":false,
            "default":"MANUAL",
            "x-queryable":false
        },
        "AccountIndustryClassCode":{
            "title":"Primary Industry",
            "type":"string",
            "description":"The primary industry class code for the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountPartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique alternate identifier of the account associated with the campaign account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignAccountNumber":{
            "title":"Campaign Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign account.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign Identifier",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign account belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignAccountId":{
            "title":"Campaign Account ID",
            "type":"integer",
            "description":"The unique identifier of the campaign account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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 unique identifier of the lead associated with the campaign account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeadName":{
            "title":"Lead Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the lead associated with the campaign account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date when the campaign account was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the account party associated with the campaign account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountTotalEmployees":{
            "title":"Company Size",
            "type":"number",
            "description":"The total number of employees for the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

ネストされたスキーマ : campaigns-CampaignProducts-item-response

タイプ: object

ソースを表示

CampaignId: integer (int64)

タイトル: Campaign ID

キャンペーンの一意の識別子。
CampaignNumber: string

タイトル: Campaign Number

最大長: 30

キャンペーン製品が属するキャンペーンの一意の識別子。
CampaignProductId: integer (int64)

タイトル: Campaign Product ID

キャンペーン製品の一意の識別子。
CampaignProductNumber: string

タイトル: Campaign Product Number

最大長: 30

キャンペーン製品の代替キー識別子。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

キャンペーン製品を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

キャンペーン製品が作成された日付。
InventoryItemId: integer (int64)

タイトル: Campaign Inventory Item ID

キャンペーン製品に関連付けられた一意の在庫品目識別子。
InventoryOrgId: integer (int64)

タイトル: Campaign Inventory Org ID

このキャンペーン製品に関連付けられた一意の在庫組織識別子。
ItemName: string

タイトル: Item Description

読取り専用: true

最大長: 240

製品がキャンペーンに関連付けられている製品の説明。
ItemNumber: string

タイトル: Item Number

読取り専用: true

最大長: 300

参照在庫品目の代替キー。
LastUpdateDate: string (date-time)

タイトル: Last Updated

読取り専用: true

キャンペーン製品が最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

キャンペーン製品を最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ProductGroupId: integer (int64)

タイトル: Campaign Product Group ID

製品グループの一意の識別子。
ProductGroupName: string

タイトル: Display

読取り専用: true

最大長: 250

製品グループがキャンペーンに関連付けられている製品グループの説明。
ProductGroupNumber: string

タイトル: Reference Number

最大長: 50

参照製品グループの代替キー。
ProductType: string

タイトル: Product Type

製品のタイプ(品目または製品グループなど)。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the campaign product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign product was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupId":{
            "title":"Campaign Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"CRMProductGroup"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the campaign products.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Campaign Inventory Item ID",
            "type":"integer",
            "description":"The unique inventory item identifier associated with the campaign product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"CRMProduct"
            },
            "x-queryable":true
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the product, such as item or product group.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryOrgId":{
            "title":"Campaign Inventory Org ID",
            "type":"integer",
            "description":"The unique inventory organization identifier associated with this campaign product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Display",
            "maxLength":250,
            "type":"string",
            "description":"The description of the product group where the product group is associated with the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":300,
            "type":"string",
            "description":"The alternate key for referenced inventory item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign product belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemName":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"The product description where the product is associated with the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignProductId":{
            "title":"Campaign Product ID",
            "type":"integer",
            "description":"The unique identifier of the campaign product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignProductNumber":{
            "title":"Campaign Product Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign product.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProductGroupNumber":{
            "title":"Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The alternate key for referenced product group.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date when the campaign product was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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"
    }
}

ネストされたスキーマ : campaigns-CampaignRollup-item-response

タイプ: object

ソースを表示

CampaignId: integer (int64)

タイトル: Campaign Identifier

読取り専用: true

キャンペーンの一意の識別子。
CorpCurrencyCode: string

タイトル: Corporate Currency Code

読取り専用: true

最大長: 15

キャンペーン・ロールアップの企業通貨コード。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: 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

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

タイトル: Total Converted Leads

読取り専用: true

キャンペーンに関連付けられた変換済リードの合計数。
NumberOfLeads: number

タイトル: Total Leads

読取り専用: true

キャンペーンに関連付けられたリードの合計数。
NumberOfOpenHotLeads: number

タイトル: Total Hot Open Leads

読取り専用: true

キャンペーンに関連付けられた、ホットとしてランク付けされた不適格または適格なリードの合計数。
NumberOfOpenLeads: number

タイトル: Total Open Leads

読取り専用: true

キャンペーンに関連付けられた不適格または適格なオープン・リードの合計数。
NumberOfOpenOpportunities: number

タイトル: Total Open Opportunities

読取り専用: true

キャンペーンに関連付けられたオープン商談の合計数。
NumberOfOpportunities: number

タイトル: Total Opportunities

読取り専用: true

キャンペーンに関連付けられた商談の合計数。
NumberOfWonOpportunities: number

タイトル: Total Won Opportunities

読取り専用: true

キャンペーンに関連付けられた受注済商談の合計。
SumOfAllOpportunitiesRevenue: number

タイトル: Total Revenue from Opportunities

読取り専用: true

キャンペーンに関連付けられた商談の合計売上。
SumOfOpenLeadAmount: number

タイトル: Total Revenue from Open Leads

読取り専用: true

キャンペーンに関連付けられた不適格および適格リードの合計金額。
SumOfOpenOpportunitiesRevenue: number

タイトル: Total Revenue from Open Opportunities

読取り専用: true

キャンペーンに関連付けられたオープン商談の合計売上。
SumOfWonOpportunitiesRevenue: number

タイトル: Total Revenue from Won Opportunities

読取り専用: true

キャンペーンに関連付けられた受注済商談の合計売上。

{
    "type":"object",
    "properties":{
        "NumberOfOpenLeads":{
            "title":"Total Open Leads",
            "type":"number",
            "description":"The total number of unqualified or qualified open leads associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfOpenHotLeads":{
            "title":"Total Hot Open Leads",
            "type":"number",
            "description":"The total number of unqualified or qualified leads ranked as hot that are associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SumOfWonOpportunitiesRevenue":{
            "title":"Total Revenue from Won Opportunities",
            "type":"number",
            "description":"The total revenue of the won opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SumOfOpenOpportunitiesRevenue":{
            "title":"Total Revenue from Open Opportunities",
            "type":"number",
            "description":"The total revenue of the open opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfLeads":{
            "title":"Total Leads",
            "type":"number",
            "description":"The total number of leads associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfOpportunities":{
            "title":"Total Opportunities",
            "type":"number",
            "description":"The total number of opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignId":{
            "title":"Campaign Identifier",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NumberOfOpenOpportunities":{
            "title":"Total Open Opportunities",
            "type":"number",
            "description":"The total number of open opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfWonOpportunities":{
            "title":"Total Won Opportunities",
            "type":"number",
            "description":"The total won opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SumOfOpenLeadAmount":{
            "title":"Total Revenue from Open Leads",
            "type":"number",
            "description":"The total amount of the unqualified and qualified leads associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SumOfAllOpportunitiesRevenue":{
            "title":"Total Revenue from Opportunities",
            "type":"number",
            "description":"The total revenue of opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code for campaign rollups.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfConvertedLeads":{
            "title":"Total Converted Leads",
            "type":"number",
            "description":"The total number of converted leads associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

ネストされたスキーマ : campaigns-CampaignTeam-item-response

タイプ: object

ソースを表示

AccessLevelCode: string

タイトル: Campaign Team Member Access Level Code

最大長: 30

デフォルト値: 300

チーム・メンバーのアクセス・レベルを示すコード。
ApproverFlag: boolean

タイトル: Is Approver

最大長: 1

デフォルト値: false

チーム・メンバーがキャンペーンの承認者であるかどうかを示します。
CampaignId: integer (int64)

タイトル: Campaign ID

キャンペーンの一意の識別子。
CampaignNumber: string

タイトル: Campaign Number

最大長: 30

キャンペーン・リソースが属するキャンペーンの一意の識別子。
CampaignTeamId: integer (int64)

タイトル: Campaign Team Member ID

キャンペーン・リソースの一意の識別子。
CampaignTeamNumber: string

タイトル: Campaign Team Member Number

最大長: 30

キャンペーン・リソースの代替キー識別子。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

キャンペーン・リソースを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

キャンペーン・リソースが作成された日付。
EmailAddress: string

タイトル: Primary Email

読取り専用: true

最大長: 320

キャンペーン・チーム・リソースに関連付けられたEメール・アドレス。
FormattedPhoneNumber: string

タイトル: Primary Phone

読取り専用: true

キャンペーン・リソースの書式設定された電話番号。
LastUpdateDate: string (date-time)

タイトル: Last Updated

読取り専用: true

キャンペーン・リソースが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

キャンペーン・リソースを最後に更新したユーザー。
links: array Links

タイトル: Links

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

タイトル: Campaign Team Member Function Code

最大長: 30

このキャンペーンのコンテキストにおけるリード担当者のロール。
OwnerFlag: boolean

タイトル: Owner

このリソースがこのキャンペーンのプライマリ・リソースかどうかを示します。
ResourceId: integer (int64)

タイトル: Campaign Team Member Party ID

この営業キャンペーン・リソースに関連付けられた一意の識別子。
ResourceName: string

タイトル: Name

読取り専用: true

最大長: 360

キャンペーン・リソースに関連付けられたパーティの名前。
ResourcePartyNumber: string

タイトル: Registry ID

読取り専用: true

最大長: 30

このキャンペーン・リソースに関連付けられた代替キー識別子。
RoleName: string

タイトル: Role Name

読取り専用: true

最大長: 60

営業リードに関連付けられたキャンペーン・リソースのロールの名前。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the campaign resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign resource was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the campaign resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessLevelCode":{
            "title":"Campaign Team Member Access Level Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the access level of a team member.",
            "nullable":false,
            "default":"300",
            "x-queryable":false
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party associated with the campaign resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether this resource is a primary resource for this campaign.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "CampaignTeamId":{
            "title":"Campaign Team Member ID",
            "type":"integer",
            "description":"The unique identifier of the campaign resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignTeamNumber":{
            "title":"Campaign Team Member Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign resource.",
            "nullable":false,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address associated with the campaign team resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the role of the campaign resource associated with the sales lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Campaign Team Member Party ID",
            "type":"integer",
            "description":"The unique identifier associated with this sales campaign resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign resource belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "ApproverFlag":{
            "title":"Is Approver",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the team member is approver of the campaign.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier associated with this campaign resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberFunctionCode":{
            "title":"Campaign Team Member Function Code",
            "maxLength":30,
            "type":"string",
            "description":"The role of lead contact in the context of this campaign.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The formatted phone number of the campaign resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date when the campaign resource was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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"
    }
}

ネストされたスキーマ : campaigns-MktCampaignMembers-item-response

タイプ: object

ソースを表示

Active: string

タイトル: Is Active

読取り専用: true

最大長: 1

デフォルト値: Y

キャンペーン・メンバーがアクティブかどうかを示します。
CampaignCampaignName: string

タイトル: Name

読取り専用: true

最大長: 100

キャンペーン・メンバーが属するキャンペーンの名前。
CampaignCampaignNumber: string

タイトル: Campaign Number

最大長: 30

キャンペーン・メンバーが属するキャンペーンの一意の識別子。
CampaignEndDate: string (date-time)

タイトル: End Date

読取り専用: true

マーケティング統合キャンペーンが終了する日付。
CampaignId: integer (int64)

タイトル: Campaign Identifier

キャンペーン・メンバーの一意の識別子。
CampaignMemberId: integer (int64)

タイトル: Campaign Member ID

キャンペーンの一意の識別子。
CampaignMemberNumber: string

タイトル: Campaign Member Number

最大長: 30

キャンペーン・メンバーの代替キー識別子。
CampaignStartDate: string (date-time)

タイトル: Start Date

読取り専用: true

マーケティング統合キャンペーンが開始する日付。
CampaignStatus: string

タイトル: Status

読取り専用: true

最大長: 30

デフォルト値: ORA_DRAFT

マーケティング統合キャンペーンのステータス。
CampaignType: string

タイトル: Type

読取り専用: true

最大長: 30

マーケティング統合キャンペーンのタイプ。
ContactEmail: string

タイトル: Contact Email

読取り専用: true

最大長: 320

キャンペーン・メンバーに関連付けられた担当者の電子メール・アドレス。
ContactId: integer (int64)

タイトル: Contact ID

キャンペーン・メンバーに関連付けられたパーティの一意の識別子。
ContactPartyName: string

タイトル: Contact Name

読取り専用: true

最大長: 360

キャンペーン・メンバーに関連付けられた担当者パーティの名前。
ContactPartyNumber: string

タイトル: Contact Number

読取り専用: true

最大長: 30

キャンペーン・メンバーに関連付けられた担当者の一意の代替識別子。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

キャンペーン・メンバーを作成したユーザー。
CreatedByModule: string

タイトル: Created by Module

最大長: 60

デフォルト値: ORA_WS

キャンペーン・メンバーを作成できるモジュール。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

キャンペーン・メンバーが作成された日付。
CurrencyCode: string

タイトル: Currency

最大長: 15

USDやGBPなど、キャンペーン・メンバーに関連付けられた通貨を示すコード。
DeleteFlag: boolean

タイトル: Can Be Deleted

読取り専用: true

ログイン・ユーザーがキャンペーン・メンバーを削除できるかどうかを示します。
EmailAddress: string

タイトル: Email

最大長: 320

キャンペーン・メンバーの電子メール・アドレス。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

キャンペーン・メンバーが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

キャンペーン・メンバーを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

キャンペーン・メンバーを最後に更新したユーザーのログイン。
LeadAccountName: string

タイトル: Lead Account

読取り専用: true

最大長: 360

キャンペーン・メンバーに関連付けられた見込み客の取引先名。
LeadEmail: string

タイトル: Lead Email

読取り専用: true

最大長: 320

キャンペーン・メンバーに関連付けられたリードのEメール・アドレス。
LeadId: integer (int64)

タイトル: Lead ID

キャンペーン・メンバーに関連付けられたリードの一意の識別子。
LeadLeadName: string

タイトル: Lead Name

読取り専用: true

最大長: 250

キャンペーン・メンバーに関連付けられている見込み客の名前。
LeadLeadNumber: string

タイトル: Lead Number

最大長: 30

キャンペーン・メンバーに関連付けられたリードの一意の代替識別子。
LeadOwnerName: string

タイトル: Lead Owner

読取り専用: true

最大長: 360

キャンペーン・メンバーに関連付けられたリードの所有者名。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
MemberResponseDate: string (date-time)

タイトル: Response Date

キャンペーン・メンバーのレスポンスを受信した日付。
MemberStatus: string

タイトル: Member Status

最大長: 30

デフォルト値: ORA_SENT

キャンペーン・メンバーのステータス。
MemberStatusLookupMeaning: string

タイトル: Member Status

読取り専用: true

最大長: 80

キャンペーン・メンバーのステータスに対する表示ラベル。
SourceSystemCampMemberId: string

タイトル: Source System Campaign Member ID

最大長: 100

ソース・システム内のキャンペーン・メンバーの一意の識別子。
UpdateFlag: boolean

タイトル: Can Be Updated

読取り専用: true

ログイン・ユーザーがキャンペーン・メンバーを更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "SourceSystemCampMemberId":{
            "title":"Source System Campaign Member ID",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the campaign member in the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadLeadName":{
            "title":"Lead Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the lead associated with the campaign member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of marketing integration campaign.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LeadEmail":{
            "title":"Lead Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the lead associated with the campaign member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "LeadAccountName":{
            "title":"Lead Account",
            "maxLength":360,
            "type":"string",
            "description":"The account name of the lead associated with the campaign member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with the campaign member.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"contacts"
            },
            "x-queryable":true
        },
        "MemberResponseDate":{
            "title":"Response Date",
            "type":"string",
            "description":"The date when the response is received for the campaign member.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ContactPartyName":{
            "title":"Contact Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the contact party associated with the campaign member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the currency associated with the campaign member, such as USD or GBP.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Can Be Updated",
            "type":"boolean",
            "description":"Indicates whether the campaign member can be updated by the logged in user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LeadOwnerName":{
            "title":"Lead Owner",
            "maxLength":360,
            "type":"string",
            "description":"The owner name of the lead associated with the campaign member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign Identifier",
            "type":"integer",
            "description":"The unique identifier of the campaign member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignCampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign member belongs to.",
            "nullable":false,
            "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 unique identifier of the lead associated with the campaign member.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"leads"
            },
            "x-queryable":true
        },
        "LeadLeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique alternate identifier of the lead associated with the campaign member.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedByModule":{
            "title":"Created by Module",
            "maxLength":60,
            "type":"string",
            "description":"The module through which the campaign member can be created.",
            "nullable":false,
            "default":"ORA_WS",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CampaignType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of marketing integration campaign.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the campaign member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignMemberId":{
            "title":"Campaign Member ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the campaign member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when marketing integration campaign starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Be Deleted",
            "type":"boolean",
            "description":"Indicates whether the campaign member can be deleted by the logged in user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the campaign member.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique alternate identifier of the contact associated with the campaign member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Active":{
            "title":"Is Active",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the campaign member is active or not.",
            "nullable":false,
            "readOnly":true,
            "default":"Y",
            "x-queryable":true
        },
        "CampaignMemberNumber":{
            "title":"Campaign Member Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign member.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when marketing integration campaign ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactEmail":{
            "title":"Contact Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the contact associated with the campaign member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "MemberStatusLookupMeaning":{
            "title":"Member Status",
            "maxLength":80,
            "type":"string",
            "description":"The display label for the status of the campaign member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignCampaignName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the campaign to which the campaign member belongs to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberStatus":{
            "title":"Member Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the campaign member.",
            "nullable":true,
            "default":"ORA_SENT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the campaign member was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the campaign member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

ネストされたスキーマ : campaigns-SalesContents-item-response

タイプ: object

ソースを表示

CanDelete: string

読取り専用: true

デフォルト値: Y

ユーザーがコンテンツ・アイテムを削除できるかどうかを示します。
CanUpdate: string

読取り専用: true

デフォルト値: Y

ユーザーがコンテンツ・アイテムを更新できるかどうかを示します。
ContentItemId: string

タイトル: Content ID

最大長: 64

ソース・システムからの内部コンテンツ・アイテム識別子。
ContentItemName: string

タイトル: Content Name

最大長: 4000

販売コンテンツ・アイテムの名前。
ContentItemType: string

読取り専用: true

コンテンツのタイプを示します。たとえば、pdf、pngなどです。
ContentSourceSystem: string

最大長: 50

デフォルト値: OCE

コンテンツ・アイテムのソース元を示します。
DeletedInSourceFlag: boolean

タイトル: Content Deleted in Source

最大長: 1

デフォルト値: false

参照販売コンテンツ・アイテムがソース・システムで削除されるかどうかを示します。
DisplaySequence: 整数(int32)

タイトル: Display Sequence

販売コンテンツがページに表示される順序を示します。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ParentObjectId: integer (int64)

タイトル: Parent Object ID

販売コンテンツ行に関連付けられたオブジェクトの一意の識別子。
ParentObjectType: string

最大長: 128

販売コンテンツ行に関連付けられた親オブジェクト・タイプ。たとえば、アカウント、担当者、リードなどです。
PublicContentItemId: string

タイトル: Public Content ID

最大長: 64

ソース・システムからの公開コンテンツ・アイテム識別子。
PublicContentItemName: string

タイトル: Public Content Name

最大長: 4000

公開販売コンテンツ・アイテムの名前。
PublicCustomerName: string

タイトル: Customer Name

最大長: 4000

公開コンテンツが公開された顧客の名前。
PublicPublishedDate: string (date-time)

タイトル: Publish Date

公開コンテンツ・アイテムが公開された日付。
PublicStoryLink: string

タイトル: Public URL

最大長: 4000

公開コンテンツ・アイテムのリンク。
SalesContentId: integer (int64)

タイトル: Sales Content ID

読取り専用: true

販売コンテンツの一意の識別子。

{
    "type":"object",
    "properties":{
        "ContentSourceSystem":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates from where the content item is sourced.",
            "nullable":true,
            "default":"OCE",
            "x-queryable":true
        },
        "ContentItemName":{
            "title":"Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the sales content item.",
            "nullable":false,
            "x-queryable":true
        },
        "PublicCustomerName":{
            "title":"Customer Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the customer for which the public content was published.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Indicates the sequence in which the sales content should appear in a page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CanDelete":{
            "type":"string",
            "description":"Indicates whether user can delete the content item or not.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PublicContentItemId":{
            "title":"Public Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The public content item identifier from the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesContentId":{
            "title":"Sales Content ID",
            "type":"integer",
            "description":"The unique identifier of the sales content.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentObjectType":{
            "maxLength":128,
            "type":"string",
            "description":"The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "ContentItemId":{
            "title":"Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The internal content item identifier from the source system.",
            "nullable":false,
            "x-queryable":true
        },
        "CanUpdate":{
            "type":"string",
            "description":"Indicates whether user can update the content item or not.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PublicPublishedDate":{
            "title":"Publish Date",
            "type":"string",
            "description":"The date on which the public content item was published.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PublicStoryLink":{
            "title":"Public URL",
            "maxLength":4000,
            "type":"string",
            "description":"The link of the public content item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PublicContentItemName":{
            "title":"Public Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the public sales content item.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentItemType":{
            "type":"string",
            "description":"Indicates the type of content, for example pdf, png, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ParentObjectId":{
            "title":"Parent Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated to the sales content row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeletedInSourceFlag":{
            "title":"Content Deleted in Source",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether referred sales content item is deleted in source system.",
            "nullable":true,
            "default":false,
            "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"
    }
}

ネストされたスキーマ : campaigns-smartActions-item-response

タイプ: object

ソースを表示

ActionIntent: 文字列(バイト)

タイトル: Action Intent

アクションの実行内容、およびアクションに渡すことができるコンテキスト・データを記述するJSONオブジェクト。
ConfirmationMessage: string

タイトル: Confirmation Message

最大長: 1024

実行中のアクションの確認を求めるメッセージ。
ContentType: string

タイトル: Content Type

最大長: 50

RESTエンドポイントの呼出し時に使用するコンテンツ・タイプ。
DisplayLabel: string

タイトル: Action Name

最大長: 256

コンシューマ・フレンドリなアクション名。
Entity: string

タイトル: Parent Entity

最大長: 150

アクションが属するRESTリソース。
Href: string

タイトル: REST Endpoint

最大長: 150

アクションを実行するRESTエンドポイント。
IncludedInApplication: string

タイトル: Included in Application

最大長: 512

このアクションを使用できるアプリケーションのリスト。
links: array Links

タイトル: Links

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

タイトル: HTTP Method

最大長: 15

スマート・アクションREST操作のHTTPメソッド。
ObjectFunctionName: string

タイトル: Object Function

最大長: 64

スマート・アクションに関連付けられたオブジェクト関数。
PageType: string

タイトル: Page Type

最大長: 256

このアクションを使用できるページのリスト。
SmartSuggestFlag: boolean

タイトル: Smart Suggest

最大長: 1

処理に対してスマート提案が使用可能かどうかを示します。
SystemActionFlag: boolean

タイトル: System Action

最大長: 1

処理がシード済かカスタムかを示します。
UpdateOfAttributes: string

タイトル: Attributes to Update

最大長: 512

処理UIの起動時に更新される属性。
UserActionId: integer (int64)

タイトル: User Action ID

スマート処理定義の一意のシステム割当識別子。
UserActionName: string

タイトル: Action Name

最大長: 256

名前を持つ処理を一意に識別します。内部使用。
UserActionNavigation: array Smart Action User Interface Definitions

タイトル: Smart Action User Interface Definitions

ユーザー・インタフェース定義リソースは、スマート処理に関連付けられたユーザー・インタフェースを表示するために使用されます。各ユーザー・インタフェースをクライアント・アプリケーションにマッピングできます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
UserActionRank: integer (int64)

タイトル: Priority

処理の優先度を示す番号。
UserActionRequestPayload: array Smart Action REST Payload Definitions

タイトル: Smart Action REST Payload Definitions

ペイロード定義リソースは、スマート・アクションのRESTリクエスト・ペイロードの名前と値のペア定義を表示するために使用されます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
UserActionURLBinding: array Smart Action REST Path Parameter Definitions

タイトル: Smart Action REST Path Parameter Definitions

パス・パラメータ定義リソースは、スマート・アクションのRESTリクエスト・パス・パラメータの名前と値のペア定義を表示するために使用されます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The REST Resources the Action belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action REST Path Parameter Definitions",
            "type":"array",
            "description":"The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/campaigns-smartActions-UserActionURLBinding-item-response"
            }
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The list of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/campaigns-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":150,
            "type":"string",
            "description":"The REST endpoint to perform the Action.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The consumer friendly Action Name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Uniquely identifies the Action with name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique system assigned identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":1024,
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/campaigns-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":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"
    }
}

ネストされたスキーマ : スマート処理ユーザー・インタフェース定義

タイプ: array

タイトル: Smart Action User Interface Definitions

ユーザー・インタフェース定義リソースは、スマート処理に関連付けられたユーザー・インタフェースを表示するために使用されます。各ユーザー・インタフェースをクライアント・アプリケーションにマッピングできます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。

ソースを表示

Array of: object campaigns-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/campaigns-smartActions-UserActionNavigation-item-response"
    }
}

ネストされたスキーマ : スマート・アクションのRESTペイロード定義

タイプ: array

タイトル: Smart Action REST Payload Definitions

ペイロード定義リソースは、スマート・アクションのRESTリクエスト・ペイロードの名前と値のペア定義を表示するために使用されます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。

ソースを表示

Array of: object campaigns-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/campaigns-smartActions-UserActionRequestPayload-item-response"
    }
}

ネストされたスキーマ : スマート処理RESTパス・パラメータ定義

タイプ: array

タイトル: Smart Action REST Path Parameter Definitions

パス・パラメータ定義リソースは、スマート・アクションのRESTリクエスト・パス・パラメータの名前と値のペア定義を表示するために使用されます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。

ソースを表示

Array of: object campaigns-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action REST Path Parameter Definitions",
    "type":"array",
    "description":"The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/campaigns-smartActions-UserActionURLBinding-item-response"
    }
}

ネストされたスキーマ : campaigns-smartActions-UserActionNavigation-item-response

タイプ: object

ソースを表示

links: array Links

タイトル: Links

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

タイトル: System Action

最大長: 1

デフォルト値: false

スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。値は、smartActions.SystemActionFlagから自動的に導出されます。
UserActionNavAppUsage: string

タイトル: Application Usage

最大長: 50

UserActionNavIdで識別されるスマート・アクション・ユーザー・インタフェース・エンドポイント定義に関連付けられたクライアント・アプリケーション。
UserActionNavBody: string

タイトル: Navigation Metadata

最大長: 1000

スマート・アクションのユーザー・インタフェース・エンドポイントのメタデータ定義。
UserActionNavId: integer (int64)

タイトル: Primary Key

スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。値は、smartActions.SystemActionFlagから自動的に導出されます。
UserActionNavType: string

タイトル: Navigation Type

最大長: 100

起動するユーザー・インタフェースを決定するためにアプリケーションで使用されるテキスト値。

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "nullable":false,
            "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"
    }
}

ネストされたスキーマ : campaigns-smartActions-UserActionRequestPayload-item-response

タイプ: object

ソースを表示

Binding: string

タイトル: Payload Value Binding Type

最大長: 64

名前と値のペアの値プロパティの分類。バインディング値RUNTIMEは、割り当てられる値がオブジェクト属性の実行時値であることを示します。値STATICは、割り当てられる値が単純な文字列であることを示します。 NULL値は、値タイプがJSON_ARRAY_STRINGであることを示します。
links: array Links

タイトル: Links

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

タイトル: Mandatory

最大長: 1

RESTペイロード本文のパラメータ値が必須かどうかを示します。 Trueの場合、ランタイム検証によって値が確実に定義されます。
RequestPayloadId: integer (int64)

スマート・アクションRESTペイロード本文パラメータの名前と値のペア定義の一意のシステム割当識別子。
RequestPayloadName: string

タイトル: Request Payload Attribute Name

最大長: 256

名前と値のペアの名前プロパティに割り当てられた値。
SmartSuggestPath: string

タイトル: Smart Suggest Path

最大長: 2048

スマート候補に使用されるパス。
SystemActionFlag: boolean

タイトル: System Action

最大長: 1

デフォルト値: false

スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。値は、smartActions.SystemActionFlagから自動的に導出されます。
Value: string

タイトル: Request Payload Attribute Value

最大長: 250

名前と値のペアの値プロパティに割り当てられた値。
ValueStruct: string

タイトル: Payload Value Structure

最大長: 20

値JSON_ARRAY_STRINGは、名前と値のペアの値プロパティが、オブジェクト属性名や単純なテキスト文字列などの単一エンティティではなく、データの配列を表すことを示します。配列文字列は、名前と値のペア、およびバインディングと必須プロパティの定義です。配列文字列は、[{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]などの特定のパターンに従います。 null値は、値プロパティが、オブジェクト属性名や単純なテキスト文字列などの単純な単一エンティティを表すことを示します。

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":250,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "nullable":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"
    }
}

ネストされたスキーマ : campaigns-smartActions-UserActionURLBinding-item-response

タイプ: object

ソースを表示

Binding: string

タイトル: URL Binding Type

最大長: 64

名前と値のペアの値プロパティの分類。 UserActionURLBindingインスタンスのバインディング値は、RUNTIMEである必要があります。バインディング値RUNTIMEは、割り当てられる値がオブジェクト属性の実行時値であることを示します。
links: array Links

タイトル: Links

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

タイトル: System Action

最大長: 1

デフォルト値: false

スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。値は、smartActions.SystemActionFlagから自動的に導出されます。
URLBindingId: integer (int64)

スマート・アクションRESTパス・パラメータの名前と値のペア定義の一意のシステム割当識別子。
URLBindingName: string

タイトル: URL Binding Parameter Name

最大長: 50

名前と値のペアの名前プロパティに割り当てられた値。
Value: string

タイトル: URL Binding Parameter Value

最大長: 80

名前と値のペアの値プロパティに割り当てられた値。

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":80,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST path parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":50,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "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"
    }
}

リンク

CampaignAccountAttributionCriteria

操作: /crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccountAttributionCriteria

パラメータ: