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

機械翻訳について

すべてのビジネス計画の取得

get

/crmRestApi/resources/11.13.18.05/businessPlans

リクエスト

問合せパラメータ

expand: string

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

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

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

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- AllBusinessPlansFinder : ユーザーがアクセス権を持つすべてのビジネス・プランを検索します。
  ファインダ変数:
- MyBusinessPlansFinder : 主キー情報を持つビジネス・プラン所有者を検索します。
  ファインダ変数:
  - BusinessPlanOwnerId; string; ビジネス・プランの所有者の一意の識別子。
- PrimaryKey : 主キー情報を持つビジネス・プランを検索します。
  ファインダ変数:
  - BusinessPlanId; integer;ビジネス・プランの一意の識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

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

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

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

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- BusinessPlanClassCode; string; ビジネス・プランのクラスを示すコード。有効な値のリストは、参照BusinessPlanClassVAで定義されます。
- BusinessPlanId; integer;ビジネス・プランの一意の識別子。
- BusinessPlanNumber; string;ビジネス計画の代替キー識別子。
- BusinessPlanOwnerNumber; string; BusinessPlanOwnerIdに対応する代替キー。
- BusinessPlanTypeCode; string; ビジネス・プランのタイプを示すコード。有効な値のリストは、参照BusinessPlanTypeVAで定義されます。
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string;レコードが作成された日付。
- CustomerId; integer;ビジネス・プラン・アカウントの一意の識別子。
- CustomerNumber; string; CustomerIdに対応する代替キー。
- CustomerPartyType; string; ビジネス・プランに関連付けられている顧客のパーティ・タイプ。有効な値のリストは、参照CA_RECORD_TYPEで定義されます。指定可能な値は、組織、グループまたは個人です。
- 説明;文字列;ビジネス計画の説明。
- LastUpdateDate; string; レコードが最後に更新された日付。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- 名前、文字列、ビジネス計画の名前。
- OrigCreationDate; string; ビジネス・プランが最初に作成された日付。
- OwnerResourceName; string;ビジネス・プラン所有者の名前。
- PartnerNumber; string; PartnerIdに対応する代替キー。
- PartnerPartyDisplayName; string; ビジネス・プランのパートナの表示名。
- PeriodEndDate;文字列;期間終了日
- PeriodEndName; string; ビジネス・プラン期間の終了の内部名。
- PeriodRangeDisplayName; string;ビジネス期間範囲の表示名。
- PeriodStartDate;文字列;期間開始日
- PeriodStartName; string; ビジネス・プラン期間の開始の内部名。
- PeriodTypeCode; string; ビジネス・プランの期間を示すコード。有効な値のリストは、参照SalesObjectiveGLPeriodTypeViewAccessorで定義されます。
- SourceType; string; ビジネス・プランのアクティビティの取得に使用されるソース・タイプ。
- StatusCode; string; ビジネス・プランのステータスを示すコード。有効な値のリストは、参照BusinessPlanStatusVAで定義されます。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

Metadata-Context:

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

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

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : businessPlans

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

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

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/businessPlans-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

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

タイプ: array

タイトル: Items

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

ソースを表示

Array of: object businessPlans-item-response

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

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

タイプ: object

ソースを表示

BusinessPlanClassCode: string

タイトル: Class

最大長: 20

デフォルト値: PARTNER

ビジネス・プランのクラスを示すコード。有効な値のリストは、参照BusinessPlanClassVAで定義されます。
BusinessPlanId: integer (int64)

タイトル: Business Plan ID

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

タイトル: Number

最大長: 64

ビジネス・プランの代替キー識別子。
BusinessPlanOwnerId: integer (int64)

タイトル: Owner ID

ビジネス・プラン所有者の一意の識別子。
BusinessPlanOwnerNumber: string

タイトル: Owner Number

読取り専用: true

最大長: 30

BusinessPlanOwnerIdに対応する代替キー。
BusinessPlanResource: array Business Plan Resources

タイトル: Business Plan Resources

ビジネス・プラン・リソースは、ビジネス・プランに関連付けられているチーム・メンバーを表示、作成、更新および削除するために使用されます。
BusinessPlanTypeCode: string

タイトル: Type

最大長: 30

ビジネス・プランのタイプを示すコード。有効な値のリストは、参照BusinessPlanTypeVAで定義されます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

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

タイトル: Customer ID

ビジネス・プラン・アカウントの一意の識別子。
CustomerNumber: string

タイトル: Customer Number

読取り専用: true

最大長: 30

CustomerIdに対応する代替キー。
CustomerPartyType: string

タイトル: Customer Type

読取り専用: true

最大長: 30

ビジネス・プランに関連付けられている顧客のパーティ・タイプ。有効な値のリストは、参照CA_RECORD_TYPEで定義されます。指定可能な値は、組織、グループまたは個人です。
DeleteFlag: boolean

読取り専用: true

ビジネス・プランを削除できるかどうかを示します。
Description: string

タイトル: Description

最大長: 3000

ビジネス・プランの摘要。
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

最大長: 275

ビジネス計画の名前。
Note: array Notes

タイトル: Notes

ノート・リソースは、ビジネス・プランに関連付けられたノートの表示、作成、更新および削除に使用されます。ノートは、ビジネス・プランに関連するコメント、情報またはインストラクションを取得します。
OrigCreationDate: string (date-time)

タイトル: Original Creation Date

ビジネス計画が最初に作成された日付。
OwnerResourceName: string

タイトル: Owner

最大長: 360

ビジネス計画所有者の名前。
PartnerId: integer (int64)

タイトル: Partner ID

ビジネス・プラン・パートナの一意の識別子。
PartnerName: string

タイトル: Partner

読取り専用: true

最大長: 80

ビジネス計画に関連付けられているパートナの名前。
PartnerNumber: string

タイトル: Partner Number

最大長: 30

PartnerIdに対応する代替キー。
PartnerPartyDisplayName: string

タイトル: Partner

最大長: 360

ビジネス・プランのパートナの表示名。
PeriodEndDate: 文字列(日付)

タイトル: End Date

読取り専用: true

期間終了日
PeriodEndDisplayName: string

タイトル: Period End Name

最大長: 30

ビジネス・プラン期間の終了の表示名。
PeriodEndName: string

タイトル: Period End Internal Name

最大長: 30

ビジネス・プラン期間の終了の内部名。
PeriodRangeDisplayName: string

タイトル: Period

最大長: 80

ビジネス期間範囲の表示名。
PeriodSetName: string

最大長: 15

ビジネス・プラン期間のカレンダの名前。
PeriodStartDate: 文字列(日付)

タイトル: Start Date

読取り専用: true

期間開始日
PeriodStartDisplayName: string

タイトル: Period Start Name

最大長: 30

ビジネス・プラン期間の開始の表示名。
PeriodStartName: string

タイトル: Period Start Internal Name

最大長: 30

ビジネス・プラン期間の開始の内部名。
PeriodTypeCode: string

タイトル: Period Type

最大長: 30

ビジネス・プランの期間を示すコード。有効な値のリストは、参照SalesObjectiveGLPeriodTypeViewAccessorで定義されます。
SourceType: string

読取り専用: true

ビジネス・プランのアクティビティの取得に使用されるソース・タイプ。
StatusCode: string

タイトル: Status

最大長: 30

ビジネス・プランのステータスを示すコード。有効な値のリストは、参照BusinessPlanStatusVAで定義されます。
Swot: array SWOTs

タイトル: SWOTs

SWOTsリソースは、ビジネス・プランの長所、短所、商談および脅威の表示、作成、更新および削除に使用されます。
UpdateFlag: boolean

読取り専用: true

ビジネス・プランを更新できるかどうかを示します。デフォルト値はtrueです。

{
    "type":"object",
    "properties":{
        "PartnerPartyDisplayName":{
            "title":"Partner",
            "maxLength":360,
            "type":"string",
            "description":"The display name of the partner for the business plan.",
            "nullable":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":true
        },
        "Description":{
            "title":"Description",
            "maxLength":3000,
            "type":"string",
            "description":"The description of the business plan.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceType":{
            "type":"string",
            "description":"The source type to be used for retrieving the Activities of the Business Plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessPlanNumber":{
            "title":"Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate key identifier of a business plan.",
            "nullable":false,
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The unique identifier of the business plan partner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodStartName":{
            "title":"Period Start Internal Name",
            "maxLength":30,
            "type":"string",
            "description":"The internal name for the start of the business plan period.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodSetName":{
            "maxLength":15,
            "type":"string",
            "description":"The name of the calendar for the business plan period.",
            "nullable":true,
            "x-queryable":false
        },
        "PeriodStartDisplayName":{
            "title":"Period Start Name",
            "maxLength":30,
            "type":"string",
            "description":"The display name for the start of the business plan period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Period End Date",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the business plan. A list of valid values is defined in the lookup BusinessPlanStatusVA.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Swot":{
            "title":"SWOTs",
            "type":"array",
            "description":"The SWOTs resource is used to view, create, update, and delete a business plan's strengths, weaknesses, opportunities, and threats.",
            "items":{
                "$ref":"#/components/schemas/businessPlans-Swot-item-response"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":275,
            "type":"string",
            "description":"The name of the business plan.",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodRangeDisplayName":{
            "title":"Period",
            "maxLength":80,
            "type":"string",
            "description":"The display name of the business period range.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the business plan 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":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerNumber":{
            "title":"Customer Number",
            "maxLength":30,
            "type":"string",
            "description":"Alternate Key corresponding to CustomerId.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessPlanTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of business plan. A list of valid values is defined in the lookup BusinessPlanTypeVA.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerResourceName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the business plan owner.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "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 business plan was first created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessPlanOwnerNumber":{
            "title":"Owner Number",
            "maxLength":30,
            "type":"string",
            "description":"Alternate key corresponding to BusinessPlanOwnerId.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessPlanResource":{
            "title":"Business Plan Resources",
            "type":"array",
            "description":"Business plan resources is used to view, create, update, and delete the team members associated with a business plan.",
            "items":{
                "$ref":"#/components/schemas/businessPlans-BusinessPlanResource-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
        },
        "PeriodEndDisplayName":{
            "title":"Period End Name",
            "maxLength":30,
            "type":"string",
            "description":"The display name for the end of the business plan period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"The unique identifier of the business plan account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerName":{
            "title":"Partner",
            "maxLength":80,
            "type":"string",
            "description":"The name of the partner associated with the business plan.",
            "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
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the business plan can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BusinessPlanClassCode":{
            "title":"Class",
            "maxLength":20,
            "type":"string",
            "description":"A code indicating the class of a business plan.  A list of valid values is defined in the lookup BusinessPlanClassVA.",
            "nullable":false,
            "default":"PARTNER",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BusinessPlanOwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the business plan owner.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodEndName":{
            "title":"Period End Internal Name",
            "maxLength":30,
            "type":"string",
            "description":"The internal name for the end of the business plan period.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerPartyType":{
            "title":"Customer Type",
            "maxLength":30,
            "type":"string",
            "description":"The party type of the customer associated with the business plan. Alist of valid values is defined in the lookup CA_RECORD_TYPE. Possible values are Organisation, Group, or Person.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartnerNumber":{
            "title":"Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"Alternate Key corresponding to PartnerId.",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodTypeCode":{
            "title":"Period Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the period of the business plan. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Note":{
            "title":"Notes",
            "type":"array",
            "description":"The notes resource is used to view, create, update, and delete notes associated with a business plan. A note captures comments, information, or instructions related to an business plan.",
            "items":{
                "$ref":"#/components/schemas/businessPlans-Note-item-response"
            }
        },
        "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":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":false
        }
    }
}

ネストされたスキーマ : ビジネス・プランのリソース

タイプ: array

タイトル: Business Plan Resources

ビジネス・プラン・リソースは、ビジネス・プランに関連付けられているチーム・メンバーを表示、作成、更新および削除するために使用されます。

ソースを表示

Array of: object businessPlans-BusinessPlanResource-item-response

{
    "title":"Business Plan Resources",
    "type":"array",
    "description":"Business plan resources is used to view, create, update, and delete the team members associated with a business plan.",
    "items":{
        "$ref":"#/components/schemas/businessPlans-BusinessPlanResource-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"
    }
}

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

タイプ: array

タイトル: Notes

ノート・リソースは、ビジネス・プランに関連付けられたノートの表示、作成、更新および削除に使用されます。ノートは、ビジネス・プランに関連するコメント、情報またはインストラクションを取得します。

ソースを表示

Array of: object businessPlans-Note-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The notes resource is used to view, create, update, and delete notes associated with a business plan. A note captures comments, information, or instructions related to an business plan.",
    "items":{
        "$ref":"#/components/schemas/businessPlans-Note-item-response"
    }
}

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

タイプ: array

タイトル: SWOTs

SWOTsリソースは、ビジネス・プランの長所、短所、商談および脅威の表示、作成、更新および削除に使用されます。

ソースを表示

Array of: object businessPlans-Swot-item-response

{
    "title":"SWOTs",
    "type":"array",
    "description":"The SWOTs resource is used to view, create, update, and delete a business plan's strengths, weaknesses, opportunities, and threats.",
    "items":{
        "$ref":"#/components/schemas/businessPlans-Swot-item-response"
    }
}

ネストされたスキーマ : 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."
        }
    }
}

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

タイプ: object

ソースを表示

ContactRelationshipId: integer (int64)

タイトル: Contact Relationship ID

リレーションの一意の識別子。この値は、ノートが担当者に関連付けられているときに移入されます。
CorpCurrencyCode: string

タイトル: Corporate Currency Code

最大長: 15

担当者に関連付けられたノートの企業通貨コード。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

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

タイトル: Creator Party ID

ノート作成者のパーティの一意の識別子。
CurcyConvRateType: string

タイトル: Currency Conversion Rate Type

最大長: 30

ノートに関連付けられた通貨換算レート・タイプ。受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。
CurrencyCode: string

タイトル: Currency

最大長: 15

ノートに関連付けられた通貨コード。受け入れられる値のリストは、参照RatedCurrenciesVAで定義されます。
DeleteFlag: boolean

タイトル: Delete Indicator

読取り専用: true

ビジネス・プラン・ノートを削除できるかどうかを示します。デフォルト値はtrueです。
EmailAddress: string

タイトル: Primary Email

読取り専用: true

最大長: 320

ノートを作成したユーザーの電子メール・アドレス。
FormattedAddress: string

タイトル: Primary Address

読取り専用: true

ノートを作成したユーザーの住所。
FormattedPhoneNumber: string

タイトル: Primary Phone

読取り専用: true

ノートを作成したユーザーの電話番号。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

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

タイトル: Last Updated By

読取り専用: true

最大長: 64

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

タイトル: Last Update Login

読取り専用: true

最大長: 32

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

タイトル: Links

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

タイトル: Note ID

読取り専用: true

ビジネス・プランのノートの一意の識別子。
NoteNumber: string

最大長: 30

ノートの代替一意識別子。システム生成または外部システムからのユーザー・キー。
NoteTitle: string

タイトル: Title

最大長: 500

ユーザーが入力したノートのタイトル。
NoteTxt: 文字列(バイト)

タイトル: Note

実際のノートのテキスト。
NoteTypeCode: string

タイトル: Type

最大長: 30

これは、ノートを分類するためのノート・タイプ・コードです。有効な値のリストは、参照NoteSourceTypeVAで定義されます。
ParentNoteId: integer (int64)

タイトル: Parent Note ID

親ノートの一意の識別子。
PartyId: integer (int64)

タイトル: Party ID

読取り専用: true

ノートが関連付けられている担当者の一意の識別子。この場合、CreatorPartyIdと同じです。
PartyName: string

タイトル: Author

読取り専用: true

最大長: 360

ビジネス・プランに関連付けられているパーティの名前。
SourceObjectCode: string

タイトル: Related Object Type

最大長: 30

OBJECTS Metadataで定義されたソース・オブジェクトを示すコード(アクティビティ、商談、販売ビジネス・プランなど)。
SourceObjectId: string

タイトル: Related Object

最大長: 64

OBJECTS Metadataで定義されたソース・オブジェクトの主キー識別子(アクティビティ、商談、販売ビジネス・プランなど)。
UpdateFlag: boolean

タイトル: Update Indicator

読取り専用: true

ビジネス・プラン・ノートを更新できるかどうかを示します。デフォルト値はtrueです。
VisibilityCode: string

タイトル: Private

最大長: 30

デフォルト値: INTERNAL

これは、ノートの表示レベルを指定するための属性です。有効な値のリストは、参照NoteVisibilityLookupVAで定義されます。

{
    "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
        },
        "PartyName":{
            "title":"Author",
            "maxLength":360,
            "type":"string",
            "description":"The name of party associated with the business plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"This is the attribute to specify the visibility level of the note. A list of valid values is defined in the lookup NoteVisibilityLookupVA.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationshi, this value is populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the note. A list of accepted values is defined in the lookup RatedCurrenciesVA.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the business plan note can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the note for the business plan.",
            "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-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the note creator's party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"The address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"This is the note type code for categorization of note. A list of valid values is defined in the lookup NoteSourceTypeVA.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the business plan note can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"The primary key identifier of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique Identifier of the contact with whom the note is associated. In this case, same as CreatorPartyId.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when 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
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

タイプ: object

ソースを表示

BusinessPlanId: integer (int64)

タイトル: Business Plan ID

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

タイトル: Business Plan Number

最大長: 64

親PUID。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

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

タイトル: Description

最大長: 2000

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

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

タイトル: SWOT ID

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

タイトル: Number

最大長: 64

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

タイトル: Type Code

最大長: 30

ビジネス・プランSWOTのタイプを示すコード。有効な値のリストは、参照ORA_ZCA_BUS_PLAN_SWOTで定義されます。指定可能な値は、Opportunity(商談)、Strength(強さ)、Threat(脅威)、Weakmess(弱い)です。

{
    "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
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SWOTTypeCode":{
            "title":"Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of business plan SWOT. A list of valid values is defined in the lookup ORA_ZCA_BUS_PLAN_SWOT. Possible values are Opportunity, Strength, Threat, or Weakmess.",
            "nullable":false,
            "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
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the SWOT.",
            "nullable":false,
            "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
            }
        },
        "SWOTId":{
            "title":"SWOT ID",
            "type":"integer",
            "description":"The unique identifier of the business plan SWOT.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SWOTNumber":{
            "title":"Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate key identifier for the business plan SWOT.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "maxLength":64,
            "type":"string",
            "description":"Parent puid.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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"
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのビジネス・プランを取得する方法を示しています。

cURLコマンド

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

レスポンス本文の例

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

{
"items": [
  {
"BusinessPlanClassCode": "PARTNER",
"BusinessPlanId": 300100089695451,
"Name": "AUTOBPNAME_c7577740946",
"BusinessPlanNumber": "CDRM_7008",
"BusinessPlanOwnerId": 100010038017849,
"BusinessPlanTypeCode": null,
"CreatedBy": "CHANNEL_SALES_MGR",
"CreationDate": "2016-06-03T11:15:48-07:00",
"Description": null,
"LastUpdateDate": "2016-06-03T11:15:51-07:00",
"LastUpdateLogin": "3462E43397E9A13FE0532AB0F20AD2A5",
"LastUpdatedBy": "CHANNEL_SALES_MGR",
"PartnerId": 300100089683791,
"PeriodTypeCode": "YEAR",
"PeriodSetName": "Accounting12",
"PeriodStartName": "01-15",
"PeriodEndName": "12-15",
"StatusCode": "ORA_DRAFT",
"OwnerResourceName": "Channel_Sales_Mgr_ENT2 CSM",
"PartnerName": "OrgName_13873809212",
"PeriodStartDisplayName": "2015",
"PeriodEndDisplayName": "2015",
"PeriodRangeDisplayName": "2015",
"OrigCreationDate": "2016-06-03T11:15:48-07:00",
"PartnerPartyDisplayName": "OrgName_13873809212",
"UpdateFlag": true,
"DeleteFlag": true,
"SourceType": "SALES_BUSINESS_PLAN",
...
},
  {
"BusinessPlanClassCode": "PARTNER",
"BusinessPlanId": 300100089800166,
"Name": "AUTOBPNAME_f2554956076",
"BusinessPlanNumber": "CDRM_10008",
"BusinessPlanOwnerId": 100010038017849,
"BusinessPlanTypeCode": null,
"CreatedBy": "CHANNEL_SALES_MGR",
"CreationDate": "2016-06-05T12:29:22-07:00",
"Description": null,
"LastUpdateDate": "2016-06-05T12:29:25-07:00",
"LastUpdateLogin": "348C468C90248AAFE0532AB0F20A7F7C",
"LastUpdatedBy": "CHANNEL_SALES_MGR",
"PartnerId": 300100089785026,
"PeriodTypeCode": "YEAR",
"PeriodSetName": "Accounting12",
"PeriodStartName": "01-15",
"PeriodEndName": "12-15",
"StatusCode": "ORA_DRAFT",
"OwnerResourceName": "Channel_Sales_Mgr_ENT2 CSM",
"PartnerName": "RESTORG_57451230678",
"PeriodStartDisplayName": "2015",
"PeriodEndDisplayName": "2015",
"PeriodRangeDisplayName": "2015",
"OrigCreationDate": "2016-06-05T12:29:22-07:00",
"PartnerPartyDisplayName": "RESTORG_57451230678",
"UpdateFlag": true,
"DeleteFlag": true,
"SourceType": "SALES_BUSINESS_PLAN",
...
},
...

「トップに戻る」