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

機械翻訳について

アクティビティ関数の取得

get

/crmRestApi/resources/11.13.18.05/activityFunctionLookups/{activityFunctionLookupsUniqID}

リクエスト

パス・パラメータ

activityFunctionLookupsUniqID(required): string

これは、アクティビティ関数リソースに対してコンポジット・キー(LookupCode、LookupType、ViewApplicationIdおよびSetId)を構成する属性のハッシュ・キーで、アクティビティ関数のインスタンスを一意に識別するために使用されます。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、アクティビティ関数の特定のインスタンスに移動するために、主キー値に対するフィルタを使用してアクティビティ関数コレクション・リソースを問い合せる必要があります。

次に例を示します: activityFunctionLookups?q=LookupCode=<value1>;LookupType=<value2>;ViewApplicationId=<value3>;SetId=<value4>

問合せパラメータ

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
links: string

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

例:
self,canonical
onlyData: boolean

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

ヘッダー・パラメータ

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のデフォルト・バージョンを選択します。

ルート・スキーマ : activityFunctionLookups-item-response

タイプ: object

ソースを表示

activityTypeLookup: array Activity Type Lookups

タイトル: Activity Type Lookups

アクティビティ・タイプ参照リソースは、アクティビティ機能のアクティビティ・タイプを表示するために使用されます。アクティビティ・タイプは、アクティビティ機能をさらに定義するために使用されます。
EnabledFlag: boolean

タイトル: Enabled

最大長: 1

デフォルト値: true

アクティビティ機能がアクティブかどうかを示します。
links: array Links

タイトル: Links

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

タイトル: Lookup Code

最大長: 30

アクティビティ機能の一意のコード。
LookupType: string

タイトル: Lookup Type

最大長: 30

アクティビティ機能参照の参照タイプ。
Meaning: string

タイトル: Meaning

最大長: 80

アクティビティ機能参照の表示値。
SetId: integer (int64)

タイトル: Reference Data Set

読取り専用: true

デフォルト値: 0

セットの一意の識別子。
Tag: string

タイトル: Tag

最大長: 150

アクティビティ機能の説明および分類。
ViewApplicationId: integer (int64)

読取り専用: true

デフォルト値: 0

アクティビティ機能参照の表示アプリケーションの一意の識別子。

{
    "type":"object",
    "properties":{
        "ViewApplicationId":{
            "type":"integer",
            "description":"The unique identifier of the view application of the activity function lookup.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup type for the activity function lookup.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "activityTypeLookup":{
            "title":"Activity Type Lookups",
            "type":"array",
            "description":"The activity type lookup resource is used to view the activity types for an activity function. Activity types are used to further define an activity function.",
            "items":{
                "$ref":"#/components/schemas/activityFunctionLookups-activityTypeLookup-item-response"
            }
        },
        "Tag":{
            "title":"Tag",
            "maxLength":150,
            "type":"string",
            "description":"The description and classification for activity function.",
            "nullable":true,
            "x-queryable":true
        },
        "SetId":{
            "title":"Reference Data Set",
            "type":"integer",
            "description":"The unique identifier of the set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity function is active.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The display value for the activity function lookup.",
            "nullable":false,
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique code for the activity function.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : アクティビティ・タイプ参照

タイプ: array

タイトル: Activity Type Lookups

アクティビティ・タイプ参照リソースは、アクティビティ機能のアクティビティ・タイプを表示するために使用されます。アクティビティ・タイプは、アクティビティ機能をさらに定義するために使用されます。

ソースを表示

Array of: object activityFunctionLookups-activityTypeLookup-item-response

{
    "title":"Activity Type Lookups",
    "type":"array",
    "description":"The activity type lookup resource is used to view the activity types for an activity function. Activity types are used to further define an activity function.",
    "items":{
        "$ref":"#/components/schemas/activityFunctionLookups-activityTypeLookup-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"
    }
}

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

タイプ: object

ソースを表示

activitySubtypeLookup: array Activity Subtypes

タイトル: Activity Subtypes

アクティビティ・サブタイプ参照リソースは、アクティビティ・タイプおよびアクティビティ機能のアクティビティ・サブタイプを表示するために使用されます。アクティビティ・サブタイプは、アクティビティを追跡するための追加の詳細を提供します。
ActivityTypeCodeTransient: string

最大長: 255

アクティビティのタイプまたはカテゴリを示すコード。
DisplaySequence: integer (int64)

タイトル: Display Sequence

アプリケーション参照のアクティビティ・タイプの表示順序を示す番号。
EnabledFlag: boolean

タイトル: Enabled

最大長: 1

デフォルト値: true

アクティビティ・タイプが使用可能かどうかを示します。
EndDateActive: 文字列(日付)

タイトル: End Date

アクティビティ・タイプがアクティブである最終日。
links: array Links

タイトル: Links

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

タイトル: Lookup Code

最大長: 30

アクティビティ・タイプの一意のコード。
LookupEnabledFlag: boolean

最大長: 255

アクティビティ・タイプがアクティブかどうかを示します。
LookupType: string

タイトル: Lookup Type

最大長: 30

アクティビティ・タイプ参照の参照タイプ。
Meaning: string

タイトル: Meaning

最大長: 80

アクティビティ・タイプ参照の表示値。
SetId: integer (int64)

タイトル: Reference Data Set

読取り専用: true

デフォルト値: 0

アクティビティ・タイプ参照の一意の識別子。
StartDateActive: 文字列(日付)

タイトル: Start Date

アクティビティ・タイプがアクティブである日付。
Tag: string

タイトル: Tag

最大長: 150

摘要および分類アクティビティ・タイプ。
ViewApplicationId: integer (int64)

読取り専用: true

デフォルト値: 0

アクティビティ・タイプ参照の表示アプリケーションの一意の識別子。

{
    "type":"object",
    "properties":{
        "activitySubtypeLookup":{
            "title":"Activity Subtypes",
            "type":"array",
            "description":"The activity subtype lookup resource is used to view the activity subtypes for an Activity type and Activity Function. The activity subtypes provide additional detail to track activities.",
            "items":{
                "$ref":"#/components/schemas/activityFunctionLookups-activityTypeLookup-activitySubtypeLookup-item-response"
            }
        },
        "ViewApplicationId":{
            "type":"integer",
            "description":"The unique identifier of the view application of the activity type lookup.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup type for the activity type lookup.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The number indicating the display sequence for the activity type in the application lookup.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the activity type.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivityTypeCodeTransient":{
            "maxLength":255,
            "type":"string",
            "description":"The code indicating the type or category of the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the activity type is active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The last day the activity type is active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Tag":{
            "title":"Tag",
            "maxLength":150,
            "type":"string",
            "description":"The description and classification activity type.",
            "nullable":true,
            "x-queryable":true
        },
        "SetId":{
            "title":"Reference Data Set",
            "type":"integer",
            "description":"The unique identifier for the activity type lookup.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity type is enabled.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "LookupEnabledFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the activity type is active.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The display value for the activity type lookup.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : アクティビティ・サブタイプ

タイプ: array

タイトル: Activity Subtypes

アクティビティ・サブタイプ参照リソースは、アクティビティ・タイプおよびアクティビティ機能のアクティビティ・サブタイプを表示するために使用されます。アクティビティ・サブタイプは、アクティビティを追跡するための追加の詳細を提供します。

ソースを表示

Array of: object activityFunctionLookups-activityTypeLookup-activitySubtypeLookup-item-response

{
    "title":"Activity Subtypes",
    "type":"array",
    "description":"The activity subtype lookup resource is used to view the activity subtypes for an Activity type and Activity Function. The activity subtypes provide additional detail to track activities.",
    "items":{
        "$ref":"#/components/schemas/activityFunctionLookups-activityTypeLookup-activitySubtypeLookup-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"
    }
}

ネストされたスキーマ : activityFunctionLookups-activityTypeLookup-activitySubtypeLookup-item-response

タイプ: object

ソースを表示

ActivitySubtypeCode: string

タイトル: Code

最大長: 30

アクティビティ・サブタイプを示すコード。
ActivitySubtypeId: integer (int64)

アクティビティ・サブタイプの一意の識別子。
ActivityTypeCode: string

最大長: 30

アクティビティのタイプを示すコード。
CreatedBy: string

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

レコードが作成された日付。
DefaultFlag: boolean

タイトル: Set as Default

最大長: 1

アクティビティ・サブタイプがデフォルトかどうかを示します。
EnabledFlag: boolean

タイトル: Enabled

最大長: 1

アクティビティ・サブタイプがアクティブかどうかを示します。
EndDateActive: 文字列(日付)

タイトル: End Date

アクティビティ・サブタイプがアクティブである最終日。
LastUpdateDate: string (date-time)

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Name

最大長: 80

アクティビティ・サブタイプの表示値。
StartDateActive: 文字列(日付)

タイトル: Start Date

アクティビティ・サブタイプがアクティブになる日付。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivitySubtypeCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the activity subtype.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the activity subtype becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The last day the activity subtype is active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ActivitySubtypeId":{
            "type":"integer",
            "description":"The unique identifier for the activity subtype.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "DefaultFlag":{
            "title":"Set as Default",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an activity subtype is the default.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity subtype is active.",
            "nullable":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The display value for the activity subtype.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who last updated the record.",
            "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."
        }
    }
}

リンク

activityTypeLookup

操作: /crmRestApi/resources/11.13.18.05/activityFunctionLookups/{activityFunctionLookupsUniqID}/child/activityTypeLookup

パラメータ:

activityFunctionLookupsUniqID: $request.path.activityFunctionLookupsUniqID

「トップに戻る」