Вы находитесь здесь:
InsCensusServiceStd:getFields
Используйте эту службу для извлечения определений полей и API-имен полей для участников групповой переписи и планов участников групповой переписи.
Класс: InsCensusServiceStd
Метод: getFields
Принцип работы
- Служба извлекает список полей
GroupCensusMember, входящих в набор полей, переданный вfieldsetNameпараметра ввода. -
Если параметр
withPlansявляется истинным, служба также извлекает список полейGroupCensusMemberPlan. -
Список определений полей (типы данных полей, метки полей, API-имена полей и заголовки полей .csv) объединен в
headers.-
Если
GroupClassIdдобавлен в извлеченный список полей, служба добавляет узел под заголовками -GroupClassId.Name.
-
-
Список API-имен полей объединен в узел JSON.
-
Если
GroupClassIdдобавлен в извлеченный список полей, служба добавляет узел под полями -GroupClassId.Name.
-
Удаленные параметры
Параметр |
Описание |
|---|---|
|
Извлекает поля Если вводные данные не соответствуют текущему набору полей, служба возвращает ошибку - "Указанное имя набора полей <fieldsetName> не существует". Если пользователь не указывает значение, служба использует стандартный набор полей - |
|
Извлекает поля Если вводные данные не соответствуют текущему набору полей, служба возвращает ошибку - "Указанное имя набора полей <planFieldsetName> не существует". Если пользователь не указывает значение, служба возвращает все поля |
|
Логическое При Значение по умолчанию: |
JSON ввода
Ниже указан пример ввода JSON:
{
"fieldsetName": "memberFields",
"withPlans": true,
"planFieldsetName": "planFields"
}Вывод JSON
Служба возвращает список всех API-имен полей, являющихся частью myFieldsetName набора полей в объекте GroupCensusMember. Если параметр withPlans является истинным, вывод также содержит имена API поля, являющиеся частью myPlanFieldsetName набора полей в объекте GroupCensusMemberPlan.
Заголовки состоят из списка 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"
}
]
}
]
}
]
}
