機械翻訳について

ジャンプ先

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

顧客分類の更新

patch

/crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}

リクエスト

パス・パラメータ

• CodeAssignmentId(required): integer(int64)
  顧客分類割当の一意の識別子。
• 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のデフォルト・バージョンを選択します。

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

• application/json

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

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

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

タイプ: object

ソースを表示

• EndDateActive: 文字列(日付)
  タイトル: End Date

  分類コードが無効になった日付。
• PrimaryFlag: boolean
  タイトル: Primary

  最大長: 1

  デフォルト値: false

  現在のコードがプライマリ分類コードかどうかを示すインジケータ。
• SourceSystem: string
  タイトル: Source System

  システム設定の一部として管理者が定義する、コードで示される区分カテゴリの外部ソース・システムの名前。 SourceSystemとSourceSystemReferenceの組合せは一意であり、クラス・カテゴリを識別するための外部キーとして使用されます。
• SourceSystemReferenceValue: string
  タイトル: Source System Reference Value

  外部ソースからの区分カテゴリの一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、クラス・カテゴリを識別するための外部キーとして使用されます。
• Status: string
  タイトル: Status

  最大長: 1

  デフォルト値: A

  コード割当がアクティブか非アクティブかを示します。たとえば、アクティブの場合はA、非アクティブの場合はIです。

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the code assignment is active or inactive, such as A for active and I for inactive.",
            "nullable":true,
            "default":"A"
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date on which the classification code is no longer valid.",
            "format":"date",
            "nullable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicator to show if the current code is the primary classification code.",
            "nullable":false,
            "default":false
        },
        "SourceSystem":{
            "title":"Source System",
            "type":"string",
            "description":"The name of external source system for the class category denoted by a code, which is defined by an administrator as part of system setup. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category.",
            "nullable":true
        },
        "SourceSystemReferenceValue":{
            "title":"Source System Reference Value",
            "type":"string",
            "description":"The unique identifier for the class category from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : hubPersons-CustomerClassification-item-response

タイプ: object

ソースを表示

• ClassCategory: string
  タイトル: Classification Category

  最大長: 30

  分類カテゴリの名前。
• ClassCode: string
  タイトル: Classification Code

  最大長: 30

  分類カテゴリに対応する有効な分類コード。
• CodeAssignmentId: integer (int64)
  タイトル: Code Assignment ID

  読取り専用: true

  顧客分類割当の一意の識別子。
• ConflictId: integer (int64)
  読取り専用: true

  デフォルト値: 0

  競合の一意の識別子。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザーの名前。
• CreatedByModule: string
  タイトル: Created by Module

  最大長: 30

  レコードを作成したアプリケーションまたはモジュール。 すべてのwebサービス・ベースの作成では、デフォルト値はHZ_WSです。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日時を示します。
• EndDateActive: 文字列(日付)
  タイトル: End Date

  分類コードが無効になった日付。
• IsAuxClassificationFlag: boolean
  タイトル: Auxiliary Classification Status

  読取り専用: true

  分類カテゴリがカスタム・グループ分類カテゴリかどうかを示します。
• IsIndustryFlag: boolean
  タイトル: Industry Type Status

  読取り専用: true

  分類カテゴリが産業グループ分類カテゴリであるかどうかを示します。
• IsOrgTypeFlag: boolean
  タイトル: Organization Type Status

  読取り専用: true

  分類カテゴリが組織タイプ分類カテゴリかどうかを示します。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日時を示します。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

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

  リソース・インスタンスに関連付けられたリンク関係。
• PartyId: integer (int64)
  タイトル: Party ID

  分類カテゴリおよび分類コードが関連付けられているアカウント、担当者または世帯の一意の識別子。
• PartyNumber: string
  タイトル: Party Number

  最大長: 30

  分類カテゴリおよび分類コードが関連付けられているアカウント、担当者または世帯の一意の代替識別子です。 非アクティブなレコードは更新できません。
• PartySourceSystem: string
  タイトル: Party Source System

  分類カテゴリおよび分類コードが関連付けられているアカウント、担当者または世帯の外部ソース・システムの名前。
• PartySourceSystemReferenceValue: string
  タイトル: Party Source System Reference Value

  分類カテゴリおよび分類コードが関連付けられているアカウント、担当者または世帯の外部ソース・システムからの識別子です。
• PartyType: string
  タイトル: Party Type

  読取り専用: true

  最大長: 30

  アカウント、担当者または世帯など、パーティのタイプを示します。
• PrimaryFlag: boolean
  タイトル: Primary

  最大長: 1

  デフォルト値: false

  現在のコードがプライマリ分類コードかどうかを示すインジケータ。
• SourceSystem: string
  タイトル: Source System

  システム設定の一部として管理者が定義する、コードで示される区分カテゴリの外部ソース・システムの名前。 SourceSystemとSourceSystemReferenceの組合せは一意であり、クラス・カテゴリを識別するための外部キーとして使用されます。
• SourceSystemReferenceValue: string
  タイトル: Source System Reference Value

  外部ソースからの区分カテゴリの一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、クラス・カテゴリを識別するための外部キーとして使用されます。
• StartDateActive: 文字列(日付)
  タイトル: Start Date

  分類が有効になる日付。
• Status: string
  タイトル: Status

  最大長: 1

  デフォルト値: A

  コード割当がアクティブか非アクティブかを示します。たとえば、アクティブの場合はA、非アクティブの場合はIです。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Indicates the date and time when the record is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicator to show if the current code is the primary classification code.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "IsAuxClassificationFlag":{
            "title":"Auxiliary Classification Status",
            "type":"boolean",
            "description":"Indicates whether the classification category is a custom group classification category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassCategory":{
            "title":"Classification Category",
            "maxLength":30,
            "type":"string",
            "description":"The name of the classification category.",
            "nullable":false,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The identifier from external source system for the account, contact, or household with which the classification category and classification code is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date on which the classification becomes valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "title":"Created by Module",
            "maxLength":30,
            "type":"string",
            "description":"The application or module that created the record. The default value is HZ_WS for all web service based creation.",
            "nullable":false,
            "x-queryable":true
        },
        "IsOrgTypeFlag":{
            "title":"Organization Type Status",
            "type":"boolean",
            "description":"Indicates whether the classification category is an organization type classification category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Party Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of the party, such as account, contact, or household.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsIndustryFlag":{
            "title":"Industry Type Status",
            "type":"boolean",
            "description":"Indicates whether the classification category is an industry group classification category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the code assignment is active or inactive, such as A for active and I for inactive.",
            "nullable":true,
            "default":"A",
            "x-queryable":true
        },
        "CodeAssignmentId":{
            "title":"Code Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the customer classification assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The name of the external source system of the account, contact, or household with which the classification category and classification code is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "title":"Source System Reference Value",
            "type":"string",
            "description":"The unique identifier for the class category from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique alternate identifier of the account, contact, or household to which the classification category and classification code is associated. Inactive records can't be updated.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date on which the classification code is no longer valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClassCode":{
            "title":"Classification Code",
            "maxLength":30,
            "type":"string",
            "description":"A valid classification code corresponding to the classification category.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of account, contact, or household to which the classification category and classification code is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "type":"string",
            "description":"The name of external source system for the class category denoted by a code, which is defined by an administrator as part of system setup. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates the date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

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

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

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

「トップに戻る」