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

機械翻訳について

すべての処理プラン処理の取得

get

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

リクエスト

パス・パラメータ

ActionPlanId(required): integer(int64)

処理プランの一意の識別子。

問合せパラメータ

dependency: string

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

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

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

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

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

使用可能なファインダ名および対応するファインダ変数を次に示します:
- PrimaryKey : 指定した主キーを持つ処理プラン処理を検索します。
  ファインダ変数:
  - ActionPlanActionId; integer; アクション・プラン・アクションの一意の識別子。
limit: integer

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

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

例:
self,canonical
offset: integer

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

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

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

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

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- ActionDescription; string;アクション・プラン内のアクションの説明。
- ActionId; integer; アクションの一意の識別子。
- ActionName; string;アクションの名前。
- ActionPlanActionId; integer; アクション・プラン内のアクションの一意の識別子。
- ActionPlanActionNumber; string; アクション・プラン・アクションの代替の一意の識別子。
- ActionPlanId; integer;アクション・プランの一意の識別子。
- ActionPlanNumber; string;アクション・プラン参照番号。
- CreatedBy; string; アクション・プランでアクションを作成したユーザー。
- CreationDate; string; アクションがアクション・プランで作成された日時。
- DelayedFlag; boolean。アクション・プランのアクションが遅延しているかどうかを示します。
- DeletedFlag; boolean。アクション・プランのアクションが削除されるかどうかを示します。デフォルト値はfalseです。
- EndDate; string; アクション・プランのアクションが終了する日付。
- EndDateReadOnlyFlag; boolean;終了日を読み取り専用にするかどうかを示します。
- ExpectedCompletionDate; string; アクション・プランのアクションが完了する日付。
- ExpectedStartDate; string; アクション・プランのアクションが開始される予定の日付。
- LastUpdateDate; string; アクション・プランでアクションが最後に更新された日時。
- LastUpdateLogin; string;アクション・プランのアクションを最後に更新したユーザーのログイン詳細。
- LastUpdatedBy; string; アクション・プランのアクションを最後に更新したユーザー。
- LeadTime; integer;アクションの完了に必要な推定時間。
- LeadTimeUnit; string; 分、時間、日など、リード・タイムの測定単位。
- LeadTimeUnitMeaning; string; 処理プラン処理のリード・タイム・ユニット参照コードに対応する表示値です。
- MandatoryFlag; boolean;アクション・プランのアクションが必須かどうかを示します。デフォルト値はfalseです。
- ObjectEntityName; string; アクションの基になる親エンティティ・オブジェクトの名前。
- ObjectEntityNameMeaning; string; アクション・プラン・アクションのオブジェクト・エンティティ名参照コードに対応する表示値。
- ObjectEntitySubtype; string; アクション・プラン内のアクションのオブジェクト・エンティティ・サブタイプを示します。
- ObjectEntityType; string; アクションの基になる親エンティティ・オブジェクトのタイプ。
- ObjectEntityTypeMeaning; string; アクション・プラン・アクションのオブジェクト・エンティティ・タイプ参照コードに対応する表示値。
- ObjectId; integer; アクションに関連付けられたオブジェクトの一意の識別子。
- ObjectReferenceNumber; string; アクションに関連付けられたオブジェクトの参照番号。
- OrderNumber; integer;アクション・プランでのアクションの順序。
- OwnerName; string;アクションの所有者の名前。
- 前提条件、文字列、アクションを開始するために必要な前提条件ステップ。
- ProcessInstanceId; string; 外部プロセスのプロセス・インスタンス識別子を示します。
- ProcessStatus; string;外部プロセスのステータス。
- SkipFlag; boolean。アクション・プランのアクションをスキップできるかどうかを示します。
- StartDate; string; アクション・プランのアクションが開始される日付。
- StatusCd; string; アクションのステータスを示すコード。有効な値のリストは、参照ORA_SVC_AP_STATUS_CDで定義されます。
- StatusCdMeaning; string;処理計画処理のステータス参照コードに対応する表示値。
- StatusDetails; string; アクション・プラン内のアクションのステータスの詳細。
- TemplateId; integer; アクションの作成元であるアクション・プラン・テンプレートの一意の識別子。
- TemplateNumber; string;アクション・プラン・テンプレートの参照番号。
- TemplateTemplateId; integer;テンプレートの一意の識別子。
- VisibilityCd; string; アクションの表示レベルを示すコード。有効な値のリストは、参照ORA_SVC_AP_VISIBILITY_CDで定義されます。
- VisibilityCdMeaning; string; 処理プラン処理の表示参照コードに対応する表示値。
totalResults: boolean

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

ヘッダー・パラメータ

Metadata-Context:

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : actionplans-actionPlanAction

タイプ: object

ソースを表示

count(required): integer

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

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

タイトル: Items

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

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

タイトル: Links

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

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

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

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

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

タイプ: array

タイトル: Items

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

ソースを表示

Array of: object actionplans-actionPlanAction-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "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."
        }
    }
}

トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
"items": [
  {
"ActionId": 300100117527290,
"ActionPlanActionId": 300100117534968,
"ActionPlanId": 300100117534967,
"CreatedBy": "autoxtnapi90",
"CreationDate": "2017-09-14T09:05:08.006+00:00",
"DelayedFlag": true,
"DeletedFlag": false,
"EndDate": "2017-09-26T11:48:00+00:00",
"ExpectedCompletionDate": "2017-09-15T11:06:00+00:00",
"ExpectedStartDate": "2017-09-15T09:06:00+00:00",
"LastUpdateDate": "2017-09-27T14:05:44.762+00:00",
"LastUpdateLogin": "5A2B9616EDB55FF2E0538E09F20A4251",
"LastUpdatedBy": "autoxtnapi90",
"LeadTime": 2,
"LeadTimeUnit": "ORA_SVC_HOURS",
"MandatoryFlag": true,
"ObjectId": 300100118782699,
"ObjectReferenceNumber": null,
"OrderNumber": 3,
"StartDate": "2017-09-26T09:47:37.447+00:00",
"StatusCd": "ORA_SVC_IN_PROGRESS",
"StatusDetails": null,
"TemplateId": 300100117534921,
"OwnerName": "Gabrielle Lee",
"Prerequisites": "1, 5",
"ObjectEntityName": "Activity",
"ObjectEntityType": "Appointment",
"VisibilityCd": "ORA_SVC_CUSTOMER_VISIBLE",
"ActionName": "action149_1",
"UpdateFlag": true,
"DeleteFlag": true,
"ActionNumber": "ACT0000043279",
"ActionDescription": null,
"EndDateReadOnlyFlag": false,
"DclActionPlan_Id_c": null,
"DclActionPlan_c": null,
"links": [
 ...
 ]
},
{
"ActionId": 300100117527294,
"ActionPlanActionId": 300100117534969,
"ActionPlanId": 300100117534967,
"CreatedBy": "autoxtnapi90",
"CreationDate": "2017-09-14T09:05:08.115+00:00",
"DelayedFlag": false,
"DeletedFlag": false,
"EndDate": "2017-09-14T09:05:18.561+00:00",
"ExpectedCompletionDate": null,
"ExpectedStartDate": null,
"LastUpdateDate": "2017-09-14T09:05:21.614+00:00",
"LastUpdateLogin": "59217E93DA3C30D0E0538E09F20A0E64",
"LastUpdatedBy": "autoxtnapi90",
"LeadTime": 3,
"LeadTimeUnit": "ORA_SVC_HOURS",
"MandatoryFlag": false,
"ObjectId": null,
"ObjectReferenceNumber": null,
"OrderNumber": 5,
"StartDate": "2017-09-14T09:05:18.560+00:00",
"StatusCd": "ORA_SVC_CANCELED",
"StatusDetails": null,
"TemplateId": 300100117534921,
"OwnerName": null,
"Prerequisites": "2, 4",
"ObjectEntityName": "ServiceRequest",
"ObjectEntityType": "ServiceRequest",
"VisibilityCd": "ORA_SVC_CUSTOMER_VISIBLE",
"ActionName": "action149_2",
"UpdateFlag": true,
"DeleteFlag": true,
"ActionNumber": "ACT0000043280",
"ActionDescription": null,
"EndDateReadOnlyFlag": true,
"DclActionPlan_Id_c": null,
"DclActionPlan_c": null,
"links": [
 ...
 ]
}

「トップに戻る」