機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 処理プラン

アクション・プランの取得

get

/crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

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

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

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : actionplans-item-response
タイプ: object
ソースを表示
  • タイトル: Action ID
    アクションの一意の識別子。
  • タイトル: Action Number
    処理の参照番号。
  • タイトル: Object Entity Subtype
    読取り専用: true
    最大長: 400
    アクションのオブジェクト・エンティティ・サブタイプを示します。
  • タイトル: Type
    読取り専用: true
    最大長: 400
    アクションのオブジェクト・エンティティ・タイプを示します。
  • タイトル: Action Object ID
    処理に関連付けられた一意のオブジェクト識別子。
  • タイトル: Action Object Reference Number
    最大長: 100
    処理に関連付けられたオブジェクトの参照番号。
  • Action Plan Actions
    タイトル: Action Plan Actions
    アクション・プラン・アクション・リソースは、アクション・プランの処理を表示、作成、更新および削除するために使用されます。 アクションは、アクション・プランのステップまたはシーケンスです。
  • タイトル: Action Plan ID
    読取り専用: true
    処理プランの一意の識別子。
  • タイトル: Action Plan Number
    最大長: 30
    処理プランの代替一意識別子。
  • タイトル: Action Plan Type Code
    最大長: 30
    デフォルト値: ORA_SVC_TEMPLATE
    処理プランのタイプ(テンプレート・ベースの処理プラン、PCSプロセス・ベースの処理プランなど)を示す参照コード。
  • タイトル: Action Plan Type Value
    読取り専用: true
    最大長: 255
    処理プランの処理プラン・タイプ参照コードに対応する表示値。
  • タイトル: Action Status Code
    最大長: 30
    処理のステータス。
  • タイトル: Action Status Code Meaning
    最大長: 255
    処理のステータス参照コードに対応する表示値。
  • タイトル: Actual Completion Date
    処理プランが実際に完了した日時。
  • タイトル: Additional Information
    最大長: 1000
    アクション・プラン・レコードに関する追加情報。
  • タイトル: Calendar ID
    処理プランに関連付けられたカレンダの一意の識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    処理プランを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    処理プランが作成された日時。
  • タイトル: Deleted
    最大長: 1
    デフォルト値: false
    処理プランが削除されたかどうかを示します。 デフォルト値はfalseです。
  • 読取り専用: true
    処理プランを削除できるかどうかを示します。
  • タイトル: Projected Completion Date
    処理プランが完了する日付。
  • タイトル: Initial Expected Completion Date
    処理プランの完了が予想された最初の日付。
  • タイトル: Last Refreshed Date
    アクション・プラン・ステータスが最後にリフレッシュされた日付。
  • タイトル: Last Updated Date
    読取り専用: true
    アクション・プランが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    アクション・プランを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    アクション・プランを最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Name
    最大長: 400
    アクション・プランを最後に更新したユーザーの名前。
  • タイトル: Object Entity Name
    最大長: 400
    処理プランに関連付けられた親エンティティ・オブジェクトの名前。
  • タイトル: Object Entity Name Value
    最大長: 255
    処理プランのオブジェクト・エンティティ名参照コードに対応する表示値。
  • タイトル: Object ID
    処理プランに関連付けられたオブジェクトの一意の識別子。
  • 処理プランのオブジェクト参照番号。
  • タイトル: Order Number
    処理プランのリスト内の処理プランの順序。
  • タイトル: Process Instance ID
    最大長: 500
    外部プロセスのプロセス・インスタンス識別子。
  • タイトル: Process Status
    最大長: 100
    外部プロセスのステータス。
  • タイトル: Schedule PUID
    読取り専用: true
    最大長: 120
    標準カバレッジ・スケジュールの公開一意識別子。
  • タイトル: Start Date
    アクション・プランが開始する日付。
  • 読取り専用: 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ステータスは、アクション・プランのすべてのアクションが完了したことを示します。
  • タイトル: 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ステータスは、アクション・プランのすべてのアクションが完了したことを示します。
  • タイトル: Status Value
    最大長: 255
    処理プランのステータス参照コードに対応する表示値。
  • タイトル: Status Details
    最大長: 1000
    処理プランのエラー・ステータスの説明。
  • タイトル: Template ID
    処理プランの作成元である処理プラン・テンプレートの一意の識別子。
  • タイトル: Template Number
    最大長: 30
    処理プラン・テンプレートの参照番号。
  • 読取り専用: true
    処理プランを更新できるかどうかを示します。
ネストされたスキーマ : 処理プラン処理
タイプ: array
タイトル: Action Plan Actions
アクション・プラン・アクション・リソースは、アクション・プランの処理を表示、作成、更新および削除するために使用されます。 アクションは、アクション・プランのステップまたはシーケンスです。
ソースを表示
ネストされたスキーマ : actionplans-actionPlanAction-item-response
タイプ: object
ソースを表示
  • タイトル: Description
    読取り専用: true
    最大長: 1000
    処理プランの処理の摘要。
  • タイトル: Action ID
    アクションの一意の識別子。
  • タイトル: Action
    読取り専用: true
    最大長: 400
    アクションの名前。
  • タイトル: Action Number
    処理プランの処理の参照番号。
  • タイトル: Action Plan Action ID
    読取り専用: true
    処理プランの処理の一意の識別子。
  • タイトル: Action Plan Action Number
    最大長: 30
    処理プラン処理の代替一意識別子。
  • Action Plan Action Relations
    タイトル: Action Plan Action Relations
    アクション・プラン処理関係リソースは、アクション・プラン内のアクション間の関係を表示、作成、更新および削除するために使用されます。 アクション関係は、アクションが実行される順序を定義できます。
  • タイトル: Action Plan ID
    処理プランの一意の識別子。
  • タイトル: Action Plan Number
    最大長: 30
    処理プラン参照番号。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    処理プランで処理を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    アクション・プランでアクションが作成された日時。
  • 読取り専用: true
    処理プランの処理が遅延しているかどうかを示します。
  • タイトル: Deleted
    最大長: 1
    デフォルト値: false
    処理プランの処理が削除されるかどうかを示します。 デフォルト値はfalseです。
  • 読取り専用: true
    処理プランの処理を削除できるかどうかを示します。
  • タイトル: End Date
    アクション・プランのアクションが終了する日付。
  • 読取り専用: true
    終了日を読み取り専用にするかどうかを示します。
  • タイトル: Expected Completion Date
    アクション・プランのアクションが完了する日付。
  • タイトル: Expected Start Date
    アクション・プランのアクションが開始される予定の日付。
  • タイトル: Last Update Date
    読取り専用: true
    アクション・プランで処理が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    アクション・プランの処理を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    アクション・プランのアクションを最後に更新したユーザーのログイン詳細。
  • タイトル: Duration
    アクションの完了に必要な推定時間。
  • タイトル: Duration Unit
    最大長: 30
    分、時間、日など、リード・タイムの測定単位。
  • タイトル: Lead Time Unit Value
    最大長: 255
    処理プラン処理のリード・タイム・ユニット参照コードに対応する表示値です。
  • Links
  • タイトル: Mandatory
    最大長: 1
    デフォルト値: true
    処理プランの処理が必須かどうかを示します。 デフォルト値はfalseです。
  • タイトル: Entity Name
    読取り専用: true
    最大長: 400
    アクションの基になる親エンティティ・オブジェクトの名前。
  • タイトル: Object Entity Name Value
    最大長: 255
    処理プラン処理のオブジェクト・エンティティ名参照コードに対応する表示値。
  • タイトル: Object Entity Subtype
    読取り専用: true
    最大長: 400
    処理プランの処理のオブジェクト・エンティティ・サブタイプを示します。
  • タイトル: Type
    読取り専用: true
    最大長: 400
    アクションの基になる親エンティティ・オブジェクトのタイプ。
  • タイトル: Object Entity Type Value
    最大長: 255
    処理プラン処理のオブジェクト・エンティティ・タイプ参照コードに対応する表示値。
  • タイトル: Object ID
    アクションに関連付けられたオブジェクトの一意の識別子。
  • タイトル: Object Reference Number
    最大長: 100
    処理に関連付けられたオブジェクトの参照番号。
  • タイトル: Step
    アクション・プランでのアクションの順序。
  • タイトル: Owner
    読取り専用: true
    アクションの所有者の名前。
  • タイトル: Prerequisites
    読取り専用: true
    アクションを開始するために必要な前提条件ステップ。
  • タイトル: Process Instance ID
    最大長: 500
    外部プロセスのプロセス・インスタンス識別子を示します。
  • タイトル: Process Status
    最大長: 100
    外部プロセスのステータス。
  • タイトル: Skip
    最大長: 1
    デフォルト値: false
    処理プランの処理をスキップできるかどうかを示します。
  • タイトル: Start Date
    アクション・プランのアクションが開始する日付。
  • タイトル: Status
    最大長: 30
    処理のステータスを示すコード。 有効な値のリストは、参照ORA_SVC_AP_STATUS_CDで定義されます。
  • タイトル: Status Value
    最大長: 255
    処理プラン処理のステータス参照コードに対応する表示値です。
  • タイトル: Status Details
    最大長: 1000
    処理プランの処理ステータスの詳細。
  • タイトル: Template ID
    処理の作成元である処理プラン・テンプレートの一意の識別子。
  • タイトル: Template Number
    最大長: 30
    処理プラン・テンプレートの参照番号。
  • タイトル: Template ID
    読取り専用: true
    テンプレートの一意の識別子。
  • 読取り専用: true
    処理プランの処理を更新できるかどうかを示します。
  • タイトル: Visibility
    読取り専用: true
    最大長: 30
    デフォルト値: ORA_SVC_NOT_PUBLISHED
    アクションの表示レベルを示すコード。 有効な値のリストは、参照ORA_SVC_AP_VISIBILITY_CDで定義されます。
  • タイトル: Visibility Value
    最大長: 255
    処理プラン処理の表示参照コードに対応する表示値。
ネストされたスキーマ : 処理プラン処理関連
タイプ: array
タイトル: Action Plan Action Relations
アクション・プラン処理関係リソースは、アクション・プラン内のアクション間の関係を表示、作成、更新および削除するために使用されます。 アクション関係は、アクションが実行される順序を定義できます。
ソースを表示
ネストされたスキーマ : actionplans-actionPlanAction-actionPlanActionRelation-item-response
タイプ: object
ソースを表示
  • タイトル: Action Plan Action ID
    処理プランの処理の一意の識別子。
  • タイトル: Action Plan Action Number
    最大長: 30
    処理プラン参照番号。
  • タイトル: Action Status
    最大長: 30
    デフォルト値: ORA_SVC_COMPLETED
    処理関係の依存関係条件のステータスを示すコード。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    アクションの依存関係を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    アクション依存関係が作成された日時。
  • タイトル: Deleted
    最大長: 1
    デフォルト値: false
    処理依存関係が削除されたかどうかを示します。 デフォルト値はfalseです。
  • 読取り専用: true
    処理依存関係を削除できるかどうかを示します。
  • タイトル: Dependent Action Plan Action ID
    処理プラン内の依存処理の一意の識別子です。
  • タイトル: Dependent Action Plan Action Number
    最大長: 30
    依存処理プラン参照番号。
  • タイトル: Last Update Date
    読取り専用: true
    アクションの依存関係が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    アクションの依存関係を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    アクションの依存関係を最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Relation ID
    読取り専用: true
    処理プランの処理間の関係の一意の識別子。
  • 読取り専用: true
    処理依存関係を更新できるかどうかを示します。
リンク
ActionPlanTypeLookup
パラメータ:
  • ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_ACTION_PLAN_TYPE
値リスト処理プランのタイプがテンプレートかプロセス・クラウド・プロセスかを示します。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: ActionPlanTypeCd;ターゲット属性: LookupCode
  • 表示属性: 意味
ActionStatusCdLookup
パラメータ:
  • ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_STATUS_CD
処理のステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: ActionStatusCd;ターゲット属性: LookupCode
  • 表示属性: 意味
ObjectEntityNameLookup
パラメータ:
  • ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_PARENT_ENTITY_NAME
処理プラン・オブジェクトの親エンティティ名がケースかサービス・リクエストかを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: ObjectEntityName;ターゲット属性: LookupCode
  • 表示属性: 意味
StatusCdLookup
パラメータ:
  • ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_PROCESS_CD
処理プランのステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: StatusCd;ターゲット属性: LookupCode
  • 表示属性: 意味
YesNoLookup
パラメータ:
  • ファインダ: LookupTypeFinder
処理プランが削除されたかどうかを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: DeletedFlag;ターゲット属性: LookupCode
  • 表示属性: 意味
actionPlanAction
パラメータ:
  • ActionPlanId: $request.path.ActionPlanId
アクション・プラン・アクション・リソースは、アクション・プランの処理を表示、作成、更新および削除するために使用されます。 アクションは、アクション・プランのステップまたはシーケンスです。
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
"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": [
 ...
 ]
}
「トップに戻る」