機械翻訳について

ジャンプ先

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

処理プランの更新

patch

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

リクエスト

パス・パラメータ

• ActionPlanId(required): integer(int64)
  処理プランの一意の識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• ActionObjectId: integer (int64)
  タイトル: Action Object ID

  処理に関連付けられた一意のオブジェクト識別子。
• ActionObjectReferenceNumber: string
  タイトル: Action Object Reference Number

  最大長: 100

  処理に関連付けられたオブジェクトの参照番号。
• actionPlanAction: array Action Plan Actions
  タイトル: Action Plan Actions

  アクション・プラン・アクション・リソースは、アクション・プランの処理を表示、作成、更新および削除するために使用されます。 アクションは、アクション・プランのステップまたはシーケンスです。
• 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

  処理プランに関連付けられたカレンダの一意の識別子。
• DeletedFlag: boolean
  タイトル: Deleted

  最大長: 1

  デフォルト値: false

  処理プランが削除されたかどうかを示します。 デフォルト値はfalseです。
• ExpectedCompletionDate: string (date-time)
  タイトル: Projected Completion Date

  処理プランが完了する日付。
• InitialCompletionDate: string (date-time)
  タイトル: Initial Expected Completion Date

  処理プランの完了が予想された最初の日付。
• LastRefreshedDate: string (date-time)
  タイトル: Last Refreshed Date

  アクション・プラン・ステータスが最後にリフレッシュされた日付。
• Name: string
  タイトル: Name

  最大長: 400

  アクション・プランを最後に更新したユーザーの名前。
• ObjectEntityNameMeaning: string
  タイトル: Object Entity Name Value

  最大長: 255

  処理プランのオブジェクト・エンティティ名参照コードに対応する表示値。
• OrderNumber: integer (int64)
  タイトル: Order Number

  処理プランのリスト内の処理プランの順序。
• ProcessInstanceId: string
  タイトル: Process Instance ID

  最大長: 500

  外部プロセスのプロセス・インスタンス識別子。
• ProcessStatus: string
  タイトル: Process Status

  最大長: 100

  外部プロセスのステータス。
• StartDate: string (date-time)
  タイトル: Start Date

  アクション・プランが開始する日付。
• 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

  処理プランの作成元である処理プラン・テンプレートの一意の識別子。

{
    "type":"object",
    "properties":{
        "AdditionalInformation":{
            "title":"Additional Information",
            "maxLength":1000,
            "type":"string",
            "description":"The additional information about the action plan record.",
            "nullable":true
        },
        "ActionObjectReferenceNumber":{
            "title":"Action Object Reference Number",
            "maxLength":100,
            "type":"string",
            "description":"The reference number of the object associated with the action.",
            "nullable":true
        },
        "ExpectedCompletionDate":{
            "title":"Projected Completion Date",
            "type":"string",
            "description":"The date when the action plan is to be completed.",
            "format":"date-time",
            "nullable":true
        },
        "ActionStatusCdMeaning":{
            "title":"Action Status Code Meaning",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionStatusCd"
                ]
            }
        },
        "ProcessStatus":{
            "title":"Process Status",
            "maxLength":100,
            "type":"string",
            "description":"The status of the external process.",
            "nullable":true
        },
        "CalendarId":{
            "title":"Calendar ID",
            "type":"integer",
            "description":"The unique identifier of the calendar associated with the action plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the action, such as ORA_SVC_CREATE,  ORA_SVC_IN_PROGRESS, ORA_SVC_COMPLETED, or ORA_SVC_ERROR. The ORA_SVC_CREATE status indicates that the required child records for the action plan based on its assigned template is created, and the status changes to ORA_SVC_CREATED.\nThe ORA_SVC_CREATED status indicates that all the child action plan actions are created but the overall plan is not yet\nstarted.\nThe ORA_SVC_INITIATE status indicates that the action plan is initiated, and if successful, the status is changed to ORA_SVC_IN_PROGRESS.\nThe ORA_SVC_CREATE_AND_INITIATE status indicates that the child plan actions are created and action plan is initiated. The ORA_SVC_CREATE_AND_INITIATE status skips the intermediate ORA_SVC_CREATED status.\nThe ORA_SVC_INITIATING status indicates that the action plan initiate process has started. The action plan status changes to ORA_SVC_IN_PROGRESS if it is able to successfully create underlying objects.\nIf there is a failure in creating underlying objects, then the status changes to ORA_SVC_ERROR. For the ORA_SVC_ERROR status, the error details are stored in 'Status Details??? attribute of either 'action plan' object or its child ???action plan action' object.\nThe ORA_SVC_COMPLETED status indicates that all actions in the action plan are complete.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the action plan.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            }
        },
        "OrderNumber":{
            "title":"Order Number",
            "type":"integer",
            "description":"The order of the action plan in the list of action plans.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectEntityNameMeaning":{
            "title":"Object Entity Name Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the object entity name lookup code for the action plan.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityName"
                ]
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the user who last updated the action plan.",
            "nullable":true
        },
        "InitialCompletionDate":{
            "title":"Initial Expected Completion Date",
            "type":"string",
            "description":"The initial date when the action plan was expected to be completed.",
            "format":"date-time",
            "nullable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the action plan starts.",
            "format":"date-time",
            "nullable":true
        },
        "ActionStatusCd":{
            "title":"Action Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status of the action.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActionObjectId":{
            "title":"Action Object ID",
            "type":"integer",
            "description":"The unique object identifier associated with the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action plan is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusDetails":{
            "title":"Status Details",
            "maxLength":1000,
            "type":"string",
            "description":"The explanation of the error status of the action plan.",
            "nullable":true
        },
        "actionPlanAction":{
            "title":"Action Plan Actions",
            "type":"array",
            "description":"The actions plan actions resource is used to view, create, update, and delete the actions in an action plan. An action is a step or a sequence in an action plan.",
            "items":{
                "$ref":"#/components/schemas/actionplans-actionPlanAction-item-patch-request"
            }
        },
        "ProcessInstanceId":{
            "title":"Process Instance ID",
            "maxLength":500,
            "type":"string",
            "description":"The process instance identifier from of an external process.",
            "nullable":true
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"The date and time when the action plan was actually completed.",
            "format":"date-time",
            "nullable":true
        },
        "LastRefreshedDate":{
            "title":"Last Refreshed Date",
            "type":"string",
            "description":"The date when the action plan status was last refreshed.",
            "format":"date-time",
            "nullable":true
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of the action plan template from which the action plan is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

ネストされたスキーマ : 処理プラン処理

タイプ: array

タイトル: Action Plan Actions

アクション・プラン・アクション・リソースは、アクション・プランの処理を表示、作成、更新および削除するために使用されます。 アクションは、アクション・プランのステップまたはシーケンスです。

ソースを表示

• Array of: object schema

{
    "title":"Action Plan Actions",
    "type":"array",
    "description":"The actions plan actions resource is used to view, create, update, and delete the actions in an action plan. An action is a step or a sequence in an action plan.",
    "items":{
        "$ref":"#/components/schemas/actionplans-actionPlanAction-item-patch-request"
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

• ActionId: integer (int64)
  タイトル: Action ID

  アクションの一意の識別子。
• ActionNumber: string
  タイトル: Action Number

  処理プランの処理の参照番号。
• actionPlanActionRelation: array Action Plan Action Relations
  タイトル: Action Plan Action Relations

  アクション・プラン処理関係リソースは、アクション・プラン内のアクション間の関係を表示、作成、更新および削除するために使用されます。 アクション関係は、アクションが実行される順序を定義できます。
• ActionPlanId: integer (int64)
  タイトル: Action Plan ID

  処理プランの一意の識別子。
• DeletedFlag: boolean
  タイトル: Deleted

  最大長: 1

  デフォルト値: false

  処理プランの処理が削除されるかどうかを示します。 デフォルト値はfalseです。
• EndDate: string (date-time)
  タイトル: End Date

  アクション・プランのアクションが終了する日付。
• ExpectedCompletionDate: string (date-time)
  タイトル: Expected Completion Date

  アクション・プランのアクションが完了する日付。
• ExpectedStartDate: string (date-time)
  タイトル: Expected Start Date

  アクション・プランのアクションが開始される予定の日付。
• LeadTime: integer (int64)
  タイトル: Duration

  アクションの完了に必要な推定時間。
• LeadTimeUnit: string
  タイトル: Duration Unit

  最大長: 30

  分、時間、日など、リード・タイムの測定単位。
• LeadTimeUnitMeaning: string
  タイトル: Lead Time Unit Value

  最大長: 255

  処理プラン処理のリード・タイム・ユニット参照コードに対応する表示値です。
• ObjectEntityNameMeaning: string
  タイトル: Object Entity Name Value

  最大長: 255

  処理プラン処理のオブジェクト・エンティティ名参照コードに対応する表示値。
• ObjectEntityTypeMeaning: string
  タイトル: Object Entity Type Value

  最大長: 255

  処理プラン処理のオブジェクト・エンティティ・タイプ参照コードに対応する表示値。
• ObjectId: integer (int64)
  タイトル: Object ID

  アクションに関連付けられたオブジェクトの一意の識別子。
• ObjectReferenceNumber: string
  タイトル: Object Reference Number

  最大長: 100

  処理に関連付けられたオブジェクトの参照番号。
• OrderNumber: integer (int64)
  タイトル: Step

  アクション・プランでのアクションの順序。
• 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

  処理プランの処理ステータスの詳細。
• VisibilityCdMeaning: string
  タイトル: Visibility Value

  最大長: 255

  処理プラン処理の表示参照コードに対応する表示値。

{
    "type":"object",
    "properties":{
        "ActionPlanId":{
            "title":"Action Plan ID",
            "type":"integer",
            "description":"The unique identifier of the action plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LeadTimeUnit":{
            "title":"Duration Unit",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measurement of the lead time, such as minutes, hours, or days.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExpectedCompletionDate":{
            "title":"Expected Completion Date",
            "type":"string",
            "description":"The date when the action in an action plan is to be completed.",
            "format":"date-time",
            "nullable":true
        },
        "VisibilityCdMeaning":{
            "title":"Visibility Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the visibility lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VisibilityCd"
                ]
            }
        },
        "ExpectedStartDate":{
            "title":"Expected Start Date",
            "type":"string",
            "description":"The date when an action in the action plan is expected to start.",
            "format":"date-time",
            "nullable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProcessStatus":{
            "title":"Process Status",
            "maxLength":100,
            "type":"string",
            "description":"The status of the external process.",
            "nullable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the action. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            }
        },
        "ObjectEntityTypeMeaning":{
            "title":"Object Entity Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the object entity type lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityType"
                ]
            }
        },
        "ObjectReferenceNumber":{
            "title":"Object Reference Number",
            "maxLength":100,
            "type":"string",
            "description":"The reference number of the object associated with the action.",
            "nullable":true
        },
        "OrderNumber":{
            "title":"Step",
            "type":"integer",
            "description":"The order of the action in an action plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when an action in the action plan ends.",
            "format":"date-time",
            "nullable":true
        },
        "ActionNumber":{
            "title":"Action Number",
            "type":"string",
            "description":"The reference number of the action in an action plan.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectEntityNameMeaning":{
            "title":"Object Entity Name Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the object entity name lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityName"
                ]
            }
        },
        "actionPlanActionRelation":{
            "title":"Action Plan Action Relations",
            "type":"array",
            "description":"The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.",
            "items":{
                "$ref":"#/components/schemas/actionplans-actionPlanAction-actionPlanActionRelation-item-patch-request"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when an action in the action plan begins.",
            "format":"date-time",
            "nullable":true
        },
        "ActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LeadTime":{
            "title":"Duration",
            "type":"integer",
            "description":"The estimated time required to complete the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action in an action plan is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusDetails":{
            "title":"Status Details",
            "maxLength":1000,
            "type":"string",
            "description":"The details of the status of an action in an action plan.",
            "nullable":true
        },
        "ProcessInstanceId":{
            "title":"Process Instance ID",
            "maxLength":500,
            "type":"string",
            "description":"Indicates the process instance identifier of an external process.",
            "nullable":true
        },
        "LeadTimeUnitMeaning":{
            "title":"Lead Time Unit Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the lead time unit lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LeadTimeUnit"
                ]
            }
        },
        "SkipFlag":{
            "title":"Skip",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action for the action plan can be skipped.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        }
    }
}

ネストされたスキーマ : 処理プラン処理関連

タイプ: array

タイトル: Action Plan Action Relations

アクション・プラン処理関係リソースは、アクション・プラン内のアクション間の関係を表示、作成、更新および削除するために使用されます。 アクション関係は、アクションが実行される順序を定義できます。

ソースを表示

• Array of: object schema

{
    "title":"Action Plan Action Relations",
    "type":"array",
    "description":"The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.",
    "items":{
        "$ref":"#/components/schemas/actionplans-actionPlanAction-actionPlanActionRelation-item-patch-request"
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

• ActionPlanActionId: integer (int64)
  タイトル: Action Plan Action ID

  処理プランの処理の一意の識別子。
• ActionStatusCd: string
  タイトル: Action Status

  最大長: 30

  デフォルト値: ORA_SVC_COMPLETED

  処理関係の依存関係条件のステータスを示すコード。
• DeletedFlag: boolean
  タイトル: Deleted

  最大長: 1

  デフォルト値: false

  処理依存関係が削除されたかどうかを示します。 デフォルト値はfalseです。
• DepActionPlanActionId: integer (int64)
  タイトル: Dependent Action Plan Action ID

  処理プラン内の依存処理の一意の識別子です。

{
    "type":"object",
    "properties":{
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action dependency is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DepActionPlanActionId":{
            "title":"Dependent Action Plan Action ID",
            "type":"integer",
            "description":"The unique identifier of the dependent action in an action plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the dependency condition of the action relation.",
            "nullable":true,
            "default":"ORA_SVC_COMPLETED"
        },
        "ActionPlanActionId":{
            "title":"Action Plan Action ID",
            "type":"integer",
            "description":"The unique identifier of the action in an action plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : 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

  処理プランを更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the action plan was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionPlanId":{
            "title":"Action Plan ID",
            "type":"integer",
            "description":"The unique identifier of the action plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionStatusCdMeaning":{
            "title":"Action Status Code Meaning",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionStatusCd"
                ]
            },
            "x-queryable":true
        },
        "ProcessStatus":{
            "title":"Process Status",
            "maxLength":100,
            "type":"string",
            "description":"The status of the external process.",
            "nullable":true,
            "x-queryable":true
        },
        "CalendarId":{
            "title":"Calendar ID",
            "type":"integer",
            "description":"The unique identifier of the calendar associated with the action plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionPlanTypeCd":{
            "title":"Action Plan Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Lookup code that indicates the type of action plan, such as Template based Action Plan, or PCS process based Action Plan.",
            "nullable":false,
            "default":"ORA_SVC_TEMPLATE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActionObjectEntityType":{
            "title":"Type",
            "maxLength":400,
            "type":"string",
            "description":"Indicates the object entity type of the action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectEntityName":{
            "title":"Object Entity Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the parent entity object associated with the action plan.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Order Number",
            "type":"integer",
            "description":"The order of the action plan in the list of action plans.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionNumber":{
            "title":"Action Number",
            "type":"string",
            "description":"The reference number of the action.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectEntityNameMeaning":{
            "title":"Object Entity Name Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the object entity name lookup code for the action plan.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityName"
                ]
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the user who last updated the action plan.",
            "nullable":true,
            "x-queryable":true
        },
        "InitialCompletionDate":{
            "title":"Initial Expected Completion Date",
            "type":"string",
            "description":"The initial date when the action plan was expected to be completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the action plan starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action plan can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionStatusCd":{
            "title":"Action Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status of the action.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActionObjectEntitySubtype":{
            "title":"Object Entity Subtype",
            "maxLength":400,
            "type":"string",
            "description":"Indicates the object entity subtype of the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "actionPlanAction":{
            "title":"Action Plan Actions",
            "type":"array",
            "description":"The actions plan actions resource is used to view, create, update, and delete the actions in an action plan. An action is a step or a sequence in an action plan.",
            "items":{
                "$ref":"#/components/schemas/actionplans-actionPlanAction-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"The date and time when the action plan was actually completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of the action plan template from which the action plan is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"The status of the action plan, such as ORA_SVC_CREATE,  ORA_SVC_IN_PROGRESS, ORA_SVC_COMPLETED, or ORA_SVC_ERROR. The ORA_SVC_CREATE status indicates that the required child records for the action plan based on its assigned template is created, and the status changes to ORA_SVC_CREATED.\nThe ORA_SVC_CREATED status indicates that all the child action plan actions are created but the overall plan is not yet\nstarted.\nThe ORA_SVC_INITIATE status indicates that the action plan is initiated, and if successful, the status is changed to ORA_SVC_IN_PROGRESS.\nThe ORA_SVC_CREATE_AND_INITIATE status indicates that the child plan actions are created and action plan is initiated. The ORA_SVC_CREATE_AND_INITIATE status skips the intermediate ORA_SVC_CREATED status.\nThe ORA_SVC_INITIATING status indicates that the action plan initiate process has started. The action plan status changes to ORA_SVC_IN_PROGRESS if it is able to successfully create underlying objects.\nIf there is a failure in creating underlying objects, then the status changes to ORA_SVC_ERROR. For the ORA_SVC_ERROR status, the error details are stored in 'Status Details??? attribute of either 'action plan' object or its child ???action plan action' object.\nThe ORA_SVC_COMPLETED status indicates that all actions in the action plan are complete.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalInformation":{
            "title":"Additional Information",
            "maxLength":1000,
            "type":"string",
            "description":"The additional information about the action plan record.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionObjectReferenceNumber":{
            "title":"Action Object Reference Number",
            "maxLength":100,
            "type":"string",
            "description":"The reference number of the object associated with the action.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedCompletionDate":{
            "title":"Projected Completion Date",
            "type":"string",
            "description":"The date when the action plan is to be completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectNumber":{
            "type":"string",
            "description":"The object reference number of the action plan.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the action plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the action, such as ORA_SVC_CREATE,  ORA_SVC_IN_PROGRESS, ORA_SVC_COMPLETED, or ORA_SVC_ERROR. The ORA_SVC_CREATE status indicates that the required child records for the action plan based on its assigned template is created, and the status changes to ORA_SVC_CREATED.\nThe ORA_SVC_CREATED status indicates that all the child action plan actions are created but the overall plan is not yet\nstarted.\nThe ORA_SVC_INITIATE status indicates that the action plan is initiated, and if successful, the status is changed to ORA_SVC_IN_PROGRESS.\nThe ORA_SVC_CREATE_AND_INITIATE status indicates that the child plan actions are created and action plan is initiated. The ORA_SVC_CREATE_AND_INITIATE status skips the intermediate ORA_SVC_CREATED status.\nThe ORA_SVC_INITIATING status indicates that the action plan initiate process has started. The action plan status changes to ORA_SVC_IN_PROGRESS if it is able to successfully create underlying objects.\nIf there is a failure in creating underlying objects, then the status changes to ORA_SVC_ERROR. For the ORA_SVC_ERROR status, the error details are stored in 'Status Details??? attribute of either 'action plan' object or its child ???action plan action' object.\nThe ORA_SVC_COMPLETED status indicates that all actions in the action plan are complete.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the action plan.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            },
            "x-queryable":true
        },
        "TemplateNumber":{
            "title":"Template Number",
            "maxLength":30,
            "type":"string",
            "description":"The reference number of the action plan template.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action plan can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionPlanNumber":{
            "title":"Action Plan Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of an action plan.",
            "nullable":false,
            "x-queryable":true
        },
        "ActionObjectId":{
            "title":"Action Object ID",
            "type":"integer",
            "description":"The unique object identifier associated with the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action plan is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusDetails":{
            "title":"Status Details",
            "maxLength":1000,
            "type":"string",
            "description":"The explanation of the error status of the action plan.",
            "nullable":true,
            "x-queryable":true
        },
        "SchedulePuid":{
            "title":"Schedule PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of a standard coverage schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessInstanceId":{
            "title":"Process Instance ID",
            "maxLength":500,
            "type":"string",
            "description":"The process instance identifier from of an external process.",
            "nullable":true,
            "x-queryable":true
        },
        "LastRefreshedDate":{
            "title":"Last Refreshed Date",
            "type":"string",
            "description":"The date when the action plan status was last refreshed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActionPlanTypeCdMeaning":{
            "title":"Action Plan Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the action plan type lookup code for the action plan.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ActionPlanTypeCd"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the action plan 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 details of the user who last updated the action plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 処理プラン処理

タイプ: array

タイトル: Action Plan Actions

アクション・プラン・アクション・リソースは、アクション・プランの処理を表示、作成、更新および削除するために使用されます。 アクションは、アクション・プランのステップまたはシーケンスです。

ソースを表示

• Array of: object actionplans-actionPlanAction-item-response

{
    "title":"Action Plan Actions",
    "type":"array",
    "description":"The actions plan actions resource is used to view, create, update, and delete the actions in an action plan. An action is a step or a sequence in an action plan.",
    "items":{
        "$ref":"#/components/schemas/actionplans-actionPlanAction-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"
    }
}

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

  処理プラン処理の表示参照コードに対応する表示値。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the action was created in an action plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionPlanId":{
            "title":"Action Plan ID",
            "type":"integer",
            "description":"The unique identifier of the action plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeadTimeUnit":{
            "title":"Duration Unit",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measurement of the lead time, such as minutes, hours, or days.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExpectedStartDate":{
            "title":"Expected Start Date",
            "type":"string",
            "description":"The date when an action in the action plan is expected to start.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectEntityName":{
            "title":"Entity Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the parent entity object on which the action is based.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Step",
            "type":"integer",
            "description":"The order of the action in an action plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionNumber":{
            "title":"Action Number",
            "type":"string",
            "description":"The reference number of the action in an action plan.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectEntityNameMeaning":{
            "title":"Object Entity Name Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the object entity name lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityName"
                ]
            },
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action in an action plan is mandatory. The default value is false.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "Prerequisites":{
            "title":"Prerequisites",
            "type":"string",
            "description":"The prerequisite steps required to initiate the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when an action in the action plan begins.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActionPlanActionId":{
            "title":"Action Plan Action ID",
            "type":"integer",
            "description":"The unique identifier of the action in an action plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateTemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of a template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "ObjectEntitySubtype":{
            "title":"Object Entity Subtype",
            "maxLength":400,
            "type":"string",
            "description":"Indicates the object entity subtype of the action in the action plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SkipFlag":{
            "title":"Skip",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action for the action plan can be skipped.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action in an action plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action in an action plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedCompletionDate":{
            "title":"Expected Completion Date",
            "type":"string",
            "description":"The date when the action in an action plan is to be completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            },
            "x-queryable":true
        },
        "EndDateReadOnlyFlag":{
            "type":"boolean",
            "description":"Indicates whether the end date should be read only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateNumber":{
            "title":"Template Number",
            "maxLength":30,
            "type":"string",
            "description":"The reference number of the action plan template.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action in an action plan can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "actionPlanActionRelation":{
            "title":"Action Plan Action Relations",
            "type":"array",
            "description":"The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.",
            "items":{
                "$ref":"#/components/schemas/actionplans-actionPlanAction-actionPlanActionRelation-item-response"
            }
        },
        "ActionName":{
            "title":"Action",
            "maxLength":400,
            "type":"string",
            "description":"The name of the action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeadTime":{
            "title":"Duration",
            "type":"integer",
            "description":"The estimated time required to complete the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectEntityType":{
            "title":"Type",
            "maxLength":400,
            "type":"string",
            "description":"The type of the parent entity object on which the action is based.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action in an action plan is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusDetails":{
            "title":"Status Details",
            "maxLength":1000,
            "type":"string",
            "description":"The details of the status of an action in an action plan.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadTimeUnitMeaning":{
            "title":"Lead Time Unit Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the lead time unit lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LeadTimeUnit"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the action in an action plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner",
            "type":"string",
            "description":"The name of the owner of the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessStatus":{
            "title":"Process Status",
            "maxLength":100,
            "type":"string",
            "description":"The status of the external process.",
            "nullable":true,
            "x-queryable":true
        },
        "VisibilityCd":{
            "title":"Visibility",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the visibility level of the action. A list of valid values is defined in the lookup ORA_SVC_AP_VISIBILITY_CD.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_NOT_PUBLISHED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action in an action plan can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of the action plan template from which the action is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionPlanActionNumber":{
            "title":"Action Plan Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of an action plan action.",
            "nullable":false,
            "x-queryable":true
        },
        "VisibilityCdMeaning":{
            "title":"Visibility Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the visibility lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VisibilityCd"
                ]
            },
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the action. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectEntityTypeMeaning":{
            "title":"Object Entity Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the object entity type lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityType"
                ]
            },
            "x-queryable":true
        },
        "ObjectReferenceNumber":{
            "title":"Object Reference Number",
            "maxLength":100,
            "type":"string",
            "description":"The reference number of the object associated with the action.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when an action in the action plan ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActionPlanNumber":{
            "title":"Action Plan Number",
            "maxLength":30,
            "type":"string",
            "description":"The action plan reference number.",
            "nullable":false,
            "x-queryable":true
        },
        "ActionDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of an action in an action plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelayedFlag":{
            "type":"boolean",
            "description":"Indicates whether the action in an action plan is delayed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "EndDate",
                    "StartDate",
                    "StatusCd"
                ]
            },
            "x-queryable":true
        },
        "ProcessInstanceId":{
            "title":"Process Instance ID",
            "maxLength":500,
            "type":"string",
            "description":"Indicates the process instance identifier of an external process.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the action was last updated in an action plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 処理プラン処理関連

タイプ: array

タイトル: Action Plan Action Relations

アクション・プラン処理関係リソースは、アクション・プラン内のアクション間の関係を表示、作成、更新および削除するために使用されます。 アクション関係は、アクションが実行される順序を定義できます。

ソースを表示

• Array of: object actionplans-actionPlanAction-actionPlanActionRelation-item-response

{
    "title":"Action Plan Action Relations",
    "type":"array",
    "description":"The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.",
    "items":{
        "$ref":"#/components/schemas/actionplans-actionPlanAction-actionPlanActionRelation-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"
    }
}

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

  処理依存関係を更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the dependencies of action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the action dependency was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionPlanActionNumber":{
            "title":"Action Plan Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The action plan reference number.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the dependencies of an action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepActionPlanActionNumber":{
            "title":"Dependent Action Plan Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The dependent action plan reference number.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action dependency can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action dependency can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DepActionPlanActionId":{
            "title":"Dependent Action Plan Action ID",
            "type":"integer",
            "description":"The unique identifier of the dependent action in an action plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the dependency condition of the action relation.",
            "nullable":true,
            "default":"ORA_SVC_COMPLETED",
            "x-queryable":true
        },
        "ActionPlanActionId":{
            "title":"Action Plan Action ID",
            "type":"integer",
            "description":"The unique identifier of the action in an action plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationId":{
            "title":"Relation ID",
            "type":"integer",
            "description":"The unique identifier of the relation between actions in an action plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action dependency is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the action dependency 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 details of the user who last updated the dependencies of action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

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

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

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

リンク

ActionPlanTypeLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_ACTION_PLAN_TYPE

値リスト処理プランのタイプがテンプレートかプロセス・クラウド・プロセスかを示します。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: ActionPlanTypeCd;ターゲット属性: LookupCode
• 表示属性: 意味

ActionStatusCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_STATUS_CD

処理のステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: ActionStatusCd;ターゲット属性: LookupCode
• 表示属性: 意味

ObjectEntityNameLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_PARENT_ENTITY_NAME

処理プラン・オブジェクトの親エンティティ名がケースかサービス・リクエストかを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: ObjectEntityName;ターゲット属性: LookupCode
• 表示属性: 意味

StatusCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_PROCESS_CD

処理プランのステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: StatusCd;ターゲット属性: LookupCode
• 表示属性: 意味

YesNoLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder

処理プランが削除されたかどうかを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: DeletedFlag;ターゲット属性: LookupCode
• 表示属性: 意味

actionPlanAction

操作: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction

パラメータ:

• ActionPlanId: $request.path.ActionPlanId

アクション・プラン・アクション・リソースは、アクション・プランの処理を表示、作成、更新および削除するために使用されます。 アクションは、アクション・プランのステップまたはシーケンスです。

トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actionplans/300100118916660

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
"Name":"patched action Plan"
}

レスポンス本文の例

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

"ActionPlanId": 300100118916660,
"ActualCompletionDate": null,
"CalendarId": 300100028308361,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2017-09-27T13:53:25+00:00",
"DeletedFlag": false,
"ExpectedCompletionDate": null,
"InitialCompletionDate": null,
"StartDate": null,
"LastUpdateDate": "2017-09-27T13:56:07+00:00",
"LastUpdateLogin": "5A2BD805BC436ED2E0538E09F20A9D1F",
"LastUpdatedBy": "SALES_ADMIN",
"Name": "patched action Plan",
"ObjectEntityName": "ServiceRequest",
"ObjectId": 300100090946752,
"UpdateFlag": true,
"DeleteFlag": true,
"links": [
 ...
 ]
}

「トップに戻る」