Field Type & Data Type List
PORTERS APIで取り扱うことのできるField Typeの一覧と、それぞれの値は次の通りです。
Data Typeによって、XMLのフォーマットが異なります。詳細は、Read API - XML Format、Write API - XML Formatを参照してください。
※{Resource}には、Client、Job、ResumeなどのResource名が入ります。
Value | Field Type Name | Data Type | Description |
---|---|---|---|
1 | SinglelineText | SinglelineText | 一行の文字列を表します。 |
2 | MultilineText | MultilineText | 改行コードを含む複数行の文字列を表します。 |
3 | Number | Number | 数値を表します。 |
4 | Date | Date | 日付(年月日)を表します。[yyyy/mm/dd]の書式のみサポートしています。 |
5 | Option[Checbox] | Option | 選択肢(チェックボックス or 複数選択可能サーチボックス)で、定義済みの選択肢から値を選択します。 XMLフォーマットの詳細は、Read API - XML Format > Data Type : OptionまたはWrite API - XML Format > Data Type : Optionを確認してください。 |
6 | Option[Radiobutton] | Option | 選択肢(ラジオボタン or サーチボックス)で、定義済みの選択肢から値を選択します。 XMLフォーマットの詳細は、Read API - XML Format > Data Type : OptionまたはWrite API - XML Format > Data Type : Optionを確認してください。 |
7 | Option[Drowdown] | Option | 選択肢(ドロップダウン)で、定義済みの選択肢から値を選択します。 XMLフォーマットの詳細は、Read API - XML Format > Data Type : OptionまたはWrite API - XML Format > Data Type : Optionを確認してください。 |
8 | Age | Age | 生年月日(年齢)を表します。[yyyy/mm/dd]の書式のみサポートしています。 値はDate型と同じですが、PORTERS画面表示時に現在日付から自動的に年齢を算出します。 |
9 | URL | URL | URLを表す文字列型です。 |
10 | メールアドレスを表す文字列型です。 | ||
11 | System | System[Id] | レコードのIDを数値で表します。対象となるFieldはSystem Field Listを参照してください。 |
System[DateTime] | 日付(年月日時分)を表します。指定された時刻はUTCとして扱われます。 [yyyy/mm/dd HH:MM:SS]の書式のみサポートしています。 Write時に任意の日時を指定することはできません。 対象となるFieldはSystem Field Listを参照してください。 |
||
System[Reference] | 関連する上位Resourceを表します。対象となるFieldはSystem Field Listを参照してください。 Readの場合、Read API - Parameter > Read - Fieldに従って指定することで、上位ResourceのFieldを参照することができます。 Writeの場合、上位Resourceの{Resource}.P_Idの値のみを指定することができます。 |
||
System[Department] | User APIのみで使用されるField Typeです。 対象となるFieldはSystem Field Listを参照してください。 |
||
12 | DateTime | DateTime | 日付(年月日時分)を表します。指定された時刻はUTCとして扱われます。 [yyyy/mm/dd HH:MM:SS]の書式のみサポートしています。 |
14 | Currency | Number | 通貨を表します。 |
15 | Telephone | Telephone | 電話番号を表す文字列型です。 |
16 | Reference | ー | 他のResourceのデータを参照して表示する項目です。当該項目自体にデータを持つことはありません。 |
17 | User | User | 定義済みのユーザーから値を選択するユーザー型です。対象となるFieldはSystem Field Listを参照してください。 Readの場合、Read API - Parameter > Read - Fieldに従って指定することで、定義されているUser情報を参照することができます。 Writeの場合、User.P_Idの値のみを指定することができます。 |
18 | Image | Image | 画像を表します。ContentはBase64 Encode/Decodeが必要です。 XMLフォーマットの詳細は、Read API - XML Format > Data Type : ImageまたはWrite API - XML Format > Data Type : Imageを確認してください。 |
20 | Link | Link | Contact(コンタクト)レコードのIDを数値で表します。 ConnectAPI-Version2以降を指定する必要があります。詳細はHTTP-Headerを確認してください。 |
System Field List
System Type、User TypeのFieldは以下の通りです。Aliasなどの詳細は、各ResourceのField Listを参照してください。
※{Resource}には、Client、Job、ResumeなどのResource名が入ります。
Field Type | Field | Description |
---|---|---|
System[Id] | {Resource}.P_Id | レコードのIDです。 |
System[DateTime] | {Resource}.P_RegistrationDate | レコードのデータ登録日です。 Write時に任意の日時を指定することはできません。 |
{Resource}.P_UpdateDate | レコードのデータ更新日です。 Write時に任意の日時を指定することはできません。 |
|
System[Reference] | {Resource}.P_Client | 関連するClient(企業)を表す項目です。 Readの場合、Client ResourceのFieldを参照することができます。 Writeの場合、Cliend.P_Idの値のみを指定することができます。 |
{Resource}.P_Recruiter | 関連するRecruiter(企業担当者)を表す項目です。 Readの場合、Recruiter ResourceのFieldを参照することができます。 Writeの場合、Recruiter.P_Idの値のみを指定することができます。 |
|
{Resource}.P_Job | 関連するJobを表す項目です。 Readの場合、Job ResourceのFieldを参照することができます。 Writeの場合、Job.P_Idの値のみを指定することができます。 |
|
{Resource}.P_Candidate | 関連するCandidateを表す項目です。 Readの場合、Candidate ResourceのFieldを参照することができます。 Writeの場合、Person.P_Idの値のみを指定することができます。 |
|
{Resource}.P_Resume | 関連するResume(レジュメ)を表す項目です。 Readの場合、Resume ResourceのFieldを参照することができます。 Writeの場合、Resume.P_Idの値のみを指定することができます。 |
|
Sales.P_Contract | 関連するContract(契約)を表す項目です。 Readの場合、Contract ResourceのFieldを参照することができます。 Writeの場合、Contract.P_Idの値のみを指定することができます。 |
|
Activity.P_ResourceId | 関連する上位Resourceを表す項目です。 | |
System[Department] | User.P_Department | ユーザーの部署を表す項目です。 |
User | {Resource}.P_Owner | レコードの所有者を表します。新規作成時には通常必須となります。 |
{Resource}.P_RegisteredBy | レコードの登録者を表します。 Write(新規作成)時に指定されていない場合は、現在アクセスしているアプリユーザーが自動的に割り当てられます。 |
|
{Resource}.P_UpdatedBy | レコードの登録者を表します。 Write時に指定されていない場合は、現在アクセスしているアプリユーザーが自動的に割り当てられます。 |
|
Activity.P_EventParticipants | アクティビティの参加者です。 |