Genesis Foods GraphQL API Reference
Welcome to the Genesis Foods GraphQL API Reference! This reference includes the complete set of GraphQL types, queries, mutations and their parameters for working with Genesis Foods.
Learn how to authenticate to the API and common use cases in the Getting Started Guide.
Trustwell Support: https://trustwell.com/support
API Endpoints
https://api.trustwell.com/genesisHeaders
# Your API token from the dashboard. Must be included in all API calls.
X-API-KEY: <YOUR_TOKEN_HERE>Queries
allergens
Response
Returns an AllergenQuery
Example
Query
query allergens {
allergens {
get {
...AllergenPayloadFragment
}
getAllStandard {
...AllergenListPayloadFragment
}
}
}
Response
{
"data": {
"allergens": {
"get": AllergenPayload,
"getAllStandard": AllergenListPayload
}
}
}
analysis
Response
Returns an AnalysisQuery
Example
Query
query analysis {
analysis {
calculateBrix {
... on BrixPayload {
...BrixPayloadFragment
}
... on CalculateSpecificGravityException {
...CalculateSpecificGravityExceptionFragment
}
... on BrixArgumentOutOfRangeException {
...BrixArgumentOutOfRangeExceptionFragment
}
}
getAnalysis {
...AnalysisPayloadFragment
}
calculateNCCAnalysis {
...CalculateNCCAnalysisPayloadFragment
}
calculateAminoAcidScores {
...AminoAcidScoresPayloadFragment
}
}
}
Response
{
"data": {
"analysis": {
"calculateBrix": BrixPayload,
"getAnalysis": AnalysisPayload,
"calculateNCCAnalysis": CalculateNCCAnalysisPayload,
"calculateAminoAcidScores": AminoAcidScoresPayload
}
}
}
audits
Response
Returns an AuditQuery
Example
Query
query audits {
audits {
get {
...AuditListPayloadFragment
}
}
}
Response
{"data": {"audits": {"get": AuditListPayload}}}
customFields
Response
Returns a CustomFieldsQuery
Example
Query
query customFields {
customFields {
getAll {
...PaginatedCustomFieldListPayloadFragment
}
getCustomFieldsUsedInFood {
...CustomFieldListPayloadFragment
}
}
}
Response
{
"data": {
"customFields": {
"getAll": PaginatedCustomFieldListPayload,
"getCustomFieldsUsedInFood": CustomFieldListPayload
}
}
}
documents
Response
Returns a DocumentQuery
Example
Query
query documents {
documents {
get {
...DocumentPayloadFragment
}
search {
...PaginatedDocumentSearchResultPayloadFragment
}
recents {
...PaginatedDocumentSearchResultPayloadFragment
}
active {
...ActiveDocumentsPayloadFragment
}
getStoredDocuments {
...PaginatedDocumentEntitiesPayloadFragment
}
getPointInTimeId
bulkSearch {
...BulkSearchPayloadFragment
}
}
}
Response
{
"data": {
"documents": {
"get": DocumentPayload,
"search": PaginatedDocumentSearchResultPayload,
"recents": PaginatedDocumentSearchResultPayload,
"active": ActiveDocumentsPayload,
"getStoredDocuments": PaginatedDocumentEntitiesPayload,
"getPointInTimeId": "abc123",
"bulkSearch": BulkSearchPayload
}
}
}
foodAttributes
Response
Returns a FoodAttributeQuery
Example
Query
query foodAttributes {
foodAttributes {
get {
...FoodAttributePayloadFragment
}
getStandard {
...PaginatedFoodAttributeListPayloadFragment
}
getUserAdded {
...PaginatedFoodAttributeListPayloadFragment
}
}
}
Response
{
"data": {
"foodAttributes": {
"get": FoodAttributePayload,
"getStandard": PaginatedFoodAttributeListPayload,
"getUserAdded": PaginatedFoodAttributeListPayload
}
}
}
foods
Response
Returns a FoodQuery
Example
Query
query foods {
foods {
recentFoods {
...PaginatedFoodSearchResultPayloadFragment
}
search {
...PaginatedFoodSearchResultPayloadFragment
}
get {
...FoodPayloadFragment
}
getNutrientAnalysis {
...NutrientAnalysisPayloadFragment
}
whereUsed {
...GetWhereUsedPayloadFragment
}
}
}
Response
{
"data": {
"foods": {
"recentFoods": PaginatedFoodSearchResultPayload,
"search": PaginatedFoodSearchResultPayload,
"get": FoodPayload,
"getNutrientAnalysis": NutrientAnalysisPayload,
"whereUsed": GetWhereUsedPayload
}
}
}
labels
Response
Returns a LabelQuery
Example
Query
query labels {
labels {
getLabel {
...LabelPayloadFragment
}
getLabelsForFood {
...PaginatedLabelListPayloadFragment
}
recentLabels {
...PaginatedLabelSearchResultPayloadFragment
}
search {
...PaginatedLabelSearchResultPayloadFragment
}
getLabelImage
}
}
Response
{
"data": {
"labels": {
"getLabel": LabelPayload,
"getLabelsForFood": PaginatedLabelListPayload,
"recentLabels": PaginatedLabelSearchResultPayload,
"search": PaginatedLabelSearchResultPayload,
"getLabelImage": "abc123"
}
}
}
nutrients
Response
Returns a NutrientQuery
Example
Query
query nutrients {
nutrients {
getStandard {
...NutrientListPayloadFragment
}
getUserAdded {
...PaginatedNutrientListPayloadFragment
}
getCustomNutrientsUsedInFood {
...NutrientListPayloadFragment
}
getUserAddedNutrientsInUse {
...NutrientListPayloadFragment
}
}
}
Response
{
"data": {
"nutrients": {
"getStandard": NutrientListPayload,
"getUserAdded": PaginatedNutrientListPayload,
"getCustomNutrientsUsedInFood": NutrientListPayload,
"getUserAddedNutrientsInUse": NutrientListPayload
}
}
}
options
Response
Returns a UserOptionsQuery
Example
Query
query options {
options {
getUserOptions {
...UserOptionsPayloadFragment
}
getNutrientsToView {
...NutrientsToViewPayloadFragment
}
}
}
Response
{
"data": {
"options": {
"getUserOptions": UserOptionsPayload,
"getNutrientsToView": NutrientsToViewPayload
}
}
}
products
Response
Returns a ProductQuery
Example
Query
query products {
products {
getStandard {
...ProductListPayloadFragment
}
getUserAdded {
...PaginatedProductListPayloadFragment
}
getUserAddedProductsInUse {
...ProductListPayloadFragment
}
}
}
Response
{
"data": {
"products": {
"getStandard": ProductListPayload,
"getUserAdded": PaginatedProductListPayload,
"getUserAddedProductsInUse": ProductListPayload
}
}
}
regulations
Response
Returns a RegulationQuery
Example
Query
query regulations {
regulations {
getAuthorities {
...PaginatedAuthorityListPayloadFragment
}
getRegulations {
...PaginatedRegulationListPayloadFragment
}
getRecommendationProfiles {
...PaginatedRecommendationProfileListPayloadFragment
}
getRecommendations {
...PaginatedRecommendationListPayloadFragment
}
getNutrientContentClaims {
...PaginatedNutrientContentClaimsPayloadFragment
}
getDesignations {
...RegulatoryDesignationsPayloadFragment
}
getRegulation {
...RegulationPayloadFragment
}
}
}
Response
{
"data": {
"regulations": {
"getAuthorities": PaginatedAuthorityListPayload,
"getRegulations": PaginatedRegulationListPayload,
"getRecommendationProfiles": PaginatedRecommendationProfileListPayload,
"getRecommendations": PaginatedRecommendationListPayload,
"getNutrientContentClaims": PaginatedNutrientContentClaimsPayload,
"getDesignations": RegulatoryDesignationsPayload,
"getRegulation": RegulationPayload
}
}
}
suppliers
Response
Returns a SupplierQuery
Example
Query
query suppliers {
suppliers {
getStandard {
...SupplierListPayloadFragment
}
getUserAdded {
...PaginatedSupplierListPayloadFragment
}
getUserAddedSuppliersInUse {
...SupplierListPayloadFragment
}
}
}
Response
{
"data": {
"suppliers": {
"getStandard": SupplierListPayload,
"getUserAdded": PaginatedSupplierListPayload,
"getUserAddedSuppliersInUse": SupplierListPayload
}
}
}
units
Response
Returns a UnitQuery
Example
Query
query units {
units {
getStandard {
...UnitListPayloadFragment
}
}
}
Response
{"data": {"units": {"getStandard": UnitListPayload}}}
Mutations
documents
Response
Returns a DocumentMutation
Example
Query
mutation documents {
documents {
setName {
...DocumentPayloadFragment
}
setNotes {
...DocumentPayloadFragment
}
setTags {
...DocumentPayloadFragment
}
approve {
...DocumentPayloadFragment
}
setCustomFields {
...DocumentPayloadFragment
}
reindexDocument {
...DocumentPayloadFragment
}
deleteDocumentIndex {
...DocumentPayloadFragment
}
deleteDocumentEntity {
... on DeletedDocumentEntityPayload {
...DeletedDocumentEntityPayloadFragment
}
... on DocumentNotFoundException {
...DocumentNotFoundExceptionFragment
}
... on ApprovedDocumentEntityCantBeDeletedException {
...ApprovedDocumentEntityCantBeDeletedExceptionFragment
}
... on UsedDraftDocumentEntityCantBeDeletedException {
...UsedDraftDocumentEntityCantBeDeletedExceptionFragment
}
}
toggleArchive {
...DocumentPayloadFragment
}
}
}
Response
{
"data": {
"documents": {
"setName": DocumentPayload,
"setNotes": DocumentPayload,
"setTags": DocumentPayload,
"approve": DocumentPayload,
"setCustomFields": DocumentPayload,
"reindexDocument": DocumentPayload,
"deleteDocumentIndex": DocumentPayload,
"deleteDocumentEntity": DeletedDocumentEntityPayload,
"toggleArchive": DocumentPayload
}
}
}
foods
Response
Returns a FoodMutation
Example
Query
mutation foods {
foods {
setName {
...FoodPayloadFragment
}
addAlias {
...FoodPayloadFragment
}
deleteAlias {
...FoodPayloadFragment
}
editAlias {
...FoodPayloadFragment
}
setAliases {
...FoodPayloadFragment
}
setAmount {
...FoodPayloadFragment
}
setNotes {
...FoodPayloadFragment
}
setNutrientValue {
...FoodPayloadFragment
}
setNutrientValues {
...FoodPayloadFragment
}
create {
...FoodPayloadFragment
}
addTag {
...FoodPayloadFragment
}
removeTag {
...FoodPayloadFragment
}
setYieldKey {
...FoodPayloadFragment
}
setTags {
...FoodPayloadFragment
}
addFoodItem {
...FoodPayloadFragment
}
editFoodItemAmount {
...FoodPayloadFragment
}
editFoodItemNote {
...FoodPayloadFragment
}
deleteFoodItem {
...FoodPayloadFragment
}
setFoodItems {
...FoodPayloadFragment
}
approveFood {
...FoodPayloadFragment
}
createNewVersion {
...FoodPayloadFragment
}
setFoodCostAmount {
...FoodPayloadFragment
}
setPreparationTime {
...RecipePayloadFragment
}
setCookTime {
...RecipePayloadFragment
}
setCookTemperature {
...RecipePayloadFragment
}
setCookMethod {
...RecipePayloadFragment
}
setPanSize {
...RecipePayloadFragment
}
setInstructions {
...RecipePayloadFragment
}
removeImage {
...FoodPayloadFragment
}
addConversion {
...FoodPayloadFragment
}
updateConversion {
...FoodPayloadFragment
}
deleteConversion {
...FoodPayloadFragment
}
setConversions {
...FoodPayloadFragment
}
setSpecificGravity {
...RecipePayloadFragment
}
setSubIngredients {
...IngredientPayloadFragment
}
setNumberOfServings {
...RecipePayloadFragment
}
setServingSize {
...RecipePayloadFragment
}
setAllergens {
...FoodPayloadFragment
}
setAuthorities {
...FoodPayloadFragment
}
setFoodAttributes {
...FoodPayloadFragment
}
setProduct {
...FoodPayloadFragment
}
setSupplier {
...FoodPayloadFragment
}
setCustomFields {
...FoodPayloadFragment
}
createOrUpdateNccSelectionDetails {
...RecipePayloadFragment
}
setSelectedNutrientContentClaims {
...RecipePayloadFragment
}
setGlycemicIndex {
...FoodPayloadFragment
}
setIngredientDesignations {
...IngredientPayloadFragment
}
createCopy {
...FoodPayloadFragment
}
setPDCAAS {
...FoodPayloadFragment
}
setPER {
...FoodPayloadFragment
}
setGovernmentCode {
...IngredientPayloadFragment
}
setLegacyKey {
...FoodPayloadFragment
}
setCreated {
...FoodPayloadFragment
}
setModified {
...FoodPayloadFragment
}
setAllergensVerified {
...FoodPayloadFragment
}
setAllergenStatements {
...FoodPayloadFragment
}
setYields {
...FoodPayloadFragment
}
setExcludeCost {
...RecipePayloadFragment
}
setDisplayNutrientsToView {
...FoodPayloadFragment
}
setPalHeaders {
...RecipePayloadFragment
}
setRegulationSetting {
...FoodPayloadFragment
}
setRegulationSettings {
...FoodPayloadFragment
}
setMexico2020PackagingSymbols {
...RecipePayloadFragment
}
setFormulationState {
...RecipePayloadFragment
}
setCustomIngredientStatement {
...RecipePayloadFragment
}
}
}
Response
{
"data": {
"foods": {
"setName": FoodPayload,
"addAlias": FoodPayload,
"deleteAlias": FoodPayload,
"editAlias": FoodPayload,
"setAliases": FoodPayload,
"setAmount": FoodPayload,
"setNotes": FoodPayload,
"setNutrientValue": FoodPayload,
"setNutrientValues": FoodPayload,
"create": FoodPayload,
"addTag": FoodPayload,
"removeTag": FoodPayload,
"setYieldKey": FoodPayload,
"setTags": FoodPayload,
"addFoodItem": FoodPayload,
"editFoodItemAmount": FoodPayload,
"editFoodItemNote": FoodPayload,
"deleteFoodItem": FoodPayload,
"setFoodItems": FoodPayload,
"approveFood": FoodPayload,
"createNewVersion": FoodPayload,
"setFoodCostAmount": FoodPayload,
"setPreparationTime": RecipePayload,
"setCookTime": RecipePayload,
"setCookTemperature": RecipePayload,
"setCookMethod": RecipePayload,
"setPanSize": RecipePayload,
"setInstructions": RecipePayload,
"removeImage": FoodPayload,
"addConversion": FoodPayload,
"updateConversion": FoodPayload,
"deleteConversion": FoodPayload,
"setConversions": FoodPayload,
"setSpecificGravity": RecipePayload,
"setSubIngredients": IngredientPayload,
"setNumberOfServings": RecipePayload,
"setServingSize": RecipePayload,
"setAllergens": FoodPayload,
"setAuthorities": FoodPayload,
"setFoodAttributes": FoodPayload,
"setProduct": FoodPayload,
"setSupplier": FoodPayload,
"setCustomFields": FoodPayload,
"createOrUpdateNccSelectionDetails": RecipePayload,
"setSelectedNutrientContentClaims": RecipePayload,
"setGlycemicIndex": FoodPayload,
"setIngredientDesignations": IngredientPayload,
"createCopy": FoodPayload,
"setPDCAAS": FoodPayload,
"setPER": FoodPayload,
"setGovernmentCode": IngredientPayload,
"setLegacyKey": FoodPayload,
"setCreated": FoodPayload,
"setModified": FoodPayload,
"setAllergensVerified": FoodPayload,
"setAllergenStatements": FoodPayload,
"setYields": FoodPayload,
"setExcludeCost": RecipePayload,
"setDisplayNutrientsToView": FoodPayload,
"setPalHeaders": RecipePayload,
"setRegulationSetting": FoodPayload,
"setRegulationSettings": FoodPayload,
"setMexico2020PackagingSymbols": RecipePayload,
"setFormulationState": RecipePayload,
"setCustomIngredientStatement": RecipePayload
}
}
}
label
Response
Returns a LabelMutation
Example
Query
mutation label {
label {
setLabelName {
...LabelPayloadFragment
}
createCopy {
...LabelPayloadFragment
}
setRegulation {
...LabelPayloadFragment
}
unitedStates2016 {
...UnitedStates2016MutationFragment
}
canada2016 {
...Canada2016MutationFragment
}
europeanUnion2011 {
...EuropeanUnion2011MutationFragment
}
australiaNewZealand2016 {
...AustraliaNewZealand2016MutationFragment
}
}
}
Response
{
"data": {
"label": {
"setLabelName": LabelPayload,
"createCopy": LabelPayload,
"setRegulation": LabelPayload,
"unitedStates2016": UnitedStates2016Mutation,
"canada2016": Canada2016Mutation,
"europeanUnion2011": EuropeanUnion2011Mutation,
"australiaNewZealand2016": AustraliaNewZealand2016Mutation
}
}
}
Types
ActiveDocumentResult
Description
A search result from searching for document activity.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the result. |
name - String!
|
The name of the result. |
modified - DateTimeOffset!
|
Example
{
"id": 4,
"name": "abc123",
"modified": DateTimeOffset
}
ActiveDocumentsPayload
Fields
| Field Name | Description |
|---|---|
results - [ActiveDocumentResult!]!
|
Example
{"results": [ActiveDocumentResult]}
AddAliasInput
AddFoodConversionInput
Fields
| Input Field | Description |
|---|---|
foodId - ID!
|
|
from - AmountInput
|
|
to - AmountInput
|
Example
{}
AddFoodItemInput
Fields
| Input Field | Description |
|---|---|
aggregateFoodId - ID!
|
|
addedFoodId - ID!
|
|
addedFoodAmount - AmountInput
|
|
note - String
|
Example
{}
AddTagToFoodInput
Alias
AliasInput
Allergen
Description
An allergen that can be associated with a food item.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the allergen. |
name - String!
|
The name of the allergen. |
hasChildren - Boolean!
|
Whether the allergen has children. |
parentAllergen - Allergen
|
The parent allergen. |
regulation - Regulation
|
The regulation for the allergen. |
aliases - [Alias!]!
|
The aliases for the allergen. |
Example
{
"id": 4,
"name": "xyz789",
"hasChildren": false,
"parentAllergen": Allergen,
"regulation": Regulation,
"aliases": [Alias]
}
AllergenListPayload
Fields
| Field Name | Description |
|---|---|
allergens - [Allergen]
|
Example
{"allergens": [Allergen]}
AllergenOccurrence
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
AllergenPayload
Fields
| Field Name | Description |
|---|---|
allergen - Allergen
|
Example
{"allergen": Allergen}
AllergenQuery
Description
Queries for allergens.
Fields
| Field Name | Description |
|---|---|
get - AllergenPayload
|
Get an allergen by ID. |
Arguments
|
|
getAllStandard - AllergenListPayload
|
Get all standard allergens. |
Example
{
"get": AllergenPayload,
"getAllStandard": AllergenListPayload
}
AllergenStatement
Description
An allergen statement that can be associated with a food item.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The unique identifier of the allergen statement. |
regulation - Regulation
|
The regulation for the allergen statement. |
translatedStatements - [TranslatedAllergenStatement]
|
The translated statements for the allergen statement. |
getStatements - [TranslatedStatement]
|
Gets the Allergen Statements for each language supported by the regulation.Example: Contains ... |
getVoluntaryStatements - [TranslatedStatement]
|
Gets Voluntary Allergen Statements for each language supported by the regulation.Example: May also contain ... |
Example
{
"id": 4,
"regulation": Regulation,
"translatedStatements": [TranslatedAllergenStatement],
"getStatements": [TranslatedStatement],
"getVoluntaryStatements": [TranslatedStatement]
}
AllergenStatementInput
Description
An allergen statement.
Fields
| Input Field | Description |
|---|---|
regulationId - ID!
|
The regulation identifier of the allergen statement. |
translatedStatements - [TranslatedAllergenStatementInput]
|
The translated statements of the allergen statement. |
Example
{}
AminoAcidScore
Fields
| Field Name | Description |
|---|---|
aminoAcid - StandardNutrients!
|
Enum of the main amino acid constituent for this score. |
aminoAcid2 - StandardNutrients
|
Enum of a secondary amino acid constituent of this score if available. |
actualRatio - Decimal!
|
The ratio of the weight of the amino acid to the total protein in the recipe. |
idealRatio - Decimal!
|
The ideal ratio of this amino acid to the total protein in the recipe. |
dataMissing - Boolean!
|
A boolean flag indicating that the data needed for this calculation was not available |
score - Decimal!
|
The ratio of the actual ratio to the ideal ratio of this amino acid. Actual Ratio/Ideal Ratio * 100 |
Example
{
"aminoAcid": "Calories",
"aminoAcid2": "Calories",
"actualRatio": Decimal,
"idealRatio": Decimal,
"dataMissing": false,
"score": Decimal
}
AminoAcidScoresPayload
Fields
| Field Name | Description |
|---|---|
aminoAcidScores - CalculatedAminoAcidScores!
|
Example
{"aminoAcidScores": CalculatedAminoAcidScores}
Amount
AmountCost
AmountInput
Analysis
Description
An analysis of a food item.
Fields
| Field Name | Description |
|---|---|
analysisType - AnalysisType
|
The type of the analysis. |
amountAnalyzed - Amount
|
The amount of the food item that was analyzed. |
weight - Amount
|
The weight of the food item. |
nutrientInfos - [NutrientInfo]
|
The nutrient information for the analysis. |
parentAnalysis - Analysis
|
The parent analysis of the analysis. |
percentDailyValues - [NutrientPercent]
|
Returns the Calculated Percent Daily Values for the Analysis. If the Analysis is Net/Gross a RecommendationProfileId must be provided. |
Arguments
|
|
Example
{
"analysisType": "Unspecified",
"amountAnalyzed": Amount,
"weight": Amount,
"nutrientInfos": [NutrientInfo],
"parentAnalysis": Analysis,
"percentDailyValues": [NutrientPercent]
}
AnalysisInput
Description
An input object for Analysis.
Fields
| Input Field | Description |
|---|---|
analysisType - AnalysisType
|
The type of Analysis you want returned in the response. |
amount - AmountInput
|
The amount the Analysis will be performed at. |
labelId - ID
|
Required for a LabelRounded Analysis to be calculated. Will be used to determine rounding rules and % DV values |
weightUnitId - ID
|
Specifies the unit that is returned by Weight. If you ask for an Analysis at 1 Serving, you can specify WeightUnitId to be Grams so Weight is returned in grams. |
Example
{}
AnalysisOverride
Description
An override for a nutrient in a food item.
Fields
| Field Name | Description |
|---|---|
amount - Amount
|
The amount of the override. |
overrides - [NutrientQuantity]
|
The nutrient overrides for the analysis override. |
Example
{
"amount": Amount,
"overrides": [NutrientQuantity]
}
AnalysisPayload
Fields
| Field Name | Description |
|---|---|
analysis - Analysis
|
Example
{"analysis": Analysis}
AnalysisQuery
Description
Queries for analyses.
Fields
| Field Name | Description |
|---|---|
calculateBrix - BrixPayloadUnion
|
Calculate Brix from specific gravity. |
Arguments
|
|
getAnalysis - AnalysisPayload
|
Get an analysis by ID. |
Arguments
|
|
calculateNCCAnalysis - CalculateNCCAnalysisPayload
|
Calculate NCC Analysis for a food item. |
Arguments
|
|
calculateAminoAcidScores - AminoAcidScoresPayload
|
Calculates Amino Acid scores for protein quality assessment |
Arguments
|
|
Example
{
"calculateBrix": BrixPayload,
"getAnalysis": AnalysisPayload,
"calculateNCCAnalysis": CalculateNCCAnalysisPayload,
"calculateAminoAcidScores": AminoAcidScoresPayload
}
AnalysisType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
ApproveDocumentInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
Example
{}
ApproveFoodInput
Fields
| Input Field | Description |
|---|---|
foodId - ID!
|
Example
{}
ApprovedDocumentEntityCantBeDeletedException
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "xyz789"}
ArchiveFilter
Values
| Enum Value | Description |
|---|---|
|
|
'All' returns both Archived and Unarchived documents in search results |
|
|
'Unarchived' returns only documents that have not been archived in search results |
|
|
'Archived' returns only documents that have been archived in search results |
Example
{}
AttachmentLinkInterface
Description
A link to an attachment.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the attachment link. |
attachmentLinkType - AttachmentLinkType
|
The type of the attachment link. |
Possible Types
| AttachmentLinkInterface Types |
|---|
Example
{
"id": "4",
"attachmentLinkType": "FoodAttribute"
}
AttachmentLinkType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
Audit
Description
An audit record for a food item.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The unique identifier of the audit record. |
item - String
|
The item that was audited. |
modifiedBy - EshaUser
|
The user that modified the item. |
oldValue - String
|
The old value of the item. |
newValue - String
|
The new value of the item. |
category - String
|
The category of the audit record. |
createdOn - DateTimeOffset
|
The date and time the audit record was created. |
version - Version!
|
The version of the item that was audited. |
Example
{
"id": "4",
"item": "abc123",
"modifiedBy": EshaUser,
"oldValue": "abc123",
"newValue": "abc123",
"category": "xyz789",
"createdOn": DateTimeOffset,
"version": Version
}
AuditListPayload
Fields
| Field Name | Description |
|---|---|
audits - [Audit]
|
Example
{"audits": [Audit]}
AuditQuery
Description
Queries for audits.
Fields
| Field Name | Description |
|---|---|
get - AuditListPayload
|
Get an audit by ID. |
Arguments
|
|
Example
{"get": AuditListPayload}
AustraliaNewZealand2016AnalyzedData
Types
| Union Types |
|---|
Example
{}
AustraliaNewZealand2016CalculationMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
AustraliaNewZealand2016LabelDetails
Fields
| Field Name | Description |
|---|---|
labelOptions - AustraliaNewZealand2016LabelOptions!
|
The Label Options that are set on the Label. |
analyzedData - AustraliaNewZealand2016AnalyzedData
|
Information for the Label that is determined by the Food(s) added to it. Will return null if the number of items is not correct for the given label. |
Example
{
"labelOptions": AustraliaNewZealand2016LabelOptions,
"analyzedData": AustraliaNewZealand2016StandardAnalyzedData
}
AustraliaNewZealand2016LabelOptions
Fields
| Field Name | Description |
|---|---|
servingsPerPackage - String
|
The Servings Per Package that will appear on the label |
unitOfMeasure - AustraliaNewZealand2016UnitOfMeasure!
|
Whether the label is in grams or mL |
showPercentageDailyIntakeColumn - Boolean!
|
Shows the percentage daily intake column and footnote |
calculationMethod - AustraliaNewZealand2016CalculationMethod!
|
The calculationMethodForEnergy |
displayLessThan40Kj - Boolean!
|
If value is < 40 kJ, display as "Less than 40 kJ" |
displayEnergyAsKjAndCal - Boolean!
|
Displays the energy as kJ and Cal |
displayProtienAsLessThan1g - Boolean!
|
If Protien value is < 1 g, display as "Less than 1 g" |
displayFatAsLessThan1g - Boolean!
|
If Fat value is < 1 g, display as "Less than 1 g" |
displaySatFatAsLessThan1g - Boolean!
|
If Saturated Fat value is < 1 g, display as "Less than 1 g" |
displayCarbAvailableAsLessThan1g - Boolean!
|
If Carbohydrates Available value is < 1 g, display as "Less than 1 g" |
displaySugarsAsLessThan1g - Boolean!
|
If Sugars value is < 1 g, display as "Less than 1 g" |
displaySodiumAsLessThan5mg - Boolean!
|
If Sodium value is < 5 mg, display as "Less than 5 mg" |
Example
{
"servingsPerPackage": "abc123",
"unitOfMeasure": "Gram",
"showPercentageDailyIntakeColumn": false,
"calculationMethod": "TotalOfAllIngredients",
"displayLessThan40Kj": true,
"displayEnergyAsKjAndCal": true,
"displayProtienAsLessThan1g": true,
"displayFatAsLessThan1g": false,
"displaySatFatAsLessThan1g": false,
"displayCarbAvailableAsLessThan1g": false,
"displaySugarsAsLessThan1g": false,
"displaySodiumAsLessThan5mg": false
}
AustraliaNewZealand2016LabelOptionsInput
Fields
| Input Field | Description |
|---|---|
servingsPerPackage - String!
|
The Servings Per Package that will appear on the label. Default = "" |
unitOfMeasure - AustraliaNewZealand2016UnitOfMeasure!
|
Whether the label is in grams or mL. Default = Gram |
showPercentageDailyIntakeColumn - Boolean!
|
Shows the percentage daily intake column and footnote. Default = false |
calculationMethod - AustraliaNewZealand2016CalculationMethod!
|
The calculationMethodForEnergy. Default = TotalOfAllIngredients |
displayLessThan40Kj - Boolean!
|
If value is < 40 kJ, display as "Less than 40 kJ". Default = false |
displayEnergyAsKjAndCal - Boolean!
|
Displays the energy as kJ and Cal. Default = false |
displayProtienAsLessThan1g - Boolean!
|
If Protien value is < 1 g, display as "Less than 1 g". Default = false |
displayFatAsLessThan1g - Boolean!
|
If Fat value is < 1 g, display as "Less than 1 g". Default = false |
displaySatFatAsLessThan1g - Boolean!
|
If Saturated Fat value is < 1 g, display as "Less than 1 g". Default = false |
displayCarbAvailableAsLessThan1g - Boolean!
|
If Carbohydrates Available value is < 1 g, display as "Less than 1 g". Default = false |
displaySugarsAsLessThan1g - Boolean!
|
If Sugars value is < 1 g, display as "Less than 1 g". Default = false |
displaySodiumAsLessThan5mg - Boolean!
|
If Sodium value is < 5 mg, display as "Less than 5 mg". Default = false |
Example
{}
AustraliaNewZealand2016Mutation
Fields
| Field Name | Description |
|---|---|
create - LabelPayload
|
Creates an Australia/New Zealand 2016 Label. |
Arguments |
|
setOptions - LabelPayload
|
Sets the Label Options on an Australia/New Zealand 2016 Label. |
Arguments |
|
setVoluntaryNutrients - LabelPayload
|
Sets the Voluntary Nutrients on an Australia/New Zealand 2016 Label. |
Arguments |
|
setLabelItem - LabelPayload
|
Sets the Label Item on a Label. All Foods are added at 1 Serving and can be edited with LabelOptions. This returns Label Options to default values. |
Arguments |
|
setVoluntaryCustomNutrients - LabelPayload
|
Sets custom nutrients on an Australia/New Zealand 2016 Label. |
Arguments |
|
Example
{
"create": LabelPayload,
"setOptions": LabelPayload,
"setVoluntaryNutrients": LabelPayload,
"setLabelItem": LabelPayload,
"setVoluntaryCustomNutrients": LabelPayload
}
AustraliaNewZealand2016StandardAnalyzedData
Fields
| Field Name | Description |
|---|---|
servingSize - String!
|
|
nutrientsPerServing - [LabelNutrient!]!
|
|
nutrientsPerQuantity - [LabelNutrient!]!
|
Example
{
"servingSize": "xyz789",
"nutrientsPerServing": [LabelNutrient],
"nutrientsPerQuantity": [LabelNutrient]
}
AustraliaNewZealand2016UnitOfMeasure
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
AustraliaNewZealand2016VoluntaryNutrients
Description
The Voluntary Nutrients available for Australia/New Zealand 2016.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
Authority
Description
An authority that regulates food data.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the authority. |
name - String!
|
The name of the authority. |
iso3166Numeric - Int
|
The ISO 3166 numeric code of the authority. |
iso3166Alpha2 - String!
|
The ISO 3166 alpha-2 code of the authority. |
iso3166Alpha3 - String!
|
The ISO 3166 alpha-3 code of the authority. |
regulations - [Regulation]
|
The regulations for the authority. |
Example
{
"id": "4",
"name": "xyz789",
"iso3166Numeric": 123,
"iso3166Alpha2": "abc123",
"iso3166Alpha3": "abc123",
"regulations": [Regulation]
}
Boolean
Description
The 'Boolean' scalar type represents 'true' or 'false' .
Example
{}
BrixArgumentOutOfRangeException
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
BrixPayload
Fields
| Field Name | Description |
|---|---|
value - Float!
|
Example
{"value": 123.45}
BrixPayloadUnion
Types
| Union Types |
|---|
Example
{}
BulkSearchInput
Fields
| Input Field | Description |
|---|---|
pointInTimeId - String!
|
|
cursor - String!
|
|
pageSize - Int!
|
|
documentTypes - [DocumentType!]!
|
|
archiveFilter - ArchiveFilter!
|
|
documentStatusFilter - DocumentStatusFilter!
|
Example
{}
BulkSearchPayload
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
documents - [DocumentSearchResultInterface!]!
|
Example
{
"cursor": "abc123",
"documents": [DocumentSearchResultInterface]
}
CalculateBrixInput
Fields
| Input Field | Description |
|---|---|
specificGravity - Float!
|
Example
{}
CalculateNCCAnalysisInput
CalculateNCCAnalysisPayload
Fields
| Field Name | Description |
|---|---|
perRaccAnalysis - [NccAnalysis]
|
|
perRaccReferenceAnalysis - [NccAnalysis]
|
|
perServingAnalysis - [NccAnalysis]
|
|
per50GramAnalysis - [NccAnalysis]
|
Example
{
"perRaccAnalysis": [NccAnalysis],
"perRaccReferenceAnalysis": [NccAnalysis],
"perServingAnalysis": [NccAnalysis],
"per50GramAnalysis": [NccAnalysis]
}
CalculateSpecificGravityException
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "xyz789"}
CalculatedAminoAcidScores
Fields
| Field Name | Description |
|---|---|
proteinDataMissing - Boolean!
|
A boolean indicating if the protein amount was missing for this calculation. Would result in an empty scores collection if true. |
scores - [AminoAcidScore]!
|
The collection of AminoAcidScores for the regulated collection of amino acids used to assess protein quality |
limitingAminoAcids - [AminoAcidScore]!
|
A collection of Amino Acid Scores for amino acids preventing the the protein from meeting ideal ratios. |
Example
{
"proteinDataMissing": false,
"scores": [AminoAcidScore],
"limitingAminoAcids": [AminoAcidScore]
}
CalculatedSpecificGravityPayload
Fields
| Field Name | Description |
|---|---|
value - Float!
|
Example
{"value": 987.65}
CalculatedSpecificGravityPayloadUnion
Types
| Union Types |
|---|
Example
{}
CalculatedStrategy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
CalculationMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
Canada2016AnalyzedData
Types
| Union Types |
|---|
Example
{}
Canada2016CaloriesCalculationMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
Canada2016DecimalSeparator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
Canada2016DualAnalyzedData
Fields
| Field Name | Description |
|---|---|
column1Amount - String!
|
|
column1Nutrients - [LabelNutrient!]!
|
|
column2Amount - String!
|
|
column2Nutrients - [LabelNutrient!]!
|
|
addedFoodAddsFootnote - String!
|
Example
{
"column1Amount": "xyz789",
"column1Nutrients": [LabelNutrient],
"column2Amount": "abc123",
"column2Nutrients": [LabelNutrient],
"addedFoodAddsFootnote": "abc123"
}
Canada2016DualLabelOption
Fields
| Field Name | Description |
|---|---|
includeOptionalHMAddedFootnote - Boolean!
|
Adds the 'HM of the added food adds ...' footnote for the Dual Foods Requiring Preparation label. |
primaryPerHouseholdMeasure1 - String!
|
The primary language text that will appear over column 1 in the Dual labels. |
secondaryPerHouseholdMeasure1 - String!
|
The secondary language text that will appear over column 1 in the Dual labels. |
column1Quantity - Float!
|
The Quantity of Column 1 |
column1Unit - StandardUnits!
|
The Unit of Column 1 |
primaryPerHouseholdMeasure2 - String!
|
The primary language text that will appear over column 2 in the Dual labels. |
secondaryPerHouseholdMeasure2 - String!
|
The secondary language text that will appear over column 2 in the Dual labels. |
column2Quantity - Float!
|
The Quantity of Column 2 |
column2Unit - StandardUnits!
|
The Unit of Column 2 |
primaryPreparedServing - String!
|
The primary language text for the Prepared Serving that will appear below the Household Serving Size. |
secondaryPreparedServing - String!
|
The secondary language text for the Prepared Serving that will appear below the Household Serving Size. |
Example
{
"includeOptionalHMAddedFootnote": false,
"primaryPerHouseholdMeasure1": "xyz789",
"secondaryPerHouseholdMeasure1": "xyz789",
"column1Quantity": 987.65,
"column1Unit": "Teaspoon",
"primaryPerHouseholdMeasure2": "abc123",
"secondaryPerHouseholdMeasure2": "abc123",
"column2Quantity": 987.65,
"column2Unit": "Teaspoon",
"primaryPreparedServing": "abc123",
"secondaryPreparedServing": "xyz789"
}
Canada2016DualLabelOptionsInput
Fields
| Input Field | Description |
|---|---|
includeOptionalHMAddedFootnote - Boolean!
|
Adds the 'HM of the added food adds ...' footnote for the Dual Foods Requiring Preparation label. Default = false |
primaryPerHouseholdMeasure1 - String!
|
The primary language text that will appear over column 1 in the Dual labels. Default = "" |
secondaryPerHouseholdMeasure1 - String!
|
The secondary language text that will appear over column 1 in the Dual labels. Default = "" |
column1Quantity - Float!
|
The Quantity of Column 1. Default = 1 |
column1Unit - StandardUnits!
|
The Unit of Column 1. Default = Serving |
primaryPerHouseholdMeasure2 - String!
|
The primary language text that will appear over column 2 in the Dual labels. Default = "" |
secondaryPerHouseholdMeasure2 - String!
|
The secondary language text that will appear over column 2 in the Dual labels. Default = "" |
column2Quantity - Float!
|
The Quantity of Column 2. Default = 1 |
column2Unit - StandardUnits!
|
The Unit of Column 2. Default = Serving |
primaryPreparedServing - String!
|
The primary language text for the Prepared Serving that will appear below the Household Serving Size. Default = "" |
secondaryPreparedServing - String!
|
The secondary language text for the Prepared Serving that will appear below the Household Serving Size. Default = "" |
Example
{}
Canada2016LabelDetails
Fields
| Field Name | Description |
|---|---|
labelOptions - Canada2016LabelOptions!
|
The Label Options that are set on the Label. |
analyzedData - Canada2016AnalyzedData
|
Information for the Label that is determined by the Food(s) added to it. Will return null if the number of items is not correct for the given label. |
Example
{
"labelOptions": Canada2016LabelOptions,
"analyzedData": Canada2016StandardAnalyzedData
}
Canada2016LabelOptions
Fields
| Field Name | Description |
|---|---|
primaryLanguage - Canada2016PrimaryLanguage!
|
The Primary Language for the label |
secondaryLanguage - Canada2016SecondaryLanguage!
|
The Secondary Language for the label. Certain labels might set this automatically |
templateStyle - Canada2016TemplateStyle!
|
Template style for the label |
decimalSeperator - Canada2016DecimalSeparator!
|
The decimal separator |
useShortenedSimplifiedFootnote - Boolean!
|
Use shortened "not a significant source of other nutrients" in Simplified label |
primaryHouseholdServingSizeText - String!
|
The Household serving size for the Primary Language on the Label |
secondaryHouseholdServingSizeText - String!
|
The Household serving size for the Secondary Language on the Label |
primaryServingsPerContainerText - String!
|
The Servings per container that will appear for the Primary Language on the Label |
secondaryServingsPerContainerText - String!
|
The Servings per container that will appear for the Secondary Language on the Label |
showServingsPerContainerText - Boolean!
|
Show the servings per container text on the Label |
hideServingSizeAmount - Boolean!
|
Hides the Serving Size amount from appearing on the Label |
nutrientDataDisplayPer - Canada2016NutrientDisplay!
|
Displays nutrient values per gram or per ml |
caloriesCalculationMethod - Canada2016CaloriesCalculationMethod!
|
How calories are calculated and appear on the label |
caloriesWhenInsignificant - Canada2016WhenInsignificant!
|
How calories are handled when insignificant on the label |
caloriesUseRoundedValuesWith44927 - Boolean!
|
Use 44927 when rounding calories on the label |
fatWhenInsignificant - Canada2016WhenInsignificant!
|
How fat is handled when insignificant on the label |
fatUseUnroundedValuesWhenCalculatingPercentDv - Boolean!
|
Use unrounded values for fat when calculating percent daily value |
satFatWhenInsignificant - Canada2016WhenInsignificant!
|
How saturated fat is handled when insignificant on the label |
transFatWhenInsignificant - Canada2016WhenInsignificant!
|
How trans fat is handled when insignificant on the label |
totalDietaryFiberWhenInsignificantShow - Boolean!
|
Displays total dietary fiber when insignificant on the label |
totalDietaryFiberUseUnroundedValuesWhenCaluculatingPercentDv - Boolean!
|
Use unrounded values for total dietary fiber when calculating percent daily value |
totalSugarsWhenInsignificantShow - Boolean!
|
Displays total sugars when insignificant on the label |
totalSugarsUseUnroundedValuesWhenCalculatingPercentDv - Boolean!
|
Use unrounded values for total sugars when calculating percent daily value |
cholesterolWhenInsignificant - Canada2016WhenInsignificant!
|
How cholesterol is handled when insignificant on the label |
cholesterolHidePercentCholesterol - Boolean!
|
Hide percent cholesterol on the label |
cholesterolUseUnroundedValuesWhenCalculatingPercentDv - Boolean!
|
Use unrounded values for cholesterol when calculating percent daily value |
cholesterolWhenInsignificantShow - Boolean!
|
Displays cholesterol when insignificant on the label |
sodiumWhenInsignificant - Canada2016WhenInsignificant!
|
How sodium is handled when insignificant on the label |
sodiumWhenInsignificantShow - Boolean!
|
Displays sodium when insignificant on the label |
potassiumWhenInsignificant - Canada2016WhenInsignificant!
|
How potassium is handled when insignificant on the label |
potassiumWhenInsignificantShow - Boolean!
|
Displays potassium when insignificant on the label |
calciumWhenInsignificantShow - Boolean!
|
Displays calcium when insignificant on the label |
ironWhenInsignificantShow - Boolean!
|
Displays iron when insignificant on the label |
dualOptions - Canada2016DualLabelOption
|
Dual Label Options for Canada 2016 Dual Labels. Will not save and return null when the Label does not have 2 Foods added to it. |
Example
{
"primaryLanguage": "English",
"secondaryLanguage": "None",
"templateStyle": "Full",
"decimalSeperator": "Comma",
"useShortenedSimplifiedFootnote": false,
"primaryHouseholdServingSizeText": "xyz789",
"secondaryHouseholdServingSizeText": "abc123",
"primaryServingsPerContainerText": "xyz789",
"secondaryServingsPerContainerText": "abc123",
"showServingsPerContainerText": true,
"hideServingSizeAmount": true,
"nutrientDataDisplayPer": "Gram",
"caloriesCalculationMethod": "TotalOfAllIngredients",
"caloriesWhenInsignificant": "Round",
"caloriesUseRoundedValuesWith44927": true,
"fatWhenInsignificant": "Round",
"fatUseUnroundedValuesWhenCalculatingPercentDv": true,
"satFatWhenInsignificant": "Round",
"transFatWhenInsignificant": "Round",
"totalDietaryFiberWhenInsignificantShow": true,
"totalDietaryFiberUseUnroundedValuesWhenCaluculatingPercentDv": false,
"totalSugarsWhenInsignificantShow": true,
"totalSugarsUseUnroundedValuesWhenCalculatingPercentDv": true,
"cholesterolWhenInsignificant": "Round",
"cholesterolHidePercentCholesterol": false,
"cholesterolUseUnroundedValuesWhenCalculatingPercentDv": true,
"cholesterolWhenInsignificantShow": true,
"sodiumWhenInsignificant": "Round",
"sodiumWhenInsignificantShow": true,
"potassiumWhenInsignificant": "Round",
"potassiumWhenInsignificantShow": true,
"calciumWhenInsignificantShow": true,
"ironWhenInsignificantShow": true,
"dualOptions": Canada2016DualLabelOption
}
Canada2016LabelOptionsInput
Fields
| Input Field | Description |
|---|---|
primaryLanguage - Canada2016PrimaryLanguage!
|
The Primary Language for the label. Default = English |
secondaryLanguage - Canada2016SecondaryLanguage!
|
The Secondary Language for the label. Certain labels might set this automatically. Default = French |
templateStyle - Canada2016TemplateStyle!
|
Template style for the label. Default = Full |
decimalSeperator - Canada2016DecimalSeparator!
|
The decimal separator. Default = Period |
useShortenedSimplifiedFootnote - Boolean!
|
Use shortened "not a significant source of other nutrients" in Simplified label. Default = false |
primaryHouseholdServingSizeText - String!
|
The Household serving size for the Primary Language on the Label. Default = "" |
secondaryHouseholdServingSizeText - String!
|
The Household serving size for the Secondary Language on the Label. Default = "" |
primaryServingsPerContainerText - String!
|
The Servings per container that will appear for the Primary Language on the Label. Default = "" |
secondaryServingsPerContainerText - String!
|
The Servings per container that will appear for the Secondary Language on the Label. Default = "" |
showServingsPerContainerText - Boolean!
|
Show the servings per container text on the Label. Default = false |
hideServingSizeAmount - Boolean!
|
Hides the Serving Size amount from appearing on the Label. Default = false |
nutrientDataDisplayPer - Canada2016NutrientDisplay!
|
Displays nutrient values per gram or per ml. Default = Gram |
caloriesCalculationMethod - Canada2016CaloriesCalculationMethod!
|
How calories are calculated and appear on the label. Default = TotalOfAllIngredients |
caloriesWhenInsignificant - Canada2016WhenInsignificant!
|
How calories are handled when insignificant on the label. Default = Round |
caloriesUseRoundedValuesWith44927 - Boolean!
|
Use 44927 when rounding calories on the label. Default = false |
fatWhenInsignificant - Canada2016WhenInsignificant!
|
How fat is handled when insignificant on the label. Default = Round |
fatUseUnroundedValuesWhenCalculatingPercentDv - Boolean!
|
Use unrounded values for fat when calculating percent daily value. Default = false |
satFatWhenInsignificant - Canada2016WhenInsignificant!
|
How saturated fat is handled when insignificant on the label. Default = Round |
transFatWhenInsignificant - Canada2016WhenInsignificant!
|
How trans fat is handled when insignificant on the label. Default = Round |
totalDietaryFiberWhenInsignificantShow - Boolean!
|
Displays total dietary fiber when insignificant on the label. Default = false |
totalDietaryFiberUseUnroundedValuesWhenCaluculatingPercentDv - Boolean!
|
Use unrounded values for total dietary fiber when calculating percent daily value. Default = false |
totalSugarsWhenInsignificantShow - Boolean!
|
Displays total sugars when insignificant on the label. Default = false |
totalSugarsUseUnroundedValuesWhenCalculatingPercentDv - Boolean!
|
Use unrounded values for total sugars when calculating percent daily value. Default = false |
cholesterolWhenInsignificant - Canada2016WhenInsignificant!
|
How cholesterol is handled when insignificant on the label. Default = Round |
cholesterolHidePercentCholesterol - Boolean!
|
Hide percent cholesterol on the label. Default = false |
cholesterolUseUnroundedValuesWhenCalculatingPercentDv - Boolean!
|
Use unrounded values for cholesterol when calculating percent daily value. Default = false |
cholesterolWhenInsignificantShow - Boolean!
|
Displays cholesterol when insignificant on the label. Default = false |
sodiumWhenInsignificant - Canada2016WhenInsignificant!
|
How sodium is handled when insignificant on the label. Default = Round |
sodiumWhenInsignificantShow - Boolean!
|
Displays sodium when insignificant on the label. Default = false |
potassiumWhenInsignificant - Canada2016WhenInsignificant!
|
How potassium is handled when insignificant on the label. Default = Round |
potassiumWhenInsignificantShow - Boolean!
|
Displays potassium when insignificant on the label. Default = false |
calciumWhenInsignificantShow - Boolean!
|
Displays calcium when insignificant on the label. Default = false |
ironWhenInsignificantShow - Boolean!
|
Displays iron when insignificant on the label. Default = false |
dualOptions - Canada2016DualLabelOptionsInput
|
Dual Label Options for Canada 2016 Dual Labels. Will not save and return null when the Label does not have 2 Foods added to it. |
Example
{}
Canada2016LabelStyles
Description
The Label Styles available for Canada 2016.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
Canada2016Mutation
Fields
| Field Name | Description |
|---|---|
create - LabelPayload
|
Creates a Canada 2016 Label. |
Arguments
|
|
setOptions - LabelPayload
|
Sets the Label Options on a Canada 2016 Label. |
Arguments
|
|
setVoluntaryNutrients - LabelPayload
|
Sets the Voluntary Nutrients on a Canada 2016 Label. |
Arguments |
|
setLabelStyle - LabelPayload
|
Sets the Label Style on a Canada 2016 Label. This clears all Label Items and returns Label Options to default values. |
Arguments
|
|
setLabelItems - LabelPayload
|
Sets the Label Items on a Label. All Foods are added at 1 Serving and can be edited with LabelOptions. This returns certain Label Options to default values. |
Arguments
|
|
Example
{
"create": LabelPayload,
"setOptions": LabelPayload,
"setVoluntaryNutrients": LabelPayload,
"setLabelStyle": LabelPayload,
"setLabelItems": LabelPayload
}
Canada2016NutrientDisplay
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
Canada2016PrimaryLanguage
Description
The primary label languages available for Canada 2016.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
Canada2016SecondaryLanguage
Description
The secondary label languages available for Canada 2016.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
Canada2016StandardAnalyzedData
Fields
| Field Name | Description |
|---|---|
servingSize - String!
|
|
nutrientsPerServing - [LabelNutrient!]!
|
|
primarySimplifiedFootnote - String!
|
|
secondarySimplifiedFootnote - String!
|
Example
{
"servingSize": "abc123",
"nutrientsPerServing": [LabelNutrient],
"primarySimplifiedFootnote": "abc123",
"secondarySimplifiedFootnote": "xyz789"
}
Canada2016TemplateStyle
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
Canada2016VoluntaryNutrients
Description
The Voluntary Nutrients available for Canada 2016.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
Canada2016WhenInsignificant
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
Conversion
ConversionInput
Description
A conversion.
Fields
| Input Field | Description |
|---|---|
to - AmountInput!
|
The target amount. |
from - AmountInput!
|
The source amount. |
Example
{}
ConvertAmountInput
Description
An amount to convert.
Fields
| Input Field | Description |
|---|---|
from - AmountInput
|
The source amount. |
to - ID!
|
The target unit. |
Example
{}
CreateAustraliaNewZealand2016LabelInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Example
{}
CreateCanada2016LabelInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
labelStyle - Canada2016LabelStyles!
|
Example
{}
CreateEuropeanUnion2011LabelInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Example
{}
CreateFoodCopyInput
CreateFoodInput
CreateLabelCopyInput
CreateNewFoodVersionInput
CreateOrUpdateNccSelectionDetailsInput
Fields
| Input Field | Description |
|---|---|
foodId - ID!
|
|
regulationId - ID!
|
|
racc - AmountInput
|
|
referenceRecipeId - ID
|
Example
{}
CreateUnitedStates2016LabelInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
labelStyle - UnitedStates2016LabelStyles!
|
|
recommendationProfile - UnitedStates2016RecommendationProfiles!
|
Example
{}
CultureInfo
Description
A culture info object.
Example
{}
CustomField
Description
A custom field for a food item.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the custom field. |
name - String!
|
The name of the custom field. |
documentFlags - [CustomFieldDocumentFlags!]!
|
The document flags for the custom field. |
Example
{
"id": "4",
"name": "xyz789",
"documentFlags": ["None"]
}
CustomFieldDocumentFlags
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
CustomFieldInput
CustomFieldListPayload
Fields
| Field Name | Description |
|---|---|
customFields - [CustomField!]!
|
Example
{"customFields": [CustomField]}
CustomFieldValue
Description
A custom field value.
Fields
| Field Name | Description |
|---|---|
value - String!
|
The value of the custom field. |
customField - CustomField
|
The custom field. |
Example
{
"value": "xyz789",
"customField": CustomField
}
CustomFieldsQuery
Description
Queries for custom fields.
Fields
| Field Name | Description |
|---|---|
getAll - PaginatedCustomFieldListPayload
|
Get all custom fields. |
Arguments
|
|
getCustomFieldsUsedInFood - CustomFieldListPayload
|
Get all custom fields used in food. |
Example
{
"getAll": PaginatedCustomFieldListPayload,
"getCustomFieldsUsedInFood": CustomFieldListPayload
}
CustomIngredientStatement
Fields
| Field Name | Description |
|---|---|
regulation - Regulation!
|
|
statements - [CustomStatement!]!
|
Example
{
"regulation": Regulation,
"statements": [CustomStatement]
}
CustomIngredientStatementInput
Fields
| Input Field | Description |
|---|---|
language - StandardLanguage!
|
|
statement - String
|
Example
{}
CustomStatement
DateOnly
Description
The Date scalar type represents a year, month and day in accordance with the ISO-8601 standard. Format is yyyy-MM-dd
Example
{}
DateTime
Description
The DateTime scalar type represents a date and time. DateTime expects timestamps to be formatted in accordance with the ISO-8601 standard.
Example
{}
DateTimeOffset
Description
The DateTimeOffset scalar type represents a date, time and offset from UTC. DateTimeOffset expects timestamps to be formatted in accordance with the ISO-8601 standard.
Example
{}
Decimal
Example
{}
DeleteAliasInput
DeleteDocumentEntityInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
Example
{}
DeleteDocumentIndexInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
Example
{}
DeleteFoodConversionInput
DeleteFoodItemInput
DeletedDocumentEntityPayload
Fields
| Field Name | Description |
|---|---|
documentId - ID!
|
Example
{"documentId": 4}
DeletedDocumentUnion
Dimension
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
DocumentIdInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
Example
{}
DocumentInterface
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
modified - DateTimeOffset!
|
|
created - DateTimeOffset!
|
|
isApproved - Boolean!
|
|
version - Version!
|
|
versionHistory - VersionHistory!
|
|
isArchived - Boolean!
|
|
notes - [Note!]!
|
|
attachments - [FileAttachment!]!
|
|
tags - [Tag!]!
|
|
customFields - [CustomFieldValue!]!
|
|
documentType - DocumentType!
|
Possible Types
| DocumentInterface Types |
|---|
Example
{
"id": 4,
"name": "abc123",
"modified": DateTimeOffset,
"created": DateTimeOffset,
"isApproved": false,
"version": Version,
"versionHistory": VersionHistory,
"isArchived": true,
"notes": [Note],
"attachments": [FileAttachment],
"tags": [Tag],
"customFields": [CustomFieldValue],
"documentType": "Ingredient"
}
DocumentMutation
Description
Mutations for documents.
Fields
| Field Name | Description |
|---|---|
setName - DocumentPayload
|
Set the name of a document. |
Arguments
|
|
setNotes - DocumentPayload
|
Set the notes of a document. |
Arguments
|
|
setTags - DocumentPayload
|
Set the tags of a document. |
Arguments
|
|
approve - DocumentPayload
|
Approve a document. |
Arguments
|
|
setCustomFields - DocumentPayload
|
Set the custom fields of a document. |
Arguments
|
|
reindexDocument - DocumentPayload
|
Reindex a document. |
Arguments
|
|
deleteDocumentIndex - DocumentPayload
|
Delete a document index. |
Arguments
|
|
deleteDocumentEntity - DeletedDocumentUnion
|
Delete a document entity. |
Arguments
|
|
toggleArchive - DocumentPayload
|
Toggle the archive status of a document. |
Arguments
|
|
Example
{
"setName": DocumentPayload,
"setNotes": DocumentPayload,
"setTags": DocumentPayload,
"approve": DocumentPayload,
"setCustomFields": DocumentPayload,
"reindexDocument": DocumentPayload,
"deleteDocumentIndex": DocumentPayload,
"deleteDocumentEntity": DeletedDocumentEntityPayload,
"toggleArchive": DocumentPayload
}
DocumentNotFoundException
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "abc123"}
DocumentPayload
Fields
| Field Name | Description |
|---|---|
document - DocumentInterface
|
Example
{"document": DocumentInterface}
DocumentQuery
Description
Queries for documents.
Fields
| Field Name | Description |
|---|---|
get - DocumentPayload
|
Get a document by ID. |
Arguments
|
|
search - PaginatedDocumentSearchResultPayload
|
Search for documents. |
Arguments
|
|
recents - PaginatedDocumentSearchResultPayload
|
Get recent documents. |
Arguments
|
|
active - ActiveDocumentsPayload
|
Gets documents that were active during a specified date range. |
Arguments
|
|
getStoredDocuments - PaginatedDocumentEntitiesPayload
|
Get documents that are stored in our Backend. This is helpful for Reindexing our database. |
Arguments
|
|
getPointInTimeId - String!
|
Gets a point in time ID that can be used in our search field. |
Arguments
|
|
bulkSearch - BulkSearchPayload
|
Used for searching result sets that are > 10000 records |
Arguments
|
|
Example
{
"get": DocumentPayload,
"search": PaginatedDocumentSearchResultPayload,
"recents": PaginatedDocumentSearchResultPayload,
"active": ActiveDocumentsPayload,
"getStoredDocuments": PaginatedDocumentEntitiesPayload,
"getPointInTimeId": "abc123",
"bulkSearch": BulkSearchPayload
}
DocumentSearchInput
Fields
| Input Field | Description |
|---|---|
documentTypes - [DocumentType]
|
|
searchText - String
|
|
searchFieldFilter - SearchFieldFilter
|
|
itemSourceFilter - ItemSourceFilter
|
|
versionFilter - VersionFilter
|
|
archiveFilter - ArchiveFilter
|
|
documentStatusFilter - DocumentStatusFilter
|
|
first - Int
|
|
after - Int
|
Example
{}
DocumentSearchResultInterface
Description
A document search result interface.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The unique identifier of the document. |
name - String
|
The name of the document. |
versionName - String
|
The version name of the document. |
documentType - DocumentType
|
The type of the document. |
modified - DateTimeOffset
|
The date the document was last modified. |
created - DateTimeOffset
|
The date the document was created. |
isApproved - Boolean
|
Whether the document is approved. |
tags - [String]
|
The tags for the document. |
customFields - [String]
|
The custom fields for the document. |
versionHistoryId - ID
|
The unique identifier of the version history. |
score - Decimal
|
The score of the document. |
isArchived - Boolean
|
Whether the document is archived. |
Possible Types
| DocumentSearchResultInterface Types |
|---|
Example
{
"id": "4",
"name": "xyz789",
"versionName": "xyz789",
"documentType": "Ingredient",
"modified": DateTimeOffset,
"created": DateTimeOffset,
"isApproved": true,
"tags": ["xyz789"],
"customFields": ["abc123"],
"versionHistoryId": 4,
"score": Decimal,
"isArchived": true
}
DocumentStatusFilter
Values
| Enum Value | Description |
|---|---|
|
|
'All' includes both Draft and Approved documents in search results. |
|
|
'Draft' includes only Draft documents in search results. |
|
|
'Approved' includes only Approved documents in search results. |
Example
{}
DocumentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
EditAliasInput
EditFoodItemAmountInput
Fields
| Input Field | Description |
|---|---|
aggregateFoodId - ID!
|
|
foodItemId - ID!
|
|
amount - AmountInput
|
Example
{}
EditFoodItemNoteInput
EntityType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
EshaUser
Description
A user of the application
Example
{
"id": "4",
"name": "abc123",
"email": "xyz789",
"lastName": "xyz789",
"firstName": "abc123"
}
EuropeanUnion2011AnalyzedData
Types
| Union Types |
|---|
Example
{}
EuropeanUnion2011ColumnFormatting
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
EuropeanUnion2011DecimalFormatting
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
EuropeanUnion2011EnergyCalculationMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
EuropeanUnion2011LabelDetails
Fields
| Field Name | Description |
|---|---|
labelOptions - EuropeanUnion2011LabelOptions!
|
The Label Options that are set on the Label. |
analyzedData - EuropeanUnion2011AnalyzedData
|
Information for the Label that is determined by the Food(s) added to it. Will return null if the number of items is not correct for the given label. |
Example
{
"labelOptions": EuropeanUnion2011LabelOptions,
"analyzedData": EuropeanUnion2011TabularAnalyzedData
}
EuropeanUnion2011LabelOptions
Fields
| Field Name | Description |
|---|---|
primaryLanguage - EuropeanUnion2011PrimaryLanguage!
|
The Primary Language for the label |
showPerPortionColumn - Boolean!
|
Show Per Portions column |
portionSizeHeading - String!
|
The Portion Size heading |
portionsPerContainerText - String!
|
The Portions Per Container Text |
showConsumptionUnitColumn - Boolean!
|
Show Consumption Unit column |
consumptionUnitHeading - String!
|
Consumption Unit Heading |
consumptionUnitsPerContainerText - String!
|
Consumption Units Per Container Text |
consumptionValue - Float!
|
Consumption Value |
consumptionUnit - StandardUnits!
|
Consumption Unit |
productType - EuropeanUnion2011Product!
|
The product type for the label |
showPercentRIPer100gOrMl - Boolean!
|
Shows the %RI for the Per 100g/ml |
showPercentRIPerPortion - Boolean!
|
Shows the %RI Per Portion |
showPercentRIPerConsumptionUnit - Boolean!
|
Shows the %RI Per Consumption Unit |
columnFormatting - EuropeanUnion2011ColumnFormatting!
|
Column Formatting for the label |
decimalFormatting - EuropeanUnion2011DecimalFormatting!
|
How decimals appear on the label |
nutrientDataDisplayPer - EuropeanUnion2011NutrientDataDisplay!
|
Display Nutrient data per 100g or 100ml |
showOfWhichOnSeparateLine - Boolean!
|
Shows "of which" on Separate line |
showTypicalValuesInHeading - Boolean!
|
Shows "Typical Values" in heading |
showNegligibleAmountsStatement - Boolean!
|
Show contains negligible amounts statement |
showSaltStatement - Boolean!
|
Show Salt statement |
energyCalculationMethod - EuropeanUnion2011EnergyCalculationMethod!
|
The calculation method for energy |
displayEnergyAs0 - Boolean!
|
When Calories < 0.5, show 0 kJ and 0 kcal |
fatWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Fat is insignificant, show |
saturatedFatWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Saturated Fat is insignificant, show |
carbAvailableWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Carbohydrate (Available) is insignificant, show |
totalSugarsWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Total Sugars is insignificant, show |
proteinWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Protein is insignificant, show |
saltWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Salt is insignificant, show |
monoFatWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Monounsaturated Fat is insignificant, show |
polyFatWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Polyunsaturated Fat is insignificant, show |
polyolsWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Polyols is insignificant, show |
starchWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Starch is insignificant, show |
totalDietaryFiberWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Total Dietary Fiber is insignificant, show |
Example
{
"primaryLanguage": "English",
"showPerPortionColumn": true,
"portionSizeHeading": "xyz789",
"portionsPerContainerText": "xyz789",
"showConsumptionUnitColumn": true,
"consumptionUnitHeading": "xyz789",
"consumptionUnitsPerContainerText": "xyz789",
"consumptionValue": 123.45,
"consumptionUnit": "Teaspoon",
"productType": "Food",
"showPercentRIPer100gOrMl": false,
"showPercentRIPerPortion": false,
"showPercentRIPerConsumptionUnit": false,
"columnFormatting": "RightAligned",
"decimalFormatting": "Comma",
"nutrientDataDisplayPer": "Gram",
"showOfWhichOnSeparateLine": false,
"showTypicalValuesInHeading": false,
"showNegligibleAmountsStatement": false,
"showSaltStatement": true,
"energyCalculationMethod": "Unrounded",
"displayEnergyAs0": true,
"fatWhenInsignificantShow": "Zero",
"saturatedFatWhenInsignificantShow": "Zero",
"carbAvailableWhenInsignificantShow": "Zero",
"totalSugarsWhenInsignificantShow": "Zero",
"proteinWhenInsignificantShow": "Zero",
"saltWhenInsignificantShow": "Zero",
"monoFatWhenInsignificantShow": "Zero",
"polyFatWhenInsignificantShow": "Zero",
"polyolsWhenInsignificantShow": "Zero",
"starchWhenInsignificantShow": "Zero",
"totalDietaryFiberWhenInsignificantShow": "Zero"
}
EuropeanUnion2011LabelOptionsInput
Fields
| Input Field | Description |
|---|---|
primaryLanguage - EuropeanUnion2011PrimaryLanguage!
|
The Primary Language for the label. Default = English |
showPerPortionColumn - Boolean!
|
Show Per Portions column. Default = false |
portionSizeHeading - String!
|
The Portion Size heading. Default = "" |
portionsPerContainerText - String!
|
The Portions Per Container Text. Default = "" |
showConsumptionUnitColumn - Boolean!
|
Show Consumption Unit column. Default = false |
consumptionUnitHeading - String!
|
Consumption Unit Heading |
consumptionUnitsPerContainerText - String!
|
Consumption Units Per Container Text. Default = "" |
consumptionValue - Float!
|
Consumption Value. Default = 100 |
consumptionUnit - StandardUnits!
|
Consumption Unit. Default = Gram |
productType - EuropeanUnion2011Product!
|
The product type for the label. Default = Food |
showPercentRIPer100gOrMl - Boolean!
|
Shows the %RI for the Per 100g/ml. Default = false |
showPercentRIPerPortion - Boolean!
|
Shows the %RI Per Portion. Default = false |
showPercentRIPerConsumptionUnit - Boolean!
|
Shows the %RI Per Consumption Unit. Default = false |
columnFormatting - EuropeanUnion2011ColumnFormatting!
|
Column Formatting for the label. Default = RightAligned |
decimalFormatting - EuropeanUnion2011DecimalFormatting!
|
How decimals appear on the label. Default = Comma |
nutrientDataDisplayPer - EuropeanUnion2011NutrientDataDisplay!
|
Display Nutrient data per 100g or 100ml. Default = Gram |
showOfWhichOnSeparateLine - Boolean!
|
Shows "of which" on Separate line. Default = false |
showTypicalValuesInHeading - Boolean!
|
Shows "Typical Values" in heading. Default = false |
showNegligibleAmountsStatement - Boolean!
|
Show contains negligible amounts statement. Default = false |
showSaltStatement - Boolean!
|
Show Salt statement. Default = false |
energyCalculationMethod - EuropeanUnion2011EnergyCalculationMethod!
|
The calculation method for energy. Default = Unrounded |
displayEnergyAs0 - Boolean!
|
When Calories < 0.5, show 0 kJ and 0 kcal. Default = false |
fatWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Fat is insignificant, show. Default = Zero |
saturatedFatWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Saturated Fat is insignificant, show. Default = Zero |
carbAvailableWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Carbohydrate (Available) is insignificant, show. Default = Zero |
totalSugarsWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Total Sugars is insignificant, show. Default = Zero |
proteinWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Protein is insignificant, show. Default = Zero |
saltWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Salt is insignificant, show. Default = Zero |
monoFatWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Monounsaturated Fat is insignificant, show. Default = Zero |
polyFatWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Polyunsaturated Fat is insignificant, show. Default = Zero |
polyolsWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Polyols is insignificant, show. Default = Zero |
starchWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Starch is insignificant, show. Default = Zero |
totalDietaryFiberWhenInsignificantShow - EuropeanUnion2011WhenInsignificantShow!
|
When Total Dietary Fiber is insignificant, show. Default = Zero |
Example
{}
EuropeanUnion2011Mutation
Fields
| Field Name | Description |
|---|---|
create - LabelPayload
|
Creates a European Union 2011 Label. |
Arguments |
|
setOptions - LabelPayload
|
Sets the Label Options on a European Union 2011 Label. |
Arguments |
|
setVoluntaryNutrients - LabelPayload
|
Sets the Voluntary Nutrients on a European Union 2011 Label. |
Arguments |
|
setLabelItem - LabelPayload
|
Sets the Label Items on a Label. All Foods are added at 1 Serving and can be edited with LabelOptions. This returns Label Options to default values. |
Arguments |
|
Example
{
"create": LabelPayload,
"setOptions": LabelPayload,
"setVoluntaryNutrients": LabelPayload,
"setLabelItem": LabelPayload
}
EuropeanUnion2011NutrientDataDisplay
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
EuropeanUnion2011PrimaryLanguage
Description
The label languages available for European Union 2011.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
EuropeanUnion2011Product
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
EuropeanUnion2011TabularAnalyzedData
Fields
| Field Name | Description |
|---|---|
nutrientsPer100gOrMl - [LabelNutrient!]!
|
|
nutrientsPerPortion - [LabelNutrient!]!
|
|
nutrientsPerConsumptionAmount - [LabelNutrient!]!
|
Example
{
"nutrientsPer100gOrMl": [LabelNutrient],
"nutrientsPerPortion": [LabelNutrient],
"nutrientsPerConsumptionAmount": [LabelNutrient]
}
EuropeanUnion2011VoluntaryNutrients
Description
The Voluntary Nutrients available for Eurpean Union 2011.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
EuropeanUnion2011WhenInsignificantShow
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
EvaluatedNutrientContentClaim
Description
A nutrient content claim that has been evaluated.
Fields
| Field Name | Description |
|---|---|
claim - NutrientContentClaim
|
The nutrient content claim. |
result - NccEvaluationStatus
|
The result of the evaluation. |
recipeNutrientAmount - Amount
|
The amount of the nutrient in the recipe. |
referenceRecipeNutrientAmount - Amount
|
The amount of the nutrient in the reference recipe. |
recipeNutrientRdiPercent - Quantity
|
The RDI percent of the nutrient in the recipe. |
referenceRecipeNutrientRdiPercent - Quantity
|
The RDI percent of the nutrient in the reference recipe. |
Example
{
"claim": NutrientContentClaim,
"result": "None",
"recipeNutrientAmount": Amount,
"referenceRecipeNutrientAmount": Amount,
"recipeNutrientRdiPercent": Quantity,
"referenceRecipeNutrientRdiPercent": Quantity
}
FileAttachment
Description
A file attachment.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the attachment. |
name - String!
|
The name of the attachment. |
fileName - String!
|
The file name of the attachment. |
fileSize - Long!
|
The size of the attachment. |
user - EshaUser
|
The user who attached the file. |
contentType - String!
|
The content type of the attachment. |
attachedDate - DateTimeOffset
|
The date the attachment was attached. |
attachmentLinks - [AttachmentLinkInterface!]!
|
The links to the attachment. |
downloadUri - Uri
|
Generates a SaS Uri for the given attachment. |
Arguments
|
|
description - String!
|
The description of the file attachment. |
Example
{
"id": "4",
"name": "xyz789",
"fileName": "xyz789",
"fileSize": {},
"user": EshaUser,
"contentType": "abc123",
"attachedDate": DateTimeOffset,
"attachmentLinks": [AttachmentLinkInterface],
"downloadUri": Uri,
"description": "xyz789"
}
Float
Description
The 'Float' scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
{}
FoodAlertInterface
Description
An alert for a food item.
Fields
| Field Name | Description |
|---|---|
food - FoodInterface
|
The food item associated with the alert. |
alertType - FoodAlertType
|
The type of the alert. |
Possible Types
| FoodAlertInterface Types |
|---|
Example
{"food": FoodInterface, "alertType": "Invalid"}
FoodAlertType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
FoodAllergen
Description
An allergen that can be associated with a food item.
Fields
| Field Name | Description |
|---|---|
allergen - Allergen!
|
The allergen. |
occurrence - AllergenOccurrence!
|
The occurrence of the allergen in the food item. |
Example
{"allergen": Allergen, "occurrence": "Invalid"}
FoodAllergenInput
Description
An allergen associated with a food item.
Fields
| Input Field | Description |
|---|---|
allergenId - ID
|
The allergen identifier. |
occurrence - AllergenOccurrence
|
The occurrence of the allergen. |
Example
{}
FoodAttribute
Description
A food attribute.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the food attribute. |
name - String!
|
The name of the food attribute. |
standardKey - StandardFoodAttributes
|
The standard key of the food attribute. |
calculatedStrategy - CalculatedStrategy
|
The calculated strategy of the food attribute. |
Example
{
"id": 4,
"name": "xyz789",
"standardKey": "BioEngineered",
"calculatedStrategy": "IfAny"
}
FoodAttributeAttachmentLink
Description
A link between a food attribute and an attachment.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the attachment link. |
attachmentLinkType - AttachmentLinkType
|
The type of the attachment link. |
foodAttribute - FoodAttribute
|
The food attribute of the attachment link. |
Example
{
"id": 4,
"attachmentLinkType": "FoodAttribute",
"foodAttribute": FoodAttribute
}
FoodAttributeElement
Description
An element of a food attribute.
Fields
| Field Name | Description |
|---|---|
value - String
|
The value of the element. |
expirationDate - DateTime
|
The expiration date of the element. |
attribute - FoodAttribute
|
The attribute of the element. |
Example
{
"value": "abc123",
"expirationDate": "2007-12-03T10:15:30Z",
"attribute": FoodAttribute
}
FoodAttributePayload
Fields
| Field Name | Description |
|---|---|
foodAttribute - FoodAttribute
|
Example
{"foodAttribute": FoodAttribute}
FoodAttributeQuery
Description
Queries for food attributes.
Fields
| Field Name | Description |
|---|---|
get - FoodAttributePayload
|
Get a food attribute by ID. |
Arguments
|
|
getStandard - PaginatedFoodAttributeListPayload
|
Get all standard food attributes. |
Arguments
|
|
getUserAdded - PaginatedFoodAttributeListPayload
|
Get all user added food attributes. |
Arguments
|
|
Example
{
"get": FoodAttributePayload,
"getStandard": PaginatedFoodAttributeListPayload,
"getUserAdded": PaginatedFoodAttributeListPayload
}
FoodAttributeValueInput
FoodAuthoritiesInput
Description
A food authority.
Fields
| Input Field | Description |
|---|---|
authorityId - ID
|
The authority identifier. |
Example
{}
FoodIdInput
Fields
| Input Field | Description |
|---|---|
foodId - ID!
|
Example
{}
FoodInterface
Description
A food item.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the food item. |
name - String!
|
The name of the food item. |
modified - DateTimeOffset!
|
The date the food item was last modified. |
created - DateTimeOffset!
|
The date the food item was created. |
isApproved - Boolean!
|
Whether the food item is approved. |
version - Version!
|
The version of the food item. |
versionHistory - VersionHistory!
|
The version history of the food item. |
isArchived - Boolean!
|
Whether the food item is archived. |
notes - [Note!]!
|
The notes for the food item. |
attachments - [FileAttachment!]!
|
The attachments for the food item. |
tags - [Tag!]!
|
The tags for the food item. |
customFields - [CustomFieldValue!]!
|
The custom fields for the food item. |
definingAmount - Amount
|
The amount of the food item. |
foodType - FoodType
|
The type of the food item. |
items - [FoodItem!]!
|
The items that make up the food item. |
amountCost - AmountCost
|
The cost of the food item. |
eshaCode - Int
|
Use ItemCode |
itemCode - Int
|
The Item code of the food item. |
image - ImageAttachment
|
The image for the food item. |
conversions - [Conversion!]!
|
The conversions for the food item. |
aliases - [Alias!]!
|
The aliases for the food item. |
product - Product
|
The product of the food item. |
supplier - Supplier
|
The supplier of the food item. |
glycemicIndex - Quantity
|
The glycemic index of the food item. |
isInUse - Boolean
|
Whether the food item is in use. |
legacyKey - Int
|
The legacy key of the food item. |
yieldKey - Int
|
The yield key of the food item. |
allergensVerified - Boolean!
|
Whether the allergens have been verified. |
allergenStatements - [AllergenStatement!]!
|
The allergen statements for the food item. |
regulationSettings - [RegulationSetting!]!
|
The collection of regulation settings associated with this food. |
authorities - [Authority!]!
|
The authorities for the food item. |
allergens - [FoodAllergen!]!
|
Returns the Allergens that have been directly set on the Food. The returned allergens here do not consider any allergens that any FoodItems have. |
analyzedAllergens - [FoodAllergen!]!
|
Returns the allergens that the Food contains. This takes into account any allergens that any FoodItems have. |
hasVolumeMeasures - Boolean!
|
Returns whether the food has a volumetric conversion. If so, the Food can be added to other foods at a volumetric amount, an analysis for the food can be calculated at a volumetric amount, etc. |
discreteMeasures - [Unit!]!
|
Returns the discrete units (besides AsIs) that are defined via a conversion on the Food. The foodcan be added at an amount with one of the units returned by this field, an analysis for the food can becalculated at an amount with one of the units, etc. |
itemsGramYield - Float!
|
Returns the Yield of the Food based solely off of the Yield Weight of its FoodItems. If the Food has no items it will return a value of 0. |
glycemicLoad - Quantity
|
The glycemic load of the food item. |
pdcaas - Float
|
The Protein Digestibility Corrected Amino Acid Score of the food item. |
per - Float
|
The Protein Efficiency Ratio of the food item. |
yields - Yields
|
The Yields to be applied to the Food. |
attributes - [FoodAttributeElement!]!
|
|
alerts - [FoodAlertInterface!]!
|
|
Arguments
|
|
analysis - Analysis
|
|
Arguments
|
|
convertAmount - Amount
|
|
Arguments
|
|
analyzedCost - Decimal
|
|
Arguments
|
|
displayNutrientsToView - NutrientsToView
|
|
Possible Types
| FoodInterface Types |
|---|
Example
{
"id": "4",
"name": "xyz789",
"modified": DateTimeOffset,
"created": DateTimeOffset,
"isApproved": false,
"version": Version,
"versionHistory": VersionHistory,
"isArchived": false,
"notes": [Note],
"attachments": [FileAttachment],
"tags": [Tag],
"customFields": [CustomFieldValue],
"definingAmount": Amount,
"foodType": "Ingredient",
"items": [FoodItem],
"amountCost": AmountCost,
"eshaCode": 987,
"itemCode": 123,
"image": ImageAttachment,
"conversions": [Conversion],
"aliases": [Alias],
"product": Product,
"supplier": Supplier,
"glycemicIndex": Quantity,
"isInUse": true,
"legacyKey": 987,
"yieldKey": 987,
"allergensVerified": false,
"allergenStatements": [AllergenStatement],
"regulationSettings": [RegulationSetting],
"authorities": [Authority],
"allergens": [FoodAllergen],
"analyzedAllergens": [FoodAllergen],
"hasVolumeMeasures": false,
"discreteMeasures": [Unit],
"itemsGramYield": 123.45,
"glycemicLoad": Quantity,
"pdcaas": 987.65,
"per": 987.65,
"yields": Yields,
"attributes": [FoodAttributeElement],
"alerts": [FoodAlertInterface],
"analysis": Analysis,
"convertAmount": Amount,
"analyzedCost": Decimal,
"displayNutrientsToView": NutrientsToView
}
FoodItem
Description
A food item.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the food item. |
note - String
|
A note about the food item. |
amount - Amount
|
The amount of the food item. |
cost - Decimal
|
The cost of the food item. |
gramWeight - Float
|
Get's the Items Weight Amount in grams. |
food - FoodInterface
|
The food of the food item. |
gramYield - Float!
|
Get's the Items Yield Amount in grams. In most cases this will be equivalent to the GramWeight field. |
Example
{
"id": 4,
"note": "abc123",
"amount": Amount,
"cost": Decimal,
"gramWeight": 987.65,
"food": FoodInterface,
"gramYield": 987.65
}
FoodItemInput
Fields
| Input Field | Description |
|---|---|
foodItemId - ID
|
If null, a new FoodItem is added to the food with a randomly generated Id. If non-null we update any FoodItem that exists on the food with the specified Id. If no FoodItem is found with the specified Id a new FoodItem is added with the Id. |
foodId - ID!
|
|
amount - AmountInput
|
|
note - String
|
Example
{}
FoodMutation
Description
Mutations for foods.
Fields
| Field Name | Description |
|---|---|
setName - FoodPayload
|
Set the name of a food. Use DocumentMutation field instead. |
Arguments
|
|
addAlias - FoodPayload
|
Add an alias to a food. |
Arguments
|
|
deleteAlias - FoodPayload
|
Delete an alias from a food. |
Arguments
|
|
editAlias - FoodPayload
|
Edit an alias on a food. |
Arguments
|
|
setAliases - FoodPayload
|
Set the aliases on a food. |
Arguments
|
|
setAmount - FoodPayload
|
Set the defining amount on a food. |
Arguments
|
|
setNotes - FoodPayload
|
Set the notes on a food. Use DocumentMutation field instead. |
Arguments
|
|
setNutrientValue - FoodPayload
|
Set a nutrient value on a food. |
Arguments
|
|
setNutrientValues - FoodPayload
|
Set nutrient values on a food. |
Arguments
|
|
create - FoodPayload
|
Create a new food. |
Arguments
|
|
addTag - FoodPayload
|
Add a tag to a food. |
Arguments
|
|
removeTag - FoodPayload
|
Remove a tag from a food. |
Arguments
|
|
setYieldKey - FoodPayload
|
Set the Yield Key on a Food. |
Arguments
|
|
setTags - FoodPayload
|
Use DocumentMutation field instead. |
Arguments
|
|
addFoodItem - FoodPayload
|
Add a Food Item to an Aggregate Food. |
Arguments
|
|
editFoodItemAmount - FoodPayload
|
Edit the Amount of a Food Item. |
Arguments
|
|
editFoodItemNote - FoodPayload
|
Edit the Note of a Food Item. |
Arguments
|
|
deleteFoodItem - FoodPayload
|
Delete a Food Item from an Aggregate Food. |
Arguments
|
|
setFoodItems - FoodPayload
|
Set the Food Items on an Aggregate Food. |
Arguments
|
|
approveFood - FoodPayload
|
Approve a Food. Use DocumentMutation field instead. |
Arguments
|
|
createNewVersion - FoodPayload
|
Create a new version of a Food. |
Arguments
|
|
setFoodCostAmount - FoodPayload
|
Set the Cost Amount on a Food. |
Arguments
|
|
setPreparationTime - RecipePayload
|
Set the Preparation Time on a Recipe. |
Arguments
|
|
setCookTime - RecipePayload
|
Set the Cook Time on a Recipe. |
Arguments
|
|
setCookTemperature - RecipePayload
|
Set the Cook Temperature on a Recipe. |
Arguments
|
|
setCookMethod - RecipePayload
|
Set the Cook Method on a Recipe. |
Arguments
|
|
setPanSize - RecipePayload
|
Set the Pan Size on a Recipe. |
Arguments
|
|
setInstructions - RecipePayload
|
Set the Instructions on a Recipe. |
Arguments
|
|
removeImage - FoodPayload
|
Remove the Image from a Food. |
Arguments
|
|
addConversion - FoodPayload
|
Add a Conversion to a Food. |
Arguments
|
|
updateConversion - FoodPayload
|
Update a Conversion on a Food. |
Arguments
|
|
deleteConversion - FoodPayload
|
Delete a Conversion from a Food. |
Arguments
|
|
setConversions - FoodPayload
|
Set the Conversions on a Food. |
Arguments
|
|
setSpecificGravity - RecipePayload
|
Set the Specific Gravity on a Recipe. |
Arguments
|
|
setSubIngredients - IngredientPayload
|
Set the Sub Ingredients on an Ingredient. |
Arguments
|
|
setNumberOfServings - RecipePayload
|
Set the Number of Servings on a Recipe. |
Arguments
|
|
setServingSize - RecipePayload
|
Set the Serving Size on a Recipe. |
Arguments
|
|
setAllergens - FoodPayload
|
Set the Allergens on a Food. |
Arguments
|
|
setAuthorities - FoodPayload
|
Set the Authorities on a Food. |
Arguments
|
|
setFoodAttributes - FoodPayload
|
Set the Food Attributes on a Food. |
Arguments
|
|
setProduct - FoodPayload
|
Set the Product on a Food. |
Arguments
|
|
setSupplier - FoodPayload
|
Set the Supplier on a Food. |
Arguments
|
|
setCustomFields - FoodPayload
|
Set the Custom Fields on a Food. Use DocumentMutation field instead. |
Arguments
|
|
createOrUpdateNccSelectionDetails - RecipePayload
|
Create or Update NCC Selection Details on a Recipe. |
Arguments |
|
setSelectedNutrientContentClaims - RecipePayload
|
Set the Selected Nutrient Content Claims on a Recipe. |
Arguments |
|
setGlycemicIndex - FoodPayload
|
Set the Glycemic Index on a Food. |
Arguments
|
|
setIngredientDesignations - IngredientPayload
|
Set the Ingredient Designations on an Ingredient. |
Arguments
|
|
createCopy - FoodPayload
|
Create a copy of a Food. |
Arguments
|
|
setPDCAAS - FoodPayload
|
Set the PDCAAS on a Food. |
Arguments
|
|
setPER - FoodPayload
|
Set the PER on a Food. |
Arguments
|
|
setGovernmentCode - IngredientPayload
|
Set the Government Code on an Ingredient. |
Arguments
|
|
setLegacyKey - FoodPayload
|
Set the Legacy Key on a Food. |
Arguments
|
|
setCreated - FoodPayload
|
Set the Created Date on a Food. |
Arguments
|
|
setModified - FoodPayload
|
Set the Modified Date on a Food. |
Arguments
|
|
setAllergensVerified - FoodPayload
|
Set the Allergens Verified on a Food. |
Arguments
|
|
setAllergenStatements - FoodPayload
|
Set the Allergen Statements on a Food. |
Arguments
|
|
setYields - FoodPayload
|
Set the Yields on a Food. Currently only available for Recipes. |
Arguments
|
|
setExcludeCost - RecipePayload
|
Set the Exclude Cost on a Recipe. |
Arguments
|
|
setDisplayNutrientsToView - FoodPayload
|
Set the Display Nutrients To View on a Food. |
Arguments
|
|
setPalHeaders - RecipePayload
|
Set the PAL Header on a Recipe. |
Arguments
|
|
setRegulationSetting - FoodPayload
|
Set the Regulation Setting on a Food. |
Arguments
|
|
setRegulationSettings - FoodPayload
|
Set the Regulation Settings on a Food. |
Arguments
|
|
setMexico2020PackagingSymbols - RecipePayload
|
Sets the Packaging Symbols on a Recipe for the Mexico 2020 Regulation. You can no longer set Mexico2020PackagingSymbols on a Food. |
Arguments |
|
setFormulationState - RecipePayload
|
Sets the Packaging Symbols on a Recipe for the Mexico 2020 Regulation. |
Arguments
|
|
setCustomIngredientStatement - RecipePayload
|
Sets the custom ingredient statement for a Recipe. |
Arguments |
|
Example
{
"setName": FoodPayload,
"addAlias": FoodPayload,
"deleteAlias": FoodPayload,
"editAlias": FoodPayload,
"setAliases": FoodPayload,
"setAmount": FoodPayload,
"setNotes": FoodPayload,
"setNutrientValue": FoodPayload,
"setNutrientValues": FoodPayload,
"create": FoodPayload,
"addTag": FoodPayload,
"removeTag": FoodPayload,
"setYieldKey": FoodPayload,
"setTags": FoodPayload,
"addFoodItem": FoodPayload,
"editFoodItemAmount": FoodPayload,
"editFoodItemNote": FoodPayload,
"deleteFoodItem": FoodPayload,
"setFoodItems": FoodPayload,
"approveFood": FoodPayload,
"createNewVersion": FoodPayload,
"setFoodCostAmount": FoodPayload,
"setPreparationTime": RecipePayload,
"setCookTime": RecipePayload,
"setCookTemperature": RecipePayload,
"setCookMethod": RecipePayload,
"setPanSize": RecipePayload,
"setInstructions": RecipePayload,
"removeImage": FoodPayload,
"addConversion": FoodPayload,
"updateConversion": FoodPayload,
"deleteConversion": FoodPayload,
"setConversions": FoodPayload,
"setSpecificGravity": RecipePayload,
"setSubIngredients": IngredientPayload,
"setNumberOfServings": RecipePayload,
"setServingSize": RecipePayload,
"setAllergens": FoodPayload,
"setAuthorities": FoodPayload,
"setFoodAttributes": FoodPayload,
"setProduct": FoodPayload,
"setSupplier": FoodPayload,
"setCustomFields": FoodPayload,
"createOrUpdateNccSelectionDetails": RecipePayload,
"setSelectedNutrientContentClaims": RecipePayload,
"setGlycemicIndex": FoodPayload,
"setIngredientDesignations": IngredientPayload,
"createCopy": FoodPayload,
"setPDCAAS": FoodPayload,
"setPER": FoodPayload,
"setGovernmentCode": IngredientPayload,
"setLegacyKey": FoodPayload,
"setCreated": FoodPayload,
"setModified": FoodPayload,
"setAllergensVerified": FoodPayload,
"setAllergenStatements": FoodPayload,
"setYields": FoodPayload,
"setExcludeCost": RecipePayload,
"setDisplayNutrientsToView": FoodPayload,
"setPalHeaders": RecipePayload,
"setRegulationSetting": FoodPayload,
"setRegulationSettings": FoodPayload,
"setMexico2020PackagingSymbols": RecipePayload,
"setFormulationState": RecipePayload,
"setCustomIngredientStatement": RecipePayload
}
FoodObject
Description
A food object.
Fields
| Field Name | Description |
|---|---|
foodId - ID!
|
The unique identifier of the food object. |
foodName - String
|
The name of the food object. |
documentType - FoodType
|
The type of the food object. |
isQualified - Boolean!
|
Whether the food object is qualified. |
expirationDate - DateTime
|
The expiration date of the food object. |
attachment - FileAttachment
|
The attachment of the food object. |
Example
{
"foodId": "4",
"foodName": "abc123",
"documentType": "Ingredient",
"isQualified": true,
"expirationDate": "2007-12-03T10:15:30Z",
"attachment": FileAttachment
}
FoodPayload
Fields
| Field Name | Description |
|---|---|
food - FoodInterface!
|
Example
{"food": FoodInterface}
FoodQuery
Description
Queries for foods.
Fields
| Field Name | Description |
|---|---|
recentFoods - PaginatedFoodSearchResultPayload
|
Get recent foods. |
Arguments
|
|
search - PaginatedFoodSearchResultPayload
|
Search for foods. |
Arguments
|
|
get - FoodPayload
|
Get a food by ID. |
Arguments
|
|
getNutrientAnalysis - NutrientAnalysisPayload
|
Get nutrient analysis. |
Arguments
|
|
whereUsed - GetWhereUsedPayload
|
Get foods that contain any version of a food at any nesting level. |
Arguments
|
|
Example
{
"recentFoods": PaginatedFoodSearchResultPayload,
"search": PaginatedFoodSearchResultPayload,
"get": FoodPayload,
"getNutrientAnalysis": NutrientAnalysisPayload,
"whereUsed": GetWhereUsedPayload
}
FoodSearchInput
Fields
| Input Field | Description |
|---|---|
foodTypes - [FoodType]
|
|
searchText - String
|
|
searchFieldFilter - SearchFieldFilter
|
|
itemSourceFilter - ItemSourceFilter
|
|
versionFilter - VersionFilter
|
|
archiveFilter - ArchiveFilter
|
|
documentStatusFilter - DocumentStatusFilter
|
|
first - Int
|
|
after - Int
|
Example
{}
FoodSearchResult
Description
A food search result.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the document. |
name - String!
|
The name of the document. |
versionName - String!
|
The version name of the document. |
documentType - DocumentType
|
The type of the document. |
created - DateTimeOffset
|
The date the document was created. |
modified - DateTimeOffset
|
The date the document was last modified. |
isApproved - Boolean!
|
Whether the document is approved. |
tags - [String]
|
The tags for the document. |
customFields - [String]
|
The custom fields for the document. |
versionHistoryId - ID!
|
The unique identifier of the version history. |
score - Decimal
|
The score of the document. |
isArchived - Boolean!
|
Whether the document is archived. |
product - String
|
The product of the food search result. |
supplier - String
|
The supplier of the food search result. |
eshaCode - Int
|
Use ItemCode |
itemCode - Int
|
The item code of the food search result. |
discreteMeasures - [ID!]
|
The discrete measures of the food search result. |
hasVolumeMeasures - Boolean!
|
Whether the food search result has volume measures. |
legacyKey - Int
|
The legacy key of the food search result. |
yieldKey - Int
|
The yield key of the food search result. |
foodTags - [String]
|
Use Tags |
foodType - FoodType
|
Use DocumentType |
aliases - [String]
|
The aliases of the food search result. |
Example
{
"id": "4",
"name": "abc123",
"versionName": "abc123",
"documentType": "Ingredient",
"created": DateTimeOffset,
"modified": DateTimeOffset,
"isApproved": true,
"tags": ["abc123"],
"customFields": ["xyz789"],
"versionHistoryId": "4",
"score": Decimal,
"isArchived": false,
"product": "xyz789",
"supplier": "xyz789",
"eshaCode": 987,
"itemCode": 123,
"discreteMeasures": [4],
"hasVolumeMeasures": false,
"legacyKey": 987,
"yieldKey": 987,
"foodTags": ["abc123"],
"foodType": "Ingredient",
"aliases": ["abc123"]
}
FoodType
Description
The type of food item.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
FormulationState
Description
Whether the food is formulated as a solid or a liquid.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
GetActiveDocumentsInput
GetAllergenInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{}
GetAnalysisInput
Fields
| Input Field | Description |
|---|---|
foodId - ID!
|
|
analysisInput - AnalysisInput
|
Example
{}
GetAuditInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{}
GetAuthoritiesInput
GetCustomFieldsInput
GetDocumentInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{}
GetFoodAttributeInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{}
GetFoodInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{}
GetLabelImageInput
Fields
| Input Field | Description |
|---|---|
labelId - ID!
|
Example
{}
GetLabelInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{}
GetLabelsForFoodInput
GetNutrientAnalysisInput
Fields
| Input Field | Description |
|---|---|
foodId - ID!
|
|
analyzedAmount - AmountInput!
|
Example
{}
GetNutrientContentClaimsInput
GetNutrientsToViewInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{}
GetPointInTimeIdInput
Fields
| Input Field | Description |
|---|---|
itemSourceFilter - ItemSourceFilter!
|
Example
{}
GetRecommendationProfilesInput
GetRecommendationsInput
GetRegulationInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
standardRegulation - StandardRegulations
|
Example
{}
GetRegulationsInput
GetRegulatoryDesignationsInput
Fields
| Input Field | Description |
|---|---|
regulationId - ID!
|
Example
{}
GetStandardFoodAttributesInput
GetStoredDocumentsInput
Fields
| Input Field | Description |
|---|---|
documentTypes - [DocumentType!]!
|
|
first - Int!
|
|
after - Int!
|
Example
{}
GetUserAddedFoodAttributesInput
GetUserAddedFoodTagsInput
GetUserAddedNutrientsInput
GetUserAddedProductsInput
GetUserAddedSuppliersInput
GetWhereUsedInput
GetWhereUsedPayload
Fields
| Field Name | Description |
|---|---|
results - [GetWhereUsedResult]
|
Example
{"results": [GetWhereUsedResult]}
GetWhereUsedResult
Description
A search result from searching for where a food is used.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the result. |
name - String!
|
The name of the result. |
versionName - String!
|
The version name of the result. |
isApproved - Boolean!
|
Whether the result is an approved document. |
isArchived - Boolean!
|
Whether the result is an archived document. |
supplier - String
|
The supplier of the result. |
modified - DateTimeOffset
|
The modified date of the result. |
Example
{
"id": 4,
"name": "abc123",
"versionName": "abc123",
"isApproved": true,
"isArchived": false,
"supplier": "xyz789",
"modified": DateTimeOffset
}
Guid
Example
{}
ID
Description
The 'ID' scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as '4') or integer (such as 4) input value will be accepted as an ID.
Example
{}
ImageAttachment
Description
An image attachment.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the attachment. |
name - String!
|
The name of the attachment. |
fileName - String!
|
The file name of the attachment. |
fileSize - Long!
|
The size of the attachment. |
user - EshaUser
|
The user who attached the file. |
contentType - String!
|
The content type of the attachment. |
attachedDate - DateTimeOffset
|
The date the attachment was attached. |
attachmentLinks - [AttachmentLinkInterface!]!
|
The links to the attachment. |
downloadUri - Uri
|
Generates a SaS Uri for the given attachment. |
Arguments
|
|
Example
{
"id": "4",
"name": "xyz789",
"fileName": "xyz789",
"fileSize": {},
"user": EshaUser,
"contentType": "xyz789",
"attachedDate": DateTimeOffset,
"attachmentLinks": [AttachmentLinkInterface],
"downloadUri": Uri
}
Ingredient
Description
An ingredient.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the food item. |
name - String!
|
The name of the food item. |
modified - DateTimeOffset!
|
The date the food item was last modified. |
created - DateTimeOffset!
|
The date the food item was created. |
isApproved - Boolean!
|
Whether the food item is approved. |
version - Version!
|
The version of the food item. |
versionHistory - VersionHistory!
|
The version history of the food item. |
notes - [Note!]!
|
The notes for the food item. |
attachments - [FileAttachment!]!
|
The attachments for the food item. |
tags - [Tag!]!
|
The tags for the food item. |
customFields - [CustomFieldValue!]!
|
The custom fields for the food item. |
isArchived - Boolean!
|
Whether the food item is archived. |
documentType - DocumentType!
|
|
definingAmount - Amount!
|
The amount of the food. |
foodType - FoodType
|
The type of the food. |
items - [FoodItem!]!
|
The items that make up the food. |
amountCost - AmountCost
|
The cost of the food. |
eshaCode - Int
|
Use ItemCode |
itemCode - Int
|
The Item code of the food. |
image - ImageAttachment
|
The image for the food. |
conversions - [Conversion!]!
|
The conversions for the food. |
product - Product
|
The product of the food. |
supplier - Supplier
|
The supplier of the food. |
glycemicIndex - Quantity
|
The glycemic index of the food. |
aliases - [Alias!]!
|
The aliases for the food. |
hasVolumeMeasures - Boolean!
|
Whether the food has volume measures. |
discreteMeasures - [Unit!]!
|
The discrete measures of the food. |
legacyKey - Int
|
The legacy key of the food. |
yieldKey - Int
|
The yield key of the food. |
yields - Yields
|
The yields of the food. |
allergensVerified - Boolean!
|
Whether the allergens are verified. |
allergenStatements - [AllergenStatement!]!
|
The allergen statements for the food. |
regulationSettings - [RegulationSetting!]!
|
The collection of regulation settings associated with this food. |
glycemicLoad - Quantity
|
The glycemic load of the food. |
pdcaas - Float
|
The protein digestibility-corrected amino acid score of the food. |
per - Float
|
The protein efficiency ratio of the food. |
alerts - [FoodAlertInterface!]!
|
The alerts for the food. |
Arguments
|
|
attributes - [FoodAttributeElement!]!
|
The attributes of the food. |
allergens - [FoodAllergen!]!
|
The allergens for the food. |
authorities - [Authority!]!
|
The authorities for the food. |
displayNutrientsToView - NutrientsToView
|
The nutrients to display for the food. |
analyzedAllergens - [FoodAllergen!]!
|
The allergens that the food contains. |
analysis - Analysis
|
The analysis for the food. |
Arguments
|
|
convertAmount - Amount
|
Converts the amount of the food. |
Arguments
|
|
itemsGramYield - Float!
|
The yield of the food based solely off of the yield weight of its food items. If the food has no items it will return a value of 0. |
analyzedCost - Decimal
|
The analyzed cost of the food. |
Arguments
|
|
isInUse - Boolean!
|
Whether the food is in use. |
nutrientProfile - NutrientProfile!
|
The nutrient profile of the ingredient. |
subIngredients - [SubIngredient!]!
|
The sub-ingredients of the ingredient. |
designations - [RegulatoryDesignation!]!
|
The regulatory designations of the ingredient. |
governmentCode - Int
|
The government code of the ingredient. |
Example
{
"id": "4",
"name": "xyz789",
"modified": DateTimeOffset,
"created": DateTimeOffset,
"isApproved": true,
"version": Version,
"versionHistory": VersionHistory,
"notes": [Note],
"attachments": [FileAttachment],
"tags": [Tag],
"customFields": [CustomFieldValue],
"isArchived": false,
"documentType": "Ingredient",
"definingAmount": Amount,
"foodType": "Ingredient",
"items": [FoodItem],
"amountCost": AmountCost,
"eshaCode": 987,
"itemCode": 123,
"image": ImageAttachment,
"conversions": [Conversion],
"product": Product,
"supplier": Supplier,
"glycemicIndex": Quantity,
"aliases": [Alias],
"hasVolumeMeasures": true,
"discreteMeasures": [Unit],
"legacyKey": 123,
"yieldKey": 123,
"yields": Yields,
"allergensVerified": false,
"allergenStatements": [AllergenStatement],
"regulationSettings": [RegulationSetting],
"glycemicLoad": Quantity,
"pdcaas": 987.65,
"per": 987.65,
"alerts": [FoodAlertInterface],
"attributes": [FoodAttributeElement],
"allergens": [FoodAllergen],
"authorities": [Authority],
"displayNutrientsToView": NutrientsToView,
"analyzedAllergens": [FoodAllergen],
"analysis": Analysis,
"convertAmount": Amount,
"itemsGramYield": 123.45,
"analyzedCost": Decimal,
"isInUse": false,
"nutrientProfile": NutrientProfile,
"subIngredients": [SubIngredient],
"designations": [RegulatoryDesignation],
"governmentCode": 987
}
IngredientPayload
Fields
| Field Name | Description |
|---|---|
ingredient - Ingredient
|
Example
{"ingredient": Ingredient}
InheritedAttribute
Description
Inherited attributes of a food object.
Fields
| Field Name | Description |
|---|---|
foods - [FoodObject]
|
The foods that have this attribute. |
value - String!
|
The value of the attribute. |
expirationDate - DateTime
|
The expiration date of the attribute. |
isQualified - Boolean
|
Whether the attribute is qualified. |
attribute - FoodAttribute
|
The attribute of the food object. |
Example
{
"foods": [FoodObject],
"value": "xyz789",
"expirationDate": "2007-12-03T10:15:30Z",
"isQualified": false,
"attribute": FoodAttribute
}
Int
Description
The 'Int' scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
{}
ItemSourceFilter
Values
| Enum Value | Description |
|---|---|
|
|
'All' includes Trustwell Foods and Customer data in search results. |
|
|
'Library' returns only Trustwell Foods documents in search results |
|
|
'Customer' returns only those documents created by the customer in search results |
Example
{}
Label
Description
A label.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
modified - DateTimeOffset!
|
|
created - DateTimeOffset!
|
|
isApproved - Boolean!
|
|
version - Version!
|
|
versionHistory - VersionHistory!
|
|
notes - [Note!]!
|
|
attachments - [FileAttachment!]!
|
|
tags - [Tag!]!
|
|
customFields - [CustomFieldValue!]!
|
|
isArchived - Boolean!
|
|
documentType - DocumentType!
|
|
regulation - Regulation
|
The regulation of the label. |
recommendationProfile - RecommendationProfile
|
The recommendation profile of the label. |
labelStyle - LabelStyle
|
The style of the label. |
selectedVoluntaryCustomNutrients - [Nutrient]
|
|
labelDetails - LabelDetails
|
Example
{
"id": 4,
"name": "xyz789",
"modified": DateTimeOffset,
"created": DateTimeOffset,
"isApproved": true,
"version": Version,
"versionHistory": VersionHistory,
"notes": [Note],
"attachments": [FileAttachment],
"tags": [Tag],
"customFields": [CustomFieldValue],
"isArchived": true,
"documentType": "Ingredient",
"regulation": Regulation,
"recommendationProfile": RecommendationProfile,
"labelStyle": LabelStyle,
"selectedVoluntaryCustomNutrients": [Nutrient],
"labelDetails": UnitedStates2016LabelDetails
}
LabelDetails
Example
{}
LabelMutation
Description
Mutations for labels.
Fields
| Field Name | Description |
|---|---|
setLabelName - LabelPayload
|
Set the name of a label. |
Arguments
|
|
createCopy - LabelPayload
|
Create a copy of a label. |
Arguments
|
|
setRegulation - LabelPayload
|
Set the Regulation on a Label. This will return the label to a default state. |
Arguments
|
|
unitedStates2016 - UnitedStates2016Mutation
|
|
canada2016 - Canada2016Mutation
|
|
europeanUnion2011 - EuropeanUnion2011Mutation
|
|
australiaNewZealand2016 - AustraliaNewZealand2016Mutation
|
|
Example
{
"setLabelName": LabelPayload,
"createCopy": LabelPayload,
"setRegulation": LabelPayload,
"unitedStates2016": UnitedStates2016Mutation,
"canada2016": Canada2016Mutation,
"europeanUnion2011": EuropeanUnion2011Mutation,
"australiaNewZealand2016": AustraliaNewZealand2016Mutation
}
LabelNutrient
Example
{
"nutrient": Nutrient,
"unit": Unit,
"name": "abc123",
"quantity": "abc123",
"amount": "abc123",
"percentDV": "xyz789",
"isSignificant": true,
"isBold": true,
"indent": 987,
"isVitaminMineral": false,
"isDisplayed": false,
"prefix": "xyz789",
"postfix": "xyz789"
}
LabelPayload
Fields
| Field Name | Description |
|---|---|
label - Label
|
Example
{"label": Label}
LabelQuery
Description
Queries for labels.
Fields
| Field Name | Description |
|---|---|
getLabel - LabelPayload
|
Get a label by ID. |
Arguments
|
|
getLabelsForFood - PaginatedLabelListPayload
|
Get labels for a food item. |
Arguments
|
|
recentLabels - PaginatedLabelSearchResultPayload
|
Get recent labels. |
Arguments
|
|
search - PaginatedLabelSearchResultPayload
|
Search for labels. |
Arguments
|
|
getLabelImage - String
|
An experimental field that will allow you to get an svg for a given label. Not all labels will render properly. |
Arguments
|
|
Example
{
"getLabel": LabelPayload,
"getLabelsForFood": PaginatedLabelListPayload,
"recentLabels": PaginatedLabelSearchResultPayload,
"search": PaginatedLabelSearchResultPayload,
"getLabelImage": "xyz789"
}
LabelSearchInput
Fields
| Input Field | Description |
|---|---|
searchText - String
|
|
versionFilter - VersionFilter
|
|
archiveFilter - ArchiveFilter
|
|
documentStatusFilter - DocumentStatusFilter
|
|
first - Int
|
|
after - Int
|
Example
{}
LabelSearchResult
Description
A search result for labels.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the document. |
name - String!
|
The name of the document. |
versionName - String!
|
The version name of the document. |
documentType - DocumentType
|
The type of the document. |
created - DateTimeOffset
|
The date the document was created. |
modified - DateTimeOffset
|
The date the document was last modified. |
isApproved - Boolean!
|
Whether the document is approved. |
tags - [String]
|
The tags for the document. |
customFields - [String]
|
The custom fields for the document. |
versionHistoryId - ID!
|
The unique identifier of the version history. |
score - Decimal
|
The score of the document. |
isArchived - Boolean!
|
Whether the document is archived. |
Example
{
"id": 4,
"name": "abc123",
"versionName": "xyz789",
"documentType": "Ingredient",
"created": DateTimeOffset,
"modified": DateTimeOffset,
"isApproved": false,
"tags": ["xyz789"],
"customFields": ["xyz789"],
"versionHistoryId": 4,
"score": Decimal,
"isArchived": true
}
LabelStyle
Description
A label style.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the label style. |
name - String!
|
The name of the label style. |
maxItemCount - Int!
|
The maximum item count for the label style. |
minItemCount - Int!
|
The minimum item count for the label style. |
standardKey - StandardLabelStyle!
|
The minimum item count for the label style. |
Example
{
"id": 4,
"name": "abc123",
"maxItemCount": 123,
"minItemCount": 987,
"standardKey": "UnitedStates2016StandardVertical"
}
Language
Description
A language.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the language. |
name - String!
|
The name of the language. |
culture - CultureInfo
|
The culture of the language. |
standardKey - StandardLanguage!
|
Key for the Language. |
Example
{
"id": "4",
"name": "abc123",
"culture": CultureInfo,
"standardKey": "English"
}
Long
Example
{}
Mexico2020PackagingSymbol
Description
A Packaging Symbol set on a Recipe for the Mexico 2020 Regulation
Fields
| Field Name | Description |
|---|---|
qualifies - Boolean!
|
Whether the Front of Packaging Symbol still qualifies. Will be set to false if the defined nutrient thresholds are not met. All Mexico2020PackagingSymbols that are returned qualify. |
packagingSymbol - Mexico2020PackagingSymbols!
|
The Style of the Packaging Symbol |
downloadUri - Uri
|
Generates a SaS Uri for the given attachment. |
Arguments
|
|
warningSealFlags - [Mexico2020WarningSealFlags!]!
|
The Nutrients that cause the current Warning Seal to be required. Will return an empty list if the Packaging Symbol is not a Warning Seal. |
Example
{
"qualifies": true,
"packagingSymbol": "ContainsCaffeineNarrow",
"downloadUri": Uri,
"warningSealFlags": ["None"]
}
Mexico2020PackagingSymbols
Description
Denotes the different type of Packaing Symbols available for the Mexico 2020 Regulation
Values
| Enum Value | Description |
|---|---|
|
|
A narrow warning statement used when a Recipe contains > 0 g of Caffeine |
|
|
A wide warning statement used when a Recipe contains > 0 g of Caffeine |
|
|
A narrow warning statement used when a Recipe contains an Item designated as a sweetener |
|
|
A wide warning statement used when a Recipe contains an Item designated as a sweetener |
|
|
A vertical warning seal used when a Recipe is above certain nutrient thresholds for 3 of the following nutrients: Calories, Saturated Fat, Excess Trans Fat, Sodium, Added Sugar |
|
|
A horizontal warning seal used when a Recipe is above certain nutrient thresholds for any combination of the following nutrients: Calories, Saturated Fat, Excess Trans Fat, Sodium, Added Sugar |
|
|
A warning seal used when a Recipe is above certain nutrient thresholds for any combination of the following nutrients: Calories, Saturated Fat, Excess Trans Fat, Sodium, Added Sugar |
Example
{}
Mexico2020WarningSealFlags
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
MissingMandatoryNutrientAlert
Description
An alert for a missing mandatory nutrient.
Fields
| Field Name | Description |
|---|---|
alertType - FoodAlertType
|
The type of the alert. |
food - FoodInterface
|
The food item associated with the alert. |
nutrient - Nutrient
|
The missing mandatory nutrient. |
Example
{
"alertType": "Invalid",
"food": FoodInterface,
"nutrient": Nutrient
}
NccAnalysis
Description
An analysis of a nutrient content claim.
Example
{
"nutrient": Nutrient,
"dailyValue": Quantity,
"value": Quantity
}
NccClaimType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
NccEvaluationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
NccResultPayload
Description
A result from an NCC evaluation.
Fields
| Field Name | Description |
|---|---|
result - NccEvaluationStatus
|
The result of the NCC evaluation. |
Example
{"result": "None"}
NccSelectionDetails
Description
Details of a Nutrient Content Claim selection.
Fields
| Field Name | Description |
|---|---|
racc - Amount
|
The Reference Amount Customarily Consumed for the recipe. |
regulation - Regulation
|
The regulation for the Nutrient Content Claim selection. |
referenceFood - Recipe
|
The reference food for the Nutrient Content Claim selection. |
allNutrientContentClaims - [EvaluatedNutrientContentClaim]
|
All Nutrient Content Claims for the selection. |
selectedNutrientContentClaims - [SelectedNutrientContentClaim]
|
The selected Nutrient Content Claims for the selection. |
Example
{
"racc": Amount,
"regulation": Regulation,
"referenceFood": Recipe,
"allNutrientContentClaims": [
EvaluatedNutrientContentClaim
],
"selectedNutrientContentClaims": [
SelectedNutrientContentClaim
]
}
NewDocumentTag
Description
A tag for a document.
Fields
| Field Name | Description |
|---|---|
tag - Tag
|
The tag. |
documentType - EntityType
|
The type of document the tag is for. |
Example
{"tag": Tag, "documentType": "Ingredient"}
Note
Description
A note for a food.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the note. |
text - String
|
The text of the note. |
eshaUser - EshaUser
|
The user who created the note. |
created - DateTimeOffset
|
The date and time the note was created. |
modified - DateTimeOffset
|
The date and time the note was last modified. |
Example
{
"id": "4",
"text": "abc123",
"eshaUser": EshaUser,
"created": DateTimeOffset,
"modified": DateTimeOffset
}
NoteInput
Description
A note.
Fields
| Input Field | Description |
|---|---|
text - String
|
The text of the note. |
eshaUserId - ID
|
Identifies which user created the note. For newly created notes, it can be set to null. |
created - DateTimeOffset
|
The date and time the note was created. |
modified - DateTimeOffset
|
The date and time the note was last modified. |
Example
{}
Nutrient
Description
A nutrient.
Fields
| Field Name | Description |
|---|---|
name - String!
|
The name of the nutrient. |
id - ID!
|
The unique identifier of the nutrient. |
abbreviation - String
|
The abbreviation of the nutrient. |
isScalar - Boolean!
|
Whether the nutrient is scalar. |
unit - Unit
|
The unit of the nutrient. |
precision - Int
|
The precision of the nutrient. |
legacyKey - Int
|
The legacy key of the nutrient. |
standardKey - StandardNutrients
|
The standard key of the nutrient. |
nutrientCategory - NutrientCategory
|
The category of the nutrient. |
isCalculated - Boolean!
|
Whether the nutrient is calculated. |
isDeleted - Boolean!
|
Whether the nutrient is deleted. |
Example
{
"name": "abc123",
"id": 4,
"abbreviation": "xyz789",
"isScalar": false,
"unit": Unit,
"precision": 123,
"legacyKey": 987,
"standardKey": "Calories",
"nutrientCategory": "None",
"isCalculated": true,
"isDeleted": true
}
NutrientAnalysis
Fields
| Field Name | Description |
|---|---|
parentFoodMeasure - String
|
|
parentFoodQuantity - Float
|
|
parentFoodNutrients - [SimpleNutrientAnalysis]
|
|
nutrientAnalysisItems - [NutrientAnalysisItem]
|
Example
{
"parentFoodMeasure": "xyz789",
"parentFoodQuantity": 987.65,
"parentFoodNutrients": [SimpleNutrientAnalysis],
"nutrientAnalysisItems": [NutrientAnalysisItem]
}
NutrientAnalysisItem
Fields
| Field Name | Description |
|---|---|
name - String
|
|
measure - String
|
|
isRecipe - Boolean
|
|
quantity - Float
|
|
unitAbbreviation - String
|
|
gramWeight - Float
|
|
unitConversionFactor - Float
|
|
items - [NutrientAnalysisItem]
|
|
nutrients - [SimpleNutrientAnalysis]
|
Example
{
"name": "abc123",
"measure": "xyz789",
"isRecipe": false,
"quantity": 123.45,
"unitAbbreviation": "abc123",
"gramWeight": 987.65,
"unitConversionFactor": 987.65,
"items": [NutrientAnalysisItem],
"nutrients": [SimpleNutrientAnalysis]
}
NutrientAnalysisPayload
Fields
| Field Name | Description |
|---|---|
nutrientAnalysis - NutrientAnalysis
|
Example
{"nutrientAnalysis": NutrientAnalysis}
NutrientCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
NutrientContentClaim
Description
A nutrient content claim.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the nutrient content claim. |
regulationNutrient - RegulationNutrient
|
The nutrient of the nutrient content claim. |
claimType - NccClaimType
|
The type of the nutrient content claim. |
defaultClaimTextOption - NutrientContentClaimText
|
The default claim text option. |
claimTextOptions - [NutrientContentClaimText]
|
The claim text options. |
nccCitations - [NutrientContentClaimCitation]
|
The citations for the nutrient content claim. |
citations - String
|
The citations for the nutrient content claim. |
nccConditionId - ID!
|
The condition id of the nutrient content claim. |
legacyNutrientKey - Int!
|
The legacy nutrient key of the nutrient content claim. |
legacyGroupKey - Int!
|
The legacy group key of the nutrient content claim. |
calculationMethod - CalculationMethod
|
The calculation method of the nutrient content claim. |
Example
{
"id": "4",
"regulationNutrient": RegulationNutrient,
"claimType": "Free",
"defaultClaimTextOption": NutrientContentClaimText,
"claimTextOptions": [NutrientContentClaimText],
"nccCitations": [NutrientContentClaimCitation],
"citations": "abc123",
"nccConditionId": "4",
"legacyNutrientKey": 123,
"legacyGroupKey": 987,
"calculationMethod": "NUTRIENT_VALUE"
}
NutrientContentClaimCitation
Description
A citation for a nutrient content claim.
Fields
| Field Name | Description |
|---|---|
language - Language
|
The language of the citation. |
citation - String
|
The citation text. |
qualifyingCondition - String
|
The qualifying condition for the citation. |
additionalInformation - String
|
Additional information for the citation. |
localizationKey - String
|
The localization key for the citation. |
Example
{
"language": Language,
"citation": "abc123",
"qualifyingCondition": "xyz789",
"additionalInformation": "abc123",
"localizationKey": "abc123"
}
NutrientContentClaimText
Description
A nutrient content claim text.
Example
{
"id": Guid,
"claimText": "abc123",
"legacyTermKey": 987
}
NutrientInfo
Description
Nutrient information for a food item.
Example
{
"value": 123.45,
"calculated": 987.65,
"overridden": 987.65,
"unknown": 123.45,
"nutrient": Nutrient
}
NutrientListPayload
Fields
| Field Name | Description |
|---|---|
nutrients - [Nutrient!]!
|
Example
{"nutrients": [Nutrient]}
NutrientPercent
NutrientProfile
Description
A nutrient profile for a food item.
Fields
| Field Name | Description |
|---|---|
definingAmount - Amount!
|
The amount that defines the nutrient profile. |
nutrients - [NutrientQuantity!]!
|
The nutrients in the nutrient profile. |
Example
{
"definingAmount": Amount,
"nutrients": [NutrientQuantity]
}
NutrientQuantity
NutrientQuery
Description
Queries for nutrients.
Fields
| Field Name | Description |
|---|---|
getStandard - NutrientListPayload
|
Get all standard nutrients. |
getUserAdded - PaginatedNutrientListPayload
|
Get all user added nutrients. |
Arguments
|
|
getCustomNutrientsUsedInFood - NutrientListPayload
|
Get all custom nutrients used in food. |
getUserAddedNutrientsInUse - NutrientListPayload
|
Get all user added nutrients in use. |
Example
{
"getStandard": NutrientListPayload,
"getUserAdded": PaginatedNutrientListPayload,
"getCustomNutrientsUsedInFood": NutrientListPayload,
"getUserAddedNutrientsInUse": NutrientListPayload
}
NutrientValueInput
NutrientsToView
Description
A collection of nutrients to view.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier for the NutrientsToView. |
name - String!
|
The name of the NutrientsToView. |
modified - DateTimeOffset
|
The date and time the NutrientsToView was last modified. |
standardKey - StandardNutrientsToView
|
The standard key for the NutrientsToView. |
authority - Authority
|
The authority for the NutrientsToView. |
isForAllAuthorities - Boolean
|
Whether the NutrientsToView is for all authorities. |
isUsedInFood - Boolean!
|
Whether the NutrientsToView is used in food. |
nutrients - [Nutrient!]!
|
The nutrients in the NutrientsToView. |
Example
{
"id": "4",
"name": "abc123",
"modified": DateTimeOffset,
"standardKey": "None",
"authority": Authority,
"isForAllAuthorities": false,
"isUsedInFood": false,
"nutrients": [Nutrient]
}
NutrientsToViewPayload
Fields
| Field Name | Description |
|---|---|
nutrientsToView - NutrientsToView
|
Example
{"nutrientsToView": NutrientsToView}
PageInfo
Description
Information about a page of data.
Example
{"cursor": 987, "hasNextPage": true, "startCursor": 987, "endCursor": 987}
PaginatedAuthorityListPayload
Fields
| Field Name | Description |
|---|---|
authorities - [Authority!]!
|
|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
Example
{
"authorities": [Authority],
"totalCount": 123,
"pageInfo": PageInfo
}
PaginatedCustomFieldListPayload
Fields
| Field Name | Description |
|---|---|
customFields - [CustomField!]!
|
|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
Example
{
"customFields": [CustomField],
"totalCount": 987,
"pageInfo": PageInfo
}
PaginatedDocumentEntitiesPayload
Fields
| Field Name | Description |
|---|---|
documentEntities - [DocumentInterface!]!
|
|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
Example
{
"documentEntities": [DocumentInterface],
"totalCount": 987,
"pageInfo": PageInfo
}
PaginatedDocumentSearchResultPayload
Fields
| Field Name | Description |
|---|---|
documents - [DocumentSearchResultInterface]
|
|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
Example
{
"documents": [DocumentSearchResultInterface],
"totalCount": 123,
"pageInfo": PageInfo
}
PaginatedFoodAttributeListPayload
Fields
| Field Name | Description |
|---|---|
foodAttributes - [FoodAttribute!]!
|
|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
Example
{
"foodAttributes": [FoodAttribute],
"totalCount": 123,
"pageInfo": PageInfo
}
PaginatedFoodSearchResultPayload
Fields
| Field Name | Description |
|---|---|
foodSearchResults - [FoodSearchResult!]!
|
|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
Example
{
"foodSearchResults": [FoodSearchResult],
"totalCount": 123,
"pageInfo": PageInfo
}
PaginatedLabelListPayload
PaginatedLabelSearchResultPayload
Fields
| Field Name | Description |
|---|---|
labelSearchResults - [LabelSearchResult!]!
|
|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
Example
{
"labelSearchResults": [LabelSearchResult],
"totalCount": 123,
"pageInfo": PageInfo
}
PaginatedNutrientContentClaimsPayload
Fields
| Field Name | Description |
|---|---|
nutrientContentClaims - [NutrientContentClaim!]!
|
|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
Example
{
"nutrientContentClaims": [NutrientContentClaim],
"totalCount": 123,
"pageInfo": PageInfo
}
PaginatedNutrientListPayload
Fields
| Field Name | Description |
|---|---|
nutrients - [Nutrient!]!
|
|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
Example
{
"nutrients": [Nutrient],
"totalCount": 123,
"pageInfo": PageInfo
}
PaginatedProductListPayload
PaginatedRecommendationListPayload
Fields
| Field Name | Description |
|---|---|
recommendations - [Recommendation!]!
|
|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
Example
{
"recommendations": [Recommendation],
"totalCount": 987,
"pageInfo": PageInfo
}
PaginatedRecommendationProfileListPayload
Fields
| Field Name | Description |
|---|---|
recommendationProfiles - [RecommendationProfile!]!
|
|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
Example
{
"recommendationProfiles": [RecommendationProfile],
"totalCount": 123,
"pageInfo": PageInfo
}
PaginatedRegulationListPayload
Fields
| Field Name | Description |
|---|---|
regulations - [Regulation!]!
|
|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
Example
{
"regulations": [Regulation],
"totalCount": 123,
"pageInfo": PageInfo
}
PaginatedSupplierListPayload
Fields
| Field Name | Description |
|---|---|
suppliers - [Supplier]
|
|
totalCount - Int!
|
|
pageInfo - PageInfo!
|
Example
{
"suppliers": [Supplier],
"totalCount": 987,
"pageInfo": PageInfo
}
PaginatedTagListPayload
PalHeader
Description
A pal header.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the pal header. |
header - String!
|
The name of the pal header. |
regulation - Regulation!
|
The regulation for the pal header. |
language - Language!
|
The language for the pal header. |
Example
{
"id": "4",
"header": "abc123",
"regulation": Regulation,
"language": Language
}
PalHeaderInput
PercentDailyValuesInput
Fields
| Input Field | Description |
|---|---|
recommendationProfileId - ID
|
Example
{}
Product
ProductListPayload
Fields
| Field Name | Description |
|---|---|
products - [Product!]!
|
Example
{"products": [Product]}
ProductQuery
Description
Queries for products.
Fields
| Field Name | Description |
|---|---|
getStandard - ProductListPayload
|
Get all standard products. |
getUserAdded - PaginatedProductListPayload
|
Get all user added products. |
Arguments
|
|
getUserAddedProductsInUse - ProductListPayload
|
Get all user added products in use. |
Example
{
"getStandard": ProductListPayload,
"getUserAdded": PaginatedProductListPayload,
"getUserAddedProductsInUse": ProductListPayload
}
Quantity
Description
A quantity of a food item.
Fields
| Field Name | Description |
|---|---|
value - String!
|
The value of the quantity. |
quantityType - QuantityType!
|
|
type - String
|
The type of the quantity. Use QuantityType field instead. |
Example
{
"value": "xyz789",
"quantityType": "Double",
"type": "abc123"
}
QuantityType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
RecentDocumentsInput
Fields
| Input Field | Description |
|---|---|
documentTypes - [DocumentType]
|
|
versionFilter - VersionFilter
|
|
documentStatusFilter - DocumentStatusFilter
|
|
first - Int
|
|
after - Int
|
Example
{}
RecentFoodsInput
Fields
| Input Field | Description |
|---|---|
foodTypes - [FoodType]
|
|
versionFilter - VersionFilter
|
|
documentStatusFilter - DocumentStatusFilter
|
|
first - Int
|
|
after - Int
|
Example
{}
RecentLabelsInput
Fields
| Input Field | Description |
|---|---|
versionFilter - VersionFilter
|
|
documentStatusFilter - DocumentStatusFilter!
|
|
first - Int
|
|
after - Int
|
Example
{}
Recipe
Description
A recipe food item.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the food item. |
name - String!
|
The name of the food item. |
modified - DateTimeOffset!
|
The date the food item was last modified. |
created - DateTimeOffset!
|
The date the food item was created. |
isApproved - Boolean!
|
Whether the food item is approved. |
version - Version!
|
The version of the food item. |
versionHistory - VersionHistory!
|
The version history of the food item. |
notes - [Note!]!
|
The notes for the food item. |
attachments - [FileAttachment!]!
|
The attachments for the food item. |
tags - [Tag!]!
|
The tags for the food item. |
customFields - [CustomFieldValue!]!
|
The custom fields for the food item. |
isArchived - Boolean!
|
Whether the food item is archived. |
documentType - DocumentType!
|
|
definingAmount - Amount!
|
The amount of the food. |
foodType - FoodType
|
The type of the food. |
items - [FoodItem!]!
|
The items that make up the food. |
amountCost - AmountCost
|
The cost of the food. |
eshaCode - Int
|
Use ItemCode |
itemCode - Int
|
The Item code of the food. |
image - ImageAttachment
|
The image for the food. |
conversions - [Conversion!]!
|
The conversions for the food. |
product - Product
|
The product of the food. |
supplier - Supplier
|
The supplier of the food. |
glycemicIndex - Quantity
|
The glycemic index of the food. |
aliases - [Alias!]!
|
The aliases for the food. |
hasVolumeMeasures - Boolean!
|
Whether the food has volume measures. |
discreteMeasures - [Unit!]!
|
The discrete measures of the food. |
legacyKey - Int
|
The legacy key of the food. |
yieldKey - Int
|
The yield key of the food. |
yields - Yields
|
The yields of the food. |
allergensVerified - Boolean!
|
Whether the allergens are verified. |
allergenStatements - [AllergenStatement!]!
|
The allergen statements for the food. |
regulationSettings - [RegulationSetting!]!
|
The collection of regulation settings associated with this food. |
glycemicLoad - Quantity
|
The glycemic load of the food. |
pdcaas - Float
|
The protein digestibility-corrected amino acid score of the food. |
per - Float
|
The protein efficiency ratio of the food. |
alerts - [FoodAlertInterface!]!
|
The alerts for the food. |
Arguments
|
|
attributes - [FoodAttributeElement!]!
|
The attributes of the food. |
allergens - [FoodAllergen!]!
|
The allergens for the food. |
authorities - [Authority!]!
|
The authorities for the food. |
displayNutrientsToView - NutrientsToView
|
The nutrients to display for the food. |
analyzedAllergens - [FoodAllergen!]!
|
The allergens that the food contains. |
analysis - Analysis
|
The analysis for the food. |
Arguments
|
|
convertAmount - Amount
|
Converts the amount of the food. |
Arguments
|
|
itemsGramYield - Float!
|
The yield of the food based solely off of the yield weight of its food items. If the food has no items it will return a value of 0. |
analyzedCost - Decimal
|
The analyzed cost of the food. |
Arguments
|
|
isInUse - Boolean!
|
Whether the food is in use. |
cookMethod - String
|
The method used to cook the food. |
cookTemperature - String
|
The temperature at which the food is cooked. |
cookTime - String
|
The time it takes to cook the food. |
instructions - String
|
The instructions for cooking the food. |
panSize - String
|
The size of the pan used to cook the food. |
preparationTime - String
|
The time it takes to prepare the food. |
specificGravityOverride - Float
|
The user set specific gravity. |
analysisOverrides - AnalysisOverride!
|
The analysis overrides for the food. |
servingConversion - Conversion!
|
The conversion for the serving size. |
excludeUncostedItems - Boolean!
|
Whether or not to exclude uncosted items. |
nccSelectionDetails - [NccSelectionDetails]
|
The NCC selection details for the food. |
brix - BrixPayloadUnion
|
The Brix value of the food. Food must have a volume conversion for us to calculate this value. |
calculatedSpecificGravity - CalculatedSpecificGravityPayloadUnion
|
The value we calculate for specific gravity of the food. Food must have a volume conversion for us to calculate this value. |
specificGravity - Float
|
We now have fields specifically for SpecificGravityOverride and CalculatedSpecificGravity. |
analyzedFoodsWithAttributes - [InheritedAttribute]
|
The analyzed foods with attributes for the food. |
analyzedDesignations - [RegulatoryDesignation!]!
|
The designations of the ingredients contained in the recipe. |
palHeaders - [PalHeader!]!
|
The pal header for the food. |
mexico2020PackagingSymbols - [Mexico2020PackagingSymbol!]!
|
The Packaging Symbols set on a Recipe for the Mexico 2020 Regulation. |
formulationState - FormulationState!
|
Whether the food is a liquid or solid. |
customIngredientStatements - [CustomIngredientStatement!]!
|
The custom ingredient statements set on a recipe. |
generatedIngredientStatement - String
|
|
Arguments
|
|
Example
{
"id": 4,
"name": "xyz789",
"modified": DateTimeOffset,
"created": DateTimeOffset,
"isApproved": false,
"version": Version,
"versionHistory": VersionHistory,
"notes": [Note],
"attachments": [FileAttachment],
"tags": [Tag],
"customFields": [CustomFieldValue],
"isArchived": false,
"documentType": "Ingredient",
"definingAmount": Amount,
"foodType": "Ingredient",
"items": [FoodItem],
"amountCost": AmountCost,
"eshaCode": 123,
"itemCode": 123,
"image": ImageAttachment,
"conversions": [Conversion],
"product": Product,
"supplier": Supplier,
"glycemicIndex": Quantity,
"aliases": [Alias],
"hasVolumeMeasures": true,
"discreteMeasures": [Unit],
"legacyKey": 123,
"yieldKey": 123,
"yields": Yields,
"allergensVerified": false,
"allergenStatements": [AllergenStatement],
"regulationSettings": [RegulationSetting],
"glycemicLoad": Quantity,
"pdcaas": 123.45,
"per": 123.45,
"alerts": [FoodAlertInterface],
"attributes": [FoodAttributeElement],
"allergens": [FoodAllergen],
"authorities": [Authority],
"displayNutrientsToView": NutrientsToView,
"analyzedAllergens": [FoodAllergen],
"analysis": Analysis,
"convertAmount": Amount,
"itemsGramYield": 123.45,
"analyzedCost": Decimal,
"isInUse": false,
"cookMethod": "xyz789",
"cookTemperature": "xyz789",
"cookTime": "xyz789",
"instructions": "abc123",
"panSize": "abc123",
"preparationTime": "xyz789",
"specificGravityOverride": 987.65,
"analysisOverrides": AnalysisOverride,
"servingConversion": Conversion,
"excludeUncostedItems": true,
"nccSelectionDetails": [NccSelectionDetails],
"brix": BrixPayload,
"calculatedSpecificGravity": CalculatedSpecificGravityPayload,
"specificGravity": 987.65,
"analyzedFoodsWithAttributes": [InheritedAttribute],
"analyzedDesignations": [RegulatoryDesignation],
"palHeaders": [PalHeader],
"mexico2020PackagingSymbols": [
Mexico2020PackagingSymbol
],
"formulationState": "Solid",
"customIngredientStatements": [
CustomIngredientStatement
],
"generatedIngredientStatement": "xyz789"
}
RecipePayload
Fields
| Field Name | Description |
|---|---|
recipe - Recipe
|
Example
{"recipe": Recipe}
Recommendation
Description
A recommendation.
Example
{
"id": "4",
"nutrient": Nutrient,
"recommendedValue": Quantity
}
RecommendationProfile
Description
A recommendation profile.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the recommendation profile. |
name - String!
|
The name of the recommendation profile. |
recommendations - [Recommendation]
|
The recommendations for the recommendation profile. |
Example
{
"id": "4",
"name": "abc123",
"recommendations": [Recommendation]
}
Regulation
Description
A regulation.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the regulation. |
name - String!
|
The name of the regulation. |
enacted - DateOnly
|
The date the regulation was enacted. |
retired - DateOnly
|
The date the regulation was retired. |
recommendationProfiles - [RecommendationProfile]
|
The recommendation profiles for the regulation. |
nutrients - [RegulationNutrient]
|
The nutrients for the regulation. |
allergens - [Allergen]
|
The allergens for the regulation. |
labelStyles - [LabelStyle]
|
The label styles for the regulation. |
languages - [RegulationLanguage]
|
The languages for the regulation. |
nutrientContentClaims - [NutrientContentClaim]
|
The nutrient content claims for the regulation. |
regulatoryDesignations - [RegulatoryDesignation]
|
The regulatory designations for the regulation. |
labelText - [TranslatedLabelText]
|
The label text for the regulation. |
Example
{
"id": 4,
"name": "abc123",
"enacted": DateOnly,
"retired": DateOnly,
"recommendationProfiles": [RecommendationProfile],
"nutrients": [RegulationNutrient],
"allergens": [Allergen],
"labelStyles": [LabelStyle],
"languages": [RegulationLanguage],
"nutrientContentClaims": [NutrientContentClaim],
"regulatoryDesignations": [RegulatoryDesignation],
"labelText": [TranslatedLabelText]
}
RegulationLanguage
Description
A language that a regulation can be in.
Example
{
"id": "4",
"name": "xyz789",
"canBePrimaryLanguage": false,
"language": Language
}
RegulationNutrient
Description
A nutrient that is regulated by a regulation.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the regulation nutrient. |
defaultRoundingRule - Int!
|
The default rounding rule of the regulation nutrient. |
names - [TranslatedLabelText]
|
The names of the regulation nutrient. |
indent - Int!
|
The indent of the regulation nutrient. |
isBold - Boolean!
|
Whether the regulation nutrient is bold. |
isCoreNutrient - Boolean!
|
Whether the regulation nutrient is a core nutrient. |
isInline - Boolean!
|
Whether the regulation nutrient is inline. |
isMandatory - Boolean!
|
Whether the regulation nutrient is mandatory. |
isVitaminMineral - Boolean!
|
Whether the regulation nutrient is a vitamin or mineral. |
labelOrder - Int!
|
The label order of the regulation nutrient. |
nutrient - Nutrient
|
The nutrient of the regulation nutrient. |
parentNutrient - RegulationNutrient
|
The parent nutrient of the regulation nutrient. |
nutrientContentClaims - [NutrientContentClaim]
|
The nutrient content claims for the nutrient. |
significanceLevelAmount - Float
|
The significance level amount of the regulation nutrient. |
significanceLevelPercent - Float
|
The significance level percent of the regulation nutrient. |
beverageSignificanceLevelPercent - Float
|
The beverage significance level percent of the regulation nutrient. |
unit - Unit
|
The unit of the regulation nutrient. |
Example
{
"id": 4,
"defaultRoundingRule": 123,
"names": [TranslatedLabelText],
"indent": 123,
"isBold": false,
"isCoreNutrient": true,
"isInline": false,
"isMandatory": false,
"isVitaminMineral": false,
"labelOrder": 123,
"nutrient": Nutrient,
"parentNutrient": RegulationNutrient,
"nutrientContentClaims": [NutrientContentClaim],
"significanceLevelAmount": 987.65,
"significanceLevelPercent": 123.45,
"beverageSignificanceLevelPercent": 123.45,
"unit": Unit
}
RegulationPayload
Fields
| Field Name | Description |
|---|---|
regulation - Regulation
|
Example
{"regulation": Regulation}
RegulationQuery
Description
Queries for regulations.
Fields
| Field Name | Description |
|---|---|
getAuthorities - PaginatedAuthorityListPayload
|
Get all authorities. |
Arguments
|
|
getRegulations - PaginatedRegulationListPayload
|
Get all regulations. |
Arguments
|
|
getRecommendationProfiles - PaginatedRecommendationProfileListPayload
|
Get all recommendation profiles. |
Arguments
|
|
getRecommendations - PaginatedRecommendationListPayload
|
Get all recommendations. |
Arguments
|
|
getNutrientContentClaims - PaginatedNutrientContentClaimsPayload
|
Get all nutrient content claims. |
Arguments
|
|
getDesignations - RegulatoryDesignationsPayload
|
Get all regulatory designations. |
Arguments
|
|
getRegulation - RegulationPayload
|
You can pass in either the Regulation Id or the StandardRegulation. |
Arguments
|
|
Example
{
"getAuthorities": PaginatedAuthorityListPayload,
"getRegulations": PaginatedRegulationListPayload,
"getRecommendationProfiles": PaginatedRecommendationProfileListPayload,
"getRecommendations": PaginatedRecommendationListPayload,
"getNutrientContentClaims": PaginatedNutrientContentClaimsPayload,
"getDesignations": RegulatoryDesignationsPayload,
"getRegulation": RegulationPayload
}
RegulationSetting
Fields
| Field Name | Description |
|---|---|
id - ID
|
The unique identifier of the regulation setting. |
regulation - Regulation
|
The regulation associated with these settings. |
isMultilingual - Boolean!
|
Whether this food is multilingual for this regulation. |
Example
{
"id": 4,
"regulation": Regulation,
"isMultilingual": true
}
RegulationSettingValueInput
RegulatoryDesignation
RegulatoryDesignationsPayload
Fields
| Field Name | Description |
|---|---|
designations - [RegulatoryDesignation!]!
|
Example
{"designations": [RegulatoryDesignation]}
ReindexDocumentInput
Fields
| Input Field | Description |
|---|---|
documentId - ID!
|
Example
{}
RemoveImageInput
Fields
| Input Field | Description |
|---|---|
foodId - ID!
|
Example
{}
RemoveTagFromFoodInput
SearchFieldFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Use ItemCode |
|
|
|
|
|
|
|
|
Example
{}
Seconds
Description
The Seconds scalar type represents a period of time represented as the total number of seconds in range [-922337203685, 922337203685].
Example
{}
SelectedNutrientContentClaim
Description
A selected nutrient content claim.
Fields
| Field Name | Description |
|---|---|
claim - NutrientContentClaim
|
The nutrient content claim. |
selectedText - NutrientContentClaimText
|
The selected text of the nutrient content claim. |
qualifies - NccResultPayload
|
The result of the nutrient content claim evaluation. |
Example
{
"claim": NutrientContentClaim,
"selectedText": NutrientContentClaimText,
"qualifies": NccResultPayload
}
SelectedNutrientContentClaimInput
SetAliasesInput
Fields
| Input Field | Description |
|---|---|
aliases - [AliasInput!]
|
|
foodId - ID!
|
Example
{}
SetAllergenStatementsInput
Fields
| Input Field | Description |
|---|---|
allergenStatements - [AllergenStatementInput]
|
|
foodId - ID!
|
Example
{}
SetAllergensInput
Fields
| Input Field | Description |
|---|---|
foodAllergenInputs - [FoodAllergenInput]
|
|
foodId - ID!
|
Example
{}
SetAllergensVerifiedInput
SetAustraliaNewZealand2016LabelItemInput
SetAustraliaNewZealand2016LabelOptionsInput
Fields
| Input Field | Description |
|---|---|
labelOptions - AustraliaNewZealand2016LabelOptionsInput!
|
|
labelId - ID!
|
Example
{}
SetAustraliaNewZealand2016VoluntaryCustomNutrientsInput
SetAustraliaNewZealand2016VoluntaryNutrientsInput
Fields
| Input Field | Description |
|---|---|
voluntaryNutrients - [AustraliaNewZealand2016VoluntaryNutrients!]!
|
|
labelId - ID!
|
Example
{}
SetAuthoritiesInput
Fields
| Input Field | Description |
|---|---|
foodAuthoritiesInputs - [FoodAuthoritiesInput]
|
|
foodId - ID!
|
Example
{}
SetCanada2016LabelItemsInput
SetCanada2016LabelOptionsInput
Fields
| Input Field | Description |
|---|---|
labelOptions - Canada2016LabelOptionsInput!
|
|
labelId - ID!
|
Example
{}
SetCanada2016LabelStyleInput
Fields
| Input Field | Description |
|---|---|
labelStyle - Canada2016LabelStyles!
|
|
labelId - ID!
|
Example
{}
SetCanada2016VoluntaryNutrientsInput
Fields
| Input Field | Description |
|---|---|
voluntaryNutrients - [Canada2016VoluntaryNutrients!]!
|
|
labelId - ID!
|
Example
{}
SetConversionsInput
Fields
| Input Field | Description |
|---|---|
conversions - [ConversionInput!]
|
|
foodId - ID!
|
Example
{}
SetCookMethodInput
SetCookTemperatureInput
SetCookTimeInput
SetCustomFieldsInput
Fields
| Input Field | Description |
|---|---|
customFieldValues - [CustomFieldInput]
|
|
documentId - ID!
|
Example
{}
SetCustomIngredientStatementInput
Fields
| Input Field | Description |
|---|---|
regulation - StandardRegulations!
|
|
customStatements - [CustomIngredientStatementInput!]!
|
|
foodId - ID!
|
Example
{}
SetDisplayNutrientsToViewInput
SetDocumentNameInput
SetEuropeanUnion2011LabelItemInput
SetEuropeanUnion2011LabelOptionsInput
Fields
| Input Field | Description |
|---|---|
labelOptions - EuropeanUnion2011LabelOptionsInput!
|
|
labelId - ID!
|
Example
{}
SetEuropeanUnion2011VoluntaryNutrientsInput
Fields
| Input Field | Description |
|---|---|
voluntaryNutrients - [EuropeanUnion2011VoluntaryNutrients!]!
|
|
labelId - ID!
|
Example
{}
SetExcludeCostInput
SetFoodAmountCostInput
Fields
| Input Field | Description |
|---|---|
amount - AmountInput
|
|
cost - Decimal!
|
|
foodId - ID!
|
Example
{}
SetFoodAmountInput
Fields
| Input Field | Description |
|---|---|
amount - AmountInput
|
|
foodId - ID!
|
Example
{}
SetFoodAttributesInput
Fields
| Input Field | Description |
|---|---|
foodId - ID!
|
|
foodAttributes - [FoodAttributeValueInput!]
|
Example
{}
SetFoodCreatedInput
Fields
| Input Field | Description |
|---|---|
created - DateTimeOffset!
|
|
foodId - ID!
|
Example
{}
SetFoodItemsInput
Fields
| Input Field | Description |
|---|---|
foodItems - [FoodItemInput]
|
|
foodId - ID!
|
Example
{}
SetFoodModifiedInput
Fields
| Input Field | Description |
|---|---|
modified - DateTimeOffset!
|
|
foodId - ID!
|
Example
{}
SetFoodNameInput
SetFoodNotesInput
Fields
| Input Field | Description |
|---|---|
foodId - ID!
|
|
notes - [NoteInput]
|
Example
{}
SetFoodTagsInput
SetFormulationStateInput
Fields
| Input Field | Description |
|---|---|
formulationState - FormulationState!
|
|
foodId - ID!
|
Example
{}
SetGlycemicIndexInput
SetGovernmentCodeInput
SetIngredientDesignationsInput
SetInstructionsInput
SetLabelNameInput
SetLabelRegulationInput
Fields
| Input Field | Description |
|---|---|
regulation - StandardRegulations
|
|
labelId - ID!
|
Example
{}
SetLegacyKeyInput
SetMexico2020PackagingSymbolsInput
Fields
| Input Field | Description |
|---|---|
packagingSymbols - [Mexico2020PackagingSymbols!]
|
|
foodId - ID!
|
Example
{}
SetNotesInput
Fields
| Input Field | Description |
|---|---|
notes - [NoteInput]
|
|
documentId - ID!
|
Example
{}
SetNumberOfServingsInput
SetNutrientValueInput
SetNutrientValuesInput
Fields
| Input Field | Description |
|---|---|
nutrientValues - [NutrientValueInput]
|
|
foodId - ID!
|
Example
{}
SetPDCAASInput
SetPERInput
SetPalHeadersInput
Fields
| Input Field | Description |
|---|---|
palHeaders - [PalHeaderInput!]
|
|
foodId - ID!
|
Example
{}
SetPanSizeInput
SetPreparationTimeInput
SetProductInput
SetRecipeSpecificGravityInput
SetRegulationSettingInput
SetRegulationSettingsInput
Fields
| Input Field | Description |
|---|---|
foodId - ID!
|
|
regulationSettings - [RegulationSettingValueInput]
|
Example
{}
SetSelectedNutrientContentClaimsInput
Fields
| Input Field | Description |
|---|---|
selectedNutrientContentClaims - [SelectedNutrientContentClaimInput]
|
|
regulationId - ID!
|
|
foodId - ID!
|
Example
{}
SetServingSizeInput
Fields
| Input Field | Description |
|---|---|
servingSize - AmountInput!
|
|
foodId - ID!
|
Example
{}
SetSubIngredientsInput
Fields
| Input Field | Description |
|---|---|
subIngredients - [SubIngredientInput!]
|
|
foodId - ID!
|
Example
{}
SetSupplierInput
SetTagsInput
SetUnitedStates2016LabelItemsInput
SetUnitedStates2016LabelOptionsInput
Fields
| Input Field | Description |
|---|---|
labelOptions - UnitedStates2016LabelOptionsInput!
|
|
labelId - ID!
|
Example
{}
SetUnitedStates2016LabelStyleInput
Fields
| Input Field | Description |
|---|---|
labelStyle - UnitedStates2016LabelStyles!
|
|
labelId - ID!
|
Example
{}
SetUnitedStates2016RecommendationProfileInput
Fields
| Input Field | Description |
|---|---|
recommendationProfile - UnitedStates2016RecommendationProfiles!
|
|
labelId - ID!
|
Example
{}
SetUnitedStates2016VoluntaryNutrientsInput
Fields
| Input Field | Description |
|---|---|
voluntaryNutrients - [UnitedStates2016VoluntaryNutrients!]!
|
|
labelId - ID!
|
Example
{}
SetYieldKeyInput
SetYieldsInput
Description
Sets the following yields on a given food. A null value for the defined fields represents that the food does not have the given yield.
Fields
| Input Field | Description |
|---|---|
moisture - YieldInput
|
|
fat - YieldInput
|
|
processingLoss - AmountInput
|
|
foodId - ID!
|
Example
{}
SimpleNutrientAnalysis
StandardFoodAttributes
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
StandardLabelStyle
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
StandardLanguage
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
StandardNutrients
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
StandardNutrientsToView
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
StandardRegulations
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
StandardTags
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
StandardUnits
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
String
Description
The 'String' scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
{}
SubIngredient
Description
A sub-ingredient of a food item.
Example
{
"name": "abc123",
"suffixText": "abc123",
"percentage": 123.45
}
SubIngredientInput
Supplier
SupplierListPayload
Fields
| Field Name | Description |
|---|---|
suppliers - [Supplier!]!
|
Example
{"suppliers": [Supplier]}
SupplierQuery
Description
Queries for suppliers.
Fields
| Field Name | Description |
|---|---|
getStandard - SupplierListPayload
|
Get all standard suppliers. |
getUserAdded - PaginatedSupplierListPayload
|
Get all user added suppliers. |
Arguments
|
|
getUserAddedSuppliersInUse - SupplierListPayload
|
Get all user added suppliers in use. |
Example
{
"getStandard": SupplierListPayload,
"getUserAdded": PaginatedSupplierListPayload,
"getUserAddedSuppliersInUse": SupplierListPayload
}
Tag
Description
A tag for a food item.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the tag. |
name - String!
|
The name of the tag. |
standardKey - StandardTags
|
The standard key of the tag. |
created - DateTimeOffset
|
The date and time the tag was created. |
Example
{
"id": 4,
"name": "abc123",
"standardKey": "None",
"created": DateTimeOffset
}
TagListPayload
TagQuery
Description
Queries for tags.
Fields
| Field Name | Description |
|---|---|
getStandardFoodTags - TagListPayload
|
Get all standard food tags. |
getUserAddedFoodTags - PaginatedTagListPayload
|
Get all user added food tags. |
Arguments
|
|
getUserAddedFoodTagsInUse - TagListPayload
|
Get all user added food tags in use. |
getUserAddedFoodTagIdsInUse - TagListPayload
|
Get all user added food tag IDs in use. Just use getUserAddedFoodTagsInUse. |
Example
{
"getStandardFoodTags": TagListPayload,
"getUserAddedFoodTags": PaginatedTagListPayload,
"getUserAddedFoodTagsInUse": TagListPayload,
"getUserAddedFoodTagIdsInUse": TagListPayload
}
TranslatedAllergenStatement
Description
A translated allergen statement.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the translated allergen statement. |
statementPrefix - String
|
The prefix of the translated allergen statement. |
voluntaryStatementPrefix - String
|
The prefix of the translated voluntary statement. |
customStatement - String
|
The custom statement of the translated allergen statement. |
customVoluntaryStatement - String
|
The custom statement of the translated voluntary statement. |
language - RegulationLanguage
|
The language of the translated allergen statement. |
Example
{
"id": "4",
"statementPrefix": "abc123",
"voluntaryStatementPrefix": "xyz789",
"customStatement": "xyz789",
"customVoluntaryStatement": "xyz789",
"language": RegulationLanguage
}
TranslatedAllergenStatementInput
Description
A translated allergen statement.
Fields
| Input Field | Description |
|---|---|
regulationLanguageId - ID!
|
The language identifier of the regulation. |
statementPrefix - String
|
The prefix to display before the allergen statement. Ex: Contains ..., Contains: ..., etc.If null, the default prefix for the Regulation will be used. |
voluntaryStatementPrefix - String
|
The prefix to display before the voluntary allergen statement. Ex: May also contain ..., May contain ..., Processed in a facility with ..., etc.If null, the default prefix for the Regulation will be used. |
customVoluntaryStatement - String
|
If null, the program will generate the Voluntary Allergen Statement for the user. |
customStatement - String
|
If null, the program will generate the Allergen Statement for the user. |
Example
{}
TranslatedLabelText
Description
A translated label text.
Example
{
"id": "4",
"aliases": [Alias],
"isAbbreviation": false
}
TranslatedStatement
Description
A statement translated into a specific language.
Fields
| Field Name | Description |
|---|---|
language - RegulationLanguage
|
The language of the translated statement. |
statement - String!
|
The translated statement. |
Example
{
"language": RegulationLanguage,
"statement": "abc123"
}
Unit
Description
A unit of measure.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the unit. |
name - String!
|
The name of the unit. |
abbreviation - String!
|
The abbreviation of the unit. |
standardKey - StandardUnits
|
The standard key of the unit. |
standardKeyValue - Int
|
The standard key value of the unit. |
dimension - Dimension
|
The dimension of the unit. |
Example
{
"id": "4",
"name": "abc123",
"abbreviation": "xyz789",
"standardKey": "Teaspoon",
"standardKeyValue": 123,
"dimension": "Volume"
}
UnitListPayload
Fields
| Field Name | Description |
|---|---|
units - [Unit!]!
|
Example
{"units": [Unit]}
UnitQuery
Description
Queries for units.
Fields
| Field Name | Description |
|---|---|
getStandard - UnitListPayload
|
Get all standard units. |
Example
{"getStandard": UnitListPayload}
UnitedStates2016AggregateAnalyzedData
Fields
| Field Name | Description |
|---|---|
column1 - UnitedStates2016AggregateLabelItem!
|
|
column2 - UnitedStates2016AggregateLabelItem!
|
|
column3 - UnitedStates2016AggregateLabelItem
|
|
column4 - UnitedStates2016AggregateLabelItem
|
|
column5 - UnitedStates2016AggregateLabelItem
|
|
column6 - UnitedStates2016AggregateLabelItem
|
|
column7 - UnitedStates2016AggregateLabelItem
|
|
column8 - UnitedStates2016AggregateLabelItem
|
Example
{
"column1": UnitedStates2016AggregateLabelItem,
"column2": UnitedStates2016AggregateLabelItem,
"column3": UnitedStates2016AggregateLabelItem,
"column4": UnitedStates2016AggregateLabelItem,
"column5": UnitedStates2016AggregateLabelItem,
"column6": UnitedStates2016AggregateLabelItem,
"column7": UnitedStates2016AggregateLabelItem,
"column8": UnitedStates2016AggregateLabelItem
}
UnitedStates2016AggregateLabelItem
Fields
| Field Name | Description |
|---|---|
amount - String!
|
|
nutrients - [LabelNutrient!]!
|
Example
{
"amount": "xyz789",
"nutrients": [LabelNutrient]
}
UnitedStates2016AggregateLabelItemOptions
Fields
| Field Name | Description |
|---|---|
primaryColumnHeading - String!
|
The primary language text that is displayed over the column. |
secondaryColumnHeading - String!
|
The secondary language text that is displayed over the column. |
primaryServingsPerContainerText - String!
|
The primary language Servings per Container text that will appear for the item. |
secondaryServingsPerContainerText - String!
|
The secondary language Servings per Container text that will appear for the item. |
quantity - Float!
|
The Quantity of Item. |
unit - StandardUnits!
|
The Unit of Item. |
Example
{
"primaryColumnHeading": "abc123",
"secondaryColumnHeading": "xyz789",
"primaryServingsPerContainerText": "abc123",
"secondaryServingsPerContainerText": "abc123",
"quantity": 123.45,
"unit": "Teaspoon"
}
UnitedStates2016AggregateLabelItemOptionsInput
Fields
| Input Field | Description |
|---|---|
primaryColumnHeading - String!
|
The primary language text that is displayed over the column. Default = "" |
secondaryColumnHeading - String!
|
The secondary language text that is displayed over the column. Default = "" |
primaryServingsPerContainerText - String!
|
The primary language Servings per Container text that will appear for the item. Default = "" |
secondaryServingsPerContainerText - String!
|
The secondary language Servings per Container text that will appear for the item. Default = "" |
quantity - Float!
|
The Quantity of Item. Default = 1 |
unit - StandardUnits!
|
The Unit of Item. Default = Serving |
Example
{}
UnitedStates2016AggregateLabelOptions
Description
Label Options specifically for the United States 2016 Aggregate Label. These options are only saved/retrieved when Foods have been added to the Label.
Fields
| Field Name | Description |
|---|---|
item1Options - UnitedStates2016AggregateLabelItemOptions!
|
|
item2Options - UnitedStates2016AggregateLabelItemOptions!
|
|
item3Options - UnitedStates2016AggregateLabelItemOptions
|
|
item4Options - UnitedStates2016AggregateLabelItemOptions
|
|
item5Options - UnitedStates2016AggregateLabelItemOptions
|
|
item6Options - UnitedStates2016AggregateLabelItemOptions
|
|
item7Options - UnitedStates2016AggregateLabelItemOptions
|
|
item8Options - UnitedStates2016AggregateLabelItemOptions
|
Example
{
"item1Options": UnitedStates2016AggregateLabelItemOptions,
"item2Options": UnitedStates2016AggregateLabelItemOptions,
"item3Options": UnitedStates2016AggregateLabelItemOptions,
"item4Options": UnitedStates2016AggregateLabelItemOptions,
"item5Options": UnitedStates2016AggregateLabelItemOptions,
"item6Options": UnitedStates2016AggregateLabelItemOptions,
"item7Options": UnitedStates2016AggregateLabelItemOptions,
"item8Options": UnitedStates2016AggregateLabelItemOptions
}
UnitedStates2016AggregateLabelOptionsInput
Description
Label Options specifically for the United States 2016 Aggregate Label. These options are only saved/retrieved when Foods have been added to the Label.
Fields
| Input Field | Description |
|---|---|
item1Options - UnitedStates2016AggregateLabelItemOptionsInput!
|
|
item2Options - UnitedStates2016AggregateLabelItemOptionsInput!
|
|
item3Options - UnitedStates2016AggregateLabelItemOptionsInput
|
|
item4Options - UnitedStates2016AggregateLabelItemOptionsInput
|
|
item5Options - UnitedStates2016AggregateLabelItemOptionsInput
|
|
item6Options - UnitedStates2016AggregateLabelItemOptionsInput
|
|
item7Options - UnitedStates2016AggregateLabelItemOptionsInput
|
|
item8Options - UnitedStates2016AggregateLabelItemOptionsInput
|
Example
{}
UnitedStates2016AnalyzedData
Example
{}
UnitedStates2016CaloriesCalculationMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
UnitedStates2016DailyValueFootnotes
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
UnitedStates2016DualAnalyzedData
Fields
| Field Name | Description |
|---|---|
servingSize - String!
|
|
column1Nutrients - [LabelNutrient!]!
|
|
column2Nutrients - [LabelNutrient!]!
|
Example
{
"servingSize": "xyz789",
"column1Nutrients": [LabelNutrient],
"column2Nutrients": [LabelNutrient]
}
UnitedStates2016DualLabelOptions
Description
Label Options specifically for the United States 2016 Dual Column Label. These options are only saved/retrieved when Foods have been added to the Label.
Fields
| Field Name | Description |
|---|---|
primaryColumn1Heading - String!
|
The primary language text that is displayed over the first column. |
secondaryColumn1Heading - String!
|
The secondary language text that is displayed over the first column. |
column1Quantity - Float!
|
The Quantity of Column 1 |
column1Unit - StandardUnits!
|
The Unit of Column 1 |
primaryColumn2Heading - String!
|
The primary language text that is displayed over the second column. |
secondaryColumn2Heading - String!
|
The secondary language text that is displayed over the second column. |
column2Quantity - Float!
|
The Quantity of Column 2 |
column2Unit - StandardUnits!
|
The Unit of Column 2 |
Example
{
"primaryColumn1Heading": "xyz789",
"secondaryColumn1Heading": "abc123",
"column1Quantity": 987.65,
"column1Unit": "Teaspoon",
"primaryColumn2Heading": "abc123",
"secondaryColumn2Heading": "abc123",
"column2Quantity": 123.45,
"column2Unit": "Teaspoon"
}
UnitedStates2016DualLabelOptionsInput
Description
Label Options specifically for the United States 2016 Dual Column Label. These options are only saved/retrieved when Foods have been added to the Label.
Fields
| Input Field | Description |
|---|---|
primaryColumn1Heading - String!
|
The primary language text that is displayed over the first column. Default = "" |
secondaryColumn1Heading - String!
|
The secondary language text that is displayed over the first column. Default = "" |
column1Quantity - Float!
|
The Quantity of Column 1. Default = 1 |
column1Unit - StandardUnits!
|
The Unit of Column 1. Default = Serving |
primaryColumn2Heading - String!
|
The primary language text that is displayed over the second column. Default = "" |
secondaryColumn2Heading - String!
|
The secondary language text that is displayed over the second column. Default = "" |
column2Quantity - Float!
|
The Quantity of Column 2. Default = 1 |
column2Unit - StandardUnits!
|
The Unit of Column 2. Default = Serving |
Example
{}
UnitedStates2016LabelDetails
Fields
| Field Name | Description |
|---|---|
labelOptions - UnitedStates2016LabelOptions!
|
The Label Options that are set on the Label. |
analyzedData - UnitedStates2016AnalyzedData
|
Information for the Label that is determined by the Food(s) added to it. Will return null if the number of items is not correct for the given label. |
Example
{
"labelOptions": UnitedStates2016LabelOptions,
"analyzedData": UnitedStates2016StandardAnalyzedData
}
UnitedStates2016LabelOptions
Fields
| Field Name | Description |
|---|---|
shortenDailyValueToDV - Boolean!
|
Shorten %Daily Value to %DV |
templateStyle - UnitedStates2016TemplateStyle!
|
The style of label. The simplified format may only be used if eight or more of the following nutrients are present in insignificant amounts: Calories, Total Fat, Saturated Fat, Trans Fat, Cholesterol, Sodium, Total Carbohydrate, Dietary Fiber, Total Sugars, Added Sugars, Protein, Vitamin D, Calcium, Iron, and Potassium. |
useAllAbbreviations - Boolean!
|
Uses abbreviations for the nutrients that appear on the label. |
hideQuantitativeValuesForVoluntaryNutrients - Boolean!
|
Hide quantitative values for voluntary nutrients only. |
hideQuantitativeValuesForMandatoryVitaminsMinerals - Boolean!
|
Hide quantitative values for Vitamin D, Calcium, Iron, and Potassium. |
putVitaminsAndMineralsInTwoColumns - Boolean!
|
Puts Vitamins and Minerals in two columns for the Standard / Vertical Label. |
abbreviateWhenInTwoColumns - Boolean!
|
Abbreviates Vitamin and Mineral names when they are displayed in two columns. |
dailyValueFootnote - UnitedStates2016DailyValueFootnotes!
|
How the %Daily Value Footnote is displayed. |
useNotASignificantSourceOfOtherNutrients - Boolean!
|
Use "Not a significant source of other nutrients" as the footnote in a Simplified Label. |
thisIsASingleIngredientSugarProduct - Boolean!
|
This will display Added Sugar in the footnotes section. |
primaryHouseholdServingSizeText - String!
|
The Household serving size for the Primary Language on the Label. |
secondaryHouseholdServingSizeText - String!
|
The Household serving size for the Secondary Language on the Label. |
primaryServingsPerContainerText - String!
|
The Servings per container that will appear for the Primary Language on the Label. |
secondaryServingsPerContainerText - String!
|
The Servings per container that will appear for the Secondary Language on the Label. |
hideServingsPerContainer - Boolean!
|
Hides Servings per container from appearing on the Label. |
hideServingSizeAmount - Boolean!
|
Hides the Serving Size amount from appearing on the Label. |
showServingSizeAmountInMl - Boolean!
|
Displays the Serving Size amount milliliters. |
useUnroundedValuesToCalculatePercentDV - Boolean!
|
The %DV is calculated using unrounded nutrient values |
caloriesCalculationMethod - UnitedStates2016CaloriesCalculationMethod!
|
How calories are calculated and appear on the Label |
italicizeTransFat - Boolean!
|
Italicizes Trans Fat |
cholesterolLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Cholesterol is between 2mg and 5mg. |
carbohydratesLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Carbohydrates is between 0.5 and 1g. |
dietaryFiberLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Dietary Fiber is less than 1g. |
totalSugarsLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Total Sugars is less than 1g. |
addedSugarsLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Added Sugars is less than 1g. |
proteinLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Protein is less than 1g. |
solubleFiberLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Soluble Fiber is between 0.5 and 1g. |
insolubleFiberLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Insoluble Fiber is between 0.5 and 1g. |
sugarAlcoholLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Sugar Alcohol is less than 1g. |
proteinShowPercentDV - Boolean!
|
Displays the %DV for Protein on the Label. A PDCAAS / PER value must be populated on the Food. |
proteinShowNotASignificantSourceOnChildLabels - Boolean!
|
Show "not a significant source of protein" text on child labels when applicable. |
vitaminDShowIU - Boolean!
|
Show IU in parentheses after mcg. |
vitaminCName - UnitedStates2016VitaminCNames!
|
How Vitamin C is dispalyed on the Label. |
vitaminB1Name - UnitedStates2016VitaminB1Names!
|
How Vitamin B1 is dispalyed on the Label. |
vitaminB2Name - UnitedStates2016VitaminB2Names!
|
How Vitamin B2 is dispalyed on the Label. |
showFolicAcidParenthetically - Boolean!
|
Show Folic Acid parenthetically. |
tabularFootnoteLocation - UnitedStates2016TabularFootnoteLocation!
|
Where the footnote is diaplyed on a Tabular Label. |
makeAllText6Point - Boolean!
|
Makes all text 6 point on a Linear Label. |
secondaryLanguage - UnitedStates2016SecondaryLanguage!
|
The secondary language that will appear on the Label. Set this to make a Bilingual Label. |
dualOptions - UnitedStates2016DualLabelOptions
|
Options for the Dual Column LabelStyle. Will not save and return null when the Label does not have 2 Foods added to it. |
aggregateOptions - UnitedStates2016AggregateLabelOptions
|
Options for the Aggregate LabelStyle. Will not save and return null when the Label does not have at least 2 Foods added to it. |
Example
{
"shortenDailyValueToDV": false,
"templateStyle": "Full",
"useAllAbbreviations": false,
"hideQuantitativeValuesForVoluntaryNutrients": false,
"hideQuantitativeValuesForMandatoryVitaminsMinerals": true,
"putVitaminsAndMineralsInTwoColumns": true,
"abbreviateWhenInTwoColumns": true,
"dailyValueFootnote": "ShowFull",
"useNotASignificantSourceOfOtherNutrients": true,
"thisIsASingleIngredientSugarProduct": true,
"primaryHouseholdServingSizeText": "abc123",
"secondaryHouseholdServingSizeText": "xyz789",
"primaryServingsPerContainerText": "abc123",
"secondaryServingsPerContainerText": "xyz789",
"hideServingsPerContainer": false,
"hideServingSizeAmount": false,
"showServingSizeAmountInMl": false,
"useUnroundedValuesToCalculatePercentDV": true,
"caloriesCalculationMethod": "TotalOfAllIngredients",
"italicizeTransFat": false,
"cholesterolLessThanDisplay": "RoundValue",
"carbohydratesLessThanDisplay": "RoundValue",
"dietaryFiberLessThanDisplay": "RoundValue",
"totalSugarsLessThanDisplay": "RoundValue",
"addedSugarsLessThanDisplay": "RoundValue",
"proteinLessThanDisplay": "RoundValue",
"solubleFiberLessThanDisplay": "RoundValue",
"insolubleFiberLessThanDisplay": "RoundValue",
"sugarAlcoholLessThanDisplay": "RoundValue",
"proteinShowPercentDV": false,
"proteinShowNotASignificantSourceOnChildLabels": false,
"vitaminDShowIU": true,
"vitaminCName": "VitaminC",
"vitaminB1Name": "Thiamin",
"vitaminB2Name": "Riboflavin",
"showFolicAcidParenthetically": true,
"tabularFootnoteLocation": "Bottom",
"makeAllText6Point": false,
"secondaryLanguage": "None",
"dualOptions": UnitedStates2016DualLabelOptions,
"aggregateOptions": UnitedStates2016AggregateLabelOptions
}
UnitedStates2016LabelOptionsInput
Fields
| Input Field | Description |
|---|---|
shortenDailyValueToDV - Boolean!
|
Shorten %Daily Value to %DV. Default = false |
templateStyle - UnitedStates2016TemplateStyle!
|
The style of label. The simplified format may only be used if eight or more of the following nutrients are present in insignificant amounts: Calories, Total Fat, Saturated Fat, Trans Fat, Cholesterol, Sodium, Total Carbohydrate, Dietary Fiber, Total Sugars, Added Sugars, Protein, Vitamin D, Calcium, Iron, and Potassium. Default = Full |
useAllAbbreviations - Boolean!
|
Uses abbreviations for the nutrients that appear on the label. Default = false |
hideQuantitativeValuesForVoluntaryNutrients - Boolean!
|
Hide quantitative values for voluntary nutrients only. Default = false |
hideQuantitativeValuesForMandatoryVitaminsMinerals - Boolean!
|
Hide quantitative values for Vitamin D, Calcium, Iron, and Potassium. Default = false |
putVitaminsAndMineralsInTwoColumns - Boolean!
|
Puts Vitamins and Minerals in two columns for the Standard / Vertical Label. Default = false |
abbreviateWhenInTwoColumns - Boolean!
|
Abbreviates Vitamin and Mineral names when they are displayed in two columns. Default = false |
dailyValueFootnote - UnitedStates2016DailyValueFootnotes!
|
How the %Daily Value Footnote is displayed. Default = ShowFull |
useNotASignificantSourceOfOtherNutrients - Boolean!
|
Use "Not a significant source of other nutrients" as the footnote in a Simplified Label. Default = false |
thisIsASingleIngredientSugarProduct - Boolean!
|
This will display Added Sugar in the footnotes section. Default = false |
primaryHouseholdServingSizeText - String!
|
The Household serving size for the Primary Language on the Label. Default = "" |
secondaryHouseholdServingSizeText - String!
|
The Household serving size for the Secondary Language on the Label. Default = "" |
primaryServingsPerContainerText - String!
|
The Servings per container that will appear for the Primary Language on the Label. Default = "" |
secondaryServingsPerContainerText - String!
|
The Servings per container that will appear for the Secondary Language on the Label. Default = "" |
hideServingsPerContainer - Boolean!
|
Hides Servings per container from appearing on the Label. Default = false |
hideServingSizeAmount - Boolean!
|
Hides the Serving Size amount from appearing on the Label. Default = false |
showServingSizeAmountInMl - Boolean!
|
Displays the Serving Size amount milliliters. Default = false |
useUnroundedValuesToCalculatePercentDV - Boolean!
|
The %DV is calculated using unrounded nutrient values. Default = false |
caloriesCalculationMethod - UnitedStates2016CaloriesCalculationMethod!
|
How calories are calculated and appear on the Label. Default = TotalOfAllIngredients |
italicizeTransFat - Boolean!
|
Italicizes Trans Fat. Default = false |
cholesterolLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Cholesterol is between 2mg and 5mg. Default = RoundValue |
carbohydratesLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Carbohydrates is between 0.5 and 1g. Default = RoundValue |
dietaryFiberLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Dietary Fiber is less than 1g. Default = RoundValue |
totalSugarsLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Total Sugars is less than 1g. Default = RoundValue |
addedSugarsLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Added Sugars is less than 1g. Default = RoundValue |
proteinLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Protein is less than 1g. Default = RoundValue |
solubleFiberLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Soluble Fiber is between 0.5 and 1g. Default = RoundValue |
insolubleFiberLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Insoluble Fiber is between 0.5 and 1g. Default = RoundValue |
sugarAlcoholLessThanDisplay - UnitedStates2016WhenLessThan!
|
What is displayed when Sugar Alcohol is less than 1g. Default = RoundValue |
proteinShowPercentDV - Boolean!
|
Displays the %DV for Protein on the Label. A PDCAAS / PER value must be populated on the Food. Default = false |
proteinShowNotASignificantSourceOnChildLabels - Boolean!
|
Show "not a significant source of protein" text on child labels when applicable. Default = false |
vitaminDShowIU - Boolean!
|
Show IU in parentheses after mcg. Default = false |
vitaminCName - UnitedStates2016VitaminCNames!
|
How Vitamin C is dispalyed on the Label. Default = VitaminC |
vitaminB1Name - UnitedStates2016VitaminB1Names!
|
How Vitamin B1 is dispalyed on the Label. Default = Thiamin |
vitaminB2Name - UnitedStates2016VitaminB2Names!
|
How Vitamin B2 is dispalyed on the Label. Default = Riboflavin |
showFolicAcidParenthetically - Boolean!
|
Show Folic Acid parenthetically. Default = false |
tabularFootnoteLocation - UnitedStates2016TabularFootnoteLocation!
|
Where the footnote is diaplyed on a Tabular Label. Default = Bottom |
makeAllText6Point - Boolean!
|
Makes all text 6 point on a Linear Label. Default = false |
secondaryLanguage - UnitedStates2016SecondaryLanguage!
|
The secondary language that will appear on the Label. Set this to make a Bilingual Label. Default = None |
dualOptions - UnitedStates2016DualLabelOptionsInput
|
Options for the Dual Column LabelStyle. Will not save and return null when the Label does not have 2 Foods added to it. |
aggregateOptions - UnitedStates2016AggregateLabelOptionsInput
|
Options for the Aggregate LabelStyle. Will not save and return null when the Label does not have at least 2 Foods added to it. |
Example
{}
UnitedStates2016LabelStyles
Description
The Label Styles available for United States 2016.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
UnitedStates2016Mutation
Fields
| Field Name | Description |
|---|---|
create - LabelPayload
|
Creates a United States 2016 Label. |
Arguments |
|
setOptions - LabelPayload
|
Sets the Label Options on a United States 2016 Label. |
Arguments |
|
setVoluntaryNutrients - LabelPayload
|
Sets the Voluntary Nutrients on a United States 2016 Label. |
Arguments |
|
setLabelStyle - LabelPayload
|
Sets the Label Style on a United States 2016 Label. Label Styles DualColumn and Aggregate can only be used with an Adult Recommendation Profile and DualDVsInfantAndChild requires either an Infant or Child Recommendation Profile. This clears all Label Items and returns Label Options to default values. |
Arguments |
|
setRecommendationProfile - LabelPayload
|
Sets the Recommendation Profile on a United States 2016 Label. Label Styles DualColumn and Aggregate can only be used with an Adult Recommendation Profile and DualDVsInfantAndChild requires either an Infant or Child Recommendation Profile. This clears all Label Items and returns Label Options to default values. |
Arguments |
|
setLabelItems - LabelPayload
|
Sets the Label Items on a Label. StandardVertical, Tabular, Linear, and DualDVsInfantAndChild require 1 Food, DualColumn can supply 1 Food for a Per Serving and Per Container Label or supply 2 Foods for a As Prepared Label, and an Aggregate requires at least 2 and at most 8 foods. All Foods are added at 1 Serving and can be edited with LabelOptions. This returns Label Options to default values. |
Arguments |
|
Example
{
"create": LabelPayload,
"setOptions": LabelPayload,
"setVoluntaryNutrients": LabelPayload,
"setLabelStyle": LabelPayload,
"setRecommendationProfile": LabelPayload,
"setLabelItems": LabelPayload
}
UnitedStates2016RecommendationProfiles
Description
The Recommendation Profiles available for United States 2016.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
UnitedStates2016SecondaryLanguage
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
UnitedStates2016StandardAnalyzedData
Fields
| Field Name | Description |
|---|---|
servingSize - String!
|
|
nutrientsPerServing - [LabelNutrient!]!
|
Example
{
"servingSize": "abc123",
"nutrientsPerServing": [LabelNutrient]
}
UnitedStates2016TabularFootnoteLocation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
UnitedStates2016TemplateStyle
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
UnitedStates2016VitaminB1Names
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
UnitedStates2016VitaminB2Names
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
UnitedStates2016VitaminCNames
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
UnitedStates2016VoluntaryNutrients
Description
The Voluntary Nutrients available for United States 2016.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
UnitedStates2016WhenLessThan
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
UpdateFoodConversionInput
Fields
| Input Field | Description |
|---|---|
foodId - ID!
|
|
from - AmountInput
|
|
to - AmountInput
|
Example
{}
Uri
Example
{}
UsedDraftDocumentEntityCantBeDeletedException
Fields
| Field Name | Description |
|---|---|
message - String!
|
Example
{"message": "xyz789"}
UserOptions
Description
User specific options for the Genesis application.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the user options. |
defaultDecimalPlaces - Int
|
The default number of decimal places to display. |
templateFooter - String
|
The footer to use for the user's documents. |
templateSignature - String
|
The signature to use for the user's documents. |
templateLogo - String
|
The logo to use for the user's documents. |
defaultNutrientToView - NutrientsToView
|
The default nutrient to view for the user. |
newDocumentTags - [NewDocumentTag]
|
The tags to apply to new documents. |
userSelectedAuthorities - [UserSelectedAuthority]
|
The authorities that the user has selected. |
showAskRegAlerts - Boolean!
|
Should the alerts generated by Ask Reg be displayed? |
nutrientsToView - [NutrientsToView]
|
The nutrients that the user has selected to view. |
templateSignatureUri - Uri
|
Generates a SaS Uri for the given attachment. |
Arguments
|
|
templateLogoUri - Uri
|
Generates a SaS Uri for the given attachment. |
Arguments
|
|
Example
{
"id": 4,
"defaultDecimalPlaces": 987,
"templateFooter": "abc123",
"templateSignature": "xyz789",
"templateLogo": "abc123",
"defaultNutrientToView": NutrientsToView,
"newDocumentTags": [NewDocumentTag],
"userSelectedAuthorities": [UserSelectedAuthority],
"showAskRegAlerts": true,
"nutrientsToView": [NutrientsToView],
"templateSignatureUri": Uri,
"templateLogoUri": Uri
}
UserOptionsPayload
Fields
| Field Name | Description |
|---|---|
userOptions - UserOptions
|
Example
{"userOptions": UserOptions}
UserOptionsQuery
Description
Queries for user options.
Fields
| Field Name | Description |
|---|---|
getUserOptions - UserOptionsPayload
|
Get user options. |
getNutrientsToView - NutrientsToViewPayload
|
Get nutrients to view. |
Arguments
|
|
Example
{
"getUserOptions": UserOptionsPayload,
"getNutrientsToView": NutrientsToViewPayload
}
UserSelectedAuthority
Description
An authority selected by a user.
Example
{
"id": "4",
"authority": Authority,
"isDefault": true
}
Version
Description
A version of a document entity.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The unique identifier of the version. |
versionName - String
|
The name of the version. |
began - DateTimeOffset
|
The date and time the version began. |
currentPhase - VersionedEntityLifecyclePhase
|
The current phase of the version. |
entity - DocumentInterface
|
The entity the version is for. |
entityId - ID
|
The unique identifier of the entity the version is for. |
approver - EshaUser
|
The user who approved the version. |
approved - DateTimeOffset
|
The date and time the version was approved. |
lifecycle - VersionedEntityLifecycle
|
The lifecycle of the version. |
Example
{
"id": 4,
"versionName": "abc123",
"began": DateTimeOffset,
"currentPhase": VersionedEntityLifecyclePhase,
"entity": DocumentInterface,
"entityId": 4,
"approver": EshaUser,
"approved": DateTimeOffset,
"lifecycle": VersionedEntityLifecycle
}
VersionFilter
Values
| Enum Value | Description |
|---|---|
|
|
'All' returns all versions of a document in search results. |
|
|
'Latest' returns only the most recent version of a document in search results. |
Example
{}
VersionHistory
Description
A history of versions for a versioned entity.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The unique identifier of the version history. |
versions - [Version!]!
|
The versions in the history. |
Example
{
"id": "4",
"versions": [Version]
}
VersionedEntityLifecycle
Description
A lifecycle for a versioned entity.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The unique identifier of the lifecycle. |
phases - [VersionedEntityLifecyclePhase!]!
|
The phases of the lifecycle. |
Example
{
"id": "4",
"phases": [VersionedEntityLifecyclePhase]
}
VersionedEntityLifecyclePhase
Description
A lifecycle phase for a versioned entity.
Example
{
"id": "4",
"isApprovedPhase": false,
"phaseName": "xyz789"
}
Yield
Description
A yield applied to a food item.
Fields
| Field Name | Description |
|---|---|
yieldType - YieldType!
|
The type of yield. |
amount - Amount!
|
The amount of the yield. |
Example
{"yieldType": "Loss", "amount": Amount}
YieldInput
Description
A yield.
Fields
| Input Field | Description |
|---|---|
amount - AmountInput!
|
The amount to be applied for the Yield. The amount specified must have a Percent specified in the UnitId for a Target, and either a Weight or the Percent UnitId for a Loss. |
yieldType - YieldType!
|
The type of yield. |
Example
{}
YieldType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
Yields
Description
Applied to a Gross Analysis to calculate a Net Analysis. The yields are applied to a food in the following order: Moisture, Fat, Percent.
Example
{
"moisture": Yield,
"fat": Yield,
"processingLoss": Amount
}