すべてのケースを取得
get
/crmRestApi/resources/11.13.18.05/cases
リクエスト
問合せパラメータ
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- CaseByCaseNumber : 指定したケース番号を持つケースを検索します。
ファインダ変数:- CaseNumber; string; 大文字小文字の代替キー識別子。
- CaseListMyCaseTeamCasesFinder : 自分のチームに割り当てられたすべてのケースを検索します。
ファインダ変数: - CasesCreatedByMeFinder : 自分が作成したすべてのケースを検索します。
ファインダ変数: - MyCasesByStatusFinder : 自分に割り当てられたすべてのケースを検索します。
ファインダ変数:- StatusCd; string;自分に割り当てられ、特定のステータスのすべてのケースを検索します。 たとえば、ORA_SVC_NEWまたはORA_SVC_REOPENEDです。
- MyCasesFinder : 自分に割り当てられたすべてのケースを検索します。
ファインダ変数: - PrimaryKey : 指定された主キーを持つケースを検索します。
ファインダ変数:- CaseId; integer; caseの一意の識別子。
- CaseByCaseNumber : 指定したケース番号を持つケースを検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AssigneePartyName; string; ケース割当て先に関連付けられたパーティの名前。
- AssigneePartyNumber; string; ケース割当て先の代替キー識別子。
- AssigneeResourceId; integer; 大/小文字に割り当てられたリソースの一意の識別子。 たとえば、サポート・エンジニアです。
- BUOrgId; integer; 大/小文字に関連付けられたビジネス・ユニット名の一意の識別子。
- BusinessUnitName; string; 大/小文字に関連付けられているビジネス・ユニットの名前。
- CaseCategoryId; integer; ケース・カテゴリの一意の識別子。
- CaseCreatedBy; string; ケースを作成したユーザー。
- CaseCreationDate; string; ケースが作成された日時。
- CaseId; integer; caseの一意の識別子。
- CaseLastUpdateDate; string; ケースが最後に更新された日時。
- CaseLastUpdateLogin; string; ケースを最後に更新したユーザーのログイン詳細。
- CaseLastUpdatedBy; string; ケースを最後に更新したユーザー。
- CaseNumber; string; 大文字小文字の代替キー識別子。
- CaseTypeCd; string; ケースのタイプを示す参照コード。
- CaseTypeCdMeaning; string; ケースのケース・タイプ参照コードに対応する表示値。
- CategoryName; string; 大/小文字に関連付けられたカテゴリの名前。
- ClosedDate; string;ケースがクローズされた日付。
- CorpCurrencyCode; string; 大/小文字の企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
- CreatedBy; string; ケースを作成したユーザー。
- CreatedByPartyId; integer;システムでケースを作成したユーザーの一意の識別子。
- CreatedByPartyName; string;システムでケースを作成したユーザーのパーティ名。
- CreatedByPartyNumber; string;システムでケースを作成したユーザーの代替キー識別子。
- CreationDate; string; ケースが作成された日時。
- CurcyConvRateType; string; 大/小文字に関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
- CurrencyCode; string; 大/小文字に関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
- 説明; string;ケースの簡単な説明。
- LastClosedDate; string; ケースが最後にクローズされた日付。
- LastReopenDate; string; ケースが最後に再オープンされた日付。
- LastUpdateDate; string; ケースが最後に更新された日時。
- LastUpdatedBy; string; ケースを最後に更新したユーザー。
- LastUpdatedByPartyId; integer; ケースを最後に更新したユーザーの一意の識別子。
- LastUpdatedByPartyName; string; ケースを最後に更新したユーザーのパーティ名。
- LastUpdatedByPartyNumber; string; ケースを最後に更新したユーザーの代替キー識別子。
- OpenDate; string; ケースが承認された場合のケースがオープンされた日付。
- PrimaryContactPartyId; integer; ケースのプライマリ担当者の一意の識別子。
- PrimaryContactPartyName; string;プライマリ担当者パーティの名前。
- PrimaryContactPartyNumber; string; プライマリ担当者パーティの代替キー識別子。
- PrimaryHouseholdPartyId; integer;ケースのプライマリ世帯の一意の識別子。
- PrimaryHouseholdPartyName; string;プライマリ世帯パーティの名前。
- PrimaryHouseholdPartyNumber; string;プライマリ世帯パーティの代替キー識別子。
- PriorityCd; string; 大/小文字の優先度を示すコード。 たとえば、ORA_SVC_HIGH、ORA_SVC_LOWまたはORA_SVC_MEDIUMです。
- PriorityCdMeaning; string; ケースの優先度参照コードに対応する表示値。
- QueueId; integer; ケースが割り当てられるキューの一意の識別子。
- QueueName; string; 大/小文字に関連付けられたキューの名前。
- QueueNumber; string; 大/小文字に関連付けられたキューの代替キー識別子。
- ReportedByPartyId; integer; ケースを報告したユーザーの一意の識別子。
- ReportedByPartyName; string; ケースを報告した個人のパーティ名。
- ReportedByPartyNumber; string; ケースを報告したユーザーの代替キー識別子。
- SensitivityCd; string; セキュリティ視点からの大/小文字レコードの機密性を示すコード。 たとえば、ケース・レコードへのアクセスを制御するためにセキュリティが必要な場合にはORA_SVC_CONFIDENTIAL、ケース・レコードへのアクセスを制御するために特別なセキュリティが不要な場合はORA_SVC_NORMALです。
- SensitivityCdMeaning; string; 大/小文字の機密参照コードに対応する表示値。
- SourceCd; string; ケースが作成またはシステムに入力された方法を示すコード。 たとえば、ORA_SVC_API、ORA_SVC_AGENT_UIまたはORA_SVC_MOBILEです。
- SourceCdMeaning; string; ケースのソース参照コードに対応する表示値。
- StatusCd; string; caseのステータスを示すコード。 ORA_SVC_CANCELED、ORA_SVC_CLOSED、ORA_SVC_REOPENED、ORA_SVC_ELIGIBILITY_END、ORA_SVC_INCOMPLETE、ORA_SVC_NEW、ORA_SVC_SUSPENDED、ORA_SVC_WITHDRAWNなど。
- StatusCdMeaning; string; ケースのステータス参照コードに対応する表示値。
- StatusTypeCd; string; caseのステータス・タイプを示すコード。 たとえば、ケースがケース・ワーカーに割り当てられ、アクティブに作業中の場合、ORA_SVC_CLOSED(ケースがクローズされた場合)、ORA_SVC_INACTIVE(ケースが作業中でない場合)、ORA_SVC_RESOLVED(ケースが解決された場合)、ORA_SVC_SUSPENDEDなどです(データ不足のためにケースが一時停止または一時停止された場合)。
- StatusTypeCdMeaning; string; ケースのステータス・タイプ参照コードに対応する表示値。
- StripeCd; string; 大/小文字のストライプ・コード。
- タイトル;文字列;ケースのタイトル。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : ケース
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : cases-item-response
タイプ:
ソースを表示
object
-
AssigneePartyName: string
タイトル:
Assignee Party Name
最大長:360
ケース割当先に関連付けられたパーティの名前。 -
AssigneePartyNumber: string
タイトル:
Assignee Party Number
読取り専用:true
最大長:30
ケース割当先の代替キー識別子。 -
AssigneeResourceId: integer (int64)
タイトル:
Assignee Resource ID
ケースに割り当てられたリソースの一意の識別子。 たとえば、サポート・エンジニアです。 -
Attachments: array Attachments
タイトル:
Attachments
添付リソースは、添付の表示、作成、更新および削除に使用されます。 -
BUOrgId: integer (int64)
タイトル:
Business Unit ID
ケースに関連付けられているビジネス・ユニット名の一意の識別子。 -
BusinessUnitName: string
タイトル:
Business Unit Name
最大長:240
ケースに関連付けられているビジネス・ユニットの名前。 -
CaseCategoryId: integer (int64)
タイトル:
Case Category ID
ケース・カテゴリの一意の識別子。 -
caseContacts: array Case Contacts
タイトル:
Case Contacts
ケース担当者リソースは、ケースと関連担当者間の多対多関係を表示、作成、更新および削除するために使用されます。 -
CaseCreatedBy: string
タイトル:
Case Created By
最大長:64
ケースを作成したユーザー。 -
CaseCreationDate: string (date-time)
タイトル:
Case Creation Date
ケースが作成された日時。 -
caseHouseholds: array Case Households
タイトル:
Case Households
事例世帯リソースは、ケースと関連世帯間の多対多関係を表示、作成、更新および削除するために使用されます。 -
CaseId: integer (int64)
タイトル:
Case ID
読取り専用:true
ケースの一意の識別子。 -
CaseLastUpdateDate: string (date-time)
タイトル:
Case Last Update Date
ケースが最後に更新された日時。 -
CaseLastUpdatedBy: string
タイトル:
Case Last Updated By
最大長:64
ケースを最後に更新したユーザー。 -
CaseLastUpdateLogin: string
タイトル:
Case Last Update Login
最大長:32
ケースを最後に更新したユーザーのログイン詳細。 -
caseMessages: array Case Messages
タイトル:
Case Messages
ケース・メッセージ・リソースは、ケースに関連付けられているすべての通信更新に関する情報を表示、作成、更新および削除するために使用されます。 -
CaseNumber: string
タイトル:
Case Number
最大長:30
ケースの代替キー識別子。 -
caseOpportunities: array Case Opportunities
タイトル:
Case Opportunities
商談リソースは、ケースと関連商談との間の1対多関係を示します。 -
caseResources: array Case Resources
タイトル:
Case Resources
ケース・リソースは、ケースと関連リソース間の多対多関係の表示、作成、更新および削除に使用されます。 -
CaseTypeCd: string
タイトル:
Case Type Code
最大長:30
ケースのタイプを示す参照コード。 -
CaseTypeCdMeaning: string
タイトル:
Case Type Value
最大長:255
ケースのケース・タイプ参照コードに対応する表示値。 -
CategoryName: string
タイトル:
Category Name
最大長:400
ケースに関連付けられているカテゴリの名前。 -
ClosedDate: string (date-time)
タイトル:
Closed Date
ケースがクローズされた日付。 -
CorpCurrencyCode: string
タイトル:
Corporate Currency Code
最大長:15
ケースの企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
ケースを作成したユーザー。 -
CreatedByPartyId: integer (int64)
タイトル:
Created by Party ID
システムでケースを作成したユーザーの一意の識別子。 -
CreatedByPartyName: string
タイトル:
Created by Party Name
読取り専用:true
最大長:360
システムでケースを作成したユーザーのパーティ名。 -
CreatedByPartyNumber: string
タイトル:
Created by Party Number
読取り専用:true
最大長:30
システムでケースを作成したユーザーの代替キー識別子。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ケースが作成された日時。 -
CurcyConvRateType: string
タイトル:
Currency Rate
最大長:30
ケースに関連付けられている通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyCode: string
タイトル:
Currency Code
最大長:15
ケースに関連付けられている通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
DeleteFlag: boolean
タイトル:
Delete
読取り専用:true
ケースを削除できるかどうかを示します。 -
Description: string
タイトル:
Description
最大長:1000
ケースの簡単な説明。 -
LastClosedDate: string (date-time)
タイトル:
Last Closed Date
ケースが最後にクローズされた日付。 -
LastReopenDate: string (date-time)
タイトル:
Last Reopen Date
ケースが最後に再オープンされた日付。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
ケースが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
ケースを最後に更新したユーザー。 -
LastUpdatedByPartyId: integer (int64)
タイトル:
Last Updated by Party
ケースを最後に更新したユーザーの一意のパーティ識別子。 -
LastUpdatedByPartyName: string
タイトル:
Last Updated by Party Name
読取り専用:true
最大長:360
ケースを最後に更新したユーザーのパーティ名。 -
LastUpdatedByPartyNumber: string
タイトル:
Last Updated by Party Number
読取り専用:true
最大長:30
ケースを最後に更新したユーザーの代替キー識別子。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
ケースを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OpenDate: string (date-time)
タイトル:
Open Date
ケースが承認された場合にケースがオープンされた日付。 -
PrimaryContactPartyId: integer (int64)
タイトル:
Primary Contact Party ID
ケースのプライマリ担当者の一意の識別子。 -
PrimaryContactPartyName: string
タイトル:
Primary Contact Party Name
最大長:360
プライマリ担当者パーティの名前。 -
PrimaryContactPartyNumber: string
タイトル:
Primary Contact Party Number
読取り専用:true
最大長:30
プライマリ担当者パーティの代替キー識別子。 -
PrimaryHouseholdPartyId: integer (int64)
タイトル:
Primary Household Party ID
ケースのプライマリ世帯の一意の識別子。 -
PrimaryHouseholdPartyName: string
タイトル:
Primary Household Party Name
最大長:360
プライマリ世帯パーティの名前。 -
PrimaryHouseholdPartyNumber: string
タイトル:
Primary Household Party Number
読取り専用:true
最大長:30
プライマリ世帯パーティの代替キー識別子。 -
PriorityCd: string
タイトル:
Priority
最大長:30
ケースの優先度を示すコード。 たとえば、ORA_SVC_HIGH、ORA_SVC_LOWまたはORA_SVC_MEDIUMです。 -
PriorityCdMeaning: string
タイトル:
Priority Value
最大長:255
ケースの優先度参照コードに対応する表示値。 -
QueueId: integer (int64)
タイトル:
Queue ID
ケースが割り当てられているキューの一意の識別子。 -
QueueName: string
タイトル:
Queue
最大長:400
ケースに関連付けられているキューの名前。 -
QueueNumber: string
タイトル:
Queue Number
最大長:30
ケースに関連付けられているキューの代替キー識別子。 -
ReportedByPartyId: integer (int64)
タイトル:
Reported by Party ID
ケースを報告した個人の一意の識別子。 -
ReportedByPartyName: string
タイトル:
Reported by Party Name
読取り専用:true
最大長:360
ケースを報告した個人のパーティ名。 -
ReportedByPartyNumber: string
タイトル:
Reported by Party Number
読取り専用:true
最大長:30
ケースを報告した個人の代替キー識別子。 -
SensitivityCd: string
タイトル:
Sensitivity
最大長:30
セキュリティの観点からケース・レコードの機密性を示すコード。 たとえば、ケース・レコードへのアクセスを制御するためにセキュリティが必要な場合にはORA_SVC_CONFIDENTIAL、ケース・レコードへのアクセスを制御するために特別なセキュリティが不要な場合はORA_SVC_NORMALです。 -
SensitivityCdMeaning: string
タイトル:
Sensitivity Value
最大長:255
大/小文字の機密参照コードに対応する表示値。 -
smartActions: array Smart Actions
タイトル:
Smart Actions
スマート・アクション・リソースは、スマート・アクションの名前、セキュリティ、コンテキスト・オブジェクト、REST操作、確認メッセージおよびその他のグローバル・プロパティを表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。 -
SourceCd: string
タイトル:
Source
最大長:30
ケースが作成またはシステムに入力された方法を示すコード。 たとえば、ORA_SVC_API、ORA_SVC_AGENT_UIまたはORA_SVC_MOBILEです。 -
SourceCdMeaning: string
タイトル:
Source Value
最大長:255
ケースのソース参照コードに対応する表示値。 -
StatusCd: string
タイトル:
Status
最大長:30
デフォルト値:ORA_SVC_NEW
ケースのステータスを示すコード。 ORA_SVC_CANCELED、ORA_SVC_CLOSED、ORA_SVC_REOPENED、ORA_SVC_ELIGIBILITY_END、ORA_SVC_INCOMPLETE、ORA_SVC_NEW、ORA_SVC_SUSPENDED、ORA_SVC_WITHDRAWNなど。 -
StatusCdMeaning: string
タイトル:
Status Value
最大長:255
ケースのステータス参照コードに対応する表示値。 -
StatusTypeCd: string
タイトル:
Status Type
最大長:30
デフォルト値:ORA_SVC_ACTIVE
ケースのステータス・タイプを示すコード。 たとえば、ケースがケース・ワーカーに割り当てられ、アクティブに作業中の場合、ORA_SVC_CLOSED(ケースがクローズされた場合)、ORA_SVC_INACTIVE(ケースが作業中でない場合)、ORA_SVC_RESOLVED(ケースが解決された場合)、ORA_SVC_SUSPENDEDなどです(データ不足のためにケースが一時停止または一時停止された場合)。 -
StatusTypeCdMeaning: string
タイトル:
Status Type Value
最大長:255
ケースのステータス・タイプ参照コードに対応する表示値。 -
StripeCd: string
タイトル:
Stripe Code
最大長:30
デフォルト値:ORA_SVC_CRM
ケースのストライプ・コード。 -
Title: string
タイトル:
Title
最大長:400
ケースのタイトル。 -
UpdateFlag: boolean
タイトル:
Update
読取り専用:true
レコードを更新できるかどうかを示します。
ネストされたスキーマ : ケース担当者
タイプ:
array
タイトル:
Case Contacts
ケース担当者リソースは、ケースと関連担当者間の多対多関係を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : ケース世帯
タイプ:
array
タイトル:
Case Households
事例世帯リソースは、ケースと関連世帯間の多対多関係を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : ケース・メッセージ
タイプ:
array
タイトル:
Case Messages
ケース・メッセージ・リソースは、ケースに関連付けられているすべての通信更新に関する情報を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : ケース・リソース
タイプ:
array
タイトル:
Case Resources
ケース・リソースは、ケースと関連リソース間の多対多関係の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : スマートなアクション
タイプ:
array
タイトル:
Smart Actions
スマート・アクション・リソースは、スマート・アクションの名前、セキュリティ、コンテキスト・オブジェクト、REST操作、確認メッセージおよびその他のグローバル・プロパティを表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ソースを表示
ネストされたスキーマ : cases-Attachments-item-response
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
ファイルのアップロードを支援するために添付UIコンポーネントによって排他的に使用される属性。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付文書の一意の識別子。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
レコードを作成したユーザー。 -
CreatedByUserName: string
タイトル:
Created By User Name
読取り専用:true
レコードを作成したユーザーの名前。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日付。 -
DatatypeCode: string
タイトル:
Type
最大長:30
デフォルト値:FILE
データ型を示す値。 -
Description: string
タイトル:
Description
最大長:255
添付の説明。 -
DmDocumentId: string
最大長:
255
添付の作成元となる文書の一意の識別子。 -
DmFolderPath: string
タイトル:
Dm Folder Path
最大長:1000
添付の作成元のフォルダ・パス。 -
DmVersionNumber: string
最大長:
255
添付の作成元となる文書バージョン番号。 -
DownloadInfo: string
タイトル:
DownloadInfo
添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。 -
ErrorStatusCode: string
タイトル:
Error Status Code
添付のエラー・コード(ある場合)。 -
ErrorStatusMessage: string
タイトル:
Error Status Message
添付のエラー・メッセージ(ある場合)。 -
ExpirationDate: string (date-time)
タイトル:
Expiration Date
添付ファイルのコンテンツの有効期限。 -
FileContents: 文字列(バイト)
タイトル:
File Contents
添付ファイルの内容。 -
FileName: string
タイトル:
File Name
最大長:2048
添付のファイル名。 -
FileUrl: string
タイトル:
File Url
ファイルのURI。 -
FileWebImage: 文字列(バイト)
タイトル:
File Web Image
読取り専用:true
ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:255
レコードを最後に更新したユーザー。 -
LastUpdatedByUserName: string
タイトル:
Last Updated By User
読取り専用:true
レコードを最後に更新したユーザーの名前。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Title: string
タイトル:
Title
添付のタイトル。 -
UploadedFileContentType: string
タイトル:
Uploaded File Content Type
添付のコンテンツ・タイプ。 -
UploadedFileLength: integer
タイトル:
File Size
添付ファイルのサイズ。 -
UploadedFileName: string
タイトル:
Uploaded File Name
添付ファイルの名前。 -
UploadedText: string
タイトル:
Uploaded Text
新規テキスト添付のテキスト・コンテンツ。 -
Uri: string
タイトル:
Uri
最大長:4000
トポロジ・マネージャ・タイプ・アタッチメントのURI。 -
Url: string
タイトル:
Url
最大長:4000
webページ・タイプ添付のURL。 -
UserName: string
タイトル:
User Name
読取り専用:true
最大長:255
添付を作成したユーザーのログイン資格証明。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : cases-caseContacts-item-response
タイプ:
ソースを表示
object
-
CaseContactId: integer (int64)
タイトル:
Contact ID
読取り専用:true
ケース担当者の一意の識別子。 -
CaseId: integer (int64)
タイトル:
Case ID
ケースの一意の識別子。 -
CaseNumber: string
タイトル:
Case Number
最大長:30
ケースの代替キー識別子。 -
ContactPartyNumber: string
タイトル:
Contact Party Number
読取り専用:true
最大長:30
担当者パーティの代替キー識別子。 -
CorpCurrencyCode: string
タイトル:
Corporate Currency Code
最大長:15
ケース担当者の企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
ケースの担当者を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ケース担当者が作成された日時。 -
CurcyConvRateType: string
タイトル:
Currency Conversion Rate Type
最大長:30
ケース担当者に関連付けられた通貨換算レート・タイプです。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyCode: string
タイトル:
Currency Code
最大長:15
ケース担当者に関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
DeleteFlag: boolean
タイトル:
Delete
読取り専用:true
ケース担当者を削除できるかどうかを示します。 -
EmailAddress: string
タイトル:
Email
読取り専用:true
最大長:320
担当者の電子メール・アドレス。 -
FormattedPhoneNumber: string
タイトル:
Phone
読取り専用:true
担当者の電話番号。 -
JobTitle: string
タイトル:
Job Title
読取り専用:true
最大長:100
コンタクトのジョブ・タイトル。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
PartyId: integer (int64)
タイトル:
Party ID
パーティの一意識別子 -
PartyName: string
タイトル:
Party Name
最大長:360
パーティの名前。 -
PrimaryFlag: boolean
タイトル:
Primary Contact
読取り専用:true
担当者がケースのプライマリ担当者であるかどうかを示します。 -
RelationshipCd: string
タイトル:
Relationship Code
最大長:30
担当者とケースの関係を示すコード。 たとえば、ORA_SVC_BENEFICIARYは、ケースの受取人である担当者(ORA_SVC_CHILD)、応募者の法定子である担当者(ORA_SVC_DEPENDENT)、担当者は応募者(ORA_SVC_GUARDIAN)に依存し、担当者は申請者の法定後見人です(ORA_SVC_LAWYER)、担当者は職業によって弁護士です(ORA_SVC_PARENT)、担当者は申請者の法定の親です(ORA_SVC_PERPETRATOR)、担当者はケースを処理する担当者(ORA_SVC_PARENT)です犯罪者または有害な行為、ORA_SVC_REFERRAL、サービス・プロバイダを参照する担当者、ORA_SVC_REPORTER、インシデントを報告する担当者、ORA_SVC_SERVICE_PROVIDER、特定のサービスまたは福利厚生を応募者にレンダリングしている担当者、ORA_SVC_SIBLING、応募者の法的兄弟である担当者、ORA_SVC_SPOUSE、応募者の配偶者である担当者、またはORA_SVC_VICTIM、インシデントまたはイベントの影響を受ける担当者、 -
RelationshipCdMeaning: string
タイトル:
Relationship Value
最大長:255
ケース担当者の関係参照コードに対応する表示値。 -
UpdateFlag: boolean
タイトル:
Update
読取り専用:true
ケース担当者を更新できるかどうかを示します。
ネストされたスキーマ : cases-caseHouseholds-item-response
タイプ:
ソースを表示
object
-
CaseHouseholdId: integer (int64)
タイトル:
Household ID
読取り専用:true
事例世帯の一意の識別子。 -
CaseId: integer (int64)
タイトル:
Case ID
ケースの一意の識別子。 -
CaseNumber: string
タイトル:
Case Number
最大長:30
ケースの代替キー識別子。 -
CorpCurrencyCode: string
タイトル:
Corporate Currency Code
最大長:15
事例世帯の企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
ケースの世帯を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ケース世帯が作成された日時。 -
CurcyConvRateType: string
タイトル:
Currency Conversion Rate Type
最大長:30
事例世帯に関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyCode: string
タイトル:
Currency Code
最大長:15
事例世帯に関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
DeleteFlag: boolean
タイトル:
Delete
読取り専用:true
レコードを削除できるかどうかを示します。 -
HouseholdName: string
タイトル:
Household Name
最大長:360
世帯の名前 -
HouseholdPartyNumber: string
タイトル:
Household Party Number
読取り専用:true
最大長:30
世帯パーティの代替キー識別子。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
PartyId: integer (int64)
タイトル:
Party ID
パーティの一意識別子 -
PrimaryFlag: boolean
タイトル:
Primary Household
読取り専用:true
世帯がケースのプライマリ世帯かどうかを示します。 -
UpdateFlag: boolean
タイトル:
Update
読取り専用:true
レコードを更新できるかどうかを示します。
ネストされたスキーマ : cases-caseMessages-item-response
タイプ:
ソースを表示
object
-
Attachments: array Attachments
タイトル:
Attachments
添付リソースは、添付の表示、作成、更新および削除に使用されます。 -
CaseId: integer (int64)
タイトル:
Case ID
ケースの一意の識別子。 -
CaseNumber: string
タイトル:
Case Number
最大長:30
ケースの代替キー識別子。 -
コンテンツ: 文字列(バイト)
タイトル:
Content
添付ではないメッセージのコンテンツ。 -
CorpCurrencyCode: string
タイトル:
Corporate Currency Code
最大長:15
ケース・メッセージの企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
ケースのメッセージを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ケース・メッセージが作成された日時。 -
CurcyConvRateType: string
タイトル:
Currency Conversion Rate Type
最大長:30
ケース・メッセージに関連付けられた通貨換算レート・タイプです。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyCode: string
タイトル:
Currency Code
最大長:15
ケース・メッセージに関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
DeleteFlag: boolean
タイトル:
Delete
読取り専用:true
レコードを削除できるかどうかを示します。 -
LastEditedDate: string (date-time)
タイトル:
Last Update Date
ケース・メッセージが最後に編集された日付。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
MessageCreatedBy: string
タイトル:
Message Created By
最大長:64
ケース・メッセージを作成したユーザー。 -
MessageCreationDate: string (date-time)
タイトル:
Message Creation Date
ケース・メッセージが作成された日時。 -
MessageId: integer (int64)
タイトル:
Message ID
メッセージの一意の識別子。 -
MessageLastUpdateDate: string (date-time)
タイトル:
Message Last Update Date
ケース・メッセージが最後に更新された日時。 -
MessageLastUpdatedBy: string
タイトル:
Message Last Updated By
最大長:64
ケース・メッセージを最後に更新したユーザー。 -
MessageLastUpdateLogin: string
タイトル:
Message Last Update Login
最大長:32
ケース・メッセージを最後に更新したユーザーのアプリケーション・ログインID。 -
MessageNumber: string
タイトル:
Message Number
最大長:30
メッセージの代替キー識別子。 -
MessageTypeCd: string
タイトル:
Message Type
最大長:30
デフォルト値:ORA_SVC_NOTE
内部や外部など、メッセージのタイプを示すコード。 -
MessageTypeCdMeaning: string
タイトル:
Message Type Value
最大長:255
ケース・メッセージのメッセージ・タイプ参照コードに対応する表示値。 -
OriginationDate: string (date-time)
タイトル:
Origination Date
メッセージが発生した日付またはメッセージが投稿された日付。 -
ParentMessageId: integer (int64)
タイトル:
Parent Message
親メッセージの一意の識別子。 -
PostedByPartyId: integer (int64)
タイトル:
Posting Party ID
メッセージをポストしたユーザー・パーティの一意の識別子。 -
PostedByPartyName: string
タイトル:
Posted by Party Name
読取り専用:true
最大長:360
メッセージをポストしたパーティの名前。 -
PostedByPartyNumber: string
タイトル:
Posting Party Number
読取り専用:true
最大長:30
メッセージをポストしたユーザー・パーティの代替キー識別子。 -
RichTextFlag: boolean
タイトル:
Rich Text Format
最大長:1
デフォルト値:true
メッセージ・コンテンツがリッチ・テキスト形式であるかどうかを示します。値はYまたはNです。 -
SourceCd: string
タイトル:
Source
最大長:30
メッセージがシステムにどのように入力されたかを示すコード。 たとえば、ORA_SVC_API、REST APIを介してケース・メッセージが作成されたORA_SVC_AGENT_UI、UIでケース・メッセージが作成されたケース・メッセージ、またはモバイル・デバイスを介してケース・メッセージが作成されたORA_SVC_MOBILEなどです。 -
SourceCdMeaning: string
タイトル:
Source Value
最大長:255
ケース・メッセージのソース参照コードに対応する表示値。 -
StatusCd: string
タイトル:
Status Code
最大長:30
デフォルト値:ORA_SVC_COMMITTED
メッセージのステータスを示すコード。 たとえば、ORA_SVC_COMMITTEDは、メッセージがコミットされているか、NULLであることを示します。 -
StatusCdMeaning: string
タイトル:
Status Value
最大長:255
ケース・メッセージのステータス参照コードに対応する表示値。 -
UpdateFlag: boolean
タイトル:
Update
読取り専用:true
レコードを更新できるかどうかを示します。 -
VisibilityCd: string
タイトル:
Visibility
最大長:30
デフォルト値:ORA_SVC_INTERNAL
ケース・メッセージの表示レベルを示すコード。 たとえば、ORA_SVC_EXTERNALの場合、ケース・メッセージは内部ユーザーと外部ユーザーに表示され、ORA_SVC_INTERNALの場合メッセージは内部ユーザーにのみ表示されます。 -
VisibilityCdMeaning: string
タイトル:
Visibility Value
最大長:255
ケース・メッセージの表示参照コードに対応する表示値。
ネストされたスキーマ : cases-caseMessages-Attachments-item-response
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
ファイルのアップロードを支援するために添付UIコンポーネントによって排他的に使用される属性。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付文書の一意の識別子。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
レコードを作成したユーザー。 -
CreatedByUserName: string
タイトル:
Created By User Name
読取り専用:true
レコードを作成したユーザーの名前。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日付。 -
DatatypeCode: string
タイトル:
Type
最大長:30
デフォルト値:FILE
データ型を示す値。 -
Description: string
タイトル:
Description
最大長:255
添付の説明。 -
DmDocumentId: string
最大長:
255
添付の作成元となる文書の一意の識別子。 -
DmFolderPath: string
タイトル:
Dm Folder Path
最大長:1000
添付の作成元のフォルダ・パス。 -
DmVersionNumber: string
最大長:
255
添付の作成元となる文書バージョン番号。 -
DownloadInfo: string
タイトル:
DownloadInfo
添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。 -
ErrorStatusCode: string
タイトル:
Error Status Code
添付のエラー・コード(ある場合)。 -
ErrorStatusMessage: string
タイトル:
Error Status Message
添付のエラー・メッセージ(ある場合)。 -
ExpirationDate: string (date-time)
タイトル:
Expiration Date
添付ファイルのコンテンツの有効期限。 -
FileContents: 文字列(バイト)
タイトル:
File Contents
添付ファイルの内容。 -
FileName: string
タイトル:
File Name
最大長:2048
添付のファイル名。 -
FileUrl: string
タイトル:
File Url
ファイルのURI。 -
FileWebImage: 文字列(バイト)
タイトル:
File Web Image
読取り専用:true
ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:255
レコードを最後に更新したユーザー。 -
LastUpdatedByUserName: string
タイトル:
Last Updated By User
読取り専用:true
レコードを最後に更新したユーザーの名前。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Title: string
タイトル:
Title
添付のタイトル。 -
UploadedFileContentType: string
タイトル:
Uploaded File Content Type
添付のコンテンツ・タイプ。 -
UploadedFileLength: integer
タイトル:
File Size
添付ファイルのサイズ。 -
UploadedFileName: string
タイトル:
Uploaded File Name
添付ファイルの名前。 -
UploadedText: string
タイトル:
Uploaded Text
新規テキスト添付のテキスト・コンテンツ。 -
Uri: string
タイトル:
Uri
最大長:4000
トポロジ・マネージャ・タイプ・アタッチメントのURI。 -
Url: string
タイトル:
Url
最大長:4000
webページ・タイプ添付のURL。 -
UserName: string
タイトル:
User Name
読取り専用:true
最大長:255
添付を作成したユーザーのログイン資格証明。
ネストされたスキーマ : cases-caseOpportunities-item-response
タイプ:
ソースを表示
object
-
CaseId: integer (int64)
タイトル:
Case ID
ケースの一意の識別子。 -
CaseNumber: string
タイトル:
Case Number
読取り専用:true
最大長:30
ケースの代替一意識別子。 -
CaseOpportunityId: integer (int64)
タイトル:
Case Opportunity ID
読取り専用:true
ケースに関連付けられている商談の一意の識別子。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日付。 -
DeleteFlag: boolean
タイトル:
Delete
読取り専用:true
レコードを現在のユーザーが削除できるかどうかを示します。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OptyId: integer (int64)
タイトル:
Opportunity ID
ケース商談の一意の識別子。 -
OptyName: string
タイトル:
Opportunity Name
最大長:275
ケース商談の商談名。 -
OptyNumber: string
タイトル:
Opportunity Number
最大長:30
ケース商談の代替一意識別子。 -
UpdateFlag: boolean
タイトル:
Update
読取り専用:true
レコードを現在のユーザーが更新できるかどうかを示します。
ネストされたスキーマ : cases-caseResources-item-response
タイプ:
ソースを表示
object
-
CaseId: integer (int64)
タイトル:
Case ID
ケースの一意の識別子。 -
CaseNumber: string
タイトル:
Case Number
最大長:30
ケースの代替キー識別子。 -
CaseResourceId: integer (int64)
タイトル:
Resource ID
読取り専用:true
ケース・リソースの一意の識別子。 -
CorpCurrencyCode: string
タイトル:
Corporate Currency Code
最大長:15
ケース・リソースの企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
ケースのリソースを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ケース・リソースが作成された日時。 -
CurcyConvRateType: string
タイトル:
Currency Conversion Rate Type
最大長:30
ケース・リソースに関連付けられた通貨換算レート・タイプです。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyCode: string
タイトル:
Currency Code
最大長:15
ケース・リソースに関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
DeleteFlag: boolean
タイトル:
Delete
読取り専用:true
レコードを削除できるかどうかを示します。 -
EmailAddress: string
タイトル:
Email
読取り専用:true
最大長:320
リソースを作成した担当者のEメール・アドレス。 -
FormattedPhoneNumber: string
タイトル:
Phone
読取り専用: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
リソース・インスタンスに関連付けられたリンク関係。 -
OwnerFlag: boolean
タイトル:
Owner
読取り専用:true
リソースがケースの所有者であるかどうかを示します。 -
PartyId: integer (int64)
タイトル:
Party ID
パーティの一意識別子 -
ResourceName: string
タイトル:
Resource Name
最大長:360
リソースの名前。 -
ResourcePartyNumber: string
タイトル:
Party Number
読取り専用:true
最大長:30
パーティの代替キー識別子。 -
UpdateFlag: boolean
タイトル:
Update
読取り専用:true
レコードを更新できるかどうかを示します。
ネストされたスキーマ : cases-smartActions-item-response
タイプ:
ソースを表示
object
-
ActionIntent: 文字列(バイト)
タイトル:
Action Intent
アクションの実行内容、およびアクションに渡すことができるコンテキスト・データを記述するJSONオブジェクト。 -
ActiveFlag: boolean
タイトル:
Active
最大長:1
処理がアクティブか非アクティブかを示します。 非アクティブなアクションは、どのような状況でもクライアント・アプリケーションには返されません。 Trueは、スマート・アクションがアクティブであることを示します。 -
ApplicationRoles: string
タイトル:
Application Roles
最大長:1000
スマート処理に関連付けられたアプリケーション・ロール。 -
Condition: string
タイトル:
Filter Condition
最大長:1000
アクションをクライアント・アプリケーションに戻すことができるかどうかを判断するために実行時に評価されるブール・スクリプト。 また、アクションがクライアント・アプリケーションに戻されるかどうかを判断するために、追加の評価も行われます。 -
ConfirmationMessage: string
タイトル:
Confirmation Message
最大長:1024
実行中のアクションの確認を求めるメッセージ。 -
ContentType: string
タイトル:
Content Type
最大長:50
RESTエンドポイントの呼出し時に使用するコンテンツ・タイプ。 -
ContextualFlag: boolean
タイトル:
Contextual
最大長:1
コンテキスト・フラグを示します。 -
DataPrivilege: string
タイトル:
Data Security Privilege
最大長:250
アクションをクライアント・アプリケーションに戻すために、認証されたユーザー・ロールを付与する必要があるデータ・セキュリティ権限。 また、アクションがクライアント・アプリケーションに戻されるかどうかを判断するために、追加の評価も行われます。 -
DisplayLabel: string
タイトル:
Action Name
最大長:256
コンシューマ・フレンドリなアクション名。 -
Entity: string
タイトル:
Parent Entity
最大長:150
アクションが属するRESTリソース。 -
Href: string
タイトル:
REST Endpoint
最大長:150
アクションを実行するRESTエンドポイント。 -
IncludedIn: string
タイトル:
Included In
最大長:150
スマート処理が関連付けられているプライマリ・オブジェクトに対応するビュー・オブジェクト。 -
IncludedInApplication: string
タイトル:
Included in Application
最大長:512
このアクションを使用できるアプリケーションのリスト。 -
InternalFlag: boolean
タイトル:
Restricted
最大長:1
処理が内部タイプかどうかを示します。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MassActionFlag: boolean
タイトル:
Mass Action
最大長:1
処理を一括処理できるかどうかを示します。 -
Method: string
タイトル:
HTTP Method
最大長:15
スマート・アクションREST操作のHTTPメソッド。 -
ObjectFunctionName: string
タイトル:
Object Function
最大長:64
スマート・アクションに関連付けられたオブジェクト関数。 -
PageType: string
タイトル:
Page Type
最大長:256
ページ・タイプ。 -
SmartSuggestFlag: boolean
タイトル:
Smart Suggest
最大長:1
スマート提示フラグを示します。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
処理がシード済かカスタムかを示します。 -
UpdateOfAttributes: string
タイトル:
Attributes to Update
最大長:512
処理UIの起動時に更新される属性。 -
UserActionId: integer (int64)
タイトル:
User Action ID
スマート・アクション定義の一意の識別子。 -
UserActionName: string
タイトル:
Action Name
最大長:256
属性は、名前を持つ処理を一意に識別します。 内部使用。 - UserActionNavigation: array User Interface Definitions
-
UserActionRank: integer (int64)
タイトル:
Priority
処理の優先度を示す番号。 -
UserActionRequestPayload: array Payload Definitions
タイトル:
Payload Definitions
ペイロード定義リソースは、スマート・アクションのRESTリクエスト・ペイロードの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。 -
UserActionURLBinding: array Path Parameter Definitions
タイトル:
Path Parameter Definitions
パス・パラメータ定義リソースは、スマート・アクションのRESTリクエスト・パス・パラメータの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。 -
UserPrivilege: string
タイトル:
User Security Privilege
最大長:2000
ユーザー・セキュリティ権限。
ネストされたスキーマ : ペイロード定義
タイプ:
array
タイトル:
Payload Definitions
ペイロード定義リソースは、スマート・アクションのRESTリクエスト・ペイロードの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ソースを表示
ネストされたスキーマ : パス・パラメータ定義
タイプ:
array
タイトル:
Path Parameter Definitions
パス・パラメータ定義リソースは、スマート・アクションのRESTリクエスト・パス・パラメータの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ソースを表示
ネストされたスキーマ : cases-smartActions-UserActionRequestPayload-item-response
タイプ:
ソースを表示
object
-
Binding: string
タイトル:
Payload Value Binding Type
最大長:64
名前と値のペアの値プロパティの分類。 バインディング値RUNTIMEは、割り当てられる値がオブジェクト属性の実行時値であることを示します。 値STATICは、割り当てられる値が単純な文字列であることを示します。 NULL値は、値タイプがJSON_ARRAY_STRINGであることを示します。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MandatoryFlag: boolean
タイトル:
Mandatory
最大長:1
RESTペイロード本文のパラメータ値が必須かどうかを示します。 Trueの場合、ランタイム検証によって値が確実に定義されます。 -
RequestPayloadId: integer (int64)
スマート・アクションRESTペイロード本文パラメータの名前と値のペア定義の一意のシステム割当識別子。
-
RequestPayloadName: string
タイトル:
Request Payload Attribute Name
最大長:256
名前と値のペアの名前プロパティに割り当てられた値。 -
SmartSuggestPath: string
タイトル:
Smart Suggest Path
最大長:2048
スマートはパスを提案します。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
デフォルト値:false
スマート処理がシード済かカスタムかを示します。 Trueは、スマート処理がシードされていることを示します。 値は、smartActions.SystemActionFlagから自動的に導出されます。 -
Value: string
タイトル:
Request Payload Attribute Value
最大長:250
名前と値のペアの値プロパティに割り当てられた値。 -
ValueStruct: string
タイトル:
Payload Value Structure
最大長:20
値JSON_ARRAY_STRINGは、名前と値のペアの値プロパティが、オブジェクト属性名や単純なテキスト文字列などの単一エンティティではなく、データの配列を表すことを示します。 配列文字列は、名前と値のペア、およびバインディングと必須プロパティの定義です。 配列文字列は、[{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]などの特定のパターンに従います。 null値は、値プロパティが、オブジェクト属性名や単純なテキスト文字列などの単純な単一エンティティを表すことを示します。
ネストされたスキーマ : cases-smartActions-UserActionURLBinding-item-response
タイプ:
ソースを表示
object
-
Binding: string
タイトル:
URL Binding Type
最大長:64
名前と値のペアの値プロパティの分類。 UserActionURLBindingインスタンスのバインディング値は、RUNTIMEである必要があります。 バインディング値RUNTIMEは、割り当てられる値がオブジェクト属性の実行時値であることを示します。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
デフォルト値:false
スマート処理がシード済かカスタムかを示します。 Trueは、スマート処理がシードされていることを示します。 値は、smartActions.SystemActionFlagから自動的に導出されます。 -
URLBindingId: integer (int64)
スマート・アクションRESTパス・パラメータの名前と値のペア定義の一意の識別子。
-
URLBindingName: string
タイトル:
URL Binding Parameter Name
最大長:50
名前と値のペアの名前プロパティに割り当てられた値。 -
Value: string
タイトル:
URL Binding Parameter Value
最大長:80
名前と値のペアの値プロパティに割り当てられた値。
例:
次の例は、cURLを使用してRESTリソースに対するgetリクエストを発行して、すべてのケースを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cases
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{ "items": [ { "AssigneeResourceId": null, "BUOrgId": 204, "CaseCategoryId": null, "CaseCreatedBy": "AUTOUICASE1", "CaseCreationDate": "2021-08-25T23:47:35+00:00", "CaseId": 300100216949243, "CaseLastUpdateDate": "2021-08-25T23:47:35.001+00:00", "CaseLastUpdateLogin": "CA5FA16623618065E05323EAF40A8D90", "CaseLastUpdatedBy": "AUTOUICASE1", "CaseNumber": "CDRM_5003", "ClosedDate": null, "CorpCurrencyCode": null, "CreatedBy": "AUTOUICASE1", "CreatedByPartyId": 300100112109025, "CreationDate": "2021-08-25T23:47:35+00:00", "CurcyConvRateType": null, "CurrencyCode": null, "Description": null, "LastClosedDate": null, "LastReopenDate": null, "LastUpdateDate": "2021-08-25T23:47:53.735+00:00", "LastUpdateLogin": "CA5F9CD8F6178063E05323EAF40A4F68", "LastUpdatedBy": "AUTOUICASE1", "LastUpdatedByPartyId": 300100112109025, "OpenDate": "2021-08-25T23:47:36.181+00:00", "PrimaryContactPartyId": null, "PrimaryHouseholdPartyId": null, "PriorityCd": null, "QueueId": null, "ReportedByPartyId": 300100112109025, "SensitivityCd": null, "SourceCd": null, "StatusCd": "ORA_SVC_NEW", "StatusTypeCd": "ORA_SVC_ACTIVE", "StripeCd": "ORA_SVC_CRM", "Title": "JETAutoRestCase_202173_164725548", "AssigneePartyName": null, "AssigneePartyNumber": null, "BusinessUnitName": "Vision Operations", "CategoryName": null, "PrimaryContactPartyName": null, "PrimaryContactPartyNumber": null, "PrimaryHouseholdPartyName": null, "PrimaryHouseholdPartyNumber": null, "QueueName": null, "QueueNumber": null, "ReportedByPartyName": "AUTOUICASE1 svc", "ReportedByPartyNumber": "CDRM_674216", "LastUpdatedByPartyName": "AUTOUICASE1 svc", "LastUpdatedByPartyNumber": "CDRM_674216", "CreatedByPartyName": "AUTOUICASE1 svc", "CreatedByPartyNumber": "CDRM_674216", "DeleteFlag": true, "UpdateFlag": true, "StatusTypeCdMeaning": "Active", "PriorityCdMeaning": null, "SensitivityCdMeaning": null, "SourceCdMeaning": null, "StatusCdMeaning": "New", "CaseTypeCd": null, "CaseTypeCdMeaning": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_5003", "name": "cases", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678" } ... }