詳細情報:
InsCensusServiceStd:getFields
このサービスを使用して、グループ国勢調査メンバーおよびグループ国勢調査メンバープランの項目定義と項目 API 参照名を取得します。
クラス: InsCensusServiceStd
方法: getFields
操作手順
- このサービスは、入力パラメータ
fieldsetNameで渡されるフィールドセットに含まれるフィールドのリストを取得しますGroupCensusMember。 -
withPlans パラメータが true の場合、サービスはGroupCensusMemberPlanフィールドのリストも取得します。 -
フィールド定義のリスト (フィールドデータ型、フィールド表示ラベル、フィールド API 参照名、およびフィールド .csv ヘッダー) が組み合わされて が形成されます
headers。-
取得されたフィールドのリストに
GroupClassIdが含まれている場合、サービスはヘッダー - の下にノードを追加しますGroupClassId.Name。
-
-
項目の API 参照名のリストが結合されて JSON ノードが作成されます。
-
取得された項目のリストに が含ま
GroupClassIdれている場合、サービスは fields の下にノードを追加しますGroupClassId.Name。
-
リモートオプション
オプション |
説明 |
|---|---|
|
指定されたフィールドセットに含まれる 入力が既存の項目セットと一致しない場合、「指定された項目セット名 <fieldsetName> が存在しません」というエラーが返されます。 ユーザーが値を指定しない場合、サービスはデフォルトのフィールドセット |
|
有効な値のフィールドセットに含まれる 入力が既存の項目セットと一致しない場合、「指定された項目セット名 <planFieldsetName> が存在しません」というエラーが返されます。 ユーザーが値を指定しない場合、サービスはすべての |
|
Boolean
デフォルト値は |
Input JSON
入力 JSON の例を次に示します。
{
"fieldsetName": "memberFields",
"withPlans": true,
"planFieldsetName": "planFields"
}出力 JSON
サービスは、GroupCensusMember オブジェクトの項目セットmyFieldsetNameに含まれるすべての項目 API 参照名のリストを返します。withPlans パラメータが true の場合、出力には GroupCensusMemberPlan オブジェクトの項目セットmyPlanFieldsetNameに含まれる項目 API 参照名も含まれます。
ヘッダーは、サービスによって取得されるすべての項目の項目 API 参照名、項目の表示ラベル、項目データ型、項目の CSV ヘッダーのリストで構成されます。
このサービスは、次の例のように書式設定された出力 JSON を返します。
{
"fields": [
"vlocityins__AttributeSelectedValues__c",
"AccountId",
"Gender",
"ContractGroupPlanId",
],
"headers": [
{
"fieldId": "",
"type": "StringPlusClob",
"label": "Attribute Selected Values",
"name": "vlocityins__AttributeSelectedValues__c"
},
{
"fieldId": "",
"type": "EntityId",
"label": "Account ID",
"name": "AccountId"
},
{
"fieldId": "",
"type": "DynamicEnum",
"label": "Gender",
"name": "Gender"
"options": [
{
"label": "Male",
"name": "Male"
},
{
"label": "Female",
"name": "Female"
}
],
},
{
"fieldId": "",
"type": "EntityId",
"label": "Contract Group Plan ID",
"name": "ContractGroupPlanId",
"options":[
{
"value":"a2N4P000006ygEiUAI",
"type":"Medical",
"name":"rootProd",
"childProducts": [
{
"value": "0rgDC000000000RYAQ",
"IsOptional": false,
"name": "MandatoryCoverage"
},
{
"value": "0rgDC000000000RYBQ",
"IsOptional": true,
"name": "OptionalCoverage"
}
]
},
{
"value":"a2N4P000006ygEjUAI",
"type":"Dental",
"name":"rootProd2",
"childProducts": [
{
"value": "0rgDC000000000RYCQ",
"IsOptional": false,
"name": "MandatoryCoverage"
},
{
"value": "0rgDC000000000RYDQ",
"IsOptional": true,
"name": "OptionalCoverage"
}
]
}
]
}
]
}
