Skip to content

Specification API (2.0)

Download OpenAPI description
OpenAPISpecification.json
OpenAPISpecification.yaml
Languages
Servers
Production

https://apis.traceone.com/spec/

Sandbox

https://apis-ppd.traceone.com/spec/

Marketing Claim

Operations

Health Claim

Operations

Nutritional Claim

Operations

NutritionalClaims_Get

Request

Path
nutritionalClaimIdstring(uuid)required
curl -i -X GET \
  'https://apis.traceone.com/spec/v2/food/nutritional-claims/{nutritionalClaimId}'

Responses

Returns the nutritional claim

Bodyapplication/json
claimIdstring(uuid)
claimNamestring or null
productTypeIdstring(uuid)
claimTypestring(ClaimTypes)
Enum"marketing""health""nutrition"
substanceIdsArray of strings or null(uuid)(List`1)
nutrientIdsArray of strings or null(uuid)(List`1)
statusstring(LibraryItemStatus)
Enum"draft""published""locked"
versionobject(ObjectVersion)
lastUpdateDateUtcstring(date-time)
sentenceArray of objects or null(List`1)
requiresSupportingDocumentsboolean
conditionOfUseArray of objects or null(List`1)
Response
application/json
{
  "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
  "claimName": "string",
  "productTypeId": "5b816809-bc2f-427f-abf0-cfc28532f595",
  "claimType": "marketing",
  "substanceIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "nutrientIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "status": "draft",
  "version": {
    "number": 0,
    "historyId": "4766cb03-195d-44df-b838-373e34658dcb",
    "activeVersion": true,
    "lastVersion": true
  },
  "lastUpdateDateUtc": "2019-08-24T14:15:22Z",
  "sentence": [
    { … }
  ],
  "requiresSupportingDocuments": true,
  "conditionOfUse": [
    { … }
  ]
}

Additive

Operations

Processing Aid

Operations

Raw Material

Operations

Bought Composite

Operations

Made in House Composite

Operations

Production Chapter

Operations

Finished Product Chapter

Operations

Testing Chapter

Operations

Specifications

Operations