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

機械翻訳について

関係の作成

post

/crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Relationship

リクエスト

パス・パラメータ

PartyNumber(required): string

組織パーティの一意の代替識別子。プロファイル・オプションHZ_GENERATE_PARTY_NUMBERがTrueに設定されている場合、値を更新できます。デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値と一意のシステム生成順序番号を連結した値です。非アクティブなレコードは更新できません。

ヘッダー・パラメータ

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

ソースを表示

Comments: string

タイトル: Comments

最大長: 2000

この関係のユーザー・コメント。
ConflictId: integer (int64)

デフォルト値: 0

競合の一意の識別子。
CreatedByModule: string

タイトル: Created by Application

最大長: 30

デフォルト値: HZ_WS

レコードを作成したアプリケーション・モジュール。すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。
DependentFlag: string

タイトル: Dependent Indicator

最大長: 1

デフォルト値: N

1つのパーティが別のパーティに依存しているかどうかを示します。
EndDate: 文字列(日付)

タイトル: To Date

関係が終了する日付。
HeadOfHouseholdFlag: string

タイトル: Head of Household Indicator

最大長: 1

デフォルト値: N

個人が所属する世帯主であるかどうかを示します。
InfluenceLevel: string

タイトル: Influence Level

販売担当者が購買関係に与える影響。サンプル値は、内部円、政治構造、なしです。
JobDefinitionName: string

最大長: 100

ジョブ名の定義。
JobDefinitionPackage: string

最大長: 900

ジョブ・パッケージの定義。
ObjectPartyId: integer (int64)

この関係にあるオブジェクトの主キー識別子。 ObjectPartyId、ObjectPartyNumber、およびObjectSourceSystemとObjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のオブジェクト・パーティを識別します。
ObjectPartyNumber: string

タイトル: Object Registry ID

最大長: 30

関係のオブジェクト・パーティの一意の識別番号。 ObjectPartyId、ObjectPartyNumberおよびObjectSourceSystemとObjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のオブジェクト・パーティを識別します。
ObjectSourceSystem: string

タイトル: Object Source System

関係のオブジェクト・パーティの外部ソース・システムの名前で、システム設定の一部として管理者が定義します。 ObjectPartyId、ObjectPartyNumberおよびObjectSourceSystemとObjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のオブジェクト・パーティを識別します。設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。
ObjectSourceSystemReferenceValue: string

タイトル: Object Source System Reference

外部ソース・システムからの関係におけるオブジェクト・パーティの識別子。 ObjectPartyId、ObjectPartyNumberおよびObjectSourceSystemとObjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のオブジェクト・パーティを識別します。
ObjectTableName: string

最大長: 30

この関係のオブジェクト・パーティのソース表名。
ObjectType: string

最大長: 30

担当者のオブジェクト・タイプ。
ObjectUsageCode: string

最大長: 30

関係におけるオブジェクト・パーティの使用コード。
ObjectVersionNumber: 整数(int32)

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

タイトル: Ownership Percentage

親エンティティが所有する子エンティティのパーセンテージ。
PreferredContactFlag: boolean

最大長: 10

デフォルト値: false

この担当者個人が顧客のプライマリ担当者であるかどうかを示します。受け入れられる値はYおよびNです。デフォルト値はNです。
PrimaryCustomerFlag: boolean

最大長: 10

デフォルト値: false

この顧客が担当者のプライマリ顧客かどうかを示します。受け入れられる値はYおよびNです。デフォルト値はNです。
RelationshipCode: string

タイトル: Relationship Code

最大長: 30

これがフォワード関係コードかバック・ワード関係コードかを示します。有効な関係コードのリストは、参照PARTY_RELATIONS_TYPEで定義されます。設定およびメンテナンス・タスクの関係参照の管理を使用して、コードをレビューおよび更新します。
RelationshipRecId: integer (int64)

関係レコードの一意の識別子。
RelationshipSourceSystem: string

システム設定の一部として管理者が定義する、関係の外部ソース・システムの名前。
RelationshipSourceSystemReferenceValue: string

外部ソース・システムとの関係の識別子。
RelationshipType: string

タイトル: Relationship Type

最大長: 30

関係タイプ名。たとえば、CUSTOMER_SUPPLIERです。有効な関係タイプのリストは、参照HZ_RELATIONSHIP_TYPEで定義されます。設定およびメンテナンス・タスクの関係参照の管理を使用して、コードをレビューおよび更新します。
RequestId: integer (int64)

要求トの一意の識別子。
Role: string

タイトル: Role

サブジェクト・パーティとオブジェクト・パーティ間のロール。
StartDate: 文字列(日付)

タイトル: From Date

関係が設定された日付。デフォルトはシステム日付です。
SubjectPartyId: integer (int64)

この関係のサブジェクトの主キー識別子。 SubjectPartyId、SubjectPartyNumber、およびSubjectSourceSystemとSubjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のサブジェクト・パーティを識別します。
SubjectPartyNumber: string

タイトル: Subject Registry ID

最大長: 30

関係のサブジェクト・パーティの代替キー識別子。 SubjectPartyId、SubjectPartyNumberおよびSubjectSourceSystemとSubjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のサブジェクト・パーティを識別します。
SubjectSourceSystem: string

タイトル: Subject Source System

関係のサブジェクト・パーティの外部ソース・システムの名前で、システム設定の一部として管理者が定義します。 SubjectPartyId、SubjectPartyNumberおよびSubjectSourceSystemとSubjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のサブジェクト・パーティを識別します。設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。
SubjectSourceSystemReferenceValue: string

タイトル: Subject Source System Reference

外部ソース・システムからの関係のサブジェクト・パーティの識別子。 SubjectPartyId、SubjectPartyNumberおよびSubjectSourceSystemとSubjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のサブジェクト・パーティを識別します。
SubjectTableName: string

最大長: 30

件名のソース表。
SubjectType: string

最大長: 30

担当者の件名タイプ。
SubjectUsageCode: string

最大長: 30

担当者のサブジェクト・パーティの使用コード。

{
    "type":"object",
    "properties":{
        "SubjectPartyNumber":{
            "title":"Subject Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "nullable":false
        },
        "JobDefinitionName":{
            "maxLength":100,
            "type":"string",
            "description":"The definition of the job name.",
            "nullable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"The relationship type name. For example, CUSTOMER_SUPPLIER. A list of valid relationship types is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectTableName":{
            "maxLength":30,
            "type":"string",
            "description":"The source table name of the object party in this relationship.",
            "nullable":false
        },
        "InfluenceLevel":{
            "title":"Influence Level",
            "type":"string",
            "description":"The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date when the relationship was established. Defaulted to the system date.",
            "format":"date",
            "nullable":false
        },
        "ObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"The object type of the contact.",
            "nullable":false
        },
        "ObjectPartyId":{
            "type":"integer",
            "description":"The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubjectType":{
            "maxLength":30,
            "type":"string",
            "description":"The subject type of the contact.",
            "nullable":false
        },
        "JobDefinitionPackage":{
            "maxLength":900,
            "type":"string",
            "description":"The definition of the job package.",
            "nullable":true
        },
        "ObjectPartyNumber":{
            "title":"Object Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement 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 determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SubjectSourceSystem":{
            "title":"Subject Source System",
            "type":"string",
            "description":"The name of external source system for the subject party in the relationship, which are defined by an admin as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.",
            "nullable":true
        },
        "PreferredContactFlag":{
            "maxLength":10,
            "type":"boolean",
            "description":"Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PreferredContactPersonId"
                ]
            }
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether this is a forward or a backward relationship code. A list of valid relationship codes is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubjectPartyId":{
            "type":"integer",
            "description":"The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubjectUsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"The usage code of subject party in the contact.",
            "nullable":true
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "maxLength":30,
            "type":"string",
            "description":"The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS"
        },
        "PercentageOwnership":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"The percentage of the child entity owned by the parent entity.",
            "nullable":true
        },
        "RequestId":{
            "type":"integer",
            "description":"The unique identifier of the request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The user comments for this relationship.",
            "nullable":true
        },
        "RelationshipRecId":{
            "type":"integer",
            "description":"The unique identifier of the relationship record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RelationshipSourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier for the relationship with the external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "SubjectSourceSystemReferenceValue":{
            "title":"Subject Source System Reference",
            "type":"string",
            "description":"The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "nullable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date when the relationship ends.",
            "format":"date",
            "nullable":false
        },
        "PrimaryCustomerFlag":{
            "maxLength":10,
            "type":"boolean",
            "description":"Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "Role":{
            "title":"Role",
            "type":"string",
            "description":"The role between the subject and object party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelationshipSourceSystem":{
            "type":"string",
            "description":"The name of external source system for the relationship, which is defined by an admin as part of the system setup.",
            "nullable":true,
            "x-queryable":false
        },
        "HeadOfHouseholdFlag":{
            "title":"Head of Household Indicator",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a person is the head of the household that he belongs to.",
            "nullable":true,
            "default":"N"
        },
        "ObjectUsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"The usage code of object party in the relationship.",
            "nullable":true
        },
        "ObjectSourceSystem":{
            "title":"Object Source System",
            "type":"string",
            "description":"The name of external source system for the object party in the relationship, which are defined by an admin as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.",
            "nullable":true
        },
        "ObjectSourceSystemReferenceValue":{
            "title":"Object Source System Reference",
            "type":"string",
            "description":"The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "nullable":true
        },
        "SubjectTableName":{
            "maxLength":30,
            "type":"string",
            "description":"The source table of the subject.",
            "nullable":false
        },
        "DependentFlag":{
            "title":"Dependent Indicator",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether one party is a dependent on another.",
            "nullable":true,
            "default":"N"
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : hubOrganizations-Relationship-item-response

タイプ: object

ソースを表示

BackwardRole: string

タイトル: Backward Role

読取り専用: true

関係の記述に使用されるバック・ワード関係コード。たとえば、SUPPLIER_OFです。
Comments: string

タイトル: Comments

最大長: 2000

この関係のユーザー・コメント。
ConflictId: integer (int64)

デフォルト値: 0

競合の一意の識別子。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Created by Application

最大長: 30

デフォルト値: HZ_WS

レコードを作成したアプリケーション・モジュール。すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

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

タイトル: Dependent Indicator

最大長: 1

デフォルト値: N

1つのパーティが別のパーティに依存しているかどうかを示します。
DirectionCode: string

読取り専用: true

最大長: 30

DIRECTION_CODE参照タイプによって検証されたレコード。親の場合はP、子の場合はC、方向でない場合はN。
EndDate: 文字列(日付)

タイトル: To Date

関係が終了する日付。
HeadOfHouseholdFlag: string

タイトル: Head of Household Indicator

最大長: 1

デフォルト値: N

個人が所属する世帯主であるかどうかを示します。
InfluenceLevel: string

タイトル: Influence Level

販売担当者が購買関係に与える影響。サンプル値は、内部円、政治構造、なしです。
JobDefinitionName: string

最大長: 100

ジョブ名の定義。
JobDefinitionPackage: string

最大長: 900

ジョブ・パッケージの定義。
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

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

この関係にあるオブジェクトの主キー識別子。 ObjectPartyId、ObjectPartyNumber、およびObjectSourceSystemとObjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のオブジェクト・パーティを識別します。
ObjectPartyName: string

タイトル: Object Party Name

読取り専用: true

最大長: 360

関係のオブジェクト・パーティの名前。
ObjectPartyNumber: string

タイトル: Object Registry ID

最大長: 30

関係のオブジェクト・パーティの一意の識別番号。 ObjectPartyId、ObjectPartyNumberおよびObjectSourceSystemとObjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のオブジェクト・パーティを識別します。
ObjectSourceSystem: string

タイトル: Object Source System

関係のオブジェクト・パーティの外部ソース・システムの名前で、システム設定の一部として管理者が定義します。 ObjectPartyId、ObjectPartyNumberおよびObjectSourceSystemとObjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のオブジェクト・パーティを識別します。設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。
ObjectSourceSystemReferenceValue: string

タイトル: Object Source System Reference

外部ソース・システムからの関係におけるオブジェクト・パーティの識別子。 ObjectPartyId、ObjectPartyNumberおよびObjectSourceSystemとObjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のオブジェクト・パーティを識別します。
ObjectTableName: string

最大長: 30

この関係のオブジェクト・パーティのソース表名。
ObjectType: string

最大長: 30

担当者のオブジェクト・タイプ。
ObjectUsageCode: string

最大長: 30

関係におけるオブジェクト・パーティの使用コード。
ObjectVersionNumber: 整数(int32)

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

読取り専用: true

この属性は、オプティミスティック・ロックの実装に使用されます。この番号は、行を更新するたびに増分されます。この数値は、トランザクションの開始時と終了時に比較され、最後の問合せ以降に別のセッションによって行が更新されたかどうかが検出されます。
ObjectVersionNumber2: 整数(int32)

読取り専用: true

この属性は、オプティミスティック・ロックの実装に使用されます。この番号は、行を更新するたびに増分されます。この数値は、トランザクションの開始時と終了時に比較され、最後の問合せ以降に別のセッションによって行が更新されたかどうかが検出されます。
PartyId: integer (int64)

読取り専用: true

パーティの一意識別子
PartyId1: integer (int64)

読取り専用: true

パーティの代替一意識別子。
PercentageOwnership: number

タイトル: Ownership Percentage

親エンティティが所有する子エンティティのパーセンテージ。
PreferredContactFlag: boolean

最大長: 10

デフォルト値: false

この担当者個人が顧客のプライマリ担当者であるかどうかを示します。受け入れられる値はYおよびNです。デフォルト値はNです。
PrimaryCustomerFlag: boolean

最大長: 10

デフォルト値: false

この顧客が担当者のプライマリ顧客かどうかを示します。受け入れられる値はYおよびNです。デフォルト値はNです。
RelationshipCode: string

タイトル: Relationship Code

最大長: 30

これがフォワード関係コードかバック・ワード関係コードかを示します。有効な関係コードのリストは、参照PARTY_RELATIONS_TYPEで定義されます。設定およびメンテナンス・タスクの関係参照の管理を使用して、コードをレビューおよび更新します。
RelationshipId: integer (int64)

読取り専用: true

関係の一意の識別子。
RelationshipRecId: integer (int64)

関係レコードの一意の識別子。
RelationshipSourceSystem: string

システム設定の一部として管理者が定義する、関係の外部ソース・システムの名前。
RelationshipSourceSystemReferenceValue: string

外部ソース・システムとの関係の識別子。
RelationshipType: string

タイトル: Relationship Type

最大長: 30

関係タイプ名。たとえば、CUSTOMER_SUPPLIERです。有効な関係タイプのリストは、参照HZ_RELATIONSHIP_TYPEで定義されます。設定およびメンテナンス・タスクの関係参照の管理を使用して、コードをレビューおよび更新します。
RequestId: integer (int64)

要求トの一意の識別子。
Role: string

タイトル: Role

サブジェクト・パーティとオブジェクト・パーティ間のロール。
SSROwnerTableName: string

読取り専用: true

最大長: 255

デフォルト値: HZ_PARTIES

レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。
StartDate: 文字列(日付)

タイトル: From Date

関係が設定された日付。デフォルトはシステム日付です。
Status: string

読取り専用: true

最大長: 1

デフォルト値: A

これがアクティブまたは非アクティブの関係であるかどうかを示します。 Aはアクティブ、Iは非アクティブ。これは内部列であり、値を渡すことはできません。有効な値のリストは、参照HZ_STATUSで定義されます。「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。
SubjectPartyId: integer (int64)

この関係のサブジェクトの主キー識別子。 SubjectPartyId、SubjectPartyNumber、およびSubjectSourceSystemとSubjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のサブジェクト・パーティを識別します。
SubjectPartyName: string

タイトル: Subject Party Name

読取り専用: true

最大長: 360

件名パーティの名前。
SubjectPartyNumber: string

タイトル: Subject Registry ID

最大長: 30

関係のサブジェクト・パーティの代替キー識別子。 SubjectPartyId、SubjectPartyNumberおよびSubjectSourceSystemとSubjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のサブジェクト・パーティを識別します。
SubjectSourceSystem: string

タイトル: Subject Source System

関係のサブジェクト・パーティの外部ソース・システムの名前で、システム設定の一部として管理者が定義します。 SubjectPartyId、SubjectPartyNumberおよびSubjectSourceSystemとSubjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のサブジェクト・パーティを識別します。設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。
SubjectSourceSystemReferenceValue: string

タイトル: Subject Source System Reference

外部ソース・システムからの関係のサブジェクト・パーティの識別子。 SubjectPartyId、SubjectPartyNumberおよびSubjectSourceSystemとSubjectSourceSystemReferenceValueの組合せのいずれかを使用して、関係のサブジェクト・パーティを識別します。
SubjectTableName: string

最大長: 30

件名のソース表。
SubjectType: string

最大長: 30

担当者の件名タイプ。
SubjectUsageCode: string

最大長: 30

担当者のサブジェクト・パーティの使用コード。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectPartyNumber":{
            "title":"Subject Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"The relationship type name. For example, CUSTOMER_SUPPLIER. A list of valid relationship types is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date when the relationship was established. Defaulted to the system date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SubjectType":{
            "maxLength":30,
            "type":"string",
            "description":"The subject type of the contact.",
            "nullable":false,
            "x-queryable":true
        },
        "SubjectSourceSystem":{
            "title":"Subject Source System",
            "type":"string",
            "description":"The name of external source system for the subject party in the relationship, which are defined by an admin as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactFlag":{
            "maxLength":10,
            "type":"boolean",
            "description":"Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PreferredContactPersonId"
                ]
            }
        },
        "BackwardRole":{
            "title":"Backward Role",
            "type":"string",
            "description":"The backward relationship code used to describe relationships. For example, SUPPLIER_OF.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubjectPartyId":{
            "type":"integer",
            "description":"The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubjectUsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"The usage code of subject party in the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "maxLength":30,
            "type":"string",
            "description":"The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "Status":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this is an active or inactive relationship. A for active, I for inactive. This is an internal column and you are not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"A",
            "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PercentageOwnership":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"The percentage of the child entity owned by the parent entity.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestId":{
            "type":"integer",
            "description":"The unique identifier of the request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipRecId":{
            "type":"integer",
            "description":"The unique identifier of the relationship record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubjectSourceSystemReferenceValue":{
            "title":"Subject Source System Reference",
            "type":"string",
            "description":"The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryCustomerFlag":{
            "maxLength":10,
            "type":"boolean",
            "description":"Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "ObjectVersionNumber2":{
            "type":"integer",
            "description":"The attribute is used to implement 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 last queried.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Role":{
            "title":"Role",
            "type":"string",
            "description":"The role between the subject and object party.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelationshipSourceSystem":{
            "type":"string",
            "description":"The name of external source system for the relationship, which is defined by an admin as part of the system setup.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"The attribute is used to implement 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 last queried.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "HeadOfHouseholdFlag":{
            "title":"Head of Household Indicator",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a person is the head of the household that he belongs to.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "SSROwnerTableName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the table that holds the record data and is referenced to manage source system reference.",
            "nullable":true,
            "readOnly":true,
            "default":"HZ_PARTIES",
            "x-queryable":true
        },
        "ObjectUsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"The usage code of object party in the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectSourceSystemReferenceValue":{
            "title":"Object Source System Reference",
            "type":"string",
            "description":"The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "SubjectTableName":{
            "maxLength":30,
            "type":"string",
            "description":"The source table of the subject.",
            "nullable":false,
            "x-queryable":true
        },
        "DependentFlag":{
            "title":"Dependent Indicator",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether one party is a dependent on another.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the contact record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobDefinitionName":{
            "maxLength":100,
            "type":"string",
            "description":"The definition of the job name.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectTableName":{
            "maxLength":30,
            "type":"string",
            "description":"The source table name of the object party in this relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "InfluenceLevel":{
            "title":"Influence Level",
            "type":"string",
            "description":"The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"The object type of the contact.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectPartyId":{
            "type":"integer",
            "description":"The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobDefinitionPackage":{
            "maxLength":900,
            "type":"string",
            "description":"The definition of the job package.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectPartyNumber":{
            "title":"Object Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectPartyName":{
            "title":"Object Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the object party of the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement 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 determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether this is a forward or a backward relationship code. A list of valid relationship codes is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubjectPartyName":{
            "title":"Subject Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the subject party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The user comments for this relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipSourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier for the relationship with the external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "DirectionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The record validated by DIRECTION_CODE lookup type. P for Parent, C for Child, and N for Not Directional.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId1":{
            "type":"integer",
            "description":"The alternate unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date when the relationship ends.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectSourceSystem":{
            "title":"Object Source System",
            "type":"string",
            "description":"The name of external source system for the object party in the relationship, which are defined by an admin as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"The unique identifier of the relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

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

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

リンク

BackwardRoleLOV

操作: /crmRestApi/resources/11.13.18.05/relationshipTypes

パラメータ:

ファインダ: RoleForSubjectObjectFinder%3BbindObjectType%3D{SubjectType}%2CbindSubjectType%3D{ObjectType}

後方ロール・タイプを示す値リスト。

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

ソース属性: BackwardRole;ターゲット属性: ロール
表示属性: 説明

InfluenceLevelLookupLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_INFLUENCE_LVL_CD

関係の影響レベルを示す値リスト。

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

ソース属性: InfluenceLevel;ターゲット属性: LookupCode
表示属性: LookupCode

RelationshipCodeLookupLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DPARTY_RELATIONS_TYPE

関連および関連会社など、関係の記述に使用されるフレーズを示す値リスト。

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

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

RelationshipTypeLookupLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DHZ_RELATIONSHIP_TYPE

関連または競合相手など、関係のタイプを示す値リスト。

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

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

RoleLOV

操作: /crmRestApi/resources/11.13.18.05/relationshipTypes

パラメータ:

ファインダ: RoleForSubjectObjectFinder%3BbindObjectType%3D{ObjectType}%2CbindSubjectType%3D{SubjectType}

ロール・タイプを示す値リスト。

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

ソース属性: ロール、ターゲット属性: ロール
表示属性: 説明

「トップに戻る」