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

機械翻訳について

目標の更新

patch

/crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}

リクエスト

パス・パラメータ

ObjectiveId(required): integer(int64)

目標の一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

AccountId: integer (int64)

タイトル: Account

アカウントの一意の識別子。
AccountName: string

タイトル: Account

アカウントの名前。
ActualValue: integer

タイトル: Attainment

目標の実績達成値。
BusinessPlanId: integer (int64)

タイトル: Business Plan ID

ビジネス・プランの一意の識別子。
BusinessPlanNumber: string

タイトル: Business Plan Number

最大長: 64

ビジネス・プランの代替キー識別子。
CurrencyCode: string

タイトル: Currency Code

最大長: 15

目標に関連付けられている通貨コード。有効な値のリストは、参照RatedCurrenciesVOで定義されます。
Description: string

タイトル: Description

最大長: 2000

目標の説明。
EndDisplayPeriodName: string

タイトル: End Period Name

最大長: 60

目標の終了期間の表示名。有効な値のリストは、参照SalesGLEndPeriodPickTimeListToViewAccessorで定義されます。
EndPeriodName: string

タイトル: Period End Internal Name

最大長: 15

目標の終了期間の内部名。
GeographyId: integer (int64)

タイトル: Geography

地理一意識別子。
GeographyKey: string

地理公開一意識別子。
GeographyName: string

タイトル: Geography

最大長: 255

地理の名前。
Name: string

タイトル: Name

最大長: 60

目標の名前。
ObjectiveId: integer (int64)

タイトル: Objective ID

目標の一意の識別子。
ObjectiveTypeCode: string

タイトル: Objective Type Code

最大長: 30

目標の分類方法を示すコード。コードのリストは、LovSalesObjectiveTypeVOにあります。
ObjectiveTypeName: string

タイトル: Type

最大長: 60

目標のタイプ。
PeriodTypeCode: string

タイトル: Period Type Code

最大長: 30

目標の期間のタイプを示すコード。有効な値のリストは、参照SalesObjectiveGLPeriodTypeViewAccessorで定義されます。
ProductGroupId: integer (int64)

タイトル: Product Group

製品グループの一意の識別子。
ProductGroupName: string

タイトル: Product Group

最大長: 250

製品グループの名前。
ProductGroupReferenceNumber: string

タイトル: Reference Number

最大長: 50

ProductGroup参照番号。
SalesObjectiveSplits: array Objective Splits

タイトル: Objective Splits

目標分割リソースは、目標分割の表示、作成、更新および削除に使用されます。目標分割は、1つ以上のパラメータによって制限される、市場の特定のセグメントに対する測定可能なターゲットおよび実績達成を表します。
StartDisplayPeriodName: string

タイトル: Start Period Name

最大長: 60

目標の開始期間の表示名。有効な値のリストは、参照SalesGLStartPeriodPickerTimeListViewAccessorで定義されます。
StartPeriodName: string

タイトル: Period Start Internal Name

最大長: 15

目標の開始期間の内部名。
TargetValue: integer

タイトル: Target

目標のターゲットの一意の識別子。

{
    "type":"object",
    "properties":{
        "ProductGroupId":{
            "title":"Product Group",
            "type":"integer",
            "description":"Product Group unique identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProductGroupReferenceNumber":{
            "title":"Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"ProductGroup Reference Number.",
            "nullable":false
        },
        "TargetValue":{
            "title":"Target",
            "type":"integer",
            "description":"The unique identifier for the target of the objective.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the objective.",
            "nullable":true
        },
        "ObjectiveId":{
            "title":"Objective ID",
            "type":"integer",
            "description":"The unique identifier of the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AccountId":{
            "title":"Account",
            "type":"integer",
            "description":"Account unique identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "GeographyId":{
            "title":"Geography",
            "type":"integer",
            "description":"Geography unique identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StartDisplayPeriodName":{
            "title":"Start Period Name",
            "maxLength":60,
            "type":"string",
            "description":"The display name of the start period for the objective. A list of valid values is defined in the lookup SalesGLStartPeriodPickerTimeListViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodTypeCode"
                ]
            }
        },
        "ObjectiveTypeName":{
            "title":"Type",
            "maxLength":60,
            "type":"string",
            "description":"The type of the objective.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate key identifier for the business plan.",
            "nullable":false
        },
        "GeographyName":{
            "title":"Geography",
            "maxLength":255,
            "type":"string",
            "description":"Name of the Geography.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ProductGroupName":{
            "title":"Product Group",
            "maxLength":250,
            "type":"string",
            "description":"Name of the Product Group.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the objective.",
            "nullable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the objective. A list of valid values are defined in the lookup RatedCurrenciesVO.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDisplayPeriodName":{
            "title":"End Period Name",
            "maxLength":60,
            "type":"string",
            "description":"The display name of the end period for the objective. A list of valid values is defined in the lookup SalesGLEndPeriodPickTimeListToViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodTypeCode"
                ]
            }
        },
        "GeographyKey":{
            "type":"string",
            "description":"Geography public unique identifier.",
            "nullable":true
        },
        "ObjectiveTypeCode":{
            "title":"Objective Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how the objective is categorized. The list of codes is available in LovSalesObjectiveTypeVO.",
            "nullable":false
        },
        "StartPeriodName":{
            "title":"Period Start Internal Name",
            "maxLength":15,
            "type":"string",
            "description":"The internal name of the start period for the objective.",
            "nullable":true
        },
        "BusinessPlanId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The unique identifier of the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EndPeriodName":{
            "title":"Period End Internal Name",
            "maxLength":15,
            "type":"string",
            "description":"The internal name of the end period for the objective.",
            "nullable":true
        },
        "ActualValue":{
            "title":"Attainment",
            "type":"integer",
            "description":"The actual attainment value for the objective.",
            "nullable":true
        },
        "PeriodTypeCode":{
            "title":"Period Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of period for the objective. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesObjectiveSplits":{
            "title":"Objective Splits",
            "type":"array",
            "description":"The objective splits resource is used to view, create, update, and delete objective splits. Objective splits represent a measureable target and the actual attainment for a given segment of the market restricted by one or more parameters.",
            "items":{
                "$ref":"#/components/schemas/salesObjectives-SalesObjectiveSplits-item-patch-request"
            }
        },
        "AccountName":{
            "title":"Account",
            "type":"string",
            "description":"The name of the account.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AccountId",
                    "TransientPartyType"
                ]
            }
        }
    }
}

ネストされたスキーマ : 目標分割

タイプ: array

タイトル: Objective Splits

目標分割リソースは、目標分割の表示、作成、更新および削除に使用されます。目標分割は、1つ以上のパラメータによって制限される、市場の特定のセグメントに対する測定可能なターゲットおよび実績達成を表します。

ソースを表示

Array of: object schema

{
    "title":"Objective Splits",
    "type":"array",
    "description":"The objective splits resource is used to view, create, update, and delete objective splits. Objective splits represent a measureable target and the actual attainment for a given segment of the market restricted by one or more parameters.",
    "items":{
        "$ref":"#/components/schemas/salesObjectives-SalesObjectiveSplits-item-patch-request"
    }
}

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

タイプ: object

ソースを表示

AccountId: integer (int64)

タイトル: Account

目標に割り当てられたアカウントの一意の識別子。
ActualValue: integer (int64)

タイトル: Attainment

デフォルト値: 0

目標分割の実績達成値。
GeographyName: string

タイトル: Geography

最大長: 255

地理の名前(JAPAC、EMEA、Americasなど)。
TargetValue: integer (int64)

タイトル: Target

デフォルト値: 0

目標分割のターゲットの一意の識別子。

{
    "type":"object",
    "properties":{
        "GeographyName":{
            "title":"Geography",
            "maxLength":255,
            "type":"string",
            "description":"The name of the geography, such as JAPAC, EMEA, or Americas.",
            "nullable":false
        },
        "TargetValue":{
            "title":"Target",
            "type":"integer",
            "description":"The unique identifier for the target of the objective split.",
            "format":"int64",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "AccountId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the account assigned to the objective.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ActualValue":{
            "title":"Attainment",
            "type":"integer",
            "description":"The actual attainment value for the objective split.",
            "format":"int64",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

AccountId: integer (int64)

タイトル: Account

アカウントの一意の識別子。
AccountName: string

タイトル: Account

アカウントの名前。
AccountNumber: string

読取り専用: true

最大長: 30

アカウントのPuid。
ActualValue: integer

タイトル: Attainment

目標の実績達成値。
BusinessPlanId: integer (int64)

タイトル: Business Plan ID

ビジネス・プランの一意の識別子。
BusinessPlanName: string

タイトル: Business Plan

読取り専用: true

最大長: 275

目標のビジネス計画の名前。
BusinessPlanNumber: string

タイトル: Business Plan Number

最大長: 64

ビジネス・プランの代替キー識別子。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
CurrencyCode: string

タイトル: Currency Code

最大長: 15

目標に関連付けられている通貨コード。有効な値のリストは、参照RatedCurrenciesVOで定義されます。
DeleteFlag: boolean

読取り専用: true

目標を削除できるかどうかを示します。デフォルト値はtrueです。
Description: string

タイトル: Description

最大長: 2000

目標の説明。
EndDisplayPeriodName: string

タイトル: End Period Name

最大長: 60

目標の終了期間の表示名。有効な値のリストは、参照SalesGLEndPeriodPickTimeListToViewAccessorで定義されます。
EndPeriodName: string

タイトル: Period End Internal Name

最大長: 15

目標の終了期間の内部名。
GeographyId: integer (int64)

タイトル: Geography

地理一意識別子。
GeographyKey: string

地理公開一意識別子。
GeographyName: string

タイトル: Geography

最大長: 255

地理の名前。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

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

タイトル: Last Updated By

読取り専用: true

最大長: 64

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

タイトル: Last Update Login

読取り専用: true

最大長: 32

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

タイトル: Links

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

タイトル: Name

最大長: 60

目標の名前。
ObjectiveId: integer (int64)

タイトル: Objective ID

目標の一意の識別子。
ObjectiveNumber: string

タイトル: Number

最大長: 30

目標の代替キー識別子。
ObjectiveTypeCode: string

タイトル: Objective Type Code

最大長: 30

目標の分類方法を示すコード。コードのリストは、LovSalesObjectiveTypeVOにあります。
ObjectiveTypeName: string

タイトル: Type

最大長: 60

目標のタイプ。
OrigCreationDate: string (date-time)

タイトル: Original Creation Date

外部システムで目標が最初に作成された日付。
PeriodEndDate: 文字列(日付)

タイトル: End Date

読取り専用: true

期間終了日
PeriodStartDate: 文字列(日付)

タイトル: Start Date

読取り専用: true

期間開始日
PeriodTypeCode: string

タイトル: Period Type Code

最大長: 30

目標の期間のタイプを示すコード。有効な値のリストは、参照SalesObjectiveGLPeriodTypeViewAccessorで定義されます。
PeriodTypeName: string

タイトル: Period

読取り専用: true

最大長: 80

目標の期間タイプの名前。
ProductGroupId: integer (int64)

タイトル: Product Group

製品グループの一意の識別子。
ProductGroupName: string

タイトル: Product Group

最大長: 250

製品グループの名前。
ProductGroupReferenceNumber: string

タイトル: Reference Number

最大長: 50

ProductGroup参照番号。
SalesObjectiveSplits: array Objective Splits

タイトル: Objective Splits

目標分割リソースは、目標分割の表示、作成、更新および削除に使用されます。目標分割は、1つ以上のパラメータによって制限される、市場の特定のセグメントに対する測定可能なターゲットおよび実績達成を表します。
StartDisplayPeriodName: string

タイトル: Start Period Name

最大長: 60

目標の開始期間の表示名。有効な値のリストは、参照SalesGLStartPeriodPickerTimeListViewAccessorで定義されます。
StartPeriodName: string

タイトル: Period Start Internal Name

最大長: 15

目標の開始期間の内部名。
TargetValue: integer

タイトル: Target

目標のターゲットの一意の識別子。
UnitOfMeasureCode: string

タイトル: Unit of Measure Code

読取り専用: true

最大長: 30

目標の単位を示すコード。
UnitOfMeasureName: string

タイトル: Unit of Measure

読取り専用: true

最大長: 80

目標の単位。
UpdateFlag: boolean

読取り専用: true

目標を更新できるかどうかを示します。デフォルト値はtrueです。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "title":"Unit of Measure Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the unit of measure for the objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectiveId":{
            "title":"Objective ID",
            "type":"integer",
            "description":"The unique identifier of the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account",
            "type":"integer",
            "description":"Account unique identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GeographyId":{
            "title":"Geography",
            "type":"integer",
            "description":"Geography unique identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDisplayPeriodName":{
            "title":"Start Period Name",
            "maxLength":60,
            "type":"string",
            "description":"The display name of the start period for the objective. A list of valid values is defined in the lookup SalesGLStartPeriodPickerTimeListViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodTypeCode"
                ]
            },
            "x-queryable":true
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate key identifier for the business plan.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group",
            "maxLength":250,
            "type":"string",
            "description":"Name of the Product Group.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Period End Date",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the objective.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the objective. A list of valid values are defined in the lookup RatedCurrenciesVO.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDisplayPeriodName":{
            "title":"End Period Name",
            "maxLength":60,
            "type":"string",
            "description":"The display name of the end period for the objective. A list of valid values is defined in the lookup SalesGLEndPeriodPickTimeListToViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodTypeCode"
                ]
            },
            "x-queryable":true
        },
        "GeographyKey":{
            "type":"string",
            "description":"Geography public unique identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessPlanName":{
            "title":"Business Plan",
            "maxLength":275,
            "type":"string",
            "description":"The name of the business plan for the objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the objective can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BusinessPlanId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The unique identifier of the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectiveNumber":{
            "title":"Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the objective.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrigCreationDate":{
            "title":"Original Creation Date",
            "type":"string",
            "description":"The date when the objective was originally created in an external system.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SalesObjectiveSplits":{
            "title":"Objective Splits",
            "type":"array",
            "description":"The objective splits resource is used to view, create, update, and delete objective splits. Objective splits represent a measureable target and the actual attainment for a given segment of the market restricted by one or more parameters.",
            "items":{
                "$ref":"#/components/schemas/salesObjectives-SalesObjectiveSplits-item-response"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupId":{
            "title":"Product Group",
            "type":"integer",
            "description":"Product Group unique identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductGroupReferenceNumber":{
            "title":"Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"ProductGroup Reference Number.",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodTypeName":{
            "title":"Period",
            "maxLength":80,
            "type":"string",
            "description":"The name of the period type for the objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetValue":{
            "title":"Target",
            "type":"integer",
            "description":"The unique identifier for the target of the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectiveTypeName":{
            "title":"Type",
            "maxLength":60,
            "type":"string",
            "description":"The type of the objective.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "GeographyName":{
            "title":"Geography",
            "maxLength":255,
            "type":"string",
            "description":"Name of the Geography.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the objective can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Period Start Date",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Puid for the Account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectiveTypeCode":{
            "title":"Objective Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how the objective is categorized. The list of codes is available in LovSalesObjectiveTypeVO.",
            "nullable":false,
            "x-queryable":true
        },
        "StartPeriodName":{
            "title":"Period Start Internal Name",
            "maxLength":15,
            "type":"string",
            "description":"The internal name of the start period for the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "EndPeriodName":{
            "title":"Period End Internal Name",
            "maxLength":15,
            "type":"string",
            "description":"The internal name of the end period for the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualValue":{
            "title":"Attainment",
            "type":"integer",
            "description":"The actual attainment value for the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodTypeCode":{
            "title":"Period Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of period for the objective. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UnitOfMeasureName":{
            "title":"Unit of Measure",
            "maxLength":80,
            "type":"string",
            "description":"The unit of measure of the objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the record 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 of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account",
            "type":"string",
            "description":"The name of the account.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AccountId",
                    "TransientPartyType"
                ]
            },
            "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

タイトル: Objective Splits

ソースを表示

Array of: object salesObjectives-SalesObjectiveSplits-item-response

{
    "title":"Objective Splits",
    "type":"array",
    "description":"The objective splits resource is used to view, create, update, and delete objective splits. Objective splits represent a measureable target and the actual attainment for a given segment of the market restricted by one or more parameters.",
    "items":{
        "$ref":"#/components/schemas/salesObjectives-SalesObjectiveSplits-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."
        }
    }
}

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

タイプ: object

ソースを表示

AccountId: integer (int64)

タイトル: Account

目標に割り当てられたアカウントの一意の識別子。
ActualValue: integer (int64)

タイトル: Attainment

デフォルト値: 0

目標分割の実績達成値。
CreatedBy: string

読取り専用: true

最大長: 64

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

読取り専用: true

レコードが作成された日付。
DisplayPeriodName: string

タイトル: Period

最大長: 15

目標分割期間の表示名。
GeographyId: integer (int64)

タイトル: Geography

地理の一意の識別子。
GeographyName: string

タイトル: Geography

最大長: 255

地理の名前(JAPAC、EMEA、Americasなど)。
LastUpdateDate: string (date-time)

読取り専用: true

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

読取り専用: true

最大長: 64

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

読取り専用: true

最大長: 32

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

タイトル: Links

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

タイトル: Objective

目標の一意の識別子。
ObjectiveSplitId: integer (int64)

目標分割の一意の識別子。
PartyUniqueName: string

読取り専用: true

最大長: 900

アカウントの名前。
PeriodType: string

タイトル: Period Type Code

最大長: 30

目標分割の期間のタイプ。
ProdGroupName: string

タイトル: Product Group

読取り専用: true

最大長: 250

製品グループの名前。
ProductId: integer (int64)

タイトル: Product Group

製品の一意の識別子。
TargetValue: integer (int64)

タイトル: Target

デフォルト値: 0

目標分割のターゲットの一意の識別子。

{
    "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
        },
        "ProdGroupName":{
            "title":"Product Group",
            "maxLength":250,
            "type":"string",
            "description":"The name of the product group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodType":{
            "title":"Period Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of period for the objective split.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetValue":{
            "title":"Target",
            "type":"integer",
            "description":"The unique identifier for the target of the objective split.",
            "format":"int64",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyId":{
            "title":"Geography",
            "type":"integer",
            "description":"The unique identifier for the geography.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectiveId":{
            "title":"Objective",
            "type":"integer",
            "description":"The unique identifier of the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the account assigned to the objective.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyUniqueName":{
            "maxLength":900,
            "type":"string",
            "description":"The name of the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyName":{
            "title":"Geography",
            "maxLength":255,
            "type":"string",
            "description":"The name of the geography, such as JAPAC, EMEA, or Americas.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductId":{
            "title":"Product Group",
            "type":"integer",
            "description":"The unique identifier for the product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActualValue":{
            "title":"Attainment",
            "type":"integer",
            "description":"The actual attainment value for the objective split.",
            "format":"int64",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectiveSplitId":{
            "type":"integer",
            "description":"The unique identifier of the objective split.",
            "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"
            }
        },
        "DisplayPeriodName":{
            "title":"Period",
            "maxLength":15,
            "type":"string",
            "description":"The display name for the objective split period.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PeriodType"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date on which the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The 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"
    }
}

リンク

LovSalesObjectiveTypeVO

操作: /crmRestApi/resources/11.13.18.05/salesObjectiveTypes

パラメータ:

ファインダ: SalesObjectiveTypeFinder%3BBindObjectiveTypeCode%3D{ObjectiveTypeCode}

営業目的タイプ

ProductGroupViewAccessor

操作: /crmRestApi/resources/11.13.18.05/productGroups

パラメータ:

ファインダ: ProductGroupList

製品グループ詳細ベース・パブリック・ビュー・オブジェクトの名前。

RatedCurrenciesVO

操作: /crmRestApi/resources/11.13.18.05/ratedCurrencies

レート通貨リソースは、CRMの通貨コードの詳細を表示するために使用されます。ルックアップZCA_COMMON_CORPORATE_CURRENCYに定義されている、受け入れられる値のリストが表示されます。

SalesGLEndPeriodPickTimeListToViewAccessor

操作: /crmRestApi/resources/11.13.18.05/salesGLEndPeriodTimesLOV

パラメータ:

ファインダ: EndPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}

終了期間リソースを使用すると、すべての終了期間を表示できます。

SalesGLStartPeriodPickerTimeListViewAccessor

操作: /crmRestApi/resources/11.13.18.05/salesGLStartPeriodTimesLOV

パラメータ:

ファインダ: StartPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}

開始期間リソースを使用すると、開始期間を表示できます。

SalesObjectiveGLPeriodTypeViewAccessor

操作: /crmRestApi/resources/11.13.18.05/salesGLPeriodTypes

期間タイプ・リソースを使用すると、使用可能なすべての期間タイプを表示できます。

SalesObjectiveSplits

操作: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits

パラメータ:

ObjectiveId: $request.path.ObjectiveId

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するパッチ・リクエストを発行することによって、目標を更新する方法を示しています。

cURLコマンド

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

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
"Name" : "Obj_REST_Updated"
}

レスポンス本文の例

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

{
"ActualValue": null,
"BusinessPlanId": null,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2016-11-10T23:07:56-08:00",
"CurrencyCode": "USD",
"Description": null,
"EndPeriodName": null,
"LastUpdateDate": "2016-11-10T23:22:55-08:00",
"LastUpdateLogin": "4101B34432126FE8E05392D0F00A4D46",
"LastUpdatedBy": "SALES_ADMIN",
"Name": "Obj_REST",
"ObjectiveId": 300100091619347,
"ObjectiveTypeCode": "Amount",
"PeriodTypeCode": "YEAR",
"StartPeriodName": null,
"TargetValue": null,
"ObjectiveNumber": "CDRM_12006",
"OrigCreationDate": "2016-11-10T23:07:56-08:00",
"UnitOfMeasureCode": "AMOUNT",
"ObjectiveTypeName": "Amount",
"UnitOfMeasureName": "Amount",
"PeriodTypeName": "Year",
"BusinessPlanName": null,
"BusinessPlanNumber": null,
"StartDisplayPeriodName": "2016",
"EndDisplayPeriodName": "2017",
"UpdateFlag": true,
"DeleteFlag": true,
"links":[
{"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347",???},
{"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347",???},
{"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/lov/LovSalesObjectiveTypeVO",???},
{"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/lov/SalesGLStartPeriodPickerTimeListViewAccessor",???},
{"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/lov/SalesObjectiveGLPeriodTypeViewAccessor",???},
{"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/lov/RatedCurrenciesVO",???},
{"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/lov/SalesGLEndPeriodPickTimeListToViewAccessor",???},
{"rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/child/SalesObjectiveSplits",???}
]
}

「トップに戻る」