機械翻訳について

ジャンプ先

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

キャンペーン製品の作成

post

/crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignProducts

リクエスト

パス・パラメータ

• CampaignNumber(required): string
  キャンペーンの代替キー識別子。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

リクエスト本文 - application/json ()

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

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

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

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

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

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

リンク

ProductTypeVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

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

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

「トップに戻る」