機械翻訳について

ジャンプ先

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

イベントの取得

get

/crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents/{McaEventId}

リクエスト

パス・パラメータ

• McaEventId(required): integer(int64)
  イベントの自動生成された番号と主キー。

問合せパラメータ

• dependency: string
  このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
  
  フォーマット: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

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

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : multiChannelAdapterEvents-item-response

タイプ: object

ソースを表示

• AgentId: integer (int64)
  パーティ・エンティティのエージェント識別子。
• ApplClassificationCd: string
  最大長: 32

  このイベントが適用されるアプリケーション分類のコード。
• BoEntityId: integer (int64)
  ビジネス・オブジェクト・エンティティ表の自動生成された番号と主キー。
• ChannelId: integer (int64)
  チャネル表の自動生成された番号と主キー。
• CommId: string
  最大長: 64

  APIイベントIDで表される通信ID。
• ContactId: integer (int64)
  担当者表の自動生成された番号と主キー。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  イベントを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  イベントが作成された日時。
• DirectionCd: string
  最大長: 32

  トークン値のイベントの方向。
• EntityName: string
  タイトル: Object Name

  読取り専用: true

  最大長: 64

  ビジネス・オブジェクト・エンティティの一意の識別子。
• ErrorMsg: string
  最大長: 4000

  イベント処理のエラー・メッセージ。
• ErrorMsgCd: string
  最大長: 64

  イベント処理のエラー・コード。
• InteractionId: integer (int64)
  顧客対応表の自動生成された番号と主キー。
• InTokens: string
  最大長: 4000

  リクエスト・ペイロードの入力トークン。
• LastUpdateDate: string (date-time)
  読取り専用: true

  イベントを最後に更新したユーザー。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  イベントが最後に更新された日付。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  イベントを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• McaEventId: integer (int64)
  読取り専用: true

  イベントの自動生成された番号と主キー。
• McaEventNumber: string
  最大長: 30

  行の作成中に必要な公開サロゲート・キー。
• Method: string
  最大長: 32

  コール・イベント・メソッドの名前。
• NextState: string
  最大長: 32

  イベント処理によって計算される次の状態。
• ObjectVersionNumber: 整数(int32)
  オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
• Origin: string
  最大長: 250

  イベント開始者を表すURL。
• OutTokens: string
  最大長: 4000

  レスポンス・ペイロードの出力トークン。
• Result: string
  最大長: 64

  イベント処理の返された結果。
• ToolbarId: integer (int64)
  ツールバー表の自動生成された番号と主キー。
• ToolbarName: string
  最大長: 64

  このイベントに使用されているツールバー名。
• Uuid: string
  最大長: 64

  クライアント・レスポンスの一意の識別子。
• Version: string
  最大長: 32

  クライアント側コンシューマのバージョン。
• WindowName: string
  最大長: 64

  イベントのクライアント・ウィンドウ識別子。
• WrapupId: integer (int64)
  ラップ・アップ表の自動生成された番号と主キー。

{
    "type":"object",
    "properties":{
        "Origin":{
            "maxLength":250,
            "type":"string",
            "description":"The URL representing the event initiator.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BoEntityId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the business object entity table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CommId":{
            "maxLength":64,
            "type":"string",
            "description":"The communication ID represented by the API Event ID.",
            "nullable":false,
            "x-queryable":true
        },
        "EntityName":{
            "title":"Object Name",
            "maxLength":64,
            "type":"string",
            "description":"A unique identifier of the business object entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DirectionCd":{
            "maxLength":32,
            "type":"string",
            "description":"The direction of the event for the token values.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the contact table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelId":{
            "type":"integer",
            "description":"The auto-generated number and primary key of the channels table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Result":{
            "maxLength":64,
            "type":"string",
            "description":"The returned result of event processing.",
            "nullable":true,
            "x-queryable":true
        },
        "Version":{
            "maxLength":32,
            "type":"string",
            "description":"The version of the client side consumer.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "McaEventNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public surrogate key which is required during creation of the row.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AgentId":{
            "type":"integer",
            "description":"The agent identifier from the parties entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ToolbarId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the toolbars table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date when the event was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the interactions table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorMsgCd":{
            "maxLength":64,
            "type":"string",
            "description":"The error code for the event processing.",
            "nullable":true,
            "x-queryable":true
        },
        "McaEventId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ToolbarName":{
            "maxLength":64,
            "type":"string",
            "description":"The toolbar name being used for this event.",
            "nullable":true,
            "x-queryable":true
        },
        "WindowName":{
            "maxLength":64,
            "type":"string",
            "description":"The client window identifier of the event.",
            "nullable":true,
            "x-queryable":true
        },
        "NextState":{
            "maxLength":32,
            "type":"string",
            "description":"The next state calculated by the event processing.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMsg":{
            "maxLength":4000,
            "type":"string",
            "description":"The error message of the event processing.",
            "nullable":true,
            "x-queryable":true
        },
        "OutTokens":{
            "maxLength":4000,
            "type":"string",
            "description":"The output tokens in the response payload.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "maxLength":32,
            "type":"string",
            "description":"The name of the calling event method.",
            "nullable":false,
            "x-queryable":true
        },
        "WrapupId":{
            "type":"integer",
            "description":"The auto-generated number and primary key for the wrap ups table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Uuid":{
            "maxLength":64,
            "type":"string",
            "description":"Client response unique identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "InTokens":{
            "maxLength":4000,
            "type":"string",
            "description":"The input tokens of the request payload.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplClassificationCd":{
            "maxLength":32,
            "type":"string",
            "description":"The code of the application classification to which this event applies.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The user who last updated the event.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the event.",
            "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."
        }
    }
}

リンク

ApplClassificationCodeLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_MCA_APPL_CLASSIF_CD

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

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

「トップに戻る」