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

機械翻訳について

Lightboxプレゼンテーション・セッションをすべて取得

get

/crmRestApi/resources/11.13.18.05/presentationSessions

リクエスト

問合せパラメータ

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
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- MyPresentationSessionsRF : 現在のユーザーが作成したLightboxプレゼンテーション・セッションを検索します。
  ファインダ変数:
- PresentationSessionSearchRF : 指定した主キーでLightboxプレゼンテーション・セッションを検索します。
  ファインダ変数:
  - BindAccountId; integer;アカウントの一意の識別子。
  - BindActivityId; integer;アクティビティの一意の識別子。
  - BindSessionDateFrom; string;指定した最も早い日付からLightboxプレゼンテーション・セッションを検索します。
  - BindSessionDateTo; string;指定した日付までのLightboxプレゼンテーション・セッションを検索します。
  - BindSessionOwnerId; integer;所有者の一意の識別子。
- PrimaryKey : 指定した主キーでLightboxプレゼンテーション・セッションを検索します。
  ファインダ変数:
  - PresentationSessionId; integer; Lightboxプレゼンテーション・セッションの一意の識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AccountId; integer; プレゼンテーション・セッションが行われたアカウントの一意の識別子。デフォルト値は、作成時に指定されないかぎり、アクティビティから取得されます。
- AccountName; string; プレゼンテーション・セッションが行われたアカウントの名前。
- AccountPartyNumber; string; プレゼンテーション・セッションが行われたアカウントのレジストリ識別子。
- ActivityAccountId; integer;アクティビティ・アカウントの一意の識別子。この属性は、アドホック・プレゼンテーション・セッションでは使用できません。
- ActivityAccountName; string;プレゼンテーション・セッションのアクティビティ・アカウントの名前。この属性は、アドホック・プレゼンテーション・セッションでは使用できません。
- ActivityAccountPartyNumber; string; プレゼンテーション・セッションのアクティビティ・アカウントのレジストリ識別子。この属性は、アドホック・プレゼンテーション・セッションでは使用できません。
- ActivityId; integer; プレゼンテーション・セッションのアクティビティの一意の識別子。
- ActivityNumber; string; プレゼンテーション・セッションのアクティビティ番号。
- ActivitySubject; string;プレゼンテーション・セッションのアクティビティの件名。
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string;レコードが作成された日付。
- LastUpdateDate; string; レコードが最後に更新された日付。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- PresentationSessionId; integer; Lightboxプレゼンテーション・セッションの一意の識別子。
- SessionDate; string; Lightboxプレゼンテーション・セッションが実行された日時。デフォルト値は、作成時に指定されないかぎり、アクティビティから取得されます。
- SessionOwnerEmailAddress; string; プレゼンテーション・セッションの所有者の電子メール・アドレス。
- SessionOwnerId; integer; プレゼンテーション・セッションの所有者の一意の識別子。この個人は、Lightbox文書の主要なプレゼンタです。デフォルト値は、作成時に指定されないかぎり、ユーザーのPartyIdから取得されます。
- SessionOwnerName; string;プレゼンテーション・セッションの所有者の名前。
- SessionOwnerTitle; string;プレゼンテーション・セッションの所有者のタイトル。
- TotalSessionDisplayDuration; number;すべてのプレゼンテーション・セッションの合計時間には、プレゼンテーション・セッション中に表示されたすべてのLightbox文書ページのイベントが表示されます。値は秒単位です。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

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のデフォルト・バージョンを選択します。

ルート・スキーマ : presentationSessions

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

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

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/presentationSessions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object presentationSessions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/presentationSessions-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : presentationSessions-item-response

タイプ: object

ソースを表示

AccountId: integer (int64)

タイトル: Account ID

プレゼンテーション・セッションが行われた取引先の一意の識別子。デフォルト値は、作成時に指定されないかぎり、アクティビティから取得されます。
AccountName: string

タイトル: Account

最大長: 360

プレゼンテーション・セッションが行われた取引先の名前。
AccountPartyNumber: string

タイトル: Registry ID

読取り専用: true

最大長: 30

プレゼンテーション・セッションが実施されたアカウントのレジストリ識別子。
ActivityAccountId: integer (int64)

タイトル: Activity Account ID

読取り専用: true

アクティビティ・アカウントの一意の識別子。この属性は、アドホック・プレゼンテーション・セッションでは使用できません。
ActivityAccountName: string

タイトル: Activity Account

読取り専用: true

最大長: 900

プレゼンテーション・セッションのアクティビティ・アカウントの名前。この属性は、アドホック・プレゼンテーション・セッションでは使用できません。
ActivityAccountPartyNumber: string

タイトル: Activity Registry ID

読取り専用: true

最大長: 30

プレゼンテーション・セッションのアクティビティ・アカウントのレジストリ識別子。この属性は、アドホック・プレゼンテーション・セッションでは使用できません。
ActivityId: integer (int64)

タイトル: Activity ID

プレゼンテーション・セッションの活動の一意の識別子。
ActivityNumber: string

タイトル: Activity Number

読取り専用: true

最大長: 64

プレゼンテーション・セッションの活動番号。
ActivitySubject: string

タイトル: Subject

読取り専用: true

最大長: 500

プレゼンテーション・セッションの活動の件名。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
DeleteFlag: boolean

読取り専用: true

レコードを削除できるかどうかを示します。デフォルト値は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

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

タイトル: Session ID

Lightboxプレゼンテーション・セッションの一意の識別子。
sessionAttendanceEvents: array Presentation Session Attendance Events

タイトル: Presentation Session Attendance Events

プレゼンテーション・セッション出席イベント・リソースは、イベント出席を表示および作成するために使用します。プレゼンテーション・セッション・イベントの出席は、Lightbox文書が表示されたときにセッションに参加したオーディエンスを追跡するために使用されます。
SessionDate: string (date-time)

タイトル: Session Date

Lightboxプレゼンテーション・セッションが実行された日時。デフォルト値は、作成時に指定されないかぎり、アクティビティから取得されます。
sessionDisplayEvents: array Presentation Session Display Events

タイトル: Presentation Session Display Events

プレゼンテーション・セッション表示イベント・リソースは、表示イベントを表示および作成するために使用します。プレゼンテーション・セッション中にLightbox文書ページが表示されていた開始時間と停止時間を記録するイベントを表示します。
SessionOwnerEmailAddress: string

タイトル: Owner Primary Email

読取り専用: true

最大長: 320

プレゼンテーション・セッションの所有者の電子メール・アドレス。
SessionOwnerId: integer (int64)

タイトル: Session Owner ID

プレゼンテーション・セッションの所有者の一意の識別子。この個人は、Lightbox文書の主要なプレゼンタです。デフォルト値は、作成時に指定されないかぎり、ユーザーのPartyIdから取得されます。
SessionOwnerName: string

タイトル: Owner Name

読取り専用: true

最大長: 360

プレゼンテーション・セッションの所有者の名前。
SessionOwnerTitle: string

タイトル: Owner Title

読取り専用: true

最大長: 60

プレゼンテーション・セッションの所有者のタイトル。
TotalSessionDisplayDuration: number

タイトル: Total Session Display Duration

読取り専用: true

デフォルト値: 1

すべてのプレゼンテーション・セッションの合計時間には、プレゼンテーション・セッション中に表示されたすべてのLightbox文書ページのイベントが表示されます。値は秒単位です。
UpdateFlag: boolean

読取り専用: true

レコードを更新できるかどうかを示します。デフォルト値はtrueです。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityAccountPartyNumber":{
            "title":"Activity Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The registry identifier for the activity account for the presentation session. This attribute is not available for ad-hoc presentation sessions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account for which the presentation session was conducted. The default value is obtained from Activity unless specified during create.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity for the presentation session.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The registry identifier for the account for which the presentation session was conducted.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionDate":{
            "title":"Session Date",
            "type":"string",
            "description":"The date and time when the Lightbox presentation session was conducted. The default value is obtained from Activity unless specified during create.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "PresentationSessionId":{
            "title":"Session ID",
            "type":"integer",
            "description":"The unique identifier of the Lightbox presentation session.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SessionOwnerId"
                ]
            }
        },
        "ActivityNumber":{
            "title":"Activity Number",
            "maxLength":64,
            "type":"string",
            "description":"The activity number for the presentation session.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionOwnerId":{
            "title":"Session Owner ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the presentation session. This person is the primary presenter of Lightbox documents. The default value is obtained from the user's PartyId unless specified during create.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActivityAccountName":{
            "title":"Activity Account",
            "maxLength":900,
            "type":"string",
            "description":"The name of the activity account for the presentation session. This attribute is not available for ad-hoc presentation sessions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionOwnerName":{
            "title":"Owner Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the owner of the presentation session.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "SessionOwnerEmailAddress":{
            "title":"Owner Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the owner of the presentation session.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ActivityAccountId":{
            "title":"Activity Account ID",
            "type":"integer",
            "description":"The unique identifier of the activity account. This attribute is not available for ad-hoc presentation sessions.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActivitySubject":{
            "title":"Subject",
            "maxLength":500,
            "type":"string",
            "description":"The subject of the activity for the presentation session.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov",
                "protectionKey":"ActivityEO.Subject",
                "protectionState":"TOKENIZED"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SessionOwnerId"
                ]
            }
        },
        "sessionAttendanceEvents":{
            "title":"Presentation Session Attendance Events",
            "type":"array",
            "description":"The presentation session attendance events resource is used to view and create the event attendance. Presentation session events attendance is used to keep track of the audience who attended a session when a Lightbox document was displayed.",
            "items":{
                "$ref":"#/components/schemas/presentationSessions-sessionAttendanceEvents-item-response"
            }
        },
        "TotalSessionDisplayDuration":{
            "title":"Total Session Display Duration",
            "type":"number",
            "description":"The summed duration of all presentation session display events of all Lightbox document pages presented during the presentation session. The value is in seconds.",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-queryable":true
        },
        "sessionDisplayEvents":{
            "title":"Presentation Session Display Events",
            "type":"array",
            "description":"The presentation session display events resource is used to view and create the display events. Display events log the start and stop times during which a Lightbox document page was displayed during a presentation session.",
            "items":{
                "$ref":"#/components/schemas/presentationSessions-sessionDisplayEvents-item-response"
            }
        },
        "SessionOwnerTitle":{
            "title":"Owner Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the owner of the presentation session.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "AccountName":{
            "title":"Account",
            "maxLength":360,
            "type":"string",
            "description":"The name of the account for which the presentation session was conducted.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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"
    }
}

ネストされたスキーマ : プレゼンテーション・セッション出席イベント

タイプ: array

タイトル: Presentation Session Attendance Events

プレゼンテーション・セッション出席イベント・リソースは、イベント出席を表示および作成するために使用します。プレゼンテーション・セッション・イベントの出席は、Lightbox文書が表示されたときにセッションに参加したオーディエンスを追跡するために使用されます。

ソースを表示

Array of: object presentationSessions-sessionAttendanceEvents-item-response

{
    "title":"Presentation Session Attendance Events",
    "type":"array",
    "description":"The presentation session attendance events resource is used to view and create the event attendance. Presentation session events attendance is used to keep track of the audience who attended a session when a Lightbox document was displayed.",
    "items":{
        "$ref":"#/components/schemas/presentationSessions-sessionAttendanceEvents-item-response"
    }
}

ネストされたスキーマ : プレゼンテーション・セッション表示イベント

タイプ: array

タイトル: Presentation Session Display Events

プレゼンテーション・セッション表示イベント・リソースは、表示イベントを表示および作成するために使用します。プレゼンテーション・セッション中にLightbox文書ページが表示されていた開始時間と停止時間を記録するイベントを表示します。

ソースを表示

Array of: object presentationSessions-sessionDisplayEvents-item-response

{
    "title":"Presentation Session Display Events",
    "type":"array",
    "description":"The presentation session display events resource is used to view and create the display events. Display events log the start and stop times during which a Lightbox document page was displayed during a presentation session.",
    "items":{
        "$ref":"#/components/schemas/presentationSessions-sessionDisplayEvents-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: 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."
        }
    }
}

ネストされたスキーマ : presentationSessions-sessionAttendanceEvents-item-response

タイプ: object

ソースを表示

AttendanceEventId: integer (int64)

タイトル: Attendance Event ID

出席イベントの一意の識別子。
AttendanceEventStartTime: string (date-time)

タイトル: Attendance Event Start Time

出勤イベントの開始時間。
AttendanceEventStopTime: string (date-time)

タイトル: Attendance Event Stop Time

出勤イベントの停止時間。
AttendeeId: integer (int64)

タイトル: Attendee ID

出席者の一意の識別子。
ContactId: integer

タイトル: Contact ID

担当者の一意の識別子。
ContactName: string

タイトル: Contact

読取り専用: true

最大長: 450

出席イベントの担当者の名前。
ContactPartyNumber: string

タイトル: Party Number

読取り専用: true

最大長: 30

担当者のパーティ番号。
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

レコードを最後に更新したユーザーのログイン。
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
        },
        "AttendanceEventStartTime":{
            "title":"Attendance Event Start Time",
            "type":"string",
            "description":"The start time for the attendance event.",
            "format":"date-time",
            "nullable":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
        },
        "AttendanceEventId":{
            "title":"Attendance Event ID",
            "type":"integer",
            "description":"The unique identifier of the attendance event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the contact.",
            "nullable":false,
            "readOnly":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
        },
        "PresentationSessionId":{
            "title":"Session ID",
            "maxLength":1000,
            "type":"string",
            "description":"The unique identifier of the presentation session.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactName":{
            "title":"Contact",
            "maxLength":450,
            "type":"string",
            "description":"The name of the contact for the attendance event.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AttendeeId":{
            "title":"Attendee ID",
            "type":"integer",
            "description":"The unique identifier of the attendee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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
        },
        "AttendanceEventStopTime":{
            "title":"Attendance Event Stop Time",
            "type":"string",
            "description":"The stop time for the attendance event.",
            "format":"date-time",
            "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"
    }
}

ネストされたスキーマ : 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"
    }
}

トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/presentationSessions

レスポンス本文の例

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

{
  "items": [
    {
      "PresentationSessionId": 300100089786735,
      "SessionDate": "2017-02-21T05:48:17+00:00",
      "ActivityId": null,
      "ActivitySubject": null,
      "ActivityNumber": null,
      "AccountId": null,
      "AccountName": null,
      "AccountPartyNumber": null,
      "ActivityAccountId": null,
      "ActivityAccountName": null,
      "ActivityAccountPartyNumber": null,
      "SessionOwnerId": 100010032752947,
      "SessionOwnerName": "Ryan,Katy",
      "SessionOwnerEmailAddress": "email@your_organization.com",
      "SessionOwnerTitle": null,
      "CreatedBy": "KRyan",
      "CreationDate": "2017-02-21T05:48:27+00:00",
      "LastUpdateDate": "2017-02-21T05:48:27+00:00",
      "LastUpdateLogin": "4904EDC6284F3784E0533DD7F00A5CB2",
      "LastUpdatedBy": "KRyan",
      "TotalSessionDisplayDuration": null,
      "DeleteFlag": true,
      "UpdateFlag": true,
      "links": 
	  ...
    },
    {
      "PresentationSessionId": 300100089786740,
      "SessionDate": "2017-02-16T00:30:00+00:00",
      "ActivityId": 300100089786738,
      "ActivitySubject": "Payload Examples",
      "ActivityNumber": "CDRM_56153",
      "AccountId": 1004,
      "AccountName": "Hilman and Associates",
      "AccountPartyNumber": "1004",
      "ActivityAccountId": 1004,
      "ActivityAccountName": "Hilman and Associates US)",
      "ActivityAccountPartyNumber": "1004",
      "SessionOwnerId": 100010032752947,
      "SessionOwnerName": "Ryan,Katy",
      "SessionOwnerEmailAddress": "email@your_organization.com",
      "SessionOwnerTitle": null,
      "CreatedBy": "KRyan",
      "CreationDate": "2017-02-21T06:07:55+00:00",
      "LastUpdateDate": "2017-02-21T06:07:55+00:00",
      "LastUpdateLogin": "4904EDC6284F3784E0533DD7F00A5CB2",
      "LastUpdatedBy": "KRyan",
      "TotalSessionDisplayDuration": null,
      "DeleteFlag": true,
      "UpdateFlag": true,
      "links": 
	  ...
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": 
  ...
}

「トップに戻る」