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

機械翻訳について

追加名の更新

patch

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalName/{NameId}

リクエスト

パス・パラメータ

NameId(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

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

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

タイプ: object

ソースを表示

AcademicTitle: string

タイトル: Academic Title

最大長: 30

学業資格を示す個人のタイトルの一部です(Dr. Jane Smithなど)。
ConflictId: integer (int64)

デフォルト値: 0

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

タイトル: Description

最大長: 240

追加名レコードの説明
FirstName: string

タイトル: First Name

最大長: 150

レコードに関連付けられている名。
LastName: string

タイトル: Last Name

最大長: 150

レコードに関連付けられた姓。
MiddleName: string

タイトル: Middle Name

最大長: 60

レコードに関連付けられたミドル・ネーム。
Name: string

タイトル: Additional Name

最大長: 360

組織、個人またはグループ・パーティの名前。たとえば、"Oracle"や"John Smith"などです。
PartySourceSystem: string

住所に関連付けられたアカウント・パーティがインポートされる外部ソース・システムの名前。値は、設定タスク取引先コミュニティ・ソース・システムで構成できます。
PartySourceSystemReferenceValue: string

属性PartySourceSystemで指定された外部ソース・システムからの、住所に関連付けられたアカウントの一意の識別子。
PreferredFlag: boolean

タイトル: Preferred Indicator

最大長: 1

デフォルト値: false

この名前タイプ内で、このパーティの優先名として名前を識別します。指定可能な値は'Y'および'N'です。デフォルトはNです。
SourceSystem: string

アカウント・パーティがインポートされる外部ソース・システムの名前。設定タスク取引先コミュニティ・ソース・システムで構成された値。
SourceSystemReferenceValue: string

属性SourceSystemで指定された外部ソース・システムからのアカウント・パーティの一意の識別子。
StatusFlag: boolean

最大長: 1

デフォルト値: true

追加名が現在アクティブかどうかを示します。
Title: string

タイトル: Title

最大長: 60

DonやThe Right Honorableなどの専門職または家族のタイトル
TransliterationLanguage: string

タイトル: Transliteration Language

最大長: 4

TransliterationLanguageは、外国語で単語や名前の発音に役立ちます。 FND_LANGUAGES.LANGUAGE_CODEに対して検証されます。サンプル値: US,NL,DK etc.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the Additional Name record",
            "nullable":true
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            }
        },
        "Title":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"A professional or family title, such as Don or The Right Honorable",
            "nullable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            }
        },
        "StatusFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the additional name is currently active.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
            }
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the account party from the external source system specified in the attribute SourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":4,
            "type":"string",
            "description":"TransliterationLanguage helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Name":{
            "title":"Additional Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the organization, person, or group party. For example, \"Oracle\" or \"John Smith\".",
            "nullable":true
        },
        "AcademicTitle":{
            "title":"Academic Title",
            "maxLength":30,
            "type":"string",
            "description":"The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith.",
            "nullable":true
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            }
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredFlag":{
            "title":"Preferred Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Identify the name as preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'.",
            "nullable":false,
            "default":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

AcademicTitle: string

タイトル: Academic Title

最大長: 30

学業資格を示す個人のタイトルの一部です(Dr. Jane Smithなど)。
ConflictId: integer (int64)

デフォルト値: 0

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

読取り専用: true

最大長: 64

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

読取り専用: true

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

タイトル: Description

最大長: 240

追加名レコードの説明
FirstName: string

タイトル: First Name

最大長: 150

レコードに関連付けられている名。
LastName: string

タイトル: Last Name

最大長: 150

レコードに関連付けられた姓。
LastUpdateDate: string (date-time)

読取り専用: true

担当者が最後に更新された日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

担当者レコードを最後に更新したユーザー。
links: array Links

タイトル: Links

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

タイトル: Middle Name

最大長: 60

レコードに関連付けられたミドル・ネーム。
Name: string

タイトル: Additional Name

最大長: 360

組織、個人またはグループ・パーティの名前。たとえば、"Oracle"や"John Smith"などです。
NameId: integer (int64)

読取り専用: true

名前の一意の識別子。
NameType: string

タイトル: Additional Name Type

最大長: 30

名前のタイプ。たとえば、ALIASやLEGALです。
PartyId: integer (int64)

パーティの一意識別子
PartyNumber: string

タイトル: Registry ID

読取り専用: true

最大長: 30

パーティの代替識別子。非アクティブなレコードは更新できません。
PartySourceSystem: string

住所に関連付けられたアカウント・パーティがインポートされる外部ソース・システムの名前。値は、設定タスク取引先コミュニティ・ソース・システムで構成できます。
PartySourceSystemReferenceValue: string

属性PartySourceSystemで指定された外部ソース・システムからの、住所に関連付けられたアカウントの一意の識別子。
PreferredFlag: boolean

タイトル: Preferred Indicator

最大長: 1

デフォルト値: false

この名前タイプ内で、このパーティの優先名として名前を識別します。指定可能な値は'Y'および'N'です。デフォルトはNです。
SourceSystem: string

アカウント・パーティがインポートされる外部ソース・システムの名前。設定タスク取引先コミュニティ・ソース・システムで構成された値。
SourceSystemReferenceValue: string

属性SourceSystemで指定された外部ソース・システムからのアカウント・パーティの一意の識別子。
StatusFlag: boolean

最大長: 1

デフォルト値: true

追加名が現在アクティブかどうかを示します。
Title: string

タイトル: Title

最大長: 60

DonやThe Right Honorableなどの専門職または家族のタイトル
TransliterationLanguage: string

タイトル: Transliteration Language

最大長: 4

TransliterationLanguageは、外国語で単語や名前の発音に役立ちます。 FND_LANGUAGES.LANGUAGE_CODEに対して検証されます。サンプル値: US,NL,DK etc.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contact record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the contact record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the contact record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the Additional Name record",
            "nullable":true,
            "x-queryable":true
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "NameId":{
            "type":"integer",
            "description":"The unique identifier of the name.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"A professional or family title, such as Don or The Right Honorable",
            "nullable":true,
            "x-queryable":true
        },
        "NameType":{
            "title":"Additional Name Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the name. For example, ALIAS or LEGAL.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "StatusFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the additional name is currently active.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the account party from the external source system specified in the attribute SourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":4,
            "type":"string",
            "description":"TransliterationLanguage helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Additional Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the organization, person, or group party. For example, \"Oracle\" or \"John Smith\".",
            "nullable":true,
            "x-queryable":true
        },
        "AcademicTitle":{
            "title":"Academic Title",
            "maxLength":30,
            "type":"string",
            "description":"The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the party. Inactive records can't be updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "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"
            }
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredFlag":{
            "title":"Preferred Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Identify the name as preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the contact 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."
        }
    }
}

リンク

NameTypeLOV

操作: /crmRestApi/resources/11.13.18.05/nameAndIdTypes

パラメータ:

ファインダ: NameTypeFinder

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

ソース属性: NameType;ターゲット属性: TypeCode
表示属性: TypeName

StatusLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

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

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

TransliterationLanguageLOV

操作: /fscmRestApi/resources/11.13.18.05/languagesLOV

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

ソース属性: TransliterationLanguage;ターゲット属性: LanguageCode
表示属性: 説明

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、追加の名前を更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_1597922/child/AdditionalName/300100157374911

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
"Name": "LocalRestNameUpdated" 
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
"Name": "LocalRestNameUpdated",
"NameType": "LOCAL",
"NameId": 300100157374911,
"StatusFlag": "A",
"CreationDate": "2017-12-14T14:09:54+00:00",
"CreatedBy": "SALES_ADMIN",
"LastUpdateDate": "2017-12-14T14:09:56.282+00:00",
"LastUpdatedBy": "SALES_ADMIN"
}

「トップに戻る」