Summary: Updated APIs for Custom Schema. Updated APIs for Presentation Builder.

Custom Schema

Link to the documentation

Custom Schema (v v1)

---

What's Changed

---

GET /v1/schemas/{id}/versions/{version}

Parameters:

Changed: include in query

Optional parameter to include additional information in the response. Note: Now it only supports including space names that the schema is distributed to. Note: The space names will be included in the response under the schema item.
Changed: id in path
(Required) The schema id, which identifies a schema across all versions. Note: This is not the version id, which identifies a specific version of the schema.
Changed: version in path
(Required) The version number, which is a combination of major, minor and tag. Note: The version number is in format of {major}.{minor}, where major and minor are integers. E.g. 1.0, 2.1.

Return Type:

Changed response : 400 Bad Request

Bad Request, meaning the request is invalid. Ensure the schema ID and version number are properly formatted and all required parameters are included in the request.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 401 Unauthorized

  Unauthorized, meaning the request is not authorized. Ensure you have a valid tenant-level JWT token to access this endpoint.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 403 Forbidden

  Forbidden, meaning you don't have permission to access this resource. Ensure your JWT token has the necessary permissions to access this endpoint.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 404 Not Found

  Not Found, meaning the requested resource could not be found. Ensure the schema ID and version number are correct.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 500 Internal Server Error

  Internal Server Error, meaning an unexpected error occurred on the server side.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 200 OK

  A schema at the given version is successfully retrieved, with space names included if requested. Note: If the specified version does not exist, a 404 Not Found error will be returned

• Changed content type : application/json
  • Changed property tenantId (string -> string)

    The unique identifier of the tenant that owns this schema, used to scope the schema to a specific Seismic tenant.

  • Changed property name (string)

    The display name of the schema, must be unique within the tenant. Used to identify and reference the schema in the Seismic UI.

  • Changed property description (string)

    A human-readable description of the schema's purpose and intended usage, helping users understand when and how to apply it.

  • Changed property spaceIds (array)

    The list of space IDs to which this schema is distributed, enabling schema reuse across multiple Seismic workspaces.
    Changed items (string -> string):

  • Changed property version (object)

    The version details of this schema, including major and minor version number and whether this is the latest version.

  • Changed property createdAt (string)

    The ISO 8601 timestamp recording when this schema was first created in the system.

  • Changed property updatedAt (string)

    The ISO 8601 timestamp recording when this schema was most recently modified, including field and status changes.

  • Changed property spaces (array)

    The list of spaces this schema is distributed to, populated only when the include=spaceName query parameter is specified.
    Changed items (object):

    • Changed property id (string -> string)

      The unique identifier of the Seismic space that this schema is distributed to.

    • Changed property name (string)

      The display name of the Seismic space that this schema is distributed to, included when include=spaceName is requested.

  • Changed property fields (array)

    The ordered list of custom field definitions that make up this schema, each specifying name, type, and validation rules.
    Changed items (object):

    • Changed property name (string)

      The display name of the field as shown to users in forms and the schema editor. Must be unique within the schema.

GET /v1/schemas

Parameters:

Changed: spaceIds in query

List of spaces that this schema is distributed to. Note: A schema can be distributed to multiple spaces, and filtering by spaceIds will return all schemas that are distributed to any of the specified spaces.
Changed: name in query
Name of the schema, supports case insensitive partial match. Note: Filtering by name will return all schemas that match the specified name.
Changed: filter in query
Advanced filter to query all details of Schemas. Note: This field will overwrite SpaceIds, Status, and Name filters.
Changed: limit in query
(Required) The limit of how many schemas get returned, used for pagination. Note: The default limit is 100, if the value is skipped in the query parameter, it will be treated as 100.
Changed: skip in query
(Required) How many schemas to skip from query, used together with limit for pagination. Note: For the first page, skip should be 0, and for the second page, skip should be the same as limit, and so on.
Changed: orderDirection in query
Order direction of the returned schemas, which can be ascending or descending. Note: This will work together with orderBy to order the returned schemas by the specified schema property in either ascending or descending order.
Changed: orderBy in query
Order by which schema property, now it only support ordering by name. Note: This will work together with orderDirection to order the returned schemas by the specified schema property in either ascending or descending order.
Changed: include in query
If the response should include space names that the schema is distributed to. Note: This will not return the full space details, only the id and name. Note: The space names will be included in the response under each schema item.

Return Type:

Changed response : 401 Unauthorized

Unauthorized to access the resource. Ensure you have a valid tenant-level JWT token.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 403 Forbidden

  Forbidden to access the resource. Ensure your JWT token has the necessary permissions to access this endpoint.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 200 OK

  Successfully retrieved the custom schemas, with space names included if requested.

• Changed content type : application/json
  • Changed property count (number)

    The number of custom schemas returned in this page of results, which may be less than limit if fewer results are available.

  • Changed property totalCount (number)

    The total number of custom schemas that match the filter criteria across all pages, used to calculate total pages for pagination.

  • Changed property items (array)

    The list of custom schemas that match the filter criteria and pagination settings in this response page.
    Changed items (object):

    • Changed property tenantId (string -> string)

      The unique identifier of the tenant that owns this schema, used to scope the schema to a specific Seismic tenant.

    • Changed property name (string)

      The display name of the schema, must be unique within the tenant. Used to identify and reference the schema in the Seismic UI.

    • Changed property description (string)

      A human-readable description of the schema's purpose and intended usage, helping users understand when and how to apply it.

    • Changed property spaceIds (array)

      The list of space IDs to which this schema is distributed, enabling schema reuse across multiple Seismic workspaces.
      Changed items (string -> string):

    • Changed property version (object)

      The version details of this schema, including major and minor version number and whether this is the latest version.

    • Changed property createdAt (string)

      The ISO 8601 timestamp recording when this schema was first created in the system.

    • Changed property updatedAt (string)

      The ISO 8601 timestamp recording when this schema was most recently modified, including field and status changes.

    • Changed property spaces (array)

      The list of spaces this schema is distributed to, populated only when the include=spaceName query parameter is specified.
      Changed items (object):

      • Changed property id (string -> string)

        The unique identifier of the Seismic space that this schema is distributed to.

      • Changed property name (string)

        The display name of the Seismic space that this schema is distributed to, included when include=spaceName is requested.

    • Changed property fields (array)

      The ordered list of custom field definitions that make up this schema, each specifying name, type, and validation rules.
      Changed items (object):

      • Changed property name (string)

        The display name of the field as shown to users in forms and the schema editor. Must be unique within the schema.

POST /v1/schemas

Request:

Changed content type : application/json

• Changed property name (string)

  The name of the schema to be created, which is required and must be unique across the tenant, a duplicated name will result in a Bad Request error.

• Changed property description (string)

  The description of the schema to be created, which is optional. If not provided, it will be defaulted to an empty string.

• Changed property spaceIds (array)

  The IDs of the spaces where the schema will be distributed. If not provided, the schema will not be distributed to any space. Note: ShortGuid of the space can also be used and the system will convert it to spaceId automatically.
  Changed items (string -> string):

• Changed property fields (array)

  The fields of the schema to be created, which is required and must have at least one item and at most 200 items. Note: no null values are allowed in the fields array.

Return Type:

Changed response : 400 Bad Request

Bad Request - The request body is invalid or missing required fields. Ensure that the JSON is properly formatted and includes all necessary information.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 401 Unauthorized

  Unauthorized

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 403 Forbidden

  Forbidden

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 404 Not Found

  Not Found

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 500 Internal Server Error

  Internal Server Error

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 201 Created

  Successfully created a new schema with the provided name, description and fields details, and distributed it to the specified spaces if spaceIds are provided.

• Changed content type : application/json
  • Changed property tenantId (string -> string)

    The unique identifier of the tenant that owns this schema, used to scope the schema to a specific Seismic tenant.

  • Changed property name (string)

    The display name of the schema, must be unique within the tenant. Used to identify and reference the schema in the Seismic UI.

  • Changed property description (string)

    A human-readable description of the schema's purpose and intended usage, helping users understand when and how to apply it.

  • Changed property spaceIds (array)

    The list of space IDs to which this schema is distributed, enabling schema reuse across multiple Seismic workspaces.
    Changed items (string -> string):

  • Changed property version (object)

    The version details of this schema, including major and minor version number and whether this is the latest version.

  • Changed property createdAt (string)

    The ISO 8601 timestamp recording when this schema was first created in the system.

  • Changed property updatedAt (string)

    The ISO 8601 timestamp recording when this schema was most recently modified, including field and status changes.

  • Changed property spaces (array)

    The list of spaces this schema is distributed to, populated only when the include=spaceName query parameter is specified.
    Changed items (object):

    • Changed property id (string -> string)

      The unique identifier of the Seismic space that this schema is distributed to.

    • Changed property name (string)

      The display name of the Seismic space that this schema is distributed to, included when include=spaceName is requested.

  • Changed property fields (array)

    The ordered list of custom field definitions that make up this schema, each specifying name, type, and validation rules.
    Changed items (object):

    • Changed property name (string)

      The display name of the field as shown to users in forms and the schema editor. Must be unique within the schema.

DELETE /v1/schemas/{id}

Parameters:

Changed: id in path

(Required) The schema id, which identifies a schema across all versions. Note: This is not the version id, which identifies a specific version of the schema.

Return Type:

Changed response : 204 No Content

No Content, which means the schema is successfully deleted.

• Deleted content type : text/plain
  Changed response : 400 Bad Request

  Bad Request, which means the request is invalid. Ensure the schema ID is properly formatted and all required parameters are included in the request.

• New content type : application/problem+json
• Deleted content type : text/plain
  Changed response : 401 Unauthorized

  Unauthorized, which means the request lacks valid authentication credentials. Ensure a valid JWT token is provided.

• New content type : application/problem+json
• Deleted content type : text/plain
  Changed response : 403 Forbidden

  Forbidden, which means you don't have permission to access this resource. Ensure your JWT token has the necessary permissions to access this endpoint.

• New content type : application/problem+json
• Deleted content type : text/plain
  Changed response : 404 Not Found

  Not Found, which means the specified schema could not be found. Ensure the schema ID is correct and the schema exists.

• New content type : application/problem+json
• Deleted content type : text/plain
  Changed response : 500 Internal Server Error

  Internal Server Error, which means an unexpected error occurred on the server. Ensure the server is functioning correctly and try again later.

• New content type : application/problem+json
• Deleted content type : text/plain

GET /v1/schemas/{id}

Parameters:

Changed: include in query

Optional parameter to include additional information in the response. Note: Now it only supports including space names that the schema is distributed to. The space names will be included in the response under the schema item.
Changed: id in path
(Required) The schema id, which identifies a schema across all versions. Note: This is not the version id, which identifies a specific version of the schema.

Return Type:

Changed response : 400 Bad Request

Bad Request, means the request is invalid. Ensure the schema ID is properly formatted and all required parameters are included in the request.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 401 Unauthorized

  Unauthorized, means the request is not authorized. Ensure you have a valid tenant-level JWT token to access this endpoint.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 403 Forbidden

  Forbidden, means you don't have permission to access this resource. Ensure your JWT token has the necessary permissions to access this endpoint.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 404 Not Found

  Not Found, means the requested schema could not be found. Ensure the schema ID is correct and the schema exists.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 500 Internal Server Error

  Internal Server Error

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 200 OK

  OK, means successfully retrieved the latest version of the schema by the given id, with space names included if requested.

• Changed content type : application/json
  • Changed property tenantId (string -> string)

    The unique identifier of the tenant that owns this schema, used to scope the schema to a specific Seismic tenant.

  • Changed property name (string)

    The display name of the schema, must be unique within the tenant. Used to identify and reference the schema in the Seismic UI.

  • Changed property description (string)

    A human-readable description of the schema's purpose and intended usage, helping users understand when and how to apply it.

  • Changed property spaceIds (array)

    The list of space IDs to which this schema is distributed, enabling schema reuse across multiple Seismic workspaces.
    Changed items (string -> string):

  • Changed property version (object)

    The version details of this schema, including major and minor version number and whether this is the latest version.

  • Changed property createdAt (string)

    The ISO 8601 timestamp recording when this schema was first created in the system.

  • Changed property updatedAt (string)

    The ISO 8601 timestamp recording when this schema was most recently modified, including field and status changes.

  • Changed property spaces (array)

    The list of spaces this schema is distributed to, populated only when the include=spaceName query parameter is specified.
    Changed items (object):

    • Changed property id (string -> string)

      The unique identifier of the Seismic space that this schema is distributed to.

    • Changed property name (string)

      The display name of the Seismic space that this schema is distributed to, included when include=spaceName is requested.

  • Changed property fields (array)

    The ordered list of custom field definitions that make up this schema, each specifying name, type, and validation rules.
    Changed items (object):

    • Changed property name (string)

      The display name of the field as shown to users in forms and the schema editor. Must be unique within the schema.

PUT /v1/schemas/{id}

Parameters:

Changed: id in path

(Required) The schema id, which identifies a schema across all versions. Note: This is not the version id, which identifies a specific version of the schema.

Request:

Changed content type : application/json

• Changed property name (string)

  The name of the schema to be created, which is required and must be unique across the tenant, a duplicated name will result in a Bad Request error.

• Changed property description (string)

  The description of the schema to be created, which is optional. If not provided, it will be defaulted to an empty string.

• Changed property spaceIds (array)

  The IDs of the spaces where the schema will be distributed. If not provided, the schema will not be distributed to any space. Note: ShortGuid of the space can also be used and the system will convert it to spaceId automatically.
  Changed items (string -> string):

• Changed property fields (array)

  The fields of the schema to be created, which is required and must have at least one item and at most 200 items. Note: no null values are allowed in the fields array.

Return Type:

Changed response : 400 Bad Request

Bad Request, means the request is invalid. Ensure the schema ID is properly formatted, the request body is valid and includes all required fields.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 401 Unauthorized

  Unauthorized, meaning the request is not authorized. Ensure you have a valid tenant-level JWT token to access this endpoint.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 403 Forbidden

  Forbidden, means you don't have permission to access this resource. Ensure your JWT token has the necessary permissions to access this endpoint.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 404 Not Found

  Not Found, meaning the requested schema could not be found. Ensure the schema ID is correct and the schema exists.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 500 Internal Server Error

  Internal Server Error, meaning an unexpected error occurred while processing the request. Ensure the server is functioning properly and try again later.

• New content type : application/problem+json
• Deleted content type : application/json
  Changed response : 200 OK

  OK, means the schema is successfully updated, and the updated schema will be returned in the response body.

• Changed content type : application/json
  • Changed property tenantId (string -> string)

    The unique identifier of the tenant that owns this schema, used to scope the schema to a specific Seismic tenant.

  • Changed property name (string)

    The display name of the schema, must be unique within the tenant. Used to identify and reference the schema in the Seismic UI.

  • Changed property description (string)

    A human-readable description of the schema's purpose and intended usage, helping users understand when and how to apply it.

  • Changed property spaceIds (array)

    The list of space IDs to which this schema is distributed, enabling schema reuse across multiple Seismic workspaces.
    Changed items (string -> string):

  • Changed property version (object)

    The version details of this schema, including major and minor version number and whether this is the latest version.

  • Changed property createdAt (string)

    The ISO 8601 timestamp recording when this schema was first created in the system.

  • Changed property updatedAt (string)

    The ISO 8601 timestamp recording when this schema was most recently modified, including field and status changes.

  • Changed property spaces (array)

    The list of spaces this schema is distributed to, populated only when the include=spaceName query parameter is specified.
    Changed items (object):

    • Changed property id (string -> string)

      The unique identifier of the Seismic space that this schema is distributed to.

    • Changed property name (string)

      The display name of the Seismic space that this schema is distributed to, included when include=spaceName is requested.

  • Changed property fields (array)

    The ordered list of custom field definitions that make up this schema, each specifying name, type, and validation rules.
    Changed items (object):

    • Changed property name (string)

      The display name of the field as shown to users in forms and the schema editor. Must be unique within the schema.

Result

---

API changes broke backward compatibility

---

Presentation Builder

Link to the documentation

Presentation Builder (v v1)

---

What's New

---

POST /v1/presentations

Create a presentation

GET /v1/presentations/{presentationId}

Get presentation

GET /v1/sources/{source}/contents/{contentId}/versions/{versionId}/slides

Get slide metadata for a content version

POST /v1/contents/query

Search eligible content

Result

---

API changes are backward compatible