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

機械翻訳について

ビジネス・プラン・リソースの作成

post

/crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanResource

リクエスト

パス・パラメータ

BusinessPlanId(required): integer(int64)

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

ヘッダー・パラメータ

Metadata-Context:

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

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

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

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

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

タイプ: object

ソースを表示

AccessLevelCode: string

タイトル: Access

最大長: 30

チーム・メンバーのアクセス・レベルを示すコード。有効な値のリストは、参照ORA_ZCA_BUS_PLAN_ACCESS_LEVELで定義されます。
BusinessPlanId: integer (int64)

タイトル: Business Plan ID

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

タイトル: Number

最大長: 64

親PUID。
BusinessPlanResourceId: integer (int64)

タイトル: Business Plan Resource ID

ビジネス・プラン・リソースの一意の識別子。
BusinessPlanResourceNumber: string

タイトル: Resource Number

最大長: 230

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

タイトル: Function

最大長: 30

チーム・メンバーの機能を示すコード。有効な値のリストは、参照MemberFunctionCodesVAで定義されます。
ResourceId: integer (int64)

タイトル: Resource ID

リソースの一意の識別子。

{
    "type":"object",
    "properties":{
        "BusinessPlanResourceNumber":{
            "title":"Resource Number",
            "maxLength":230,
            "type":"string",
            "description":"The alternate key identifier for business plan resource.",
            "nullable":false
        },
        "BusinessPlanId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The unique identifier of the business plan.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the access level of a team member. A list of valid values is defined in the lookup ORA_ZCA_BUS_PLAN_ACCESS_LEVEL.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BusinessPlanNumber":{
            "title":"Number",
            "maxLength":64,
            "type":"string",
            "description":"Parent puid.",
            "nullable":false
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the function of a team member. A list of valid values is defined in the lookup MemberFunctionCodesVA.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BusinessPlanResourceId":{
            "title":"Business Plan Resource ID",
            "type":"integer",
            "description":"The unique identifier of the business plan resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : businessPlans-BusinessPlanResource-item-response

タイプ: object

ソースを表示

AccessLevelCode: string

タイトル: Access

最大長: 30

チーム・メンバーのアクセス・レベルを示すコード。有効な値のリストは、参照ORA_ZCA_BUS_PLAN_ACCESS_LEVELで定義されます。
BusinessPlanId: integer (int64)

タイトル: Business Plan ID

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

タイトル: Number

最大長: 64

親PUID。
BusinessPlanResourceId: integer (int64)

タイトル: Business Plan Resource ID

ビジネス・プラン・リソースの一意の識別子。
BusinessPlanResourceNumber: string

タイトル: Resource Number

最大長: 230

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

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
DenormMgrId: integer (int64)

読取り専用: true

ビジネス・プラン・チーム・メンバーのマネージャの一意の識別子。
EmailAddress: string

タイトル: Email

読取り専用: true

最大長: 320

ビジネス計画チーム・メンバーの電子メール・アドレス。
FormattedPhoneNumber: string

タイトル: Phone

読取り専用: true

ビジネス計画チーム・メンバーの電話番号。
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

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

タイトル: Manager

読取り専用: true

最大長: 360

ビジネス計画チーム・メンバーのマネージャの名前。
MemberFunctionCode: string

タイトル: Function

最大長: 30

チーム・メンバーの機能を示すコード。有効な値のリストは、参照MemberFunctionCodesVAで定義されます。
OrganizationName: string

タイトル: Organization

読取り専用: true

最大長: 240

ビジネス・プラン・チーム・メンバーの組織名。
OwnerFlag: boolean

タイトル: Owner Indicator

読取り専用: true

ビジネス計画チーム・メンバーがビジネス計画の所有者であるかどうかを示します。値がTrueの場合、ビジネス計画チーム・メンバーもビジネス計画の所有者になります。デフォルト値は「False」です。
ResourceId: integer (int64)

タイトル: Resource ID

リソースの一意の識別子。
ResourceName: string

読取り専用: true

最大長: 360

チーム・メンバーの名前。
ResourceNumber: string

読取り専用: true

最大長: 30

ResourceIdに対応する代替キー。
RoleName: string

タイトル: Role

読取り専用: true

最大長: 60

チーム・メンバーのロールの名前。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrganizationName":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"The organization name of the business plan team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DenormMgrId":{
            "type":"integer",
            "description":"The unique identifier of the manager of the business plan team member.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BusinessPlanResourceNumber":{
            "title":"Resource Number",
            "maxLength":230,
            "type":"string",
            "description":"The alternate key identifier for business plan resource.",
            "nullable":false,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the access level of a team member. A list of valid values is defined in the lookup ORA_ZCA_BUS_PLAN_ACCESS_LEVEL.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerName":{
            "title":"Manager",
            "maxLength":360,
            "type":"string",
            "description":"The name of the manager of the business plan team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner Indicator",
            "type":"boolean",
            "description":"Indicates if the business plan team member is the owner of the business plan. If the value is True, then the business plan team member is also the owner of the business plan. The default value is False.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "BusinessPlanNumber":{
            "title":"Number",
            "maxLength":64,
            "type":"string",
            "description":"Parent puid.",
            "nullable":false,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The E-Mail address of the business plan team member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role",
            "maxLength":60,
            "type":"string",
            "description":"The name of the role of the team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Alternate key corresponding to ResourceId.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessPlanId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The unique identifier of the business plan.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the function of a team member. A list of valid values is defined in the lookup MemberFunctionCodesVA.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the business plan team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BusinessPlanResourceId":{
            "title":"Business Plan Resource ID",
            "type":"integer",
            "description":"The unique identifier of the business plan resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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":false
        }
    }
}

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

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

リンク

AccessLevelVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeFinder%3BBindLookupType%3DORA_ZCA_BUS_PLAN_ACCESS_LEVEL

ビジネス・プラン・チーム・メンバーのアクセス・レベルの値リスト。

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

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

MemberFunctionCodesVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{MemberFunctionCode}%2CBindLookupType%3DORA_ZCA_BUS_PLAN_TEAM_FUNC

ビジネス・プラン・チーム・メンバーの機能の値リスト。

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

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

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行して、ビジネス・プラン・リソースを作成する方法を示しています。

cURLコマンド

- curl -u <username:password> \ -X http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/businessPlans/300100091979253/child/BusinessPlanResource/

リクエスト本文の例

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

{
"ResourceId":100010032635999
}

レスポンス本文の例

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

{
"BusinessPlanId": 300100091979253,
"BusinessPlanResourceId": 300100091979256,
"BusinessPlanResourceNumber": "CDRM_25043",
"CreatedBy": "MHoope",
"CreationDate": "2016-12-12T02:53:12-08:00",
"LastUpdateDate": "2016-12-12T02:53:12-08:00",
"LastUpdateLogin": "4373F6AF02325539E05364C0F20A8DA6",
"LastUpdatedBy": "MHoope",
"MemberFunctionCode": null,
"ResourceId": 100010032635999,
"OwnerFlag": false,
"EmailAddress": "sendmail-test-discard@oracle.com",
"ResourceName": "Billy ZHRS-Taylor",
"FormattedPhoneNumber": null,
"OrganizationName": null,
"DenormMgrId": null,
"RoleName": null,
"ManagerName": null,
...
}

「トップに戻る」