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

機械翻訳について

すべての処理プラン・テンプレートの取得

get

/crmRestApi/resources/11.13.18.05/actiontemplates

リクエスト

問合せパラメータ

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 : 指定した主キーを持つ処理プラン・テンプレートを検索します。
  ファインダ変数:
  - TemplateId; integer;アクション・プラン・テンプレートの一意の識別子。
- TemplateAltKey : 指定された代替一意識別子を持つテンプレートを検索します。
  ファインダ変数:
  - TemplateNumber; string;テンプレートの代替の一意の識別子。
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問合せパラメータを使用してこの収集リソースをフィルタできます:
- ActionPlanTypeCd; string; テンプレートが関連付けられているアクション・プランのタイプを示すコード。有効な値のリストは、参照ORA_SVC_AP_ACTION_PLAN_TYPE_CDで定義されます。
- ActionPlanTypeCdMeaning; string;テンプレートの処理プラン・タイプ参照コードに対応する表示値。
- AutoStartFlag; boolean。テンプレートを使用して作成されたアクション・プランが自動的に開始されるかどうかを示します。
- BUOrgId; integer;アクション・プラン・テンプレートに関連付けられたビジネス・ユニット名の一意の識別子。
- BusinessUnitName; string;テンプレートに関連付けられたビジネス・ユニットの名前。
- CalendarId; integer; アクション・プラン・テンプレートに関連付けられているカレンダの一意の識別子。
- CoverageName; string; アクション・プラン・テンプレートに関連付けられたカレンダの名前。
- CoverageTimeId; integer; アクション・プラン・テンプレートに関連付けられたカレンダの一意の識別子。
- CreatedBy; string; アクション・プラン・テンプレートを作成したユーザー。
- CreationDate; string; アクション・プラン・テンプレートが作成された日時。
- DeletedFlag; boolean;アクション・プラン・テンプレートが削除されたかどうかを示します。デフォルト値はfalseです。
- 説明;文字列;アクション・プラン・テンプレートの説明。
- EnabledFlag; boolean。処理プラン・テンプレートがシステムで有効になっているかどうかを示します。デフォルト値はtrueです。
- EndDate; string; アクション・プラン・テンプレートが終了する日付。
- LastUpdateDate; string; アクション・プラン・テンプレートが最後に更新された日時。
- LastUpdateLogin; string; アクション・プラン・テンプレートを最後に更新したユーザーのログイン詳細。
- LastUpdatedBy; string; アクション・プラン・テンプレートを最後に更新したユーザー。
- 名前;文字列;アクション・プラン・テンプレートの名前。
- ObjectEntityName; string; テンプレートがアクション・プランの作成に使用するオブジェクト・エンティティの名前。
- ObjectEntityNameMeaning; string;テンプレートのオブジェクト・エンティティ名参照コードに対応する表示値。
- SchedulePuid; string;標準カバレッジ・スケジュールの公開一意識別子。
- StartDate; string; アクション・プラン・テンプレートが開始する日付。
- StripeCd; string; アクション・プラン・テンプレートのアプリケーション・コンテキスト。
- StripeCdMeaning; string;テンプレートのストライプ参照コードに対応する表示値。
- TemplateId; integer;アクション・プラン・テンプレートの一意の識別子。
- TemplateNumber; string;アクション・プラン・テンプレートの参照番号。
totalResults: boolean

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

ヘッダー・パラメータ

Metadata-Context:

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

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

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : アクション・テンプレート

タイプ: object

ソースを表示

count(required): integer

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

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

タイトル: Items

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

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

タイトル: Links

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

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

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

{
    "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/actiontemplates-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

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

タイプ: array

タイトル: Items

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

ソースを表示

Array of: object actiontemplates-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/actiontemplates-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"
    }
}

ネストされたスキーマ : actiontemplates-item-response

タイプ: object

ソースを表示

ActionPlanTypeCd: string

タイトル: Category

最大長: 30

テンプレートが関連付けられている処理プランのタイプを示すコード。有効な値のリストは、参照ORA_SVC_AP_ACTION_PLAN_TYPE_CDで定義されます。
ActionPlanTypeCdMeaning: string

タイトル: Action Plan Type Value

最大長: 255

テンプレートの処理プラン・タイプ参照コードに対応する表示値。
AutoStartFlag: boolean

タイトル: Auto Start

最大長: 1

デフォルト値: false

テンプレートを使用して作成された処理プランが自動的に開始されるかどうかを示します。
BUOrgId: integer (int64)

タイトル: Business Unit ID

処理プラン・テンプレートに関連付けられたビジネス・ユニット名の一意の識別子。
BusinessUnitName: string

タイトル: Business Unit

テンプレートに関連付けられたビジネス・ユニットの名前。
CalendarId: integer (int64)

タイトル: Calendar

処理プラン・テンプレートに関連付けられているカレンダの一意の識別子。
CoverageName: string

タイトル: Calendar

読取り専用: true

処理プラン・テンプレートに関連付けられたカレンダの名前。
CoverageTimeId: integer

タイトル: Coverage Time ID

読取り専用: true

処理プラン・テンプレートに関連付けられたカレンダの一意の識別子。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

処理プラン・テンプレートを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

処理プラン・テンプレートが作成された日時。
DeletedFlag: boolean

タイトル: Deleted

最大長: 1

デフォルト値: false

処理プラン・テンプレートが削除されたかどうかを示します。デフォルト値はfalseです。
DeleteFlag: boolean

読取り専用: true

処理プラン・テンプレートを削除できるかどうかを示します。
Description: string

タイトル: Description

最大長: 1000

処理プラン・テンプレートの摘要。
EnabledFlag: boolean

タイトル: Published

最大長: 1

デフォルト値: false

処理プラン・テンプレートがシステムで有効になっているかどうかを示します。デフォルト値はtrueです。
EndDate: string (date-time)

タイトル: End Date

処理プラン・テンプレートが終了する日付。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

処理プラン・テンプレートが最後に更新された日時。
LastUpdatedBy: string

タイトル: LastUpdatedBy

読取り専用: true

最大長: 64

処理プラン・テンプレートを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

アクション・プラン・テンプレートを最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

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

タイトル: Template

最大長: 400

処理プラン・テンプレートの名前。
ObjectEntityName: string

タイトル: Context

最大長: 400

テンプレートが処理プランの作成に使用するオブジェクト・エンティティの名前。
ObjectEntityNameMeaning: string

タイトル: Object Entity Name Value

最大長: 255

テンプレートのオブジェクト・エンティティ名参照コードに対応する表示値。
SchedulePuid: string

タイトル: Schedule PUID

読取り専用: true

最大長: 120

標準カバレッジ・スケジュールの公開一意識別子。
StartDate: string (date-time)

タイトル: Start Date

処理プラン・テンプレートが開始する日付。
StripeCd: string

タイトル: Stripe Code

最大長: 30

処理プラン・テンプレートのアプリケーション・コンテキスト。
StripeCdMeaning: string

タイトル: Stripe Value

最大長: 255

テンプレートのストライプ参照コードに対応する表示値。
templateAction: array Template Actions

タイトル: Template Actions

テンプレート処理リソースは、処理と処理プラン・テンプレートの関連付けを表示、作成、更新および削除するために使用されます。
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 template was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the action plan template.",
            "nullable":true,
            "x-queryable":true
        },
        "CalendarId":{
            "title":"Calendar",
            "type":"integer",
            "description":"The unique identifier of the calendar that is associated with the action plan template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CoverageName":{
            "title":"Calendar",
            "type":"string",
            "description":"The name of the calendar associated with the action plan template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionPlanTypeCd":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the action plan with which the template is associated. A list of valid values is defined in the lookup ORA_SVC_AP_ACTION_PLAN_TYPE_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectEntityName":{
            "title":"Context",
            "maxLength":400,
            "type":"string",
            "description":"The name of the object entity that the template uses to create action plans.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectEntityNameMeaning":{
            "title":"Object Entity Name Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the object entity name lookup code for the template.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityName"
                ]
            },
            "x-queryable":true
        },
        "StripeCdMeaning":{
            "title":"Stripe Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the stripe lookup code for the template.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StripeCd"
                ]
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Template",
            "maxLength":400,
            "type":"string",
            "description":"The name of the action plan template.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the action plan template starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action plan template can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Published",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action plan template is enabled in the system. The default value is true.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "type":"string",
            "description":"The name of the business unit associated to the template.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of the action plan template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"LastUpdatedBy",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoverageTimeId":{
            "title":"Coverage Time ID",
            "type":"integer",
            "description":"The unique identifier of the calendar associated with the action plan template.",
            "nullable":false,
            "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
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the action plan template ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action plan template can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "templateAction":{
            "title":"Template Actions",
            "type":"array",
            "description":"The template actions resource is used to view, create, update, and delete the associations of actions with action plan templates.",
            "items":{
                "$ref":"#/components/schemas/actiontemplates-templateAction-item-response"
            }
        },
        "AutoStartFlag":{
            "title":"Auto Start",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action plans created using the template start automatically.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The application context of the action plan template.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ObjectEntityName"
                ]
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action plan template has been deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit name associated to the action plan template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "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 template.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionPlanTypeCd"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the action plan template 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 template.",
            "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"
    }
}

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

タイプ: array

タイトル: Template Actions

テンプレート処理リソースは、処理と処理プラン・テンプレートの関連付けを表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object actiontemplates-templateAction-item-response

{
    "title":"Template Actions",
    "type":"array",
    "description":"The template actions resource is used to view, create, update, and delete the associations of actions with action plan templates.",
    "items":{
        "$ref":"#/components/schemas/actiontemplates-templateAction-item-response"
    }
}

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

タイプ: 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."
        }
    }
}

ネストされたスキーマ : actiontemplates-templateAction-item-response

タイプ: object

ソースを表示

ActionId: integer (int64)

タイトル: Action ID

アクションの一意の識別子。
ActionNumber: string

タイトル: Action Number

最大長: 64

処理の参照番号。
actionRelation: array Action Relations

タイトル: Action Relations

処理関係リソースは、処理プラン・テンプレート内の他の処理に対する処理の依存関係を表示、作成、更新および削除するために使用されます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

アクションをテンプレートに追加したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

アクションがテンプレートに追加された日時。
DeletedFlag: boolean

タイトル: Deleted

最大長: 1

デフォルト値: false

テンプレート処理が削除されたかどうかを示します。デフォルト値はfalseです。
DeleteFlag: boolean

読取り専用: true

テンプレート処理を削除できるかどうかを示します。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

テンプレート・アクションが最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

テンプレート処理を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

テンプレート処理を最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

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

タイトル: Mandatory

最大長: 1

デフォルト値: true

処理プランの処理が必須かどうかを示します。デフォルト値はtrueです。
OrderNumber: integer (int64)

タイトル: Sort Number

アクション・テンプレート内のアクションの表示順序。
Prerequisites: string

読取り専用: true

アクションの前提条件のアクション・ステップ。
TemplateActionId: integer (int64)

タイトル: Template Action ID

読取り専用: true

テンプレート処理の一意の識別子。
TemplateActionNumber: string

タイトル: Template Action Number

最大長: 30

テンプレート処理参照番号。
TemplateId: integer (int64)

タイトル: Template ID

処理プラン・テンプレートの一意の識別子。
TemplateNumber: string

タイトル: Template Number

最大長: 30

処理プラン・テンプレートの参照番号。
Tier: integer

読取り専用: true

アクション・プラン・ダイアグラムで適切なレベルのアクション・ノードを表示するために使用する層。
UpdateFlag: boolean

読取り専用: true

テンプレート処理を更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the template action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the action was added to the template.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who added the action to the template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Tier":{
            "type":"integer",
            "description":"The tier used in an action plan diagram to display the action nodes at appropriate levels.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateActionNumber":{
            "title":"Template Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The template action reference number.",
            "nullable":false,
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Sort Number",
            "type":"integer",
            "description":"The order of display for an action within an action template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionNumber":{
            "title":"Action Number",
            "maxLength":64,
            "type":"string",
            "description":"The reference number of the action.",
            "nullable":false,
            "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 template action can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action in an action plan is mandatory. The default value is true.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "Prerequisites":{
            "type":"string",
            "description":"The prerequisite action steps for the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the template action can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateActionId":{
            "title":"Template Action ID",
            "type":"integer",
            "description":"The unique identifier of the template action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the template action has been 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"
            }
        },
        "actionRelation":{
            "title":"Action Relations",
            "type":"array",
            "description":"The action relations resource is used to view, create, update, and delete the dependencies of actions on other actions in an action plan template.",
            "items":{
                "$ref":"#/components/schemas/actiontemplates-templateAction-actionRelation-item-response"
            }
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of the action plan template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the template action 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 template action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Action Relations

処理関係リソースは、処理プラン・テンプレート内の他の処理に対する処理の依存関係を表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object actiontemplates-templateAction-actionRelation-item-response

{
    "title":"Action Relations",
    "type":"array",
    "description":"The action relations resource is used to view, create, update, and delete the dependencies of actions on other actions in an action plan template.",
    "items":{
        "$ref":"#/components/schemas/actiontemplates-templateAction-actionRelation-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"
    }
}

ネストされたスキーマ : actiontemplates-templateAction-actionRelation-item-response

タイプ: object

ソースを表示

ActionStatusCd: string

タイトル: Action Status

最大長: 30

デフォルト値: ORA_SVC_COMPLETED

処理関係の依存関係条件を示すステータス・コード。有効な値のリストは、参照ORA_SVC_AP_STATUS_CDで定義されます。
ActionStatusCdMeaning: string

タイトル: Action Status Value

最大長: 255

処理関係の処理ステータス参照コードに対応する表示値。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

アクションの依存関係を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

アクション依存関係が作成された日時。
DeletedFlag: boolean

タイトル: Deleted

最大長: 1

デフォルト値: false

処理依存関係が削除されたかどうかを示します。デフォルト値はfalseです。
DeleteFlag: boolean

読取り専用: true

処理関連を削除できるかどうかを示します。
DepTemplateActionId: integer (int64)

タイトル: Dependent Template Action ID

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

タイトル: Dependent Template Action Number

最大長: 30

依存処理のテンプレート処理参照番号です。
DepTmpActionOrderNumber: integer (int64)

タイトル: Sort Number

読取り専用: true

アクション・テンプレート内のアクションの表示順序。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

アクションの依存関係が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

アクションの依存関係を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

アクションの依存関係を最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

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

タイトル: Relation ID

処理プラン内の処理間の関係の一意の識別子。
TemplateActionId: integer (int64)

タイトル: Template Action ID

テンプレート処理の一意の識別子。
TemplateActionNumber: string

タイトル: Template Action Number

最大長: 30

テンプレート処理参照番号。
UpdateFlag: boolean

読取り専用: true

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the dependencies of an 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
        },
        "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
        },
        "ActionStatusCdMeaning":{
            "title":"Action Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the action status lookup code for the action relation.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionStatusCd"
                ]
            },
            "x-queryable":true
        },
        "DepTemplateActionNumber":{
            "title":"Dependent Template Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The template action reference number of a dependent action.",
            "nullable":false,
            "x-queryable":true
        },
        "TemplateActionNumber":{
            "title":"Template Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The template action reference number.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action relation can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DepTemplateActionId":{
            "title":"Dependent Template 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
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action relation can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code which indicates the dependency condition of an action relation. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.",
            "nullable":true,
            "default":"ORA_SVC_COMPLETED",
            "x-queryable":true
        },
        "RelationId":{
            "title":"Relation ID",
            "type":"integer",
            "description":"The unique identifier of the relation between the actions in an action plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateActionId":{
            "title":"Template Action ID",
            "type":"integer",
            "description":"The unique identifier of the template action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action dependency has been 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"
            }
        },
        "DepTmpActionOrderNumber":{
            "title":"Sort Number",
            "type":"integer",
            "description":"The order of display for an action within an action template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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 action dependency.",
            "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"
    }
}

トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
"items": [
  {
"ActionPlanTypeCd": null,
"CalendarId": 300100028308361,
"CreatedBy": "autoxtnapi90",
"CreationDate": "2017-09-26T04:35:27+00:00",
"DeletedFlag": false,
"Description": null,
"EnabledFlag": true,
"EndDate": null,
"LastUpdateDate": "2017-09-26T04:38:50.624+00:00",
"LastUpdateLogin": "5A110B3702AB2374E0538E09F20AA247",
"LastUpdatedBy": "autoxtnapi90",
"Name": "test_26838643_bug",
"ObjectEntityName": "ServiceRequest",
"StartDate": "2017-09-26T00:00:00+00:00",
"TemplateId": 300100118701852,
"CoverageName": "24 by 7",
"CoverageTimeId": 300100028308361,
"UpdateFlag": true,
"DeleteFlag": true,
"DclTemplate_Id_c": null,
"DclTemplate_c": null,
"links": [
 ...
 ]
},
{
"ActionPlanTypeCd": null,
"CalendarId": 300100028308361,
"CreatedBy": "autouicase1",
"CreationDate": "2017-09-26T00:16:31+00:00",
"DeletedFlag": false,
"Description": "Auto_APTemplate_DESC_Multi_PreReqs_25092017_171629.949",
"EnabledFlag": true,
"EndDate": null,
"LastUpdateDate": "2017-09-26T00:18:29.258+00:00",
"LastUpdateLogin": "5A0D0227FB64731EE0538E09F20A7BA2",
"LastUpdatedBy": "autouicase1",
"Name": "Auto_APTemplate_Multi_PreReqs_25092017_171629.949",
"ObjectEntityName": "ServiceRequest",
"StartDate": "2017-09-26T00:00:00+00:00",
"TemplateId": 300100118669128,
"CoverageName": "24 by 7",
"CoverageTimeId": 300100028308361,
"UpdateFlag": true,
"DeleteFlag": true,
"DclTemplate_Id_c": null,
"DclTemplate_c": null,
"links": [
 ...
 ]
},
...

「トップに戻る」