すべてのアクション・プランの取得
get
/crmRestApi/resources/11.13.18.05/actionplans
リクエスト
問合せパラメータ
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- ActionPlanNumberRowFinder : 指定した主キーを持つアクション・プランを検索します。
ファインダ変数:- ActionPlanNumber; string; アクション・プランの代替の一意の識別子。
- PrimaryKey : 指定した主キーを持つアクション・プランを検索します。
ファインダ変数:- ActionPlanId; integer;アクション・プランの一意の識別子。
- ActionPlanNumberRowFinder : 指定した主キーを持つアクション・プランを検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- ActionId; integer; アクションの一意の識別子。
- ActionObjectEntitySubtype; string; アクションのオブジェクト・エンティティ・サブタイプを示します。
- ActionObjectEntityType; string;アクションのオブジェクト・エンティティ・タイプを示します。
- ActionObjectId; integer; アクションに関連付けられた一意のオブジェクト識別子。
- ActionObjectReferenceNumber; string;アクションに関連付けられたオブジェクトの参照番号。
- ActionPlanId; integer;アクション・プランの一意の識別子。
- ActionPlanNumber; string; アクション・プランの代替の一意の識別子。
- ActionPlanTypeCd;文字列。テンプレート・ベースのアクション・プランやPCSプロセス・ベースのアクション・プランなど、アクション・プランのタイプを示す参照コード。
- ActionPlanTypeCdMeaning; string; 処理プランの処理プラン・タイプ参照コードに対応する表示値。
- ActionStatusCd; string;アクションのステータス。
- ActionStatusCdMeaning; string; アクションのステータス参照コードに対応する表示値。
- ActualCompletionDate; string; アクション・プランが実際に完了した日時。
- AdditionalInformation; string; アクション・プラン・レコードに関する追加情報。
- CalendarId; integer; アクション・プランに関連付けられたカレンダの一意の識別子。
- CreatedBy; string; アクション・プランを作成したユーザー。
- CreationDate; string; アクション・プランが作成された日時。
- DeletedFlag; boolean。アクション・プランが削除されたかどうかを示します。 デフォルト値はfalseです。
- ExpectedCompletionDate; string; アクション・プランが完了する日付。
- InitialCompletionDate; string; アクション・プランの完了が予想された最初の日付。
- LastRefreshedDate; string; アクション・プラン・ステータスが最後にリフレッシュされた日付。
- LastUpdateDate; string; アクション・プランが最後に更新された日時。
- LastUpdateLogin; string; アクション・プランを最後に更新したユーザーのログイン詳細。
- LastUpdatedBy; string; アクション・プランを最後に更新したユーザー。
- 名前、文字列。アクション・プランを最後に更新したユーザーの名前。
- ObjectEntityName; string; アクション・プランに関連付けられた親エンティティ・オブジェクトの名前。
- ObjectEntityNameMeaning; string; アクション・プランのオブジェクト・エンティティ名参照コードに対応する表示値。
- ObjectId; integer; アクション・プランに関連付けられたオブジェクトの一意の識別子。
- ObjectNumber; string; アクション・プランのオブジェクト参照番号。
- OrderNumber; integer;アクション・プランのリスト内のアクション・プランの順序。
- ProcessInstanceId; string; 外部プロセスのプロセス・インスタンス識別子。
- ProcessStatus; string;外部プロセスのステータス。
- SchedulePuid; string;標準カバレッジ・スケジュールの公開一意識別子。
- StartDate; string; アクション・プランが開始する日付。
- ステータス、文字列。アクション・プランのステータス(ORA_SVC_CREATE、ORA_SVC_IN_PROGRESS、ORA_SVC_COMPLETED、ORA_SVC_ERRORなど)。 ORA_SVC_CREATEステータスは、アクション・プランの割当済テンプレートに基づく必須の子レコードが作成され、ステータスがORA_SVC_CREATEDに変更されることを示します。 ORA_SVC_CREATEDステータスは、すべての子アクション・プラン・アクションが作成されたが、計画全体がまだ開始されていないことを示します。 ORA_SVC_INITIATEステータスは、アクション・プランが開始されたことを示し、成功した場合はステータスがORA_SVC_IN_PROGRESSに変更されます。 ORA_SVC_CREATE_AND_INITIATEステータスは、子プラン・アクションが作成され、アクション・プランが開始されることを示します。 ORA_SVC_CREATE_AND_INITIATEステータスは、中間ORA_SVC_CREATEDステータスをスキップします。 ORA_SVC_INITIATINGステータスは、アクション・プラン開始プロセスが開始されたことを示します。 基礎となるオブジェクトを正常に作成できる場合、アクション・プランのステータスはORA_SVC_IN_PROGRESSに変わります。 基礎となるオブジェクトの作成に失敗した場合、ステータスはORA_SVC_ERRORに変わります。 ORA_SVC_ERRORステータスの場合、エラー詳細は、アクション・プラン・オブジェクトまたはその子アクション・プラン・アクション・オブジェクトのステータス詳細属性に格納されます。 ORA_SVC_COMPLETEDステータスは、アクション・プランのすべてのアクションが完了したことを示します。
- StatusCd; string; ORA_SVC_CREATE、ORA_SVC_IN_PROGRESS、ORA_SVC_COMPLETED、ORA_SVC_ERRORなど、アクションのステータスを示すコード。 ORA_SVC_CREATEステータスは、アクション・プランの割当済テンプレートに基づく必須の子レコードが作成され、ステータスがORA_SVC_CREATEDに変更されることを示します。 ORA_SVC_CREATEDステータスは、すべての子アクション・プラン・アクションが作成されたが、計画全体がまだ開始されていないことを示します。 ORA_SVC_INITIATEステータスは、アクション・プランが開始されたことを示し、成功した場合はステータスがORA_SVC_IN_PROGRESSに変更されます。 ORA_SVC_CREATE_AND_INITIATEステータスは、子プラン・アクションが作成され、アクション・プランが開始されることを示します。 ORA_SVC_CREATE_AND_INITIATEステータスは、中間ORA_SVC_CREATEDステータスをスキップします。 ORA_SVC_INITIATINGステータスは、アクション・プラン開始プロセスが開始されたことを示します。 基礎となるオブジェクトを正常に作成できる場合、アクション・プランのステータスはORA_SVC_IN_PROGRESSに変わります。 基礎となるオブジェクトの作成に失敗した場合、ステータスはORA_SVC_ERRORに変わります。 ORA_SVC_ERRORステータスの場合、エラー詳細は、アクション・プラン・オブジェクトまたはその子アクション・プラン・アクション・オブジェクトのステータス詳細属性に格納されます。 ORA_SVC_COMPLETEDステータスは、アクション・プランのすべてのアクションが完了したことを示します。
- StatusCdMeaning; string; アクション・プランのステータス参照コードに対応する表示値。
- StatusDetails; string; アクション・プランのエラー・ステータスの説明。
- TemplateId; integer; アクション・プランの作成元であるアクション・プラン・テンプレートの一意の識別子。
- TemplateNumber; 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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : actionplans-item-response
タイプ:
ソースを表示
object
-
ActionId: integer (int64)
タイトル:
Action ID
アクションの一意の識別子。 -
ActionNumber: string
タイトル:
Action Number
処理の参照番号。 -
ActionObjectEntitySubtype: string
タイトル:
Object Entity Subtype
読取り専用:true
最大長:400
アクションのオブジェクト・エンティティ・サブタイプを示します。 -
ActionObjectEntityType: string
タイトル:
Type
読取り専用:true
最大長:400
アクションのオブジェクト・エンティティ・タイプを示します。 -
ActionObjectId: integer (int64)
タイトル:
Action Object ID
処理に関連付けられた一意のオブジェクト識別子。 -
ActionObjectReferenceNumber: string
タイトル:
Action Object Reference Number
最大長:100
処理に関連付けられたオブジェクトの参照番号。 -
actionPlanAction: array Action Plan Actions
タイトル:
Action Plan Actions
アクション・プラン・アクション・リソースは、アクション・プランの処理を表示、作成、更新および削除するために使用されます。 アクションは、アクション・プランのステップまたはシーケンスです。 -
ActionPlanId: integer (int64)
タイトル:
Action Plan ID
読取り専用:true
処理プランの一意の識別子。 -
ActionPlanNumber: string
タイトル:
Action Plan Number
最大長:30
処理プランの代替一意識別子。 -
ActionPlanTypeCd: string
タイトル:
Action Plan Type Code
最大長:30
デフォルト値:ORA_SVC_TEMPLATE
処理プランのタイプ(テンプレート・ベースの処理プラン、PCSプロセス・ベースの処理プランなど)を示す参照コード。 -
ActionPlanTypeCdMeaning: string
タイトル:
Action Plan Type Value
読取り専用:true
最大長:255
処理プランの処理プラン・タイプ参照コードに対応する表示値。 -
ActionStatusCd: string
タイトル:
Action Status Code
最大長:30
処理のステータス。 -
ActionStatusCdMeaning: string
タイトル:
Action Status Code Meaning
最大長:255
処理のステータス参照コードに対応する表示値。 -
ActualCompletionDate: string (date-time)
タイトル:
Actual Completion Date
処理プランが実際に完了した日時。 -
AdditionalInformation: string
タイトル:
Additional Information
最大長:1000
アクション・プラン・レコードに関する追加情報。 -
CalendarId: integer (int64)
タイトル:
Calendar ID
処理プランに関連付けられたカレンダの一意の識別子。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
処理プランを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
処理プランが作成された日時。 -
DeletedFlag: boolean
タイトル:
Deleted
最大長:1
デフォルト値:false
処理プランが削除されたかどうかを示します。 デフォルト値はfalseです。 -
DeleteFlag: boolean
読取り専用:
true
処理プランを削除できるかどうかを示します。 -
ExpectedCompletionDate: string (date-time)
タイトル:
Projected Completion Date
処理プランが完了する日付。 -
InitialCompletionDate: string (date-time)
タイトル:
Initial Expected Completion Date
処理プランの完了が予想された最初の日付。 -
LastRefreshedDate: string (date-time)
タイトル:
Last Refreshed 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
リソース・インスタンスに関連付けられたリンク関係。 -
Name: string
タイトル:
Name
最大長:400
アクション・プランを最後に更新したユーザーの名前。 -
ObjectEntityName: string
タイトル:
Object Entity Name
最大長:400
処理プランに関連付けられた親エンティティ・オブジェクトの名前。 -
ObjectEntityNameMeaning: string
タイトル:
Object Entity Name Value
最大長:255
処理プランのオブジェクト・エンティティ名参照コードに対応する表示値。 -
ObjectId: integer (int64)
タイトル:
Object ID
処理プランに関連付けられたオブジェクトの一意の識別子。 -
ObjectNumber: string
処理プランのオブジェクト参照番号。
-
OrderNumber: integer (int64)
タイトル:
Order Number
処理プランのリスト内の処理プランの順序。 -
ProcessInstanceId: string
タイトル:
Process Instance ID
最大長:500
外部プロセスのプロセス・インスタンス識別子。 -
ProcessStatus: string
タイトル:
Process Status
最大長:100
外部プロセスのステータス。 -
SchedulePuid: string
タイトル:
Schedule PUID
読取り専用:true
最大長:120
標準カバレッジ・スケジュールの公開一意識別子。 -
StartDate: string (date-time)
タイトル:
Start Date
アクション・プランが開始する日付。 -
Status: string
読取り専用:
true
ORA_SVC_CREATE、ORA_SVC_IN_PROGRESS、ORA_SVC_COMPLETED、ORA_SVC_ERRORなど、アクション・プランのステータス。 ORA_SVC_CREATEステータスは、アクション・プランの割当済テンプレートに基づく必須の子レコードが作成され、ステータスがORA_SVC_CREATEDに変更されることを示します。 ORA_SVC_CREATEDステータスは、すべての子アクション・プラン・アクションが作成されたが、計画全体がまだ開始されていないことを示します。 ORA_SVC_INITIATEステータスは、アクション・プランが開始されたことを示し、成功した場合はステータスがORA_SVC_IN_PROGRESSに変更されます。 ORA_SVC_CREATE_AND_INITIATEステータスは、子プラン・アクションが作成され、アクション・プランが開始されることを示します。 ORA_SVC_CREATE_AND_INITIATEステータスは、中間ORA_SVC_CREATEDステータスをスキップします。 ORA_SVC_INITIATINGステータスは、アクション・プラン開始プロセスが開始されたことを示します。 基礎となるオブジェクトを正常に作成できる場合、アクション・プランのステータスはORA_SVC_IN_PROGRESSに変わります。 基礎となるオブジェクトの作成に失敗した場合、ステータスはORA_SVC_ERRORに変わります。 ORA_SVC_ERRORステータスの場合、エラー詳細は、アクション・プラン・オブジェクトまたはその子アクション・プラン・アクション・オブジェクトのステータス詳細属性に格納されます。 ORA_SVC_COMPLETEDステータスは、アクション・プランのすべてのアクションが完了したことを示します。 -
StatusCd: string
タイトル:
Status Code
最大長:30
ORA_SVC_CREATE、ORA_SVC_IN_PROGRESS、ORA_SVC_COMPLETED、ORA_SVC_ERRORなど、アクションのステータスを示すコード。 ORA_SVC_CREATEステータスは、アクション・プランの割当済テンプレートに基づく必須の子レコードが作成され、ステータスがORA_SVC_CREATEDに変更されることを示します。 ORA_SVC_CREATEDステータスは、すべての子アクション・プラン・アクションが作成されたが、計画全体がまだ開始されていないことを示します。 ORA_SVC_INITIATEステータスは、アクション・プランが開始されたことを示し、成功した場合はステータスがORA_SVC_IN_PROGRESSに変更されます。 ORA_SVC_CREATE_AND_INITIATEステータスは、子プラン・アクションが作成され、アクション・プランが開始されることを示します。 ORA_SVC_CREATE_AND_INITIATEステータスは、中間ORA_SVC_CREATEDステータスをスキップします。 ORA_SVC_INITIATINGステータスは、アクション・プラン開始プロセスが開始されたことを示します。 基礎となるオブジェクトを正常に作成できる場合、アクション・プランのステータスはORA_SVC_IN_PROGRESSに変わります。 基礎となるオブジェクトの作成に失敗した場合、ステータスはORA_SVC_ERRORに変わります。 ORA_SVC_ERRORステータスの場合、エラー詳細は、アクション・プラン・オブジェクトまたはその子アクション・プラン・アクション・オブジェクトのステータス詳細属性に格納されます。 ORA_SVC_COMPLETEDステータスは、アクション・プランのすべてのアクションが完了したことを示します。 -
StatusCdMeaning: string
タイトル:
Status Value
最大長:255
処理プランのステータス参照コードに対応する表示値。 -
StatusDetails: string
タイトル:
Status Details
最大長:1000
処理プランのエラー・ステータスの説明。 -
TemplateId: integer (int64)
タイトル:
Template ID
処理プランの作成元である処理プラン・テンプレートの一意の識別子。 -
TemplateNumber: string
タイトル:
Template Number
最大長:30
処理プラン・テンプレートの参照番号。 -
UpdateFlag: boolean
読取り専用:
true
処理プランを更新できるかどうかを示します。
ネストされたスキーマ : 処理プラン処理
タイプ:
array
タイトル:
Action Plan Actions
アクション・プラン・アクション・リソースは、アクション・プランの処理を表示、作成、更新および削除するために使用されます。 アクションは、アクション・プランのステップまたはシーケンスです。
ソースを表示
ネストされたスキーマ : actionplans-actionPlanAction-item-response
タイプ:
ソースを表示
object
-
ActionDescription: string
タイトル:
Description
読取り専用:true
最大長:1000
処理プランの処理の摘要。 -
ActionId: integer (int64)
タイトル:
Action ID
アクションの一意の識別子。 -
ActionName: string
タイトル:
Action
読取り専用:true
最大長:400
アクションの名前。 -
ActionNumber: string
タイトル:
Action Number
処理プランの処理の参照番号。 -
ActionPlanActionId: integer (int64)
タイトル:
Action Plan Action ID
読取り専用:true
処理プランの処理の一意の識別子。 -
ActionPlanActionNumber: string
タイトル:
Action Plan Action Number
最大長:30
処理プラン処理の代替一意識別子。 -
actionPlanActionRelation: array Action Plan Action Relations
タイトル:
Action Plan Action Relations
アクション・プラン処理関係リソースは、アクション・プラン内のアクション間の関係を表示、作成、更新および削除するために使用されます。 アクション関係は、アクションが実行される順序を定義できます。 -
ActionPlanId: integer (int64)
タイトル:
Action Plan ID
処理プランの一意の識別子。 -
ActionPlanNumber: string
タイトル:
Action Plan Number
最大長:30
処理プラン参照番号。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
処理プランで処理を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
アクション・プランでアクションが作成された日時。 -
DelayedFlag: boolean
読取り専用:
true
処理プランの処理が遅延しているかどうかを示します。 -
DeletedFlag: boolean
タイトル:
Deleted
最大長:1
デフォルト値:false
処理プランの処理が削除されるかどうかを示します。 デフォルト値はfalseです。 -
DeleteFlag: boolean
読取り専用:
true
処理プランの処理を削除できるかどうかを示します。 -
EndDate: string (date-time)
タイトル:
End Date
アクション・プランのアクションが終了する日付。 -
EndDateReadOnlyFlag: boolean
読取り専用:
true
終了日を読み取り専用にするかどうかを示します。 -
ExpectedCompletionDate: string (date-time)
タイトル:
Expected Completion Date
アクション・プランのアクションが完了する日付。 -
ExpectedStartDate: string (date-time)
タイトル:
Expected Start Date
アクション・プランのアクションが開始される予定の日付。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
アクション・プランで処理が最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
アクション・プランの処理を最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
アクション・プランのアクションを最後に更新したユーザーのログイン詳細。 -
LeadTime: integer (int64)
タイトル:
Duration
アクションの完了に必要な推定時間。 -
LeadTimeUnit: string
タイトル:
Duration Unit
最大長:30
分、時間、日など、リード・タイムの測定単位。 -
LeadTimeUnitMeaning: string
タイトル:
Lead Time Unit Value
最大長:255
処理プラン処理のリード・タイム・ユニット参照コードに対応する表示値です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MandatoryFlag: boolean
タイトル:
Mandatory
最大長:1
デフォルト値:true
処理プランの処理が必須かどうかを示します。 デフォルト値はfalseです。 -
ObjectEntityName: string
タイトル:
Entity Name
読取り専用:true
最大長:400
アクションの基になる親エンティティ・オブジェクトの名前。 -
ObjectEntityNameMeaning: string
タイトル:
Object Entity Name Value
最大長:255
処理プラン処理のオブジェクト・エンティティ名参照コードに対応する表示値。 -
ObjectEntitySubtype: string
タイトル:
Object Entity Subtype
読取り専用:true
最大長:400
処理プランの処理のオブジェクト・エンティティ・サブタイプを示します。 -
ObjectEntityType: string
タイトル:
Type
読取り専用:true
最大長:400
アクションの基になる親エンティティ・オブジェクトのタイプ。 -
ObjectEntityTypeMeaning: string
タイトル:
Object Entity Type Value
最大長:255
処理プラン処理のオブジェクト・エンティティ・タイプ参照コードに対応する表示値。 -
ObjectId: integer (int64)
タイトル:
Object ID
アクションに関連付けられたオブジェクトの一意の識別子。 -
ObjectReferenceNumber: string
タイトル:
Object Reference Number
最大長:100
処理に関連付けられたオブジェクトの参照番号。 -
OrderNumber: integer (int64)
タイトル:
Step
アクション・プランでのアクションの順序。 -
OwnerName: string
タイトル:
Owner
読取り専用:true
アクションの所有者の名前。 -
Prerequisites: string
タイトル:
Prerequisites
読取り専用:true
アクションを開始するために必要な前提条件ステップ。 -
ProcessInstanceId: string
タイトル:
Process Instance ID
最大長:500
外部プロセスのプロセス・インスタンス識別子を示します。 -
ProcessStatus: string
タイトル:
Process Status
最大長:100
外部プロセスのステータス。 -
SkipFlag: boolean
タイトル:
Skip
最大長:1
デフォルト値:false
処理プランの処理をスキップできるかどうかを示します。 -
StartDate: string (date-time)
タイトル:
Start Date
アクション・プランのアクションが開始する日付。 -
StatusCd: string
タイトル:
Status
最大長:30
処理のステータスを示すコード。 有効な値のリストは、参照ORA_SVC_AP_STATUS_CDで定義されます。 -
StatusCdMeaning: string
タイトル:
Status Value
最大長:255
処理プラン処理のステータス参照コードに対応する表示値です。 -
StatusDetails: string
タイトル:
Status Details
最大長:1000
処理プランの処理ステータスの詳細。 -
TemplateId: integer (int64)
タイトル:
Template ID
処理の作成元である処理プラン・テンプレートの一意の識別子。 -
TemplateNumber: string
タイトル:
Template Number
最大長:30
処理プラン・テンプレートの参照番号。 -
TemplateTemplateId: integer (int64)
タイトル:
Template ID
読取り専用:true
テンプレートの一意の識別子。 -
UpdateFlag: boolean
読取り専用:
true
処理プランの処理を更新できるかどうかを示します。 -
VisibilityCd: string
タイトル:
Visibility
読取り専用:true
最大長:30
デフォルト値:ORA_SVC_NOT_PUBLISHED
アクションの表示レベルを示すコード。 有効な値のリストは、参照ORA_SVC_AP_VISIBILITY_CDで定義されます。 -
VisibilityCdMeaning: string
タイトル:
Visibility Value
最大長:255
処理プラン処理の表示参照コードに対応する表示値。
ネストされたスキーマ : 処理プラン処理関連
タイプ:
array
タイトル:
Action Plan Action Relations
アクション・プラン処理関係リソースは、アクション・プラン内のアクション間の関係を表示、作成、更新および削除するために使用されます。 アクション関係は、アクションが実行される順序を定義できます。
ソースを表示
ネストされたスキーマ : actionplans-actionPlanAction-actionPlanActionRelation-item-response
タイプ:
ソースを表示
object
-
ActionPlanActionId: integer (int64)
タイトル:
Action Plan Action ID
処理プランの処理の一意の識別子。 -
ActionPlanActionNumber: string
タイトル:
Action Plan Action Number
最大長:30
処理プラン参照番号。 -
ActionStatusCd: string
タイトル:
Action Status
最大長:30
デフォルト値:ORA_SVC_COMPLETED
処理関係の依存関係条件のステータスを示すコード。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
アクションの依存関係を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
アクション依存関係が作成された日時。 -
DeletedFlag: boolean
タイトル:
Deleted
最大長:1
デフォルト値:false
処理依存関係が削除されたかどうかを示します。 デフォルト値はfalseです。 -
DeleteFlag: boolean
読取り専用:
true
処理依存関係を削除できるかどうかを示します。 -
DepActionPlanActionId: integer (int64)
タイトル:
Dependent Action Plan Action ID
処理プラン内の依存処理の一意の識別子です。 -
DepActionPlanActionNumber: string
タイトル:
Dependent Action Plan Action Number
最大長:30
依存処理プラン参照番号。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
RelationId: integer (int64)
タイトル:
Relation ID
読取り専用:true
処理プランの処理間の関係の一意の識別子。 -
UpdateFlag: boolean
読取り専用:
true
処理依存関係を更新できるかどうかを示します。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- addActionToObject
-
オブジェクトに処理を追加し、処理プランを作成します。 処理および親ビジネス・オブジェクトは、処理番号、オブジェクト・タイプおよびオブジェクト番号によって入力で指定されます。
- addAdhocActiontoActionPlan
-
単一の処理プランまたは複数の処理プランにアドホック処理を追加します。 アクションおよびアクション・プランは、指定されたアクション・プラン番号およびアクション番号のリストで指定されます。
- getActionMappings
-
このメソッドを使用すると、特定の処理プランまたは処理プラン処理の属性マッピングを解決値とともに取得できます。
- getProcessAccessToken
-
このメソッドは、ログイン・ユーザーがPCインスタンスに接続するためのJWTトークンを取得するために使用されます。 このメソッドは、トークンを生成するためにVBCSからのみ使用する必要があります。
- processSignalObject
-
シグナルを介してすでに開始された処理プラン処理をリフレッシュします。
- recreateObjectForActionPlanAction
-
前のオーケストレーションで失敗した、対応する処理プラン処理(SR、タスク、アポイントメントなど)の基礎となるビジネス・オブジェクトを再作成します。
- refreshActionPlan
-
すでに開始されている処理プランをリフレッシュします。
- refreshActionPlanAction
-
すでに開始されている処理プラン処理をリフレッシュします。
- updateObjectDetailsToPlan
-
処理プランまたは処理プラン処理および関連日付の子オブジェクト識別子を更新します。 必要に応じて、リフレッシュ処理プランを実行します。
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのアクション・プランを取得する方法を示しています。
cURLコマンド
Command: curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actionplans
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [ { "ActionPlanId": 300100117572596, "ActualCompletionDate": null, "CalendarId": 300100028308361, "CreatedBy": "MHoope", "CreationDate": "2017-09-15T00:56:43.626+00:00", "DeletedFlag": false, "ExpectedCompletionDate": "2017-09-20T05:58:00+00:00", "InitialCompletionDate": "2017-09-16T02:57:00+00:00", "StartDate": "2017-09-15T00:56:50.553+00:00", "LastUpdateDate": "2017-09-15T02:53:23+00:00", "LastUpdateLogin": "592E32349F671673E0538E09F20ACE8A", "LastUpdatedBy": "SALES_ADMIN", "Name": null, "ObjectEntityName": "ServiceRequest", "ObjectId": 300100117572404, "UpdateFlag": true, "DeleteFlag": true, "links": [ ... ] }, { "ActionPlanId": 300100111080994, "ActualCompletionDate": null, "CalendarId": 300100028308361, "CreatedBy": "autoxtnapi90", "CreationDate": "2017-07-12T05:41:02+00:00", "DeletedFlag": false, "ExpectedCompletionDate": null, "InitialCompletionDate": null, "StartDate": null, "LastUpdateDate": "2017-07-12T05:41:02.006+00:00", "LastUpdateLogin": "541749F1C18D4646E0538E09F20AB723", "LastUpdatedBy": "autoxtnapi90", "Name": null, "ObjectEntityName": "ServiceRequest", "ObjectId": 300100111082917, "UpdateFlag": true, "DeleteFlag": true, "links": [ ... ] }, ...