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

機械翻訳について

ビジネス・ユニットの取得

get

/crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}

リクエスト

パス・パラメータ

crmBusinessUnitsUniqID(required): string

これは、CRMビジネス・ユニット・リソースのコンポジット・キーを構成し、CRMビジネス・ユニットのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、ハッシュ・キーを取得するためにCRMビジネス・ユニットの特定のインスタンスに移動するために、CRMビジネス・ユニットの収集リソースを問い合せる必要があります。

問合せパラメータ

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

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

タイプ: object

ソースを表示

assessmentTemplates: array Assessment Templates

タイトル: Assessment Templates

査定テンプレート・リソースは、査定テンプレートの表示に使用されます。アセスメントに関連付けられたテンプレートが格納されます。
BUId: integer

読取り専用: true

ビジネス・ユニットの一意の識別子。
BUName: string

読取り専用: true

ビジネス・ユニットの名前。
BusinessUnitId: integer

読取り専用: true

ビジネス・ユニットの一意の識別子。
DefaultBUFlag: boolean

読取り専用: true

現在のビジネス・ユニットがログイン・ユーザーのデフォルト・ビジネス・ユニットであるかどうかを示します。この値はtrueおよびfalseです。
fndCommonSetIdLookups: array Common Set Id Lookups

タイトル: Common Set Id Lookups

共通セットID参照リソースは、セットID対応参照タイプの参照値を表示するために使用されます。
links: array Links

タイトル: Links

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

読取り専用: true

ビジネス・ユニットの名前。
optyStatus: array Opportunity Status Values

タイトル: Opportunity Status Values

商談ステータス値のリソースを使用して、商談ステータス値を表示します。構成可能な設定データは、販売用途に特化して定義されます。
salesMethods: array Sales Methods

タイトル: Sales Methods

販売メソッド・リソースは、販売プロセスで使用されるアプローチを表示するために使用されます。メソッドには、商談の見込み、売上予想、クローズなど、セールス・プロセスに関連付けられたすべてのステージを含めることができます。

{
    "type":"object",
    "properties":{
        "BUId":{
            "type":"integer",
            "description":"The unique identifier of a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "dependencies":[
                    "BuId"
                ]
            },
            "x-queryable":true
        },
        "salesMethods":{
            "title":"Sales Methods",
            "type":"array",
            "description":"The sales methods resource is used to view an approach which is used in the sales process. A method can encompass every stage associated with the sales process such as prospecting, forecasting, or closing opportunities.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-item-response"
            }
        },
        "assessmentTemplates":{
            "title":"Assessment Templates",
            "type":"array",
            "description":"The assesment templates resource is used to view the assesment templates. It stores the templates associated with assessments.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-assessmentTemplates-item-response"
            }
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "dependencies":[
                    "BuId"
                ]
            },
            "x-queryable":true
        },
        "fndCommonSetIdLookups":{
            "title":"Common Set Id Lookups",
            "type":"array",
            "description":"The common set id lookups resource is used to view lookup values for set id enabled lookup types.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-fndCommonSetIdLookups-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BUName":{
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "dependencies":[
                    "BuName"
                ]
            },
            "x-queryable":true
        },
        "optyStatus":{
            "title":"Opportunity Status Values",
            "type":"array",
            "description":"The opportunity status values resource is used to view the opportunity status value. The configurable setup data is defined specifically for sales usage.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-optyStatus-item-response"
            }
        },
        "DefaultBUFlag":{
            "type":"boolean",
            "description":"Indicates whether the current business unit is logged in user's default business unit. It has the value true and false.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "dependencies":[
                    "BuId"
                ]
            },
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate",
                "dependencies":[
                    "BuName"
                ]
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : アセスメント・テンプレート

タイプ: array

タイトル: Assessment Templates

査定テンプレート・リソースは、査定テンプレートの表示に使用されます。アセスメントに関連付けられたテンプレートが格納されます。

ソースを表示

Array of: object crmBusinessUnits-assessmentTemplates-item-response

{
    "title":"Assessment Templates",
    "type":"array",
    "description":"The assesment templates resource is used to view the assesment templates. It stores the templates associated with assessments.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-assessmentTemplates-item-response"
    }
}

ネストされたスキーマ : 共通セットID参照

タイプ: array

タイトル: Common Set Id Lookups

共通セットID参照リソースは、セットID対応参照タイプの参照値を表示するために使用されます。

ソースを表示

Array of: object crmBusinessUnits-fndCommonSetIdLookups-item-response

{
    "title":"Common Set Id Lookups",
    "type":"array",
    "description":"The common set id lookups resource is used to view lookup values for set id enabled lookup types.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-fndCommonSetIdLookups-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

タイトル: Opportunity Status Values

商談ステータス値のリソースを使用して、商談ステータス値を表示します。構成可能な設定データは、販売用途に特化して定義されます。

ソースを表示

Array of: object crmBusinessUnits-optyStatus-item-response

{
    "title":"Opportunity Status Values",
    "type":"array",
    "description":"The opportunity status values resource is used to view the opportunity status value. The configurable setup data is defined specifically for sales usage.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-optyStatus-item-response"
    }
}

ネストされたスキーマ : 販売メソッド

タイプ: array

タイトル: Sales Methods

販売メソッド・リソースは、販売プロセスで使用されるアプローチを表示するために使用されます。メソッドには、商談の見込み、売上予想、クローズなど、セールス・プロセスに関連付けられたすべてのステージを含めることができます。

ソースを表示

Array of: object crmBusinessUnits-salesMethods-item-response

{
    "title":"Sales Methods",
    "type":"array",
    "description":"The sales methods resource is used to view an approach which is used in the sales process. A method can encompass every stage associated with the sales process such as prospecting, forecasting, or closing opportunities.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-item-response"
    }
}

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

タイプ: object

ソースを表示

AssessedObjTypeCode: string

最大長: 50

査定済ビジネス・オブジェクトのタイプを示すコード。
AssessTemplateId: integer (int64)

このアセスメントのソースとして機能したアセスメント・テンプレートの一意の識別子。
links: array Links

タイトル: Links

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

タイトル: Name

最大長: 100

アセスメント・テンプレートの名前。
ObjectVersionNumber: 整数(int32)

ロックの実装に使用される番号。この番号は、行を更新するたびに増分されます。この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssessedObjTypeCode":{
            "maxLength":50,
            "type":"string",
            "description":"The code indicating the type of the assessed business object.",
            "nullable":false,
            "x-queryable":false
        },
        "AssessTemplateId":{
            "type":"integer",
            "description":"The unique identifier of the assessment template that served as the source of this assessment.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the assessment template.",
            "nullable":false,
            "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."
        }
    }
}

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

タイプ: object

ソースを表示

BUId: integer

読取り専用: true

ビジネス・ユニットの一意の識別子。
CreatedBy: string

読取り専用: true

最大長: 64

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

読取り専用: true

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

タイトル: Description

読取り専用: true

最大長: 240

参照タイプの摘要。
DisplaySequence: integer (int64)

読取り専用: true

参照タイプがリスト順序に表示される場所を示す番号。
EndDateActive: 文字列(日付)

読取り専用: true

参照タイプが非アクティブになる日付。
LastUpdateDate: string (date-time)

読取り専用: true

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

読取り専用: true

最大長: 64

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

読取り専用: true

最大長: 32

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

タイトル: Links

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

タイトル: Lookup Code

読取り専用: true

最大長: 30

参照の識別に使用されるコード。
LookupType: string

タイトル: Lookup Type

読取り専用: true

最大長: 30

参照値に関連付けられた参照タイプ。
Meaning: string

タイトル: Meaning

読取り専用: true

最大長: 80

参照タイプの意味。
SetId: integer (int64)

タイトル: Set Id

読取り専用: true

参照値の参照データ・セットの識別子。
StartDateActive: 文字列(日付)

読取り専用: true

参照タイプが使用可能になった日付。

{
    "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 and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the lookup type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup type associated with the lookup value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"The number denoting the place where the lookup type will be displayed in the list sequence.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"The code used to identify the lookup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "type":"string",
            "description":"The date when the lookup type was enabled.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BUId":{
            "type":"integer",
            "description":"The unique identifier of a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "type":"string",
            "description":"The date when the lookup type will become inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SetId":{
            "title":"Set Id",
            "type":"integer",
            "description":"The identifier for lookup value's reference data set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the lookup type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when 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"
    }
}

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

タイプ: object

ソースを表示

AppliesToLOVSwitcher: string

読取り専用: true

これは、ピッカーの表示時にLOVを区別するためにUIで使用されます。
BUId: integer

読取り専用: true

ビジネス・ユニットの一意の識別子。
CategoryLOVSwitcher: string

読取り専用: true

これは、ピッカーの表示時にLOVを区別するためにUIで使用されます。
ConflictId: integer (int64)

デフォルト値: 0

この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
CreatedBy: string

読取り専用: true

最大長: 64

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

読取り専用: true

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

タイトル: Description

最大長: 240

参照タイプの摘要。
DisplaySequence: integer (int64)

タイトル: Display Sequence

ステータス・コードが表示される順序。
EnabledFlag: boolean

タイトル: Active

最大長: 1

参照タイプが使用可能かどうかを示します。
EndDateActive: 文字列(日付)

参照タイプが使用不可である日付。
LastUpdateDate: string (date-time)

読取り専用: true

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

読取り専用: true

最大長: 64

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

読取り専用: true

最大長: 32

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

タイトル: Links

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

タイトル: Status Category

最大長: 30

参照値に関連付けられた参照カテゴリ。
LookupCode: string

タイトル: Status Code

最大長: 30

参照値に関連付けられた参照コード。
LookupType: string

タイトル: Status

最大長: 30

デフォルト値: OPTY_STATUS

参照値に関連付けられた参照タイプ。
LookupValuesId: integer (int64)

参照値の一意の識別子。
Meaning: string

タイトル: Status

最大長: 80

参照値の翻訳済値。
ObjectVersionNumber: 整数(int32)

読取り専用: true

オブジェクト・バージョン番号は、オプティミスティック・ロックを実装します。この番号は、行を更新するたびに増分されます。問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
SetCode: string

タイトル: Set Code

読取り専用: true

最大長: 30

販売ステータス参照値の参照データ・セット・コード。
SetId: integer (int64)

タイトル: Set

販売ステータス参照値のリファレンス・データの一意の識別子。
SetIdLOVSwitcher: string

読取り専用: true

これは、ピッカーの表示時にLOVを区別するためにUIで使用されます。
SetIdP: integer (int64)

読取り専用: true

販売ステータス参照値のリファレンス・データの一意の識別子。
SetName: string

タイトル: Set Name

読取り専用: true

最大長: 80

販売ステータス参照値の参照データ・セット識別子の名前。
StartDateActive: 文字列(日付)

参照タイプがアクティブになる日付。
UserLastUpdateDate: string (date-time)

行が最後に更新された日時。別のモバイル・データベースやサーバーなどの別のデータベースで更新が行われた場合、この値はLAST_UPDATE_DATEとは異なります。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the lookup type.",
            "nullable":true,
            "x-queryable":true
        },
        "LookupValuesId":{
            "type":"integer",
            "description":"The unique identifier of the lookup value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the status code is displayed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as a different mobile database, or the server.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SetCode":{
            "title":"Set Code",
            "maxLength":30,
            "type":"string",
            "description":"The sales status lookup value's reference data set code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BUId":{
            "type":"integer",
            "description":"The unique identifier of a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "type":"string",
            "description":"The date when the lookup type is made active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SetIdP":{
            "type":"integer",
            "description":"The unique identifier of the sales status lookup value's reference data.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number implements optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LookupCategory":{
            "title":"Status Category",
            "maxLength":30,
            "type":"string",
            "description":"The lookup category associated with the lookup value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the lookup type is enabled.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryLOVSwitcher":{
            "type":"string",
            "description":"This is used in UI for differentiating between LOVs when picker is displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The lookup type associated with the lookup value.",
            "nullable":false,
            "default":"OPTY_STATUS",
            "x-queryable":true
        },
        "SetName":{
            "title":"Set Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the sales status lookup value's reference data set identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code associated with the lookup value.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDateActive":{
            "type":"string",
            "description":"The date when the lookup type is disabled.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AppliesToLOVSwitcher":{
            "type":"string",
            "description":"This is used in UI for differentiating between LOVs when picker is displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetIdLOVSwitcher":{
            "type":"string",
            "description":"This is used in UI for differentiating between LOVs when picker is displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetId":{
            "title":"Set",
            "type":"integer",
            "description":"The unique identifier of the sales status lookup value's reference data.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Meaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The translated value of the lookup value.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when 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"
    }
}

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

タイプ: object

ソースを表示

BUId: integer

読取り専用: true

ビジネス・ユニットの一意の識別子。
ConflictId: integer (int64)

デフォルト値: 0

この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
CreatedBy: string

読取り専用: true

最大長: 64

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

読取り専用: true

レコードが作成された日時。
DefaultSalesMethodFlag: boolean

タイトル: Default Sales Method

読取り専用: true

現在の販売メソッドがユーザーのデフォルト・ビジネス・ユニットに記録されるかどうかを示します。この値はtrueおよびfalseです。
DefaultSalesMethodForExpansionFlag: boolean

タイトル: Default Sales Method for Expansion

読取り専用: true

拡張商談のデフォルトの販売メソッド。
DefaultSalesMethodForRenewalFlag: boolean

タイトル: Default Sales Method for Renewal

読取り専用: true

更改商談のデフォルト販売メソッド。
DeletedFlag: boolean

タイトル: Disabled

最大長: 2

デフォルト値: false

販売メソッドが削除されたかどうかを示します。
DescriptionText: string

タイトル: Description

最大長: 255

販売メソッドの摘要。
LastUpdateDate: string (date-time)

読取り専用: true

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

読取り専用: true

最大長: 64

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

読取り専用: true

最大長: 32

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

タイトル: Links

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

タイトル: Name

最大長: 50

販売メソッドの名前。
OpportunityType: string

タイトル: Opportunity Type

最大長: 30

商談のタイプが新規、更新または拡張のいずれであるかを示します。
OptyCloseWindow: integer (int64)

タイトル: Close Window

販売メソッド商談クローズ・ウィンドウ。
RevnLineSetEnabledFlag: boolean

タイトル: Revenue Line-Set Enabled

最大長: 1

デフォルト値: false

この販売メソッドの使用時に収益明細セットを使用可能にするかどうかを示します。
SalesMethodId: integer (int64)

販売メソッドの一意の識別子。
SalesMethodNumber: string

タイトル: Sales Method Number

最大長: 64

データ移行の代替キーとして作成されたGUIDベースの列。
SalesStage: array Sales Stages

タイトル: Sales Stages

営業ステージ・リソースは、営業ステージの表示に使用されます。特定のセールス・メソッドのセールス・ステージでは、セールス・サイクルにおける商談の進捗状況について説明します。
SetIdP: integer (int64)

読取り専用: true

販売メソッド参照値のリファレンス・データ・セットの一意の識別子。
SetName: string

タイトル: Set

読取り専用: true

最大長: 80

販売メソッド参照データ・セット識別子の名前。
UserLastUpdateDate: string (date-time)

行が最後に更新された日時。異なるモバイル・データベースやサーバーなどの別のデータベースで更新が行われた場合、この値はLAST_UPDATE_DATEとは異なります。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DefaultSalesMethodForExpansionFlag":{
            "title":"Default Sales Method for Expansion",
            "type":"boolean",
            "description":"The default sales method for an expansion opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesMethodNumber":{
            "title":"Sales Method Number",
            "maxLength":64,
            "type":"string",
            "description":"A GUID-based column that has been created to be an alternate key for data migration.",
            "nullable":false,
            "x-queryable":true
        },
        "SalesMethodId":{
            "type":"integer",
            "description":"The unique identifier of the sales method.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesStage":{
            "title":"Sales Stages",
            "type":"array",
            "description":"The sales stages resource is used to view the sales stage. The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-SalesStage-item-response"
            }
        },
        "OptyCloseWindow":{
            "title":"Close Window",
            "type":"integer",
            "description":"The sales method opportunity close window.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "DefaultSalesMethodFlag":{
            "title":"Default Sales Method",
            "type":"boolean",
            "description":"Indicates whether the current sales method is logged in user's default business unit. It has the value true and false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RevnLineSetEnabledFlag":{
            "title":"Revenue Line-Set Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the revenue line set will be enabled when using this sales method.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SetName":{
            "title":"Set",
            "maxLength":80,
            "type":"string",
            "description":"The name of the sales method reference data set identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as different mobile database, or the server.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ConflictId":{
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the sales method.",
            "nullable":true,
            "x-queryable":true
        },
        "BUId":{
            "type":"integer",
            "description":"The unique identifier of a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultSalesMethodForRenewalFlag":{
            "title":"Default Sales Method for Renewal",
            "type":"boolean",
            "description":"The default sales method for a renewal opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetIdP":{
            "type":"integer",
            "description":"The unique identifier of the sales method lookup value's reference data set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DeletedFlag":{
            "title":"Disabled",
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates whether the sales method has been deleted.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the sales method.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityType":{
            "title":"Opportunity Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the type of opportunity is New, Renewal, or an Expansion.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "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"
    }
}

ネストされたスキーマ : 営業ステージ

タイプ: array

タイトル: Sales Stages

営業ステージ・リソースは、営業ステージの表示に使用されます。特定のセールス・メソッドのセールス・ステージでは、セールス・サイクルにおける商談の進捗状況について説明します。

ソースを表示

Array of: object crmBusinessUnits-salesMethods-SalesStage-item-response

{
    "title":"Sales Stages",
    "type":"array",
    "description":"The sales stages resource is used to view the sales stage. The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-SalesStage-item-response"
    }
}

ネストされたスキーマ : crmBusinessUnits-salesMethods-SalesStage-item-response

タイプ: object

ソースを表示

AttachmentEntityName: string

最大長: 255

デフォルト値: MOO_STG_B

添付エンティティの名前。デフォルト値はMOO_STG_Bです。
Attachments: array Attachments

タイトル: Attachments

添付リソースは、添付の表示、作成および更新に使用されます。
AverageDaysAtStage: integer (int64)

タイトル: Duration

営業ステージの平均日数。
ConflictId: integer (int64)

デフォルト値: 0

この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
CreatedBy: string

読取り専用: true

最大長: 64

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

読取り専用: true

レコードが作成された日時。
DeletedFlag: boolean

最大長: 2

デフォルト値: false

営業ステージが削除されたかどうかを示します。
DescriptionText: string

タイトル: Description

最大長: 255

営業ステージの摘要。
LastUpdateDate: string (date-time)

読取り専用: true

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

読取り専用: true

最大長: 64

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

読取り専用: true

最大長: 32

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

タイトル: Links

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

タイトル: Stalled Deal Limit

セールス・ステージの最大日数。
Name: string

タイトル: Name

最大長: 50

セールス・ステージの名前。
PhaseCd: string

タイトル: Phase

最大長: 30

デフォルト値: "B - Working the Deal"

営業ステージのフェーズ・コード。
QuotaFactor: number

タイトル: Quota Factor

営業ステージの目標ファクタ。
RcmndWinProb: number

タイトル: Win Probability

デフォルト値: 0

営業ステージの推奨受注確度。
SalesMethodId: integer (int64)

タイトル: Sales Method ID

営業ステージが属する販売メソッドの一意の識別子。
SalesStageProcessSteps: array Sales Stage Process Steps

タイトル: Sales Stage Process Steps

営業ステージ・プロセス・ステップ・リソースは、営業ステージ・プロセス・ステップの表示に使用されます。特定の営業ステージに関連付けられた一連の推奨ステップであり、営業担当に商談ライフサイクルをガイドするために使用されます。
SetId: string

営業ステージ・セットの一意の識別子。値は販売メソッド・セット識別子から取得されます。
StageNumber: string

最大長: 64

データ移行の代替キーの一部として作成されたGUIDベースの列。
StageStatusCd: string

タイトル: Status

最大長: 30

デフォルト値: "Open"

営業ステージのステータス。
StgId: integer (int64)

営業ステージの一意の識別子。
StgOrder: number

タイトル: Order

販売メソッド内の営業ステージ・オーダーです。
UserLastUpdateDate: string (date-time)

行が最後に更新された日時。異なるモバイル・データベースやサーバーなどの別のデータベースで更新が行われた場合、この値はLAST_UPDATE_DATEとは異なります。

{
    "type":"object",
    "properties":{
        "StageNumber":{
            "maxLength":64,
            "type":"string",
            "description":"A GUID-based column that has been created to be part of alternate key for data migration.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesMethodId":{
            "title":"Sales Method ID",
            "type":"integer",
            "description":"The unique identifier of the sales method to which the sales stage belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StgId":{
            "type":"integer",
            "description":"The unique identifier of the sales stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AverageDaysAtStage":{
            "title":"Duration",
            "type":"integer",
            "description":"The average number of days of sales stage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as different mobile database, or the server.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-SalesStage-Attachments-item-response"
            }
        },
        "SalesStageProcessSteps":{
            "title":"Sales Stage Process Steps",
            "type":"array",
            "description":"The sales stage process steps resource is used view the sales stage process steps. It is a sequence of recommended steps tied to a particular sales stage which is used to guide the sales representative through the opportunity lifecycle.",
            "items":{
                "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-SalesStage-SalesStageProcessSteps-item-response"
            }
        },
        "StgOrder":{
            "title":"Order",
            "type":"number",
            "description":"The sales stage order within a sales method.",
            "nullable":false,
            "x-hints":{
                "precision":22,
                "scale":7
            },
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the sales stage.",
            "nullable":false,
            "x-queryable":true
        },
        "QuotaFactor":{
            "title":"Quota Factor",
            "type":"number",
            "description":"The quota factor for a sales stage.",
            "nullable":false,
            "x-hints":{
                "precision":22,
                "scale":7
            },
            "x-queryable":true
        },
        "StageStatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the sales stage.",
            "nullable":true,
            "default":"\"Open\"",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumDaysInStage":{
            "title":"Stalled Deal Limit",
            "type":"integer",
            "description":"The maximum number of days of a sales stage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "RcmndWinProb":{
            "title":"Win Probability",
            "type":"number",
            "description":"The recommended win probability of the sales stage.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":22,
                "scale":7
            },
            "x-queryable":true
        },
        "PhaseCd":{
            "title":"Phase",
            "maxLength":30,
            "type":"string",
            "description":"The phase code for a sales stage.",
            "nullable":false,
            "default":"\"B - Working the Deal\"",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates whether the sales stage has been deleted.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the sales stage.",
            "nullable":true,
            "x-queryable":true
        },
        "SetId":{
            "type":"string",
            "description":"The unique identifier of the sales stage set. The value is retrieved from the sales method set identifier.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the attachment entity. Default value is MOO_STG_B.",
            "nullable":true,
            "default":"MOO_STG_B",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when 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

タイトル: Attachments

添付リソースは、添付の表示、作成および更新に使用されます。

ソースを表示

Array of: object crmBusinessUnits-salesMethods-SalesStage-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-SalesStage-Attachments-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

タイトル: Sales Stage Process Steps

営業ステージ・プロセス・ステップ・リソースは、営業ステージ・プロセス・ステップの表示に使用されます。特定の営業ステージに関連付けられた一連の推奨ステップであり、営業担当に商談ライフサイクルをガイドするために使用されます。

ソースを表示

Array of: object crmBusinessUnits-salesMethods-SalesStage-SalesStageProcessSteps-item-response

{
    "title":"Sales Stage Process Steps",
    "type":"array",
    "description":"The sales stage process steps resource is used view the sales stage process steps. It is a sequence of recommended steps tied to a particular sales stage which is used to guide the sales representative through the opportunity lifecycle.",
    "items":{
        "$ref":"#/components/schemas/crmBusinessUnits-salesMethods-SalesStage-SalesStageProcessSteps-item-response"
    }
}

ネストされたスキーマ : crmBusinessUnits-salesMethods-SalesStage-Attachments-item-response

タイプ: object

ソースを表示

AsyncTrackerId: string

タイトル: Asynchronous Upload Tracker Id

ファイルのアップロードを支援するために添付UIコンポーネントで排他的に使用するために指定された属性。
AttachedDocumentId: integer (int64)

タイトル: Attached Document Id

添付文書の一意の識別子。
CategoryName: string

タイトル: Category

最大長: 30

添付のカテゴリ。
ContentRepositoryFileShared: boolean

タイトル: Shared

添付が共有されているかどうかを示します。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 255

レコードを作成したユーザー。
CreatedByUserName: string

タイトル: Created By User Name

読取り専用: true

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

タイトル: Creation Date

読取り専用: true

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

タイトル: Type

最大長: 30

デフォルト値: FILE

添付のデータ型コードを示す値です。
Description: string

タイトル: Description

最大長: 255

添付の説明。
DmDocumentId: string

最大長: 255

添付の作成元となる文書ID。
DmFolderPath: string

タイトル: Dm Folder Path

最大長: 1000

添付の作成元のフォルダ・パス。
DmVersionNumber: string

最大長: 255

添付の作成元となる文書バージョン番号。
DownloadInfo: string

タイトル: DownloadInfo

添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。
ErrorStatusCode: string

タイトル: Error Status Code

添付のエラー・コード(ある場合)。
ErrorStatusMessage: string

タイトル: Error Status Message

添付のエラー・メッセージ(ある場合)。
ExpirationDate: string (date-time)

タイトル: Expiration Date

添付ファイルのコンテンツが失効する日付。
FileContents: 文字列(バイト)

タイトル: File Contents

添付ファイルの内容。
FileName: string

タイトル: File Name

最大長: 2048

添付のファイル名。
FileUrl: string

タイトル: File Url

添付ファイルのURL。
FileWebImage: 文字列(バイト)

タイトル: File Web Image

読取り専用: true

ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

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

タイトル: Last Updated By

読取り専用: true

最大長: 255

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

タイトル: Last Updated By User

読取り専用: true

レコードを最後に更新したユーザーの名前。
links: array Links

タイトル: Links

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

タイトル: Title

添付のタイトル。
UploadedFileContentType: string

タイトル: Uploaded File Content Type

添付のコンテンツ・タイプ。
UploadedFileLength: integer

タイトル: File Size

添付ファイルのサイズ。
UploadedFileName: string

タイトル: Uploaded File Name

新しい添付ファイルに割り当てる名前。
UploadedText: string

タイトル: Uploaded Text

新規テキスト添付のテキスト・コンテンツ。
Uri: string

タイトル: Uri

最大長: 4000

トポロジ・マネージャ・タイプ・アタッチメントのURI。
Url: string

タイトル: Url

最大長: 4000

webページ・タイプ添付のURL。
UserName: string

タイトル: User Name

読取り専用: true

最大長: 255

添付を作成したユーザーのログイン資格証明。

{
    "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-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The value that indicates the data type code of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "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-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

ネストされたスキーマ : crmBusinessUnits-salesMethods-SalesStage-SalesStageProcessSteps-item-response

タイプ: object

ソースを表示

ConflictId: integer (int64)

デフォルト値: 0

この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
CreatedBy: string

読取り専用: true

最大長: 64

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

読取り専用: true

レコードが作成された日時。
DescriptionText: string

タイトル: Description

最大長: 4000

プロセス・ステップの詳細。
LastUpdateDate: string (date-time)

読取り専用: true

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

読取り専用: true

最大長: 64

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

読取り専用: true

最大長: 32

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

タイトル: Links

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

タイトル: Name

最大長: 200

プロセス・ステップの名前。
StepSequenceNumber: integer (int64)

タイトル: Order

営業ステージ内のプロセス・ステップの連番。
StgId: integer (int64)

プロセス・ステップが属する営業ステージの一意の識別子。
StgProcessStepId: integer (int64)

営業ステージ・プロセス・ステップの識別子。
StgProcessStepNumber: string

最大長: 64

データ移行の代替キーの一部として作成されたGUIDベースの列。
UserLastUpdateDate: string (date-time)

行が最後に更新された日時。異なるモバイル・データベースやサーバーなどの別のデータベースで更新が行われた場合、この値はLAST_UPDATE_DATEとは異なります。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StgId":{
            "type":"integer",
            "description":"The unique identifier of the sales stage that the process step is a part of.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StgProcessStepId":{
            "type":"integer",
            "description":"The identifier of the sales stage process step.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database such as different mobile database, or the server.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":200,
            "type":"string",
            "description":"The name of the process step.",
            "nullable":false,
            "x-queryable":true
        },
        "StgProcessStepNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The GUID-based column that has been created to be part of alternate key for data migration.",
            "nullable":true,
            "x-queryable":true
        },
        "StepSequenceNumber":{
            "title":"Order",
            "type":"integer",
            "description":"The sequence number of the process step within sales stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"The details of the process step.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when 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"
    }
}

リンク

assessmentTemplates

操作: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/assessmentTemplates

パラメータ:

crmBusinessUnitsUniqID: $request.path.crmBusinessUnitsUniqID

査定テンプレート・リソースは、査定テンプレートの表示に使用されます。アセスメントに関連付けられたテンプレートが格納されます。

fndCommonSetIdLookups

操作: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/fndCommonSetIdLookups

パラメータ:

crmBusinessUnitsUniqID: $request.path.crmBusinessUnitsUniqID

共通セットID参照リソースは、セットID対応参照タイプの参照値を表示するために使用されます。

optyStatus

操作: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/optyStatus

パラメータ:

crmBusinessUnitsUniqID: $request.path.crmBusinessUnitsUniqID

商談ステータス値のリソースを使用して、商談ステータス値を表示します。構成可能な設定データは、販売用途に特化して定義されます。

salesMethods

操作: /crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/salesMethods

パラメータ:

crmBusinessUnitsUniqID: $request.path.crmBusinessUnitsUniqID

「トップに戻る」