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

機械翻訳について

インバウンド・メッセージ・パートの更新

patch

/crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts/{InboundMsgPartId}

リクエスト

パス・パラメータ

InboundMessageId(required): integer(int64)

インバウンド・メッセージの一意の識別子。
InboundMsgPartId(required): integer(int64)

メッセージ・パートの一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

InboundMessageId: integer (int64)

タイトル: Inbound Message ID

メッセージ・パートが関連付けられているインバウンド・メッセージの一意の識別子。
InboundMsgPartId: integer (int64)

タイトル: Inbound Message Part ID

メッセージ・パートの一意の識別子。
PartName: string

タイトル: Part Name

最大長: 64

インバウンド・メッセージ部分のヘッダー名。
PartTypeCd: string

タイトル: Part Type Code

最大長: 30

インバウンド・メッセージ部分のタイプ。
PartTypeCdMeaning: string

タイトル: Part Type Value

最大長: 255

インバウンド・メッセージの部品タイプ参照コードに対応する表示値。
PartValue: string

タイトル: Part Value

最大長: 2000

インバウンド・メッセージ部分の値。

{
    "type":"object",
    "properties":{
        "InboundMessageId":{
            "title":"Inbound Message ID",
            "type":"integer",
            "description":"The unique identifier of the inbound message with which the message part is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartTypeCd":{
            "title":"Part Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of the inbound message part.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartTypeCdMeaning":{
            "title":"Part Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the part type lookup code for the inbound message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartTypeCd"
                ]
            }
        },
        "PartName":{
            "title":"Part Name",
            "maxLength":64,
            "type":"string",
            "description":"The header name of the inbound message part.",
            "nullable":true
        },
        "PartValue":{
            "title":"Part Value",
            "maxLength":2000,
            "type":"string",
            "description":"The value of the inbound message part.",
            "nullable":true
        },
        "InboundMsgPartId":{
            "title":"Inbound Message Part ID",
            "type":"integer",
            "description":"The unique identifier of the message part.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : inboundMessages-InboundMsgParts-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

インバウンド・メッセージ・パートが作成された日付。
DeleteFlag: boolean

タイトル: Can Delete

読取り専用: true

インバウンド・メッセージ・パートを削除できるかどうかを示します。
InboundMessageId: integer (int64)

タイトル: Inbound Message ID

メッセージ・パートが関連付けられているインバウンド・メッセージの一意の識別子。
InboundMsgPartId: integer (int64)

タイトル: Inbound Message Part ID

メッセージ・パートの一意の識別子。
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

リソース・インスタンスに関連付けられたリンク関係。
PartName: string

タイトル: Part Name

最大長: 64

インバウンド・メッセージ部分のヘッダー名。
PartTypeCd: string

タイトル: Part Type Code

最大長: 30

インバウンド・メッセージ部分のタイプ。
PartTypeCdMeaning: string

タイトル: Part Type Value

最大長: 255

インバウンド・メッセージの部品タイプ参照コードに対応する表示値。
PartValue: string

タイトル: Part Value

最大長: 2000

インバウンド・メッセージ部分の値。
UpdateFlag: boolean

タイトル: Can Update

読取り専用: true

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the inbound message part.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartTypeCd":{
            "title":"Part Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of the inbound message part.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the inbound message part was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartTypeCdMeaning":{
            "title":"Part Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the part type lookup code for the inbound message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartTypeCd"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the inbound message part.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartValue":{
            "title":"Part Value",
            "maxLength":2000,
            "type":"string",
            "description":"The value of the inbound message part.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the inbound message part can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InboundMessageId":{
            "title":"Inbound Message ID",
            "type":"integer",
            "description":"The unique identifier of the inbound message with which the message part is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the inbound message part can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartName":{
            "title":"Part Name",
            "maxLength":64,
            "type":"string",
            "description":"The header name of the inbound message part.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InboundMsgPartId":{
            "title":"Inbound Message Part ID",
            "type":"integer",
            "description":"The unique identifier of the message part.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the inbound message part 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."
        }
    }
}

リンク

PartTypeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

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

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

トップに戻る

例:

次の例は、RESTリソースに対してPATCHリクエストを発行してインバウンド・メッセージ部分を更新する方法を示しています。

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

PATCH /crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695/child/InboundMsgParts/300100091977703
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

リクエスト本文の例

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

{
"PartTypeCd": "ORA_SVC_HEADER",
"PartName": "Date"
}

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 200 OK
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

次の例は、レスポンス本文の内容を示しています。

{
  "InboundMsgPartId": 300100091977703,
  "InboundMessageId": 300100091977695,
  "PartTypeCd": "ORA_SVC_HEADER",
  "PartName": "Date",
  "PartValue": "incoming@server.fa.us2.oraclecloud.com",
  "CreationDate": "2017-04-02T19:54:21.004+00:00",
  "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
  "LastUpdateDate": "2017-04-21T12:18:33+00:00",
  "LastUpdatedBy": "sales_admin",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695/child/InboundMsgParts/300100091977703",
      "name": "InboundMsgParts",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695/child/InboundMsgParts/300100091977703",
      "name": "InboundMsgParts",
      "kind": "item"
    },
    {
      "rel": "parent",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695",
      "name": "inboundMessages",
      "kind": "item"
    }
  ]
}

「トップに戻る」