Du är här:
InsCensusServiceStd:getFields
Använd denna tjänst för att hämta fältdefinitioner och fält-API-namn för gruppräkningsmedlemmar och gruppräkningsmedlemsplaner.
Klass: InsCensusServiceStd
Metod: getFields
Så här fungerar det
- Tjänsten hämtar listan över
GroupCensusMembersom ingår i fältuppsättningen som skickas ifieldsetNameför indataparametrar. -
Om
withPlansär sant hämtar tjänsten även listan överGroupCensusMemberPlan. -
Listan över fältdefinitioner (fältdatatyper, fältetiketter, fält-API-namn och fält-.csv-sidhuvuden) kombineras för att bilda
headers.-
Om
GroupClassIdinkluderas i den hämtade listan över fält lägger tjänsten till en nod under rubrikerna -GroupClassId.Name.
-
-
Listan över fältens API-namn kombineras för att bilda JSON-noden.
-
Om
GroupClassIdinkluderas i den hämtade listan över fält lägger tjänsten till en nod under fälten -GroupClassId.Name.
-
Fjärralternativ
Alternativ |
Beskrivning |
|---|---|
|
Hämtar Om inmatningen inte matchar med befintlig fältuppsättning returnerar tjänsten ett fel - "Det specificerade fältuppsättningsnamnet <fieldsetName> finns inte." Om användaren inte specificerar ett värde använder tjänsten standardfältuppsättningen - |
|
Hämtar Om inmatningen inte matchar med befintlig fältuppsättning returnerar tjänsten ett fel - "Det specificerade fältuppsättningsnamnet <planFieldsetName> finns inte." Om användaren inte anger ett värde returnerar tjänsten alla |
|
Boolesk Om Standardvärdet är |
Indata-JSON
Här är exempel-JSON för indata:
{
"fieldsetName": "memberFields",
"withPlans": true,
"planFieldsetName": "planFields"
}JSON för utdata
Tjänsten returnerar en lista över alla fältens API-namn som ingår i fältuppsättningens myFieldsetName i objektet GroupCensusMember. Om withPlans är sant inkluderar utdata även fältens API-namn som är en del av fältuppsättningens myPlanFieldsetName i objektet GroupCensusMemberPlan.
Sidhuvuden består av en lista över fältens API-namn, fältetiketter, fältdatatyp och fält-CSV-sidhuvud för alla fält som hämtas av tjänsten.
Tjänsten returnerar en JSON-utdata formaterad enligt detta exempel:
{
"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"
}
]
}
]
}
]
}
