Skip to content

Draft API / SCT Endpoints

Last updatedView as Markdown

The Structured Content Types (SCT) API is part of the Arc XP Draft API. It exposes two resource groups: schema types (the templates that define your content structure) and documents (the individual records that conform to a schema). Both groups are managed through the same authenticated API used for story content in Arc XP.

Schema Management Endpoints

MethodPathDescription
POST/draft/v1/schema-typeCreate a new schema
GET/draft/v1/schema-typeList schemas in the org, 25 per page (page). Sort with sort_by = name, display_name, created_at or updated_at and sort_direction = asc or desc
GET/draft/v1/schema-type/{name}Get a single schema by name
PATCH/draft/v1/schema-type/{name}Update a schema (non-breaking only)
DELETE/draft/v1/schema-type/{name}Delete a schema (no records may exist, and no other schema may reference it)
GET/draft/v1/schema-usageSchema and indexed-field counts against the org’s limits, and per-schema field and record counts
PUT, GET, DELETE/draft/v1/schema-type/{name}/settingsData Center settings for a schema: preview_url, schema_display_field and list_fields (up to 8 columns shown in the record list)

Schema, Document Management Endpoints

MethodPathDescription
POST/draft/v1/document/schemaCreate a new record (schema_name, schema_content and contributors in the body)
GET/draft/v1/schema-type/{name}/projectionsList records for a schema
GET/draft/v1/document/schema/{id}Get a single record
PUT/draft/v1/document/schema/{id}/revision/draftUpdate a record’s draft
POST/draft/v1/document/schema/{id}/revision/publishedPublish a record
DELETE/draft/v1/document/schema/{id}/revision/publishedUnpublish a record
PUT/draft/v1/document/schema/{id}/circulation/{website}Circulate a record to a website
DELETE/draft/v1/document/schema/{id}Delete a record
Loading API docs...