您位於此處:
InsCensusServiceStd:getFields
使用此服務可針對群組普查成員和群組普查成員計畫,來提取欄位定義和欄位 API 名稱。
類別:InsCensusServiceStd
方法:getFields
運作方式
- 服務會從在輸入參數
fieldsetName中傳遞的欄位集中取得一部分的GroupCensusMember欄位清單。 -
若
withPlans參數為 true,則服務也會提取GroupCensusMemberPlan欄位的清單。 -
欄位定義清單 (欄位資料類型、欄位標籤、欄位 API 名稱和欄位 .csv 標題) 會合併為
headers。-
如果選取的欄位清單中包含
GroupClassId,則服務會在標題 -GroupClassId.Name下新增節點。
-
-
欄位 API 名稱清單會合併以形成 JSON 節點。
-
如果選取的欄位清單中包含
GroupClassId,則服務會在 fields -GroupClassId.Name下新增節點。
-
遠端選項
選項 |
描述 |
|---|---|
|
檢取屬於指定欄位集一部分的 如果輸入與現有欄位集不符,服務會傳回錯誤 - 「指定的欄位集名稱 <fieldsetName> 不存在。」 如果使用者未指定值,則服務會使用預設欄位集 - |
|
針對任何有效值中屬於欄位集的 如果輸入與現有欄位集不符,則服務會傳回錯誤 - 「指定的欄位集名稱 <planFieldsetName> 不存在。」 如果使用者未指定值,服務會傳回所有 |
|
布林值 如果為 預設值為 |
輸入 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"
}
]
}
]
}
]
}
