NAV Navigation
Shell HTTP JavaScript Node.JS Ruby Python Java Go

TERMINALFOUR REST API v8.2.18

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The web service API for the TERMINALFOUR Content Management System.

Base URLs:

Terms of service Email: TERMINALFOUR Web: TERMINALFOUR License: Apache 2.0

about

This functionality returns basic information about the system.

getDatabaseInformation

GET /about/database

Example responses

200 Response

{
  "jdbc": {
    "driverName": "string",
    "driverVersion": "string",
    "datasourceClass": "string",
    "connectionClass": "string"
  },
  "database": {
    "name": "string",
    "version": "string",
    "address": "string",
    "connectedUser": "string",
    "sqlSupport": "string",
    "transactions": true
  },
  "queryFactories": [
    "string"
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<InfoUtilsDatabaseObjectDTO>
  <jdbc>
    <driverName>string</driverName>
    <driverVersion>string</driverVersion>
    <datasourceClass>string</datasourceClass>
    <connectionClass>string</connectionClass>
  </jdbc>
  <database>
    <name>string</name>
    <version>string</version>
    <address>string</address>
    <connectedUser>string</connectedUser>
    <sqlSupport>string</sqlSupport>
    <transactions>true</transactions>
  </database>
  <queryFactories>string</queryFactories>
</InfoUtilsDatabaseObjectDTO>

Responses

Status Meaning Description Schema
200 OK successful operation InfoUtilsDatabaseObjectDTO

getEnvironmentInformation

GET /about/environment

Example responses

200 Response

{
  "environmentalVariables": {
    "property1": "string",
    "property2": "string"
  }
}
<?xml version="1.0" encoding="UTF-8" ?>
<InfoUtilsEnvironmentVariablesObjectDTO>
  <environmentalVariables>
    <property1>string</property1>
    <property2>string</property2>
  </environmentalVariables>
</InfoUtilsEnvironmentVariablesObjectDTO>

Responses

Status Meaning Description Schema
200 OK successful operation InfoUtilsEnvironmentVariablesObjectDTO

getGeneralInformation

GET /about/general

Example responses

200 Response

{
  "os": {
    "arch": "string",
    "name": "string",
    "version": "string",
    "systemTime": "string",
    "defaultEncoding": "string",
    "localHostname": "string"
  },
  "t4": {
    "version": {
      "version": "string",
      "minor": 0,
      "major": 0,
      "subMinor": 0
    },
    "dbPatchLevel": 0
  }
}
<?xml version="1.0" encoding="UTF-8" ?>
<InfoUtilsMetaDataDTO>
  <os>
    <arch>string</arch>
    <name>string</name>
    <version>string</version>
    <systemTime>string</systemTime>
    <defaultEncoding>string</defaultEncoding>
    <localHostname>string</localHostname>
  </os>
  <t4>
    <version>
      <version>string</version>
      <minor>0</minor>
      <major>0</major>
      <subMinor>0</subMinor>
    </version>
    <dbPatchLevel>0</dbPatchLevel>
  </t4>
</InfoUtilsMetaDataDTO>

Responses

Status Meaning Description Schema
200 OK successful operation InfoUtilsMetaDataDTO

getLicenceCountInformation

GET /about/licence

Example responses

200 Response

{
  "contentLimit": 0,
  "contentItemsInSystem": 0,
  "itemsCountedForLicence": 0,
  "remaining": 0
}
<?xml version="1.0" encoding="UTF-8" ?>
<InfoUtilsLicenceCountObjectDTO>
  <contentLimit>0</contentLimit>
  <contentItemsInSystem>0</contentItemsInSystem>
  <itemsCountedForLicence>0</itemsCountedForLicence>
  <remaining>0</remaining>
</InfoUtilsLicenceCountObjectDTO>

Responses

Status Meaning Description Schema
200 OK successful operation InfoUtilsLicenceCountObjectDTO

getListenerInformation

GET /about/listeners

Example responses

200 Response

{
  "siteManagerListeners": [
    {
      "property1": "string",
      "property2": "string"
    }
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<InfoUtilsListenerObjectDTO>
  <siteManagerListeners>
    <property1>string</property1>
    <property2>string</property2>
  </siteManagerListeners>
</InfoUtilsListenerObjectDTO>

Responses

Status Meaning Description Schema
200 OK successful operation InfoUtilsListenerObjectDTO

getMetaInformation

GET /about/meta

Example responses

200 Response

{
  "os": {
    "arch": "string",
    "name": "string",
    "version": "string",
    "systemTime": "string",
    "defaultEncoding": "string",
    "localHostname": "string"
  },
  "t4": {
    "version": {
      "version": "string",
      "minor": 0,
      "major": 0,
      "subMinor": 0
    },
    "dbPatchLevel": 0
  }
}
<?xml version="1.0" encoding="UTF-8" ?>
<InfoUtilsMetaDataDTO>
  <os>
    <arch>string</arch>
    <name>string</name>
    <version>string</version>
    <systemTime>string</systemTime>
    <defaultEncoding>string</defaultEncoding>
    <localHostname>string</localHostname>
  </os>
  <t4>
    <version>
      <version>string</version>
      <minor>0</minor>
      <major>0</major>
      <subMinor>0</subMinor>
    </version>
    <dbPatchLevel>0</dbPatchLevel>
  </t4>
</InfoUtilsMetaDataDTO>

Responses

Status Meaning Description Schema
200 OK successful operation InfoUtilsMetaDataDTO

getStatisticsInformation

GET /about/totals

Example responses

200 Response

{
  "content": [
    {
      "property1": {},
      "property2": {}
    }
  ],
  "sections": {
    "property1": {},
    "property2": {}
  },
  "statistics": {
    "property1": {},
    "property2": {}
  }
}
<?xml version="1.0" encoding="UTF-8" ?>
<InfoUtilsStatisticsObjectDTO>
  <content>
    <property1/>
    <property2/>
  </content>
  <sections>
    <property1/>
    <property2/>
  </sections>
  <statistics>
    <property1/>
    <property2/>
  </statistics>
</InfoUtilsStatisticsObjectDTO>

Responses

Status Meaning Description Schema
200 OK successful operation InfoUtilsStatisticsObjectDTO

accesscontrolprofile

These endpoints provide the functionality for interacting with TERMINALFOUR's access control profiles.

list

GET /accesscontrolprofile

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AccessControlProfileView] false none none

action

This endpoint describes returning the list of actions that can be carried out within the TERMINALFOUR system.

list

GET /action

Example responses

200 Response

[
  {
    "key": 0,
    "eventLabel": "string",
    "primaryGroup": {
      "id": 0,
      "name": "string"
    }
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<key>0</key>
<eventLabel>string</eventLabel>
<primaryGroup>
  <id>0</id>
  <name>string</name>
</primaryGroup>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [EventLogDto] false none none

analytics

Describes web service end points for the Analytics services.

getServices

GET /analytics

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "implClass": "string",
    "enabled": true,
    "default": true,
    "details": [
      {
        "id": 0,
        "serviceID": 0,
        "name": "string",
        "value": "string",
        "enabled": true
      }
    ]
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<implClass>string</implClass>
<enabled>true</enabled>
<default>true</default>
<details>
  <id>0</id>
  <serviceID>0</serviceID>
  <name>string</name>
  <value>string</value>
  <enabled>true</enabled>
</details>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AnalyticsServiceMetaData] false none none

getAccounts

GET /analytics/{serviceID}/account

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
type query integer(int32) false none
includeSavedQueries query boolean false none
includeDisabled query boolean false none

Example responses

200 Response

[
  {
    "primaryGroup": {
      "ownershipLevel": 0,
      "group": {
        "id": 0,
        "name": "string",
        "description": "string",
        "emailAddress": "string",
        "createDate": "2019-07-02T14:03:44Z",
        "enabled": true,
        "ldap": true,
        "defaultChannel": 0,
        "deleted": true
      },
      "readLevel": 0,
      "assetType": 0,
      "assetID": 0,
      "groupName": "string",
      "groupID": 0
    },
    "sharedGroups": [
      {
        "ownershipLevel": 0,
        "group": {
          "id": 0,
          "name": "string",
          "description": "string",
          "emailAddress": "string",
          "createDate": "2019-07-02T14:03:44Z",
          "enabled": true,
          "ldap": true,
          "defaultChannel": 0,
          "deleted": true
        },
        "readLevel": 0,
        "assetType": 0,
        "assetID": 0,
        "groupName": "string",
        "groupID": 0
      }
    ],
    "id": 0,
    "serviceID": 0,
    "authorized": true,
    "type": 0,
    "language": "string",
    "name": "string",
    "description": "string",
    "enabled": true,
    "sequence": 0,
    "parent": {
      "id": 0,
      "serviceID": 0,
      "type": 0,
      "language": "string",
      "name": "string",
      "description": "string",
      "enabled": true,
      "sequence": 0
    },
    "savedQueries": [
      {
        "id": 0,
        "accountID": 0,
        "name": "string",
        "description": "string",
        "preload": true,
        "enabled": true,
        "sequence": 0,
        "categories": [
          {
            "id": 0,
            "serviceID": 0,
            "name": "string",
            "description": "string",
            "enabled": true,
            "sequence": 0,
            "assignedQueryIDs": []
          }
        ],
        "queryDetails": [
          {
            "id": 0,
            "queryID": 0,
            "name": "string",
            "value": "string",
            "enabled": true
          }
        ],
        "account": {
          "id": 0,
          "serviceID": 0,
          "type": 0,
          "language": "string",
          "name": "string",
          "description": "string",
          "enabled": true,
          "sequence": 0
        }
      }
    ],
    "assignedChannels": [
      {
        "id": {
          "accountID": 0,
          "channelID": 0,
          "language": "string"
        },
        "serviceID": 0,
        "language": "string",
        "accountID": 0,
        "channelID": 0
      }
    ],
    "details": [
      {
        "id": 0,
        "accountID": 0,
        "name": "string",
        "value": "string",
        "enabled": true
      }
    ],
    "childIDs": [
      0
    ]
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<primaryGroup>
  <ownershipLevel>0</ownershipLevel>
  <group>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <emailAddress>string</emailAddress>
    <createDate>2019-07-02T14:03:44Z</createDate>
    <enabled>true</enabled>
    <ldap>true</ldap>
    <defaultChannel>0</defaultChannel>
    <deleted>true</deleted>
  </group>
  <readLevel>0</readLevel>
  <assetType>0</assetType>
  <assetID>0</assetID>
  <groupName>string</groupName>
  <groupID>0</groupID>
</primaryGroup>
<sharedGroups>
  <ownershipLevel>0</ownershipLevel>
  <group>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <emailAddress>string</emailAddress>
    <createDate>2019-07-02T14:03:44Z</createDate>
    <enabled>true</enabled>
    <ldap>true</ldap>
    <defaultChannel>0</defaultChannel>
    <deleted>true</deleted>
  </group>
  <readLevel>0</readLevel>
  <assetType>0</assetType>
  <assetID>0</assetID>
  <groupName>string</groupName>
  <groupID>0</groupID>
</sharedGroups>
<id>0</id>
<serviceID>0</serviceID>
<authorized>true</authorized>
<type>0</type>
<language>string</language>
<name>string</name>
<description>string</description>
<enabled>true</enabled>
<sequence>0</sequence>
<parent>
  <id>0</id>
  <serviceID>0</serviceID>
  <type>0</type>
  <language>string</language>
  <name>string</name>
  <description>string</description>
  <enabled>true</enabled>
  <sequence>0</sequence>
</parent>
<savedQueries>
  <id>0</id>
  <accountID>0</accountID>
  <name>string</name>
  <description>string</description>
  <preload>true</preload>
  <enabled>true</enabled>
  <sequence>0</sequence>
  <categories>
    <id>0</id>
    <serviceID>0</serviceID>
    <name>string</name>
    <description>string</description>
    <enabled>true</enabled>
    <sequence>0</sequence>
  </categories>
  <queryDetails>
    <id>0</id>
    <queryID>0</queryID>
    <name>string</name>
    <value>string</value>
    <enabled>true</enabled>
  </queryDetails>
  <account>
    <id>0</id>
    <serviceID>0</serviceID>
    <type>0</type>
    <language>string</language>
    <name>string</name>
    <description>string</description>
    <enabled>true</enabled>
    <sequence>0</sequence>
  </account>
</savedQueries>
<assignedChannels>
  <id>
    <accountID>0</accountID>
    <channelID>0</channelID>
    <language>string</language>
  </id>
  <serviceID>0</serviceID>
  <language>string</language>
  <accountID>0</accountID>
  <channelID>0</channelID>
</assignedChannels>
<details>
  <id>0</id>
  <accountID>0</accountID>
  <name>string</name>
  <value>string</value>
  <enabled>true</enabled>
</details>
<childIDs>0</childIDs>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AnalyticsAccountDTO] false none none
» sharedGroups [AssetSharingInformation] false none none
» assignedChannels [AnalyticsAccountChannel] false none none
» details [AnalyticsAccountDetail] false none none

addAccount

POST /analytics/{serviceID}/account

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none

Example responses

200 Response

{
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": 0,
      "name": "string",
      "description": "string",
      "emailAddress": "string",
      "createDate": "2019-07-02T14:03:44Z",
      "enabled": true,
      "ldap": true,
      "defaultChannel": 0,
      "deleted": true
    },
    "readLevel": 0,
    "assetType": 0,
    "assetID": 0,
    "groupName": "string",
    "groupID": 0
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {
        "id": 0,
        "name": "string",
        "description": "string",
        "emailAddress": "string",
        "createDate": "2019-07-02T14:03:44Z",
        "enabled": true,
        "ldap": true,
        "defaultChannel": 0,
        "deleted": true
      },
      "readLevel": 0,
      "assetType": 0,
      "assetID": 0,
      "groupName": "string",
      "groupID": 0
    }
  ],
  "id": 0,
  "serviceID": 0,
  "authorized": true,
  "type": 0,
  "language": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "sequence": 0,
  "parent": {
    "id": 0,
    "serviceID": 0,
    "type": 0,
    "language": "string",
    "name": "string",
    "description": "string",
    "enabled": true,
    "sequence": 0
  },
  "savedQueries": [
    {
      "id": 0,
      "accountID": 0,
      "name": "string",
      "description": "string",
      "preload": true,
      "enabled": true,
      "sequence": 0,
      "categories": [
        {
          "id": 0,
          "serviceID": 0,
          "name": "string",
          "description": "string",
          "enabled": true,
          "sequence": 0,
          "assignedQueryIDs": [
            0
          ]
        }
      ],
      "queryDetails": [
        {
          "id": 0,
          "queryID": 0,
          "name": "string",
          "value": "string",
          "enabled": true
        }
      ],
      "account": {
        "id": 0,
        "serviceID": 0,
        "type": 0,
        "language": "string",
        "name": "string",
        "description": "string",
        "enabled": true,
        "sequence": 0
      }
    }
  ],
  "assignedChannels": [
    {
      "id": {
        "accountID": 0,
        "channelID": 0,
        "language": "string"
      },
      "serviceID": 0,
      "language": "string",
      "accountID": 0,
      "channelID": 0
    }
  ],
  "details": [
    {
      "id": 0,
      "accountID": 0,
      "name": "string",
      "value": "string",
      "enabled": true
    }
  ],
  "childIDs": [
    0
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<AnalyticsAccountDTO>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <emailAddress>string</emailAddress>
      <createDate>2019-07-02T14:03:44Z</createDate>
      <enabled>true</enabled>
      <ldap>true</ldap>
      <defaultChannel>0</defaultChannel>
      <deleted>true</deleted>
    </group>
    <readLevel>0</readLevel>
    <assetType>0</assetType>
    <assetID>0</assetID>
    <groupName>string</groupName>
    <groupID>0</groupID>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <emailAddress>string</emailAddress>
      <createDate>2019-07-02T14:03:44Z</createDate>
      <enabled>true</enabled>
      <ldap>true</ldap>
      <defaultChannel>0</defaultChannel>
      <deleted>true</deleted>
    </group>
    <readLevel>0</readLevel>
    <assetType>0</assetType>
    <assetID>0</assetID>
    <groupName>string</groupName>
    <groupID>0</groupID>
  </sharedGroups>
  <id>0</id>
  <serviceID>0</serviceID>
  <authorized>true</authorized>
  <type>0</type>
  <language>string</language>
  <name>string</name>
  <description>string</description>
  <enabled>true</enabled>
  <sequence>0</sequence>
  <parent>
    <id>0</id>
    <serviceID>0</serviceID>
    <type>0</type>
    <language>string</language>
    <name>string</name>
    <description>string</description>
    <enabled>true</enabled>
    <sequence>0</sequence>
  </parent>
  <savedQueries>
    <id>0</id>
    <accountID>0</accountID>
    <name>string</name>
    <description>string</description>
    <preload>true</preload>
    <enabled>true</enabled>
    <sequence>0</sequence>
    <categories>
      <id>0</id>
      <serviceID>0</serviceID>
      <name>string</name>
      <description>string</description>
      <enabled>true</enabled>
      <sequence>0</sequence>
      <assignedQueryIDs>0</assignedQueryIDs>
    </categories>
    <queryDetails>
      <id>0</id>
      <queryID>0</queryID>
      <name>string</name>
      <value>string</value>
      <enabled>true</enabled>
    </queryDetails>
    <account>
      <id>0</id>
      <serviceID>0</serviceID>
      <type>0</type>
      <language>string</language>
      <name>string</name>
      <description>string</description>
      <enabled>true</enabled>
      <sequence>0</sequence>
    </account>
  </savedQueries>
  <assignedChannels>
    <id>
      <accountID>0</accountID>
      <channelID>0</channelID>
      <language>string</language>
    </id>
    <serviceID>0</serviceID>
    <language>string</language>
    <accountID>0</accountID>
    <channelID>0</channelID>
  </assignedChannels>
  <details>
    <id>0</id>
    <accountID>0</accountID>
    <name>string</name>
    <value>string</value>
    <enabled>true</enabled>
  </details>
  <childIDs>0</childIDs>
</AnalyticsAccountDTO>

Responses

Status Meaning Description Schema
200 OK successful operation AnalyticsAccountDTO

getAccount

GET /analytics/{serviceID}/account/{accountID}

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
accountID path integer(int32) true none
includeSavedQueries query boolean false none

Example responses

200 Response

{
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": 0,
      "name": "string",
      "description": "string",
      "emailAddress": "string",
      "createDate": "2019-07-02T14:03:44Z",
      "enabled": true,
      "ldap": true,
      "defaultChannel": 0,
      "deleted": true
    },
    "readLevel": 0,
    "assetType": 0,
    "assetID": 0,
    "groupName": "string",
    "groupID": 0
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {
        "id": 0,
        "name": "string",
        "description": "string",
        "emailAddress": "string",
        "createDate": "2019-07-02T14:03:44Z",
        "enabled": true,
        "ldap": true,
        "defaultChannel": 0,
        "deleted": true
      },
      "readLevel": 0,
      "assetType": 0,
      "assetID": 0,
      "groupName": "string",
      "groupID": 0
    }
  ],
  "id": 0,
  "serviceID": 0,
  "authorized": true,
  "type": 0,
  "language": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "sequence": 0,
  "parent": {
    "id": 0,
    "serviceID": 0,
    "type": 0,
    "language": "string",
    "name": "string",
    "description": "string",
    "enabled": true,
    "sequence": 0
  },
  "savedQueries": [
    {
      "id": 0,
      "accountID": 0,
      "name": "string",
      "description": "string",
      "preload": true,
      "enabled": true,
      "sequence": 0,
      "categories": [
        {
          "id": 0,
          "serviceID": 0,
          "name": "string",
          "description": "string",
          "enabled": true,
          "sequence": 0,
          "assignedQueryIDs": [
            0
          ]
        }
      ],
      "queryDetails": [
        {
          "id": 0,
          "queryID": 0,
          "name": "string",
          "value": "string",
          "enabled": true
        }
      ],
      "account": {
        "id": 0,
        "serviceID": 0,
        "type": 0,
        "language": "string",
        "name": "string",
        "description": "string",
        "enabled": true,
        "sequence": 0
      }
    }
  ],
  "assignedChannels": [
    {
      "id": {
        "accountID": 0,
        "channelID": 0,
        "language": "string"
      },
      "serviceID": 0,
      "language": "string",
      "accountID": 0,
      "channelID": 0
    }
  ],
  "details": [
    {
      "id": 0,
      "accountID": 0,
      "name": "string",
      "value": "string",
      "enabled": true
    }
  ],
  "childIDs": [
    0
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<AnalyticsAccountDTO>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <emailAddress>string</emailAddress>
      <createDate>2019-07-02T14:03:44Z</createDate>
      <enabled>true</enabled>
      <ldap>true</ldap>
      <defaultChannel>0</defaultChannel>
      <deleted>true</deleted>
    </group>
    <readLevel>0</readLevel>
    <assetType>0</assetType>
    <assetID>0</assetID>
    <groupName>string</groupName>
    <groupID>0</groupID>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <emailAddress>string</emailAddress>
      <createDate>2019-07-02T14:03:44Z</createDate>
      <enabled>true</enabled>
      <ldap>true</ldap>
      <defaultChannel>0</defaultChannel>
      <deleted>true</deleted>
    </group>
    <readLevel>0</readLevel>
    <assetType>0</assetType>
    <assetID>0</assetID>
    <groupName>string</groupName>
    <groupID>0</groupID>
  </sharedGroups>
  <id>0</id>
  <serviceID>0</serviceID>
  <authorized>true</authorized>
  <type>0</type>
  <language>string</language>
  <name>string</name>
  <description>string</description>
  <enabled>true</enabled>
  <sequence>0</sequence>
  <parent>
    <id>0</id>
    <serviceID>0</serviceID>
    <type>0</type>
    <language>string</language>
    <name>string</name>
    <description>string</description>
    <enabled>true</enabled>
    <sequence>0</sequence>
  </parent>
  <savedQueries>
    <id>0</id>
    <accountID>0</accountID>
    <name>string</name>
    <description>string</description>
    <preload>true</preload>
    <enabled>true</enabled>
    <sequence>0</sequence>
    <categories>
      <id>0</id>
      <serviceID>0</serviceID>
      <name>string</name>
      <description>string</description>
      <enabled>true</enabled>
      <sequence>0</sequence>
      <assignedQueryIDs>0</assignedQueryIDs>
    </categories>
    <queryDetails>
      <id>0</id>
      <queryID>0</queryID>
      <name>string</name>
      <value>string</value>
      <enabled>true</enabled>
    </queryDetails>
    <account>
      <id>0</id>
      <serviceID>0</serviceID>
      <type>0</type>
      <language>string</language>
      <name>string</name>
      <description>string</description>
      <enabled>true</enabled>
      <sequence>0</sequence>
    </account>
  </savedQueries>
  <assignedChannels>
    <id>
      <accountID>0</accountID>
      <channelID>0</channelID>
      <language>string</language>
    </id>
    <serviceID>0</serviceID>
    <language>string</language>
    <accountID>0</accountID>
    <channelID>0</channelID>
  </assignedChannels>
  <details>
    <id>0</id>
    <accountID>0</accountID>
    <name>string</name>
    <value>string</value>
    <enabled>true</enabled>
  </details>
  <childIDs>0</childIDs>
</AnalyticsAccountDTO>

Responses

Status Meaning Description Schema
200 OK successful operation AnalyticsAccountDTO

modifyAccount

PUT /analytics/{serviceID}/account/{accountID}

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
accountID path integer(int32) true none

Example responses

200 Response

{
  "primaryGroup": {
    "ownershipLevel": 0,
    "group": {
      "id": 0,
      "name": "string",
      "description": "string",
      "emailAddress": "string",
      "createDate": "2019-07-02T14:03:44Z",
      "enabled": true,
      "ldap": true,
      "defaultChannel": 0,
      "deleted": true
    },
    "readLevel": 0,
    "assetType": 0,
    "assetID": 0,
    "groupName": "string",
    "groupID": 0
  },
  "sharedGroups": [
    {
      "ownershipLevel": 0,
      "group": {
        "id": 0,
        "name": "string",
        "description": "string",
        "emailAddress": "string",
        "createDate": "2019-07-02T14:03:44Z",
        "enabled": true,
        "ldap": true,
        "defaultChannel": 0,
        "deleted": true
      },
      "readLevel": 0,
      "assetType": 0,
      "assetID": 0,
      "groupName": "string",
      "groupID": 0
    }
  ],
  "id": 0,
  "serviceID": 0,
  "authorized": true,
  "type": 0,
  "language": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "sequence": 0,
  "parent": {
    "id": 0,
    "serviceID": 0,
    "type": 0,
    "language": "string",
    "name": "string",
    "description": "string",
    "enabled": true,
    "sequence": 0
  },
  "savedQueries": [
    {
      "id": 0,
      "accountID": 0,
      "name": "string",
      "description": "string",
      "preload": true,
      "enabled": true,
      "sequence": 0,
      "categories": [
        {
          "id": 0,
          "serviceID": 0,
          "name": "string",
          "description": "string",
          "enabled": true,
          "sequence": 0,
          "assignedQueryIDs": [
            0
          ]
        }
      ],
      "queryDetails": [
        {
          "id": 0,
          "queryID": 0,
          "name": "string",
          "value": "string",
          "enabled": true
        }
      ],
      "account": {
        "id": 0,
        "serviceID": 0,
        "type": 0,
        "language": "string",
        "name": "string",
        "description": "string",
        "enabled": true,
        "sequence": 0
      }
    }
  ],
  "assignedChannels": [
    {
      "id": {
        "accountID": 0,
        "channelID": 0,
        "language": "string"
      },
      "serviceID": 0,
      "language": "string",
      "accountID": 0,
      "channelID": 0
    }
  ],
  "details": [
    {
      "id": 0,
      "accountID": 0,
      "name": "string",
      "value": "string",
      "enabled": true
    }
  ],
  "childIDs": [
    0
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<AnalyticsAccountDTO>
  <primaryGroup>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <emailAddress>string</emailAddress>
      <createDate>2019-07-02T14:03:44Z</createDate>
      <enabled>true</enabled>
      <ldap>true</ldap>
      <defaultChannel>0</defaultChannel>
      <deleted>true</deleted>
    </group>
    <readLevel>0</readLevel>
    <assetType>0</assetType>
    <assetID>0</assetID>
    <groupName>string</groupName>
    <groupID>0</groupID>
  </primaryGroup>
  <sharedGroups>
    <ownershipLevel>0</ownershipLevel>
    <group>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <emailAddress>string</emailAddress>
      <createDate>2019-07-02T14:03:44Z</createDate>
      <enabled>true</enabled>
      <ldap>true</ldap>
      <defaultChannel>0</defaultChannel>
      <deleted>true</deleted>
    </group>
    <readLevel>0</readLevel>
    <assetType>0</assetType>
    <assetID>0</assetID>
    <groupName>string</groupName>
    <groupID>0</groupID>
  </sharedGroups>
  <id>0</id>
  <serviceID>0</serviceID>
  <authorized>true</authorized>
  <type>0</type>
  <language>string</language>
  <name>string</name>
  <description>string</description>
  <enabled>true</enabled>
  <sequence>0</sequence>
  <parent>
    <id>0</id>
    <serviceID>0</serviceID>
    <type>0</type>
    <language>string</language>
    <name>string</name>
    <description>string</description>
    <enabled>true</enabled>
    <sequence>0</sequence>
  </parent>
  <savedQueries>
    <id>0</id>
    <accountID>0</accountID>
    <name>string</name>
    <description>string</description>
    <preload>true</preload>
    <enabled>true</enabled>
    <sequence>0</sequence>
    <categories>
      <id>0</id>
      <serviceID>0</serviceID>
      <name>string</name>
      <description>string</description>
      <enabled>true</enabled>
      <sequence>0</sequence>
      <assignedQueryIDs>0</assignedQueryIDs>
    </categories>
    <queryDetails>
      <id>0</id>
      <queryID>0</queryID>
      <name>string</name>
      <value>string</value>
      <enabled>true</enabled>
    </queryDetails>
    <account>
      <id>0</id>
      <serviceID>0</serviceID>
      <type>0</type>
      <language>string</language>
      <name>string</name>
      <description>string</description>
      <enabled>true</enabled>
      <sequence>0</sequence>
    </account>
  </savedQueries>
  <assignedChannels>
    <id>
      <accountID>0</accountID>
      <channelID>0</channelID>
      <language>string</language>
    </id>
    <serviceID>0</serviceID>
    <language>string</language>
    <accountID>0</accountID>
    <channelID>0</channelID>
  </assignedChannels>
  <details>
    <id>0</id>
    <accountID>0</accountID>
    <name>string</name>
    <value>string</value>
    <enabled>true</enabled>
  </details>
  <childIDs>0</childIDs>
</AnalyticsAccountDTO>

Responses

Status Meaning Description Schema
200 OK successful operation AnalyticsAccountDTO

deleteAccount

DELETE /analytics/{serviceID}/account/{accountID}

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
accountID path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

getAuthorisationData

GET /analytics/{serviceID}/account/{accountID}/authorisation

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
accountID path integer(int32) true none

Example responses

200 Response

{
  "property1": {},
  "property2": {}
}
<?xml version="1.0" encoding="UTF-8" ?>
<property1/>
<property2/>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» additionalProperties object false none none

deleteAuthorisationData

DELETE /analytics/{serviceID}/account/{accountID}/authorisation

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
accountID path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

getCategories

GET /analytics/{serviceID}/account/{accountID}/category

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
accountID path integer(int32) true none

Example responses

200 Response

[
  {
    "id": 0,
    "serviceID": 0,
    "name": "string",
    "description": "string",
    "enabled": true,
    "sequence": 0,
    "assignedQueryIDs": [
      0
    ]
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<serviceID>0</serviceID>
<name>string</name>
<description>string</description>
<enabled>true</enabled>
<sequence>0</sequence>
<assignedQueryIDs>0</assignedQueryIDs>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AnalyticsCategory] false none none

addCategory

POST /analytics/{serviceID}/account/{accountID}/category

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
accountID path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "serviceID": 0,
  "name": "string",
  "description": "string",
  "enabled": true,
  "sequence": 0,
  "assignedQueryIDs": [
    0
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<AnalyticsCategory>
  <id>0</id>
  <serviceID>0</serviceID>
  <name>string</name>
  <description>string</description>
  <enabled>true</enabled>
  <sequence>0</sequence>
  <assignedQueryIDs>0</assignedQueryIDs>
</AnalyticsCategory>

Responses

Status Meaning Description Schema
200 OK successful operation AnalyticsCategory

getCategory

GET /analytics/{serviceID}/account/{accountID}/category/{categoryID}

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
accountID path integer(int32) true none
categoryID path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "serviceID": 0,
  "name": "string",
  "description": "string",
  "enabled": true,
  "sequence": 0,
  "assignedQueryIDs": [
    0
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<AnalyticsCategory>
  <id>0</id>
  <serviceID>0</serviceID>
  <name>string</name>
  <description>string</description>
  <enabled>true</enabled>
  <sequence>0</sequence>
  <assignedQueryIDs>0</assignedQueryIDs>
</AnalyticsCategory>

Responses

Status Meaning Description Schema
200 OK successful operation AnalyticsCategory

modifyCategory

PUT /analytics/{serviceID}/account/{accountID}/category/{categoryID}

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
accountID path integer(int32) true none
categoryID path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "serviceID": 0,
  "name": "string",
  "description": "string",
  "enabled": true,
  "sequence": 0,
  "assignedQueryIDs": [
    0
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<AnalyticsCategory>
  <id>0</id>
  <serviceID>0</serviceID>
  <name>string</name>
  <description>string</description>
  <enabled>true</enabled>
  <sequence>0</sequence>
  <assignedQueryIDs>0</assignedQueryIDs>
</AnalyticsCategory>

Responses

Status Meaning Description Schema
200 OK successful operation AnalyticsCategory

deleteCategory

DELETE /analytics/{serviceID}/account/{accountID}/category/{categoryID}

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
accountID path integer(int32) true none
categoryID path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

getSavedQueries

GET /analytics/{serviceID}/savedquery

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
ensureDistinctQueryNames query boolean false none

Example responses

200 Response

[
  {
    "id": 0,
    "accountID": 0,
    "name": "string",
    "description": "string",
    "preload": true,
    "enabled": true,
    "sequence": 0,
    "categories": [
      {
        "id": 0,
        "serviceID": 0,
        "name": "string",
        "description": "string",
        "enabled": true,
        "sequence": 0,
        "assignedQueryIDs": [
          0
        ]
      }
    ],
    "queryDetails": [
      {
        "id": 0,
        "queryID": 0,
        "name": "string",
        "value": "string",
        "enabled": true
      }
    ],
    "account": {
      "id": 0,
      "serviceID": 0,
      "type": 0,
      "language": "string",
      "name": "string",
      "description": "string",
      "enabled": true,
      "sequence": 0
    }
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<accountID>0</accountID>
<name>string</name>
<description>string</description>
<preload>true</preload>
<enabled>true</enabled>
<sequence>0</sequence>
<categories>
  <id>0</id>
  <serviceID>0</serviceID>
  <name>string</name>
  <description>string</description>
  <enabled>true</enabled>
  <sequence>0</sequence>
  <assignedQueryIDs>0</assignedQueryIDs>
</categories>
<queryDetails>
  <id>0</id>
  <queryID>0</queryID>
  <name>string</name>
  <value>string</value>
  <enabled>true</enabled>
</queryDetails>
<account>
  <id>0</id>
  <serviceID>0</serviceID>
  <type>0</type>
  <language>string</language>
  <name>string</name>
  <description>string</description>
  <enabled>true</enabled>
  <sequence>0</sequence>
</account>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AnalyticsSavedQuery] false none none

addSavedQuery

POST /analytics/{serviceID}/savedquery

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "accountID": 0,
  "name": "string",
  "description": "string",
  "preload": true,
  "enabled": true,
  "sequence": 0,
  "categories": [
    {
      "id": 0,
      "serviceID": 0,
      "name": "string",
      "description": "string",
      "enabled": true,
      "sequence": 0,
      "assignedQueryIDs": [
        0
      ]
    }
  ],
  "queryDetails": [
    {
      "id": 0,
      "queryID": 0,
      "name": "string",
      "value": "string",
      "enabled": true
    }
  ],
  "account": {
    "id": 0,
    "serviceID": 0,
    "type": 0,
    "language": "string",
    "name": "string",
    "description": "string",
    "enabled": true,
    "sequence": 0
  }
}
<?xml version="1.0" encoding="UTF-8" ?>
<AnalyticsSavedQuery>
  <id>0</id>
  <accountID>0</accountID>
  <name>string</name>
  <description>string</description>
  <preload>true</preload>
  <enabled>true</enabled>
  <sequence>0</sequence>
  <categories>
    <id>0</id>
    <serviceID>0</serviceID>
    <name>string</name>
    <description>string</description>
    <enabled>true</enabled>
    <sequence>0</sequence>
    <assignedQueryIDs>0</assignedQueryIDs>
  </categories>
  <queryDetails>
    <id>0</id>
    <queryID>0</queryID>
    <name>string</name>
    <value>string</value>
    <enabled>true</enabled>
  </queryDetails>
  <account>
    <id>0</id>
    <serviceID>0</serviceID>
    <type>0</type>
    <language>string</language>
    <name>string</name>
    <description>string</description>
    <enabled>true</enabled>
    <sequence>0</sequence>
  </account>
</AnalyticsSavedQuery>

Responses

Status Meaning Description Schema
200 OK successful operation AnalyticsSavedQuery

getSavedQuery

GET /analytics/{serviceID}/savedquery/{savedQueryID}

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
savedQueryID path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "accountID": 0,
  "name": "string",
  "description": "string",
  "preload": true,
  "enabled": true,
  "sequence": 0,
  "categories": [
    {
      "id": 0,
      "serviceID": 0,
      "name": "string",
      "description": "string",
      "enabled": true,
      "sequence": 0,
      "assignedQueryIDs": [
        0
      ]
    }
  ],
  "queryDetails": [
    {
      "id": 0,
      "queryID": 0,
      "name": "string",
      "value": "string",
      "enabled": true
    }
  ],
  "account": {
    "id": 0,
    "serviceID": 0,
    "type": 0,
    "language": "string",
    "name": "string",
    "description": "string",
    "enabled": true,
    "sequence": 0
  }
}
<?xml version="1.0" encoding="UTF-8" ?>
<AnalyticsSavedQuery>
  <id>0</id>
  <accountID>0</accountID>
  <name>string</name>
  <description>string</description>
  <preload>true</preload>
  <enabled>true</enabled>
  <sequence>0</sequence>
  <categories>
    <id>0</id>
    <serviceID>0</serviceID>
    <name>string</name>
    <description>string</description>
    <enabled>true</enabled>
    <sequence>0</sequence>
    <assignedQueryIDs>0</assignedQueryIDs>
  </categories>
  <queryDetails>
    <id>0</id>
    <queryID>0</queryID>
    <name>string</name>
    <value>string</value>
    <enabled>true</enabled>
  </queryDetails>
  <account>
    <id>0</id>
    <serviceID>0</serviceID>
    <type>0</type>
    <language>string</language>
    <name>string</name>
    <description>string</description>
    <enabled>true</enabled>
    <sequence>0</sequence>
  </account>
</AnalyticsSavedQuery>

Responses

Status Meaning Description Schema
200 OK successful operation AnalyticsSavedQuery

modifySavedQuery

PUT /analytics/{serviceID}/savedquery/{savedQueryID}

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
savedQueryID path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "accountID": 0,
  "name": "string",
  "description": "string",
  "preload": true,
  "enabled": true,
  "sequence": 0,
  "categories": [
    {
      "id": 0,
      "serviceID": 0,
      "name": "string",
      "description": "string",
      "enabled": true,
      "sequence": 0,
      "assignedQueryIDs": [
        0
      ]
    }
  ],
  "queryDetails": [
    {
      "id": 0,
      "queryID": 0,
      "name": "string",
      "value": "string",
      "enabled": true
    }
  ],
  "account": {
    "id": 0,
    "serviceID": 0,
    "type": 0,
    "language": "string",
    "name": "string",
    "description": "string",
    "enabled": true,
    "sequence": 0
  }
}
<?xml version="1.0" encoding="UTF-8" ?>
<AnalyticsSavedQuery>
  <id>0</id>
  <accountID>0</accountID>
  <name>string</name>
  <description>string</description>
  <preload>true</preload>
  <enabled>true</enabled>
  <sequence>0</sequence>
  <categories>
    <id>0</id>
    <serviceID>0</serviceID>
    <name>string</name>
    <description>string</description>
    <enabled>true</enabled>
    <sequence>0</sequence>
    <assignedQueryIDs>0</assignedQueryIDs>
  </categories>
  <queryDetails>
    <id>0</id>
    <queryID>0</queryID>
    <name>string</name>
    <value>string</value>
    <enabled>true</enabled>
  </queryDetails>
  <account>
    <id>0</id>
    <serviceID>0</serviceID>
    <type>0</type>
    <language>string</language>
    <name>string</name>
    <description>string</description>
    <enabled>true</enabled>
    <sequence>0</sequence>
  </account>
</AnalyticsSavedQuery>

Responses

Status Meaning Description Schema
200 OK successful operation AnalyticsSavedQuery

deleteSavedQuery

DELETE /analytics/{serviceID}/savedquery/{savedQueryID}

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
savedQueryID path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

updateSavedQueryOrder

PUT /analytics/{serviceID}/account/{accountID}/savedquery/{savedQueryID}/order

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
accountID path integer(int32) true none
savedQueryID path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

getMappings

GET /analytics/{serviceID}/mapping/{accountID}

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none
accountID path integer(int32) true none
language query string false none
tokenType query integer(int32) false none
includeDisabled query boolean false none

Example responses

200 Response

[
  {
    "id": 0,
    "token": "string",
    "tokenWithRegex": "string",
    "tokenLabel": "string",
    "details": [
      {
        "id": 0,
        "mappingID": 0,
        "mappingRule": "string",
        "mappingRuleInput": "string",
        "mappingRuleOverride": "string",
        "enabled": true,
        "sequence": 0
      }
    ]
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<token>string</token>
<tokenWithRegex>string</tokenWithRegex>
<tokenLabel>string</tokenLabel>
<details>
  <id>0</id>
  <mappingID>0</mappingID>
  <mappingRule>string</mappingRule>
  <mappingRuleInput>string</mappingRuleInput>
  <mappingRuleOverride>string</mappingRuleOverride>
  <enabled>true</enabled>
  <sequence>0</sequence>
</details>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AnalyticsResultMappingDTO] false none none

query

POST /analytics/{serviceID}/query

Parameters

Parameter In Type Required Description
serviceID path integer(int32) true none

Example responses

200 Response

{
  "property1": {},
  "property2": {}
}
<?xml version="1.0" encoding="UTF-8" ?>
<property1/>
<property2/>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» additionalProperties object false none none

authmethod

These endpoints allow the viewing, listing, and modification of existing authentication methods in the TERMINALFOUR system.

list

GET /authmethod

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "javaClass": "string",
    "enabled": true,
    "updateUserRecord": true,
    "authMethodMappings": {
      "property1": "string",
      "property2": "string"
    },
    "deactivateUserRecord": true
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<javaClass>string</javaClass>
<enabled>true</enabled>
<updateUserRecord>true</updateUserRecord>
<authMethodMappings>
  <property1>string</property1>
  <property2>string</property2>
</authMethodMappings>
<deactivateUserRecord>true</deactivateUserRecord>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AuthenticationMethod] false none none

get

GET /authmethod/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "javaClass": "string",
  "enabled": true,
  "updateUserRecord": true,
  "authMethodMappings": {
    "property1": "string",
    "property2": "string"
  },
  "deactivateUserRecord": true
}
<?xml version="1.0" encoding="UTF-8" ?>
<AuthenticationMethod>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <javaClass>string</javaClass>
  <enabled>true</enabled>
  <updateUserRecord>true</updateUserRecord>
  <authMethodMappings>
    <property1>string</property1>
    <property2>string</property2>
  </authMethodMappings>
  <deactivateUserRecord>true</deactivateUserRecord>
</AuthenticationMethod>

Responses

Status Meaning Description Schema
200 OK successful operation AuthenticationMethod

modify

PUT /authmethod/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "javaClass": "string",
  "enabled": true,
  "updateUserRecord": true,
  "authMethodMappings": {
    "property1": "string",
    "property2": "string"
  },
  "deactivateUserRecord": true
}
<?xml version="1.0" encoding="UTF-8" ?>
<AuthenticationMethod>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <javaClass>string</javaClass>
  <enabled>true</enabled>
  <updateUserRecord>true</updateUserRecord>
  <authMethodMappings>
    <property1>string</property1>
    <property2>string</property2>
  </authMethodMappings>
  <deactivateUserRecord>true</deactivateUserRecord>
</AuthenticationMethod>

Responses

Status Meaning Description Schema
200 OK successful operation AuthenticationMethod

automirrorcontentconfig

Provides web service end points for operations around auto mirroring of content.

updateAutoMirrorContentConfiguration

POST /automirrorcontentconfig/updateList/{language}

Parameters

Parameter In Type Required Description
language path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

getListAndItems

GET /automirrorcontentconfig/{language}

Parameters

Parameter In Type Required Description
language path string true none

Example responses

200 Response

[
  {
    "listID": 0,
    "listName": "string",
    "language": "string",
    "items": [
      {
        "id": 0,
        "name": "string",
        "sectionID": 0
      }
    ],
    "mirror": true
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<listID>0</listID>
<listName>string</listName>
<language>string</language>
<items>
  <id>0</id>
  <name>string</name>
  <sectionID>0</sectionID>
</items>
<mirror>true</mirror>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AutoMirrorContentConfigDTO] false none none

brokenlink

Provides core web services for managing broken links configuration within the TERMINALFOUR system.

getAllExcludedUrls

GET /brokenlink

Example responses

200 Response

[
  "string"
]
<?xml version="1.0" encoding="UTF-8" ?>string

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

updateBrokenLinkConfiguration

POST /brokenlink

Responses

Status Meaning Description Schema
default Default successful operation None

getExternalLinkChecker

GET /brokenlink/externallinkchecker

Example responses

200 Response

{
  "id": 0,
  "name": "string",
  "status": 0,
  "creationDate": "2019-07-02T14:03:44Z",
  "nextDue": "2019-07-02T14:03:44Z",
  "fixedRate": true,
  "executionInterval": 0,
  "executionCount": 0,
  "alert": {
    "id": 0,
    "from": 0,
    "header": "string",
    "message": "string",
    "level": 0,
    "type": "DEFAULT",
    "userRecipients": [
      0
    ],
    "groupRecipients": [
      0
    ],
    "dispatchMedia": [
      0
    ],
    "emailRecipients": [
      "string"
    ],
    "emailSender": "string",
    "attachments": [
      null
    ],
    "recipients": [
      0
    ]
  },
  "parameters": {
    "property1": {
      "scheduledJob": null,
      "key": "string",
      "value": "string"
    },
    "property2": {
      "scheduledJob": null,
      "key": "string",
      "value": "string"
    }
  },
  "maximumExecutions": 0,
  "jobDescription": "string",
  "jobName": "string",
  "jobKey": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<schedule>
  <id>0</id>
  <name>string</name>
  <status>0</status>
  <creationDate>2019-07-02T14:03:44Z</creationDate>
  <nextDue>2019-07-02T14:03:44Z</nextDue>
  <fixedRate>true</fixedRate>
  <executionInterval>0</executionInterval>
  <executionCount>0</executionCount>
  <alert>
    <id>0</id>
    <from>0</from>
    <header>string</header>
    <message>string</message>
    <level>0</level>
    <type>DEFAULT</type>
    <userRecipients>0</userRecipients>
    <groupRecipients>0</groupRecipients>
    <dispatchMedia>0</dispatchMedia>
    <emailRecipients>string</emailRecipients>
    <emailSender>string</emailSender>
    <attachments/>
    <recipients>0</recipients>
  </alert>
  <parameters>
    <property1>
      <scheduledJob/>
      <key>string</key>
      <value>string</value>
    </property1>
    <property2>
      <scheduledJob/>
      <key>string</key>
      <value>string</value>
    </property2>
  </parameters>
  <maximumExecutions>0</maximumExecutions>
  <jobDescription>string</jobDescription>
  <jobName>string</jobName>
  <jobKey>string</jobKey>
</schedule>

Responses

Status Meaning Description Schema
200 OK successful operation ScheduledJob

updateExternalLinkChecker

POST /brokenlink/externallinkchecker/{cancelJob}/{scheduleId}

Parameters

Parameter In Type Required Description
cancelJob path boolean true none
scheduleId path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

channel

Provides endpoints for web service operations on Channels within the TERMINALFOUR system.

list

GET /channel

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "pendingVersionOutputDir": "string",
    "rootSectionID": 0,
    "hasPendingVersion": true,
    "editable": true,
    "microSites": [
      null
    ],
    "parentID": 0
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<pendingVersionOutputDir>string</pendingVersionOutputDir>
<rootSectionID>0</rootSectionID>
<hasPendingVersion>true</hasPendingVersion>
<editable>true</editable>
<microSites/>
<parentID>0</parentID>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ChannelMetaData] false none none

save

POST /channel

Example responses

200 Response

{
  "id": 0,
  "description": "string",
  "name": "string",
  "parentID": 0,
  "fullName": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ChannelDTO>
  <id>0</id>
  <description>string</description>
  <name>string</name>
  <parentID>0</parentID>
  <fullName>string</fullName>
</ChannelDTO>

Responses

Status Meaning Description Schema
200 OK successful operation ChannelDTO

getPageLayout

GET /channel/pageLayout/{channelID}/{sectionID}

Parameters

Parameter In Type Required Description
channelID path integer(int32) true none
sectionID path integer(int32) true none

Example responses

200 Response

{
  "channelID": 0,
  "sectionID": 0,
  "pageLayoutID": 0,
  "inheritablePageLayoutID": 0
}
<?xml version="1.0" encoding="UTF-8" ?>
<AppliedPageLayoutDTO>
  <channelID>0</channelID>
  <sectionID>0</sectionID>
  <pageLayoutID>0</pageLayoutID>
  <inheritablePageLayoutID>0</inheritablePageLayoutID>
</AppliedPageLayoutDTO>

Responses

Status Meaning Description Schema
200 OK successful operation AppliedPageLayoutDTO

listPublishables

GET /channel/publishables/{sectionID}/{action}

Parameters

Parameter In Type Required Description
sectionID path integer(int32) true none
action path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "pendingVersionOutputDir": "string",
    "rootSectionID": 0,
    "hasPendingVersion": true,
    "editable": true,
    "microSites": [
      null
    ],
    "parentID": 0
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<description>string</description>
<pendingVersionOutputDir>string</pendingVersionOutputDir>
<rootSectionID>0</rootSectionID>
<hasPendingVersion>true</hasPendingVersion>
<editable>true</editable>
<microSites/>
<parentID>0</parentID>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ChannelMetaData] false none none

getRootChannels

GET /channel/root

Example responses

200 Response

[
  {
    "id": 0,
    "description": "string",
    "name": "string",
    "parentID": 0,
    "fullName": "string"
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<description>string</description>
<name>string</name>
<parentID>0</parentID>
<fullName>string</fullName>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ChannelDTO] false none none

get

GET /channel/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true none

Example responses

200 Response

{
  "id": 0,
  "description": "string",
  "name": "string",
  "parentID": 0,
  "fullName": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ChannelDTO>
  <id>0</id>
  <description>string</description>
  <name>string</name>
  <parentID>0</parentID>
  <fullName>string</fullName>
</ChannelDTO>

Responses

Status Meaning Description Schema
200 OK successful operation ChannelDTO

modify

PUT /channel/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

delete

DELETE /channel/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

resetChannelContent

POST /channel/{id}/content/reset

Parameters

Parameter In Type Required Description
id path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

getResetContentsForChannel

GET /channel/{id}/content/reset/{language}

Parameters

Parameter In Type Required Description
id path integer(int32) true none
language path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "sections": {
      "property1": "string",
      "property2": "string"
    },
    "sectionID": 0
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<sections>
  <property1>string</property1>
  <property2>string</property2>
</sections>
<sectionID>0</sectionID>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ResetChannelContent] false none none

resetSecondLevelLayouts

POST /channel/{id}/resetLayouts

Parameters

Parameter In Type Required Description
id path integer(int32) true none

Responses

Status Meaning Description Schema
default Default successful operation None

clusterconfig

Provides core web services for managing clustering configurations within the TERMINALFOUR system.

getAllClusteredServers

GET /clusterconfig

Example responses

200 Response

[
  {
    "serverName": "string",
    "sourcePort": 0,
    "destinationPort": 0,
    "useAsScheduledServer": true,
    "useAsSearchIndexServer": true,
    "newName": "string",
    "modified": true
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<serverName>string</serverName>
<sourcePort>0</sourcePort>
<destinationPort>0</destinationPort>
<useAsScheduledServer>true</useAsScheduledServer>
<useAsSearchIndexServer>true</useAsSearchIndexServer>
<newName>string</newName>
<modified>true</modified>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ClusteredServerDTO] false none none

addOrModify

POST /clusterconfig

Example responses

200 Response

{
  "serverName": "string",
  "sourcePort": 0,
  "destinationPort": 0,
  "useAsScheduledServer": true,
  "useAsSearchIndexServer": true,
  "newName": "string",
  "modified": true
}
<?xml version="1.0" encoding="UTF-8" ?>
<cluster>
  <serverName>string</serverName>
  <sourcePort>0</sourcePort>
  <destinationPort>0</destinationPort>
  <useAsScheduledServer>true</useAsScheduledServer>
  <useAsSearchIndexServer>true</useAsSearchIndexServer>
  <newName>string</newName>
  <modified>true</modified>
</cluster>

Responses

Status Meaning Description Schema
200 OK successful operation ClusteredServerDTO

get

GET /clusterconfig/cluster

Parameters

Parameter In Type Required Description
serverName query string false none

Example responses

200 Response

{
  "serverName": "string",
  "sourcePort": 0,
  "destinationPort": 0,
  "useAsScheduledServer": true,
  "useAsSearchIndexServer": true,
  "newName": "string",
  "modified": true
}
<?xml version="1.0" encoding="UTF-8" ?>
<cluster>
  <serverName>string</serverName>
  <sourcePort>0</sourcePort>
  <destinationPort>0</destinationPort>
  <useAsScheduledServer>true</useAsScheduledServer>
  <useAsSearchIndexServer>true</useAsSearchIndexServer>
  <newName>string</newName>
  <modified>true</modified>
</cluster>

Responses

Status Meaning Description Schema
200 OK successful operation ClusteredServerDTO

delete

DELETE /clusterconfig/{serverName}

Parameters

Parameter In Type Required Description
serverName path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

cmssearch

Provides the search functionality for the TERMINALFOUR system.

GET /cmssearch

Parameters

Parameter In Type Required Description
query query string false none
maxResults query integer(int32) false none
allLanguages query boolean false none
allVersions query boolean false none

Example responses

200 Response

[
  {
    "type": "string",
    "path": "string",
    "id": 0,
    "lang": "string",
    "lastModified": "string",
    "name": "string",
    "status": "string",
    "smName": "string",
    "version": "string",
    "sectionId": 0,
    "title": "string",
    "template": "string",
    "expired": true,
    "lastModifiedBy": "string",
    "readOnly": true,
    "content": true
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<type>string</type>
<path>string</path>
<id>0</id>
<lang>string</lang>
<lastModified>string</lastModified>
<name>string</name>
<status>string</status>
<smName>string</smName>
<version>string</version>
<sectionId>0</sectionId>
<title>string</title>
<template>string</template>
<expired>true</expired>
<lastModifiedBy>string</lastModifiedBy>
<readOnly>true</readOnly>
<content>true</content>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [SearchResponse] false none none

config

These web service endpoints describe the operations on configuration options within the TERMINALFOUR system.

getAll

GET /config

Example responses

200 Response

{
  "options": [
    {
      "name": "string",
      "type": "string",
      "value": {},
      "valueList": [
        {}
      ],
      "valueMap": [
        {
          "property1": {},
          "property2": {}
        }
      ]
    }
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<ConfigurationOptions>
  <options>
    <name>string</name>
    <type>string</type>
    <value/>
    <valueList/>
    <valueMap>
      <property1/>
      <property2/>
    </valueMap>
  </options>
</ConfigurationOptions>

Responses

Status Meaning Description Schema
200 OK successful operation ConfigurationOptions

addOrModify

PUT /config/{key}

Parameters

Parameter In Type Required Description
key path string true none

Example responses

200 Response

{
  "name": "string",
  "type": "string",
  "value": {},
  "valueList": [
    {}
  ],
  "valueMap": [
    {
      "property1": {},
      "property2": {}
    }
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<ConfigurationOptionDTO>
  <name>string</name>
  <type>string</type>
  <value/>
  <valueList/>
  <valueMap>
    <property1/>
    <property2/>
  </valueMap>
</ConfigurationOptionDTO>

Responses

Status Meaning Description Schema
200 OK successful operation ConfigurationOptionDTO

updateChannelMapping

POST /config/updateTransferChannel/{key}

Parameters

Parameter In Type Required Description
key path string true none

Responses

Status Meaning Description Schema
default Default successful operation None

get

GET /config/{key}

Parameters

Parameter In Type Required Description
key path string true none

Example responses

200 Response

{
  "name": "string",
  "type": "string",
  "value": {},
  "valueList": [
    {}
  ],
  "valueMap": [
    {
      "property1": {},
      "property2": {}
    }
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<ConfigurationOptionDTO>
  <name>string</name>
  <type>string</type>
  <value/>
  <valueList/>
  <valueMap>
    <property1/>
    <property2/>
  </valueMap>
</ConfigurationOptionDTO>

Responses

Status Meaning Description Schema
200 OK successful operation ConfigurationOptionDTO

getSelected

POST /config/{key}

Parameters

Parameter In Type Required Description
key path string true none

Example responses

200 Response

{
  "options": [
    {
      "name": "string",
      "type": "string",
      "value": {},
      "valueList": [
        {}
      ],
      "valueMap": [
        {
          "property1": {},
          "property2": {}
        }
      ]
    }
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<ConfigurationOptions>
  <options>
    <name>string</name>
    <type>string</type>
    <value/>
    <valueList/>
    <valueMap>
      <property1/>
      <property2/>
    </valueMap>
  </options>
</ConfigurationOptions>

Responses

Status Meaning Description Schema
200 OK successful operation ConfigurationOptions

content

These endpoints describe operations on content within the TERMINALFOUR system.

assign

POST /content/assign

Responses

Status Meaning Description Schema
default Default successful operation None

listInactive

GET /content/inactive/{languageCode}

Parameters

Parameter In Type Required Description
languageCode path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "language": "string",
    "sections": [
      {
        "id": 0,
        "level": 0,
        "status": 0,
        "printSequence": 0,
        "formSection": true,
        "archived": true,
        "users": [
          {
            "id": 0,
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "emailAddress": "string",
            "defaultLang": "string",
            "localeCountryCode": "string",
            "localeLanguageCode": "string",
            "localeVariant": "string",
            "createDate": "2019-07-02T14:03:44Z",
            "lastLoginDate": "2019-07-02T14:03:44Z",
            "enabled": true,
            "password": {},
            "defaultPreviewChannel": 0,
            "preferredHtmlEditor": 0,
            "extranetConsent": true,
            "extranetAccess": "string",
            "extranetConsentDatetime": "2019-07-02T14:03:44Z",
            "groups": [],
            "extensibleUserObjectContent": {},
            "sections": [],
            "userChannels": [],
            "locale": {},
            "appliedPreviewChannel": 0,
            "propertyResourceBundle": {},
            "fullTinyMCELocaleCode": "string",
            "fullLocaleCode": "string",
            "deleted": true,
            "authLevel": 0,
            "fullName": "string",
            "powerUser": true,
            "administrator": true
          }
        ],
        "viewUsers": [
          {
            "id": 0,
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "emailAddress": "string",
            "defaultLang": "string",
            "localeCountryCode": "string",
            "localeLanguageCode": "string",
            "localeVariant": "string",
            "createDate": "2019-07-02T14:03:44Z",
            "lastLoginDate": "2019-07-02T14:03:44Z",
            "enabled": true,
            "password": {},
            "defaultPreviewChannel": 0,
            "preferredHtmlEditor": 0,
            "extranetConsent": true,
            "extranetAccess": "string",
            "extranetConsentDatetime": "2019-07-02T14:03:44Z",
            "groups": [],
            "extensibleUserObjectContent": {},
            "sections": [],
            "userChannels": [],
            "locale": {},
            "appliedPreviewChannel": 0,
            "propertyResourceBundle": {},
            "fullTinyMCELocaleCode": "string",
            "fullLocaleCode": "string",
            "deleted": true,
            "authLevel": 0,
            "fullName": "string",
            "powerUser": true,
            "administrator": true
          }
        ],
        "groups": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "emailAddress": "string",
            "createDate": "2019-07-02T14:03:44Z",
            "enabled": true,
            "ldap": true,
            "defaultChannel": 0,
            "children": [],
            "sections": [],
            "steps": [],
            "memberCount": 0,
            "deleted": true
          }
        ],
        "viewGroups": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "emailAddress": "string",
            "createDate": "2019-07-02T14:03:44Z",
            "enabled": true,
            "ldap": true,
            "defaultChannel": 0,
            "children": [],
            "sections": [],
            "steps": [],
            "memberCount": 0,
            "deleted": true
          }
        ],
        "contentSections": [
          {
            "section": null,
            "content": {},
            "printSequence": 0,
            "sortLock": "TOP",
            "contentID": 0,
            "entityID": 0,
            "sectionID": 0
          }
        ],
        "sectionInfos": {
          "property1": {
            "section": null,
            "language": "string",
            "name": "string",
            "lastModified": "2019-07-02T14:03:44Z",
            "outputUri": "string",
            "outputFilename": "string",
            "keyPhrase": "string",
            "accessKey": "string",
            "contentOwner": 0,
            "metaDatas": []
          },
          "property2": {
            "section": null,
            "language": "string",
            "name": "string",
            "lastModified": "2019-07-02T14:03:44Z",
            "outputUri": "string",
            "outputFilename": "string",
            "keyPhrase": "string",
            "accessKey": "string",
            "contentOwner": 0,
            "metaDatas": []
          }
        },
        "mirrorSections": [
          null
        ],
        "links": {
          "property1": {
            "sourceSection": null,
            "language": "string",
            "url": "string",
            "section": 0,
            "target": "string",
            "inheritedAccessControl": 0,
            "overrideLink": true,
            "linkHasBeenOverridden": true,
            "type": 0,
            "persistentLanguage": "string",
            "sourceSectionID": 0
          },
          "property2": {
            "sourceSection": null,
            "language": "string",
            "url": "string",
            "section": 0,
            "target": "string",
            "inheritedAccessControl": 0,
            "overrideLink": true,
            "linkHasBeenOverridden": true,
            "type": 0,
            "persistentLanguage": "string",
            "sourceSectionID": 0
          }
        },
        "rootChannels": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "type": "string",
            "defaultLanguage": "string",
            "rootSectionID": 0,
            "fileOutputPath": "string",
            "indexFileName": "string",
            "baseHref": "string",
            "siteRoot": "string",
            "pathCaseModifier": 0,
            "fullTextType": "string",
            "fullTextExtension": "string",
            "secondaryPublishLanguage": "string",
            "channelPublishURL": "string",
            "parent": null,
            "favIconID": 0,
            "pollIconID": 0,
            "accessControlConfigurationID": 0,
            "personalisationConfigurationID": 0,
            "publishReportLevel": 0,
            "pendingVersionOutputPath": "string",
            "pendingVersionBaseHref": "string",
            "pendingVersionSiteRoot": "string",
            "prePublishProcessorID": 0,
            "allowScriptsInDirectEdit": 0,
            "languages": [],
            "microSites": [],
            "permittedFileExtensions": [],
            "translationDisclaimers": [],
            "mediaPublishRules": [],
            "channelFullTextDisplayPeriod": {},
            "channelUsers": [],
            "channelContents": [],
            "convertSpacesInSectionNameEnabled": true,
            "convertSpacesInOutputURIEnabled": true,
            "convertSpacesInRetainedFilenameEnabled": true,
            "contentIDs": [],
            "languageCodes": [],
            "microSite": true,
            "parentID": 0,
            "publishEmptySectionsEnabled": true,
            "personalisationEnabled": true,
            "fullTextDisplayPeriodValue": 0,
            "secondaryPublishEnabled": true,
            "accessControlEnabled": true,
            "channelCleanupEnabled": true,
            "fullTextDisplayPeriodUnit": 0,
            "overrideExtensionEnabled": true
          }
        ],
        "appliedPageLayouts": [
          {
            "id": {},
            "sectionID": 0,
            "pageLayoutID": 0,
            "inheritablePageLayoutID": 0,
            "channel": {},
            "section": null,
            "channelName": "string",
            "channelID": 0
          }
        ],
        "hierarchyMirrorAcOpt": {
          "section": null,
          "accessControlOption": 0,
          "id": 0
        },
        "hierarchyMirrorMetadataOpt": {
          "section": null,
          "metadataOption": 0,
          "id": 0
        },
        "children": [
          null
        ],
        "contentTypeScopes": [
          {
            "section": null,
            "contentType": {},
            "scope": 0,
            "contentTypeID": 0
          }
        ],
        "cloneSource": null,
        "sectionPaths": {
          "property1": {
            "section": null,
            "language": "string",
            "path": "string"
          },
          "property2": {
            "section": null,
            "language": "string",
            "path": "string"
          }
        },
        "webDAVRules": [
          {
            "section": null,
            "executionOrder": 0,
            "extensions": [],
            "contentType": 0,
            "element": "string",
            "autoApprove": true,
            "csvextensions": "string",
            "sectionID": 0
          }
        ],
        "sortLock": "TOP",
        "parent": null,
        "mirrors": [
          0
        ],
        "root": true,
        "workflow": {
          "id": 0,
          "name": "string",
          "description": "string",
          "status": "ACTIVE",
          "creationDate": "2019-07-02T14:03:44Z",
          "lastModified": "2019-07-02T14:03:44Z",
          "contentTypes": [
            {}
          ],
          "section": [
            null
          ],
          "workflowSteps": [
            {}
          ],
          "firstStep": {
            "id": 0,
            "name": "string",
            "description": "string",
            "status": "ACTIVE",
            "lastModified": "2019-07-02T14:03:44Z",
            "priority": "PRIORITY_LOWEST",
            "restrictToEditors": 0,
            "language": {},
            "users": [],
            "groups": [],
            "options": {},
            "workflowSteps": []
          },
          "currentActiveStep": {
            "id": 0,
            "name": "string",
            "description": "string",
            "status": "ACTIVE",
            "lastModified": "2019-07-02T14:03:44Z",
            "priority": "PRIORITY_LOWEST",
            "restrictToEditors": 0,
            "language": {},
            "users": [],
            "groups": [],
            "options": {},
            "workflowSteps": []
          }
        },
        "link": true,
        "mirrorSource": null,
        "shown": true,
        "languageCount": 0,
        "allNames": {
          "property1": "string",
          "property2": "string"
        },
        "workflowID": 0,
        "workflowName": "string",
        "nextSequence": 0,
        "childOfMirror": true,
        "channelRoot": [
          0
        ],
        "entityID": 0,
        "parentID": 0,
        "mirror": true,
        "sectionSortMethod": 0,
        "contentsAndSequences": {
          "property1": 0,
          "property2": 0
        },
        "contentSortMethod": 0,
        "mirrorSourceID": 0,
        "metadataOption": 0,
        "allPathSectionsWebDAVRules": [
          {
            "section": null,
            "executionOrder": 0,
            "extensions": [],
            "contentType": 0,
            "element": "string",
            "autoApprove": true,
            "csvextensions": "string",
            "sectionID": 0
          }
        ],
        "accessControlOption": 0,
        "currentOrInheritedWorkflow": 0,
        "childOfMirrored": true,
        "parentWorkflowID": 0,
        "contentNextSequence": 0,
        "languages": [
          "string"
        ],
        "channels": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "type": "string",
            "defaultLanguage": "string",
            "rootSectionID": 0,
            "fileOutputPath": "string",
            "indexFileName": "string",
            "baseHref": "string",
            "siteRoot": "string",
            "pathCaseModifier": 0,
            "fullTextType": "string",
            "fullTextExtension": "string",
            "secondaryPublishLanguage": "string",
            "channelPublishURL": "string",
            "parent": null,
            "favIconID": 0,
            "pollIconID": 0,
            "accessControlConfigurationID": 0,
            "personalisationConfigurationID": 0,
            "publishReportLevel": 0,
            "pendingVersionOutputPath": "string",
            "pendingVersionBaseHref": "string",
            "pendingVersionSiteRoot": "string",
            "prePublishProcessorID": 0,
            "allowScriptsInDirectEdit": 0,
            "languages": [],
            "microSites": [],
            "permittedFileExtensions": [],
            "translationDisclaimers": [],
            "mediaPublishRules": [],
            "channelFullTextDisplayPeriod": {},
            "channelUsers": [],
            "channelContents": [],
            "convertSpacesInSectionNameEnabled": true,
            "convertSpacesInOutputURIEnabled": true,
            "convertSpacesInRetainedFilenameEnabled": true,
            "contentIDs": [],
            "languageCodes": [],
            "microSite": true,
            "parentID": 0,
            "publishEmptySectionsEnabled": true,
            "personalisationEnabled": true,
            "fullTextDisplayPeriodValue": 0,
            "secondaryPublishEnabled": true,
            "accessControlEnabled": true,
            "channelCleanupEnabled": true,
            "fullTextDisplayPeriodUnit": 0,
            "overrideExtensionEnabled": true
          }
        ],
        "pathMembers": [
          0
        ]
      }
    ],
    "lastModified": "string",
    "media": true
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<language>string</language>
<sections>
  <id>0</id>
  <level>0</level>
  <status>0</status>
  <printSequence>0</printSequence>
  <formSection>true</formSection>
  <archived>true</archived>
  <users>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <emailAddress>string</emailAddress>
    <defaultLang>string</defaultLang>
    <localeCountryCode>string</localeCountryCode>
    <localeLanguageCode>string</localeLanguageCode>
    <localeVariant>string</localeVariant>
    <createDate>2019-07-02T14:03:44Z</createDate>
    <lastLoginDate>2019-07-02T14:03:44Z</lastLoginDate>
    <enabled>true</enabled>
    <password/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <preferredHtmlEditor>0</preferredHtmlEditor>
    <extranetConsent>true</extranetConsent>
    <extranetAccess>string</extranetAccess>
    <extranetConsentDatetime>2019-07-02T14:03:44Z</extranetConsentDatetime>
    <extensibleUserObjectContent/>
    <locale/>
    <appliedPreviewChannel>0</appliedPreviewChannel>
    <propertyResourceBundle/>
    <fullTinyMCELocaleCode>string</fullTinyMCELocaleCode>
    <fullLocaleCode>string</fullLocaleCode>
    <deleted>true</deleted>
    <authLevel>0</authLevel>
    <fullName>string</fullName>
    <powerUser>true</powerUser>
    <administrator>true</administrator>
  </users>
  <viewUsers>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <emailAddress>string</emailAddress>
    <defaultLang>string</defaultLang>
    <localeCountryCode>string</localeCountryCode>
    <localeLanguageCode>string</localeLanguageCode>
    <localeVariant>string</localeVariant>
    <createDate>2019-07-02T14:03:44Z</createDate>
    <lastLoginDate>2019-07-02T14:03:44Z</lastLoginDate>
    <enabled>true</enabled>
    <password/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <preferredHtmlEditor>0</preferredHtmlEditor>
    <extranetConsent>true</extranetConsent>
    <extranetAccess>string</extranetAccess>
    <extranetConsentDatetime>2019-07-02T14:03:44Z</extranetConsentDatetime>
    <extensibleUserObjectContent/>
    <locale/>
    <appliedPreviewChannel>0</appliedPreviewChannel>
    <propertyResourceBundle/>
    <fullTinyMCELocaleCode>string</fullTinyMCELocaleCode>
    <fullLocaleCode>string</fullLocaleCode>
    <deleted>true</deleted>
    <authLevel>0</authLevel>
    <fullName>string</fullName>
    <powerUser>true</powerUser>
    <administrator>true</administrator>
  </viewUsers>
  <groups>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <emailAddress>string</emailAddress>
    <createDate>2019-07-02T14:03:44Z</createDate>
    <enabled>true</enabled>
    <ldap>true</ldap>
    <defaultChannel>0</defaultChannel>
    <memberCount>0</memberCount>
    <deleted>true</deleted>
  </groups>
  <viewGroups>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <emailAddress>string</emailAddress>
    <createDate>2019-07-02T14:03:44Z</createDate>
    <enabled>true</enabled>
    <ldap>true</ldap>
    <defaultChannel>0</defaultChannel>
    <memberCount>0</memberCount>
    <deleted>true</deleted>
  </viewGroups>
  <contentSections>
    <section/>
    <content/>
    <printSequence>0</printSequence>
    <sortLock>TOP</sortLock>
    <contentID>0</contentID>
    <entityID>0</entityID>
    <sectionID>0</sectionID>
  </contentSections>
  <sectionInfos>
    <property1>
      <section/>
      <language>string</language>
      <name>string</name>
      <lastModified>2019-07-02T14:03:44Z</lastModified>
      <outputUri>string</outputUri>
      <outputFilename>string</outputFilename>
      <keyPhrase>string</keyPhrase>
      <accessKey>string</accessKey>
      <contentOwner>0</contentOwner>
    </property1>
    <property2>
      <section/>
      <language>string</language>
      <name>string</name>
      <lastModified>2019-07-02T14:03:44Z</lastModified>
      <outputUri>string</outputUri>
      <outputFilename>string</outputFilename>
      <keyPhrase>string</keyPhrase>
      <accessKey>string</accessKey>
      <contentOwner>0</contentOwner>
    </property2>
  </sectionInfos>
  <mirrorSections/>
  <links>
    <property1>
      <sourceSection/>
      <language>string</language>
      <url>string</url>
      <section>0</section>
      <target>string</target>
      <inheritedAccessControl>0</inheritedAccessControl>
      <overrideLink>true</overrideLink>
      <linkHasBeenOverridden>true</linkHasBeenOverridden>
      <type>0</type>
      <persistentLanguage>string</persistentLanguage>
      <sourceSectionID>0</sourceSectionID>
    </property1>
    <property2>
      <sourceSection/>
      <language>string</language>
      <url>string</url>
      <section>0</section>
      <target>string</target>
      <inheritedAccessControl>0</inheritedAccessControl>
      <overrideLink>true</overrideLink>
      <linkHasBeenOverridden>true</linkHasBeenOverridden>
      <type>0</type>
      <persistentLanguage>string</persistentLanguage>
      <sourceSectionID>0</sourceSectionID>
    </property2>
  </links>
  <rootChannels>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>string</type>
    <defaultLanguage>string</defaultLanguage>
    <rootSectionID>0</rootSectionID>
    <fileOutputPath>string</fileOutputPath>
    <indexFileName>string</indexFileName>
    <baseHref>string</baseHref>
    <siteRoot>string</siteRoot>
    <pathCaseModifier>0</pathCaseModifier>
    <fullTextType>string</fullTextType>
    <fullTextExtension>string</fullTextExtension>
    <secondaryPublishLanguage>string</secondaryPublishLanguage>
    <channelPublishURL>string</channelPublishURL>
    <parent/>
    <favIconID>0</favIconID>
    <pollIconID>0</pollIconID>
    <accessControlConfigurationID>0</accessControlConfigurationID>
    <personalisationConfigurationID>0</personalisationConfigurationID>
    <publishReportLevel>0</publishReportLevel>
    <pendingVersionOutputPath>string</pendingVersionOutputPath>
    <pendingVersionBaseHref>string</pendingVersionBaseHref>
    <pendingVersionSiteRoot>string</pendingVersionSiteRoot>
    <prePublishProcessorID>0</prePublishProcessorID>
    <allowScriptsInDirectEdit>0</allowScriptsInDirectEdit>
    <channelFullTextDisplayPeriod/>
    <convertSpacesInSectionNameEnabled>true</convertSpacesInSectionNameEnabled>
    <convertSpacesInOutputURIEnabled>true</convertSpacesInOutputURIEnabled>
    <convertSpacesInRetainedFilenameEnabled>true</convertSpacesInRetainedFilenameEnabled>
    <microSite>true</microSite>
    <parentID>0</parentID>
    <publishEmptySectionsEnabled>true</publishEmptySectionsEnabled>
    <personalisationEnabled>true</personalisationEnabled>
    <fullTextDisplayPeriodValue>0</fullTextDisplayPeriodValue>
    <secondaryPublishEnabled>true</secondaryPublishEnabled>
    <accessControlEnabled>true</accessControlEnabled>
    <channelCleanupEnabled>true</channelCleanupEnabled>
    <fullTextDisplayPeriodUnit>0</fullTextDisplayPeriodUnit>
    <overrideExtensionEnabled>true</overrideExtensionEnabled>
  </rootChannels>
  <appliedPageLayouts>
    <id/>
    <sectionID>0</sectionID>
    <pageLayoutID>0</pageLayoutID>
    <inheritablePageLayoutID>0</inheritablePageLayoutID>
    <channel/>
    <section/>
    <channelName>string</channelName>
    <channelID>0</channelID>
  </appliedPageLayouts>
  <hierarchyMirrorAcOpt>
    <section/>
    <accessControlOption>0</accessControlOption>
    <id>0</id>
  </hierarchyMirrorAcOpt>
  <hierarchyMirrorMetadataOpt>
    <section/>
    <metadataOption>0</metadataOption>
    <id>0</id>
  </hierarchyMirrorMetadataOpt>
  <children/>
  <contentTypeScopes>
    <section/>
    <contentType/>
    <scope>0</scope>
    <contentTypeID>0</contentTypeID>
  </contentTypeScopes>
  <cloneSource/>
  <sectionPaths>
    <property1>
      <section/>
      <language>string</language>
      <path>string</path>
    </property1>
    <property2>
      <section/>
      <language>string</language>
      <path>string</path>
    </property2>
  </sectionPaths>
  <webDAVRules>
    <section/>
    <executionOrder>0</executionOrder>
    <contentType>0</contentType>
    <element>string</element>
    <autoApprove>true</autoApprove>
    <csvextensions>string</csvextensions>
    <sectionID>0</sectionID>
  </webDAVRules>
  <sortLock>TOP</sortLock>
  <parent/>
  <mirrors>0</mirrors>
  <root>true</root>
  <workflow>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <status>ACTIVE</status>
    <creationDate>2019-07-02T14:03:44Z</creationDate>
    <lastModified>2019-07-02T14:03:44Z</lastModified>
    <contentTypes/>
    <section/>
    <workflowSteps/>
    <firstStep>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <status>ACTIVE</status>
      <lastModified>2019-07-02T14:03:44Z</lastModified>
      <priority>PRIORITY_LOWEST</priority>
      <restrictToEditors>0</restrictToEditors>
      <language/>
      <options/>
    </firstStep>
    <currentActiveStep>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <status>ACTIVE</status>
      <lastModified>2019-07-02T14:03:44Z</lastModified>
      <priority>PRIORITY_LOWEST</priority>
      <restrictToEditors>0</restrictToEditors>
      <language/>
      <options/>
    </currentActiveStep>
  </workflow>
  <link>true</link>
  <mirrorSource/>
  <shown>true</shown>
  <languageCount>0</languageCount>
  <allNames>
    <property1>string</property1>
    <property2>string</property2>
  </allNames>
  <workflowID>0</workflowID>
  <workflowName>string</workflowName>
  <nextSequence>0</nextSequence>
  <childOfMirror>true</childOfMirror>
  <channelRoot>0</channelRoot>
  <entityID>0</entityID>
  <parentID>0</parentID>
  <mirror>true</mirror>
  <sectionSortMethod>0</sectionSortMethod>
  <contentsAndSequences>
    <property1>0</property1>
    <property2>0</property2>
  </contentsAndSequences>
  <contentSortMethod>0</contentSortMethod>
  <mirrorSourceID>0</mirrorSourceID>
  <metadataOption>0</metadataOption>
  <allPathSectionsWebDAVRules>
    <section/>
    <executionOrder>0</executionOrder>
    <contentType>0</contentType>
    <element>string</element>
    <autoApprove>true</autoApprove>
    <csvextensions>string</csvextensions>
    <sectionID>0</sectionID>
  </allPathSectionsWebDAVRules>
  <accessControlOption>0</accessControlOption>
  <currentOrInheritedWorkflow>0</currentOrInheritedWorkflow>
  <childOfMirrored>true</childOfMirrored>
  <parentWorkflowID>0</parentWorkflowID>
  <contentNextSequence>0</contentNextSequence>
  <languages>string</languages>
  <channels>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>string</type>
    <defaultLanguage>string</defaultLanguage>
    <rootSectionID>0</rootSectionID>
    <fileOutputPath>string</fileOutputPath>
    <indexFileName>string</indexFileName>
    <baseHref>string</baseHref>
    <siteRoot>string</siteRoot>
    <pathCaseModifier>0</pathCaseModifier>
    <fullTextType>string</fullTextType>
    <fullTextExtension>string</fullTextExtension>
    <secondaryPublishLanguage>string</secondaryPublishLanguage>
    <channelPublishURL>string</channelPublishURL>
    <parent/>
    <favIconID>0</favIconID>
    <pollIconID>0</pollIconID>
    <accessControlConfigurationID>0</accessControlConfigurationID>
    <personalisationConfigurationID>0</personalisationConfigurationID>
    <publishReportLevel>0</publishReportLevel>
    <pendingVersionOutputPath>string</pendingVersionOutputPath>
    <pendingVersionBaseHref>string</pendingVersionBaseHref>
    <pendingVersionSiteRoot>string</pendingVersionSiteRoot>
    <prePublishProcessorID>0</prePublishProcessorID>
    <allowScriptsInDirectEdit>0</allowScriptsInDirectEdit>
    <channelFullTextDisplayPeriod/>
    <convertSpacesInSectionNameEnabled>true</convertSpacesInSectionNameEnabled>
    <convertSpacesInOutputURIEnabled>true</convertSpacesInOutputURIEnabled>
    <convertSpacesInRetainedFilenameEnabled>true</convertSpacesInRetainedFilenameEnabled>
    <microSite>true</microSite>
    <parentID>0</parentID>
    <publishEmptySectionsEnabled>true</publishEmptySectionsEnabled>
    <personalisationEnabled>true</personalisationEnabled>
    <fullTextDisplayPeriodValue>0</fullTextDisplayPeriodValue>
    <secondaryPublishEnabled>true</secondaryPublishEnabled>
    <accessControlEnabled>true</accessControlEnabled>
    <channelCleanupEnabled>true</channelCleanupEnabled>
    <fullTextDisplayPeriodUnit>0</fullTextDisplayPeriodUnit>
    <overrideExtensionEnabled>true</overrideExtensionEnabled>
  </channels>
  <pathMembers>0</pathMembers>
</sections>
<lastModified>string</lastModified>
<media>true</media>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ContentListing] false none none
»»»»»»»» priority integer(int32) false none none
»»»»»»»» disclaimer string false none none
»»»»»»»» publishRule integer(int32) false none none
»»»»»»»»»» languageIndependant boolean false none none
»»»»»»»»» convertSpacesInSectionNameEnabled boolean false none none
»»»»»»»»» convertSpacesInOutputURIEnabled boolean false none none
»»»»»»»»» convertSpacesInRetainedFilenameEnabled boolean false none none
»»»»»»»»» contentIDs [integer] false none none
»»»»»»»»» languageCodes [string] false none none
»»»»»»»»» microSite boolean false none none
»»»»»»»»» parentID integer(int32) false none none
»»»»»»»»» publishEmptySectionsEnabled boolean false none none
»»»»»»»»» personalisationEnabled boolean false none none
»»»»»»»»» fullTextDisplayPeriodValue integer(int32) false none none
»»»»»»»»» secondaryPublishEnabled boolean false none none
»»»»»»»»» accessControlEnabled boolean false none none
»»»»»»»»» channelCleanupEnabled boolean false none none
»»»»»»»»» fullTextDisplayPeriodUnit integer(int32) false none none
»»»»»»»»» overrideExtensionEnabled boolean false none none
»»»»»»»»»»» elementForFilename integer(int32) false none none
»»»»»»»»»»» alias string false none none
»»»»»»»»»»» directEditEnabled boolean false none none
»»»»»»» memberCount integer(int32) false none none
»»»»»»» deleted boolean false none none
»»»»»»» language string false none none
»»»»»»» name string false none none
»»»»»»» lastModified string(date-time) false none none
»»»»»»» id integer(int32) false none none
»»»»»»» owner integer(int32) false none none
»»»»»» fullTinyMCELocaleCode string false none none
»»»»»» fullLocaleCode string false none none
»»»»»» deleted boolean false none none
»»»»»» authLevel integer(int32) false none none
»»»»»» fullName string false none none
»»»»»» powerUser boolean false none none
»»»»»» administrator boolean false none none
»»»»»»»» value string false none none
»»»»»»»» language string false none none
»»»»»»»» metaTagID integer(int32) false none none
»»»»»»»» metaTagName string false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» pageLayoutID integer(int32) false none none
»»»»»»»» inheritablePageLayoutID integer(int32) false none none
»»»»»»»» sortLock string false none none
»»»»»»» lastModified string false none none
»»»»»»» media boolean false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

listLinkContent

GET /content/link/{id}

Parameters

Parameter In Type Required Description
id path integer(int32) true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "language": "string",
    "sections": [
      {
        "id": 0,
        "level": 0,
        "status": 0,
        "printSequence": 0,
        "formSection": true,
        "archived": true,
        "users": [
          {
            "id": 0,
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "emailAddress": "string",
            "defaultLang": "string",
            "localeCountryCode": "string",
            "localeLanguageCode": "string",
            "localeVariant": "string",
            "createDate": "2019-07-02T14:03:44Z",
            "lastLoginDate": "2019-07-02T14:03:44Z",
            "enabled": true,
            "password": {},
            "defaultPreviewChannel": 0,
            "preferredHtmlEditor": 0,
            "extranetConsent": true,
            "extranetAccess": "string",
            "extranetConsentDatetime": "2019-07-02T14:03:44Z",
            "groups": [],
            "extensibleUserObjectContent": {},
            "sections": [],
            "userChannels": [],
            "locale": {},
            "appliedPreviewChannel": 0,
            "propertyResourceBundle": {},
            "fullTinyMCELocaleCode": "string",
            "fullLocaleCode": "string",
            "deleted": true,
            "authLevel": 0,
            "fullName": "string",
            "powerUser": true,
            "administrator": true
          }
        ],
        "viewUsers": [
          {
            "id": 0,
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "emailAddress": "string",
            "defaultLang": "string",
            "localeCountryCode": "string",
            "localeLanguageCode": "string",
            "localeVariant": "string",
            "createDate": "2019-07-02T14:03:44Z",
            "lastLoginDate": "2019-07-02T14:03:44Z",
            "enabled": true,
            "password": {},
            "defaultPreviewChannel": 0,
            "preferredHtmlEditor": 0,
            "extranetConsent": true,
            "extranetAccess": "string",
            "extranetConsentDatetime": "2019-07-02T14:03:44Z",
            "groups": [],
            "extensibleUserObjectContent": {},
            "sections": [],
            "userChannels": [],
            "locale": {},
            "appliedPreviewChannel": 0,
            "propertyResourceBundle": {},
            "fullTinyMCELocaleCode": "string",
            "fullLocaleCode": "string",
            "deleted": true,
            "authLevel": 0,
            "fullName": "string",
            "powerUser": true,
            "administrator": true
          }
        ],
        "groups": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "emailAddress": "string",
            "createDate": "2019-07-02T14:03:44Z",
            "enabled": true,
            "ldap": true,
            "defaultChannel": 0,
            "children": [],
            "sections": [],
            "steps": [],
            "memberCount": 0,
            "deleted": true
          }
        ],
        "viewGroups": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "emailAddress": "string",
            "createDate": "2019-07-02T14:03:44Z",
            "enabled": true,
            "ldap": true,
            "defaultChannel": 0,
            "children": [],
            "sections": [],
            "steps": [],
            "memberCount": 0,
            "deleted": true
          }
        ],
        "contentSections": [
          {
            "section": null,
            "content": {},
            "printSequence": 0,
            "sortLock": "TOP",
            "contentID": 0,
            "entityID": 0,
            "sectionID": 0
          }
        ],
        "sectionInfos": {
          "property1": {
            "section": null,
            "language": "string",
            "name": "string",
            "lastModified": "2019-07-02T14:03:44Z",
            "outputUri": "string",
            "outputFilename": "string",
            "keyPhrase": "string",
            "accessKey": "string",
            "contentOwner": 0,
            "metaDatas": []
          },
          "property2": {
            "section": null,
            "language": "string",
            "name": "string",
            "lastModified": "2019-07-02T14:03:44Z",
            "outputUri": "string",
            "outputFilename": "string",
            "keyPhrase": "string",
            "accessKey": "string",
            "contentOwner": 0,
            "metaDatas": []
          }
        },
        "mirrorSections": [
          null
        ],
        "links": {
          "property1": {
            "sourceSection": null,
            "language": "string",
            "url": "string",
            "section": 0,
            "target": "string",
            "inheritedAccessControl": 0,
            "overrideLink": true,
            "linkHasBeenOverridden": true,
            "type": 0,
            "persistentLanguage": "string",
            "sourceSectionID": 0
          },
          "property2": {
            "sourceSection": null,
            "language": "string",
            "url": "string",
            "section": 0,
            "target": "string",
            "inheritedAccessControl": 0,
            "overrideLink": true,
            "linkHasBeenOverridden": true,
            "type": 0,
            "persistentLanguage": "string",
            "sourceSectionID": 0
          }
        },
        "rootChannels": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "type": "string",
            "defaultLanguage": "string",
            "rootSectionID": 0,
            "fileOutputPath": "string",
            "indexFileName": "string",
            "baseHref": "string",
            "siteRoot": "string",
            "pathCaseModifier": 0,
            "fullTextType": "string",
            "fullTextExtension": "string",
            "secondaryPublishLanguage": "string",
            "channelPublishURL": "string",
            "parent": null,
            "favIconID": 0,
            "pollIconID": 0,
            "accessControlConfigurationID": 0,
            "personalisationConfigurationID": 0,
            "publishReportLevel": 0,
            "pendingVersionOutputPath": "string",
            "pendingVersionBaseHref": "string",
            "pendingVersionSiteRoot": "string",
            "prePublishProcessorID": 0,
            "allowScriptsInDirectEdit": 0,
            "languages": [],
            "microSites": [],
            "permittedFileExtensions": [],
            "translationDisclaimers": [],
            "mediaPublishRules": [],
            "channelFullTextDisplayPeriod": {},
            "channelUsers": [],
            "channelContents": [],
            "convertSpacesInSectionNameEnabled": true,
            "convertSpacesInOutputURIEnabled": true,
            "convertSpacesInRetainedFilenameEnabled": true,
            "contentIDs": [],
            "languageCodes": [],
            "microSite": true,
            "parentID": 0,
            "publishEmptySectionsEnabled": true,
            "personalisationEnabled": true,
            "fullTextDisplayPeriodValue": 0,
            "secondaryPublishEnabled": true,
            "accessControlEnabled": true,
            "channelCleanupEnabled": true,
            "fullTextDisplayPeriodUnit": 0,
            "overrideExtensionEnabled": true
          }
        ],
        "appliedPageLayouts": [
          {
            "id": {},
            "sectionID": 0,
            "pageLayoutID": 0,
            "inheritablePageLayoutID": 0,
            "channel": {},
            "section": null,
            "channelName": "string",
            "channelID": 0
          }
        ],
        "hierarchyMirrorAcOpt": {
          "section": null,
          "accessControlOption": 0,
          "id": 0
        },
        "hierarchyMirrorMetadataOpt": {
          "section": null,
          "metadataOption": 0,
          "id": 0
        },
        "children": [
          null
        ],
        "contentTypeScopes": [
          {
            "section": null,
            "contentType": {},
            "scope": 0,
            "contentTypeID": 0
          }
        ],
        "cloneSource": null,
        "sectionPaths": {
          "property1": {
            "section": null,
            "language": "string",
            "path": "string"
          },
          "property2": {
            "section": null,
            "language": "string",
            "path": "string"
          }
        },
        "webDAVRules": [
          {
            "section": null,
            "executionOrder": 0,
            "extensions": [],
            "contentType": 0,
            "element": "string",
            "autoApprove": true,
            "csvextensions": "string",
            "sectionID": 0
          }
        ],
        "sortLock": "TOP",
        "parent": null,
        "mirrors": [
          0
        ],
        "root": true,
        "workflow": {
          "id": 0,
          "name": "string",
          "description": "string",
          "status": "ACTIVE",
          "creationDate": "2019-07-02T14:03:44Z",
          "lastModified": "2019-07-02T14:03:44Z",
          "contentTypes": [
            {}
          ],
          "section": [
            null
          ],
          "workflowSteps": [
            {}
          ],
          "firstStep": {
            "id": 0,
            "name": "string",
            "description": "string",
            "status": "ACTIVE",
            "lastModified": "2019-07-02T14:03:44Z",
            "priority": "PRIORITY_LOWEST",
            "restrictToEditors": 0,
            "language": {},
            "users": [],
            "groups": [],
            "options": {},
            "workflowSteps": []
          },
          "currentActiveStep": {
            "id": 0,
            "name": "string",
            "description": "string",
            "status": "ACTIVE",
            "lastModified": "2019-07-02T14:03:44Z",
            "priority": "PRIORITY_LOWEST",
            "restrictToEditors": 0,
            "language": {},
            "users": [],
            "groups": [],
            "options": {},
            "workflowSteps": []
          }
        },
        "link": true,
        "mirrorSource": null,
        "shown": true,
        "languageCount": 0,
        "allNames": {
          "property1": "string",
          "property2": "string"
        },
        "workflowID": 0,
        "workflowName": "string",
        "nextSequence": 0,
        "childOfMirror": true,
        "channelRoot": [
          0
        ],
        "entityID": 0,
        "parentID": 0,
        "mirror": true,
        "sectionSortMethod": 0,
        "contentsAndSequences": {
          "property1": 0,
          "property2": 0
        },
        "contentSortMethod": 0,
        "mirrorSourceID": 0,
        "metadataOption": 0,
        "allPathSectionsWebDAVRules": [
          {
            "section": null,
            "executionOrder": 0,
            "extensions": [],
            "contentType": 0,
            "element": "string",
            "autoApprove": true,
            "csvextensions": "string",
            "sectionID": 0
          }
        ],
        "accessControlOption": 0,
        "currentOrInheritedWorkflow": 0,
        "childOfMirrored": true,
        "parentWorkflowID": 0,
        "contentNextSequence": 0,
        "languages": [
          "string"
        ],
        "channels": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "type": "string",
            "defaultLanguage": "string",
            "rootSectionID": 0,
            "fileOutputPath": "string",
            "indexFileName": "string",
            "baseHref": "string",
            "siteRoot": "string",
            "pathCaseModifier": 0,
            "fullTextType": "string",
            "fullTextExtension": "string",
            "secondaryPublishLanguage": "string",
            "channelPublishURL": "string",
            "parent": null,
            "favIconID": 0,
            "pollIconID": 0,
            "accessControlConfigurationID": 0,
            "personalisationConfigurationID": 0,
            "publishReportLevel": 0,
            "pendingVersionOutputPath": "string",
            "pendingVersionBaseHref": "string",
            "pendingVersionSiteRoot": "string",
            "prePublishProcessorID": 0,
            "allowScriptsInDirectEdit": 0,
            "languages": [],
            "microSites": [],
            "permittedFileExtensions": [],
            "translationDisclaimers": [],
            "mediaPublishRules": [],
            "channelFullTextDisplayPeriod": {},
            "channelUsers": [],
            "channelContents": [],
            "convertSpacesInSectionNameEnabled": true,
            "convertSpacesInOutputURIEnabled": true,
            "convertSpacesInRetainedFilenameEnabled": true,
            "contentIDs": [],
            "languageCodes": [],
            "microSite": true,
            "parentID": 0,
            "publishEmptySectionsEnabled": true,
            "personalisationEnabled": true,
            "fullTextDisplayPeriodValue": 0,
            "secondaryPublishEnabled": true,
            "accessControlEnabled": true,
            "channelCleanupEnabled": true,
            "fullTextDisplayPeriodUnit": 0,
            "overrideExtensionEnabled": true
          }
        ],
        "pathMembers": [
          0
        ]
      }
    ],
    "lastModified": "string",
    "media": true
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<language>string</language>
<sections>
  <id>0</id>
  <level>0</level>
  <status>0</status>
  <printSequence>0</printSequence>
  <formSection>true</formSection>
  <archived>true</archived>
  <users>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <emailAddress>string</emailAddress>
    <defaultLang>string</defaultLang>
    <localeCountryCode>string</localeCountryCode>
    <localeLanguageCode>string</localeLanguageCode>
    <localeVariant>string</localeVariant>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <lastLoginDate>2019-07-02T14:03:45Z</lastLoginDate>
    <enabled>true</enabled>
    <password/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <preferredHtmlEditor>0</preferredHtmlEditor>
    <extranetConsent>true</extranetConsent>
    <extranetAccess>string</extranetAccess>
    <extranetConsentDatetime>2019-07-02T14:03:45Z</extranetConsentDatetime>
    <extensibleUserObjectContent/>
    <locale/>
    <appliedPreviewChannel>0</appliedPreviewChannel>
    <propertyResourceBundle/>
    <fullTinyMCELocaleCode>string</fullTinyMCELocaleCode>
    <fullLocaleCode>string</fullLocaleCode>
    <deleted>true</deleted>
    <authLevel>0</authLevel>
    <fullName>string</fullName>
    <powerUser>true</powerUser>
    <administrator>true</administrator>
  </users>
  <viewUsers>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <emailAddress>string</emailAddress>
    <defaultLang>string</defaultLang>
    <localeCountryCode>string</localeCountryCode>
    <localeLanguageCode>string</localeLanguageCode>
    <localeVariant>string</localeVariant>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <lastLoginDate>2019-07-02T14:03:45Z</lastLoginDate>
    <enabled>true</enabled>
    <password/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <preferredHtmlEditor>0</preferredHtmlEditor>
    <extranetConsent>true</extranetConsent>
    <extranetAccess>string</extranetAccess>
    <extranetConsentDatetime>2019-07-02T14:03:45Z</extranetConsentDatetime>
    <extensibleUserObjectContent/>
    <locale/>
    <appliedPreviewChannel>0</appliedPreviewChannel>
    <propertyResourceBundle/>
    <fullTinyMCELocaleCode>string</fullTinyMCELocaleCode>
    <fullLocaleCode>string</fullLocaleCode>
    <deleted>true</deleted>
    <authLevel>0</authLevel>
    <fullName>string</fullName>
    <powerUser>true</powerUser>
    <administrator>true</administrator>
  </viewUsers>
  <groups>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <emailAddress>string</emailAddress>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <enabled>true</enabled>
    <ldap>true</ldap>
    <defaultChannel>0</defaultChannel>
    <memberCount>0</memberCount>
    <deleted>true</deleted>
  </groups>
  <viewGroups>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <emailAddress>string</emailAddress>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <enabled>true</enabled>
    <ldap>true</ldap>
    <defaultChannel>0</defaultChannel>
    <memberCount>0</memberCount>
    <deleted>true</deleted>
  </viewGroups>
  <contentSections>
    <section/>
    <content/>
    <printSequence>0</printSequence>
    <sortLock>TOP</sortLock>
    <contentID>0</contentID>
    <entityID>0</entityID>
    <sectionID>0</sectionID>
  </contentSections>
  <sectionInfos>
    <property1>
      <section/>
      <language>string</language>
      <name>string</name>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <outputUri>string</outputUri>
      <outputFilename>string</outputFilename>
      <keyPhrase>string</keyPhrase>
      <accessKey>string</accessKey>
      <contentOwner>0</contentOwner>
    </property1>
    <property2>
      <section/>
      <language>string</language>
      <name>string</name>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <outputUri>string</outputUri>
      <outputFilename>string</outputFilename>
      <keyPhrase>string</keyPhrase>
      <accessKey>string</accessKey>
      <contentOwner>0</contentOwner>
    </property2>
  </sectionInfos>
  <mirrorSections/>
  <links>
    <property1>
      <sourceSection/>
      <language>string</language>
      <url>string</url>
      <section>0</section>
      <target>string</target>
      <inheritedAccessControl>0</inheritedAccessControl>
      <overrideLink>true</overrideLink>
      <linkHasBeenOverridden>true</linkHasBeenOverridden>
      <type>0</type>
      <persistentLanguage>string</persistentLanguage>
      <sourceSectionID>0</sourceSectionID>
    </property1>
    <property2>
      <sourceSection/>
      <language>string</language>
      <url>string</url>
      <section>0</section>
      <target>string</target>
      <inheritedAccessControl>0</inheritedAccessControl>
      <overrideLink>true</overrideLink>
      <linkHasBeenOverridden>true</linkHasBeenOverridden>
      <type>0</type>
      <persistentLanguage>string</persistentLanguage>
      <sourceSectionID>0</sourceSectionID>
    </property2>
  </links>
  <rootChannels>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>string</type>
    <defaultLanguage>string</defaultLanguage>
    <rootSectionID>0</rootSectionID>
    <fileOutputPath>string</fileOutputPath>
    <indexFileName>string</indexFileName>
    <baseHref>string</baseHref>
    <siteRoot>string</siteRoot>
    <pathCaseModifier>0</pathCaseModifier>
    <fullTextType>string</fullTextType>
    <fullTextExtension>string</fullTextExtension>
    <secondaryPublishLanguage>string</secondaryPublishLanguage>
    <channelPublishURL>string</channelPublishURL>
    <parent/>
    <favIconID>0</favIconID>
    <pollIconID>0</pollIconID>
    <accessControlConfigurationID>0</accessControlConfigurationID>
    <personalisationConfigurationID>0</personalisationConfigurationID>
    <publishReportLevel>0</publishReportLevel>
    <pendingVersionOutputPath>string</pendingVersionOutputPath>
    <pendingVersionBaseHref>string</pendingVersionBaseHref>
    <pendingVersionSiteRoot>string</pendingVersionSiteRoot>
    <prePublishProcessorID>0</prePublishProcessorID>
    <allowScriptsInDirectEdit>0</allowScriptsInDirectEdit>
    <channelFullTextDisplayPeriod/>
    <convertSpacesInSectionNameEnabled>true</convertSpacesInSectionNameEnabled>
    <convertSpacesInOutputURIEnabled>true</convertSpacesInOutputURIEnabled>
    <convertSpacesInRetainedFilenameEnabled>true</convertSpacesInRetainedFilenameEnabled>
    <microSite>true</microSite>
    <parentID>0</parentID>
    <publishEmptySectionsEnabled>true</publishEmptySectionsEnabled>
    <personalisationEnabled>true</personalisationEnabled>
    <fullTextDisplayPeriodValue>0</fullTextDisplayPeriodValue>
    <secondaryPublishEnabled>true</secondaryPublishEnabled>
    <accessControlEnabled>true</accessControlEnabled>
    <channelCleanupEnabled>true</channelCleanupEnabled>
    <fullTextDisplayPeriodUnit>0</fullTextDisplayPeriodUnit>
    <overrideExtensionEnabled>true</overrideExtensionEnabled>
  </rootChannels>
  <appliedPageLayouts>
    <id/>
    <sectionID>0</sectionID>
    <pageLayoutID>0</pageLayoutID>
    <inheritablePageLayoutID>0</inheritablePageLayoutID>
    <channel/>
    <section/>
    <channelName>string</channelName>
    <channelID>0</channelID>
  </appliedPageLayouts>
  <hierarchyMirrorAcOpt>
    <section/>
    <accessControlOption>0</accessControlOption>
    <id>0</id>
  </hierarchyMirrorAcOpt>
  <hierarchyMirrorMetadataOpt>
    <section/>
    <metadataOption>0</metadataOption>
    <id>0</id>
  </hierarchyMirrorMetadataOpt>
  <children/>
  <contentTypeScopes>
    <section/>
    <contentType/>
    <scope>0</scope>
    <contentTypeID>0</contentTypeID>
  </contentTypeScopes>
  <cloneSource/>
  <sectionPaths>
    <property1>
      <section/>
      <language>string</language>
      <path>string</path>
    </property1>
    <property2>
      <section/>
      <language>string</language>
      <path>string</path>
    </property2>
  </sectionPaths>
  <webDAVRules>
    <section/>
    <executionOrder>0</executionOrder>
    <contentType>0</contentType>
    <element>string</element>
    <autoApprove>true</autoApprove>
    <csvextensions>string</csvextensions>
    <sectionID>0</sectionID>
  </webDAVRules>
  <sortLock>TOP</sortLock>
  <parent/>
  <mirrors>0</mirrors>
  <root>true</root>
  <workflow>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <status>ACTIVE</status>
    <creationDate>2019-07-02T14:03:45Z</creationDate>
    <lastModified>2019-07-02T14:03:45Z</lastModified>
    <contentTypes/>
    <section/>
    <workflowSteps/>
    <firstStep>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <status>ACTIVE</status>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <priority>PRIORITY_LOWEST</priority>
      <restrictToEditors>0</restrictToEditors>
      <language/>
      <options/>
    </firstStep>
    <currentActiveStep>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <status>ACTIVE</status>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <priority>PRIORITY_LOWEST</priority>
      <restrictToEditors>0</restrictToEditors>
      <language/>
      <options/>
    </currentActiveStep>
  </workflow>
  <link>true</link>
  <mirrorSource/>
  <shown>true</shown>
  <languageCount>0</languageCount>
  <allNames>
    <property1>string</property1>
    <property2>string</property2>
  </allNames>
  <workflowID>0</workflowID>
  <workflowName>string</workflowName>
  <nextSequence>0</nextSequence>
  <childOfMirror>true</childOfMirror>
  <channelRoot>0</channelRoot>
  <entityID>0</entityID>
  <parentID>0</parentID>
  <mirror>true</mirror>
  <sectionSortMethod>0</sectionSortMethod>
  <contentsAndSequences>
    <property1>0</property1>
    <property2>0</property2>
  </contentsAndSequences>
  <contentSortMethod>0</contentSortMethod>
  <mirrorSourceID>0</mirrorSourceID>
  <metadataOption>0</metadataOption>
  <allPathSectionsWebDAVRules>
    <section/>
    <executionOrder>0</executionOrder>
    <contentType>0</contentType>
    <element>string</element>
    <autoApprove>true</autoApprove>
    <csvextensions>string</csvextensions>
    <sectionID>0</sectionID>
  </allPathSectionsWebDAVRules>
  <accessControlOption>0</accessControlOption>
  <currentOrInheritedWorkflow>0</currentOrInheritedWorkflow>
  <childOfMirrored>true</childOfMirrored>
  <parentWorkflowID>0</parentWorkflowID>
  <contentNextSequence>0</contentNextSequence>
  <languages>string</languages>
  <channels>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>string</type>
    <defaultLanguage>string</defaultLanguage>
    <rootSectionID>0</rootSectionID>
    <fileOutputPath>string</fileOutputPath>
    <indexFileName>string</indexFileName>
    <baseHref>string</baseHref>
    <siteRoot>string</siteRoot>
    <pathCaseModifier>0</pathCaseModifier>
    <fullTextType>string</fullTextType>
    <fullTextExtension>string</fullTextExtension>
    <secondaryPublishLanguage>string</secondaryPublishLanguage>
    <channelPublishURL>string</channelPublishURL>
    <parent/>
    <favIconID>0</favIconID>
    <pollIconID>0</pollIconID>
    <accessControlConfigurationID>0</accessControlConfigurationID>
    <personalisationConfigurationID>0</personalisationConfigurationID>
    <publishReportLevel>0</publishReportLevel>
    <pendingVersionOutputPath>string</pendingVersionOutputPath>
    <pendingVersionBaseHref>string</pendingVersionBaseHref>
    <pendingVersionSiteRoot>string</pendingVersionSiteRoot>
    <prePublishProcessorID>0</prePublishProcessorID>
    <allowScriptsInDirectEdit>0</allowScriptsInDirectEdit>
    <channelFullTextDisplayPeriod/>
    <convertSpacesInSectionNameEnabled>true</convertSpacesInSectionNameEnabled>
    <convertSpacesInOutputURIEnabled>true</convertSpacesInOutputURIEnabled>
    <convertSpacesInRetainedFilenameEnabled>true</convertSpacesInRetainedFilenameEnabled>
    <microSite>true</microSite>
    <parentID>0</parentID>
    <publishEmptySectionsEnabled>true</publishEmptySectionsEnabled>
    <personalisationEnabled>true</personalisationEnabled>
    <fullTextDisplayPeriodValue>0</fullTextDisplayPeriodValue>
    <secondaryPublishEnabled>true</secondaryPublishEnabled>
    <accessControlEnabled>true</accessControlEnabled>
    <channelCleanupEnabled>true</channelCleanupEnabled>
    <fullTextDisplayPeriodUnit>0</fullTextDisplayPeriodUnit>
    <overrideExtensionEnabled>true</overrideExtensionEnabled>
  </channels>
  <pathMembers>0</pathMembers>
</sections>
<lastModified>string</lastModified>
<media>true</media>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ContentListing] false none none
»»»»»»»» priority integer(int32) false none none
»»»»»»»» disclaimer string false none none
»»»»»»»» publishRule integer(int32) false none none
»»»»»»»»»» languageIndependant boolean false none none
»»»»»»»»» convertSpacesInSectionNameEnabled boolean false none none
»»»»»»»»» convertSpacesInOutputURIEnabled boolean false none none
»»»»»»»»» convertSpacesInRetainedFilenameEnabled boolean false none none
»»»»»»»»» contentIDs [integer] false none none
»»»»»»»»» languageCodes [string] false none none
»»»»»»»»» microSite boolean false none none
»»»»»»»»» parentID integer(int32) false none none
»»»»»»»»» publishEmptySectionsEnabled boolean false none none
»»»»»»»»» personalisationEnabled boolean false none none
»»»»»»»»» fullTextDisplayPeriodValue integer(int32) false none none
»»»»»»»»» secondaryPublishEnabled boolean false none none
»»»»»»»»» accessControlEnabled boolean false none none
»»»»»»»»» channelCleanupEnabled boolean false none none
»»»»»»»»» fullTextDisplayPeriodUnit integer(int32) false none none
»»»»»»»»» overrideExtensionEnabled boolean false none none
»»»»»»»»»»» elementForFilename integer(int32) false none none
»»»»»»»»»»» alias string false none none
»»»»»»»»»»» directEditEnabled boolean false none none
»»»»»»» memberCount integer(int32) false none none
»»»»»»» deleted boolean false none none
»»»»»»» language string false none none
»»»»»»» name string false none none
»»»»»»» lastModified string(date-time) false none none
»»»»»»» id integer(int32) false none none
»»»»»»» owner integer(int32) false none none
»»»»»» fullTinyMCELocaleCode string false none none
»»»»»» fullLocaleCode string false none none
»»»»»» deleted boolean false none none
»»»»»» authLevel integer(int32) false none none
»»»»»» fullName string false none none
»»»»»» powerUser boolean false none none
»»»»»» administrator boolean false none none
»»»»»»»» value string false none none
»»»»»»»» language string false none none
»»»»»»»» metaTagID integer(int32) false none none
»»»»»»»» metaTagName string false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» pageLayoutID integer(int32) false none none
»»»»»»»» inheritablePageLayoutID integer(int32) false none none
»»»»»»»» sortLock string false none none
»»»»»»» lastModified string false none none
»»»»»»» media boolean false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

listOrphaned

GET /content/orphaned/{languageCode}

Parameters

Parameter In Type Required Description
languageCode path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "name": "string",
    "language": "string",
    "sections": [
      {
        "id": 0,
        "level": 0,
        "status": 0,
        "printSequence": 0,
        "formSection": true,
        "archived": true,
        "users": [
          {
            "id": 0,
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "emailAddress": "string",
            "defaultLang": "string",
            "localeCountryCode": "string",
            "localeLanguageCode": "string",
            "localeVariant": "string",
            "createDate": "2019-07-02T14:03:45Z",
            "lastLoginDate": "2019-07-02T14:03:45Z",
            "enabled": true,
            "password": {},
            "defaultPreviewChannel": 0,
            "preferredHtmlEditor": 0,
            "extranetConsent": true,
            "extranetAccess": "string",
            "extranetConsentDatetime": "2019-07-02T14:03:45Z",
            "groups": [],
            "extensibleUserObjectContent": {},
            "sections": [],
            "userChannels": [],
            "locale": {},
            "appliedPreviewChannel": 0,
            "propertyResourceBundle": {},
            "fullTinyMCELocaleCode": "string",
            "fullLocaleCode": "string",
            "deleted": true,
            "authLevel": 0,
            "fullName": "string",
            "powerUser": true,
            "administrator": true
          }
        ],
        "viewUsers": [
          {
            "id": 0,
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "emailAddress": "string",
            "defaultLang": "string",
            "localeCountryCode": "string",
            "localeLanguageCode": "string",
            "localeVariant": "string",
            "createDate": "2019-07-02T14:03:45Z",
            "lastLoginDate": "2019-07-02T14:03:45Z",
            "enabled": true,
            "password": {},
            "defaultPreviewChannel": 0,
            "preferredHtmlEditor": 0,
            "extranetConsent": true,
            "extranetAccess": "string",
            "extranetConsentDatetime": "2019-07-02T14:03:45Z",
            "groups": [],
            "extensibleUserObjectContent": {},
            "sections": [],
            "userChannels": [],
            "locale": {},
            "appliedPreviewChannel": 0,
            "propertyResourceBundle": {},
            "fullTinyMCELocaleCode": "string",
            "fullLocaleCode": "string",
            "deleted": true,
            "authLevel": 0,
            "fullName": "string",
            "powerUser": true,
            "administrator": true
          }
        ],
        "groups": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "emailAddress": "string",
            "createDate": "2019-07-02T14:03:45Z",
            "enabled": true,
            "ldap": true,
            "defaultChannel": 0,
            "children": [],
            "sections": [],
            "steps": [],
            "memberCount": 0,
            "deleted": true
          }
        ],
        "viewGroups": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "emailAddress": "string",
            "createDate": "2019-07-02T14:03:45Z",
            "enabled": true,
            "ldap": true,
            "defaultChannel": 0,
            "children": [],
            "sections": [],
            "steps": [],
            "memberCount": 0,
            "deleted": true
          }
        ],
        "contentSections": [
          {
            "section": null,
            "content": {},
            "printSequence": 0,
            "sortLock": "TOP",
            "contentID": 0,
            "entityID": 0,
            "sectionID": 0
          }
        ],
        "sectionInfos": {
          "property1": {
            "section": null,
            "language": "string",
            "name": "string",
            "lastModified": "2019-07-02T14:03:45Z",
            "outputUri": "string",
            "outputFilename": "string",
            "keyPhrase": "string",
            "accessKey": "string",
            "contentOwner": 0,
            "metaDatas": []
          },
          "property2": {
            "section": null,
            "language": "string",
            "name": "string",
            "lastModified": "2019-07-02T14:03:45Z",
            "outputUri": "string",
            "outputFilename": "string",
            "keyPhrase": "string",
            "accessKey": "string",
            "contentOwner": 0,
            "metaDatas": []
          }
        },
        "mirrorSections": [
          null
        ],
        "links": {
          "property1": {
            "sourceSection": null,
            "language": "string",
            "url": "string",
            "section": 0,
            "target": "string",
            "inheritedAccessControl": 0,
            "overrideLink": true,
            "linkHasBeenOverridden": true,
            "type": 0,
            "persistentLanguage": "string",
            "sourceSectionID": 0
          },
          "property2": {
            "sourceSection": null,
            "language": "string",
            "url": "string",
            "section": 0,
            "target": "string",
            "inheritedAccessControl": 0,
            "overrideLink": true,
            "linkHasBeenOverridden": true,
            "type": 0,
            "persistentLanguage": "string",
            "sourceSectionID": 0
          }
        },
        "rootChannels": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "type": "string",
            "defaultLanguage": "string",
            "rootSectionID": 0,
            "fileOutputPath": "string",
            "indexFileName": "string",
            "baseHref": "string",
            "siteRoot": "string",
            "pathCaseModifier": 0,
            "fullTextType": "string",
            "fullTextExtension": "string",
            "secondaryPublishLanguage": "string",
            "channelPublishURL": "string",
            "parent": null,
            "favIconID": 0,
            "pollIconID": 0,
            "accessControlConfigurationID": 0,
            "personalisationConfigurationID": 0,
            "publishReportLevel": 0,
            "pendingVersionOutputPath": "string",
            "pendingVersionBaseHref": "string",
            "pendingVersionSiteRoot": "string",
            "prePublishProcessorID": 0,
            "allowScriptsInDirectEdit": 0,
            "languages": [],
            "microSites": [],
            "permittedFileExtensions": [],
            "translationDisclaimers": [],
            "mediaPublishRules": [],
            "channelFullTextDisplayPeriod": {},
            "channelUsers": [],
            "channelContents": [],
            "convertSpacesInSectionNameEnabled": true,
            "convertSpacesInOutputURIEnabled": true,
            "convertSpacesInRetainedFilenameEnabled": true,
            "contentIDs": [],
            "languageCodes": [],
            "microSite": true,
            "parentID": 0,
            "publishEmptySectionsEnabled": true,
            "personalisationEnabled": true,
            "fullTextDisplayPeriodValue": 0,
            "secondaryPublishEnabled": true,
            "accessControlEnabled": true,
            "channelCleanupEnabled": true,
            "fullTextDisplayPeriodUnit": 0,
            "overrideExtensionEnabled": true
          }
        ],
        "appliedPageLayouts": [
          {
            "id": {},
            "sectionID": 0,
            "pageLayoutID": 0,
            "inheritablePageLayoutID": 0,
            "channel": {},
            "section": null,
            "channelName": "string",
            "channelID": 0
          }
        ],
        "hierarchyMirrorAcOpt": {
          "section": null,
          "accessControlOption": 0,
          "id": 0
        },
        "hierarchyMirrorMetadataOpt": {
          "section": null,
          "metadataOption": 0,
          "id": 0
        },
        "children": [
          null
        ],
        "contentTypeScopes": [
          {
            "section": null,
            "contentType": {},
            "scope": 0,
            "contentTypeID": 0
          }
        ],
        "cloneSource": null,
        "sectionPaths": {
          "property1": {
            "section": null,
            "language": "string",
            "path": "string"
          },
          "property2": {
            "section": null,
            "language": "string",
            "path": "string"
          }
        },
        "webDAVRules": [
          {
            "section": null,
            "executionOrder": 0,
            "extensions": [],
            "contentType": 0,
            "element": "string",
            "autoApprove": true,
            "csvextensions": "string",
            "sectionID": 0
          }
        ],
        "sortLock": "TOP",
        "parent": null,
        "mirrors": [
          0
        ],
        "root": true,
        "workflow": {
          "id": 0,
          "name": "string",
          "description": "string",
          "status": "ACTIVE",
          "creationDate": "2019-07-02T14:03:45Z",
          "lastModified": "2019-07-02T14:03:45Z",
          "contentTypes": [
            {}
          ],
          "section": [
            null
          ],
          "workflowSteps": [
            {}
          ],
          "firstStep": {
            "id": 0,
            "name": "string",
            "description": "string",
            "status": "ACTIVE",
            "lastModified": "2019-07-02T14:03:45Z",
            "priority": "PRIORITY_LOWEST",
            "restrictToEditors": 0,
            "language": {},
            "users": [],
            "groups": [],
            "options": {},
            "workflowSteps": []
          },
          "currentActiveStep": {
            "id": 0,
            "name": "string",
            "description": "string",
            "status": "ACTIVE",
            "lastModified": "2019-07-02T14:03:45Z",
            "priority": "PRIORITY_LOWEST",
            "restrictToEditors": 0,
            "language": {},
            "users": [],
            "groups": [],
            "options": {},
            "workflowSteps": []
          }
        },
        "link": true,
        "mirrorSource": null,
        "shown": true,
        "languageCount": 0,
        "allNames": {
          "property1": "string",
          "property2": "string"
        },
        "workflowID": 0,
        "workflowName": "string",
        "nextSequence": 0,
        "childOfMirror": true,
        "channelRoot": [
          0
        ],
        "entityID": 0,
        "parentID": 0,
        "mirror": true,
        "sectionSortMethod": 0,
        "contentsAndSequences": {
          "property1": 0,
          "property2": 0
        },
        "contentSortMethod": 0,
        "mirrorSourceID": 0,
        "metadataOption": 0,
        "allPathSectionsWebDAVRules": [
          {
            "section": null,
            "executionOrder": 0,
            "extensions": [],
            "contentType": 0,
            "element": "string",
            "autoApprove": true,
            "csvextensions": "string",
            "sectionID": 0
          }
        ],
        "accessControlOption": 0,
        "currentOrInheritedWorkflow": 0,
        "childOfMirrored": true,
        "parentWorkflowID": 0,
        "contentNextSequence": 0,
        "languages": [
          "string"
        ],
        "channels": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "type": "string",
            "defaultLanguage": "string",
            "rootSectionID": 0,
            "fileOutputPath": "string",
            "indexFileName": "string",
            "baseHref": "string",
            "siteRoot": "string",
            "pathCaseModifier": 0,
            "fullTextType": "string",
            "fullTextExtension": "string",
            "secondaryPublishLanguage": "string",
            "channelPublishURL": "string",
            "parent": null,
            "favIconID": 0,
            "pollIconID": 0,
            "accessControlConfigurationID": 0,
            "personalisationConfigurationID": 0,
            "publishReportLevel": 0,
            "pendingVersionOutputPath": "string",
            "pendingVersionBaseHref": "string",
            "pendingVersionSiteRoot": "string",
            "prePublishProcessorID": 0,
            "allowScriptsInDirectEdit": 0,
            "languages": [],
            "microSites": [],
            "permittedFileExtensions": [],
            "translationDisclaimers": [],
            "mediaPublishRules": [],
            "channelFullTextDisplayPeriod": {},
            "channelUsers": [],
            "channelContents": [],
            "convertSpacesInSectionNameEnabled": true,
            "convertSpacesInOutputURIEnabled": true,
            "convertSpacesInRetainedFilenameEnabled": true,
            "contentIDs": [],
            "languageCodes": [],
            "microSite": true,
            "parentID": 0,
            "publishEmptySectionsEnabled": true,
            "personalisationEnabled": true,
            "fullTextDisplayPeriodValue": 0,
            "secondaryPublishEnabled": true,
            "accessControlEnabled": true,
            "channelCleanupEnabled": true,
            "fullTextDisplayPeriodUnit": 0,
            "overrideExtensionEnabled": true
          }
        ],
        "pathMembers": [
          0
        ]
      }
    ],
    "lastModified": "string",
    "media": true
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<name>string</name>
<language>string</language>
<sections>
  <id>0</id>
  <level>0</level>
  <status>0</status>
  <printSequence>0</printSequence>
  <formSection>true</formSection>
  <archived>true</archived>
  <users>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <emailAddress>string</emailAddress>
    <defaultLang>string</defaultLang>
    <localeCountryCode>string</localeCountryCode>
    <localeLanguageCode>string</localeLanguageCode>
    <localeVariant>string</localeVariant>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <lastLoginDate>2019-07-02T14:03:45Z</lastLoginDate>
    <enabled>true</enabled>
    <password/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <preferredHtmlEditor>0</preferredHtmlEditor>
    <extranetConsent>true</extranetConsent>
    <extranetAccess>string</extranetAccess>
    <extranetConsentDatetime>2019-07-02T14:03:45Z</extranetConsentDatetime>
    <extensibleUserObjectContent/>
    <locale/>
    <appliedPreviewChannel>0</appliedPreviewChannel>
    <propertyResourceBundle/>
    <fullTinyMCELocaleCode>string</fullTinyMCELocaleCode>
    <fullLocaleCode>string</fullLocaleCode>
    <deleted>true</deleted>
    <authLevel>0</authLevel>
    <fullName>string</fullName>
    <powerUser>true</powerUser>
    <administrator>true</administrator>
  </users>
  <viewUsers>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <emailAddress>string</emailAddress>
    <defaultLang>string</defaultLang>
    <localeCountryCode>string</localeCountryCode>
    <localeLanguageCode>string</localeLanguageCode>
    <localeVariant>string</localeVariant>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <lastLoginDate>2019-07-02T14:03:45Z</lastLoginDate>
    <enabled>true</enabled>
    <password/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <preferredHtmlEditor>0</preferredHtmlEditor>
    <extranetConsent>true</extranetConsent>
    <extranetAccess>string</extranetAccess>
    <extranetConsentDatetime>2019-07-02T14:03:45Z</extranetConsentDatetime>
    <extensibleUserObjectContent/>
    <locale/>
    <appliedPreviewChannel>0</appliedPreviewChannel>
    <propertyResourceBundle/>
    <fullTinyMCELocaleCode>string</fullTinyMCELocaleCode>
    <fullLocaleCode>string</fullLocaleCode>
    <deleted>true</deleted>
    <authLevel>0</authLevel>
    <fullName>string</fullName>
    <powerUser>true</powerUser>
    <administrator>true</administrator>
  </viewUsers>
  <groups>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <emailAddress>string</emailAddress>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <enabled>true</enabled>
    <ldap>true</ldap>
    <defaultChannel>0</defaultChannel>
    <memberCount>0</memberCount>
    <deleted>true</deleted>
  </groups>
  <viewGroups>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <emailAddress>string</emailAddress>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <enabled>true</enabled>
    <ldap>true</ldap>
    <defaultChannel>0</defaultChannel>
    <memberCount>0</memberCount>
    <deleted>true</deleted>
  </viewGroups>
  <contentSections>
    <section/>
    <content/>
    <printSequence>0</printSequence>
    <sortLock>TOP</sortLock>
    <contentID>0</contentID>
    <entityID>0</entityID>
    <sectionID>0</sectionID>
  </contentSections>
  <sectionInfos>
    <property1>
      <section/>
      <language>string</language>
      <name>string</name>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <outputUri>string</outputUri>
      <outputFilename>string</outputFilename>
      <keyPhrase>string</keyPhrase>
      <accessKey>string</accessKey>
      <contentOwner>0</contentOwner>
    </property1>
    <property2>
      <section/>
      <language>string</language>
      <name>string</name>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <outputUri>string</outputUri>
      <outputFilename>string</outputFilename>
      <keyPhrase>string</keyPhrase>
      <accessKey>string</accessKey>
      <contentOwner>0</contentOwner>
    </property2>
  </sectionInfos>
  <mirrorSections/>
  <links>
    <property1>
      <sourceSection/>
      <language>string</language>
      <url>string</url>
      <section>0</section>
      <target>string</target>
      <inheritedAccessControl>0</inheritedAccessControl>
      <overrideLink>true</overrideLink>
      <linkHasBeenOverridden>true</linkHasBeenOverridden>
      <type>0</type>
      <persistentLanguage>string</persistentLanguage>
      <sourceSectionID>0</sourceSectionID>
    </property1>
    <property2>
      <sourceSection/>
      <language>string</language>
      <url>string</url>
      <section>0</section>
      <target>string</target>
      <inheritedAccessControl>0</inheritedAccessControl>
      <overrideLink>true</overrideLink>
      <linkHasBeenOverridden>true</linkHasBeenOverridden>
      <type>0</type>
      <persistentLanguage>string</persistentLanguage>
      <sourceSectionID>0</sourceSectionID>
    </property2>
  </links>
  <rootChannels>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>string</type>
    <defaultLanguage>string</defaultLanguage>
    <rootSectionID>0</rootSectionID>
    <fileOutputPath>string</fileOutputPath>
    <indexFileName>string</indexFileName>
    <baseHref>string</baseHref>
    <siteRoot>string</siteRoot>
    <pathCaseModifier>0</pathCaseModifier>
    <fullTextType>string</fullTextType>
    <fullTextExtension>string</fullTextExtension>
    <secondaryPublishLanguage>string</secondaryPublishLanguage>
    <channelPublishURL>string</channelPublishURL>
    <parent/>
    <favIconID>0</favIconID>
    <pollIconID>0</pollIconID>
    <accessControlConfigurationID>0</accessControlConfigurationID>
    <personalisationConfigurationID>0</personalisationConfigurationID>
    <publishReportLevel>0</publishReportLevel>
    <pendingVersionOutputPath>string</pendingVersionOutputPath>
    <pendingVersionBaseHref>string</pendingVersionBaseHref>
    <pendingVersionSiteRoot>string</pendingVersionSiteRoot>
    <prePublishProcessorID>0</prePublishProcessorID>
    <allowScriptsInDirectEdit>0</allowScriptsInDirectEdit>
    <channelFullTextDisplayPeriod/>
    <convertSpacesInSectionNameEnabled>true</convertSpacesInSectionNameEnabled>
    <convertSpacesInOutputURIEnabled>true</convertSpacesInOutputURIEnabled>
    <convertSpacesInRetainedFilenameEnabled>true</convertSpacesInRetainedFilenameEnabled>
    <microSite>true</microSite>
    <parentID>0</parentID>
    <publishEmptySectionsEnabled>true</publishEmptySectionsEnabled>
    <personalisationEnabled>true</personalisationEnabled>
    <fullTextDisplayPeriodValue>0</fullTextDisplayPeriodValue>
    <secondaryPublishEnabled>true</secondaryPublishEnabled>
    <accessControlEnabled>true</accessControlEnabled>
    <channelCleanupEnabled>true</channelCleanupEnabled>
    <fullTextDisplayPeriodUnit>0</fullTextDisplayPeriodUnit>
    <overrideExtensionEnabled>true</overrideExtensionEnabled>
  </rootChannels>
  <appliedPageLayouts>
    <id/>
    <sectionID>0</sectionID>
    <pageLayoutID>0</pageLayoutID>
    <inheritablePageLayoutID>0</inheritablePageLayoutID>
    <channel/>
    <section/>
    <channelName>string</channelName>
    <channelID>0</channelID>
  </appliedPageLayouts>
  <hierarchyMirrorAcOpt>
    <section/>
    <accessControlOption>0</accessControlOption>
    <id>0</id>
  </hierarchyMirrorAcOpt>
  <hierarchyMirrorMetadataOpt>
    <section/>
    <metadataOption>0</metadataOption>
    <id>0</id>
  </hierarchyMirrorMetadataOpt>
  <children/>
  <contentTypeScopes>
    <section/>
    <contentType/>
    <scope>0</scope>
    <contentTypeID>0</contentTypeID>
  </contentTypeScopes>
  <cloneSource/>
  <sectionPaths>
    <property1>
      <section/>
      <language>string</language>
      <path>string</path>
    </property1>
    <property2>
      <section/>
      <language>string</language>
      <path>string</path>
    </property2>
  </sectionPaths>
  <webDAVRules>
    <section/>
    <executionOrder>0</executionOrder>
    <contentType>0</contentType>
    <element>string</element>
    <autoApprove>true</autoApprove>
    <csvextensions>string</csvextensions>
    <sectionID>0</sectionID>
  </webDAVRules>
  <sortLock>TOP</sortLock>
  <parent/>
  <mirrors>0</mirrors>
  <root>true</root>
  <workflow>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <status>ACTIVE</status>
    <creationDate>2019-07-02T14:03:45Z</creationDate>
    <lastModified>2019-07-02T14:03:45Z</lastModified>
    <contentTypes/>
    <section/>
    <workflowSteps/>
    <firstStep>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <status>ACTIVE</status>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <priority>PRIORITY_LOWEST</priority>
      <restrictToEditors>0</restrictToEditors>
      <language/>
      <options/>
    </firstStep>
    <currentActiveStep>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <status>ACTIVE</status>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <priority>PRIORITY_LOWEST</priority>
      <restrictToEditors>0</restrictToEditors>
      <language/>
      <options/>
    </currentActiveStep>
  </workflow>
  <link>true</link>
  <mirrorSource/>
  <shown>true</shown>
  <languageCount>0</languageCount>
  <allNames>
    <property1>string</property1>
    <property2>string</property2>
  </allNames>
  <workflowID>0</workflowID>
  <workflowName>string</workflowName>
  <nextSequence>0</nextSequence>
  <childOfMirror>true</childOfMirror>
  <channelRoot>0</channelRoot>
  <entityID>0</entityID>
  <parentID>0</parentID>
  <mirror>true</mirror>
  <sectionSortMethod>0</sectionSortMethod>
  <contentsAndSequences>
    <property1>0</property1>
    <property2>0</property2>
  </contentsAndSequences>
  <contentSortMethod>0</contentSortMethod>
  <mirrorSourceID>0</mirrorSourceID>
  <metadataOption>0</metadataOption>
  <allPathSectionsWebDAVRules>
    <section/>
    <executionOrder>0</executionOrder>
    <contentType>0</contentType>
    <element>string</element>
    <autoApprove>true</autoApprove>
    <csvextensions>string</csvextensions>
    <sectionID>0</sectionID>
  </allPathSectionsWebDAVRules>
  <accessControlOption>0</accessControlOption>
  <currentOrInheritedWorkflow>0</currentOrInheritedWorkflow>
  <childOfMirrored>true</childOfMirrored>
  <parentWorkflowID>0</parentWorkflowID>
  <contentNextSequence>0</contentNextSequence>
  <languages>string</languages>
  <channels>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>string</type>
    <defaultLanguage>string</defaultLanguage>
    <rootSectionID>0</rootSectionID>
    <fileOutputPath>string</fileOutputPath>
    <indexFileName>string</indexFileName>
    <baseHref>string</baseHref>
    <siteRoot>string</siteRoot>
    <pathCaseModifier>0</pathCaseModifier>
    <fullTextType>string</fullTextType>
    <fullTextExtension>string</fullTextExtension>
    <secondaryPublishLanguage>string</secondaryPublishLanguage>
    <channelPublishURL>string</channelPublishURL>
    <parent/>
    <favIconID>0</favIconID>
    <pollIconID>0</pollIconID>
    <accessControlConfigurationID>0</accessControlConfigurationID>
    <personalisationConfigurationID>0</personalisationConfigurationID>
    <publishReportLevel>0</publishReportLevel>
    <pendingVersionOutputPath>string</pendingVersionOutputPath>
    <pendingVersionBaseHref>string</pendingVersionBaseHref>
    <pendingVersionSiteRoot>string</pendingVersionSiteRoot>
    <prePublishProcessorID>0</prePublishProcessorID>
    <allowScriptsInDirectEdit>0</allowScriptsInDirectEdit>
    <channelFullTextDisplayPeriod/>
    <convertSpacesInSectionNameEnabled>true</convertSpacesInSectionNameEnabled>
    <convertSpacesInOutputURIEnabled>true</convertSpacesInOutputURIEnabled>
    <convertSpacesInRetainedFilenameEnabled>true</convertSpacesInRetainedFilenameEnabled>
    <microSite>true</microSite>
    <parentID>0</parentID>
    <publishEmptySectionsEnabled>true</publishEmptySectionsEnabled>
    <personalisationEnabled>true</personalisationEnabled>
    <fullTextDisplayPeriodValue>0</fullTextDisplayPeriodValue>
    <secondaryPublishEnabled>true</secondaryPublishEnabled>
    <accessControlEnabled>true</accessControlEnabled>
    <channelCleanupEnabled>true</channelCleanupEnabled>
    <fullTextDisplayPeriodUnit>0</fullTextDisplayPeriodUnit>
    <overrideExtensionEnabled>true</overrideExtensionEnabled>
  </channels>
  <pathMembers>0</pathMembers>
</sections>
<lastModified>string</lastModified>
<media>true</media>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ContentListing] false none none
»»»»»»»» priority integer(int32) false none none
»»»»»»»» disclaimer string false none none
»»»»»»»» publishRule integer(int32) false none none
»»»»»»»»»» languageIndependant boolean false none none
»»»»»»»»» convertSpacesInSectionNameEnabled boolean false none none
»»»»»»»»» convertSpacesInOutputURIEnabled boolean false none none
»»»»»»»»» convertSpacesInRetainedFilenameEnabled boolean false none none
»»»»»»»»» contentIDs [integer] false none none
»»»»»»»»» languageCodes [string] false none none
»»»»»»»»» microSite boolean false none none
»»»»»»»»» parentID integer(int32) false none none
»»»»»»»»» publishEmptySectionsEnabled boolean false none none
»»»»»»»»» personalisationEnabled boolean false none none
»»»»»»»»» fullTextDisplayPeriodValue integer(int32) false none none
»»»»»»»»» secondaryPublishEnabled boolean false none none
»»»»»»»»» accessControlEnabled boolean false none none
»»»»»»»»» channelCleanupEnabled boolean false none none
»»»»»»»»» fullTextDisplayPeriodUnit integer(int32) false none none
»»»»»»»»» overrideExtensionEnabled boolean false none none
»»»»»»»»»»» elementForFilename integer(int32) false none none
»»»»»»»»»»» alias string false none none
»»»»»»»»»»» directEditEnabled boolean false none none
»»»»»»» memberCount integer(int32) false none none
»»»»»»» deleted boolean false none none
»»»»»»» language string false none none
»»»»»»» name string false none none
»»»»»»» lastModified string(date-time) false none none
»»»»»»» id integer(int32) false none none
»»»»»»» owner integer(int32) false none none
»»»»»» fullTinyMCELocaleCode string false none none
»»»»»» fullLocaleCode string false none none
»»»»»» deleted boolean false none none
»»»»»» authLevel integer(int32) false none none
»»»»»» fullName string false none none
»»»»»» powerUser boolean false none none
»»»»»» administrator boolean false none none
»»»»»»»» value string false none none
»»»»»»»» language string false none none
»»»»»»»» metaTagID integer(int32) false none none
»»»»»»»» metaTagName string false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» pageLayoutID integer(int32) false none none
»»»»»»»» inheritablePageLayoutID integer(int32) false none none
»»»»»»»» sortLock string false none none
»»»»»»» lastModified string false none none
»»»»»»» media boolean false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

listPending

GET /content/pending/{languageCode}

Parameters

Parameter In Type Required Description
languageCode path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "language": "string",
    "version": "string",
    "name": "string",
    "status": 0,
    "lastModified": "2019-07-02T14:03:45Z",
    "lastModifiedBy": "string",
    "lastModifiedById": 0,
    "ownerId": 0,
    "owner": "string",
    "workflow": {
      "id": 0,
      "name": "string",
      "description": "string",
      "stepId": 0,
      "stepNumber": 0,
      "stepName": "string",
      "instanceId": 0
    },
    "previousVersion": "string",
    "sections": [
      {
        "id": 0,
        "level": 0,
        "status": 0,
        "printSequence": 0,
        "formSection": true,
        "archived": true,
        "users": [
          {
            "id": 0,
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "emailAddress": "string",
            "defaultLang": "string",
            "localeCountryCode": "string",
            "localeLanguageCode": "string",
            "localeVariant": "string",
            "createDate": "2019-07-02T14:03:45Z",
            "lastLoginDate": "2019-07-02T14:03:45Z",
            "enabled": true,
            "password": {},
            "defaultPreviewChannel": 0,
            "preferredHtmlEditor": 0,
            "extranetConsent": true,
            "extranetAccess": "string",
            "extranetConsentDatetime": "2019-07-02T14:03:45Z",
            "groups": [],
            "extensibleUserObjectContent": {},
            "sections": [],
            "userChannels": [],
            "locale": {},
            "appliedPreviewChannel": 0,
            "propertyResourceBundle": {},
            "fullTinyMCELocaleCode": "string",
            "fullLocaleCode": "string",
            "deleted": true,
            "authLevel": 0,
            "fullName": "string",
            "powerUser": true,
            "administrator": true
          }
        ],
        "viewUsers": [
          {
            "id": 0,
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "emailAddress": "string",
            "defaultLang": "string",
            "localeCountryCode": "string",
            "localeLanguageCode": "string",
            "localeVariant": "string",
            "createDate": "2019-07-02T14:03:45Z",
            "lastLoginDate": "2019-07-02T14:03:45Z",
            "enabled": true,
            "password": {},
            "defaultPreviewChannel": 0,
            "preferredHtmlEditor": 0,
            "extranetConsent": true,
            "extranetAccess": "string",
            "extranetConsentDatetime": "2019-07-02T14:03:45Z",
            "groups": [],
            "extensibleUserObjectContent": {},
            "sections": [],
            "userChannels": [],
            "locale": {},
            "appliedPreviewChannel": 0,
            "propertyResourceBundle": {},
            "fullTinyMCELocaleCode": "string",
            "fullLocaleCode": "string",
            "deleted": true,
            "authLevel": 0,
            "fullName": "string",
            "powerUser": true,
            "administrator": true
          }
        ],
        "groups": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "emailAddress": "string",
            "createDate": "2019-07-02T14:03:45Z",
            "enabled": true,
            "ldap": true,
            "defaultChannel": 0,
            "children": [],
            "sections": [],
            "steps": [],
            "memberCount": 0,
            "deleted": true
          }
        ],
        "viewGroups": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "emailAddress": "string",
            "createDate": "2019-07-02T14:03:45Z",
            "enabled": true,
            "ldap": true,
            "defaultChannel": 0,
            "children": [],
            "sections": [],
            "steps": [],
            "memberCount": 0,
            "deleted": true
          }
        ],
        "contentSections": [
          {
            "section": null,
            "content": {},
            "printSequence": 0,
            "sortLock": "TOP",
            "contentID": 0,
            "entityID": 0,
            "sectionID": 0
          }
        ],
        "sectionInfos": {
          "property1": {
            "section": null,
            "language": "string",
            "name": "string",
            "lastModified": "2019-07-02T14:03:45Z",
            "outputUri": "string",
            "outputFilename": "string",
            "keyPhrase": "string",
            "accessKey": "string",
            "contentOwner": 0,
            "metaDatas": []
          },
          "property2": {
            "section": null,
            "language": "string",
            "name": "string",
            "lastModified": "2019-07-02T14:03:45Z",
            "outputUri": "string",
            "outputFilename": "string",
            "keyPhrase": "string",
            "accessKey": "string",
            "contentOwner": 0,
            "metaDatas": []
          }
        },
        "mirrorSections": [
          null
        ],
        "links": {
          "property1": {
            "sourceSection": null,
            "language": "string",
            "url": "string",
            "section": 0,
            "target": "string",
            "inheritedAccessControl": 0,
            "overrideLink": true,
            "linkHasBeenOverridden": true,
            "type": 0,
            "persistentLanguage": "string",
            "sourceSectionID": 0
          },
          "property2": {
            "sourceSection": null,
            "language": "string",
            "url": "string",
            "section": 0,
            "target": "string",
            "inheritedAccessControl": 0,
            "overrideLink": true,
            "linkHasBeenOverridden": true,
            "type": 0,
            "persistentLanguage": "string",
            "sourceSectionID": 0
          }
        },
        "rootChannels": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "type": "string",
            "defaultLanguage": "string",
            "rootSectionID": 0,
            "fileOutputPath": "string",
            "indexFileName": "string",
            "baseHref": "string",
            "siteRoot": "string",
            "pathCaseModifier": 0,
            "fullTextType": "string",
            "fullTextExtension": "string",
            "secondaryPublishLanguage": "string",
            "channelPublishURL": "string",
            "parent": null,
            "favIconID": 0,
            "pollIconID": 0,
            "accessControlConfigurationID": 0,
            "personalisationConfigurationID": 0,
            "publishReportLevel": 0,
            "pendingVersionOutputPath": "string",
            "pendingVersionBaseHref": "string",
            "pendingVersionSiteRoot": "string",
            "prePublishProcessorID": 0,
            "allowScriptsInDirectEdit": 0,
            "languages": [],
            "microSites": [],
            "permittedFileExtensions": [],
            "translationDisclaimers": [],
            "mediaPublishRules": [],
            "channelFullTextDisplayPeriod": {},
            "channelUsers": [],
            "channelContents": [],
            "convertSpacesInSectionNameEnabled": true,
            "convertSpacesInOutputURIEnabled": true,
            "convertSpacesInRetainedFilenameEnabled": true,
            "contentIDs": [],
            "languageCodes": [],
            "microSite": true,
            "parentID": 0,
            "publishEmptySectionsEnabled": true,
            "personalisationEnabled": true,
            "fullTextDisplayPeriodValue": 0,
            "secondaryPublishEnabled": true,
            "accessControlEnabled": true,
            "channelCleanupEnabled": true,
            "fullTextDisplayPeriodUnit": 0,
            "overrideExtensionEnabled": true
          }
        ],
        "appliedPageLayouts": [
          {
            "id": {},
            "sectionID": 0,
            "pageLayoutID": 0,
            "inheritablePageLayoutID": 0,
            "channel": {},
            "section": null,
            "channelName": "string",
            "channelID": 0
          }
        ],
        "hierarchyMirrorAcOpt": {
          "section": null,
          "accessControlOption": 0,
          "id": 0
        },
        "hierarchyMirrorMetadataOpt": {
          "section": null,
          "metadataOption": 0,
          "id": 0
        },
        "children": [
          null
        ],
        "contentTypeScopes": [
          {
            "section": null,
            "contentType": {},
            "scope": 0,
            "contentTypeID": 0
          }
        ],
        "cloneSource": null,
        "sectionPaths": {
          "property1": {
            "section": null,
            "language": "string",
            "path": "string"
          },
          "property2": {
            "section": null,
            "language": "string",
            "path": "string"
          }
        },
        "webDAVRules": [
          {
            "section": null,
            "executionOrder": 0,
            "extensions": [],
            "contentType": 0,
            "element": "string",
            "autoApprove": true,
            "csvextensions": "string",
            "sectionID": 0
          }
        ],
        "sortLock": "TOP",
        "parent": null,
        "mirrors": [
          0
        ],
        "root": true,
        "workflow": {
          "id": 0,
          "name": "string",
          "description": "string",
          "status": "ACTIVE",
          "creationDate": "2019-07-02T14:03:45Z",
          "lastModified": "2019-07-02T14:03:45Z",
          "contentTypes": [
            {}
          ],
          "section": [
            null
          ],
          "workflowSteps": [
            {}
          ],
          "firstStep": {
            "id": 0,
            "name": "string",
            "description": "string",
            "status": "ACTIVE",
            "lastModified": "2019-07-02T14:03:45Z",
            "priority": "PRIORITY_LOWEST",
            "restrictToEditors": 0,
            "language": {},
            "users": [],
            "groups": [],
            "options": {},
            "workflowSteps": []
          },
          "currentActiveStep": {
            "id": 0,
            "name": "string",
            "description": "string",
            "status": "ACTIVE",
            "lastModified": "2019-07-02T14:03:45Z",
            "priority": "PRIORITY_LOWEST",
            "restrictToEditors": 0,
            "language": {},
            "users": [],
            "groups": [],
            "options": {},
            "workflowSteps": []
          }
        },
        "link": true,
        "mirrorSource": null,
        "shown": true,
        "languageCount": 0,
        "allNames": {
          "property1": "string",
          "property2": "string"
        },
        "workflowID": 0,
        "workflowName": "string",
        "nextSequence": 0,
        "childOfMirror": true,
        "channelRoot": [
          0
        ],
        "entityID": 0,
        "parentID": 0,
        "mirror": true,
        "sectionSortMethod": 0,
        "contentsAndSequences": {
          "property1": 0,
          "property2": 0
        },
        "contentSortMethod": 0,
        "mirrorSourceID": 0,
        "metadataOption": 0,
        "allPathSectionsWebDAVRules": [
          {
            "section": null,
            "executionOrder": 0,
            "extensions": [],
            "contentType": 0,
            "element": "string",
            "autoApprove": true,
            "csvextensions": "string",
            "sectionID": 0
          }
        ],
        "accessControlOption": 0,
        "currentOrInheritedWorkflow": 0,
        "childOfMirrored": true,
        "parentWorkflowID": 0,
        "contentNextSequence": 0,
        "languages": [
          "string"
        ],
        "channels": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "type": "string",
            "defaultLanguage": "string",
            "rootSectionID": 0,
            "fileOutputPath": "string",
            "indexFileName": "string",
            "baseHref": "string",
            "siteRoot": "string",
            "pathCaseModifier": 0,
            "fullTextType": "string",
            "fullTextExtension": "string",
            "secondaryPublishLanguage": "string",
            "channelPublishURL": "string",
            "parent": null,
            "favIconID": 0,
            "pollIconID": 0,
            "accessControlConfigurationID": 0,
            "personalisationConfigurationID": 0,
            "publishReportLevel": 0,
            "pendingVersionOutputPath": "string",
            "pendingVersionBaseHref": "string",
            "pendingVersionSiteRoot": "string",
            "prePublishProcessorID": 0,
            "allowScriptsInDirectEdit": 0,
            "languages": [],
            "microSites": [],
            "permittedFileExtensions": [],
            "translationDisclaimers": [],
            "mediaPublishRules": [],
            "channelFullTextDisplayPeriod": {},
            "channelUsers": [],
            "channelContents": [],
            "convertSpacesInSectionNameEnabled": true,
            "convertSpacesInOutputURIEnabled": true,
            "convertSpacesInRetainedFilenameEnabled": true,
            "contentIDs": [],
            "languageCodes": [],
            "microSite": true,
            "parentID": 0,
            "publishEmptySectionsEnabled": true,
            "personalisationEnabled": true,
            "fullTextDisplayPeriodValue": 0,
            "secondaryPublishEnabled": true,
            "accessControlEnabled": true,
            "channelCleanupEnabled": true,
            "fullTextDisplayPeriodUnit": 0,
            "overrideExtensionEnabled": true
          }
        ],
        "pathMembers": [
          0
        ]
      }
    ],
    "alreadyVoted": true
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<language>string</language>
<version>string</version>
<name>string</name>
<status>0</status>
<lastModified>2019-07-02T14:03:45Z</lastModified>
<lastModifiedBy>string</lastModifiedBy>
<lastModifiedById>0</lastModifiedById>
<ownerId>0</ownerId>
<owner>string</owner>
<workflow>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <stepId>0</stepId>
  <stepNumber>0</stepNumber>
  <stepName>string</stepName>
  <instanceId>0</instanceId>
</workflow>
<previousVersion>string</previousVersion>
<sections>
  <id>0</id>
  <level>0</level>
  <status>0</status>
  <printSequence>0</printSequence>
  <formSection>true</formSection>
  <archived>true</archived>
  <users>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <emailAddress>string</emailAddress>
    <defaultLang>string</defaultLang>
    <localeCountryCode>string</localeCountryCode>
    <localeLanguageCode>string</localeLanguageCode>
    <localeVariant>string</localeVariant>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <lastLoginDate>2019-07-02T14:03:45Z</lastLoginDate>
    <enabled>true</enabled>
    <password/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <preferredHtmlEditor>0</preferredHtmlEditor>
    <extranetConsent>true</extranetConsent>
    <extranetAccess>string</extranetAccess>
    <extranetConsentDatetime>2019-07-02T14:03:45Z</extranetConsentDatetime>
    <extensibleUserObjectContent/>
    <locale/>
    <appliedPreviewChannel>0</appliedPreviewChannel>
    <propertyResourceBundle/>
    <fullTinyMCELocaleCode>string</fullTinyMCELocaleCode>
    <fullLocaleCode>string</fullLocaleCode>
    <deleted>true</deleted>
    <authLevel>0</authLevel>
    <fullName>string</fullName>
    <powerUser>true</powerUser>
    <administrator>true</administrator>
  </users>
  <viewUsers>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <emailAddress>string</emailAddress>
    <defaultLang>string</defaultLang>
    <localeCountryCode>string</localeCountryCode>
    <localeLanguageCode>string</localeLanguageCode>
    <localeVariant>string</localeVariant>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <lastLoginDate>2019-07-02T14:03:45Z</lastLoginDate>
    <enabled>true</enabled>
    <password/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <preferredHtmlEditor>0</preferredHtmlEditor>
    <extranetConsent>true</extranetConsent>
    <extranetAccess>string</extranetAccess>
    <extranetConsentDatetime>2019-07-02T14:03:45Z</extranetConsentDatetime>
    <extensibleUserObjectContent/>
    <locale/>
    <appliedPreviewChannel>0</appliedPreviewChannel>
    <propertyResourceBundle/>
    <fullTinyMCELocaleCode>string</fullTinyMCELocaleCode>
    <fullLocaleCode>string</fullLocaleCode>
    <deleted>true</deleted>
    <authLevel>0</authLevel>
    <fullName>string</fullName>
    <powerUser>true</powerUser>
    <administrator>true</administrator>
  </viewUsers>
  <groups>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <emailAddress>string</emailAddress>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <enabled>true</enabled>
    <ldap>true</ldap>
    <defaultChannel>0</defaultChannel>
    <memberCount>0</memberCount>
    <deleted>true</deleted>
  </groups>
  <viewGroups>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <emailAddress>string</emailAddress>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <enabled>true</enabled>
    <ldap>true</ldap>
    <defaultChannel>0</defaultChannel>
    <memberCount>0</memberCount>
    <deleted>true</deleted>
  </viewGroups>
  <contentSections>
    <section/>
    <content/>
    <printSequence>0</printSequence>
    <sortLock>TOP</sortLock>
    <contentID>0</contentID>
    <entityID>0</entityID>
    <sectionID>0</sectionID>
  </contentSections>
  <sectionInfos>
    <property1>
      <section/>
      <language>string</language>
      <name>string</name>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <outputUri>string</outputUri>
      <outputFilename>string</outputFilename>
      <keyPhrase>string</keyPhrase>
      <accessKey>string</accessKey>
      <contentOwner>0</contentOwner>
    </property1>
    <property2>
      <section/>
      <language>string</language>
      <name>string</name>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <outputUri>string</outputUri>
      <outputFilename>string</outputFilename>
      <keyPhrase>string</keyPhrase>
      <accessKey>string</accessKey>
      <contentOwner>0</contentOwner>
    </property2>
  </sectionInfos>
  <mirrorSections/>
  <links>
    <property1>
      <sourceSection/>
      <language>string</language>
      <url>string</url>
      <section>0</section>
      <target>string</target>
      <inheritedAccessControl>0</inheritedAccessControl>
      <overrideLink>true</overrideLink>
      <linkHasBeenOverridden>true</linkHasBeenOverridden>
      <type>0</type>
      <persistentLanguage>string</persistentLanguage>
      <sourceSectionID>0</sourceSectionID>
    </property1>
    <property2>
      <sourceSection/>
      <language>string</language>
      <url>string</url>
      <section>0</section>
      <target>string</target>
      <inheritedAccessControl>0</inheritedAccessControl>
      <overrideLink>true</overrideLink>
      <linkHasBeenOverridden>true</linkHasBeenOverridden>
      <type>0</type>
      <persistentLanguage>string</persistentLanguage>
      <sourceSectionID>0</sourceSectionID>
    </property2>
  </links>
  <rootChannels>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>string</type>
    <defaultLanguage>string</defaultLanguage>
    <rootSectionID>0</rootSectionID>
    <fileOutputPath>string</fileOutputPath>
    <indexFileName>string</indexFileName>
    <baseHref>string</baseHref>
    <siteRoot>string</siteRoot>
    <pathCaseModifier>0</pathCaseModifier>
    <fullTextType>string</fullTextType>
    <fullTextExtension>string</fullTextExtension>
    <secondaryPublishLanguage>string</secondaryPublishLanguage>
    <channelPublishURL>string</channelPublishURL>
    <parent/>
    <favIconID>0</favIconID>
    <pollIconID>0</pollIconID>
    <accessControlConfigurationID>0</accessControlConfigurationID>
    <personalisationConfigurationID>0</personalisationConfigurationID>
    <publishReportLevel>0</publishReportLevel>
    <pendingVersionOutputPath>string</pendingVersionOutputPath>
    <pendingVersionBaseHref>string</pendingVersionBaseHref>
    <pendingVersionSiteRoot>string</pendingVersionSiteRoot>
    <prePublishProcessorID>0</prePublishProcessorID>
    <allowScriptsInDirectEdit>0</allowScriptsInDirectEdit>
    <channelFullTextDisplayPeriod/>
    <convertSpacesInSectionNameEnabled>true</convertSpacesInSectionNameEnabled>
    <convertSpacesInOutputURIEnabled>true</convertSpacesInOutputURIEnabled>
    <convertSpacesInRetainedFilenameEnabled>true</convertSpacesInRetainedFilenameEnabled>
    <microSite>true</microSite>
    <parentID>0</parentID>
    <publishEmptySectionsEnabled>true</publishEmptySectionsEnabled>
    <personalisationEnabled>true</personalisationEnabled>
    <fullTextDisplayPeriodValue>0</fullTextDisplayPeriodValue>
    <secondaryPublishEnabled>true</secondaryPublishEnabled>
    <accessControlEnabled>true</accessControlEnabled>
    <channelCleanupEnabled>true</channelCleanupEnabled>
    <fullTextDisplayPeriodUnit>0</fullTextDisplayPeriodUnit>
    <overrideExtensionEnabled>true</overrideExtensionEnabled>
  </rootChannels>
  <appliedPageLayouts>
    <id/>
    <sectionID>0</sectionID>
    <pageLayoutID>0</pageLayoutID>
    <inheritablePageLayoutID>0</inheritablePageLayoutID>
    <channel/>
    <section/>
    <channelName>string</channelName>
    <channelID>0</channelID>
  </appliedPageLayouts>
  <hierarchyMirrorAcOpt>
    <section/>
    <accessControlOption>0</accessControlOption>
    <id>0</id>
  </hierarchyMirrorAcOpt>
  <hierarchyMirrorMetadataOpt>
    <section/>
    <metadataOption>0</metadataOption>
    <id>0</id>
  </hierarchyMirrorMetadataOpt>
  <children/>
  <contentTypeScopes>
    <section/>
    <contentType/>
    <scope>0</scope>
    <contentTypeID>0</contentTypeID>
  </contentTypeScopes>
  <cloneSource/>
  <sectionPaths>
    <property1>
      <section/>
      <language>string</language>
      <path>string</path>
    </property1>
    <property2>
      <section/>
      <language>string</language>
      <path>string</path>
    </property2>
  </sectionPaths>
  <webDAVRules>
    <section/>
    <executionOrder>0</executionOrder>
    <contentType>0</contentType>
    <element>string</element>
    <autoApprove>true</autoApprove>
    <csvextensions>string</csvextensions>
    <sectionID>0</sectionID>
  </webDAVRules>
  <sortLock>TOP</sortLock>
  <parent/>
  <mirrors>0</mirrors>
  <root>true</root>
  <workflow>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <status>ACTIVE</status>
    <creationDate>2019-07-02T14:03:45Z</creationDate>
    <lastModified>2019-07-02T14:03:45Z</lastModified>
    <contentTypes/>
    <section/>
    <workflowSteps/>
    <firstStep>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <status>ACTIVE</status>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <priority>PRIORITY_LOWEST</priority>
      <restrictToEditors>0</restrictToEditors>
      <language/>
      <options/>
    </firstStep>
    <currentActiveStep>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <status>ACTIVE</status>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <priority>PRIORITY_LOWEST</priority>
      <restrictToEditors>0</restrictToEditors>
      <language/>
      <options/>
    </currentActiveStep>
  </workflow>
  <link>true</link>
  <mirrorSource/>
  <shown>true</shown>
  <languageCount>0</languageCount>
  <allNames>
    <property1>string</property1>
    <property2>string</property2>
  </allNames>
  <workflowID>0</workflowID>
  <workflowName>string</workflowName>
  <nextSequence>0</nextSequence>
  <childOfMirror>true</childOfMirror>
  <channelRoot>0</channelRoot>
  <entityID>0</entityID>
  <parentID>0</parentID>
  <mirror>true</mirror>
  <sectionSortMethod>0</sectionSortMethod>
  <contentsAndSequences>
    <property1>0</property1>
    <property2>0</property2>
  </contentsAndSequences>
  <contentSortMethod>0</contentSortMethod>
  <mirrorSourceID>0</mirrorSourceID>
  <metadataOption>0</metadataOption>
  <allPathSectionsWebDAVRules>
    <section/>
    <executionOrder>0</executionOrder>
    <contentType>0</contentType>
    <element>string</element>
    <autoApprove>true</autoApprove>
    <csvextensions>string</csvextensions>
    <sectionID>0</sectionID>
  </allPathSectionsWebDAVRules>
  <accessControlOption>0</accessControlOption>
  <currentOrInheritedWorkflow>0</currentOrInheritedWorkflow>
  <childOfMirrored>true</childOfMirrored>
  <parentWorkflowID>0</parentWorkflowID>
  <contentNextSequence>0</contentNextSequence>
  <languages>string</languages>
  <channels>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>string</type>
    <defaultLanguage>string</defaultLanguage>
    <rootSectionID>0</rootSectionID>
    <fileOutputPath>string</fileOutputPath>
    <indexFileName>string</indexFileName>
    <baseHref>string</baseHref>
    <siteRoot>string</siteRoot>
    <pathCaseModifier>0</pathCaseModifier>
    <fullTextType>string</fullTextType>
    <fullTextExtension>string</fullTextExtension>
    <secondaryPublishLanguage>string</secondaryPublishLanguage>
    <channelPublishURL>string</channelPublishURL>
    <parent/>
    <favIconID>0</favIconID>
    <pollIconID>0</pollIconID>
    <accessControlConfigurationID>0</accessControlConfigurationID>
    <personalisationConfigurationID>0</personalisationConfigurationID>
    <publishReportLevel>0</publishReportLevel>
    <pendingVersionOutputPath>string</pendingVersionOutputPath>
    <pendingVersionBaseHref>string</pendingVersionBaseHref>
    <pendingVersionSiteRoot>string</pendingVersionSiteRoot>
    <prePublishProcessorID>0</prePublishProcessorID>
    <allowScriptsInDirectEdit>0</allowScriptsInDirectEdit>
    <channelFullTextDisplayPeriod/>
    <convertSpacesInSectionNameEnabled>true</convertSpacesInSectionNameEnabled>
    <convertSpacesInOutputURIEnabled>true</convertSpacesInOutputURIEnabled>
    <convertSpacesInRetainedFilenameEnabled>true</convertSpacesInRetainedFilenameEnabled>
    <microSite>true</microSite>
    <parentID>0</parentID>
    <publishEmptySectionsEnabled>true</publishEmptySectionsEnabled>
    <personalisationEnabled>true</personalisationEnabled>
    <fullTextDisplayPeriodValue>0</fullTextDisplayPeriodValue>
    <secondaryPublishEnabled>true</secondaryPublishEnabled>
    <accessControlEnabled>true</accessControlEnabled>
    <channelCleanupEnabled>true</channelCleanupEnabled>
    <fullTextDisplayPeriodUnit>0</fullTextDisplayPeriodUnit>
    <overrideExtensionEnabled>true</overrideExtensionEnabled>
  </channels>
  <pathMembers>0</pathMembers>
</sections>
<alreadyVoted>true</alreadyVoted>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ApprovableContent] false none none
»»»»»»»» priority integer(int32) false none none
»»»»»»»» disclaimer string false none none
»»»»»»»» publishRule integer(int32) false none none
»»»»»»»»»» languageIndependant boolean false none none
»»»»»»»»» convertSpacesInSectionNameEnabled boolean false none none
»»»»»»»»» convertSpacesInOutputURIEnabled boolean false none none
»»»»»»»»» convertSpacesInRetainedFilenameEnabled boolean false none none
»»»»»»»»» contentIDs [integer] false none none
»»»»»»»»» languageCodes [string] false none none
»»»»»»»»» microSite boolean false none none
»»»»»»»»» parentID integer(int32) false none none
»»»»»»»»» publishEmptySectionsEnabled boolean false none none
»»»»»»»»» personalisationEnabled boolean false none none
»»»»»»»»» fullTextDisplayPeriodValue integer(int32) false none none
»»»»»»»»» secondaryPublishEnabled boolean false none none
»»»»»»»»» accessControlEnabled boolean false none none
»»»»»»»»» channelCleanupEnabled boolean false none none
»»»»»»»»» fullTextDisplayPeriodUnit integer(int32) false none none
»»»»»»»»» overrideExtensionEnabled boolean false none none
»»»»»»»»»»» elementForFilename integer(int32) false none none
»»»»»»»»»»» alias string false none none
»»»»»»»»»»» directEditEnabled boolean false none none
»»»»»»» memberCount integer(int32) false none none
»»»»»»» deleted boolean false none none
»»»»»»» language string false none none
»»»»»»» name string false none none
»»»»»»» lastModified string(date-time) false none none
»»»»»»» id integer(int32) false none none
»»»»»»» owner integer(int32) false none none
»»»»»» fullTinyMCELocaleCode string false none none
»»»»»» fullLocaleCode string false none none
»»»»»» deleted boolean false none none
»»»»»» authLevel integer(int32) false none none
»»»»»» fullName string false none none
»»»»»» powerUser boolean false none none
»»»»»» administrator boolean false none none
»»»»»»»» value string false none none
»»»»»»»» language string false none none
»»»»»»»» metaTagID integer(int32) false none none
»»»»»»»» metaTagName string false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» pageLayoutID integer(int32) false none none
»»»»»»»» inheritablePageLayoutID integer(int32) false none none
»»»»»»»» sortLock string false none none
»»»»»»» alreadyVoted boolean false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

purgeContent

POST /content/purge

Body parameter

{
  "languageCode": "string",
  "contentIds": [
    0
  ]
}

Parameters

Parameter In Type Required Description
body body PurgeRequestDTO false none

Responses

Status Meaning Description Schema
default Default successful operation None

get

GET /content/{section}/{id}/{language}

Parameters

Parameter In Type Required Description
section path integer(int32) true none
id path integer(int32) true none
language path string true none

Example responses

200 Response

{
  "id": 0,
  "contentTypeID": 0,
  "archiveSection": 0,
  "publishDate": "2019-07-02T14:03:45Z",
  "reviewDate": "2019-07-02T14:03:45Z",
  "expiryDate": "2019-07-02T14:03:45Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-07-02T14:03:45Z",
  "lastModifiedBy": 0,
  "lastModifierName": "string",
  "contentTypeName": "string",
  "contentTypeAlias": "string",
  "owner": {
    "id": 0,
    "type": "USER"
  },
  "version": "string",
  "previousVersion": "string",
  "channels": [
    0
  ],
  "mirroredSectionPaths": {
    "property1": "string",
    "property2": "string"
  },
  "editable": true,
  "expired": true,
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-07-02T14:03:45Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "elements": {
    "property1": {},
    "property2": {}
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": 0,
      "group": {
        "id": 0,
        "name": "string",
        "description": "string",
        "emailAddress": "string",
        "createDate": "2019-07-02T14:03:45Z",
        "enabled": true,
        "ldap": true,
        "defaultChannel": 0,
        "deleted": true
      },
      "readLevel": 0,
      "assetType": 0,
      "assetID": 0,
      "groupName": "string",
      "groupID": 0
    },
    "sharedGroups": [
      {
        "ownershipLevel": 0,
        "group": {
          "id": 0,
          "name": "string",
          "description": "string",
          "emailAddress": "string",
          "createDate": "2019-07-02T14:03:45Z",
          "enabled": true,
          "ldap": true,
          "defaultChannel": 0,
          "deleted": true
        },
        "readLevel": 0,
        "assetType": 0,
        "assetID": 0,
        "groupName": "string",
        "groupID": 0
      }
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {
        "id": 0,
        "contentTypeID": 0,
        "name": "string",
        "description": "string",
        "type": 0,
        "maxSize": 0,
        "compulsory": true,
        "input_method": 0,
        "listId": 0,
        "sequence": 0,
        "alias": "string",
        "contentTypeMetaInformation": {
          "contentTypeID": 0,
          "elementID": 0,
          "metaIDs": [
            0
          ]
        },
        "binary": true
      }
    ],
    "metaMapped": true,
    "lock": {
      "assetID": 0,
      "assetType": 0,
      "lockType": 0,
      "expiry": "2019-07-02T14:03:45Z",
      "owner": 0,
      "ownerName": "string",
      "currentUser": true
    },
    "minAuthLevel": 0,
    "enableDirectEdit": true,
    "elementIdforFilename": 0,
    "warningMessage": "string",
    "sectionId": 0,
    "duplicate": true,
    "duplicatedFromId": 0,
    "fullyAccessible": true
  },
  "types": [
    {
      "id": 0,
      "name": "string",
      "listType": true
    }
  ],
  "insertAtIndex": 0,
  "sortLock": "TOP",
  "excludedMirrorSectionIds": [
    0
  ],
  "locked": true,
  "sectionIDs": [
    0
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<content>
  <id>0</id>
  <contentTypeID>0</contentTypeID>
  <archiveSection>0</archiveSection>
  <publishDate>2019-07-02T14:03:45Z</publishDate>
  <reviewDate>2019-07-02T14:03:45Z</reviewDate>
  <expiryDate>2019-07-02T14:03:45Z</expiryDate>
  <language>string</language>
  <name>string</name>
  <alternativeLanguages>
    <language>string</language>
    <name>string</name>
  </alternativeLanguages>
  <status>0</status>
  <lastModified>2019-07-02T14:03:45Z</lastModified>
  <lastModifiedBy>0</lastModifiedBy>
  <lastModifierName>string</lastModifierName>
  <contentTypeName>string</contentTypeName>
  <contentTypeAlias>string</contentTypeAlias>
  <owner>
    <id>0</id>
    <type>USER</type>
  </owner>
  <version>string</version>
  <previousVersion>string</previousVersion>
  <channels>0</channels>
  <mirroredSectionPaths>
    <property1>string</property1>
    <property2>string</property2>
  </mirroredSectionPaths>
  <editable>true</editable>
  <expired>true</expired>
  <lock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-07-02T14:03:45Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
  </lock>
  <canPublishNow>true</canPublishNow>
  <canSaveAndApprove>true</canSaveAndApprove>
  <elements>
    <property1/>
    <property2/>
  </elements>
  <contentType>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>0</type>
    <editable>true</editable>
    <primaryGroup>
      <ownershipLevel>0</ownershipLevel>
      <group>
        <id>0</id>
        <name>string</name>
        <description>string</description>
        <emailAddress>string</emailAddress>
        <createDate>2019-07-02T14:03:45Z</createDate>
        <enabled>true</enabled>
        <ldap>true</ldap>
        <defaultChannel>0</defaultChannel>
        <deleted>true</deleted>
      </group>
      <readLevel>0</readLevel>
      <assetType>0</assetType>
      <assetID>0</assetID>
      <groupName>string</groupName>
      <groupID>0</groupID>
    </primaryGroup>
    <sharedGroups>
      <ownershipLevel>0</ownershipLevel>
      <group>
        <id>0</id>
        <name>string</name>
        <description>string</description>
        <emailAddress>string</emailAddress>
        <createDate>2019-07-02T14:03:45Z</createDate>
        <enabled>true</enabled>
        <ldap>true</ldap>
        <defaultChannel>0</defaultChannel>
        <deleted>true</deleted>
      </group>
      <readLevel>0</readLevel>
      <assetType>0</assetType>
      <assetID>0</assetID>
      <groupName>string</groupName>
      <groupID>0</groupID>
    </sharedGroups>
    <alias>string</alias>
    <workflow>0</workflow>
    <systemTemplate>true</systemTemplate>
    <sharedGroupCount>0</sharedGroupCount>
    <contentTypeElements>
      <id>0</id>
      <contentTypeID>0</contentTypeID>
      <name>string</name>
      <description>string</description>
      <type>0</type>
      <maxSize>0</maxSize>
      <compulsory>true</compulsory>
      <input_method>0</input_method>
      <listId>0</listId>
      <sequence>0</sequence>
      <alias>string</alias>
      <contentTypeMetaInformation>
        <contentTypeID>0</contentTypeID>
        <elementID>0</elementID>
        <metaIDs>0</metaIDs>
      </contentTypeMetaInformation>
      <binary>true</binary>
    </contentTypeElements>
    <metaMapped>true</metaMapped>
    <lock>
      <assetID>0</assetID>
      <assetType>0</assetType>
      <lockType>0</lockType>
      <expiry>2019-07-02T14:03:45Z</expiry>
      <owner>0</owner>
      <ownerName>string</ownerName>
      <currentUser>true</currentUser>
    </lock>
    <minAuthLevel>0</minAuthLevel>
    <enableDirectEdit>true</enableDirectEdit>
    <elementIdforFilename>0</elementIdforFilename>
    <warningMessage>string</warningMessage>
    <sectionId>0</sectionId>
    <duplicate>true</duplicate>
    <duplicatedFromId>0</duplicatedFromId>
    <fullyAccessible>true</fullyAccessible>
  </contentType>
  <types>
    <id>0</id>
    <name>string</name>
    <listType>true</listType>
  </types>
  <insertAtIndex>0</insertAtIndex>
  <sortLock>TOP</sortLock>
  <excludedMirrorSectionIds>0</excludedMirrorSectionIds>
  <locked>true</locked>
  <sectionIDs>0</sectionIDs>
</content>

Responses

Status Meaning Description Schema
200 OK successful operation ContentDTO

getOwner

GET /content/{id}/{language}/owner

Parameters

Parameter In Type Required Description
id path integer(int32) true none
language path string true none

Example responses

200 Response

{
  "id": 0,
  "type": "USER"
}
<?xml version="1.0" encoding="UTF-8" ?>
<OwnerDTO>
  <id>0</id>
  <type>USER</type>
</OwnerDTO>

Responses

Status Meaning Description Schema
200 OK successful operation OwnerDTO

versions

GET /content/{id}/{language}/version

Parameters

Parameter In Type Required Description
id path integer(int32) true none
language path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "language": "string",
    "version": "string",
    "name": "string",
    "status": 0,
    "lastModified": "2019-07-02T14:03:45Z",
    "lastModifiedBy": "string",
    "lastModifiedById": 0,
    "ownerId": 0,
    "owner": "string",
    "workflow": {
      "id": 0,
      "name": "string",
      "description": "string",
      "stepId": 0,
      "stepNumber": 0,
      "stepName": "string",
      "instanceId": 0
    },
    "previousVersion": "string",
    "sections": [
      {
        "id": 0,
        "level": 0,
        "status": 0,
        "printSequence": 0,
        "formSection": true,
        "archived": true,
        "users": [
          {
            "id": 0,
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "emailAddress": "string",
            "defaultLang": "string",
            "localeCountryCode": "string",
            "localeLanguageCode": "string",
            "localeVariant": "string",
            "createDate": "2019-07-02T14:03:45Z",
            "lastLoginDate": "2019-07-02T14:03:45Z",
            "enabled": true,
            "password": {},
            "defaultPreviewChannel": 0,
            "preferredHtmlEditor": 0,
            "extranetConsent": true,
            "extranetAccess": "string",
            "extranetConsentDatetime": "2019-07-02T14:03:45Z",
            "groups": [],
            "extensibleUserObjectContent": {},
            "sections": [],
            "userChannels": [],
            "locale": {},
            "appliedPreviewChannel": 0,
            "propertyResourceBundle": {},
            "fullTinyMCELocaleCode": "string",
            "fullLocaleCode": "string",
            "deleted": true,
            "authLevel": 0,
            "fullName": "string",
            "powerUser": true,
            "administrator": true
          }
        ],
        "viewUsers": [
          {
            "id": 0,
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "emailAddress": "string",
            "defaultLang": "string",
            "localeCountryCode": "string",
            "localeLanguageCode": "string",
            "localeVariant": "string",
            "createDate": "2019-07-02T14:03:45Z",
            "lastLoginDate": "2019-07-02T14:03:45Z",
            "enabled": true,
            "password": {},
            "defaultPreviewChannel": 0,
            "preferredHtmlEditor": 0,
            "extranetConsent": true,
            "extranetAccess": "string",
            "extranetConsentDatetime": "2019-07-02T14:03:45Z",
            "groups": [],
            "extensibleUserObjectContent": {},
            "sections": [],
            "userChannels": [],
            "locale": {},
            "appliedPreviewChannel": 0,
            "propertyResourceBundle": {},
            "fullTinyMCELocaleCode": "string",
            "fullLocaleCode": "string",
            "deleted": true,
            "authLevel": 0,
            "fullName": "string",
            "powerUser": true,
            "administrator": true
          }
        ],
        "groups": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "emailAddress": "string",
            "createDate": "2019-07-02T14:03:45Z",
            "enabled": true,
            "ldap": true,
            "defaultChannel": 0,
            "children": [],
            "sections": [],
            "steps": [],
            "memberCount": 0,
            "deleted": true
          }
        ],
        "viewGroups": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "emailAddress": "string",
            "createDate": "2019-07-02T14:03:45Z",
            "enabled": true,
            "ldap": true,
            "defaultChannel": 0,
            "children": [],
            "sections": [],
            "steps": [],
            "memberCount": 0,
            "deleted": true
          }
        ],
        "contentSections": [
          {
            "section": null,
            "content": {},
            "printSequence": 0,
            "sortLock": "TOP",
            "contentID": 0,
            "entityID": 0,
            "sectionID": 0
          }
        ],
        "sectionInfos": {
          "property1": {
            "section": null,
            "language": "string",
            "name": "string",
            "lastModified": "2019-07-02T14:03:45Z",
            "outputUri": "string",
            "outputFilename": "string",
            "keyPhrase": "string",
            "accessKey": "string",
            "contentOwner": 0,
            "metaDatas": []
          },
          "property2": {
            "section": null,
            "language": "string",
            "name": "string",
            "lastModified": "2019-07-02T14:03:45Z",
            "outputUri": "string",
            "outputFilename": "string",
            "keyPhrase": "string",
            "accessKey": "string",
            "contentOwner": 0,
            "metaDatas": []
          }
        },
        "mirrorSections": [
          null
        ],
        "links": {
          "property1": {
            "sourceSection": null,
            "language": "string",
            "url": "string",
            "section": 0,
            "target": "string",
            "inheritedAccessControl": 0,
            "overrideLink": true,
            "linkHasBeenOverridden": true,
            "type": 0,
            "persistentLanguage": "string",
            "sourceSectionID": 0
          },
          "property2": {
            "sourceSection": null,
            "language": "string",
            "url": "string",
            "section": 0,
            "target": "string",
            "inheritedAccessControl": 0,
            "overrideLink": true,
            "linkHasBeenOverridden": true,
            "type": 0,
            "persistentLanguage": "string",
            "sourceSectionID": 0
          }
        },
        "rootChannels": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "type": "string",
            "defaultLanguage": "string",
            "rootSectionID": 0,
            "fileOutputPath": "string",
            "indexFileName": "string",
            "baseHref": "string",
            "siteRoot": "string",
            "pathCaseModifier": 0,
            "fullTextType": "string",
            "fullTextExtension": "string",
            "secondaryPublishLanguage": "string",
            "channelPublishURL": "string",
            "parent": null,
            "favIconID": 0,
            "pollIconID": 0,
            "accessControlConfigurationID": 0,
            "personalisationConfigurationID": 0,
            "publishReportLevel": 0,
            "pendingVersionOutputPath": "string",
            "pendingVersionBaseHref": "string",
            "pendingVersionSiteRoot": "string",
            "prePublishProcessorID": 0,
            "allowScriptsInDirectEdit": 0,
            "languages": [],
            "microSites": [],
            "permittedFileExtensions": [],
            "translationDisclaimers": [],
            "mediaPublishRules": [],
            "channelFullTextDisplayPeriod": {},
            "channelUsers": [],
            "channelContents": [],
            "convertSpacesInSectionNameEnabled": true,
            "convertSpacesInOutputURIEnabled": true,
            "convertSpacesInRetainedFilenameEnabled": true,
            "contentIDs": [],
            "languageCodes": [],
            "microSite": true,
            "parentID": 0,
            "publishEmptySectionsEnabled": true,
            "personalisationEnabled": true,
            "fullTextDisplayPeriodValue": 0,
            "secondaryPublishEnabled": true,
            "accessControlEnabled": true,
            "channelCleanupEnabled": true,
            "fullTextDisplayPeriodUnit": 0,
            "overrideExtensionEnabled": true
          }
        ],
        "appliedPageLayouts": [
          {
            "id": {},
            "sectionID": 0,
            "pageLayoutID": 0,
            "inheritablePageLayoutID": 0,
            "channel": {},
            "section": null,
            "channelName": "string",
            "channelID": 0
          }
        ],
        "hierarchyMirrorAcOpt": {
          "section": null,
          "accessControlOption": 0,
          "id": 0
        },
        "hierarchyMirrorMetadataOpt": {
          "section": null,
          "metadataOption": 0,
          "id": 0
        },
        "children": [
          null
        ],
        "contentTypeScopes": [
          {
            "section": null,
            "contentType": {},
            "scope": 0,
            "contentTypeID": 0
          }
        ],
        "cloneSource": null,
        "sectionPaths": {
          "property1": {
            "section": null,
            "language": "string",
            "path": "string"
          },
          "property2": {
            "section": null,
            "language": "string",
            "path": "string"
          }
        },
        "webDAVRules": [
          {
            "section": null,
            "executionOrder": 0,
            "extensions": [],
            "contentType": 0,
            "element": "string",
            "autoApprove": true,
            "csvextensions": "string",
            "sectionID": 0
          }
        ],
        "sortLock": "TOP",
        "parent": null,
        "mirrors": [
          0
        ],
        "root": true,
        "workflow": {
          "id": 0,
          "name": "string",
          "description": "string",
          "status": "ACTIVE",
          "creationDate": "2019-07-02T14:03:45Z",
          "lastModified": "2019-07-02T14:03:45Z",
          "contentTypes": [
            {}
          ],
          "section": [
            null
          ],
          "workflowSteps": [
            {}
          ],
          "firstStep": {
            "id": 0,
            "name": "string",
            "description": "string",
            "status": "ACTIVE",
            "lastModified": "2019-07-02T14:03:45Z",
            "priority": "PRIORITY_LOWEST",
            "restrictToEditors": 0,
            "language": {},
            "users": [],
            "groups": [],
            "options": {},
            "workflowSteps": []
          },
          "currentActiveStep": {
            "id": 0,
            "name": "string",
            "description": "string",
            "status": "ACTIVE",
            "lastModified": "2019-07-02T14:03:45Z",
            "priority": "PRIORITY_LOWEST",
            "restrictToEditors": 0,
            "language": {},
            "users": [],
            "groups": [],
            "options": {},
            "workflowSteps": []
          }
        },
        "link": true,
        "mirrorSource": null,
        "shown": true,
        "languageCount": 0,
        "allNames": {
          "property1": "string",
          "property2": "string"
        },
        "workflowID": 0,
        "workflowName": "string",
        "nextSequence": 0,
        "childOfMirror": true,
        "channelRoot": [
          0
        ],
        "entityID": 0,
        "parentID": 0,
        "mirror": true,
        "sectionSortMethod": 0,
        "contentsAndSequences": {
          "property1": 0,
          "property2": 0
        },
        "contentSortMethod": 0,
        "mirrorSourceID": 0,
        "metadataOption": 0,
        "allPathSectionsWebDAVRules": [
          {
            "section": null,
            "executionOrder": 0,
            "extensions": [],
            "contentType": 0,
            "element": "string",
            "autoApprove": true,
            "csvextensions": "string",
            "sectionID": 0
          }
        ],
        "accessControlOption": 0,
        "currentOrInheritedWorkflow": 0,
        "childOfMirrored": true,
        "parentWorkflowID": 0,
        "contentNextSequence": 0,
        "languages": [
          "string"
        ],
        "channels": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "type": "string",
            "defaultLanguage": "string",
            "rootSectionID": 0,
            "fileOutputPath": "string",
            "indexFileName": "string",
            "baseHref": "string",
            "siteRoot": "string",
            "pathCaseModifier": 0,
            "fullTextType": "string",
            "fullTextExtension": "string",
            "secondaryPublishLanguage": "string",
            "channelPublishURL": "string",
            "parent": null,
            "favIconID": 0,
            "pollIconID": 0,
            "accessControlConfigurationID": 0,
            "personalisationConfigurationID": 0,
            "publishReportLevel": 0,
            "pendingVersionOutputPath": "string",
            "pendingVersionBaseHref": "string",
            "pendingVersionSiteRoot": "string",
            "prePublishProcessorID": 0,
            "allowScriptsInDirectEdit": 0,
            "languages": [],
            "microSites": [],
            "permittedFileExtensions": [],
            "translationDisclaimers": [],
            "mediaPublishRules": [],
            "channelFullTextDisplayPeriod": {},
            "channelUsers": [],
            "channelContents": [],
            "convertSpacesInSectionNameEnabled": true,
            "convertSpacesInOutputURIEnabled": true,
            "convertSpacesInRetainedFilenameEnabled": true,
            "contentIDs": [],
            "languageCodes": [],
            "microSite": true,
            "parentID": 0,
            "publishEmptySectionsEnabled": true,
            "personalisationEnabled": true,
            "fullTextDisplayPeriodValue": 0,
            "secondaryPublishEnabled": true,
            "accessControlEnabled": true,
            "channelCleanupEnabled": true,
            "fullTextDisplayPeriodUnit": 0,
            "overrideExtensionEnabled": true
          }
        ],
        "pathMembers": [
          0
        ]
      }
    ],
    "alreadyVoted": true
  }
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>0</id>
<language>string</language>
<version>string</version>
<name>string</name>
<status>0</status>
<lastModified>2019-07-02T14:03:45Z</lastModified>
<lastModifiedBy>string</lastModifiedBy>
<lastModifiedById>0</lastModifiedById>
<ownerId>0</ownerId>
<owner>string</owner>
<workflow>
  <id>0</id>
  <name>string</name>
  <description>string</description>
  <stepId>0</stepId>
  <stepNumber>0</stepNumber>
  <stepName>string</stepName>
  <instanceId>0</instanceId>
</workflow>
<previousVersion>string</previousVersion>
<sections>
  <id>0</id>
  <level>0</level>
  <status>0</status>
  <printSequence>0</printSequence>
  <formSection>true</formSection>
  <archived>true</archived>
  <users>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <emailAddress>string</emailAddress>
    <defaultLang>string</defaultLang>
    <localeCountryCode>string</localeCountryCode>
    <localeLanguageCode>string</localeLanguageCode>
    <localeVariant>string</localeVariant>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <lastLoginDate>2019-07-02T14:03:45Z</lastLoginDate>
    <enabled>true</enabled>
    <password/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <preferredHtmlEditor>0</preferredHtmlEditor>
    <extranetConsent>true</extranetConsent>
    <extranetAccess>string</extranetAccess>
    <extranetConsentDatetime>2019-07-02T14:03:45Z</extranetConsentDatetime>
    <extensibleUserObjectContent/>
    <locale/>
    <appliedPreviewChannel>0</appliedPreviewChannel>
    <propertyResourceBundle/>
    <fullTinyMCELocaleCode>string</fullTinyMCELocaleCode>
    <fullLocaleCode>string</fullLocaleCode>
    <deleted>true</deleted>
    <authLevel>0</authLevel>
    <fullName>string</fullName>
    <powerUser>true</powerUser>
    <administrator>true</administrator>
  </users>
  <viewUsers>
    <id>0</id>
    <username>string</username>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <emailAddress>string</emailAddress>
    <defaultLang>string</defaultLang>
    <localeCountryCode>string</localeCountryCode>
    <localeLanguageCode>string</localeLanguageCode>
    <localeVariant>string</localeVariant>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <lastLoginDate>2019-07-02T14:03:45Z</lastLoginDate>
    <enabled>true</enabled>
    <password/>
    <defaultPreviewChannel>0</defaultPreviewChannel>
    <preferredHtmlEditor>0</preferredHtmlEditor>
    <extranetConsent>true</extranetConsent>
    <extranetAccess>string</extranetAccess>
    <extranetConsentDatetime>2019-07-02T14:03:45Z</extranetConsentDatetime>
    <extensibleUserObjectContent/>
    <locale/>
    <appliedPreviewChannel>0</appliedPreviewChannel>
    <propertyResourceBundle/>
    <fullTinyMCELocaleCode>string</fullTinyMCELocaleCode>
    <fullLocaleCode>string</fullLocaleCode>
    <deleted>true</deleted>
    <authLevel>0</authLevel>
    <fullName>string</fullName>
    <powerUser>true</powerUser>
    <administrator>true</administrator>
  </viewUsers>
  <groups>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <emailAddress>string</emailAddress>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <enabled>true</enabled>
    <ldap>true</ldap>
    <defaultChannel>0</defaultChannel>
    <memberCount>0</memberCount>
    <deleted>true</deleted>
  </groups>
  <viewGroups>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <emailAddress>string</emailAddress>
    <createDate>2019-07-02T14:03:45Z</createDate>
    <enabled>true</enabled>
    <ldap>true</ldap>
    <defaultChannel>0</defaultChannel>
    <memberCount>0</memberCount>
    <deleted>true</deleted>
  </viewGroups>
  <contentSections>
    <section/>
    <content/>
    <printSequence>0</printSequence>
    <sortLock>TOP</sortLock>
    <contentID>0</contentID>
    <entityID>0</entityID>
    <sectionID>0</sectionID>
  </contentSections>
  <sectionInfos>
    <property1>
      <section/>
      <language>string</language>
      <name>string</name>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <outputUri>string</outputUri>
      <outputFilename>string</outputFilename>
      <keyPhrase>string</keyPhrase>
      <accessKey>string</accessKey>
      <contentOwner>0</contentOwner>
    </property1>
    <property2>
      <section/>
      <language>string</language>
      <name>string</name>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <outputUri>string</outputUri>
      <outputFilename>string</outputFilename>
      <keyPhrase>string</keyPhrase>
      <accessKey>string</accessKey>
      <contentOwner>0</contentOwner>
    </property2>
  </sectionInfos>
  <mirrorSections/>
  <links>
    <property1>
      <sourceSection/>
      <language>string</language>
      <url>string</url>
      <section>0</section>
      <target>string</target>
      <inheritedAccessControl>0</inheritedAccessControl>
      <overrideLink>true</overrideLink>
      <linkHasBeenOverridden>true</linkHasBeenOverridden>
      <type>0</type>
      <persistentLanguage>string</persistentLanguage>
      <sourceSectionID>0</sourceSectionID>
    </property1>
    <property2>
      <sourceSection/>
      <language>string</language>
      <url>string</url>
      <section>0</section>
      <target>string</target>
      <inheritedAccessControl>0</inheritedAccessControl>
      <overrideLink>true</overrideLink>
      <linkHasBeenOverridden>true</linkHasBeenOverridden>
      <type>0</type>
      <persistentLanguage>string</persistentLanguage>
      <sourceSectionID>0</sourceSectionID>
    </property2>
  </links>
  <rootChannels>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>string</type>
    <defaultLanguage>string</defaultLanguage>
    <rootSectionID>0</rootSectionID>
    <fileOutputPath>string</fileOutputPath>
    <indexFileName>string</indexFileName>
    <baseHref>string</baseHref>
    <siteRoot>string</siteRoot>
    <pathCaseModifier>0</pathCaseModifier>
    <fullTextType>string</fullTextType>
    <fullTextExtension>string</fullTextExtension>
    <secondaryPublishLanguage>string</secondaryPublishLanguage>
    <channelPublishURL>string</channelPublishURL>
    <parent/>
    <favIconID>0</favIconID>
    <pollIconID>0</pollIconID>
    <accessControlConfigurationID>0</accessControlConfigurationID>
    <personalisationConfigurationID>0</personalisationConfigurationID>
    <publishReportLevel>0</publishReportLevel>
    <pendingVersionOutputPath>string</pendingVersionOutputPath>
    <pendingVersionBaseHref>string</pendingVersionBaseHref>
    <pendingVersionSiteRoot>string</pendingVersionSiteRoot>
    <prePublishProcessorID>0</prePublishProcessorID>
    <allowScriptsInDirectEdit>0</allowScriptsInDirectEdit>
    <channelFullTextDisplayPeriod/>
    <convertSpacesInSectionNameEnabled>true</convertSpacesInSectionNameEnabled>
    <convertSpacesInOutputURIEnabled>true</convertSpacesInOutputURIEnabled>
    <convertSpacesInRetainedFilenameEnabled>true</convertSpacesInRetainedFilenameEnabled>
    <microSite>true</microSite>
    <parentID>0</parentID>
    <publishEmptySectionsEnabled>true</publishEmptySectionsEnabled>
    <personalisationEnabled>true</personalisationEnabled>
    <fullTextDisplayPeriodValue>0</fullTextDisplayPeriodValue>
    <secondaryPublishEnabled>true</secondaryPublishEnabled>
    <accessControlEnabled>true</accessControlEnabled>
    <channelCleanupEnabled>true</channelCleanupEnabled>
    <fullTextDisplayPeriodUnit>0</fullTextDisplayPeriodUnit>
    <overrideExtensionEnabled>true</overrideExtensionEnabled>
  </rootChannels>
  <appliedPageLayouts>
    <id/>
    <sectionID>0</sectionID>
    <pageLayoutID>0</pageLayoutID>
    <inheritablePageLayoutID>0</inheritablePageLayoutID>
    <channel/>
    <section/>
    <channelName>string</channelName>
    <channelID>0</channelID>
  </appliedPageLayouts>
  <hierarchyMirrorAcOpt>
    <section/>
    <accessControlOption>0</accessControlOption>
    <id>0</id>
  </hierarchyMirrorAcOpt>
  <hierarchyMirrorMetadataOpt>
    <section/>
    <metadataOption>0</metadataOption>
    <id>0</id>
  </hierarchyMirrorMetadataOpt>
  <children/>
  <contentTypeScopes>
    <section/>
    <contentType/>
    <scope>0</scope>
    <contentTypeID>0</contentTypeID>
  </contentTypeScopes>
  <cloneSource/>
  <sectionPaths>
    <property1>
      <section/>
      <language>string</language>
      <path>string</path>
    </property1>
    <property2>
      <section/>
      <language>string</language>
      <path>string</path>
    </property2>
  </sectionPaths>
  <webDAVRules>
    <section/>
    <executionOrder>0</executionOrder>
    <contentType>0</contentType>
    <element>string</element>
    <autoApprove>true</autoApprove>
    <csvextensions>string</csvextensions>
    <sectionID>0</sectionID>
  </webDAVRules>
  <sortLock>TOP</sortLock>
  <parent/>
  <mirrors>0</mirrors>
  <root>true</root>
  <workflow>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <status>ACTIVE</status>
    <creationDate>2019-07-02T14:03:45Z</creationDate>
    <lastModified>2019-07-02T14:03:45Z</lastModified>
    <contentTypes/>
    <section/>
    <workflowSteps/>
    <firstStep>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <status>ACTIVE</status>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <priority>PRIORITY_LOWEST</priority>
      <restrictToEditors>0</restrictToEditors>
      <language/>
      <options/>
    </firstStep>
    <currentActiveStep>
      <id>0</id>
      <name>string</name>
      <description>string</description>
      <status>ACTIVE</status>
      <lastModified>2019-07-02T14:03:45Z</lastModified>
      <priority>PRIORITY_LOWEST</priority>
      <restrictToEditors>0</restrictToEditors>
      <language/>
      <options/>
    </currentActiveStep>
  </workflow>
  <link>true</link>
  <mirrorSource/>
  <shown>true</shown>
  <languageCount>0</languageCount>
  <allNames>
    <property1>string</property1>
    <property2>string</property2>
  </allNames>
  <workflowID>0</workflowID>
  <workflowName>string</workflowName>
  <nextSequence>0</nextSequence>
  <childOfMirror>true</childOfMirror>
  <channelRoot>0</channelRoot>
  <entityID>0</entityID>
  <parentID>0</parentID>
  <mirror>true</mirror>
  <sectionSortMethod>0</sectionSortMethod>
  <contentsAndSequences>
    <property1>0</property1>
    <property2>0</property2>
  </contentsAndSequences>
  <contentSortMethod>0</contentSortMethod>
  <mirrorSourceID>0</mirrorSourceID>
  <metadataOption>0</metadataOption>
  <allPathSectionsWebDAVRules>
    <section/>
    <executionOrder>0</executionOrder>
    <contentType>0</contentType>
    <element>string</element>
    <autoApprove>true</autoApprove>
    <csvextensions>string</csvextensions>
    <sectionID>0</sectionID>
  </allPathSectionsWebDAVRules>
  <accessControlOption>0</accessControlOption>
  <currentOrInheritedWorkflow>0</currentOrInheritedWorkflow>
  <childOfMirrored>true</childOfMirrored>
  <parentWorkflowID>0</parentWorkflowID>
  <contentNextSequence>0</contentNextSequence>
  <languages>string</languages>
  <channels>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>string</type>
    <defaultLanguage>string</defaultLanguage>
    <rootSectionID>0</rootSectionID>
    <fileOutputPath>string</fileOutputPath>
    <indexFileName>string</indexFileName>
    <baseHref>string</baseHref>
    <siteRoot>string</siteRoot>
    <pathCaseModifier>0</pathCaseModifier>
    <fullTextType>string</fullTextType>
    <fullTextExtension>string</fullTextExtension>
    <secondaryPublishLanguage>string</secondaryPublishLanguage>
    <channelPublishURL>string</channelPublishURL>
    <parent/>
    <favIconID>0</favIconID>
    <pollIconID>0</pollIconID>
    <accessControlConfigurationID>0</accessControlConfigurationID>
    <personalisationConfigurationID>0</personalisationConfigurationID>
    <publishReportLevel>0</publishReportLevel>
    <pendingVersionOutputPath>string</pendingVersionOutputPath>
    <pendingVersionBaseHref>string</pendingVersionBaseHref>
    <pendingVersionSiteRoot>string</pendingVersionSiteRoot>
    <prePublishProcessorID>0</prePublishProcessorID>
    <allowScriptsInDirectEdit>0</allowScriptsInDirectEdit>
    <channelFullTextDisplayPeriod/>
    <convertSpacesInSectionNameEnabled>true</convertSpacesInSectionNameEnabled>
    <convertSpacesInOutputURIEnabled>true</convertSpacesInOutputURIEnabled>
    <convertSpacesInRetainedFilenameEnabled>true</convertSpacesInRetainedFilenameEnabled>
    <microSite>true</microSite>
    <parentID>0</parentID>
    <publishEmptySectionsEnabled>true</publishEmptySectionsEnabled>
    <personalisationEnabled>true</personalisationEnabled>
    <fullTextDisplayPeriodValue>0</fullTextDisplayPeriodValue>
    <secondaryPublishEnabled>true</secondaryPublishEnabled>
    <accessControlEnabled>true</accessControlEnabled>
    <channelCleanupEnabled>true</channelCleanupEnabled>
    <fullTextDisplayPeriodUnit>0</fullTextDisplayPeriodUnit>
    <overrideExtensionEnabled>true</overrideExtensionEnabled>
  </channels>
  <pathMembers>0</pathMembers>
</sections>
<alreadyVoted>true</alreadyVoted>

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ApprovableContent] false none none
»»»»»»»» priority integer(int32) false none none
»»»»»»»» disclaimer string false none none
»»»»»»»» publishRule integer(int32) false none none
»»»»»»»»»» languageIndependant boolean false none none
»»»»»»»»» convertSpacesInSectionNameEnabled boolean false none none
»»»»»»»»» convertSpacesInOutputURIEnabled boolean false none none
»»»»»»»»» convertSpacesInRetainedFilenameEnabled boolean false none none
»»»»»»»»» contentIDs [integer] false none none
»»»»»»»»» languageCodes [string] false none none
»»»»»»»»» microSite boolean false none none
»»»»»»»»» parentID integer(int32) false none none
»»»»»»»»» publishEmptySectionsEnabled boolean false none none
»»»»»»»»» personalisationEnabled boolean false none none
»»»»»»»»» fullTextDisplayPeriodValue integer(int32) false none none
»»»»»»»»» secondaryPublishEnabled boolean false none none
»»»»»»»»» accessControlEnabled boolean false none none
»»»»»»»»» channelCleanupEnabled boolean false none none
»»»»»»»»» fullTextDisplayPeriodUnit integer(int32) false none none
»»»»»»»»» overrideExtensionEnabled boolean false none none
»»»»»»»»»»» elementForFilename integer(int32) false none none
»»»»»»»»»»» alias string false none none
»»»»»»»»»»» directEditEnabled boolean false none none
»»»»»»» memberCount integer(int32) false none none
»»»»»»» deleted boolean false none none
»»»»»»» language string false none none
»»»»»»» name string false none none
»»»»»»» lastModified string(date-time) false none none
»»»»»»» id integer(int32) false none none
»»»»»»» owner integer(int32) false none none
»»»»»» fullTinyMCELocaleCode string false none none
»»»»»» fullLocaleCode string false none none
»»»»»» deleted boolean false none none
»»»»»» authLevel integer(int32) false none none
»»»»»» fullName string false none none
»»»»»» powerUser boolean false none none
»»»»»» administrator boolean false none none
»»»»»»»» value string false none none
»»»»»»»» language string false none none
»»»»»»»» metaTagID integer(int32) false none none
»»»»»»»» metaTagName string false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» sectionID integer(int32) false none none
»»»»»»»» pageLayoutID integer(int32) false none none
»»»»»»»» inheritablePageLayoutID integer(int32) false none none
»»»»»»»» sortLock string false none none
»»»»»»» alreadyVoted boolean false none none

Enumerated Values

Property Value
sortLock TOP
sortLock BOTTOM
sortLock UNLOCKED

getWithoutSection

GET /content/{id}/{language}/version/{version}

Parameters

Parameter In Type Required Description
id path integer(int32) true none
language path string true none
version path string true none

Example responses

200 Response

{
  "id": 0,
  "contentTypeID": 0,
  "archiveSection": 0,
  "publishDate": "2019-07-02T14:03:45Z",
  "reviewDate": "2019-07-02T14:03:45Z",
  "expiryDate": "2019-07-02T14:03:45Z",
  "language": "string",
  "name": "string",
  "alternativeLanguages": [
    {
      "language": "string",
      "name": "string"
    }
  ],
  "status": 0,
  "lastModified": "2019-07-02T14:03:45Z",
  "lastModifiedBy": 0,
  "lastModifierName": "string",
  "contentTypeName": "string",
  "contentTypeAlias": "string",
  "owner": {
    "id": 0,
    "type": "USER"
  },
  "version": "string",
  "previousVersion": "string",
  "channels": [
    0
  ],
  "mirroredSectionPaths": {
    "property1": "string",
    "property2": "string"
  },
  "editable": true,
  "expired": true,
  "lock": {
    "assetID": 0,
    "assetType": 0,
    "lockType": 0,
    "expiry": "2019-07-02T14:03:45Z",
    "owner": 0,
    "ownerName": "string",
    "currentUser": true
  },
  "canPublishNow": true,
  "canSaveAndApprove": true,
  "elements": {
    "property1": {},
    "property2": {}
  },
  "contentType": {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": 0,
    "editable": true,
    "primaryGroup": {
      "ownershipLevel": 0,
      "group": {
        "id": 0,
        "name": "string",
        "description": "string",
        "emailAddress": "string",
        "createDate": "2019-07-02T14:03:45Z",
        "enabled": true,
        "ldap": true,
        "defaultChannel": 0,
        "deleted": true
      },
      "readLevel": 0,
      "assetType": 0,
      "assetID": 0,
      "groupName": "string",
      "groupID": 0
    },
    "sharedGroups": [
      {
        "ownershipLevel": 0,
        "group": {
          "id": 0,
          "name": "string",
          "description": "string",
          "emailAddress": "string",
          "createDate": "2019-07-02T14:03:45Z",
          "enabled": true,
          "ldap": true,
          "defaultChannel": 0,
          "deleted": true
        },
        "readLevel": 0,
        "assetType": 0,
        "assetID": 0,
        "groupName": "string",
        "groupID": 0
      }
    ],
    "alias": "string",
    "workflow": 0,
    "systemTemplate": true,
    "sharedGroupCount": 0,
    "contentTypeElements": [
      {
        "id": 0,
        "contentTypeID": 0,
        "name": "string",
        "description": "string",
        "type": 0,
        "maxSize": 0,
        "compulsory": true,
        "input_method": 0,
        "listId": 0,
        "sequence": 0,
        "alias": "string",
        "contentTypeMetaInformation": {
          "contentTypeID": 0,
          "elementID": 0,
          "metaIDs": [
            0
          ]
        },
        "binary": true
      }
    ],
    "metaMapped": true,
    "lock": {
      "assetID": 0,
      "assetType": 0,
      "lockType": 0,
      "expiry": "2019-07-02T14:03:45Z",
      "owner": 0,
      "ownerName": "string",
      "currentUser": true
    },
    "minAuthLevel": 0,
    "enableDirectEdit": true,
    "elementIdforFilename": 0,
    "warningMessage": "string",
    "sectionId": 0,
    "duplicate": true,
    "duplicatedFromId": 0,
    "fullyAccessible": true
  },
  "types": [
    {
      "id": 0,
      "name": "string",
      "listType": true
    }
  ],
  "insertAtIndex": 0,
  "sortLock": "TOP",
  "excludedMirrorSectionIds": [
    0
  ],
  "locked": true,
  "sectionIDs": [
    0
  ]
}
<?xml version="1.0" encoding="UTF-8" ?>
<content>
  <id>0</id>
  <contentTypeID>0</contentTypeID>
  <archiveSection>0</archiveSection>
  <publishDate>2019-07-02T14:03:45Z</publishDate>
  <reviewDate>2019-07-02T14:03:45Z</reviewDate>
  <expiryDate>2019-07-02T14:03:45Z</expiryDate>
  <language>string</language>
  <name>string</name>
  <alternativeLanguages>
    <language>string</language>
    <name>string</name>
  </alternativeLanguages>
  <status>0</status>
  <lastModified>2019-07-02T14:03:45Z</lastModified>
  <lastModifiedBy>0</lastModifiedBy>
  <lastModifierName>string</lastModifierName>
  <contentTypeName>string</contentTypeName>
  <contentTypeAlias>string</contentTypeAlias>
  <owner>
    <id>0</id>
    <type>USER</type>
  </owner>
  <version>string</version>
  <previousVersion>string</previousVersion>
  <channels>0</channels>
  <mirroredSectionPaths>
    <property1>string</property1>
    <property2>string</property2>
  </mirroredSectionPaths>
  <editable>true</editable>
  <expired>true</expired>
  <lock>
    <assetID>0</assetID>
    <assetType>0</assetType>
    <lockType>0</lockType>
    <expiry>2019-07-02T14:03:45Z</expiry>
    <owner>0</owner>
    <ownerName>string</ownerName>
    <currentUser>true</currentUser>
  </lock>
  <canPublishNow>true</canPublishNow>
  <canSaveAndApprove>true</canSaveAndApprove>
  <elements>
    <property1/>
    <property2/>
  </elements>
  <contentType>
    <id>0</id>
    <name>string</name>
    <description>string</description>
    <type>0</type>
    <editable>true</editable>
    <primaryGroup>
      <ownershipLevel>0</ownershipLevel>
      <group>
        <id>0</id>
        <name>string</name>
        <description>string</description>
        <emailAddress>string</emailAddress>
        <createDate>2019-07-02T14:03:45Z</createDate>
        <enabled>true</enabled>
        <ldap>true</ldap>
        <defaultChannel>0</defaultChannel>
        <deleted>true</deleted>
      </group>
      <readLevel>0</readLevel>
      <assetType>0</assetType>
      <assetID>0</assetID>
      <groupName>string</groupName>
      <groupID>0</groupID>
    </primaryGroup>
    <sharedGroups>
      <ownershipLevel>0</ownershipLevel>
      <group>
        <id>0</id>
        <name>string</name>
        <description>string</description>
        <emailAddress>string</emailAddress>
        <createDate>2019-07-02T14:03:45Z</createDate>
        <enabled>true</enabled>
        <ldap>true</ldap>
        <defaultChannel>0</defaultChannel>
        <deleted>true</deleted>
      </group>
      <readLevel>0</readLevel>
      <assetType>0</assetType>
      <assetID>0</assetID>
      <groupName>string</groupName>
      <groupID>0</groupID>
    </sharedGroups>
    <alias>string</alias>
    <workflow>0</workflow>
    <systemTemplate>true</systemTemplate>
    <sharedGroupCount>0</sharedGroupCount>
    <contentTypeElements>
      <id>0</id>
      <contentTypeID>0</contentTypeID>
      <name>string</name>
      <description>string</description>
      <type>0</type>
      <maxSize>0</maxSize>
      <compulsory>true</compulsory>
      <input_method>0</input_method>
      <listId>0</listId>
      <sequence>0</sequence>
      <alias>string</alias>
      <contentTypeMetaInformation>
        <contentTypeID>0</contentTypeID>
        <elementID>0</elementID>
        <metaIDs>0</metaIDs>
      </contentTypeMetaInformation>
      <binary>true</binary>
    </contentTypeElements>
    <metaMapped>true</metaMapped>
    <lock>
      <assetID>0</assetID>
      <assetType>0</assetType>
      <lockType>0</lockType>
      <expiry>2019-07-02T14:03:45Z</expiry>
      <owner>0</owner>
      <ownerName>string</ownerName>
      <currentUser>true</currentUser>
    </lock>
    <minAuthLevel>0</minAuthLevel>
    <enableDirectEdit>true</enableDirectEdit>
    <elementIdforFilename>0</elementIdforFilename>
    <warningMessage>string</warningMessage>
    <sectionId>0</sectionId>
    <duplicate>true</duplicate>
    <duplicatedFromId>0</duplicatedFromId>
    <fullyAccessible>true</fullyAccessible>
  </contentType>
  <types>
    <id>0</id>
    <name>string</name>
    <listType>true</listType>
  </types>
  <insertAtIndex>0</insertAtIndex>
  <sortLock>TOP</sortLock>
  <excludedMirrorSectionIds>0</excludedMirrorSectionIds>
  <locked>true</locked>
  <sectionIDs>0</sectionIDs>
</content>

Responses

Status Meaning Description Schema
200 OK successful operation ContentDTO

bulkDelete

DELETE /content/{language}

Parameters

Parameter In Type Required Description
language path string true none
force query boolean false none

Responses

Status Meaning Description Schema
default Default successful operation None

getInAllLanguages

GET /content/{language}/{ids}

Parameters

Parameter In Type Required Description
language path string true none
ids path string true none

Example responses

200 Response

[
  {
    "id": 0,
    "contentTypeID": 0,
    "archiveSection": 0,
    "publishDate": "2019-07-02T14:03:45Z",
    "reviewDate": "2019-07-02T14:03:45Z",
    "expiryDate": "2019-07-02T14:03:45Z",
    "language": "string",
    "name": "string",
    "alternativeLanguages": [
      {
        "language": "string",
        "name": "string"
      }
    ],
    "status": 0,
    "lastModified": "2019-07-02T14:03:45Z",
    "lastModifiedBy": 0,
    "lastModifierName": "string",
    "contentTypeName": "string",
    "contentTypeAlias": "string",
    "owner": {
      "id": 0,
      "type": "USER"
    },
    "version": "string",
    "previousVersion": "string",
    "channels": [
      0
    ],
    "mirroredSectionPaths": {
      "property1": "string",
      "property2": "string"
    },
    "editable": true,
    "expired": true,
    "lock": {
      "assetID": 0,
      "assetType": 0,
      "lockType": 0,
      "expiry": "2019-07-02T14:03:45Z",
      "owner": 0,
      "ownerName": "string",
      "currentUser": true
    },
    "canPublishNow": true,
    "canSaveAndApprove": true,
    "elements": {
      "property1": {},
      "property2": {}
    },
    "contentType": {
      "id": 0,
      "name": "string",
      "description": "string",
      "type": 0,
      "editable": true,
      "primaryGroup": {
        "ownershipLevel": 0,
        "group": {
          "id": 0,
          "name": "string",
          "description": "string",
          "emailAddress": "string",
          "createDate": "2019-07-02T14:03:45Z",
          "enabled": true,
          "ldap": true,
          "defaultChannel": 0,
          "deleted": true
        },
        "readLevel": 0,
        "assetType": 0,
        "assetID": 0,
        "groupName": "string",
        "groupID": 0
      },
      "sharedGroups": [
        {
          "ownershipLevel": 0,
          "group": {
            "id": 0,
            "name": "string",
            "description": "string",
            "emailAddress": "string",
            "createDate": "2019-07-02T14:03:45Z",
            "enabled": true,
            "ldap": true,
            "defaultChannel": 0,
            "deleted": true
          },
          "readLevel": 0,
          "assetType": 0,
          "assetID": 0,
          "groupName": "string",
          "groupID": 0
        }
      ],
      "alias": "string",
      "workflow": 0,
      "systemTemplate": true,
      "sharedGroupCount": 0,
      "contentTypeElements": [
        {
          "id": 0,
          "contentTypeID": 0,
          "name": "string",
          "description": "string",
          "type": 0,
          "maxSize": 0,
          "compulsory": true,
          "input_method": 0,
          "listId": 0,
          "sequence": 0,
          "alias": "string",
          "contentTypeMetaInformation": {
            "contentTypeID": 0,
            "elementID": 0,
            "metaIDs": []
          },
          "binary": true
        }
      ],
      "metaMapped": true,
      "lock": {
        "assetID": 0,
        "assetType": 0,
        "lockType": 0,