Page.getBrokenLinks (Method)

Returns zero or more structures, each containing information about one of a page's broken links.

Returns:

Page_GetBrokenLinks_Result (query)

Each row of the returned query results has the following fields:

Field Name	Type	Description
BrokenLinkType	String	The type of problem, either 'Broken', 'Deleted', etc.
linktargetid	NonNegativeInteger	The ID of the link's target or 0.
linktype	LinkType	The link's type.; for example, 3 (Mail To), 5 (External Image), 10 (Pop-up Menu), and so on.
Message	PlainText_NonNull	The message about the type of problem that occurred, which is either missing or broken.
pageLevel	String	List of levels for the presence of the link - page or the template names.
URL	String	The URL of page supposedly linked to.
VersionState	VersionStateList	The version state of the element containing the link; for example, 2 (Current), 3 (WIP), or 4 (Pending Approval).

Arguments:

Name	Type	Required	Description
pageID	RealPageID_NonBaseTemplate	Required	A page's ID.
versionStateList	HistoryCurrentWIP_List_EmptyString	Optional. Defaults to '2'.	A comma-delimited list of one or more integers representing version states; for example, a list member can have values such as 1(History), 2 (Current), 3 (WIP), or an empty string for all version states.
linkStatusFilter	LinkStatusList	Optional. Defaults to 'Deleted,Broken'.	A comma delimited list of possible link statuses to be returned. Possible values include 'valid', 'broken', 'deleted', 'ignore', 'syntaxvalid' and 'unchecked'.
includeTemplates	Boolean	Optional. Defaults to '0'.	Boolean value indicating if the templates from which the page is inherited should be included or not.

Context:

License Requirements	None
Permission Requirements	ContributorOrServerCode
Deny Context	None
Require Context	None
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	This method may be customized at the site level

Error Codes:

None

Notes:

None