Skip to content

Designed
Get library testing chapter

Request

Reads the chapter at its own address — the owner never needs to know which specifications link it. Same content as the spec-scoped projection (same read mapper). Returns the ETag used by If-Match on the PUT (read-modify-write: PUT is a full replace).

Security
oauth2(Required scopes: t1_api)
Path
templateTypestringrequired

The template type of the library chapter: the family of specifications that can link it. A value outside the list is a 404; so is a chapter of another template type.

Enum:"food""packaging"
chapterIdstring, (uuid)required

The unique identifier of the library chapter

curl -i -X GET \
  'https://apis.traceone.com/spec/v2/library/{templateType}/testing-chapters/{chapterId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns the testing chapter (active version)

Headers
ETagstring

Version tag of the chapter as stored. Pass it back in If-Match on the next write for optimistic concurrency.

Bodyapplication/json
chapterIdstring or null, (uuid)read-only

The library chapter this content belongs to.

namestring

Library display name of the chapter, as written on its create or replace.

characteristicsArray of objects or null(Characteristic)

The characteristics table, in table order. A characteristic with no photos reads with empty acceptedPhotoFileIds and rejectedPhotoFileIds lists.

controlPlansArray of objects or null(ControlPlan)

The control plans table, one row per controlled characteristic, in the order of the characteristics table.

requirementsArray of objects or null(Requirement)read-only

Requirements attached to this chapter by the specification. A specification-level value: null when the chapter is read at its library address.

documentsobject or null(DocumentSection)read-only

Documents attached to this chapter by the specification. A specification-level value: null when the chapter is read at its library address.

Response
{
  "chapterId": "2a48aff7-27e7-4ab6-9471-1ee9c5632811",
  "name": "string",
  "characteristics": [
    { … }
  ],
  "controlPlans": [
    { … }
  ],
  "requirements": [
    { … }
  ],
  "documents": {
    "files": [ … ]
  }
}