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

機械翻訳について

アクティビティ目標の取得

get

/crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityObjectives/{ObjectiveId}

リクエスト

パス・パラメータ

ActivityNumber(required): string

アクティビティの一意の番号。外部ソースから番号を生成することもできます。
ObjectiveId(required): integer(int64)

目標の一意の識別子。

問合せパラメータ

dependency: string

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

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

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

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

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

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
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のデフォルト・バージョンを選択します。

ルート・スキーマ : activities-ActivityObjectives-item-response

タイプ: object

ソースを表示

ActivityId: integer (int64)

タイトル: Activity ID

親活動の一意の識別子。
ActivityNumber: string

最大長: 64

アクティビティの一意の番号。外部ソースから番号を生成することもできます。
ActivityObjective: string

最大長: 255

活動の目標。
ActyActivityNumber: string

タイトル: Activity Number

最大長: 64

アクティビティの一意の番号。外部ソースから番号を生成することもできます。
AttributeCategory: string

最大長: 30

アクティビティに関連付けられた属性カテゴリ。
CompletedFlag: boolean

タイトル: Complete

最大長: 1

アクティビティ目標が完了したかどうかを示します。 Trueの場合、アクティビティは完了しています。
ConflictId: integer (int64)

デフォルト値: 0

アクティビティ目標の競合の一意の識別子。
CorpCurrencyCode: string

最大長: 15

活動担当者に関連付けられた企業通貨コード。この属性は、CRM拡張フレームワークで使用されます。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CreatedBy: string

読取り専用: true

最大長: 64

アクティビティ目標を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

活動目標が作成された日時。
CurcyConvRateType: string

最大長: 30

活動担当者に関連付けられた通貨換算レート・タイプ。この属性は、CRM拡張フレームワークで使用されます。受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
CurrencyCode: string

最大長: 15

通貨コード。この属性は、CRM拡張フレームワークで使用されます。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
LastUpdateDate: string (date-time)

読取り専用: true

アクティビティ目標が最後に更新された日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

アクティビティ目標を最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

アクティビティ目標を最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

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

タイトル: Objective

最大長: 30

アクティビティの目的を示すコード。有効な値のリストは、参照ORA_ZMM_ACTIVITY_OBJECTIVEで定義されます。
ObjectiveFreefmtText: string

タイトル: Objective Text

最大長: 80

活動の目標を説明するテキスト・エリア。
ObjectiveId: integer (int64)

タイトル: Objective ID

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

シリーズのインスタンスをリンクするシリーズの一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the activity objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletedFlag":{
            "title":"Complete",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the activity objective is completed. If True, the activity is completed.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the activity objective was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the activity objective.",
            "nullable":false,
            "readOnly":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
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the parent activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The attribute category associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ActyActivityNumber":{
            "title":"Activity Number",
            "maxLength":64,
            "type":"string",
            "description":"The unique number of the activity. The number can also be generated from an external source.",
            "nullable":false,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the activity contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectiveFreefmtText":{
            "title":"Objective Text",
            "maxLength":80,
            "type":"string",
            "description":"The text area to describe the objective of the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier for the conflict in the activity objectives.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectiveCode":{
            "title":"Objective",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the objectives of an activity. A list of valid values is defined in the lookup ORA_ZMM_ACTIVITY_OBJECTIVE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActivityNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The unique number of the activity. The number can also be generated from an external source.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActivityObjective":{
            "maxLength":255,
            "type":"string",
            "description":"The objective for the activity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectiveCode",
                    "ObjectiveFreefmtText"
                ]
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the activity contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the activity objective was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the activity objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurSeriesId":{
            "type":"integer",
            "description":"The unique identifier for the series that links instances of a series together.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

リンク

ObjectiveLookup

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsEnabledFinder%3BBindLookupType%3DORA_ZMM_ACTIVITY_OBJECTIVE

アクティビティの目標を示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ObjectiveCode;ターゲット属性: LookupCode
表示属性: 意味

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、アクティビティ目標を取得する方法を示しています。

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives/300100091331231

レスポンス本文の例

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

{
"ActivityId": 300100091331227
"ObjectiveCode": "DEMO_PRODUCT"
"ObjectiveFreefmtText": "NEW_OBJ1235"
"ObjectiveId": 300100091331231
"AttributeCategory": null
"CreationDate": "2016-08-24T00:02:57-07:00"
"CreatedBy": "SALES_ADMIN"
"LastUpdateDate": "2016-08-24T00:21:53-07:00"
"LastUpdatedBy": "SALES_ADMIN"
"LastUpdateLogin": "3ACBFC03100C5FB5E053780CF10AE876"
"ObjectVersionNumber": 2
"ConflictId": 0
"CompletedFlag": false
"ActivityNumber": null
"RecurSeriesId": null
"ObjectiveCompletedFlag": "false"
"CorpCurrencyCode": "EUR"
"CurcyConvRateType": "Corporate"
"CurrencyCode": "EUR"
-
}

「トップに戻る」