競合取引先の作成
post
/crmRestApi/resources/11.13.18.05/competitorAccounts
リクエスト
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
AnnualRevenueAmount: number
タイトル:
Annual Revenue Amount競合会社の年間売上を示します。 -
Attachment: array Attachments
タイトル:
Attachments添付リソースは、添付の表示、作成および更新に使用されます。 -
CeoName: string
タイトル:
Chief Executive Name最大長:240組織の最高経営責任者の名前。 -
Country: string
タイトル:
Country最大長:2競合相手の自国。 -
CreatedByModule: string
最大長:
30デフォルト値:SALES競合レコードを作成したモジュール。 -
CurrencyCode: string
タイトル:
Currency最大長:15年間収益金額の通貨コード。 -
DbRating: string
タイトル:
D&B Credit Rating最大長:5ダン・アンド・ブラッド・ストリート信用格付け。 -
DUNSNumber: string
タイトル:
D-U-N-S Number最大長:30自由形式のテキスト形式のDUNS番号。 値は9桁の数字に制限されません。 -
FiscalYearendMonth: string
タイトル:
Fiscal Year End Month最大長:30組織の会計年度の最終月。 受け入れられる値のリストは、参照タイプMONTHで定義されます。 -
IncorpYear: 整数(int32)
タイトル:
Year Incorporated組織が事業活動を開始した年。 -
LineOfBusiness: string
タイトル:
Line of Business最大長:240このサイトで実行されるビジネス・アクティビティのタイプ。 -
MinorityOwnedInd: string
タイトル:
Minority-Owned Indicator最大長:30組織が主に民族少数民族または人種少数民族によって所有されるかどうかを示します。 値がYの場合、組織は民族少数民族または人種少数民族によって所有されます。 会社は主に民族または人種的少数民族によって所有されています。 デフォルト値はNです。 -
OrganizationName(required): string
タイトル:
Organization Name最大長:360競合会社組織の名前。 -
OrganizationSize: string
タイトル:
Organization Size最大長:30収益や従業員数などの基準に基づく競合組織の規模。 -
PartyId: integer (int64)
競合会社レコードの主キー。
-
PartyName(required): string
タイトル:
Name最大長:360競合会社組織の名前。 -
PartyNumber(required): string
タイトル:
Registry ID最大長:30競合相手の一意の公開識別子。 -
PartyType: string
タイトル:
Party Type最大長:30デフォルト値:ORGANIZATIONパーティ・レコードのタイプ。 -
PublicPrivateOwnershipFlag: boolean
タイトル:
Private Ownership最大長:1組織が公開または非公開のどちらであるかを示します。 値がYの場合、組織は個人所有組織です。 デフォルト値はNです。 -
SICCode: string
タイトル:
SIC Code最大長:30競合相手のStandard Industry Classification (SIC)コード。 -
SmallBusInd: string
タイトル:
Small Business Indicator最大長:30組織が中小企業とみなされるかどうかを示します。 値がYの場合、組織は中小企業とみなされます。 デフォルト値はNです。 -
StatusCode: string
タイトル:
Status最大長:10デフォルト値:ACTIVE競合相手のステータス - アクティブまたは非アクティブ。 -
StockSymbol: string
タイトル:
Stock Symbol最大長:20証券取引所にリストされている組織の株式記号。 -
ThreatLevelCode: string
タイトル:
Threat Level最大長:30ディールの当該組織との競合時に競合相手が提示する脅威のレベル。 -
TradingPartnerIdentifier: string
最大長:
30FSIO関連の取引先コード。 -
UniqueNameSuffix: string
タイトル:
Name Suffix最大長:540属性PartyUniqueNameの生成に使用されるサフィクス。 サフィクスは、PartyUniqueNameを生成するためにOrganizationName属性にリンクされます。 -
URL: string
タイトル:
Primary URL最大長:2000競合相手に関する情報を含むUniform Resource Locatorまたはwebサイト。 -
YearEstablished: 整数(int32)
タイトル:
Year Established組織が事業活動を開始した年。
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Idファイルのアップロードを支援するために添付UIコンポーネントで排他的に使用するために指定された属性。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id添付文書の一意の識別子。 -
CategoryName: string
タイトル:
Category最大長:30添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
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ファイルのURI。 -
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最大長:4000webページ・タイプ添付のURL。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : competitorAccounts-item-response
タイプ:
ソースを表示
object-
AnnualRevenueAmount: number
タイトル:
Annual Revenue Amount競合会社の年間売上を示します。 -
Attachment: array Attachments
タイトル:
Attachments添付リソースは、添付の表示、作成および更新に使用されます。 -
CeoName: string
タイトル:
Chief Executive Name最大長:240組織の最高経営責任者の名前。 -
Country: string
タイトル:
Country最大長:2競合相手の自国。 -
CreatedBy: string
読取り専用:
true最大長:64競合会社レコードを作成したユーザー。 -
CreatedByModule: string
最大長:
30デフォルト値:SALES競合レコードを作成したモジュール。 -
CreationDate: string (date-time)
読取り専用:
trueレコードが作成された日付。 -
CurrencyCode: string
タイトル:
Currency最大長:15年間収益金額の通貨コード。 -
DbRating: string
タイトル:
D&B Credit Rating最大長:5ダン・アンド・ブラッド・ストリート信用格付け。 -
DeletetFlag: boolean
読取り専用:
true競合相手を削除できるかどうかを示します。 -
DUNSNumber: string
タイトル:
D-U-N-S Number最大長:30自由形式のテキスト形式のDUNS番号。 値は9桁の数字に制限されません。 -
FiscalYearendMonth: string
タイトル:
Fiscal Year End Month最大長:30組織の会計年度の最終月。 受け入れられる値のリストは、参照タイプMONTHで定義されます。 -
IncorpYear: 整数(int32)
タイトル:
Year Incorporated組織が事業活動を開始した年。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date読取り専用:trueレコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By読取り専用:true最大長:64競合会社レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login読取り専用:true最大長:32レコードを最後に更新したユーザーのログイン。 -
LineOfBusiness: string
タイトル:
Line of Business最大長:240このサイトで実行されるビジネス・アクティビティのタイプ。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
MinorityOwnedInd: string
タイトル:
Minority-Owned Indicator最大長:30組織が主に民族少数民族または人種少数民族によって所有されるかどうかを示します。 値がYの場合、組織は民族少数民族または人種少数民族によって所有されます。 会社は主に民族または人種的少数民族によって所有されています。 デフォルト値はNです。 -
OrganizationName: string
タイトル:
Organization Name最大長:360競合会社組織の名前。 -
OrganizationSize: string
タイトル:
Organization Size最大長:30収益や従業員数などの基準に基づく競合組織の規模。 -
PartyId: integer (int64)
競合会社レコードの主キー。
-
PartyName: string
タイトル:
Name最大長:360競合会社組織の名前。 -
PartyNumber: string
タイトル:
Registry ID最大長:30競合相手の一意の公開識別子。 -
PartyType: string
タイトル:
Party Type最大長:30デフォルト値:ORGANIZATIONパーティ・レコードのタイプ。 -
PublicPrivateOwnershipFlag: boolean
タイトル:
Private Ownership最大長:1組織が公開または非公開のどちらであるかを示します。 値がYの場合、組織は個人所有組織です。 デフォルト値はNです。 -
SICCode: string
タイトル:
SIC Code最大長:30競合相手のStandard Industry Classification (SIC)コード。 -
SmallBusInd: string
タイトル:
Small Business Indicator最大長:30組織が中小企業とみなされるかどうかを示します。 値がYの場合、組織は中小企業とみなされます。 デフォルト値はNです。 -
StatusCode: string
タイトル:
Status最大長:10デフォルト値:ACTIVE競合相手のステータス - アクティブまたは非アクティブ。 -
StockSymbol: string
タイトル:
Stock Symbol最大長:20証券取引所にリストされている組織の株式記号。 -
ThreatLevelCode: string
タイトル:
Threat Level最大長:30ディールの当該組織との競合時に競合相手が提示する脅威のレベル。 -
TradingPartnerIdentifier: string
最大長:
30FSIO関連の取引先コード。 -
UniqueNameSuffix: string
タイトル:
Name Suffix最大長:540属性PartyUniqueNameの生成に使用されるサフィクス。 サフィクスは、PartyUniqueNameを生成するためにOrganizationName属性にリンクされます。 -
UpdateFlag: boolean
読取り専用:
trueレコードを更新できるかどうかを示します。 -
URL: string
タイトル:
Primary URL最大長:2000競合相手に関する情報を含むUniform Resource Locatorまたはwebサイト。 -
YearEstablished: 整数(int32)
タイトル:
Year Established組織が事業活動を開始した年。
ネストされたスキーマ : competitorAccounts-Attachment-item-response
タイプ:
ソースを表示
object-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Idファイルのアップロードを支援するために添付UIコンポーネントで排他的に使用するために指定された属性。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id添付文書の一意の識別子。 -
CategoryName: string
タイトル:
Category最大長:30添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
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ファイルのURI。 -
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最大長:4000webページ・タイプ添付のURL。 -
UserName: string
タイトル:
User Name読取り専用:true最大長:255添付を作成したユーザーのログイン資格証明。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- 添付
-
パラメータ:
- PartyId:
$request.path.PartyId
添付リソースは、添付の表示、作成および更新に使用されます。 - PartyId:
- CompttrStatusLookupForSearch
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZBS_SALES_COMPTTR_STATUS
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: StatusCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- CompttrThrtLvlLookupLOV
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BBindLookupType%3DZBS_SALES_COMPTTR_THRT_LVL
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ThreatLevelCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ: