機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

ソース・システム参照の更新

patch

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}

リクエスト

パス・パラメータ

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

ヘッダー・パラメータ

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

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• ConflictId: integer (int64)
  デフォルト値: 0

  競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
• CreatedByModule: string
  デフォルト値: HZ_WS

  レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。
• EndDate: 文字列(日付)
  レコードが無効になる日付。
• ObjectVersionNumber: 整数(int32)
  ロックの実装に使用される番号。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始日と終了日に比較され、別のセッションがその行を更新したかどうかが判断されます。
• PartyId: integer (int64)
  関連付けられたアカウントの一意の識別子。
• PartyNumber: string
  タイトル: Party Number

  関連付けられたアカウントの代替一意識別子。 非アクティブなレコードは更新できません。
• PartySourceSystem: string
  タイトル: Party Source System

  アカウントのソース・システム名。
• PartySourceSystemReferenceValue: string
  タイトル: Party Source System Reference Value

  外部ソース・システムからのレコードの識別子。
• SourceSystemReferenceValue: string
  最大長: 255

  関連アカウントの識別に必要なソース・システム参照値。
• Status: string
  最大長: 1

  デフォルト値: A

  ソース・システムへのマッピングがアクティブであることを示します。 値がAの場合、マッピングはアクティブです。 値がIの場合、マッピングは非アクティブです。

{
    "type":"object",
    "properties":{
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The identifier for the record from an external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "Status":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates of the mapping to the source system is active. If the value is A, then the mapping is active. If the value is I, then the mapping is inactive.",
            "nullable":false,
            "default":"A"
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The alternate unique identifier of the associated account. Inactive records can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the associated account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The source system name for the account.",
            "nullable":true,
            "x-queryable":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 comparedat the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "CreatedByModule":{
            "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":false
        },
        "EndDate":{
            "type":"string",
            "description":"The date after which the record is inactive.",
            "format":"date",
            "nullable":false
        },
        "SourceSystemReferenceValue":{
            "maxLength":255,
            "type":"string",
            "description":"The source system reference value required to identify the associated account.",
            "nullable":false
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : accounts-SourceSystemReference-item-response

タイプ: object

ソースを表示

• ConflictId: integer (int64)
  デフォルト値: 0

  競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreatedByModule: string
  デフォルト値: HZ_WS

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

  読取り専用: true

  レコードが作成された日付。
• EndDate: 文字列(日付)
  レコードが無効になる日付。
• LastUpdateDate: string (date-time)
  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

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

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  ロックの実装に使用される番号。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始日と終了日に比較され、別のセッションがその行を更新したかどうかが判断されます。
• PartyId: integer (int64)
  関連付けられたアカウントの一意の識別子。
• PartyNumber: string
  タイトル: Party Number

  関連付けられたアカウントの代替一意識別子。 非アクティブなレコードは更新できません。
• PartySourceSystem: string
  タイトル: Party Source System

  アカウントのソース・システム名。
• PartySourceSystemReferenceValue: string
  タイトル: Party Source System Reference Value

  外部ソース・システムからのレコードの識別子。
• SourceSystem: string
  タイトル: Source System

  最大長: 30

  ソース・システムの名前。
• SourceSystemReferenceId: integer (int64)
  読取り専用: true

  ソース・システム参照の一意の識別子。
• SourceSystemReferenceValue: string
  最大長: 255

  関連アカウントの識別に必要なソース・システム参照値。
• StartDate: 文字列(日付)
  レコードが作成された日付。
• Status: string
  最大長: 1

  デフォルト値: A

  ソース・システムへのマッピングがアクティブであることを示します。 値がAの場合、マッピングはアクティブです。 値がIの場合、マッピングは非アクティブです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates of the mapping to the source system is active. If the value is A, then the mapping is active. If the value is I, then the mapping is inactive.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystemReferenceId":{
            "type":"integer",
            "description":"The unique identifier of the source system reference.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The source system name for the account.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"The date after which the record is inactive.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "maxLength":255,
            "type":"string",
            "description":"The source system reference value required to identify the associated account.",
            "nullable":false,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The identifier for the record from an external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The alternate unique identifier of the associated account. Inactive records can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the associated account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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 comparedat 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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "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":false
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"The name of the source system.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date 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"
    }
}

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

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

「トップに戻る」