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

機械翻訳について

セルフサービス登録リクエストの作成

post

/crmRestApi/resources/11.13.18.05/selfRegistrations

リクエスト

ヘッダー・パラメータ

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

ソースを表示

AccountKey: string

タイトル: Account Key

最大長: 320

アカウント・キーは、セルフサービス登録リクエストを送信するユーザーのアカウントを特定するために使用され、アカウント・キーのデフォルト値はOrganizationNameの値です。この値は、プロファイル・オプションSVC_CSS_ACCT_KEY_FIELDを使用して変更できます。
AccountPartyId: integer (int64)

タイトル: Account ID

セルフサービス登録リクエストを送信するユーザーに関連付けられたアカウントの一意の識別子。
ContactPartyId: integer (int64)

タイトル: Contact ID

セルフサービス登録リクエストを送信するユーザーに関連付けられた担当者レコードの一意の識別子。
DateOfBirth: 文字列(日付)

タイトル: Date of Birth

自己登録ユーザーの誕生日。
EmailAddress: string

タイトル: Email

最大長: 320

セルフサービス登録リクエストを送信するユーザーのEメール。
HomePhoneAreaCode: string

タイトル: Home Phone Area Code

最大長: 20

登録ユーザーの勤務先電話番号の市外局番。
HomePhoneCountryCode: string

タイトル: Home Phone Country Code

最大長: 10

登録ユーザーの自宅電話番号の国コード。
HomePhoneNumber: string

タイトル: Home Phone Number

最大長: 40

登録ユーザーの自宅電話番号。
LoginId: string

タイトル: Login ID

最大長: 320

セルフサービス登録レコードを最後に更新したユーザー。
MobileAreaCode: string

タイトル: Mobile Area Code

最大長: 20

登録ユーザーのモバイル番号の市外局番。
MobileCountryCode: string

タイトル: Mobile Country Code

最大長: 10

登録ユーザーのモバイル番号の国コード。
MobileNumber: string

タイトル: Mobile Number

最大長: 40

登録ユーザーのモバイル番号。
Name: string

タイトル: Name

最大長: 360

ユーザー・アカウントに登録している個人の名前。値は、ユーザーの名、ミドル・ネームおよび姓の連結です。
PersonFirstName: string

タイトル: First Name

最大長: 150

ユーザー・アカウントに登録している個人の名。
PersonLastName: string

タイトル: Last Name

最大長: 150

ユーザー・アカウントに登録している個人の姓。
PersonMiddleName: string

タイトル: Middle Name

最大長: 60

ユーザー・アカウントに登録している個人のミドル・ネーム。
PrimaryAddressLine1: string

タイトル: Primary Address Line 1

最大長: 240

登録ユーザーのプライマリ住所の最初の行。
PrimaryAddressLine2: string

タイトル: Primary Address Line 2

最大長: 240

登録ユーザーのプライマリ住所の2行目。
PrimaryAddressTypeCd: string

タイトル: Primary Address Type

最大長: 30

自己登録ユーザーのプライマリ住所のタイプ。たとえば、請求先や出荷先などです。
PrimaryCity: string

タイトル: Primary City

最大長: 60

登録ユーザーのプライマリ住所の市区町村。
PrimaryCountry: string

タイトル: Primary Country

最大長: 2

登録ユーザーのプライマリ住所の国コード。
PrimaryPostalCode: string

タイトル: Primary Postal Code

最大長: 60

登録ユーザーのプライマリ住所の郵便番号。
PrimaryProvince: string

タイトル: Primary Province

最大長: 60

登録ユーザーのプライマリ住所の州。
PrimaryState: string

タイトル: Primary State

最大長: 60

登録ユーザーのプライマリ・アドレスの状態。
RawHomePhoneNumber: string

タイトル: Unformatted Home Phone Number

最大長: 60

登録ユーザーの書式なし自宅電話番号。
RawMobileNumber: string

タイトル: Unformatted Mobile Number

最大長: 60

登録ユーザーの書式なし自宅電話番号。
RawWorkPhoneNumber: string

タイトル: Unformatted Work Phone Number

最大長: 60

登録ユーザーの未フォーマットの勤務先電話番号。
RequestTypeCd: string

タイトル: Request Type

最大長: 30

セルフサービス登録のタイプを示すコード。受け入れられる値のリストは、参照ORA_SVC_CSS_REQ_TYPE_CDで定義されます。
SecondaryAddressLine1: string

タイトル: Secondary Address Line 1

最大長: 240

自己登録ユーザーのセカンダリ住所の番地の最初の行。
SecondaryAddressLine2: string

タイトル: Secondary Address Line 2

最大長: 240

自己登録ユーザーのセカンダリ住所の番地住所の2行目。
SecondaryAddressTypeCd: string

タイトル: Secondary Address Type

最大長: 30

自己登録ユーザーのセカンダリ・アドレスのタイプ。たとえば、請求先や出荷先などです。
SecondaryCity: string

タイトル: Secondary City

最大長: 60

自己登録ユーザーのセカンダリ住所の市区町村。
SecondaryCountry: string

タイトル: Secondary Country

最大長: 2

自己登録ユーザーのセカンダリ住所の国。
SecondaryPostalCode: string

タイトル: Secondary Postal Code

最大長: 60

自己登録ユーザーのセカンダリ住所の郵便番号。
SecondaryProvince: string

タイトル: Secondary Province

最大長: 60

自己登録ユーザーのセカンダリ住所の州。
SecondaryState: string

タイトル: Secondary State

最大長: 60

自己登録ユーザーのセカンダリ・アドレスの状態。
StatusCd: string

タイトル: Status

最大長: 30

セルフサービス登録リクエストのステータスを示すコード。受け入れられる値のリストは、参照ORA_SVC_CSS_REG_STATUS_CDで定義されます。
StatusMsg: string

タイトル: Reason

最大長: 800

セルフサービス登録リクエストを承認または否認する事由です。
WorkPhoneAreaCode: string

タイトル: Work Phone Area Code

最大長: 20

登録ユーザーの勤務先電話番号の市外局番。
WorkPhoneCountryCode: string

タイトル: Work Phone Country Code

最大長: 10

登録ユーザーの勤務先電話番号の国コード。
WorkPhoneExtension: string

タイトル: Work Phone Extension

最大長: 20

登録使用の勤務先電話番号の内線番号。
WorkPhoneNumber: string

タイトル: Work Phone Number

最大長: 40

登録ユーザーの勤務先電話番号。

{
    "type":"object",
    "properties":{
        "SecondaryAddressLine2":{
            "title":"Secondary Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the street address in the secondary address of the self-registering user.",
            "nullable":true
        },
        "StatusMsg":{
            "title":"Reason",
            "maxLength":800,
            "type":"string",
            "description":"The reason for approving or rejecting a self-service registration request.",
            "nullable":true
        },
        "SecondaryAddressLine1":{
            "title":"Secondary Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the street address in the secondary address of the self-registering user.",
            "nullable":true
        },
        "WorkPhoneNumber":{
            "title":"Work Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The work phone number of the registering user.",
            "nullable":true
        },
        "SecondaryCountry":{
            "title":"Secondary Country",
            "maxLength":2,
            "type":"string",
            "description":"The country in the secondary address of the self-registering user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimaryCity":{
            "title":"Primary City",
            "maxLength":60,
            "type":"string",
            "description":"The city for the primary address of the registering user.",
            "nullable":true
        },
        "SecondaryState":{
            "title":"Secondary State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the secondary address of the self-registering user.",
            "nullable":true
        },
        "MobileCountryCode":{
            "title":"Mobile Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the mobile number of the registering user.",
            "nullable":true
        },
        "RequestTypeCd":{
            "title":"Request Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of self-service registration. A list of accepted values is defined in the lookup ORA_SVC_CSS_REQ_TYPE_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            }
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the person registering for a user account.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkPhoneAreaCode":{
            "title":"Work Phone Area Code",
            "maxLength":20,
            "type":"string",
            "description":"The area code for the work phone number of the registering user.",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the person registering for a user account. The value is the concatenation of first name, middle name, and the last name of the user.",
            "nullable":true
        },
        "RawWorkPhoneNumber":{
            "title":"Unformatted Work Phone Number",
            "maxLength":60,
            "type":"string",
            "description":"The un-formatted work phone number of the registering user.",
            "nullable":true
        },
        "HomePhoneNumber":{
            "title":"Home Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The home phone number of the registering user.",
            "nullable":true
        },
        "PrimaryPostalCode":{
            "title":"Primary Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the primary address of the registering user.",
            "nullable":true
        },
        "WorkPhoneCountryCode":{
            "title":"Work Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the work phone number of the registering user.",
            "nullable":true
        },
        "SecondaryCity":{
            "title":"Secondary City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the secondary address of the self-registering user.",
            "nullable":true
        },
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the user submitting the self-service registration request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact record associated with the user submitting the self-service registration request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PrimaryProvince":{
            "title":"Primary Province",
            "maxLength":60,
            "type":"string",
            "description":"The province for the primary address of the registering user.",
            "nullable":true
        },
        "HomePhoneCountryCode":{
            "title":"Home Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the home phone number of the registering user.",
            "nullable":true
        },
        "DateOfBirth":{
            "title":"Date of Birth",
            "type":"string",
            "description":"The date of birth of the self-registering user.",
            "format":"date",
            "nullable":true
        },
        "WorkPhoneExtension":{
            "title":"Work Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The extension for the work phone number of the registering use.",
            "nullable":true
        },
        "RawMobileNumber":{
            "title":"Unformatted Mobile Number",
            "maxLength":60,
            "type":"string",
            "description":"The un-formatted home phone number of the registering user.",
            "nullable":true
        },
        "PrimaryAddressLine2":{
            "title":"Primary Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line for the primary address of the registering user.",
            "nullable":true
        },
        "HomePhoneAreaCode":{
            "title":"Home Phone Area Code",
            "maxLength":20,
            "type":"string",
            "description":"The area code for the work phone number of the registering user.",
            "nullable":true
        },
        "LoginId":{
            "title":"Login ID",
            "maxLength":320,
            "type":"string",
            "description":"The user who last updated the self-service registration record.",
            "nullable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the person registering for a user account.",
            "nullable":true
        },
        "RawHomePhoneNumber":{
            "title":"Unformatted Home Phone Number",
            "maxLength":60,
            "type":"string",
            "description":"The unformatted home phone number of the registering user.",
            "nullable":true
        },
        "PrimaryCountry":{
            "title":"Primary Country",
            "maxLength":2,
            "type":"string",
            "description":"The country code for the primary address of the registering user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SecondaryAddressTypeCd":{
            "title":"Secondary Address Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of secondary address of the self-registering user. Examples include Bill To, Ship To, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimaryAddressLine1":{
            "title":"Primary Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line for the primary address of the registering user.",
            "nullable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the self-service registration request. A list of accepted values is defined in the lookup ORA_SVC_CSS_REG_STATUS_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person registering for a user account.",
            "nullable":true
        },
        "PrimaryAddressTypeCd":{
            "title":"Primary Address Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of primary address of the self-registering user. Examples include Bill To, Ship To, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SecondaryProvince":{
            "title":"Secondary Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the secondary address of the self-registering user.",
            "nullable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email of the user submitting the self-service registration request.",
            "nullable":true
        },
        "MobileAreaCode":{
            "title":"Mobile Area Code",
            "maxLength":20,
            "type":"string",
            "description":"The area code for the mobile number of the registering user.",
            "nullable":true
        },
        "MobileNumber":{
            "title":"Mobile Number",
            "maxLength":40,
            "type":"string",
            "description":"The mobile number of the registering user.",
            "nullable":true
        },
        "PrimaryState":{
            "title":"Primary State",
            "maxLength":60,
            "type":"string",
            "description":"The state for the primary address of the registering user.",
            "nullable":true
        },
        "AccountKey":{
            "title":"Account Key",
            "maxLength":320,
            "type":"string",
            "description":"The account key is used to locate the account of the user submitting the self-service registration request, and the default value of the account key is the value of OrganizationName. The value can be changed using the profile option SVC_CSS_ACCT_KEY_FIELD.",
            "nullable":true
        },
        "SecondaryPostalCode":{
            "title":"Secondary Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the secondary address of the self-registering user.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : selfRegistrations-item-response

タイプ: object

ソースを表示

AccountKey: string

タイトル: Account Key

最大長: 320

アカウント・キーは、セルフサービス登録リクエストを送信するユーザーのアカウントを特定するために使用され、アカウント・キーのデフォルト値はOrganizationNameの値です。この値は、プロファイル・オプションSVC_CSS_ACCT_KEY_FIELDを使用して変更できます。
AccountPartyId: integer (int64)

タイトル: Account ID

セルフサービス登録リクエストを送信するユーザーに関連付けられたアカウントの一意の識別子。
AccountPartyName: string

タイトル: Account Name

読取り専用: true

最大長: 360

セルフサービス登録リクエストを発行するユーザーに属するアカウントの名前。
AccountPartyNumber: string

タイトル: Account Party Number

読取り専用: true

最大長: 30

セルフサービス登録を送信するユーザーに属するアカウントの番号。
ApproveActionDate: string (date-time)

タイトル: Status Change Date

読取り専用: true

セルフサービス登録レコードが承認または却下された日付。
ApproverPartyId: string

タイトル: Approver ID

読取り専用: true

セルフサービス登録レコードを承認または否認したユーザーの一意の識別子。
ApproverPartyName: string

タイトル: Approver

読取り専用: true

最大長: 360

セルフサービス登録レコードを承認または拒否したユーザーの名前。
ContactPartyId: integer (int64)

タイトル: Contact ID

セルフサービス登録リクエストを送信するユーザーに関連付けられた担当者レコードの一意の識別子。
ContactPartyName: string

タイトル: Contact Name

読取り専用: true

最大長: 360

担当者パーティ・オブジェクトに関連付けられたユーザーの名前。
ContactPartyNumber: string

タイトル: Contact Party Number

読取り専用: true

最大長: 30

担当者パーティ・オブジェクトに関連付けられたユーザーの番号。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

セルフサービス登録リクエストを送信するユーザーの一意の識別子。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが最初に作成された日付。
DateOfBirth: 文字列(日付)

タイトル: Date of Birth

自己登録ユーザーの誕生日。
DeleteFlag: boolean

タイトル: Can Delete

読取り専用: true

デフォルト値: false

セルフサービス登録レコードを削除できるかどうかを示します。
EmailAddress: string

タイトル: Email

最大長: 320

セルフサービス登録リクエストを送信するユーザーのEメール。
HomePhoneAreaCode: string

タイトル: Home Phone Area Code

最大長: 20

登録ユーザーの勤務先電話番号の市外局番。
HomePhoneCountryCode: string

タイトル: Home Phone Country Code

最大長: 10

登録ユーザーの自宅電話番号の国コード。
HomePhoneNumber: string

タイトル: Home Phone Number

最大長: 40

登録ユーザーの自宅電話番号。
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

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

タイトル: Login ID

最大長: 320

セルフサービス登録レコードを最後に更新したユーザー。
MobileAreaCode: string

タイトル: Mobile Area Code

最大長: 20

登録ユーザーのモバイル番号の市外局番。
MobileCountryCode: string

タイトル: Mobile Country Code

最大長: 10

登録ユーザーのモバイル番号の国コード。
MobileNumber: string

タイトル: Mobile Number

最大長: 40

登録ユーザーのモバイル番号。
Name: string

タイトル: Name

最大長: 360

ユーザー・アカウントに登録している個人の名前。値は、ユーザーの名、ミドル・ネームおよび姓の連結です。
PersonFirstName: string

タイトル: First Name

最大長: 150

ユーザー・アカウントに登録している個人の名。
PersonLastName: string

タイトル: Last Name

最大長: 150

ユーザー・アカウントに登録している個人の姓。
PersonMiddleName: string

タイトル: Middle Name

最大長: 60

ユーザー・アカウントに登録している個人のミドル・ネーム。
PrimaryAddressLine1: string

タイトル: Primary Address Line 1

最大長: 240

登録ユーザーのプライマリ住所の最初の行。
PrimaryAddressLine2: string

タイトル: Primary Address Line 2

最大長: 240

登録ユーザーのプライマリ住所の2行目。
PrimaryAddressTypeCd: string

タイトル: Primary Address Type

最大長: 30

自己登録ユーザーのプライマリ住所のタイプ。たとえば、請求先や出荷先などです。
PrimaryCity: string

タイトル: Primary City

最大長: 60

登録ユーザーのプライマリ住所の市区町村。
PrimaryCountry: string

タイトル: Primary Country

最大長: 2

登録ユーザーのプライマリ住所の国コード。
PrimaryPostalCode: string

タイトル: Primary Postal Code

最大長: 60

登録ユーザーのプライマリ住所の郵便番号。
PrimaryProvince: string

タイトル: Primary Province

最大長: 60

登録ユーザーのプライマリ住所の州。
PrimaryState: string

タイトル: Primary State

最大長: 60

登録ユーザーのプライマリ・アドレスの状態。
RawHomePhoneNumber: string

タイトル: Unformatted Home Phone Number

最大長: 60

登録ユーザーの書式なし自宅電話番号。
RawMobileNumber: string

タイトル: Unformatted Mobile Number

最大長: 60

登録ユーザーの書式なし自宅電話番号。
RawWorkPhoneNumber: string

タイトル: Unformatted Work Phone Number

最大長: 60

登録ユーザーの未フォーマットの勤務先電話番号。
RegistrationId: integer (int64)

タイトル: Registration ID

読取り専用: true

セルフサービス登録リクエストの一意の識別子。
RequestTypeCd: string

タイトル: Request Type

最大長: 30

セルフサービス登録のタイプを示すコード。受け入れられる値のリストは、参照ORA_SVC_CSS_REQ_TYPE_CDで定義されます。
SecondaryAddressLine1: string

タイトル: Secondary Address Line 1

最大長: 240

自己登録ユーザーのセカンダリ住所の番地の最初の行。
SecondaryAddressLine2: string

タイトル: Secondary Address Line 2

最大長: 240

自己登録ユーザーのセカンダリ住所の番地住所の2行目。
SecondaryAddressTypeCd: string

タイトル: Secondary Address Type

最大長: 30

自己登録ユーザーのセカンダリ・アドレスのタイプ。たとえば、請求先や出荷先などです。
SecondaryCity: string

タイトル: Secondary City

最大長: 60

自己登録ユーザーのセカンダリ住所の市区町村。
SecondaryCountry: string

タイトル: Secondary Country

最大長: 2

自己登録ユーザーのセカンダリ住所の国。
SecondaryPostalCode: string

タイトル: Secondary Postal Code

最大長: 60

自己登録ユーザーのセカンダリ住所の郵便番号。
SecondaryProvince: string

タイトル: Secondary Province

最大長: 60

自己登録ユーザーのセカンダリ住所の州。
SecondaryState: string

タイトル: Secondary State

最大長: 60

自己登録ユーザーのセカンダリ・アドレスの状態。
StatusCd: string

タイトル: Status

最大長: 30

セルフサービス登録リクエストのステータスを示すコード。受け入れられる値のリストは、参照ORA_SVC_CSS_REG_STATUS_CDで定義されます。
StatusCdMeaning: string

タイトル: Status Value

読取り専用: true

最大長: 80

セルフサービス登録リクエストのステータスのわかりやすい意味。
StatusMsg: string

タイトル: Reason

最大長: 800

セルフサービス登録リクエストを承認または否認する事由です。
UpdateFlag: boolean

タイトル: Can Update

読取り専用: true

セルフサービス登録レコードを更新できるかどうかを示します。デフォルト値はfalseです。
WorkPhoneAreaCode: string

タイトル: Work Phone Area Code

最大長: 20

登録ユーザーの勤務先電話番号の市外局番。
WorkPhoneCountryCode: string

タイトル: Work Phone Country Code

最大長: 10

登録ユーザーの勤務先電話番号の国コード。
WorkPhoneExtension: string

タイトル: Work Phone Extension

最大長: 20

登録使用の勤務先電話番号の内線番号。
WorkPhoneNumber: string

タイトル: Work Phone Number

最大長: 40

登録ユーザーの勤務先電話番号。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was first created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMsg":{
            "title":"Reason",
            "maxLength":800,
            "type":"string",
            "description":"The reason for approving or rejecting a self-service registration request.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryCountry":{
            "title":"Secondary Country",
            "maxLength":2,
            "type":"string",
            "description":"The country in the secondary address of the self-registering user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MobileCountryCode":{
            "title":"Mobile Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the mobile number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the person registering for a user account.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPartyName":{
            "title":"Contact Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the user associated with the Contact Party object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the person registering for a user account. The value is the concatenation of first name, middle name, and the last name of the user.",
            "nullable":true,
            "x-queryable":true
        },
        "ApproverPartyId":{
            "title":"Approver ID",
            "type":"string",
            "description":"The unique identifier of the user who approved or rejected the self-service registration record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SecondaryCity":{
            "title":"Secondary City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the secondary address of the self-registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the user submitting the self-service registration request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact record associated with the user submitting the self-service registration request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the self-service registration record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateOfBirth":{
            "title":"Date of Birth",
            "type":"string",
            "description":"The date of birth of the self-registering user.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneExtension":{
            "title":"Work Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The extension for the work phone number of the registering use.",
            "nullable":true,
            "x-queryable":true
        },
        "RawMobileNumber":{
            "title":"Unformatted Mobile Number",
            "maxLength":60,
            "type":"string",
            "description":"The un-formatted home phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the user submitting the self-service registration request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HomePhoneAreaCode":{
            "title":"Home Phone Area Code",
            "maxLength":20,
            "type":"string",
            "description":"The area code for the work phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the person registering for a user account.",
            "nullable":true,
            "x-queryable":true
        },
        "RawHomePhoneNumber":{
            "title":"Unformatted Home Phone Number",
            "maxLength":60,
            "type":"string",
            "description":"The unformatted home phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryCountry":{
            "title":"Primary Country",
            "maxLength":2,
            "type":"string",
            "description":"The country code for the primary address of the registering user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SecondaryAddressTypeCd":{
            "title":"Secondary Address Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of secondary address of the self-registering user. Examples include Bill To, Ship To, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RegistrationId":{
            "title":"Registration ID",
            "type":"integer",
            "description":"The unique identifier of the self-service registration request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "maxLength":80,
            "type":"string",
            "description":"The user friendly meaning of the status of the self-service registration request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person registering for a user account.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryProvince":{
            "title":"Secondary Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the secondary address of the self-registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if a self-service registration record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email of the user submitting the self-service registration request.",
            "nullable":true,
            "x-queryable":true
        },
        "MobileAreaCode":{
            "title":"Mobile Area Code",
            "maxLength":20,
            "type":"string",
            "description":"The area code for the mobile number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the user associated with Contact Party object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPartyName":{
            "title":"Account Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the account belonging to the user submitting the self-service registration request.",
            "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 self-service registration record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SecondaryAddressLine2":{
            "title":"Secondary Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the street address in the secondary address of the self-registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryAddressLine1":{
            "title":"Secondary Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the street address in the secondary address of the self-registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneNumber":{
            "title":"Work Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The work phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryCity":{
            "title":"Primary City",
            "maxLength":60,
            "type":"string",
            "description":"The city for the primary address of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryState":{
            "title":"Secondary State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the secondary address of the self-registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestTypeCd":{
            "title":"Request Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of self-service registration. A list of accepted values is defined in the lookup ORA_SVC_CSS_REQ_TYPE_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "WorkPhoneAreaCode":{
            "title":"Work Phone Area Code",
            "maxLength":20,
            "type":"string",
            "description":"The area code for the work phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Account Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the account belonging to the user submitting the self-service registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if a self-service registration record can be updated. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            }
        },
        "RawWorkPhoneNumber":{
            "title":"Unformatted Work Phone Number",
            "maxLength":60,
            "type":"string",
            "description":"The un-formatted work phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneNumber":{
            "title":"Home Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The home phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryPostalCode":{
            "title":"Primary Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the primary address of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneCountryCode":{
            "title":"Work Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the work phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryProvince":{
            "title":"Primary Province",
            "maxLength":60,
            "type":"string",
            "description":"The province for the primary address of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "ApproveActionDate":{
            "title":"Status Change Date",
            "type":"string",
            "description":"The date when the self-service registration record was approved or rejected.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HomePhoneCountryCode":{
            "title":"Home Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the home phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryAddressLine2":{
            "title":"Primary Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line for the primary address of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "LoginId":{
            "title":"Login ID",
            "maxLength":320,
            "type":"string",
            "description":"The user who last updated the self-service registration record.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryAddressLine1":{
            "title":"Primary Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line for the primary address of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the self-service registration request. A list of accepted values is defined in the lookup ORA_SVC_CSS_REG_STATUS_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryAddressTypeCd":{
            "title":"Primary Address Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of primary address of the self-registering user. Examples include Bill To, Ship To, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MobileNumber":{
            "title":"Mobile Number",
            "maxLength":40,
            "type":"string",
            "description":"The mobile number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryState":{
            "title":"Primary State",
            "maxLength":60,
            "type":"string",
            "description":"The state for the primary address of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "ApproverPartyName":{
            "title":"Approver",
            "maxLength":360,
            "type":"string",
            "description":"The name of the user who approved or rejected the self-service registration record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountKey":{
            "title":"Account Key",
            "maxLength":320,
            "type":"string",
            "description":"The account key is used to locate the account of the user submitting the self-service registration request, and the default value of the account key is the value of OrganizationName. The value can be changed using the profile option SVC_CSS_ACCT_KEY_FIELD.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryPostalCode":{
            "title":"Secondary Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the secondary address of the self-registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date 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."
        }
    }
}

リンク

RequestTypeCdLookupLOVVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

セルフサービス登録リクエストのタイプを示す値リスト。参照タイプはORA_SVC_CSS_REQ_TYPE_CDです。

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

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

StatusCDLookupVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

ステータス・セルフサービス登録リクエスト(待ち状態、承認済、否認済など)を示す値リスト。参照タイプはORA_SVC_CSS_REG_STATUS_CDです。

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

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

トップに戻る

例:

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

POST  crmRestApi/resources/11.13.18.05/selfRegistrations HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

リクエスト本文の例

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

{
  "AccountKey": "Pinnacle Account",
  "EmailAddress": "pinnacle.account@oracle.com",
  "LoginId": "Pinnacle",
  "PersonFirstName": "Debra",
  "PersonLastName": "Kim",
  "PersonMiddleName": null
}

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 200 OK
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

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

{
  "RegistrationId": 300100095855333,
  "AccountKey": "Pinnacle Account",
  "AccountPartyId": 300100091492019,
  "ContactPartyId": 300100095857524,
  "CreatedBy": "FUSION",
  "CreationDate": "2017-03-06T18:44:59-08:00",
  "EmailAddress": "csstest.scn1_3196500861526535@oracle.com",
  "LastUpdateDate": "2017-03-07T02:42:56-08:00",
  "LastUpdateLogin": "4A217430FE441110E0530E8EF50AC384",
  "LastUpdatedBy": "css_dev_user@oracle.com",
  "LoginId": "csstest.scn1_3196500861526535@oracle.com",
  "PersonFirstName": "Debra",
  "PersonLastName": "Kim",
  "PersonMiddleName": null,
  "RegistrationTypeCd": null,
  "StatusCd": "ORA_CSS_APPROVED",
  "StatusMsg": "Congrats",
  "ContactPartyName": "Lisa Pickford",
  "AccountPartyName": "CSS ABCS Test 1",
  "Name": "Debra Kim",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095855333",
      "name": "selfRegistrations",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000278"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095855333",
      "name": "selfRegistrations",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095855333/lov/StatusCDLookupVO",
      "name": "StatusCDLookupVO",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095855333/lov/RegistrationTypeLookupPVO",
      "name": "RegistrationTypeLookupPVO",
      "kind": "collection"
    }
  ]
}

「トップに戻る」