Templates

Operations of the Template Registry API. Paths are relative to your deployment's API host.

GET /api/template-registry-api/templates

Authentication: bearer token (Authorization: Bearer <token>)

StatusDescriptionBody
200application/json AuthoredContentIdentityResponseDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/template-registry-api/templates

Create a Template identity with its initial draft

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json CreateAuthoredContentDto

StatusDescriptionBody
201application/json CreateAuthoredContentResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/template-registry-api/templates/resolve

Resolve an explicit owner-qualified Template target to exact content

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json ResolveAuthoredContentDto

StatusDescriptionBody
200application/json ResolvedAuthoredContentResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/template-registry-api/templates/{resourceId}

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
resourceIdpathstringyes
StatusDescriptionBody
200application/json AuthoredContentIdentityResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

PUT /api/template-registry-api/templates/{resourceId}/draft

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
resourceIdpathstringyes

Request body: application/json SaveAuthoredContentDraftDto

StatusDescriptionBody
200application/json AuthoredContentDraftResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/template-registry-api/templates/{resourceId}/drafts

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
resourceIdpathstringyes
StatusDescriptionBody
200application/json AuthoredContentDraftResponseDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/template-registry-api/templates/{resourceId}/evaluations

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
resourceIdpathstringyes
StatusDescriptionBody
200application/json AuthoredContentEvaluationResponseDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/template-registry-api/templates/{resourceId}/evaluations

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
resourceIdpathstringyes

Request body: application/json RecordEvaluationDto

StatusDescriptionBody
201application/json AuthoredContentEvaluationResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/template-registry-api/templates/{resourceId}/previews

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
resourceIdpathstringyes
StatusDescriptionBody
200application/json AuthoredContentPreviewResponseDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/template-registry-api/templates/{resourceId}/previews

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
resourceIdpathstringyes

Request body: application/json RecordTemplatePreviewDto

StatusDescriptionBody
201application/json AuthoredContentPreviewResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/template-registry-api/templates/{resourceId}/publication-proposals

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
resourceIdpathstringyes
StatusDescriptionBody
200application/json PublicationIntentResponseDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/template-registry-api/templates/{resourceId}/publication-proposals

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
resourceIdpathstringyes

Request body: application/json ProposePublicationDto

StatusDescriptionBody
201application/json PublicationIntentResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/template-registry-api/templates/{resourceId}/revision-candidates

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
resourceIdpathstringyes

Request body: application/json CreateRevisionCandidateDto

StatusDescriptionBody
201application/json CreateRevisionCandidateResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/template-registry-api/templates/{resourceId}/revisions

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
resourceIdpathstringyes
StatusDescriptionBody
200application/json AuthoredContentRevisionResponseDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto