Essence Schema Service API

Version v1 · OpenAPI 3.0.1 · 41 operations · Download the JSON document

Schema publication, marketplace, and invitation management for the Essence Platform. All endpoints require a Bearer token issued by the Essence Auth service (WS-C 1 foundation adoption).

Generated from the Schema service's code at build time (api-specs/generated/Schema/Essence.Core.Schema.Api.json) and drift-checked in CI. It describes what the code registers, which is not the same as what any one deployment has routed.

CatalogueHealth

GET/api/v1/schemas/catalogue-health

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — CatalogueHealthDto

PublicationRequests

POST/api/v1/PublicationRequests

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

SubmitPublicationRequest as application/*+json, application/json, text/json

Responses

201Created — PublicationRequestDto

400Bad Request — ProblemDetails

GET/api/v1/PublicationRequests/by-submitter/{submitterId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`submitterId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — PublicationRequestDto[]

GET/api/v1/PublicationRequests/overdue

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — PublicationRequestDto[]

GET/api/v1/PublicationRequests/pending

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — PublicationRequestDto[]

POST/api/v1/PublicationRequests/security-checks

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

string as application/*+json, application/json, text/json

Responses

200Success — SecurityCheckResult

GET/api/v1/PublicationRequests/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — PublicationRequestDto

404Not Found — ProblemDetails

POST/api/v1/PublicationRequests/{id}/approve

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—
`approvedBy`	query	`string (uuid)`	no	—
`notes`	query	`string`	no	—

Request body

No request body.

Responses

200Success — PublicationRequestDto

404Not Found — ProblemDetails

POST/api/v1/PublicationRequests/{id}/reject

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—
`rejectedBy`	query	`string (uuid)`	no	—

Request body

Not marked as required in the document.

string as application/*+json, application/json, text/json

Responses

200Success — PublicationRequestDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/PublicationRequests/{id}/request-changes

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

string as application/*+json, application/json, text/json

Responses

200Success — PublicationRequestDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/PublicationRequests/{id}/reviews

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

AddReviewRequest as application/*+json, application/json, text/json

Responses

200Success — PublicationRequestDto

404Not Found — ProblemDetails

POST/api/v1/PublicationRequests/{id}/start-review

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — PublicationRequestDto

404Not Found — ProblemDetails

POST/api/v1/PublicationRequests/{id}/withdraw

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — PublicationRequestDto

404Not Found — ProblemDetails

SchemaInvitations

POST/api/v1/SchemaInvitations

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateInvitationRequest as application/*+json, application/json, text/json

Responses

201Created — SchemaInvitationDto

400Bad Request — ProblemDetails

POST/api/v1/SchemaInvitations/accept/{token}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`token`	path	`string`	yes	—
`acceptedBy`	query	`string (uuid)`	no	—
`documentId`	query	`string (uuid)`	no	—
`vaultId`	query	`string (uuid)`	no	—

Request body

No request body.

Responses

200Success — SchemaInvitationDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/SchemaInvitations/by-recipient-email

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`email`	query	`string`	no	—

Request body

No request body.

Responses

200Success — SchemaInvitationDto[]

GET/api/v1/SchemaInvitations/by-recipient-user/{userId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`userId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — SchemaInvitationDto[]

GET/api/v1/SchemaInvitations/by-schema/{schemaId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`schemaId`	path	`string`	yes	—

Request body

No request body.

Responses

200Success — SchemaInvitationDto[]

GET/api/v1/SchemaInvitations/by-sender/{senderId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`senderId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — SchemaInvitationDto[]

GET/api/v1/SchemaInvitations/by-token/{token}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`token`	path	`string`	yes	—

Request body

No request body.

Responses

200Success — SchemaInvitationDto

404Not Found — ProblemDetails

POST/api/v1/SchemaInvitations/mark-expired

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — integer (int32)

POST/api/v1/SchemaInvitations/reject/{token}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`token`	path	`string`	yes	—

Request body

No request body.

Responses

200Success — SchemaInvitationDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/SchemaInvitations/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — SchemaInvitationDto

404Not Found — ProblemDetails

POST/api/v1/SchemaInvitations/{id}/mark-delivered

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—
`deliveryStatus`	query	`string`	no	—

Request body

No request body.

Responses

200Success — SchemaInvitationDto

404Not Found — ProblemDetails

POST/api/v1/SchemaInvitations/{id}/revoke

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — SchemaInvitationDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

Schemas

POST/api/v1/Schemas

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateSchemaRequest as application/*+json, application/json, text/json

Responses

201Created — SchemaDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/Schemas/available

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`userId`	query	`string (uuid)`	no	—
`organizationId`	query	`string (uuid)`	no	—
`userJurisdiction`	query	`string`	no	—

Request body

No request body.

Responses

200Success — SchemaDto[]

GET/api/v1/Schemas/by-jurisdiction/{jurisdictionCode}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`jurisdictionCode`	path	`string`	yes	—

Request body

No request body.

Responses

200Success — SchemaDto[]

GET/api/v1/Schemas/by-level/{level}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`level`	path	`SchemaLevel`	yes	—

Request body

No request body.

Responses

200Success — SchemaDto[]

GET/api/v1/Schemas/by-module/{moduleId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`moduleId`	path	`string`	yes	—

Request body

No request body.

Responses

200Success — SchemaDto[]

GET/api/v1/Schemas/by-organization/{organizationId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`organizationId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — SchemaDto[]

GET/api/v1/Schemas/by-schema-id/{schemaId}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`schemaId`	path	`string`	yes	—

Request body

No request body.

Responses

200Success — SchemaDto

404Not Found — ProblemDetails

GET/api/v1/Schemas/marketplace/categories

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — string[]

POST/api/v1/Schemas/marketplace/search

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

MarketplaceSearchRequest as application/*+json, application/json, text/json

Responses

200Success — MarketplaceSearchResult

GET/api/v1/Schemas/marketplace/tags

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — string[]

GET/api/v1/Schemas/published

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — SchemaDto[]

POST/api/v1/Schemas/validate-definition

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

ValidateSchemaDefinitionRequest as application/*+json, application/json, text/json

Responses

200Success — SchemaDefinitionValidationDto

GET/api/v1/Schemas/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — SchemaDto

404Not Found — ProblemDetails

PUT/api/v1/Schemas/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

UpdateSchemaRequest as application/*+json, application/json, text/json

Responses

200Success — SchemaDto

404Not Found — ProblemDetails

DELETE/api/v1/Schemas/{id}

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

204No Content

404Not Found — ProblemDetails

POST/api/v1/Schemas/{id}/archive

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—
`archivedBy`	query	`string (uuid)`	no	—

Request body

No request body.

Responses

200Success — SchemaDto

404Not Found — ProblemDetails

Schemas

AddReviewRequest

Property	Type	Required	Description
`decision`	`ReviewDecision`	no	—
`qualityScore`	`integer (int32) \| null`	no	—
`reviewNotes`	`string \| null`	no	—
`reviewerId`	`string (uuid)`	no	—
`reviewerJurisdiction`	`string \| null`	no	—
`reviewerRole`	`GovernanceRole`	no	—
`securityScore`	`integer (int32) \| null`	no	—

CatalogueHealthDto

Property	Type	Required	Description
`authoredCount`	`integer (int32)`	no	—
`authoredResolvableCount`	`integer (int32)`	no	—
`legacyFieldManifestCount`	`integer (int32)`	no	—
`manifestPresent`	`boolean`	no	—
`manifestProblems`	`string[] \| null`	no	—
`missing`	`string[] \| null`	no	—
`resolvableCount`	`integer (int32)`	no	—

CreateInvitationRequest

Property	Type	Required	Description
`autoPopulate`	`boolean`	no	—
`deliveryMethod`	`DeliveryMethod`	no	—
`expiryDays`	`integer (int32)`	no	—
`invitationDataJson`	`string \| null`	no	—
`recipientEmail`	`string \| null`	no	—
`recipientPhone`	`string \| null`	no	—
`recipientUserId`	`string (uuid) \| null`	no	—
`schemaId`	`string \| null`	no	—
`sentBy`	`string (uuid)`	no	—
`sentByOrganizationId`	`string (uuid) \| null`	no	—

CreateSchemaRequest

Property	Type	Required	Description
`category`	`string \| null`	no	—
`dataClassification`	`DataClassification`	no	—
`description`	`string \| null`	no	—
`jsonSchemaDefinition`	`string \| null`	no	—
`jurisdictionCode`	`string \| null`	no	—
`level`	`SchemaLevel`	no	—
`moduleId`	`string \| null`	no	—
`name`	`string \| null`	no	—
`organizationId`	`string (uuid) \| null`	no	—
`retentionYears`	`integer (int32) \| null`	no	—
`schemaId`	`string \| null`	no	—
`sensitivityLevel`	`integer (int32) \| null`	no	—
`tags`	`string[] \| null`	no	—

DataClassification

0 | 1 | 2 | 3 with no declared properties.

DeliveryMethod

0 | 1 | 2 | 3 with no declared properties.

GovernanceRole

0 | 1 | 2 | 3 | 4 with no declared properties.

InvitationStatus

0 | 1 | 2 | 3 | 4 with no declared properties.

MarketplaceSearchRequest

Property	Type	Required	Description
`category`	`string \| null`	no	—
`descending`	`boolean`	no	—
`pageNumber`	`integer (int32)`	no	—
`pageSize`	`integer (int32)`	no	—
`searchTerm`	`string \| null`	no	—
`sortBy`	`string \| null`	no	—
`tags`	`string[] \| null`	no	—

MarketplaceSearchResult

Property	Type	Required	Description
`pageNumber`	`integer (int32)`	no	—
`pageSize`	`integer (int32)`	no	—
`schemas`	`SchemaDto[] \| null`	no	—
`totalCount`	`integer (int32)`	no	—
`totalPages`	`integer (int32)`	no	—

ProblemDetails

Property	Type	Required	Description
`detail`	`string \| null`	no	—
`instance`	`string \| null`	no	—
`status`	`integer (int32) \| null`	no	—
`title`	`string \| null`	no	—
`type`	`string \| null`	no	—

PublicationRequestDto

Property	Type	Required	Description
`daysOverdue`	`integer (int32)`	no	—
`decidedAt`	`string (date-time) \| null`	no	—
`decidedBy`	`string (uuid) \| null`	no	—
`decisionNotes`	`string \| null`	no	—
`expectedUsers`	`integer (int32) \| null`	no	—
`id`	`string (uuid)`	no	—
`isOverdue`	`boolean`	no	—
`justification`	`string \| null`	no	—
`requestedInvitationEnabled`	`boolean`	no	—
`requestedJurisdictions`	`string[] \| null`	no	—
`requestedMarketplaceListing`	`boolean`	no	—
`requestedVisibility`	`VisibilityType`	no	—
`reviewDueDate`	`string (date-time) \| null`	no	—
`reviewStartedAt`	`string (date-time) \| null`	no	—
`reviews`	`SchemaReviewDto[] \| null`	no	—
`schemaId`	`string \| null`	no	—
`status`	`PublicationRequestStatus`	no	—
`submittedAt`	`string (date-time)`	no	—
`submittedBy`	`string (uuid)`	no	—
`useCaseDescription`	`string \| null`	no	—

PublicationRequestStatus

0 | 1 | 2 | 3 | 4 | 5 with no declared properties.

PublicationStatus

0 | 1 | 2 | 3 | 4 with no declared properties.

ReviewDecision

0 | 1 | 2 | 3 | 4 with no declared properties.

SchemaDefinitionValidationDto

Property	Type	Required	Description
`isPublishable`	`boolean`	no	—
`violations`	`SchemaRuleViolationDto[] \| null`	no	—

SchemaDto

Property	Type	Required	Description
`archivedAt`	`string (date-time) \| null`	no	—
`archivedBy`	`string (uuid) \| null`	no	—
`averageRating`	`number (double) \| null`	no	—
`basePrice`	`number (double) \| null`	no	—
`category`	`string \| null`	no	—
`createdAt`	`string (date-time)`	no	—
`createdBy`	`string \| null`	no	—
`currency`	`string \| null`	no	—
`dataClassification`	`DataClassification`	no	—
`description`	`string \| null`	no	—
`id`	`string (uuid)`	no	—
`isInvitationEnabled`	`boolean`	no	—
`isMarketplaceListed`	`boolean`	no	—
`jsonSchemaDefinition`	`string \| null`	no	—
`jurisdictionCode`	`string \| null`	no	—
`level`	`SchemaLevel`	no	—
`moduleId`	`string \| null`	no	—
`name`	`string \| null`	no	—
`organizationId`	`string (uuid) \| null`	no	—
`pricingModel`	`string \| null`	no	—
`publicationStatus`	`PublicationStatus`	no	—
`publishedAt`	`string (date-time) \| null`	no	—
`publishedBy`	`string (uuid) \| null`	no	—
`ratingCount`	`integer (int32)`	no	—
`retentionYears`	`integer (int32) \| null`	no	—
`schemaId`	`string \| null`	no	—
`sensitivityLevel`	`integer (int32) \| null`	no	—
`tags`	`string[] \| null`	no	—
`updatedAt`	`string (date-time) \| null`	no	—
`usageCount`	`integer (int32)`	no	—
`visibilityType`	`VisibilityType`	no	—

SchemaInvitationDto

Property	Type	Required	Description
`acceptedAt`	`string (date-time) \| null`	no	—
`acceptedBy`	`string (uuid) \| null`	no	—
`autoPopulate`	`boolean`	no	—
`deliveredAt`	`string (date-time) \| null`	no	—
`deliveryMethod`	`DeliveryMethod`	no	—
`deliveryStatus`	`string \| null`	no	—
`expiresAt`	`string (date-time)`	no	—
`id`	`string (uuid)`	no	—
`invitationDataJson`	`string \| null`	no	—
`invitationToken`	`string \| null`	no	—
`isExpired`	`boolean`	no	—
`isValid`	`boolean`	no	—
`recipientEmail`	`string \| null`	no	—
`recipientPhone`	`string \| null`	no	—
`recipientUserId`	`string (uuid) \| null`	no	—
`resultingDocumentId`	`string (uuid) \| null`	no	—
`resultingVaultId`	`string (uuid) \| null`	no	—
`schemaId`	`string \| null`	no	—
`sentAt`	`string (date-time)`	no	—
`sentBy`	`string (uuid)`	no	—
`sentByOrganizationId`	`string (uuid) \| null`	no	—
`status`	`InvitationStatus`	no	—

SchemaLevel

0 | 1 | 2 | 3 | 4 with no declared properties.

SchemaReviewDto

Property	Type	Required	Description
`decision`	`ReviewDecision`	no	—
`followupNotes`	`string \| null`	no	—
`id`	`string (uuid)`	no	—
`qualityScore`	`integer (int32) \| null`	no	—
`requestId`	`string (uuid)`	no	—
`requiresFollowup`	`boolean`	no	—
`reviewNotes`	`string \| null`	no	—
`reviewedAt`	`string (date-time)`	no	—
`reviewerId`	`string (uuid)`	no	—
`reviewerJurisdiction`	`string \| null`	no	—
`reviewerRole`	`GovernanceRole`	no	—
`securityScore`	`integer (int32) \| null`	no	—

SchemaRuleViolationDto

Property	Type	Required	Description
`code`	`string \| null`	no	—
`message`	`string \| null`	no	—
`path`	`string \| null`	no	—

SecurityCheckResult

Property	Type	Required	Description
`checksJson`	`string \| null`	no	—
`issues`	`string[] \| null`	no	—
`passed`	`boolean`	no	—
`qualityScore`	`integer (int32)`	no	—
`securityScore`	`integer (int32)`	no	—
`warnings`	`string[] \| null`	no	—

SubmitPublicationRequest

Property	Type	Required	Description
`expectedUsers`	`integer (int32) \| null`	no	—
`justification`	`string \| null`	no	—
`requestedInvitationEnabled`	`boolean`	no	—
`requestedJurisdictions`	`string[] \| null`	no	—
`requestedMarketplaceListing`	`boolean`	no	—
`requestedVisibility`	`VisibilityType`	no	—
`schemaId`	`string \| null`	no	—
`slaBusinessDays`	`integer (int32)`	no	—
`submittedBy`	`string (uuid)`	no	—
`useCaseDescription`	`string \| null`	no	—

UpdateSchemaRequest

Property	Type	Required	Description
`dataClassification`	`DataClassification`	no	—
`description`	`string \| null`	no	—
`jsonSchemaDefinition`	`string \| null`	no	—
`name`	`string \| null`	no	—
`retentionYears`	`integer (int32) \| null`	no	—
`sensitivityLevel`	`integer (int32) \| null`	no	—
`tags`	`string[] \| null`	no	—

ValidateSchemaDefinitionRequest

Property	Type	Required	Description
`jsonSchemaDefinition`	`string \| null`	no	—

VisibilityType

0 | 1 | 2 with no declared properties.

Essence Schema Service API ​

CatalogueHealth

Parameters

Request body

Responses

PublicationRequests

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

SchemaInvitations

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Schemas

Essence Schema Service API