Client - Field List

The Field and initial values that can be handled by the Client API are shown below:

  • The Name (item name) is changeable and thus may differ from the actual name.
  • Some items may have been deleted depending on the usage status of the user.
  • For the Option Type, the Aliases of the options that the item uses are written in the Definition.
  • For the Reference Type, the Alias of an upper-level Resource that the item refers to is written in the Definition.

For Fields created by a user or app or for Fields not included in the following, use Field Read to acquire the information.


For details on the Field Type and Data Type, see Field Type & Data Type List.

The XML format differs depending on the Data Type. For details, see Read API - XML Format and Write API - XML Format.

Required for
new registration
Required for
Alias Name Field Type Definition
Client.P_Id Client ID System[Id] Specify -1 for new registration, and the ID to be updated for update.
Client.P_Owner Client Owner User  
Client.P_RegistrationDate Date Created System[DateTime]  
Client.P_RegisteredBy Registered by User  
Client.P_UpdateDate Date Updated System[DateTime]  
Client.P_UpdatedBy Updated by User  
Client.P_Phase Phase Option[Drowdown] Option: Option.P_ClientPhase
For details on the notes, see Write API - Phase Update.
Client.P_PhaseDate Phase Date DateTime For details on the notes, see Write API - Phase Update.
Client.P_PhaseMemo Phase Memo MultilineText For details on the notes, see Write API - Phase Update.
Client.P_Name Client Name SinglelineText  
Client.P_Memo Memo MultilineText  
Client.P_Country Country (Client) SinglelineText  
Client.P_Prefecture Prefecture (Client) SinglelineText  
Client.P_City City (Client) SinglelineText  
Client.P_Street Address (Client) MultilineText  
Client.P_Zipcode Zip Code (Client) SinglelineText  
Client.P_Telephone Phone (Client) Telephone  
Client.P_Fax Fax (Client) Telephone  
Client.U_[Name] User created item.
The name specified by the user or the name given by the system is specified for [Name].
Client.A_[Name] App created item.
The name given by the app is normally specified for [Name].

Indicates the deletion status of the record.
 0: Undeleted record
 1: Deleted record

This field will be available from 04/10/2018.
This item can be specified only as the field parameter for Read. Condition or Order cannot be specified with this item.
Also, this item cannot be specified for Write.


Was this article helpful?
1 out of 1 found this helpful