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

機械翻訳について

すべてのアクションの取得

get

/crmRestApi/resources/11.13.18.05/actions

リクエスト

問合せパラメータ

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>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- ActionAltKey : 指定された代替一意キーを持つアクションを検索します。
  ファインダ変数:
  - ActionNumber; string;アクションの代替の一意の識別子。
- ActionByActionNumber : 指定された代替一意識別子を持つアクションを検索します。
  ファインダ変数:
  - ActionNumber; string;アクションの代替の一意の識別子。
- PrimaryKey : 指定された主キーを持つアクションを検索します。
  ファインダ変数:
  - ActionId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- ActionCategoryCd; string; アクションのカテゴリを示すコード。有効な値のリストは、参照ORA_SVC_AP_ACTION_CATEGORY_CDで定義されます。
- ActionCategoryCdMeaning; string; アクションのアクション・カテゴリ参照コードに対応する表示値。
- ActionId; integer; アクションの一意の識別子。
- ActionNumber; string;アクションの代替の一意の識別子。
- BUOrgId; integer; アクションに関連付けられたビジネス・ユニット名の一意の識別子。
- BusinessUnitName; string; アクションに関連付けられたビジネス・ユニットの名前。
- CopyAttachmentsFlag; boolean;添付が親コンテキストから子オブジェクトにコピーされるかどうかを示します。
- CreatedBy; string; アクションを作成したユーザー。
- CreationDate; string; アクションが作成された日時。
- DeletedFlag; boolean。アクションが削除されたかどうかを示します。デフォルト値はfalseです。
- 説明; string;アクションの説明。
- LastUpdateDate; string; アクションが最後に更新された日時。
- LastUpdateLogin; string; アクションを最後に更新したユーザーのログイン詳細。
- LastUpdatedBy; string; アクションを最後に更新したユーザー。
- LeadTime; integer;アクションの完了に必要な推定時間。
- LeadTimeUnit; string; 分、時間、日など、リード・タイムの測定単位。
- LeadTimeUnitMeaning; string; 処理のリード・タイム・ユニット参照コードに対応する表示値。
- 名前、文字列、アクションの名前。
- ObjectEntityName; string; アクションの基になるオブジェクトのエンティティ名。
- ObjectEntityNameMeaning; string; アクションのオブジェクト・エンティティ名参照コードに対応する表示値。
- ObjectEntitySubtype; string; アクションの基になるオブジェクトのサブタイプを示します。
- ObjectEntityType; string; アクションの基になるエンティティ・オブジェクトのタイプ。
- ObjectEntityTypeMeaning; string;アクションのオブジェクト・エンティティ・タイプ参照コードに対応する表示値。
- ObjectLinkTypeId; integer; アクションに関連付けられたオブジェクト・リンク・タイプ識別子。
- OperationCd; string;アクションの操作コード・エントリ。有効な値のリストは、参照ORA_SVC_AP_OPERATION_CDで定義されます。
- OperationCdMeaning; string;アクションの操作参照コードに対応する表示値。
- OriginalSystemReference; string; アクションがインポートされた元のシステムへの参照(インポートされた場合)。
- ParentEntityName; string; アクションが使用されるオブジェクトのエンティティ名。
- ParentEntityNameMeaning; string; アクションの親エンティティ名参照コードに対応する表示値。
- ProcessConnectionTypeCd; string; Process Cloudへの接続が基本か統合かを示す参照コード。
- ProcessMetadataId; integer; プロセス・メタデータの一意の識別子。
- ProcessMetadataNumber; string;プロセス・メタデータの参照番号。
- StripeCd; string;アクションのアプリケーション・コンテキスト。
- StripeCdMeaning; string;アクションのストライプ参照コードに対応する表示値。
- UseDefaultVersionFlag; boolean。デフォルトのプロセス・バージョンが使用されるかどうかを示します。
- 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のデフォルト・バージョンを選択します。

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

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

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

タイプ: array

タイトル: Items

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

ソースを表示

Array of: object actions-item-response

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

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

タイプ: object

ソースを表示

actionAttribute: array Action Attributes

タイトル: Action Attributes

アクション属性リソースは、アクションの関連オブジェクトの作成または更新中に設定された属性を表示、作成、更新および削除するために使用されます。
ActionCategoryCd: string

タイトル: Category

最大長: 30

処理のカテゴリを示すコード。有効な値のリストは、参照ORA_SVC_AP_ACTION_CATEGORY_CDで定義されます。
ActionCategoryCdMeaning: string

タイトル: Action Category Value

最大長: 255

処理の処理カテゴリ参照コードに対応する表示値。
actionCondition: array Action Conditions

タイトル: Action Conditions

アクション条件リソースは、アクションの関連オブジェクトのステータス・マッピング条件の定義を表示、作成、更新および削除するために使用されます。
ActionId: integer (int64)

タイトル: Action ID

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

タイトル: Action Number

最大長: 64

アクションの代替一意識別子。
BUOrgId: integer (int64)

タイトル: Business Unit ID

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

タイトル: Business Unit ID

処理に関連付けられたビジネス・ユニットの名前。
CopyAttachmentsFlag: boolean

タイトル: Copy Attachments

最大長: 1

デフォルト値: false

添付が親コンテキストから子オブジェクトにコピーされるかどうかを示します。
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

処理の摘要。
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

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

タイトル: Action

最大長: 400

アクションの名前。
ObjectEntityName: string

タイトル: Entity Name

最大長: 400

アクションの基になるオブジェクトのエンティティ名。
ObjectEntityNameMeaning: string

タイトル: Object Entity Name Value

最大長: 255

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

タイトル: Object Entity Subtype

最大長: 400

アクションの基になるオブジェクトのサブタイプを示します。
ObjectEntityType: string

タイトル: Type

最大長: 400

アクションの基になるエンティティ・オブジェクトのタイプ。
ObjectEntityTypeMeaning: string

タイトル: Object Entity Type Value

最大長: 255

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

タイトル: Object Link Type Id

処理に関連付けられたオブジェクト・リンク・タイプ識別子。
ObjectLinkTypeNumber: string

タイトル: Link Type Number

最大長: 255

処理に関連付けられたオブジェクト・リンク・タイプの公開一意識別子。
OperationCd: string

タイトル: Operation Code

最大長: 30

処理の操作コード・エントリ。有効な値のリストは、参照ORA_SVC_AP_OPERATION_CDで定義されます。
OperationCdMeaning: string

タイトル: Operation Value

最大長: 255

処理の操作参照コードに対応する表示値。
OriginalSystemReference: string

タイトル: Original System Reference

最大長: 255

処理がインポートされた元のシステムへの参照(インポートされている場合)。
ParentEntityName: string

タイトル: Context

最大長: 400

アクションが使用されるオブジェクトのエンティティ名。
ParentEntityNameMeaning: string

タイトル: Parent Entity Name Value

最大長: 255

処理の親エンティティ名参照コードに対応する表示値。
ProcessConnectionTypeCd: string

タイトル: Process Connection Type Code

読取り専用: true

最大長: 30

デフォルト値: Integrated

Process Cloudへの接続が基本か統合かを示す参照コード。
ProcessMetadataId: integer (int64)

タイトル: Process Metadata ID

プロセス・メタデータの一意の識別子。
ProcessMetadataNumber: string

タイトル: Process Metadata Number

最大長: 30

プロセス・メタデータの参照番号。
StripeCd: string

タイトル: Stripe Code

最大長: 30

アクションのアプリケーション・コンテキスト。
StripeCdMeaning: string

タイトル: Stripe Value

最大長: 255

処理のストライプ参照コードに対応する表示値。
UpdateFlag: boolean

読取り専用: true

処理を更新できるかどうかを示します。
UseDefaultVersionFlag: boolean

タイトル: Use Default Version

最大長: 1

デフォルト値: false

デフォルト・プロセス・バージョンが使用されるかどうかを示します。
VisibilityCd: string

タイトル: Visibility

最大長: 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.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OperationCdMeaning":{
            "title":"Operation Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the operation lookup code for the action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OperationCd"
                ]
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the action.",
            "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,
            "default":"ORA_SVC_NOT_PUBLISHED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectLinkTypeNumber":{
            "title":"Link Type Number",
            "maxLength":255,
            "type":"string",
            "description":"The public unique identifier of the object link type associated with the action.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectEntityName":{
            "title":"Entity Name",
            "maxLength":400,
            "type":"string",
            "description":"The entity name of the object on which the action is based.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActionCategoryCdMeaning":{
            "title":"Action Category Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the action category lookup code for the action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionCategoryCd"
                ]
            },
            "x-queryable":true
        },
        "ActionNumber":{
            "title":"Action Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate unique identifier of the action.",
            "nullable":false,
            "x-queryable":true
        },
        "StripeCdMeaning":{
            "title":"Stripe Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the stripe lookup code for the action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StripeCd"
                ]
            },
            "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 action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityName"
                ]
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Action",
            "maxLength":400,
            "type":"string",
            "description":"The name of the action.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "actionAttribute":{
            "title":"Action Attributes",
            "type":"array",
            "description":"The action attributes resource is used to view, create, update, and delete the attributes that are set while creating or updating the related object of an action.",
            "items":{
                "$ref":"#/components/schemas/actions-actionAttribute-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit ID",
            "type":"string",
            "description":"The name of the business unit associated to the action.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ObjectEntitySubtype":{
            "title":"Object Entity Subtype",
            "maxLength":400,
            "type":"string",
            "description":"Indicates the subtype of the object on which the action is based.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectLinkTypeId":{
            "title":"Object Link Type Id",
            "type":"integer",
            "description":"The object link type identifier associated to the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessMetadataId":{
            "title":"Process Metadata ID",
            "type":"integer",
            "description":"The unique identifier of the process metadata.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VisibilityCdMeaning":{
            "title":"Visibility Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the visibility lookup code for the action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VisibilityCd"
                ]
            },
            "x-queryable":true
        },
        "ParentEntityNameMeaning":{
            "title":"Parent Entity Name Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the parent entity name lookup code for the action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ParentEntityName"
                ]
            },
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System Reference",
            "maxLength":255,
            "type":"string",
            "description":"The reference to the original system from which the action was imported (if imported).",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionNumber"
                ]
            },
            "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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityType"
                ]
            },
            "x-queryable":true
        },
        "OperationCd":{
            "title":"Operation Code",
            "maxLength":30,
            "type":"string",
            "description":"The operation code entry for the action. A list of valid values is defined in the lookup ORA_SVC_AP_OPERATION_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionCategoryCd":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the category of the action. A list of valid values is defined in the lookup ORA_SVC_AP_ACTION_CATEGORY_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CopyAttachmentsFlag":{
            "title":"Copy Attachments",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attachments are copied from the parent context to the child object.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "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
        },
        "actionCondition":{
            "title":"Action Conditions",
            "type":"array",
            "description":"The action conditions resource is used to view, create, update, and delete the definitions of the status mapping conditions for the related object of an action.",
            "items":{
                "$ref":"#/components/schemas/actions-actionCondition-item-response"
            }
        },
        "ProcessMetadataNumber":{
            "title":"Process Metadata Number",
            "maxLength":30,
            "type":"string",
            "description":"The reference number of the process metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "LeadTime":{
            "title":"Duration",
            "type":"integer",
            "description":"The estimated time required to complete the action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentEntityName":{
            "title":"Context",
            "maxLength":400,
            "type":"string",
            "description":"The entity name of the object on which the action is used.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectEntityType":{
            "title":"Type",
            "maxLength":400,
            "type":"string",
            "description":"The type of  the entity object on which the action is based.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The application context of the action.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ObjectEntityName",
                    "ParentEntityName"
                ]
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit name associated to the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessConnectionTypeCd":{
            "title":"Process Connection Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates if the connection to Process Cloud is basic or integrated.",
            "nullable":false,
            "readOnly":true,
            "default":"Integrated",
            "x-hints":{
                "controlType":"choice"
            },
            "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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LeadTimeUnit"
                ]
            },
            "x-queryable":true
        },
        "UseDefaultVersionFlag":{
            "title":"Use Default Version",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the default process version is used.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the 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 action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 処理属性

タイプ: array

タイトル: Action Attributes

アクション属性リソースは、アクションの関連オブジェクトの作成または更新中に設定された属性を表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object actions-actionAttribute-item-response

{
    "title":"Action Attributes",
    "type":"array",
    "description":"The action attributes resource is used to view, create, update, and delete the attributes that are set while creating or updating the related object of an action.",
    "items":{
        "$ref":"#/components/schemas/actions-actionAttribute-item-response"
    }
}

ネストされたスキーマ : 処理条件

タイプ: array

タイトル: Action Conditions

アクション条件リソースは、アクションの関連オブジェクトのステータス・マッピング条件の定義を表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object actions-actionCondition-item-response

{
    "title":"Action Conditions",
    "type":"array",
    "description":"The action conditions resource is used to view, create, update, and delete the definitions of the status mapping conditions for the related object of an action.",
    "items":{
        "$ref":"#/components/schemas/actions-actionCondition-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"
    }
}

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

タイプ: object

ソースを表示

ActionAttributeId: integer (int64)

タイトル: Action Attribute ID

読取り専用: true

処理属性の一意の識別子。
ActionId: integer (int64)

タイトル: Action ID

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

タイトル: Action Number

最大長: 64

アクションの代替一意識別子。
AttributeName: string

タイトル: Attribute Name

最大長: 2000

処理属性の名前。
AttributeValue: string

タイトル: Attribute Value

最大長: 1000

処理属性に設定される値。
AttributeValueContextCd: string

タイトル: Context

最大長: 30

デフォルト値: ORA_SVC_USER_DEFINED

属性値が解釈されるコンテキストを示すコード。有効な値のリストは、参照ORA_SVC_AP_CONTEXT_CDで定義されます。
AttributeValueContextCdMeaning: string

タイトル: Context Value

最大長: 255

処理属性のコンテキスト参照コードに対応する表示値。
ChildAttributeFlag: boolean

タイトル: Child Attribute Indicator

最大長: 1

デフォルト値: false

この属性が親オブジェクトまたはその子オブジェクトのいずれに属するかを示します。
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

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

読取り専用: true

処理属性を更新できるかどうかを示します。
UsageCd: string

タイトル: Usage

最大長: 30

デフォルト値: ORA_SVC_CREATE

属性が使用されるタイミングを示すコード。有効な値のリストは、参照ORA_SVC_AP_ATTRIBUTE_USAGE_CDで定義されます。
UsageCdMeaning: string

タイトル: Usage Value

最大長: 255

処理属性の使用参照コードに対応する表示値。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the action attribute was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValue":{
            "title":"Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value to be set for the action attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionAttributeId":{
            "title":"Action Attribute ID",
            "type":"integer",
            "description":"The unique identifier of the action attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeValueContextCdMeaning":{
            "title":"Context Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the context lookup code for the action attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueContextCd"
                ]
            },
            "x-queryable":true
        },
        "ActionNumber":{
            "title":"Action Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate unique identifier of the action.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action attribute can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action attribute 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
        },
        "UsageCd":{
            "title":"Usage",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating when the attribute is to be used. A list of valid values is defined in the lookup ORA_SVC_AP_ATTRIBUTE_USAGE_CD.",
            "nullable":false,
            "default":"ORA_SVC_CREATE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UsageCdMeaning":{
            "title":"Usage Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the usage lookup code for the action attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "UsageCd"
                ]
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attribute action is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AttributeValueContextCd":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the context within which the attribute value is interpreted. A list of valid values is defined in the lookup  ORA_SVC_AP_CONTEXT_CD.",
            "nullable":false,
            "default":"ORA_SVC_USER_DEFINED",
            "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"
            }
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":2000,
            "type":"string",
            "description":"The name of the action attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ChildAttributeFlag":{
            "title":"Child Attribute Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this attribute belongs to the parent or one of its child objects.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the action attribute 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 attribute.",
            "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."
        }
    }
}

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

タイプ: object

ソースを表示

ActionConditionId: integer (int64)

タイトル: Action Condition ID

読取り専用: true

アクション条件の一意の識別子。
ActionId: integer (int64)

タイトル: Action ID

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

タイトル: Action Number

最大長: 64

アクションの代替一意識別子。
ActionStatusCd: string

タイトル: Action Status

最大長: 30

条件が満たされたかどうかに基づく処理のステータスを示すコード。有効な値のリストは、参照ORA_SVC_AP_STATUS_CDで定義されます。
ActionStatusCdMeaning: string

タイトル: Action Status Value

最大長: 255

処理条件の処理ステータス参照コードに対応する表示値。
CompletionFlag: boolean

タイトル: CompletionFlag

最大長: 1

条件を履行して処理が完了したかどうかを示します。デフォルト値はfalseです。
Condition: string

タイトル: Condition

最大長: 1000

条件が満たされているかどうかを示す式。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

アクション条件を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

条件が作成された日時。
DeleteFlag: boolean

読取り専用: true

処理条件を削除できるかどうかを示します。
Description: string

タイトル: Description

最大長: 1000

アクション条件の説明。
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

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

タイトル: Name

最大長: 400

アクション条件の名前。
UpdateFlag: boolean

読取り専用: true

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Condition":{
            "title":"Condition",
            "maxLength":1000,
            "type":"string",
            "description":"The expression indicating whether the condition is met or not.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the condition 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 action condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the action condition.",
            "nullable":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 condition.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionStatusCd"
                ]
            },
            "x-queryable":true
        },
        "ActionNumber":{
            "title":"Action Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate unique identifier of the action.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action condition can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the action condition.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionFlag":{
            "title":"CompletionFlag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action was completed by fulfilling the condition. The default value is false.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action condition 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
        },
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the action based on whether the condition is met or not. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.",
            "nullable":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"
            }
        },
        "ActionConditionId":{
            "title":"Action Condition ID",
            "type":"integer",
            "description":"The unique identifier of the action condition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the action condition 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 condition.",
            "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コマンド

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

レスポンス本文の例

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

{
"items": [
  {
"ActionCategoryCd": "CATEGORY 1",
"ActionId": 300100118621756,
"CreatedBy": "xuidrill2",
"CreationDate": "2017-09-25T06:38:02+00:00",
"DeletedFlag": false,
"Description": "SR IN Progress to Blocked when Severity is HIGH",
"LastUpdateDate": "2017-09-25T06:43:25.201+00:00",
"LastUpdateLogin": "59FCEEEABAA256BBE0538E09F20A384F",
"LastUpdatedBy": "xuidrill2",
"LeadTime": 45,
"LeadTimeUnit": "ORA_SVC_MINS",
"Name": "ESS_SR_PP01",
"ObjectEntityName": "ServiceRequest",
"ParentEntityName": "ServiceRequest",
"VisibilityCd": "ORA_SVC_INTERNAL_ONLY",
"OperationCd": "ORA_SVC_CREATE",
"ObjectEntityType": "ServiceRequest",
"ActionNumber": "ACT0000044367",
"OriginalSystemReference": "ACT0000044367",
"DeleteFlag": true,
"UpdateFlag": true,
"DclAction_Id_c": null,
"DclAction_c": null,
"links": [
...
]
},
{
"ActionCategoryCd": "CATEGORY 1",
"ActionId": 300100118621849,
"CreatedBy": "xuidrill2",
"CreationDate": "2017-09-25T06:43:59.001+00:00",
"DeletedFlag": false,
"Description": "APP IN PROGRESS to Completed",
"LastUpdateDate": "2017-09-25T06:47:18.960+00:00",
"LastUpdateLogin": "59FCEEEABAA256BBE0538E09F20A384F",
"LastUpdatedBy": "xuidrill2",
"LeadTime": 15,
"LeadTimeUnit": "ORA_SVC_MINS",
"Name": "ESS_APP_PP02",
"ObjectEntityName": "Activity",
"ParentEntityName": "ServiceRequest",
"VisibilityCd": "ORA_SVC_CUSTOMER_VISIBLE",
"OperationCd": "ORA_SVC_CREATE",
"ObjectEntityType": "Appointment",
"ActionNumber": "ACT0000044368",
"OriginalSystemReference": "ACT0000044368",
"DeleteFlag": true,
"UpdateFlag": true,
"DclAction_Id_c": null,
"DclAction_c": null,
"links": [
...
]
},
...

「トップに戻る」