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

機械翻訳について

アウトバウンド・メッセージ・パートの作成

post

/crmRestApi/resources/11.13.18.05/outboundMessages/{OutboundMessageId}/child/OutboundMsgParts

リクエスト

パス・パラメータ

OutboundMessageId(required): integer(int64)

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=

ヘッダー・パラメータ

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

ソースを表示

CorpCurrencyCode: string

タイトル: Corporate Currency Code

最大長: 15

メッセージ・パートに関連付けられた企業通貨コード。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CurcyConvRateType: string

タイトル: Type of Currency Conversion Rate

最大長: 30

メッセージ・パートの通貨換算レート・タイプ。有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CurrencyCode: string

タイトル: Currency Code

最大長: 15

メッセージ・パートに関連付けられた通貨コード。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
OutboundMessageId: integer (int64)

タイトル: Outbound Message ID

アウトバウンド・メッセージ詳細の一意の識別子。
OutboundMsgPartId: integer (int64)

タイトル: Outbound Message Part ID

アウトバウンド・メッセージ詳細の一意の部分識別子。
PartName: string

タイトル: Part Name

最大長: 64

アウトバウンド・メッセージ詳細のパート名。
PartTypeCd: string

タイトル: Part Type Code

最大長: 30

アウトバウンド・メッセージ詳細のパート・タイプ。
PartValue: string

タイトル: Part Value

最大長: 2000

アウトバウンド・メッセージ詳細のパート値。

{
    "type":"object",
    "properties":{
        "PartTypeCd":{
            "title":"Part Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The part type of the outbound message details.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true
        },
        "OutboundMsgPartId":{
            "title":"Outbound Message Part ID",
            "type":"integer",
            "description":"The unique part identifier of the outbound message detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartName":{
            "title":"Part Name",
            "maxLength":64,
            "type":"string",
            "description":"The part name of the outbound message detail.",
            "nullable":true
        },
        "PartValue":{
            "title":"Part Value",
            "maxLength":2000,
            "type":"string",
            "description":"The part value of the outbound message details.",
            "nullable":true
        },
        "OutboundMessageId":{
            "title":"Outbound Message ID",
            "type":"integer",
            "description":"The unique identifier of the outbound message detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CurcyConvRateType":{
            "title":"Type of Currency Conversion Rate",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type for the message part. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : outboundMessages-OutboundMsgParts-item-response

タイプ: object

ソースを表示

CorpCurrencyCode: string

タイトル: Corporate Currency Code

最大長: 15

メッセージ・パートに関連付けられた企業通貨コード。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

アウトバウンド・メッセージ受信者を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

アウトバウンド・メッセージが作成された日付。
CurcyConvRateType: string

タイトル: Type of Currency Conversion Rate

最大長: 30

メッセージ・パートの通貨換算レート・タイプ。有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CurrencyCode: string

タイトル: Currency Code

最大長: 15

メッセージ・パートに関連付けられた通貨コード。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
DeleteFlag: boolean

タイトル: Can Delete Message Part

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

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

タイトル: Outbound Message ID

アウトバウンド・メッセージ詳細の一意の識別子。
OutboundMsgPartId: integer (int64)

タイトル: Outbound Message Part ID

アウトバウンド・メッセージ詳細の一意の部分識別子。
PartName: string

タイトル: Part Name

最大長: 64

アウトバウンド・メッセージ詳細のパート名。
PartTypeCd: string

タイトル: Part Type Code

最大長: 30

アウトバウンド・メッセージ詳細のパート・タイプ。
PartValue: string

タイトル: Part Value

最大長: 2000

アウトバウンド・メッセージ詳細のパート値。
UpdateFlag: boolean

タイトル: Can Update Message Part

読取り専用: true

アウトバウンド・メッセージを更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The login of the user who last updated the outbound message detail.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartTypeCd":{
            "title":"Part Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The part type of the outbound message details.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the outbound message 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 outbound message recipient.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartValue":{
            "title":"Part Value",
            "maxLength":2000,
            "type":"string",
            "description":"The part value of the outbound message details.",
            "nullable":true,
            "x-queryable":true
        },
        "OutboundMessageId":{
            "title":"Outbound Message ID",
            "type":"integer",
            "description":"The unique identifier of the outbound message detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Type of Currency Conversion Rate",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type for the message part. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete Message Part",
            "type":"boolean",
            "description":"Indicates whether the outbound message is deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update Message Part",
            "type":"boolean",
            "description":"Indicates whether the outbound message can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OutboundMsgPartId":{
            "title":"Outbound Message Part ID",
            "type":"integer",
            "description":"The unique part identifier of the outbound message detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartName":{
            "title":"Part Name",
            "maxLength":64,
            "type":"string",
            "description":"The part name of the outbound message detail.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the message part. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the outbound message detail 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 outbound message detail.",
            "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."
        }
    }
}

リンク

PartTypeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_OBM_PART_TYPE

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

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

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行することによって、アウトバウンド・メッセージ部分を作成する方法を示しています。

cURLコマンド

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/outboundMessages/300100188082127/child/OutboundMsgParts

リクエスト本文の例

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

{
      "PartTypeCd": "ORA_SVC_TO",
      "PartName": "To",
      "PartValue": "rakesh.ambat@oracle.com"
    }

レスポンス本文の例

次に、JSON形式のレスポンス本文の内容を示します。

{
  "OutboundMsgPartId": 300100188188021,
  "OutboundMessageId": 300100188082127,
  "PartTypeCd": "ORA_SVC_TO",
  "PartName": "To",
  "PartValue": "rakesh.ambat@oracle.com",
  "CreationDate": "2020-08-07T07:59:46.128+00:00",
  "CreatedBy": "SALES_ADMIN",
  "LastUpdateDate": "2020-08-07T07:59:46.129+00:00",
  "LastUpdatedBy": "SALES_ADMIN",
  "LastUpdateLogin": "AB8E970B07897281E0531C5CF00A88E5",
  "DeleteFlag": true,
  "UpdateFlag": true,
  "CorpCurrencyCode": null,
  "CurcyConvRateType": null,
  "CurrencyCode": null,
  ...
}

「トップに戻る」