CreateAction Element

System.Object
  ActionType
    CreateAction
Client Declaration
  public class CreateAction

Represents a pending action for creating a new Content Engine object. For more information, see the Java™ API Create class topic.

The TargetSpecification attribute of the ChangeRequest element specifies the scope object in which the new object is to be created:

  • For new ObjectStore, AddOn, MarkingSet, and FixedContentDevice objects, the scope object must be the local Content Cortex domain.
  • For new ClassDefinition objects, the scope object must be the class definition for the superclass of the class definition that is being created.
  • For all other objects, the scope object is the object store to which the new object will belong.

If you are creating an object store, the ActionProperties attribute of the ChangeRequest element must reference ListOfString elements to hold a list of administrative security principals that are named "Administrators" and general user security principals that are named "GeneralUsers."

Element Structure

Attributes
  • Boolean autoUniqueContainmentName: [request] Optional expression that specifies whether the new object's containment name is auto-generated until a unique name is found. This attribute is valid only for ReferentialContainmentRelationship and DynamicReferentialContainmentRelationship objects; otherwise, it is ignored.
  • String classId: [request] Required expression that identifies the type of class to be instantiated. This attribute can be specified as either a symbolic name or a GUID.
  • Boolean defineSecurityParentage: [request] Optional expression that indicates whether the SecurityFolder property of the object that is referenced by the ReferentialContainmentRelationship object's Head property is set to the Folder object referenced by the ReferentialContainmentRelationship object's Tail property (in the same transaction). This attribute is valid for ReferentialContainmentRelationship and DynamicReferentialContainmentRelationship objects only; otherwise, it is ignored.
  • GuidType objectId: [request] Optional expression that specifies a GUID to assign to the object to be created. If this attribute is not specified, the server automatically assigns a GUID to the new object.
  • ReservationType reservationType: [request] Optional expression that specifies whether a collaborative or exclusive reservation is to be created. This attribute is valid only for versionable objects and only if the CreateAction action is not combined with the CheckinAction action; otherwise, it is ignored.
  • GuidType versionSeriesId: [request] Optional expression that specifies a GUID to assign to the new associated VersionSeries object that is created to hold document versions of the new object. If this attribute is not specified, the server automatically assigns a GUID to the new VersionSeries object. This attribute is valid for versionable objects only; otherwise, it is ignored.
Attributes Specific to .NET Clients
  • Boolean autoUniqueContainmentNameSpecified: Optional expression that specifies whether autoUniqueContainmentName has a value (true) or not (false).
  • Boolean defineSecurityParentageSpecified: Optional expression that specifies whether defineSecurityParentage has a value (true) or not (false).
  • Boolean reservationTypeSpecified: Optional expression that specifies whether reservationType has a value (true) or not (false).

Code Example

CreateAction objCreate = new CreateAction();
objCreate.classId = "Folder";

XML Schema

<xsd:complexType name="CreateAction">
   <xsd:complexContent>
      <xsd:extension base="ActionType">
         <xsd:attribute name="classId" type="xsd:string" use="required"/>
         <xsd:attribute name="objectId" type="GuidType"/>
         <xsd:attribute name="autoUniqueContainmentName" type="xsd:boolean"/>
         <xsd:attribute name="defineSecurityParentage" type="xsd:boolean"/>
         <xsd:attribute name="versionSeriesId" type="GuidType"/>
         <xsd:attribute name="reservationType" type="ReservationType"/>
      </xsd:extension>
   </xsd:complexContent>
</xsd:complexType>