Skip to content

Designed
Get linked requirements

Request

Returns the requirements linked to this specification, one entry per chapter attachment, with their validation state on this specification.

Security
oauth2(Required scopes: t1_api)
Path
specificationIdstring, (uuid)required

The unique identifier of the specification

curl -i -X GET \
  'https://apis.traceone.com/spec/v2/food/specifications/{specificationId}/requirements' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns the requirements linked to the specification

Bodyapplication/json
Array [
chapterTypestring

Template chapter code the requirement is attached to (same value as on the create)

requirementIdstring, (uuid)

The linked requirement version

namestring or null
requirementTypestring
Enum:"Text""Document"
validatedboolean

True when the retailer has validated the requirement on this specification

statusstring

Library status of the requirement version

Enum:"Draft""Published""Locked"
versionobject(ObjectVersion)
ownerCompanyIdstring, (uuid)
]
Response
[
  {
    "chapterType": "string",
    "requirementId": "e72767a8-2b2e-4214-9e24-a70f4b8e0ee6",
    "name": "string",
    "requirementType": "Text",
    "validated": true,
    "status": "Draft",
    "version": { … },
    "ownerCompanyId": "10e96248-c873-4e93-b748-bc36e39510eb"
  }
]