SOAP API Link Service

The SOAP API link service asset manages the link functions of the SOAP server, including creating, deleting, moving, and updating links.

To add a SOAP API link service, go to Web services  SOAP API link service. For the API to work, it must be created under a SOAP server asset. The API will then be available to enable on the Details screen of the SOAP server.

You can configure the settings of the SOAP API link service on its associated asset screens. The majority of these screens are similar to those for a standard page. They are described in the Asset screens documentation. This documentation will describe the Details screen, which is different for a SOAP API link service.

Details screen

The Details screen allows you to configure the interface functions for the SOAP API link service. Read the Asset screens documentation for more information about the Status, Future status, Thumbnail, and Details sections.

Interface settings

This section allows you to control which functions the SOAP API asset service will provide when enabled on a SOAP server.

To enable the functions for the SOAP asset service:

  1. Click Edit on the Details screen.

  2. Select the Enabled checkbox beside the function list you want to make available on the API.

  3. Click Save to make the selected functions available to use.

The Operations section below contains a full explanation of each function.

Operations

The operations that are managed by the SOAP API link service are as follows:

The CreateAssetLink operation will create a link between two specified assets. The parameters available for this operation are as follows:

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

MajorID [string]

The asset ID of the asset being linked to the minor asset (that is, the major asset in the link, the Linked Parent). This parameter is mandatory.

1

1

simple

MinorID [string]

The asset ID of the asset linking to the major asset (that is, the minor asset in the link, the Linked ). This parameter is mandatory.

1

1

simple

LinkType [LinkTypeValue]

The Link Type value of the asset to create. For example, enter 4 to set the link type as a invisible link. Read the Using the asset tree documentation for more information on the available link type values. The default value for this parameter is 1.

0

1

simple

LinkValue [string]

The value to associate with the asset Link Type.

0

1

simple

SortOrder [string]

The sort order position that this asset should take on the Linking screen. The default value for this parameter is NULL. To specify a sort order position of 0, pass the value as a string inside quotes: "0".

0

1

simple

IsDependant [string]

Indicates whether the minor asset will be dependently linked to the major asset. The value for this parameter should be either 1 (true) or 0 (false). The default value for this parameter is 0.

0

1

simple

IsExclusive [string]

Indicates whether the minor asset will be exclusively linked to the major asset. An exclusively linked asset will only be able to exist under only one parent. The value for this parameter should be either 1 (true) or 0 (false). The default value for this parameter is 0 (false).

0

1

simple

Example 1. CreateAssetLink request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:CreateAssetLink>
      <MajorID>100</MajorID>
      <MinorID>200</MinorID>
      <LinkType>1</LinkType>
      <LinkValue>link_value</LinkValue>
      <SortOrder>"0"</SortOrder>
      <IsDependant>0</IsDependant>
      <IsExclusive>0</IsExclusive>
    </ns1:CreateAssetLink>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

CreateAssetLinkSoapOutput (CreateAssetLinkResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

CreateAssetLinkResult [string]

0

1

simple

Example 2. CreateAssetLink response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:CreateAssetLinkResponse>
      <CreateAssetLinkResult>620</CreateAssetLinkResult>
    </ns1:CreateAssetLinkResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

The DeleteAssetLink operation will delete a specified link between two assets. The parameters available for this operation are as follows:

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

LinkID [string]

The asset ID of the link to delete. This parameter is mandatory.

1

1

simple

Example 3. DeleteAssetLink request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:DeleteAssetLink>
      <LinkID>1000</LinkID>
    </ns1:DeleteAssetLink>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

DeleteAssetLinkSoapOutput (DeleteAssetLinkResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

DeleteAssetLinkResult [boolean]

0

1

simple

Example 4. DeleteAssetLink response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:DeleteAssetLinkResponse>
      <DeleteAssetLinkResult>true</DeleteAssetLinkResult>
    </ns1:DeleteAssetLinkResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

The GetAllChildLinks operation will return all child links from a specified asset. The parameters available for this operation are as follows:

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset from which to return child links. This parameter is mandatory.

1

1

simple

LinkType [LinkTypeValue]

The LinkType of child links to return. This allows you to define specific link types to return. Read the Using the asset tree documentation for more information on the available link type values. The default value for this parameter is 0.

0

1

simple

Example 5. GetAllChildLinks request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetAllChildLinks>
      <AssetID>100</AssetID>
      <LinkType>2</LinkType>
    </ns1:GetAllChildLinks>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetAllChildLinksSoapOutput (GetAllChildLinksResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

GetAllChildLinksResult [LinkDetails]

0

/

complex

Example 6. GetAllChildLinks response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetAllChildLinksResponse>
      <GetAllChildLinksResult>
        <TreeID>00000000</TreeID>
        <LinkID>72</LinkID>
        <Level>2</Level>
        <AssetID>170</AssetID>
         <TypeCode>bodycopy</TypeCode>
        <LinkType>2</LinkType>
        <SortOrder>0</SortOrder>
        <Value></Value>
        <IsDependant>1</IsDependant>
        <IsExclusive>1</IsExclusive>
      </GetAllChildLinksResult>
      <GetAllChildLinksResult>
        <TreeID>000000000000</TreeID>
        <LinkID>73</LinkID>
        <Level>3</Level>
        <AssetID>171</AssetID>
        <TypeCode>bodycopy_div</TypeCode>
        <LinkType>2</LinkType>
        <SortOrder>0</SortOrder>
        <Value></Value>
        <IsDependant>1</IsDependant>
        <IsExclusive>0</IsExclusive>
      </GetAllChildLinksResult>
    </ns1:GetAllChildLinksResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetChildren

The GetChildren operation will return the children of a specified asset. The parameters available for this operation are as follows:

GetChildrenSoapInput (GetChildren)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset to return children from. This parameter is mandatory.

1

1

simple

TypeCode [string]

The asset type of the assets to return.

0

1

simple

StrictTypeCode [string]

Indicates whether to return only assets of the specified asset type or also include its subclasstypes. The value for this parameter should be either TRUE (specified asset type) or FALSE (include subclasses) (or 1 or 0). The default value for this parameter is TRUE.

0

1

simple

Dependant [string]

Indicates whether to return assets that are dependently linked to the specified asset ID or only non-dependant assets. The value for this parameter should be either TRUE (dependant) or FALSE (non-dependant) (or 1 or 0). The default value for this parameter is NULL.

0

1

simple

SortBy [string]

The sort value, indicating how the returned results will be ordered. For example, type_code, short_name or created. The default value for this parameter is NULL.

0

1

simple

PermissionLevel [string]

The permission level of the assets to return. The value for this parameter should be Read, Write or Admin. The default value for this parameter is NULL.

0

1

simple

EffectiveAccess [string]

Indicates whether effective access will be used. This means that if Write permission is selected, Read will also be selected. Similarly, if Admin permission is selected, both Read and Write permission will be selected. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is TRUE.

0

1

simple

MinDepth [string]

Specifies minimum number of levels below the specified asset returned child assets must be. The default value for this parameter is NULL.

0

1

simple

MaxDepth [string]

Specifies maximum number of levels below the specified asset returned child assets must be. The default value for this parameter is NULL.

0

1

simple

DirectShadowsOnly [string]

Indicates whether to return only direct shadow asset children or all shadow asset children of different levels. The value for this parameter should be either TRUE (direct) or FALSE (all) (or 1 or 0). The default value for this parameter is TRUE.

0

1

simple

LinkValueWanted [string]

The link values for which to return the children. This allows you to define specifically linked child assets to return. The default value for this parameter is NULL.

0

1

simple

Example 7. GetChildren request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetChildren>
      <AssetID>100</AssetID>
      <TypeCode>page</TypeCode>
      <StrictTypeCode>0</StrictTypeCode>
      <Dependant>0</Dependant>
      <SortBy>short_name</SortBy>
      <PermissionLevel>admin</PermissionLevel>
      <EffectiveAccess>1</EffectiveAccess>
      <MinDepth>1</MinDepth>
      <MaxDepth>5</MaxDepth>
     </ns1:GetChildren>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetChildrenSoapOutput (GetChildrenResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

GetChildrenResult [ChildrenInfoSummary]

0

/

complex

Example 8. GetChildren response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetChildrenResponse>
      <GetChildrenResult>
        <AssetID>270</AssetID>
        <TypeCode>page_standard</TypeCode>
      </GetChildrenResult>
      <GetChildrenResult>
        <AssetID>283</AssetID>
        <TypeCode>page_standard</TypeCode>
      </GetChildrenResult>
    <ns1:GetChildrenResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetDependantChildren

The GetDependantChildren operation will return dependant children of a specified asset. The parameters available for this operation are as follows:

GetDependantChildrenSoapInput (GetDependantChildren)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset to return dependant children from. This parameter is mandatory.

1

1

simple

TypeCode [AssetType]

The asset type of the assets to return. This allows you to define specific asset types to return.

0

1

simple

StrictTypeCode [boolean]

Indicates whether to return only assets of the specified asset type or also include its subclass types. The value for this parameter should be either TRUE (specified asset type) or FALSE (include subclasses). The default value for this parameter is TRUE.

0

1

simple

Example 9. GetDependantChildren request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetDependantChildren>
      <AssetID>70</AssetID>
      <TypeCode>bodycopy</TypeCode>
      <StrictTypeCode>FALSE</StrictTypeCode>
    </ns1:GetDependantChildren>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetDependantChildrenSoapOutput (GetDependantChildrenResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

GetDependantChildrenResult [LinkInfoSummary]

0

/

complex

Example 10. GetDependantChildren response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetDependantChildrenResponse>
      <GetDependantChildrenResult>
        <AssetID>71</AssetID>
        <TypeCode>bodycopy</TypeCode>
      </GetDependantChildrenResult>
    </ns1:GetDependantChildrenResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetDependantParents

The GetDependantParents operation will return the dependant parents of a specified asset. The parameters available for this operation are as follows:

GetDependantParentsSoapInput (GetDependantParents)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset to return dependent parents from. This parameter is mandatory.

1

1

simple

TypeCode [string]

The asset type of the assets to return. This allows you to define specific link types to return.

0

1

simple

StrictTypeCode [boolean]

Indicates whether to return only assets of the specified asset type or also include its subclass types. The value for this parameter should be either TRUE (specified asset type) or FALSE (include subclasses). The default value for this parameter is TRUE.

0

1

simple

IncludeAllDependants [boolean]

Indicates whether to return assets that are dependently linked to the specified asset ID or only non-dependant assets. The value for this parameter should be either TRUE (dependant) or FALSE (non-dependant). The default value for this parameter is TRUE.

0

1

simple

Example 11. GetDependantParents request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetDependantParents>
      <AssetID>100</AssetID>
      <TypeCode>form</TypeCode>
      <StrictTypeCode>FALSE</StrictTypeCode>
      <IncludeAllDependants>TRUE</IncludeAllDependants>
    </ns1:GetDependantParents>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetDependantParentsSoapOutput (GetDependantParentsResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

GetDependantParentsResult [LinkInfoSummary]

0

/

complex

Example 12. GetDependantParents response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetDependantParentsResponse>
      <GetDependantParentsResult>
        <AssetID>99</AssetID>
      </GetDependantParentsResult>
    </ns1:GetDependantParentsResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

The GetLinks operation will return the links of a specified asset. The parameters available for this operation are as follows:

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset to return links from. This parameter is mandatory.

1

1

simple

LinkType [LinkTypeValue]

The link type of asset links to return. This allows you to define specific link levels to return. Read the Using the asset tree documentation for more information on the available link type values. The default value for this parameter is 1.

0

1

simple

TypeCode [AssetType]

The asset type of the assets linked with the selected asset. This allows you to define the links of specific asset types to return. For example, page_standard would only return links to standard pages.

0

1

simple

StrictTypeCode [boolean]

Indicates whether to return only links to the specified asset type or also include its subclass types. The value for this parameter should be either TRUE (specified asset type) or FALSE (include subclasses). The default value for this parameter is TRUE.

0

1

simple

SideOfLink [string]

Indicates which side of the link the asset (specified on the AssetID parameter) is on: either major or minor (case-sensitive). Using the minor option on this parameter will return links where the specified asset is the minor asset (that is, the linked parents of the asset), while the major option will return the links where the asset is the major asset (its linked children). The default value for this parameter is major.

0

1

simple

LinkValue [string]

The link values to return. This allows you to define specific links to return. The default value for this parameter is NULL.

0

1

simple

Dependant [boolean]

Indicates whether the links to return are dependant links. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is NULL.

0

1

simple

Exclusive [boolean]

Indicates whether the links to return are exclusive links. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is NULL.

0

1

simple

SortBy [string]

The sort value, indicating how the returned results will be ordered. For example, type_code, short_name or created. The default value for this parameter is NULL.

0

1

simple

PermissionLevel [string]

The permission level of the assets from which to return links. The value for this parameter should be Read, Write or Admin. The default value for this parameter is NULL.

0

1

simple

Effective [boolean]

Indicates whether effective access will be used. This means that if Write permission is selected, Read permission will also be selected. Similarly, if Admin permission is selected, both Read and Write permission will be selected. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is TRUE.

0

1

simple

Example 13. GetLinks request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetLinks>
      <AssetID>100</AssetID>
      <LinkType>1</LinkType>
      <TypeCode>file</TypeCode>
      <StrictTypeCode>FALSE</StrictTypeCode>
      <SideOfLink>Major</SideOfLink>
      <LinkValue>link_value</LinkValue>
      <Dependant>TRUE</Dependant>
      <Exclusive>FALSE</Exclusive>
      <SortBy>assetid</SortBy>
      <PermissionLevel>read</PermissionLevel>
      <Effective></Effective>
    </ns1:GetLinks>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetLinksSoapOutput (GetLinksResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

GetLinksResult [LinkDetails]

0

/

complex

Example 14. GetLinks response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetLinksResponse>
      <GetLinksResult>
        <LinkID>712</LinkID>
        <MinorID>300</MinorID>
        <MinorTypeCode>word_doc</MinorTypeCode>
        <LinkType>1</LinkType>
        <SortOrder>23</SortOrder>
        <Value></Value>
        <IsDependant>0</IsDependant>
        <IsExclusive>0</IsExclusive>
      </GetLinksResult>
      <GetLinksResult>
        <LinkID>817</LinkID>
        <MinorID>340</MinorID>
        <MinorTypeCode>image</MinorTypeCode>
        <LinkType>1</LinkType>
        <SortOrder>38</SortOrder>
        <Value></Value>
        <IsDependant>0</IsDependant>
        <IsExclusive>0</IsExclusive>
      </GetLinksResult>
    </ns1:GetLinksResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetLinkByAsset

The GetLinkByAssets operation will return all links between two specified assets. The parameters available for this operation are as follows:

GetLinkByAssetSoapInput (GetLinkByAsset)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID

The asset ID of the first specified asset. This parameter is mandatory.

1

1

simple

OtherAssetID

The asset ID of the second specified asset. This parameter is mandatory.

1

1

simple

LinkType

The link type of asset links to return. This allows you to define specific links levels to return. Read the Using the asset tree documentation for more information on the available link type values. The default value for this parameter is NULL.

0

1

simple

LinkValue

The link values to return. This allows you to define specific links to return. The default value for this parameter is NULL.

0

1

simple

SideOfLink

Indicates whether the asset specified in the AssetID parameter is the major or minor of the two assets. This will determine the link information that is returned. By default, the first specified asset will act as the major asset, that is, the linked parent. Using the minor option in this parameter will indicate that the first specified asset is the minor asset, that is, the linked child. The default value for this parameter is major.

0

1

simple

IsDependant

Indicates whether the links to return are dependant links. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is NULL.

0

1

simple

IsExclusive

Indicates whether the links to return are exclusive links. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is NULL.

0

1

simple

Example 15. GetLinkByAsset request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetLinkByAsset>
      <AssetID>70</AssetID>
      <OtherAssetID>69</OtherAssetID>
      <LinkType>1</LinkType>
      <LinkValue>link_value</LinkValue>
      <SideOfLink>minor</SideOfLink>
      <IsDependant>TRUE</IsDependant>
      <IsExclusive>FALSE</IsExclusive>
    </ns1:GetLinkByAsset>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetLinkByAssetSoapOutput (GetLinkByAssetResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type
Example 16. GetLinkByAsset response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetLinkByAssetResponse>
      <GetLinkByAssetResult>
        <LinkID>71</LinkID>
        <MajorID>69</MajorID>
        <MajorTypeCode>site</MajorTypeCode>
        <LinkType>1</LinkType>
        <SortOrder>"0"</SortOrder>
        <Value></Value>
        <IsDependant>0</IsDependant>
        <IsExclusive>0</IsExclusive>
      </GetLinkByAssetResult>
    </ns1:GetLinkByAssetResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetLinkLineages

The GetLinkLineages operation will return the link types, IDs and lineages of a specified asset. The parameters available for this operation are as follows:

GetLinkLineagesSoapInput (GetLinkLineages)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset to return link lineages from. This parameter is mandatory.

1

1

simple

RootNode [string]

Enter a root node to specify the link lineage to return for an asset linked under multiple assets.

0

1

simple

Example 17. GetLinkLineages request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetLinkLineages>
      <AssetID>150</AssetID>
      <RootNode>100</RootNode>
    </ns1:GetLinkLineages>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetLinkLineagesSoapOutput (GetLinkLineagesResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

GetLinkLineagesResult [LineagesDetails]

0

/

complex

Example 18. GetLinkLineages response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
     <ns1:GetLinkLineagesResponse>
      <GetLinkLineagesResult>
        <LinkID>338</LinkID>
        <LinkType>1</LinkType>
        <Lineage>
          <AssetID>69</AssetID>
          <AssetName>Site</AssetName>
          <Order>0</Order>
        </Lineage>
        <Lineage>
          <AssetID>70</AssetID>
          <AssetName>Home</AssetName>
          <Order>1</Order>
        </Lineage>
        <Lineage>
          <AssetID>93</AssetID>
          <AssetName>About Us</AssetName>
          <Order>2</Order>
        </Lineage>
      </GetLinkLineagesResult>
    </ns1:GetLinkLineagesResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetParents

The GetParents operation will return all parents of a specified asset. The parameters available for this operation are as follows:

GetParentsSoapInput (GetParents)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset to return parents from. This parameter is mandatory.

1

1

simple

TypeCode [AssetType]

The asset type of the assets being returned.

0

1

simple

StrictTypeCode [string]

Indicates whether to return only assets of the specified asset type or also include its subclass types. The value for this parameter should be either TRUE (specified asset type) or FALSE (include subclasses) (or 1 or 0). The default value for this parameter is TRUE.

0

1

simple

SortBy [string]

The sort value, indicating how the returned results will be ordered. For example, type_code, short_name or created. The default value for this parameter is NULL.

0

1

simple

PermissionLevel [string]

The permission level of the asset to return link from. The value for this parameter should be Read, Write or Admin. The default value for this parameter is NULL.

0

1

simple

Effective [string]

Indicates whether effective access will be used. This means that if Write permission is selected, Read permission will also be selected. Similarly, if Admin permission is selected, both Read and Write permission will be selected. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is TRUE.

0

1

simple

MinDepth [string]

Specifies the minimum number of levels above the specified asset returned parent assets must be. The default value for this parameter is NULL.

0

1

simple

MaxDepth [string]

Specifies the maximum number of levels above the specified asset returned parents assets must be. The default value for this parameter is NULL.

0

1

simple

DirectShadowOnly [string]

Indicates whether to return only direct shadow asset parents or all shadow asset parents of different levels. The value for this parameter should be either TRUE or FALSE (or 1 or 0). The default value for this parameter is FALSE.

0

1

simple

LinkValueWanted [string]

The link values to return the parent assets for. This allows you to define specifically linked parent assets to return. The default value for this parameter is NULL.

0

1

simple

Example 19. GetParents request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetParents>
      <AssetID>100</AssetID>
      <TypeCode>page_standard</TypeCode>
      <StrictTypeCode>0</StrictTypeCode>
      <SortBy>name</SortBy>
      <PermissionLevel>Write</PermissionLevel>
      <Effective>0</Effective>
      <MinDepth>1</MinDepth>
      <MaxDepth>5</MaxDepth>
      <DirectShadowOnly>1</DirectShadowOnly>
      <LinkValueWanted>link_value</LinkValueWanted>
    </ns1:GetParents>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetParentsSoapOutput (GetParentsResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

GetParentsResult [LinkInfoSummary]

0

/

complex

Example 20. GetParents response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetParentsResponse>
      <GetParentsResult>
        <AssetID>69</AssetID>
        <TypeCode>page_standard</TypeCode>
      </GetParentsResult>
      <GetParentsResult>
        <AssetID>70</AssetID>
        <TypeCode>page_standard</TypeCode>
      </GetParentsResult>
    </ns1:GetParentsResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetParentsUnderTree

The GetParentsUnderTree operation will return the parents of an asset under a link tree, specified by a root node. The parameters available for the operation are as follows:

GetParentsUnderTreeSoapInput (GetParentsUnderTree)

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

AssetID [string]

The asset ID of the asset to return parents from. This parameter is mandatory.

1

1

simple

RootID [string]

The root node ID for the link tree, under which to return parents. This parameter is mandatory.

1

1

simple

MinLevel [string]

Specifies the minimum number of levels above the specified asset returned parent assets must be. This parameter is mandatory. The default value for this parameter is NULL.

1

1

simple

MaxLevel [string]

Specifies the maximum number of levels above the specified asset returned parents assets must be. This parameter is mandatory. The default value for this parameter is NULL.

1

1

simple

Example 21. GetParentsUnderTree request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetParentsUnderTree>
      <AssetID>150</AssetID>
      <RootID>100</RootID>
      <MinLevel>2</MinLevel>
      <MaxLevel>5</MaxLevel>
    </ns1:GetParentsUnderTree>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetParentsUnderTreeSoapOutput (GetParentsUnderTreeResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

Parent Paths [ParentPathsDetails]

0

/

complex

Example 22. GetParentsUnderTree response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetParentsUnderTreeResponse>
      <ParentPaths>
        <LinkID>338</LinkID>
        <LinkType>1</LinkType>
        <ParentAssets>
          <ParentID>70</ParentID>
          <ParentName>Home</ParentName>
        </ParentAssets>
        <ParentAssets>
          <ParentID>93</ParentID>
          <ParentName>About Us</ParentName>
        </ParentAssets>
      </ParentPaths>
    </ns1:GetParentsUnderTreeResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

The MoveLink operation will move a link under a new parent asset. The parameters available for this operation are as follows:

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

LinkID [string]

The asset ID of the link to move. This parameter is mandatory.

1

1

simple

LinkType [LinkTypeValue]

The link type of the link under the new parent asset. Read the Using the asset tree documentation for more information on the available link type values. The default value for this parameter is 0.

0

1

simple

ToParentID [string]

The asset ID of the parent where the link will be moved. The default value for this parameter is 0.

0

1

simple

ToParentPosition [string]

The moved link’s position under its parent in the asset map. The default value for this parameter is 0.

0

1

simple

Example 23. MoveLink request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:MoveLink>
      <LinkID>1000</LinkID>
      <LinkType>2</LinkType>
      <ToParentID>100</ToParentID>
      <ToParentPosition>1</ToParentPosition>
    </ns1:MoveLink>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

MoveLinkSoapOutput (MoveLinkResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

MoveLinkResult [integer]

0

1

simple

Example 24. MoveLink response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:MoveLinkResponse>
      <MoveLinkResult>392</MoveLinkResult>
    </ns1:MoveLinkResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

The UpdateLink operation will update an existing link within the system. The parameters available for this operation are as follows:

Elements - Parameter [Param Type] Description Min Occurs Max Occurs Type

LinkID [string]

The asset ID of the link to update. This parameter is mandatory.

1

1

simple

LinkType [LinkTypeValue]

The link type that this link should be updated to. Read the Using the asset tree documentation for more information on the available link type values. The default value for this parameter is NULL (all link types).

0

1

simple

LinkValue [string]

The link value to use for the updated link. The default value for this parameter is NULL.

0

1

simple

SortOrder [string]

The sort order position that the updated link should take. The default value for this parameter is NULL. To specify a sort order position of 0, pass the value as a string inside quotes: "0".

0

1

simple

Example 25. UpdateLink request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:UpdateLink>
      <LinkID>1000</LinkID>
      <LinkType>2</LinkType>
      <LinkValue>new_value</LinkValue>
      <SortOrder>1</SortOrder>
    </ns1:UpdateLink>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

UpdateLinkSoapOutput (UpdateLinkResponse)

Elements - Parameter [Param Type] Min Occurs Max Occurs Type

UpdateLinkResult [string]

0

1

simple

Example 26. UpdateLink response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:UpdateLinkResponse>
      <UpdateLinkResult>1</UpdateLinkResult>
    </ns1:UpdateLinkResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

© 2015- Squiz Pty Ltd