SchemaDesignerServices Methods

Ingeniux CMS Web Services API

The SchemaDesignerServices type exposes the following members.

Methods

  NameDescription
Public methodAddFavoriteSchemaField
Creates a new Schema Favorite entry
Public methodDeleteSchemas
Deletes a collection of Schemas by their unique Ids
Public methodCode exampleGetContentUnits
Retrieves a list of Content Units, based on the filtering data
Public methodGetFavoriteSchemaFields
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 methodGetSchemaAssets
Public methodGetSchemaChangeEfforts
Calculated 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 methodGetSchemaChangeEffortsForComponentEmbeds
Calculates 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 methodGetSchemaChangeEffortsForComponentUnit
Calculates 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 methodGetSchemaComponentContentUnits
Public methodGetSchemaComponentEmbeds
Public methodGetSchemaDetails
Retrieves full details of a single Schema
Public methodGetSchemaFieldCandidates
Gets all Field types as candidates for Schema construction. The collection is grouped by purpose or application of the Field type.
Public methodGetSchemaOutofSyncAssets
Retrieves the out of sync Pages created with given Schema. Out of sync Pages are Pages referring previous versions of the Schema
Public methodGetSchemaOutofSyncComponentContentUnits
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 methodGetSchemaOutOfSyncComponentEmbeds
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 methodGetSchemaOutofSyncPages
Retrieves the out of sync Pages created with given Schema. Out of sync Pages are Pages referring previous versions of the Schema
Public methodGetSchemaPages
Public methodGetSchemas
Retrieves listing of all Schemas. They are grouped into Page Schemas, Component Schemas and invalid Schemas
Public methodGetSchemasSimple
Retrieves collection of basic information of all Schemas, grouped into Page Schemas and Component Schemas
Public methodRemoveFavoriteSchemaField
Removes a Schema Field Favorite entry
Public methodSaveSchema
Creates/updates a single Schema
Public methodSetBlockedUserGroupsToSchema
Sets the listing of User Groups that are not allowed to use the specified Schema or Asset Schema
Public methodSyncComponentEmbedsToSchema
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 methodSyncComponentUnitsToSchema
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 methodSyncPagesToSchema
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 methodToggleFavoriteAvailability
Toggles whether the Schema Field Favorite entry is available to everybody, or only the creator.
Public methodUploadSchemas
Uploads to create or update a Schema with a schema xml file. Can choose whether to update existing schema, and whether to skip draft mode
Public methodUploadThumbnail
Uploads a thumbnail image for a given schema
Top
See Also

Reference