Versions

Creates a link page version.

post/api/versions/link

Request

  • Base URL: https://www.bakersfieldcity.us
  • URL: https://www.bakersfieldcity.us/api/versions/link
  • Auth: none declared

Request body

VersionIDinteger

Version unique identifier.

Titlestring nullable

Version title

Keywordsstring nullable

Keywords. Used to improve site search results, e.g. commonly-misspelled or alternate words in the content. Separate each word or phrase with a comma.

Descriptionstring nullable

Version description

InternalNotesstring nullable

Internal notes about a version.

PageIDinteger

Page which the content belongs to.

LanguageIsoCodestring nullable
Status0 | 1 | 2 | 10 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 20 | 20 | 21 | 21 | 30 | 40 | 40 | 51

Defines the various statuses supported by items and categories.

0 = Deleted 1 = MovedToArchived 2 = DeletedWithPermissionsIntact 10 = Draft 10 = InActive 11 = DraftExpired 12 = DraftPending 13 = Rejected 14 = Submitted 15 = WaitingForApproval 16 = Void 17 = AwaitingPayment 20 = Expired 20 = PublishedExpired 21 = Pending 21 = PublishedPending 30 = Archived 40 = Published 40 = Active 51 = Closed

StartDatestring date-time nullable

Start date to display the version.

EndDatestring date-time nullable

Expiration date of the version.

ModifiedOnstring date-time

Last modified date.

ModifiedOnUtcstring date-time

Last Modified UTC

ModifiedByinteger

User identifier that modified the version.

CreatedOnstring date-time

Creation date.

CreatedByinteger

User identifier that created the version.

VersionType0 | 1

VersionType

0 = Html 1 = Link

Imagestring nullable

Image uploaded for the version.

ContentCollectionIDstring guid

Unique identifier of the content collection associated with this version.

ArchiveSourceIDinteger nullable

ID of the archive source.

ArchiveReason1 | 2 | 3 | 4

Enum for archive reason.

1 = Manual 2 = Expired 3 = Modified 4 = Unpublished

SubmittedOnstring date-time nullable

Last submitted date.

PublishedOnstring date-time nullable

Last published date.

ArchivedOnstring date-time nullable

Archived date.

ArchivedByinteger nullable

User identifier that archived the version.

ArchiveIsPubliclyVisibleboolean

Whether an archived version is visible to the public.

MigrationArchiveIDinteger nullable

This field map the ID of legacy archive table.

UseTitleForMenuTextboolean

Whether or not Title needs to be used for Menu Text

MiscTagsstring nullable

add tags to the header of the page

PageTagsstring nullable

Suggested tags from the hcms

StatusChangedboolean

Whether or not the status of the version has changed. This will be deleted when we get rid of html and link domain entities since they have no purpose. Hacky but works

SubmittedOrPublishedByinteger

User identifier that submitted or published the version.

TotalRowCountinteger

Total rows in the non-paged result. Used for paging.

SiteImporterInsertboolean

Whether or not the version is being created using SiteImporter functionality from SiteCleanup.

Urlstring nullable

The url of the link.

UseLinkedPageMenuboolean

Whether or not the page will use the linked page's menu structure.

LinkPageIDinteger nullable

Page identifier to which the link is pointed to.

OpenInNewWindowboolean

Whether or not the link opens in a new window.

Response

The id of the created version.

Messagestring nullable

The message to display to the client user about the outcome of the request

Statusstring nullable

Whether the request is a 'Success' or 'Failure'

StatusCodeinteger

Status Code of the response

Changes

No recorded changes to this operation across all 1 revision of this API.