機械翻訳について

ジャンプ先

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

キャンペーン・アカウントの取得

get

/crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccounts/{CampaignAccountsUniqID}

リクエスト

パス・パラメータ

• CampaignAccountsUniqID(required): string
  これは、キャンペーン・アカウント・リソースの複合キーを構成し、キャンペーン・アカウントのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するためにキャンペーン・アカウントの特定のインスタンスに移動するために、キャンペーン・アカウント・コレクション・リソースを問い合せる必要があります。
• CampaignNumber(required): string
  キャンペーンの代替キー識別子。

問合せパラメータ

• dependency: string
  このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
  
  フォーマット: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

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

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

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : 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"
    }
}

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

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

リンク

QueryCriteriaTypeVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_CAMP_ACNTS_ADD_TYPE

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: QueryCriteriaType;ターゲット属性: LookupCode
• 表示属性: 意味

「トップに戻る」