SchemaDesignerServices Methods Ingeniux CMS Web Services API

The SchemaDesignerServices type exposes the following members.

Methods

  Name Description
Public method AddFavoriteSchemaField
Creates a new Schema Favorite entry
Public method DeleteSchemas
Deletes a collection of Schemas by their unique Ids
Public method GetContentUnits
Public method GetFavoriteSchemaFields
Retrieves the collection of Schema Field Favorites. Favorites are collection Fields with information of each Field already populated. The purpose of favorites is to place a group of fields that are used often across Schemas conveniently.
Public method GetSchemaChangeEfforts
Get the change efforts for given Pages to be updated based the latest version of their Schema. Change efforts are used to measure the differences between Page content and its latest version Schema content.
Public method GetSchemaChangeEffortsForComponentEmbeds
Get the change efforts for given Component embeds to be updated based the latest version of their Schema. Change efforts are used to measure the differences between Component Embed content and its latest version Schema content.
Public method GetSchemaChangeEffortsForComponentUnit
Get the change efforts for given Component content units to have their Component embed content updated based the latest version of their Schema. Change efforts are used to measure the differences between Component embed content and its latest version Schema content.
Public method GetSchemaDetails
Retrieves full details of a single Schema
Public method GetSchemaFieldCandidates
Gets all Field types as candidates for Schema construction. The collection is grouped by purpose or application of the Field type.
Public method GetSchemaOutofSyncComponentContentUnits
Retrieves the Component Content Units that contains out of sync component embed content, that were based on given Schema. Out of sync embed component are component embed content referring previous versions of the Schema
Public method GetSchemaOutOfSyncComponentEmbeds
Retrieves the out of sync component embed content, that were based on given Schema. Out of sync embed component are component embed content referring previous versions of the Schema
Public method GetSchemaOutofSyncPages
Retrieves the out of sync Pages created with given Schema. Out of sync Pages are Pages referring previous versions of the Schema
Public method GetSchemas
Retrieves listing of all Schemas. They are grouped into Page Schemas, Component Schemas and invalid Schemas
Public method GetSchemasSimple
Retrieves collection of basic information of all Schemas, grouped into Page Schemas and Component Schemas
Public method RemoveFavoriteSchemaField
Removes a Schema Field Favorite entry
Public method SaveSchema
Creates/updates a single Schema
Public method SyncComponentEmbedsToSchema
Synchronizes specified Component Embeds to the latest version of their Schema. This operations will update the Pages the component embeds reside at, based on the component schemas, by adding and removing fields to match the new Schema version. It will leave all the presentation related fields in the component embeds alone.
Public method SyncComponentUnitsToSchema
Synchronizes specified Component content units' component embeds to the latest version of their Schema. This operations will update the Content units the component embeds reside at, based on the component schemas, by adding and removing fields to match the new Schema version.
Public method SyncPagesToSchema
Synchronizes specified Pages to the latest version of their Schema. This operations will update Pages based on the Schema, but adding and removing fields to match the new Schema version. It will not touch any element or attribute values of the Pages.
Public method ToggleFavoriteAvailability
Toggles whether the Schema Field Favorite entry is available to everybody, or only the creator.
Top
See Also

Reference