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

機械翻訳について

ビジネス・プラン・ノートの作成

post

/crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note

リクエスト

パス・パラメータ

BusinessPlanId(required): integer(int64)

ビジネス・プランの一意の識別子。

ヘッダー・パラメータ

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

ソースを表示

ContactRelationshipId: integer (int64)

タイトル: Contact Relationship ID

リレーションの一意の識別子。この値は、ノートが担当者に関連付けられているときに移入されます。
CorpCurrencyCode: string

タイトル: Corporate Currency Code

最大長: 15

担当者に関連付けられたノートの企業通貨コード。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
CreatorPartyId: integer (int64)

タイトル: Creator Party ID

ノート作成者のパーティの一意の識別子。
CurcyConvRateType: string

タイトル: Currency Conversion Rate Type

最大長: 30

ノートに関連付けられた通貨換算レート・タイプ。受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。
CurrencyCode: string

タイトル: Currency

最大長: 15

ノートに関連付けられた通貨コード。受け入れられる値のリストは、参照RatedCurrenciesVAで定義されます。
NoteNumber: string

最大長: 30

ノートの代替一意識別子。システム生成または外部システムからのユーザー・キー。
NoteTitle: string

タイトル: Title

最大長: 500

ユーザーが入力したノートのタイトル。
NoteTxt: 文字列(バイト)

タイトル: Note

実際のノートのテキスト。
NoteTypeCode: string

タイトル: Type

最大長: 30

これは、ノートを分類するためのノート・タイプ・コードです。有効な値のリストは、参照NoteSourceTypeVAで定義されます。
ParentNoteId: integer (int64)

タイトル: Parent Note ID

親ノートの一意の識別子。
SourceObjectCode: string

タイトル: Related Object Type

最大長: 30

OBJECTS Metadataで定義されたソース・オブジェクトを示すコード(アクティビティ、商談、販売ビジネス・プランなど)。
SourceObjectId: string

タイトル: Related Object

最大長: 64

OBJECTS Metadataで定義されたソース・オブジェクトの主キー識別子(アクティビティ、商談、販売ビジネス・プランなど)。
VisibilityCode: string

タイトル: Private

最大長: 30

デフォルト値: INTERNAL

これは、ノートの表示レベルを指定するための属性です。有効な値のリストは、参照NoteVisibilityLookupVAで定義されます。

{
    "type":"object",
    "properties":{
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the note creator's party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"This is the note type code for categorization of note. A list of valid values is defined in the lookup NoteSourceTypeVA.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"This is the attribute to specify the visibility level of the note. A list of valid values is defined in the lookup NoteVisibilityLookupVA.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationshi, this value is populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the note. A list of accepted values is defined in the lookup RatedCurrenciesVA.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NoteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"The primary key identifier of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan.",
            "nullable":false
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan.",
            "nullable":false
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            }
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : businessPlans-Note-item-response

タイプ: object

ソースを表示

ContactRelationshipId: integer (int64)

タイトル: Contact Relationship ID

リレーションの一意の識別子。この値は、ノートが担当者に関連付けられているときに移入されます。
CorpCurrencyCode: string

タイトル: Corporate Currency Code

最大長: 15

担当者に関連付けられたノートの企業通貨コード。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
CreatorPartyId: integer (int64)

タイトル: Creator Party ID

ノート作成者のパーティの一意の識別子。
CurcyConvRateType: string

タイトル: Currency Conversion Rate Type

最大長: 30

ノートに関連付けられた通貨換算レート・タイプ。受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。
CurrencyCode: string

タイトル: Currency

最大長: 15

ノートに関連付けられた通貨コード。受け入れられる値のリストは、参照RatedCurrenciesVAで定義されます。
DeleteFlag: boolean

タイトル: Delete Indicator

読取り専用: true

ビジネス・プラン・ノートを削除できるかどうかを示します。デフォルト値はtrueです。
EmailAddress: string

タイトル: Primary Email

読取り専用: true

最大長: 320

ノートを作成したユーザーの電子メール・アドレス。
FormattedAddress: string

タイトル: Primary Address

読取り専用: true

ノートを作成したユーザーの住所。
FormattedPhoneNumber: string

タイトル: Primary Phone

読取り専用: true

ノートを作成したユーザーの電話番号。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Note ID

読取り専用: true

ビジネス・プランのノートの一意の識別子。
NoteNumber: string

最大長: 30

ノートの代替一意識別子。システム生成または外部システムからのユーザー・キー。
NoteTitle: string

タイトル: Title

最大長: 500

ユーザーが入力したノートのタイトル。
NoteTxt: 文字列(バイト)

タイトル: Note

実際のノートのテキスト。
NoteTypeCode: string

タイトル: Type

最大長: 30

これは、ノートを分類するためのノート・タイプ・コードです。有効な値のリストは、参照NoteSourceTypeVAで定義されます。
ParentNoteId: integer (int64)

タイトル: Parent Note ID

親ノートの一意の識別子。
PartyId: integer (int64)

タイトル: Party ID

読取り専用: true

ノートが関連付けられている担当者の一意の識別子。この場合、CreatorPartyIdと同じです。
PartyName: string

タイトル: Author

読取り専用: true

最大長: 360

ビジネス・プランに関連付けられているパーティの名前。
SourceObjectCode: string

タイトル: Related Object Type

最大長: 30

OBJECTS Metadataで定義されたソース・オブジェクトを示すコード(アクティビティ、商談、販売ビジネス・プランなど)。
SourceObjectId: string

タイトル: Related Object

最大長: 64

OBJECTS Metadataで定義されたソース・オブジェクトの主キー識別子(アクティビティ、商談、販売ビジネス・プランなど)。
UpdateFlag: boolean

タイトル: Update Indicator

読取り専用: true

ビジネス・プラン・ノートを更新できるかどうかを示します。デフォルト値はtrueです。
VisibilityCode: string

タイトル: Private

最大長: 30

デフォルト値: INTERNAL

これは、ノートの表示レベルを指定するための属性です。有効な値のリストは、参照NoteVisibilityLookupVAで定義されます。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":360,
            "type":"string",
            "description":"The name of party associated with the business plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"This is the attribute to specify the visibility level of the note. A list of valid values is defined in the lookup NoteVisibilityLookupVA.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationshi, this value is populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the note. A list of accepted values is defined in the lookup RatedCurrenciesVA.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the business plan note can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan.",
            "nullable":false,
            "x-queryable":true
        },
        "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 phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the note for the business plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the note creator's party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"The address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"This is the note type code for categorization of note. A list of valid values is defined in the lookup NoteSourceTypeVA.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the business plan note can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"The primary key identifier of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique Identifier of the contact with whom the note is associated. In this case, same as CreatorPartyId.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record 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":true,
            "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."
        }
    }
}

リンク

NoteSourceTypeVA

操作: /crmRestApi/resources/11.13.18.05/noteTypes

パラメータ:

ファインダ: NoteTypeFinder%3BBindSourceObjectCode%3D{SourceObjectCode}

一般や公式など、ノート・タイプのカテゴリ化のコードの値リスト。

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

ソース属性: NoteTypeCode;ターゲット属性: MappedLookupCode
表示属性: 意味

NoteVisibilityLookupVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeFinder%3BBindLookupType%3DZMM_NOTE_VISIBILITY

外部や内部など、ノートの表示レベルの値リスト。

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

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

RatedCurrenciesVA

操作: /crmRestApi/resources/11.13.18.05/ratedCurrencies

USドルやインド・ルピーなど、ノートに関連付けられた通貨換算レート・タイプの値リスト。

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

ソース属性: CurrencyCode;ターゲット属性: CurrencyCode
表示属性: CurrencyCode

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行して、ビジネス・プラン・ノートを作成する方法を示しています。

cURLコマンド

- curl -u <username:password> \ -X http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/businessPlans/300100091979253/child/Note

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
"VisibilityCode": "INTERNAL",
"NoteTypeCode": "GENERAL",
"NoteTxt": "This Business Plan is"
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
"NoteId": 300100091979264,
"SourceObjectCode": "SALES_BUSINESS_PLAN",
"SourceObjectId": "300100091979253",
"PartyName": "Matt Hooper",
"NoteTypeCode": "GENERAL",
"VisibilityCode": "INTERNAL",
"CreatorPartyId": 100010037456865,
"CreatedBy": "MHoope",
"CreationDate": "2016-12-12T03:44:33-08:00",
"LastUpdateDate": "2016-12-12T03:44:33-08:00",
"PartyId": 100010037456865,
"CorpCurrencyCode": "USD",
"CurcyConvRateType": "Corporate",
"CurrencyCode": "USD",
"ContactRelationshipId": null,
"ParentNoteId": null,
"LastUpdatedBy": "MHoope",
"LastUpdateLogin": "4373F6AF02325539E05364C0F20A8DA6",
...
}

「トップに戻る」