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

RawMaterials_GetById

Request

Path
materialIdstring(uuid)required
curl -i -X GET \
  'https://apis.traceone.com/spec/v2/food/raw-materials/{materialId}'

Responses

Returns the raw material

Bodyapplication/json
materialIdstring(uuid)
materialNamestring or null
commercialNamestring or null
internalCodestring or null
tagIdsArray of strings or null(uuid)(List`1)
activeboolean
materialTypestring(MaterialTypes)
Enum"rawMaterial""composite""additive""processingAid"
ownerCompanyIdstring(uuid)
versionobject(ObjectVersion)
lastUpdateDateUtcstring(date-time)
statusstring(LibraryItemStatus)
Enum"draft""published""locked"
classificationobject(ReferenceListItem)
rawMaterialPartobject(ReferenceListItem)
ionizedboolean
statestring or null
gmoboolean
suppliersArray of objects or null(List`1)
allergenDeclarationsArray of objects or null(List`1)
attachmentsobject(MaterialAttachments)
certificatesobject(MaterialCertificates)
characteristicsobject(CharacteristicsSection)
controlPlansobject(ControlPlansSection)
acceptSampleStorageboolean
sampleStorageobject(SampleStorage)
Response
application/json
{
  "materialId": "30cdab3c-3e2b-44f4-8415-c6dd88ed4261",
  "materialName": "string",
  "commercialName": "string",
  "internalCode": "string",
  "tagIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "active": true,
  "materialType": "rawMaterial",
  "ownerCompanyId": "10e96248-c873-4e93-b748-bc36e39510eb",
  "version": {
    "number": 0,
    "historyId": "4766cb03-195d-44df-b838-373e34658dcb",
    "activeVersion": true,
    "lastVersion": true
  },
  "lastUpdateDateUtc": "2019-08-24T14:15:22Z",
  "status": "draft",
  "classification": {
    "referenceListItemId": "5cc877ef-750b-4698-8347-cea3b0099d1e",
    "referenceListItemCode": "string"
  },
  "rawMaterialPart": {
    "referenceListItemId": "5cc877ef-750b-4698-8347-cea3b0099d1e",
    "referenceListItemCode": "string"
  },
  "ionized": true,
  "state": "string",
  "gmo": true,
  "suppliers": [
    { … }
  ],
  "allergenDeclarations": [
    { … }
  ],
  "attachments": {
    "fileIds": [ … ]
  },
  "certificates": {
    "certificateIds": [ … ]
  },
  "characteristics": {
    "characteristics": [ … ]
  },
  "controlPlans": {
    "controlPlans": [ … ]
  },
  "acceptSampleStorage": true,
  "sampleStorage": {
    "storageId": "0ff8924f-6eda-471e-914f-d650d8be19eb",
    "storageTemperature": { … },
    "humidity": { … },
    "keepAwayFromLight": true
  }
}

Bought Composite

Operations

Made in House Composite

Operations

Production Chapter

Operations

Finished Product Chapter

Operations

Testing Chapter

Operations

Specifications

Operations