CCAPI Page - Revision history

Gcronkright: /* Overview */

2025-02-05T21:11:15Z

‎Overview

Renee.mckechnie at 22:49, 20 December 2009

2009-12-20T22:49:53Z

Renee.mckechnie at 16:14, 22 November 2009

2009-11-22T16:14:38Z

Renee.mckechnie: Created page with '== Overview == The Create Page library utility allows you to easily create and delete CommonSpot pages using the CCAPI. The utility works similarly to the standard out of the bo…'

2009-11-22T16:13:51Z

Created page with '== Overview == The Create Page library utility allows you to easily create and delete CommonSpot pages using the CCAPI. The utility works similarly to the standard out of the bo…'

New page

== Overview ==
The Create Page library utility allows you to easily create and delete CommonSpot pages using the CCAPI. The utility works similarly to the standard out of the box CCAPI samples found in the /commonspot/samples/contentCreationAPI/ directory except it is simpler to use.

== Example Usage ==

<cfscript>
// create the standard metadata
stdMetadata = structNew();
stdMetadata["name"] = "My Page Name";
stdMetadata["title"] = "My Page Title";
stdMetadata["templateID"]= 1023;
stdMetadata["subsiteID"] = 12;
custMetadata = structNew();
custMetadata["formName"] = structNew();
custMetadata["formName"]["fieldName"] = "value 1";
// create the page CFC
csPage = server.ADF.getBean("CSPage_1_0");
// create the page
csPage.createPage(stdMetadata, custMetadata);
</cfscript>

<cfscript>
// create the deleted page data
tmp = structNew();
tmp["pageID"] = 22323;
tmp["subsiteID"] = 122;
// create the page CFC
csPage = server.ADF.getBean("CSPage_1_0");
// create the page
csPage.deletePage(tmp);
</cfscript>

Note: You must provide the following fields in stdMetadata to ensure success:
# Name (this will be converted to a valid name for you)
# Title (this is limited to 255 characters)
# SubsiteID (where do you want your page to be created)
# TemplateID (the page your page should be created from
All other field for Standard Metadata are optional

← Older revision		Revision as of 21:11, 5 February 2025
Line 1:		Line 1:
	== Overview ==		== Overview ==
		+
		+	IMPORTANT: With the release of CommonSpot 11 and ADF 2.7 it is recommended to use the CommonSpot Custom Data API or the ADF's ceRecordAPI wrappers to 'populate custom elements' instead of using CCAPI. See the [[ceRecordAPI Reference]] for more info.
		+
	The Create Page library utility allows you to easily create and delete CommonSpot pages using the CCAPI. The utility works similarly to the standard out of the box CCAPI samples found in the /commonspot/samples/contentCreationAPI/ directory except it is simpler to use.		The Create Page library utility allows you to easily create and delete CommonSpot pages using the CCAPI. The utility works similarly to the standard out of the box CCAPI samples found in the /commonspot/samples/contentCreationAPI/ directory except it is simpler to use.

@@ Line 31: / Line 31: @@
   </cfscript>
- Note: You must provide the following fields in stdMetadata to ensure success:
-. Name (this will be converted to a valid name for you)
+Note: You must provide the following fields in stdMetadata to ensure success:
-. Title (this is limited to 255 characters)
+* Name (this will be converted to a valid name for you)
-. SubsiteID (where do you want your page to be created)
+* Title (this is limited to 255 characters)
-. TemplateID (the page your page should be created from
+* SubsiteID (where do you want your page to be created)
- All other field for Standard Metadata are optional
+* TemplateID (the page your page should be created from