機械翻訳について

ジャンプ先

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

Lightboxプレゼンテーション・セッション表示イベントの作成

post

/crmRestApi/resources/11.13.18.05/presentationSessions/{PresentationSessionId}/child/sessionDisplayEvents

リクエスト

パス・パラメータ

• PresentationSessionId(required): string
  Lightboxプレゼンテーション・セッションの一意の識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• DisplayEventId: integer (int64)
  タイトル: Display Event ID

  プレゼンテーション・セッション表示イベントの一意の識別子。
• DisplayEventStartTime: string (date-time)
  タイトル: Display Event Start Time

  表示イベントの開始時間。
• DisplayEventStopTime: string (date-time)
  タイトル: Display Event Stop Time

  表示イベントの停止時間。
• LightboxDocumentId: string
  タイトル: Document ID

  最大長: 64

  Lightbox文書の一意の識別子。
• LightboxDocumentPageId: string
  タイトル: Document Page ID

  Lightbox文書ページの一意の識別子。 この値は、作成中に指定されていないかぎり、LightboxDocumentId、DocumentVersionおよびPageSequenceNumberから取得されます。
• LightboxDocumentVersion: string
  タイトル: Version

  最大長: 64

  Lightboxドキュメントのバージョン。
• PageSequenceNumber: 整数(int32)
  タイトル: Page Sequence Number

  Lightbox文書ページのページ順序番号。
• PresentationSessionId: string
  タイトル: Session ID

  最大長: 1000

  プレゼンテーション・セッションの一意の識別子。

{
    "type":"object",
    "properties":{
        "PresentationSessionId":{
            "title":"Session ID",
            "maxLength":1000,
            "type":"string",
            "description":"The unique identifier of the presentation session.",
            "nullable":true
        },
        "DisplayEventId":{
            "title":"Display Event ID",
            "type":"integer",
            "description":"The unique identifier of the presentation session display event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The page sequence number of the Lightbox document page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "DisplayEventStartTime":{
            "title":"Display Event Start Time",
            "type":"string",
            "description":"The start time for the display event.",
            "format":"date-time",
            "nullable":true
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "type":"string",
            "description":"The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.",
            "nullable":true
        },
        "LightboxDocumentVersion":{
            "title":"Version",
            "maxLength":64,
            "type":"string",
            "description":"The version of the Lightbox document.",
            "nullable":true
        },
        "DisplayEventStopTime":{
            "title":"Display Event Stop Time",
            "type":"string",
            "description":"The stop time for the display event.",
            "format":"date-time",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : presentationSessions-sessionDisplayEvents-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• DisplayEventId: integer (int64)
  タイトル: Display Event ID

  プレゼンテーション・セッション表示イベントの一意の識別子。
• DisplayEventStartTime: string (date-time)
  タイトル: Display Event Start Time

  表示イベントの開始時間。
• DisplayEventStopTime: string (date-time)
  タイトル: Display Event Stop Time

  表示イベントの停止時間。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• LightboxDocumentId: string
  タイトル: Document ID

  最大長: 64

  Lightbox文書の一意の識別子。
• LightboxDocumentPageId: string
  タイトル: Document Page ID

  Lightbox文書ページの一意の識別子。 この値は、作成中に指定されていないかぎり、LightboxDocumentId、DocumentVersionおよびPageSequenceNumberから取得されます。
• LightboxDocumentVersion: string
  タイトル: Version

  最大長: 64

  Lightboxドキュメントのバージョン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PageSequenceNumber: 整数(int32)
  タイトル: Page Sequence Number

  Lightbox文書ページのページ順序番号。
• PresentationSessionId: string
  タイトル: Session ID

  最大長: 1000

  プレゼンテーション・セッションの一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record 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 record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayEventStartTime":{
            "title":"Display Event Start Time",
            "type":"string",
            "description":"The start time for the display event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LightboxDocumentPageId":{
            "title":"Document Page ID",
            "type":"string",
            "description":"The unique identifier of the Lightbox document page. The value is obtained from LightboxDocumentId, DocumentVersion and PageSequenceNumber unless specified during create.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayEventStopTime":{
            "title":"Display Event Stop Time",
            "type":"string",
            "description":"The stop time for the display event.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PresentationSessionId":{
            "title":"Session ID",
            "maxLength":1000,
            "type":"string",
            "description":"The unique identifier of the presentation session.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayEventId":{
            "title":"Display Event ID",
            "type":"integer",
            "description":"The unique identifier of the presentation session display event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PageSequenceNumber":{
            "title":"Page Sequence Number",
            "type":"integer",
            "description":"The page sequence number of the Lightbox document page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated 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
        },
        "LightboxDocumentVersion":{
            "title":"Version",
            "maxLength":64,
            "type":"string",
            "description":"The version of the Lightbox document.",
            "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."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行することによって、Lightboxプレゼンテーション・セッション表示イベントを作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/presentationSessions/300100110457468/child/sessionDisplayEvents

リクエスト本文の例

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

{
"LightboxDocumentId":"bc6c78fa-556a-4d31-86c1-0b522f539333",
"PageSequenceNumber":4,
"DisplayEventStartTime":"2017-02-21T04:08:09",
"DisplayEventStopTime":"2017-02-21T04:59:20"
}

レスポンス本文の例

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

{
  "DisplayEventId": 300100110471627,
  "PresentationSessionId": "300100110457468",
  "LightboxDocumentId": "bc6c78fa-556a-4d31-86c1-0b522f539333",
  "LightboxDocumentPageId": "d1a5d658-49bd-4961-ad3c-4ccfd748bfcd",
  "LightboxDocumentVersion": "1",
  "PageSequenceNumber": 4,
  "DisplayEventStartTime": "2017-02-20T20:08:09-08:00",
  "DisplayEventStopTime": "2017-02-20T20:59:20-08:00",
  "CreatedBy": "KRyan",
  "CreationDate": "2017-02-21T03:20:21-08:00",
  "LastUpdateDate": "2017-02-21T03:20:21-08:00",
  "LastUpdateLogin": "4904BE299F5E24C4E053780CF10A4363",
  "LastUpdatedBy": "KRyan",
  "links": 
  ...
}

「トップに戻る」