詳細情報:
InsCensusService:getFields
このサービスを使用して、グループ国勢調査メンバーとグループ国勢調査計画の項目定義と項目 API 参照名を取得します。このサービスでゲストユーザーアクセスが有効になっている。
方法: getFields
操作手順
-
サービスは、
GroupCensusMember__cフィールドのリストを取得します。 -
withPlansパラメータが true に設定されている場合、サービスはGroupCensusMemberPlan__cフィールドのリストも取得します。 -
フィールド定義のリストが結合されて、
headersJSON ノードが作成されます。-
取得されるフィールドのリストに
GroupClassId__cが含まれている場合、ヘッダー -GroupClassId__r.Nameの下にノードが追加されます。
-
-
フィールド API 参照名のリストが結合されて、
fieldsJSON ノードが作成されます。-
取得される項目のリストに
GroupClassId__cが含まれている場合、項目 -GroupClassId__r.Nameの下にノードが追加されます。
-
リモートオプション
オプション |
説明 |
|---|---|
|
有効な値の項目セットに含まれる 項目セットのない値には項目が返されません。 デフォルト = EditableTable |
|
有効な値の項目セットに含まれる
|
|
Boolean
デフォルト = |
出力 JSON
このサービスは、次の例のように書式設定された出力 JSON を返します。
{
"fields": [
"Name",
"vlocity_ins__Birthdate__c",
"vlocity_ins__FirstName__c",
"vlocity_ins__Gender__c",
"vlocity_ins__LastName__c",
"vlocity_ins__RelatedCensusMemberId__c",
"vlocity_ins__IsPrimaryMember__c",
"vlocity_ins__IsSpouse__c",
"vlocity_ins__MemberIdentifier__c",
"vlocity_ins__PrimaryMemberIdentifier__c"
],
"headers": [
{
"type": "STRING",
"label": "Name",
"fieldId": "",
"name": "Name"
},
{
"type": "DATE",
"label": "Birthdate",
"fieldId": "",
"name": "vlocity_ins__Birthdate__c"
},
{
"type": "STRING",
"label": "First Name",
"fieldId": "",
"name": "vlocity_ins__FirstName__c"
},
{
"options": [
{
"value": "Male",
"label": "Male"
},
{
"value": "Female",
"label": "Female"
}
],
"type": "PICKLIST",
"label": "Gender",
"fieldId": "",
"name": "vlocity_ins__Gender__c"
},
{
"type": "STRING",
"label": "Last Name",
"fieldId": "",
"name": "vlocity_ins__LastName__c"
},
{
"type": "REFERENCE",
"label": "Primary Census Member",
"fieldId": "",
"name": "vlocity_ins__RelatedCensusMemberId__c"
},
{
"type": "BOOLEAN",
"label": "Primary",
"fieldId": "",
"name": "vlocity_ins__IsPrimaryMember__c"
},
{
"type": "BOOLEAN",
"label": "Is Spouse",
"fieldId": "",
"name": "vlocity_ins__IsSpouse__c"
},
{
"type": "STRING",
"label": "Member Identifier",
"fieldId": "",
"name": "vlocity_ins__MemberIdentifier__c"
},
{
"type": "STRING",
"label": "Primary Member Identifier",
"fieldId": "",
"name": "vlocity_ins__PrimaryMemberIdentifier__c"
}
]
}