機械翻訳について

ジャンプ先

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

キャンペーン・リソースの作成

post

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

リクエスト

パス・パラメータ

• 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

ソースを表示

• 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
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

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

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

リンク

AccessLevelCodeVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

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

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

MemberFunctionCodeVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

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

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

「トップに戻る」