Você está aqui:
InsCensusServiceStd:getFields
Use esse serviço para recuperar definições de campo e nomes de API de campo para membros do censo de grupo e planos de membro do censo de grupo.
Classe: InsCensusServiceStd
Método: getFields
Como funciona
- O serviço recupera a lista de campos de
GroupCensusMemberque fazem parte do conjunto de campos passado no parâmetro de entradafieldsetName. -
Se o parâmetro
withPlansfor verdadeiro, o serviço também recuperará a lista de campos deGroupCensusMemberPlan. -
A lista de definições de campo (tipos de dados de campo, rótulos de campo, nomes de API de campo e cabeçalhos de campo .csv) é combinada para formar o
headers.-
Se
GroupClassIdestiver incluído na lista de campos recuperados, o serviço adicionará um nó sob os cabeçalhos -GroupClassId.Name.
-
-
A lista de nomes de API de campo é combinada para formar o nó JSON.
-
Se
GroupClassIdestiver incluído na lista recuperada de campos, o serviço adicionará um nó sob os campos -GroupClassId.Name.
-
Opções remotas
Opção |
Descrição |
|---|---|
|
Recupera campos de Se a entrada não corresponder ao conjunto de campos existente, o serviço retornará um erro: "O nome do conjunto de campos especificado <fieldsetName> não existe". Se o usuário não especificar um valor, o serviço usará o conjunto de campos padrão – |
|
Recupera campos de Se a entrada não corresponder ao conjunto de campos existente, o serviço retornará um erro: "O nome do conjunto de campos <planFieldsetName> especificado não existe". Se o usuário não especificar um valor, o serviço retornará todos os campos de |
|
Booleano Se O valor-padrão é |
JSON de entrada
Aqui está o JSON de entrada de exemplo:
{
"fieldsetName": "memberFields",
"withPlans": true,
"planFieldsetName": "planFields"
}JSON de saída
O serviço retorna uma lista de todos os nomes de API de campo que fazem parte do conjunto de campos myFieldsetName no objeto GroupCensusMember. Se o parâmetro withPlans for verdadeiro, a saída também incluirá nomes de API de campo que fazem parte do conjunto de campos myPlanFieldsetName no objeto GroupCensusMemberPlan.
Os cabeçalhos consistem em uma lista de nomes de API de campo, rótulos de campo, tipo de dados de campo e cabeçalho CSV de campo para todos os campos recuperados pelo serviço.
O serviço retorna um JSON de saída formatado conforme este exemplo:
{
"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"
}
]
}
]
}
]
}
