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

HealthClaims_Get

Request

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

Responses

Returns the health claim

Bodyapplication/json
claimIdstring(uuid)
ownerCompanyIdstring(uuid)
productTypeIdstring(uuid)
claimTypestring(ClaimTypes)
Enum"marketing""health""nutrition"
regulatoryClaimobject(RegulatoryClaim)
logoobject(ClaimLogo)
versionobject(ObjectVersion)
lastUpdateDateUtcstring(date-time)
statusstring(LibraryItemStatus)
Enum"draft""published""locked"
tagIdsArray of strings or null(uuid)(List`1)
claimNamestring or null
additionalSentenceArray of objects or null(List`1)
Response
application/json
{
  "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
  "ownerCompanyId": "10e96248-c873-4e93-b748-bc36e39510eb",
  "productTypeId": "5b816809-bc2f-427f-abf0-cfc28532f595",
  "claimType": "marketing",
  "regulatoryClaim": {
    "claimType": "marketing",
    "claimId": "88057929-7728-4a26-8396-f965dcc8b947"
  },
  "logo": {
    "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc"
  },
  "version": {
    "number": 0,
    "historyId": "4766cb03-195d-44df-b838-373e34658dcb",
    "activeVersion": true,
    "lastVersion": true
  },
  "lastUpdateDateUtc": "2019-08-24T14:15:22Z",
  "status": "draft",
  "tagIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "claimName": "string",
  "additionalSentence": [
    { … }
  ]
}

HealthClaims_GetRegulatoryClaim

Request

Path
claimIdstring(uuid)required
curl -i -X GET \
  'https://apis.traceone.com/spec/v2/food/health-claims/regulation/{claimId}'

Responses

Returns the regulatory health claim

Bodyapplication/json
claimIdstring(uuid)
productTypeIdstring(uuid)
claimTypestring(ClaimTypes)
Enum"marketing""health""nutrition"
nutrientIdsArray of strings or null(uuid)(List`1)
substanceIdsArray of strings or null(uuid)(List`1)
statusstring(LibraryItemStatus)
Enum"draft""published""locked"
versionobject(ObjectVersion)
lastUpdateDateUtcstring(date-time)
regulationDomainstring or null
requiresSupportingDocumentsboolean
sentenceArray of objects or null(List`1)
conditionOfUseArray of objects or null(List`1)
Response
application/json
{
  "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
  "productTypeId": "5b816809-bc2f-427f-abf0-cfc28532f595",
  "claimType": "marketing",
  "nutrientIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "substanceIds": [
    "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",
  "regulationDomain": "string",
  "requiresSupportingDocuments": true,
  "sentence": [
    { … }
  ],
  "conditionOfUse": [
    { … }
  ]
}

Nutritional Claim

Operations

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