機械翻訳について

ジャンプ先

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

処理イベントの更新

patch

/crmRestApi/resources/11.13.18.05/actionEvents/{RequestActionCaptureId}

リクエスト

パス・パラメータ

• RequestActionCaptureId(required): integer(int64)
  アクション・イベント取得の一意の識別子。

ヘッダー・パラメータ

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

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• RequestActionCaptureId: integer (int64)
  タイトル: Request Action Capture ID

  アクション・イベント取得の一意の識別子。
• ResponseCode: string
  タイトル: Response Code

  最大長: 50

  呼び出されたREST APIのレスポンス・ステータス・コード。
• ResponsePayload: string
  タイトル: Response Payload

  最大長: 4000

  REST APIコールの出力。

{
    "type":"object",
    "properties":{
        "RequestActionCaptureId":{
            "title":"Request Action Capture ID",
            "type":"integer",
            "description":"The unique identifier of the action event capture.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResponseCode":{
            "title":"Response Code",
            "maxLength":50,
            "type":"string",
            "description":"The response status code of the REST API called.",
            "nullable":true
        },
        "ResponsePayload":{
            "title":"Response Payload",
            "maxLength":4000,
            "type":"string",
            "description":"The output of the REST API call.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• ActionType: string
  タイトル: Action Type

  最大長: 30

  使用されるREST APIメソッド。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  処理イベントを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

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

  リソース・インスタンスに関連付けられたリンク関係。
• ProductFamily: string
  タイトル: Product Family

  最大長: 30

  デフォルト値: CRM

  CRMなど、呼び出されたREST APIの製品ファミリ。
• ProxyUserFlag: boolean
  タイトル: Is Proxy User

  最大長: 1

  セッション・ユーザーがエンド・ユーザーまたはプロキシ・ユーザーのどちらであるかを示します。
• RequestActionCaptureId: integer (int64)
  タイトル: Request Action Capture ID

  アクション・イベント取得の一意の識別子。
• RequestDate: string (date-time)
  タイトル: Request Date

  REST APIが呼び出された日付。
• RequestHeader: string
  タイトル: Request Header

  最大長: 2000

  RESTコールの実行時に含める必要があるリクエスト・ヘッダー。
• RequestPayload: string
  タイトル: Request Payload

  最大長: 3000

  受信REST APIコールの詳細を含むペイロード。
• RequestURI: string
  タイトル: Request URI

  最大長: 1000

  REST APIコールに一致するリクエストURIパターン。
• RequestURL: string
  タイトル: Request URL

  最大長: 1000

  パラメータを含むRESTリクエストの完全なURL。
• ResponseCode: string
  タイトル: Response Code

  最大長: 50

  呼び出されたREST APIのレスポンス・ステータス・コード。
• ResponsePayload: string
  タイトル: Response Payload

  最大長: 4000

  REST APIコールの出力。
• SessionId: string
  タイトル: Session ID

  最大長: 200

  ユーザーのログイン詳細。 この属性は、デジタル顧客サービスなどのアプリケーションでREST APIの連続使用を追跡するために使用されます。
• SessionTypeId: integer (int64)
  タイトル: Session Type ID

  セッション・タイプの一意の識別子。
• SessionUser: string
  タイトル: Session User

  最大長: 64

  REST APIをコールしているログイン・ユーザー。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action event record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the action event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductFamily":{
            "title":"Product Family",
            "maxLength":30,
            "type":"string",
            "description":"The product family of the invoked REST API, such as CRM.",
            "nullable":false,
            "default":"CRM",
            "x-queryable":true
        },
        "ResponseCode":{
            "title":"Response Code",
            "maxLength":50,
            "type":"string",
            "description":"The response status code of the REST API called.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionType":{
            "title":"Action Type",
            "maxLength":30,
            "type":"string",
            "description":"The REST API method used.",
            "nullable":false,
            "x-queryable":true
        },
        "RequestURL":{
            "title":"Request URL",
            "maxLength":1000,
            "type":"string",
            "description":"The full URL of the REST request including the parameters.",
            "nullable":true,
            "x-queryable":true
        },
        "SessionTypeId":{
            "title":"Session Type ID",
            "type":"integer",
            "description":"The unique identifier of the session type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProxyUserFlag":{
            "title":"Is Proxy User",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the session user is an end user or a proxy user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SessionUser":{
            "title":"Session User",
            "maxLength":64,
            "type":"string",
            "description":"The logged in user calling the REST API.",
            "nullable":false,
            "x-queryable":true
        },
        "RequestDate":{
            "title":"Request Date",
            "type":"string",
            "description":"The date when the REST API was invoked.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "RequestActionCaptureId":{
            "title":"Request Action Capture ID",
            "type":"integer",
            "description":"The unique identifier of the action event capture.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponsePayload":{
            "title":"Response Payload",
            "maxLength":4000,
            "type":"string",
            "description":"The output of the REST API call.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestHeader":{
            "title":"Request Header",
            "maxLength":2000,
            "type":"string",
            "description":"The request header that should is included when making a REST call.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequestURI":{
            "title":"Request URI",
            "maxLength":1000,
            "type":"string",
            "description":"The request URI pattern that matches the REST API call.",
            "nullable":true,
            "x-queryable":true
        },
        "SessionId":{
            "title":"Session ID",
            "maxLength":200,
            "type":"string",
            "description":"The login details of the user. This attribute is used to track contiguous usage of REST API in applications like digital customer service.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the  action event 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 details of the user who last updated the action event record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestPayload":{
            "title":"Request Payload",
            "maxLength":3000,
            "type":"string",
            "description":"The payload containing the details of the incoming REST API call.",
            "nullable":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."
        }
    }
}

リンク

YesNoLookupPVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

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

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

「トップに戻る」