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

Additive

Operations

Processing Aid

Operations

Raw Material

Operations

Bought Composite

Operations

Made in House Composite

Operations

Production Chapter

Operations

Finished Product Chapter

Operations

FinishedProductChapters_SmartDocument

Request

Path
chapterIdstring(uuid)required
curl -i -X GET \
  'https://apis.traceone.com/spec/v2/food/finished-product-chapters/{chapterId}/smart-document'

Responses

Returns the chapter smart document

Bodyapplication/json
chapterIdstring(uuid)
productTypeIdstring(uuid)
chapterTypestring or null
chapterNamestring or null
ownerCompanyIdstring(uuid)
creationDateUtcstring(date-time)
lastUpdateDateUtcstring(date-time)
tagIdsArray of strings or null(uuid)(List`1)
versionobject(ObjectVersion)
chapterStatusstring(LibraryItemStatus)
Enum"draft""published""locked"
chapterProgressstring(SpecificationSectionStates)
Enum"none""toFill""inProgress""validated"
sectionsArray of objects or null(List`1)
validatedByCompanyIdsArray of strings or null(uuid)(List`1)
Response
application/json
{
  "chapterId": "2a48aff7-27e7-4ab6-9471-1ee9c5632811",
  "productTypeId": "5b816809-bc2f-427f-abf0-cfc28532f595",
  "chapterType": "string",
  "chapterName": "string",
  "ownerCompanyId": "10e96248-c873-4e93-b748-bc36e39510eb",
  "creationDateUtc": "2019-08-24T14:15:22Z",
  "lastUpdateDateUtc": "2019-08-24T14:15:22Z",
  "tagIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "version": {
    "number": 0,
    "historyId": "4766cb03-195d-44df-b838-373e34658dcb",
    "activeVersion": true,
    "lastVersion": true
  },
  "chapterStatus": "draft",
  "chapterProgress": "none",
  "sections": [
    { … }
  ],
  "validatedByCompanyIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

FinishedProductChapters_SmartDocumentStructure

Request

Path
chapterIdstring(uuid)required
Query
languageCodestring
curl -i -X GET \
  'https://apis.traceone.com/spec/v2/food/finished-product-chapters/{chapterId}/smart-document-structure?languageCode=string'

Responses

Returns the chapter template

Bodyapplication/json
chapterNamestring or null
chapterTypestring or null
sectionsArray of objects or null(List`1)
sectionIdstring(uuid)Deprecated
Response
application/json
{
  "sectionId": "e886b9ca-b5a6-42e4-892d-0b160851d7c9",
  "chapterName": "string",
  "chapterType": "string",
  "sections": [
    { … }
  ]
}

Testing Chapter

Operations

Specifications

Operations